Add a way to do non-fabric-filtered reads on Darwin. (#15353)

We only add the new ReadParams for attributes that are actually
fabric-scoped lists for now.

src/darwin/Framework/CHIP/CHIPCluster.h

@@ -33,4 +33,19 @@ NS_ASSUME_NONNULL_BEGIN
 + (instancetype)new NS_UNAVAILABLE;
 @end
 
+/**
+ * CHIPReadParams
+ *    This is used to control the behavior of attribute reads.
+ */
+@interface CHIPReadParams : NSObject
+
+/**
+ * Whether the read is fabric-filtered. nil (the default), or YES value,
+ * means fabric-filtered.  NO means not fabric-filtered.
+ */
+@property (strong, nonatomic, nullable) NSNumber * fabricFiltered;
+
+- (instancetype)init;
+@end
+
 NS_ASSUME_NONNULL_END

src/darwin/Framework/CHIP/CHIPCluster.mm

@@ -59,3 +59,14 @@ - (instancetype)initWithDevice:(CHIPDevice *)device endpoint:(EndpointId)endpoin
         [value lengthOfBytesUsingEncoding:NSUTF8StringEncoding]);
 }
 @end
+
+@implementation CHIPReadParams
+- (instancetype)init
+{
+    if (self = [super init]) {
+        _fabricFiltered = nil;
+    }
+    return self;
+}
+
+@end

src/darwin/Framework/CHIP/templates/CHIPClustersObjc-src.zapt

@@ -83,7 +83,13 @@ using namespace chip::app::Clusters;
 
 {{#chip_server_cluster_attributes}}
 {{#*inline "attribute"}}Attribute{{asUpperCamelCase name}}{{/inline}}
-- (void)read{{>attribute}}WithCompletionHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completionHandler
+- (void)read{{>attribute}}With
+{{~#if_is_fabric_scoped_struct type~}}
+  Params:(CHIPReadParams * _Nullable)params completionHandler:
+{{~else~}}
+  CompletionHandler:
+{{~/if_is_fabric_scoped_struct~}}
+(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completionHandler
 {
     new CHIP{{>attribute_data_callback_name}}CallbackBridge(self.callbackQueue,
       {{! This treats completionHandler as taking an id for the data.  This is
@@ -93,7 +99,11 @@ using namespace chip::app::Clusters;
           using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo;
           auto successFn = Callback<{{>attribute_data_callback_name}}Callback>::FromCancelable(success);
           auto failureFn = Callback<CHIPDefaultFailureCallbackType>::FromCancelable(failure);
-          return self.cppCluster.ReadAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall);
+          return self.cppCluster.ReadAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall
+          {{~#if_is_fabric_scoped_struct type~}}
+          , params == nil || params.fabricFiltered == nil || [params.fabricFiltered boolValue]
+          {{~/if_is_fabric_scoped_struct~}}
+          );
       });
 }
 
@@ -126,7 +136,11 @@ using namespace chip::app::Clusters;
 
 {{/if}}
 {{#if isReportableAttribute}}
-- (void) subscribe{{>attribute}}WithMinInterval:(NSNumber * _Nonnull)minInterval  maxInterval:(NSNumber * _Nonnull)maxInterval subscriptionEstablished:(SubscriptionEstablishedHandler _Nullable)subscriptionEstablishedHandler reportHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))reportHandler
+- (void) subscribe{{>attribute}}WithMinInterval:(NSNumber * _Nonnull)minInterval  maxInterval:(NSNumber * _Nonnull)maxInterval
+{{#if_is_fabric_scoped_struct type}}
+params:(CHIPReadParams * _Nullable)params
+{{/if_is_fabric_scoped_struct}}
+subscriptionEstablished:(SubscriptionEstablishedHandler _Nullable)subscriptionEstablishedHandler reportHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))reportHandler
 {
     new CHIP{{>attribute_data_callback_name}}CallbackSubscriptionBridge(self.callbackQueue,
       {{! This treats reportHandler as taking an id for the data.  This is
@@ -136,7 +150,11 @@ using namespace chip::app::Clusters;
           using TypeInfo = {{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo;
           auto successFn = Callback<{{>attribute_data_callback_name}}Callback>::FromCancelable(success);
           auto failureFn = Callback<CHIPDefaultFailureCallbackType>::FromCancelable(failure);
-          return self.cppCluster.SubscribeAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall, [minInterval unsignedShortValue], [maxInterval unsignedShortValue], CHIP{{>attribute_data_callback_name}}CallbackSubscriptionBridge::OnSubscriptionEstablished);
+          return self.cppCluster.SubscribeAttribute<TypeInfo>(successFn->mContext, successFn->mCall, failureFn->mCall, [minInterval unsignedShortValue], [maxInterval unsignedShortValue], CHIP{{>attribute_data_callback_name}}CallbackSubscriptionBridge::OnSubscriptionEstablished
+          {{~#if_is_fabric_scoped_struct type~}}
+          , params == nil || params.fabricFiltered == nil || [params.fabricFiltered boolValue]
+          {{~/if_is_fabric_scoped_struct~}}
+          );
       }, subscriptionEstablishedHandler);
 }
 

src/darwin/Framework/CHIP/templates/CHIPClustersObjc.zapt

@@ -39,12 +39,22 @@ NS_ASSUME_NONNULL_BEGIN
 
 {{#chip_server_cluster_attributes}}
 {{#*inline "attribute"}}Attribute{{asUpperCamelCase name}}{{/inline}}
-- (void)read{{>attribute}}WithCompletionHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completionHandler;
+- (void)read{{>attribute}}With
+{{~#if_is_fabric_scoped_struct type~}}
+  Params:(CHIPReadParams * _Nullable)params completionHandler:
+{{~else~}}
+  CompletionHandler:
+{{~/if_is_fabric_scoped_struct~}}
+(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))completionHandler;
 {{#if isWritableAttribute}}
 - (void)write{{>attribute}}WithValue:({{asObjectiveCType type parent.name}})value completionHandler:(StatusCompletion)completionHandler;
 {{/if}}
 {{#if isReportableAttribute}}
-- (void) subscribe{{>attribute}}WithMinInterval:(NSNumber * _Nonnull)minInterval  maxInterval:(NSNumber * _Nonnull)maxInterval subscriptionEstablished:(SubscriptionEstablishedHandler _Nullable)subscriptionEstablishedHandler reportHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))reportHandler;
+- (void) subscribe{{>attribute}}WithMinInterval:(NSNumber * _Nonnull)minInterval  maxInterval:(NSNumber * _Nonnull)maxInterval
+{{#if_is_fabric_scoped_struct type}}
+params:(CHIPReadParams * _Nullable)params
+{{/if_is_fabric_scoped_struct}}
+subscriptionEstablished:(SubscriptionEstablishedHandler _Nullable)subscriptionEstablishedHandler reportHandler:(void (^)({{asObjectiveCClass type parent.name}} * _Nullable value, NSError * _Nullable error))reportHandler;
 {{/if}}
 {{/chip_server_cluster_attributes}}
 

src/darwin/Framework/CHIP/templates/partials/test_cluster.zapt

@@ -53,8 +53,15 @@ ResponseHandler {{> subscribeDataCallback}} = nil;
     {{#chip_tests_item_parameters}}
     {{asObjectiveCBasicType type}} {{asLowerCamelCase name}}Argument = {{asTypedLiteral definedValue type}};
     {{/chip_tests_item_parameters}}
+    {{#if_is_fabric_scoped_struct attributeObject.type}}
+    CHIPReadParams * params = [[CHIPReadParams alloc] init];
+    params.fabricFiltered = [NSNumber numberWithBool:{{fabricFiltered}}];
+    {{/if_is_fabric_scoped_struct}}
     [cluster subscribeAttribute{{asUpperCamelCase attribute}}WithMinInterval:@(minIntervalArgument)
                                                                  maxInterval:@(maxIntervalArgument)
+          {{#if_is_fabric_scoped_struct attributeObject.type}}
+                                                                      params:params
+          {{/if_is_fabric_scoped_struct}}
                                                      subscriptionEstablished:^{
         XCTAssertEqual(testSendCluster{{parent.filename}}_{{asTestIndex waitForReport.index}}_{{asUpperCamelCase waitForReport.command}}_Fulfilled, true);
         [expectation fulfill];
@@ -63,7 +70,14 @@ ResponseHandler {{> subscribeDataCallback}} = nil;
     {{else if isWaitForReport}}
     {{> subscribeDataCallback }} = ^({{asObjectiveCClass attributeObject.type cluster forceList=attributeObject.isArray}} * _Nullable value, NSError * _Nullable err) {
     {{else if isReadAttribute}}
-    [cluster readAttribute{{asUpperCamelCase attribute}}WithCompletionHandler:^({{asObjectiveCClass attributeObject.type cluster forceList=attributeObject.isArray}} * _Nullable value, NSError * _Nullable err) {
+    {{#if_is_fabric_scoped_struct attributeObject.type}}
+    CHIPReadParams * params = [[CHIPReadParams alloc] init];
+    params.fabricFiltered = [NSNumber numberWithBool:{{fabricFiltered}}];
+    [cluster readAttribute{{asUpperCamelCase attribute}}WithParams:params completionHandler:
+    {{else}}
+    [cluster readAttribute{{asUpperCamelCase attribute}}WithCompletionHandler:
+    {{/if_is_fabric_scoped_struct}}
+    ^({{asObjectiveCClass attributeObject.type cluster forceList=attributeObject.isArray}} * _Nullable value, NSError * _Nullable err) {
     {{else if isWriteAttribute}}
     {{#chip_tests_item_parameters}}
     id {{asLowerCamelCase name}}Argument;