[Darwin] Rename MTRDevicePairingDelegate to MTRDeviceControllerDelega…

…te and MTRPairingStatus to MTRCommissioningStatus (#22633)

* [Darwin] Rename MTRDevicePairingDelegate to MTRDeviceControllerDelegate

* [Darwin] Rename MTRPairingStatus to MTRCommissioningStatus

examples/darwin-framework-tool/BUILD.gn

@@ -99,10 +99,10 @@ executable("darwin-framework-tool") {
     "commands/common/MTRError_Utils.h",
     "commands/common/MTRLogging.h",
     "commands/pairing/Commands.h",
+    "commands/pairing/DeviceControllerDelegateBridge.mm",
     "commands/pairing/OpenCommissioningWindowCommand.h",
     "commands/pairing/OpenCommissioningWindowCommand.mm",
     "commands/pairing/PairingCommandBridge.mm",
-    "commands/pairing/PairingDelegateBridge.mm",
     "commands/payload/SetupPayloadParseCommand.mm",
     "commands/provider/Commands.h",
     "commands/provider/OTAProviderDelegate.mm",

examples/darwin-framework-tool/commands/pairing/PairingDelegateBridge.h → examples/darwin-framework-tool/commands/pairing/DeviceControllerDelegateBridge.h

@@ -20,7 +20,7 @@
 
 #import <Matter/Matter.h>
 
-@interface CHIPToolPairingDelegate : NSObject <MTRDevicePairingDelegate>
+@interface CHIPToolDeviceControllerDelegate : NSObject <MTRDeviceControllerDelegate>
 @property PairingCommandBridge * commandBridge;
 @property chip::NodeId deviceID;
 @property MTRDeviceController * commissioner;

examples/darwin-framework-tool/commands/pairing/PairingDelegateBridge.mm → examples/darwin-framework-tool/commands/pairing/DeviceControllerDelegateBridge.mm

@@ -16,29 +16,29 @@
  *
  */
 
-#include "PairingDelegateBridge.h"
+#include "DeviceControllerDelegateBridge.h"
 #import <Matter/Matter.h>
 
-@interface CHIPToolPairingDelegate ()
+@interface CHIPToolDeviceControllerDelegate ()
 @end
 
-@implementation CHIPToolPairingDelegate
-- (void)onStatusUpdate:(MTRPairingStatus)status
+@implementation CHIPToolDeviceControllerDelegate
+- (void)onStatusUpdate:(MTRCommissioningStatus)status
 {
     NSLog(@"Pairing Status Update: %lu", status);
     switch (status) {
-    case MTRPairingStatusSuccess:
+    case MTRCommissioningStatusSuccess:
         ChipLogProgress(chipTool, "Secure Pairing Success");
         ChipLogProgress(chipTool, "CASE establishment successful");
         break;
-    case MTRPairingStatusFailed:
+    case MTRCommissioningStatusFailed:
         ChipLogError(chipTool, "Secure Pairing Failed");
         _commandBridge->SetCommandExitStatus(CHIP_ERROR_INCORRECT_STATE);
         break;
-    case MTRPairingStatusDiscoveringMoreDevices:
+    case MTRCommissioningStatusDiscoveringMoreDevices:
         ChipLogProgress(chipTool, "Secure Pairing Discovering More Devices");
         break;
-    case MTRPairingStatusUnknown:
+    case MTRCommissioningStatusUnknown:
         ChipLogError(chipTool, "Uknown Pairing Status");
         break;
     }

examples/darwin-framework-tool/commands/pairing/PairingCommandBridge.h

@@ -78,7 +78,7 @@ class PairingCommandBridge : public CHIPCommandBridge
     void PairWithCode(NSError * __autoreleasing * error);
     void PairWithPayload(NSError * __autoreleasing * error);
     void Unpair();
-    void SetUpPairingDelegate();
+    void SetUpDeviceControllerDelegate();
 
     const PairingMode mPairingMode;
     const PairingNetworkType mNetworkType;

examples/darwin-framework-tool/commands/pairing/PairingCommandBridge.mm

@@ -19,23 +19,23 @@
 #import <Matter/Matter.h>
 
 #include "../common/CHIPCommandBridge.h"
+#include "DeviceControllerDelegateBridge.h"
 #include "PairingCommandBridge.h"
-#include "PairingDelegateBridge.h"
 #include <lib/support/logging/CHIPLogging.h>
 
 #import "MTRError_Utils.h"
 
 using namespace ::chip;
 using namespace ::chip::Controller;
 
-void PairingCommandBridge::SetUpPairingDelegate()
+void PairingCommandBridge::SetUpDeviceControllerDelegate()
 {
     dispatch_queue_t callbackQueue = dispatch_queue_create("com.chip.pairing", DISPATCH_QUEUE_SERIAL);
-    CHIPToolPairingDelegate * pairing = [[CHIPToolPairingDelegate alloc] init];
+    CHIPToolDeviceControllerDelegate * deviceControllerDelegate = [[CHIPToolDeviceControllerDelegate alloc] init];
     MTRCommissioningParameters * params = [[MTRCommissioningParameters alloc] init];
     MTRDeviceController * commissioner = CurrentCommissioner();
 
-    [pairing setDeviceID:mNodeId];
+    [deviceControllerDelegate setDeviceID:mNodeId];
     switch (mNetworkType) {
     case PairingNetworkType::None:
     case PairingNetworkType::Ethernet:
@@ -49,11 +49,11 @@
         break;
     }
 
-    [pairing setCommandBridge:this];
-    [pairing setParams:params];
-    [pairing setCommissioner:commissioner];
+    [deviceControllerDelegate setCommandBridge:this];
+    [deviceControllerDelegate setParams:params];
+    [deviceControllerDelegate setCommissioner:commissioner];
 
-    [commissioner setPairingDelegate:pairing queue:callbackQueue];
+    [commissioner setDeviceControllerDelegate:deviceControllerDelegate queue:callbackQueue];
 }
 
 CHIP_ERROR PairingCommandBridge::RunCommand()
@@ -79,7 +79,7 @@
 
 void PairingCommandBridge::PairWithCode(NSError * __autoreleasing * error)
 {
-    SetUpPairingDelegate();
+    SetUpDeviceControllerDelegate();
     auto * payload = [[MTRSetupPayload alloc] initWithSetupPasscode:@(mSetupPINCode) discriminator:@(mDiscriminator)];
     MTRDeviceController * commissioner = CurrentCommissioner();
     [commissioner setupCommissioningSessionWithPayload:payload newNodeID:@(mNodeId) error:error];
@@ -88,7 +88,7 @@
 void PairingCommandBridge::PairWithPayload(NSError * __autoreleasing * error)
 {
     NSString * onboardingPayload = [NSString stringWithUTF8String:mOnboardingPayload];
-    SetUpPairingDelegate();
+    SetUpDeviceControllerDelegate();
     auto * payload = [MTRSetupPayload setupPayloadWithOnboardingPayload:onboardingPayload error:error];
     if (payload == nil) {
         return;

examples/darwin-framework-tool/commands/tests/TestCommandBridge.h

@@ -43,12 +43,12 @@ const char * getScriptsFolder() { return basePath; }
 
 constexpr const char * kDefaultKey = "default";
 
-@interface TestPairingDelegate : NSObject <MTRDevicePairingDelegate>
+@interface TestDeviceControllerDelegate : NSObject <MTRDeviceControllerDelegate>
 @property TestCommandBridge * commandBridge;
 @property chip::NodeId deviceId;
 @property BOOL active; // Whether to pass on notifications to the commandBridge
 
-- (void)onStatusUpdate:(MTRPairingStatus)status;
+- (void)onStatusUpdate:(MTRCommissioningStatus)status;
 - (void)onPairingComplete:(NSError * _Nullable)error;
 - (void)onPairingDeleted:(NSError * _Nullable)error;
 - (void)onCommissioningComplete:(NSError * _Nullable)error;
@@ -70,7 +70,7 @@ class TestCommandBridge : public CHIPCommandBridge,
 public:
     TestCommandBridge(const char * _Nonnull commandName)
         : CHIPCommandBridge(commandName)
-        , mPairingDelegate([[TestPairingDelegate alloc] initWithTestCommandBridge:this])
+        , mDeviceControllerDelegate([[TestDeviceControllerDelegate alloc] initWithTestCommandBridge:this])
     {
         AddArgument("delayInMs", 0, UINT64_MAX, &mDelayInMs);
         AddArgument("PICS", &mPICSFilePath);
@@ -183,9 +183,9 @@ class TestCommandBridge : public CHIPCommandBridge,
 
         SetIdentity(identity);
 
-        [controller setPairingDelegate:mPairingDelegate queue:mCallbackQueue];
-        [mPairingDelegate setDeviceId:value.nodeId];
-        [mPairingDelegate setActive:YES];
+        [controller setDeviceControllerDelegate:mDeviceControllerDelegate queue:mCallbackQueue];
+        [mDeviceControllerDelegate setDeviceId:value.nodeId];
+        [mDeviceControllerDelegate setActive:YES];
 
         NSString * payloadStr = [[NSString alloc] initWithBytes:value.payload.data()
                                                          length:value.payload.size()
@@ -521,21 +521,21 @@ class TestCommandBridge : public CHIPCommandBridge,
     }
 
 private:
-    TestPairingDelegate * _Nonnull mPairingDelegate;
+    TestDeviceControllerDelegate * _Nonnull mDeviceControllerDelegate;
 
     // Set of our connected devices, keyed by identity.
     std::map<std::string, MTRBaseDevice *> mConnectedDevices;
 };
 
 NS_ASSUME_NONNULL_BEGIN
 
-@implementation TestPairingDelegate
-- (void)onStatusUpdate:(MTRPairingStatus)status
+@implementation TestDeviceControllerDelegate
+- (void)onStatusUpdate:(MTRCommissioningStatus)status
 {
     if (_active) {
-        if (status == MTRPairingStatusSuccess) {
+        if (status == MTRCommissioningStatusSuccess) {
             NSLog(@"Secure pairing success");
-        } else if (status == MTRPairingStatusFailed) {
+        } else if (status == MTRCommissioningStatusFailed) {
             _active = NO;
             NSLog(@"Secure pairing failed");
             _commandBridge->OnStatusUpdate(chip::app::StatusIB(chip::Protocols::InteractionModel::Status::Failure));

src/darwin/CHIPTool/CHIPTool/View Controllers/QRCode/QRCodeViewController.h

@@ -21,6 +21,6 @@
 #import <UIKit/UIKit.h>
 
 @interface QRCodeViewController
-    : UIViewController <AVCaptureMetadataOutputObjectsDelegate, MTRDevicePairingDelegate, NFCNDEFReaderSessionDelegate>
+    : UIViewController <AVCaptureMetadataOutputObjectsDelegate, MTRDeviceControllerDelegate, NFCNDEFReaderSessionDelegate>
 
 @end

src/darwin/CHIPTool/CHIPTool/View Controllers/QRCode/QRCodeViewController.m

@@ -489,7 +489,7 @@ - (void)setVendorIDOnAccessory
     }
 }
 
-// MARK: MTRDevicePairingDelegate
+// MARK: MTRDeviceControllerDelegate
 - (void)onPairingComplete:(NSError * _Nullable)error
 {
     if (error != nil) {

src/darwin/Framework/CHIP/MTRDeviceController.h

@@ -24,7 +24,7 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @class MTRCommissioningParameters;
-@protocol MTRDevicePairingDelegate;
+@protocol MTRDeviceControllerDelegate;
 @class MTRSetupPayload;
 
 @interface MTRDeviceController : NSObject
@@ -109,7 +109,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @param[in] queue The queue on which the callbacks will be delivered
  */
-- (void)setPairingDelegate:(id<MTRDevicePairingDelegate>)delegate queue:(dispatch_queue_t)queue;
+- (void)setDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate queue:(dispatch_queue_t)queue;
 
 /**
  * Sets this MTRDeviceController to use the given issuer for issuing operational certs. By default, the MTRDeviceController uses an

src/darwin/Framework/CHIP/MTRDeviceController.mm

@@ -20,10 +20,10 @@
 
 #import "MTRBaseDevice_Internal.h"
 #import "MTRCommissioningParameters.h"
+#import "MTRDeviceControllerDelegateBridge.h"
 #import "MTRDeviceControllerFactory_Internal.h"
 #import "MTRDeviceControllerStartupParams.h"
 #import "MTRDeviceControllerStartupParams_Internal.h"
-#import "MTRDevicePairingDelegateBridge.h"
 #import "MTRDevice_Internal.h"
 #import "MTRError_Internal.h"
 #import "MTRKeypair.h"
@@ -83,7 +83,7 @@ @interface MTRDeviceController ()
 
 @property (readonly) chip::Controller::DeviceCommissioner * cppCommissioner;
 @property (readonly) chip::Credentials::PartialDACVerifier * partialDACVerifier;
-@property (readonly) MTRDevicePairingDelegateBridge * pairingDelegateBridge;
+@property (readonly) MTRDeviceControllerDelegateBridge * deviceControllerDelegateBridge;
 @property (readonly) MTROperationalCredentialsDelegate * operationalCredentialsDelegate;
 @property (readonly) MTRP256KeypairBridge signingKeypairBridge;
 @property (readonly) MTRP256KeypairBridge operationalKeypairBridge;
@@ -103,8 +103,8 @@ - (instancetype)initWithFactory:(MTRDeviceControllerFactory *)factory queue:(dis
         _deviceMapLock = OS_UNFAIR_LOCK_INIT;
         _nodeIDToDeviceMap = [NSMutableDictionary dictionary];
 
-        _pairingDelegateBridge = new MTRDevicePairingDelegateBridge();
-        if ([self checkForInitError:(_pairingDelegateBridge != nullptr) logMsg:kErrorPairingInit]) {
+        _deviceControllerDelegateBridge = new MTRDeviceControllerDelegateBridge();
+        if ([self checkForInitError:(_deviceControllerDelegateBridge != nullptr) logMsg:kErrorPairingInit]) {
             return nil;
         }
 
@@ -183,9 +183,9 @@ - (void)cleanup
         _partialDACVerifier = nullptr;
     }
 
-    if (_pairingDelegateBridge) {
-        delete _pairingDelegateBridge;
-        _pairingDelegateBridge = nullptr;
+    if (_deviceControllerDelegateBridge) {
+        delete _deviceControllerDelegateBridge;
+        _deviceControllerDelegateBridge = nullptr;
     }
 }
 
@@ -255,7 +255,7 @@ - (BOOL)startup:(MTRDeviceControllerStartupParamsInternal *)startupParams
 
         chip::Controller::SetupParams commissionerParams;
 
-        commissionerParams.pairingDelegate = _pairingDelegateBridge;
+        commissionerParams.pairingDelegate = _deviceControllerDelegateBridge;
 
         _operationalCredentialsDelegate->SetDeviceCommissioner(_cppCommissioner);
 
@@ -533,10 +533,10 @@ - (void)removeDevice:(MTRDevice *)device
     os_unfair_lock_unlock(&_deviceMapLock);
 }
 
-- (void)setPairingDelegate:(id<MTRDevicePairingDelegate>)delegate queue:(dispatch_queue_t)queue
+- (void)setDeviceControllerDelegate:(id<MTRDeviceControllerDelegate>)delegate queue:(dispatch_queue_t)queue
 {
     dispatch_async(_chipWorkQueue, ^{
-        self->_pairingDelegateBridge->setDelegate(delegate, queue);
+        self->_deviceControllerDelegateBridge->setDelegate(delegate, queue);
     });
 }
 

src/darwin/Framework/CHIP/MTRDevicePairingDelegate.h → src/darwin/Framework/CHIP/MTRDeviceControllerDelegate.h

@@ -19,25 +19,25 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-typedef NS_ENUM(NSUInteger, MTRPairingStatus) {
-    MTRPairingStatusUnknown = 0,
-    MTRPairingStatusSuccess = 1,
-    MTRPairingStatusFailed = 2,
-    MTRPairingStatusDiscoveringMoreDevices = 3
+typedef NS_ENUM(NSUInteger, MTRCommissioningStatus) {
+    MTRCommissioningStatusUnknown = 0,
+    MTRCommissioningStatusSuccess = 1,
+    MTRCommissioningStatusFailed = 2,
+    MTRCommissioningStatusDiscoveringMoreDevices = 3
 };
 
 /**
- * The protocol definition for the MTRDevicePairingDelegate
+ * The protocol definition for the MTRDeviceControllerDelegate
  *
  * All delegate methods will be called on the supplied Delegate Queue.
  */
-@protocol MTRDevicePairingDelegate <NSObject>
+@protocol MTRDeviceControllerDelegate <NSObject>
 @optional
 /**
  * Notify the delegate when pairing status gets updated
  *
  */
-- (void)onStatusUpdate:(MTRPairingStatus)status;
+- (void)onStatusUpdate:(MTRCommissioningStatus)status;
 
 /**
  * Notify the delegate when pairing is completed

src/darwin/Framework/CHIP/MTRDevicePairingDelegateBridge.h → src/darwin/Framework/CHIP/MTRDeviceControllerDelegateBridge.h

@@ -15,20 +15,20 @@
  *    limitations under the License.
  */
 
-#import "MTRDevicePairingDelegate.h"
+#import "MTRDeviceControllerDelegate.h"
 
 #include <controller/CHIPDeviceController.h>
 #include <platform/CHIPDeviceBuildConfig.h>
 
 NS_ASSUME_NONNULL_BEGIN
 
-class MTRDevicePairingDelegateBridge : public chip::Controller::DevicePairingDelegate
+class MTRDeviceControllerDelegateBridge : public chip::Controller::DevicePairingDelegate
 {
 public:
-    MTRDevicePairingDelegateBridge();
-    ~MTRDevicePairingDelegateBridge();
+    MTRDeviceControllerDelegateBridge();
+    ~MTRDeviceControllerDelegateBridge();
 
-    void setDelegate(id<MTRDevicePairingDelegate> delegate, dispatch_queue_t queue);
+    void setDelegate(id<MTRDeviceControllerDelegate> delegate, dispatch_queue_t queue);
 
     void OnStatusUpdate(chip::Controller::DevicePairingDelegate::Status status) override;
 
@@ -39,10 +39,10 @@ class MTRDevicePairingDelegateBridge : public chip::Controller::DevicePairingDel
     void OnCommissioningComplete(chip::NodeId deviceId, CHIP_ERROR error) override;
 
 private:
-    _Nullable id<MTRDevicePairingDelegate> mDelegate;
+    _Nullable id<MTRDeviceControllerDelegate> mDelegate;
     _Nullable dispatch_queue_t mQueue;
 
-    MTRPairingStatus MapStatus(chip::Controller::DevicePairingDelegate::Status status);
+    MTRCommissioningStatus MapStatus(chip::Controller::DevicePairingDelegate::Status status);
 };
 
 NS_ASSUME_NONNULL_END