Fix completion naming in Darwin framework. (project-chip#22557)

* Rename all "completionHandler" selectors/arguments to "completion". * Rename everything ending with "CompletionHandler" to end with "Completion". * Make sure we consistently use "queue" for callback queues, not "clientQueue". * Add MTR prefixes to remaining un-prefixed block typedefs. Fixes project-chip#22529 Addresses part of project-chip#22420
isiu-apple · Sep 16, 2022 · 6861dc2 · 6861dc2
1 parent 2491f62
commit 6861dc2
Show file tree

Hide file tree

Showing 53 changed files with 39,758 additions and 43,316 deletions.
diff --git a/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/ClusterCommandBridge.h
@@ -81,7 +81,7 @@ class ClusterCommand : public ModelCommand {
                              timedInvokeTimeout:mTimedInteractionTimeoutMs.HasValue()
                                  ? [NSNumber numberWithUnsignedShort:mTimedInteractionTimeoutMs.Value()]
                                  : nil
-                                    clientQueue:callbackQueue
+                                          queue:callbackQueue
                                      completion:^(
                                          NSArray<NSDictionary<NSString *, id> *> * _Nullable values, NSError * _Nullable error) {
                                          responsesNeeded--;

diff --git a/examples/darwin-framework-tool/commands/clusters/ModelCommandBridge.mm b/examples/darwin-framework-tool/commands/clusters/ModelCommandBridge.mm
@@ -31,25 +31,25 @@
     ChipLogProgress(chipTool, "Sending command to node 0x" ChipLogFormatX64, ChipLogValueX64(mNodeId));
     [commissioner getBaseDevice:mNodeId
                           queue:callbackQueue
-              completionHandler:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
-                  if (error != nil) {
-                      SetCommandExitStatus(error, "Error getting connected device");
-                      return;
-                  }
-
-                  CHIP_ERROR err;
-                  if (device == nil) {
-                      err = CHIP_ERROR_INTERNAL;
-                  } else {
-                      err = SendCommand(device, mEndPointId);
-                  }
-
-                  if (err != CHIP_NO_ERROR) {
-                      ChipLogError(chipTool, "Error: %s", chip::ErrorStr(err));
-                      SetCommandExitStatus(err);
-                      return;
-                  }
-              }];
+                     completion:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
+                         if (error != nil) {
+                             SetCommandExitStatus(error, "Error getting connected device");
+                             return;
+                         }
+
+                         CHIP_ERROR err;
+                         if (device == nil) {
+                             err = CHIP_ERROR_INTERNAL;
+                         } else {
+                             err = SendCommand(device, mEndPointId);
+                         }
+
+                         if (err != CHIP_NO_ERROR) {
+                             ChipLogError(chipTool, "Error: %s", chip::ErrorStr(err));
+                             SetCommandExitStatus(err);
+                             return;
+                         }
+                     }];
     return CHIP_NO_ERROR;
 }
 

diff --git a/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/ReportCommandBridge.h
@@ -60,7 +60,7 @@ class ReadAttribute : public ModelCommand {
                               clusterID:[NSNumber numberWithUnsignedInteger:mClusterId]
                             attributeID:[NSNumber numberWithUnsignedInteger:mAttributeId]
                                  params:params
-                            clientQueue:callbackQueue
+                                  queue:callbackQueue
                              completion:^(NSArray<NSDictionary<NSString *, id> *> * _Nullable values, NSError * _Nullable error) {
                                  if (error != nil) {
                                      LogNSError("Error reading attribute", error);
@@ -135,7 +135,7 @@ class SubscribeAttribute : public ModelCommand {
             minInterval:[NSNumber numberWithUnsignedInteger:mMinInterval]
             maxInterval:[NSNumber numberWithUnsignedInteger:mMaxInterval]
             params:params
-            clientQueue:callbackQueue
+            queue:callbackQueue
             reportHandler:^(NSArray<NSDictionary<NSString *, id> *> * _Nullable values, NSError * _Nullable error) {
                 if (values) {
                     for (id item in values) {

diff --git a/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h b/examples/darwin-framework-tool/commands/clusters/WriteAttributeCommandBridge.h
@@ -81,7 +81,7 @@ class WriteAttribute : public ModelCommand {
                        timedWriteTimeout:mTimedInteractionTimeoutMs.HasValue()
                            ? [NSNumber numberWithUnsignedShort:mTimedInteractionTimeoutMs.Value()]
                            : nil
-                             clientQueue:callbackQueue
+                                   queue:callbackQueue
                               completion:^(NSArray<NSDictionary<NSString *, id> *> * _Nullable values, NSError * _Nullable error) {
                                   if (error != nil) {
                                       LogNSError("Error writing attribute", error);

diff --git a/examples/darwin-framework-tool/commands/pairing/OpenCommissioningWindowCommand.mm b/examples/darwin-framework-tool/commands/pairing/OpenCommissioningWindowCommand.mm
@@ -34,19 +34,19 @@
         params.commissioningTimeout = @(mCommissioningWindowTimeoutMs);
         params.timedInvokeTimeoutMs = @(10000);
         [cluster openBasicCommissioningWindowWithParams:params
-                                      completionHandler:^(NSError * _Nullable error) {
-                                          if (error == nil) {
-                                              self->SetCommandExitStatus(CHIP_NO_ERROR);
-                                          } else {
-                                              self->SetCommandExitStatus(MTRErrorToCHIPErrorCode(error));
-                                          }
-                                      }];
+                                             completion:^(NSError * _Nullable error) {
+                                                 if (error == nil) {
+                                                     self->SetCommandExitStatus(CHIP_NO_ERROR);
+                                                 } else {
+                                                     self->SetCommandExitStatus(MTRErrorToCHIPErrorCode(error));
+                                                 }
+                                             }];
     } else {
         [device
             openCommissioningWindowWithSetupPasscode:[MTRSetupPayload generateRandomSetupPasscode]
                                        discriminator:@(mDiscriminator)
                                             duration:@(mCommissioningWindowTimeoutMs)
-                                         clientQueue:mWorkQueue
+                                               queue:mWorkQueue
                                           completion:^(MTRSetupPayload * _Nullable payload, NSError * error) {
                                               if (error != nil) {
                                                   self->SetCommandExitStatus(MTRErrorToCHIPErrorCode(error));

diff --git a/examples/darwin-framework-tool/commands/pairing/PairingCommandBridge.mm b/examples/darwin-framework-tool/commands/pairing/PairingCommandBridge.mm
@@ -111,46 +111,47 @@
 {
     dispatch_queue_t callbackQueue = dispatch_queue_create("com.chip-tool.command", DISPATCH_QUEUE_SERIAL);
     MTRDeviceController * commissioner = CurrentCommissioner();
-    [commissioner getBaseDevice:mNodeId
-                          queue:callbackQueue
-              completionHandler:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
-                  CHIP_ERROR err = CHIP_NO_ERROR;
-                  if (error) {
-                      err = MTRErrorToCHIPErrorCode(error);
-                      LogNSError("Error: ", error);
-                      SetCommandExitStatus(err);
-                  } else if (device == nil) {
-                      ChipLogError(chipTool, "Error: %s", chip::ErrorStr(CHIP_ERROR_INTERNAL));
-                      SetCommandExitStatus(CHIP_ERROR_INTERNAL);
-                  } else {
-                      ChipLogProgress(chipTool, "Attempting to unpair device %llu", mNodeId);
-                      MTRBaseClusterOperationalCredentials * opCredsCluster =
-                          [[MTRBaseClusterOperationalCredentials alloc] initWithDevice:device endpoint:@(0) queue:callbackQueue];
-                      [opCredsCluster readAttributeCurrentFabricIndexWithCompletionHandler:^(
-                          NSNumber * _Nullable value, NSError * _Nullable readError) {
-                          if (readError) {
-                              CHIP_ERROR readErr = MTRErrorToCHIPErrorCode(readError);
-                              LogNSError("Failed to get current fabric: ", readError);
-                              SetCommandExitStatus(readErr);
-                              return;
-                          }
-                          MTROperationalCredentialsClusterRemoveFabricParams * params =
-                              [[MTROperationalCredentialsClusterRemoveFabricParams alloc] init];
-                          params.fabricIndex = value;
-                          [opCredsCluster
-                              removeFabricWithParams:params
-                                   completionHandler:^(MTROperationalCredentialsClusterNOCResponseParams * _Nullable data,
-                                       NSError * _Nullable removeError) {
-                                       CHIP_ERROR removeErr = CHIP_NO_ERROR;
-                                       if (removeError) {
-                                           removeErr = MTRErrorToCHIPErrorCode(removeError);
-                                           LogNSError("Failed to remove current fabric: ", removeError);
-                                       } else {
-                                           ChipLogProgress(chipTool, "Successfully unpaired deviceId %llu", mNodeId);
-                                       }
-                                       SetCommandExitStatus(removeErr);
-                                   }];
-                      }];
-                  }
-              }];
+    [commissioner
+        getBaseDevice:mNodeId
+                queue:callbackQueue
+           completion:^(MTRBaseDevice * _Nullable device, NSError * _Nullable error) {
+               CHIP_ERROR err = CHIP_NO_ERROR;
+               if (error) {
+                   err = MTRErrorToCHIPErrorCode(error);
+                   LogNSError("Error: ", error);
+                   SetCommandExitStatus(err);
+               } else if (device == nil) {
+                   ChipLogError(chipTool, "Error: %s", chip::ErrorStr(CHIP_ERROR_INTERNAL));
+                   SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+               } else {
+                   ChipLogProgress(chipTool, "Attempting to unpair device %llu", mNodeId);
+                   MTRBaseClusterOperationalCredentials * opCredsCluster =
+                       [[MTRBaseClusterOperationalCredentials alloc] initWithDevice:device endpoint:@(0) queue:callbackQueue];
+                   [opCredsCluster
+                       readAttributeCurrentFabricIndexWithCompletion:^(NSNumber * _Nullable value, NSError * _Nullable readError) {
+                           if (readError) {
+                               CHIP_ERROR readErr = MTRErrorToCHIPErrorCode(readError);
+                               LogNSError("Failed to get current fabric: ", readError);
+                               SetCommandExitStatus(readErr);
+                               return;
+                           }
+                           MTROperationalCredentialsClusterRemoveFabricParams * params =
+                               [[MTROperationalCredentialsClusterRemoveFabricParams alloc] init];
+                           params.fabricIndex = value;
+                           [opCredsCluster
+                               removeFabricWithParams:params
+                                           completion:^(MTROperationalCredentialsClusterNOCResponseParams * _Nullable data,
+                                               NSError * _Nullable removeError) {
+                                               CHIP_ERROR removeErr = CHIP_NO_ERROR;
+                                               if (removeError) {
+                                                   removeErr = MTRErrorToCHIPErrorCode(removeError);
+                                                   LogNSError("Failed to remove current fabric: ", removeError);
+                                               } else {
+                                                   ChipLogProgress(chipTool, "Successfully unpaired deviceId %llu", mNodeId);
+                                               }
+                                               SetCommandExitStatus(removeErr);
+                                           }];
+                       }];
+               }
+           }];
 }
diff --git a/examples/darwin-framework-tool/commands/provider/OTAProviderDelegate.h b/examples/darwin-framework-tool/commands/provider/OTAProviderDelegate.h
@@ -41,20 +41,20 @@ typedef NS_ENUM(uint8_t, UserConsentState) {
 - (void)handleQueryImageForNodeID:(NSNumber * _Nonnull)nodeID
                        controller:(MTRDeviceController * _Nonnull)controller
                            params:(MTROtaSoftwareUpdateProviderClusterQueryImageParams * _Nonnull)params
-                completionHandler:(void (^_Nonnull)(MTROtaSoftwareUpdateProviderClusterQueryImageResponseParams * _Nullable data,
-                                      NSError * _Nullable error))completionHandler;
+                       completion:(void (^_Nonnull)(MTROtaSoftwareUpdateProviderClusterQueryImageResponseParams * _Nullable data,
+                                      NSError * _Nullable error))completion;
 
 - (void)handleApplyUpdateRequestForNodeID:(NSNumber * _Nonnull)nodeID
                                controller:(MTRDeviceController * _Nonnull)controller
                                    params:(MTROtaSoftwareUpdateProviderClusterApplyUpdateRequestParams * _Nonnull)params
-                        completionHandler:
-                            (void (^_Nonnull)(MTROtaSoftwareUpdateProviderClusterApplyUpdateResponseParams * _Nullable data,
-                                NSError * _Nullable error))completionHandler;
+                               completion:
+                                   (void (^_Nonnull)(MTROtaSoftwareUpdateProviderClusterApplyUpdateResponseParams * _Nullable data,
+                                       NSError * _Nullable error))completion;
 
 - (void)handleNotifyUpdateAppliedForNodeID:(NSNumber * _Nonnull)nodeID
                                 controller:(MTRDeviceController * _Nonnull)controller
                                     params:(MTROtaSoftwareUpdateProviderClusterNotifyUpdateAppliedParams * _Nonnull)params
-                         completionHandler:(StatusCompletion _Nonnull)completionHandler;
+                                completion:(MTRStatusCompletion _Nonnull)completion;
 
 @property (strong, nonatomic, nullable) NSArray<DeviceSoftwareVersionModel *> * candidates;
 @property (strong, nonatomic, nullable) DeviceSoftwareVersionModel * selectedCandidate;