Implement init methods for Darwin structs (#11986)

project-chip · Feb 13, 2024 · e76a525 · e76a525
1 parent 0faaac2
commit e76a525
Show file tree

Hide file tree

Showing 10 changed files with 5,029 additions and 8 deletions.
diff --git a/src/darwin/Framework/CHIP/templates/CHIPCommandPayloadsObjc-src.zapt b/src/darwin/Framework/CHIP/templates/CHIPCommandPayloadsObjc-src.zapt
@@ -2,10 +2,23 @@
 
 #import "CHIPCommandPayloadsObjc.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 {{#zcl_clusters}}
 {{#zcl_commands}}
 @implementation CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}Payload
+- (instancetype)init
+{
+  if (self = [super init]) {
+    {{#zcl_command_arguments}}
+    {{>init_struct_member label=label type=type cluster=parent.parent.name}}
+    {{/zcl_command_arguments}}
+  }
+  return self;
+}
 @end
 
 {{/zcl_commands}}
 {{/zcl_clusters}}
+
+NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/CHIP/templates/CHIPCommandPayloadsObjc.zapt b/src/darwin/Framework/CHIP/templates/CHIPCommandPayloadsObjc.zapt
@@ -6,6 +6,8 @@
 #import <Foundation/Foundation.h>
 #import <CHIP/CHIPStructsObjc.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 {{#zcl_clusters}}
 {{#zcl_commands}}
 @interface CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}Payload : NSObject
@@ -14,8 +16,12 @@
 {{#zcl_command_arguments}}
 @property (strong, nonatomic{{#unless (isStrEqual (asGetterName label) (asStructPropertyName label))}}, getter={{asGetterName label}}{{/unless}}) {{asObjectiveCType type parent.parent.name}} {{asStructPropertyName label}};
 {{/zcl_command_arguments}}
-@end
+ - (instancetype)init;
+ @end
 
 {{/zcl_commands}}
 {{/zcl_clusters}}
+
+NS_ASSUME_NONNULL_END
+
 #endif /* CHIP_COMMAND_PAYLOADS_H */
diff --git a/src/darwin/Framework/CHIP/templates/CHIPStructsObjc-src.zapt b/src/darwin/Framework/CHIP/templates/CHIPStructsObjc-src.zapt
@@ -2,10 +2,23 @@
 
 #import "CHIPStructsObjc.h"
 
+NS_ASSUME_NONNULL_BEGIN
+
 {{#zcl_clusters}}
 {{#zcl_structs}}
 @implementation CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}
+- (instancetype)init
+{
+  if (self = [super init]) {
+    {{#zcl_struct_items}}
+    {{>init_struct_member label=label type=type cluster=parent.parent.name}}
+    {{/zcl_struct_items}}
+  }
+  return self;
+}
 @end
 
 {{/zcl_structs}}
 {{/zcl_clusters}}
+
+NS_ASSUME_NONNULL_END
diff --git a/src/darwin/Framework/CHIP/templates/CHIPStructsObjc.zapt b/src/darwin/Framework/CHIP/templates/CHIPStructsObjc.zapt
@@ -5,6 +5,8 @@
 
 #import <Foundation/Foundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 {{#zcl_clusters}}
 {{#zcl_structs}}
 @interface CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}} : NSObject
@@ -13,9 +15,12 @@
 {{#zcl_struct_items}}
 @property (strong, nonatomic{{#unless (isStrEqual (asGetterName label) (asStructPropertyName label))}}, getter={{asGetterName label}}{{/unless}}) {{asObjectiveCType type parent.parent.name}} {{asStructPropertyName label}};
 {{/zcl_struct_items}}
+- (instancetype)init;
 @end
 
 {{/zcl_structs}}
 {{/zcl_clusters}}
 
+NS_ASSUME_NONNULL_END
+
 #endif /* CHIP_STRUCTS_H */
diff --git a/src/darwin/Framework/CHIP/templates/partials/init_struct_member.zapt b/src/darwin/Framework/CHIP/templates/partials/init_struct_member.zapt
@@ -0,0 +1,19 @@
+{{#*inline "memberName"}}_{{asStructPropertyName label}}{{/inline}}
+{{#if isOptional}}
+{{>memberName}} = nil;
+{{else if isNullable}}
+{{>memberName}} = nil;
+{{else if isArray}}
+  {{>memberName}} = [NSArray array];
+{{else if (isOctetString type)}}
+  {{>memberName}} = [NSData data];
+{{else if (isCharString type)}}
+  {{>memberName}} = @"";
+{{else}}
+  {{! Our memberName inline partial won't work inside the async if_is_struct }}
+  {{#if_is_struct type}}
+    _{{asStructPropertyName label}} = [{{asObjectiveCClass type cluster}} new];
+  {{else}}
+    _{{asStructPropertyName label}} = @(0);
+  {{/if_is_struct}}
+{{/if}}
diff --git a/src/darwin/Framework/CHIP/templates/templates.json b/src/darwin/Framework/CHIP/templates/templates.json
@@ -39,6 +39,10 @@
         {
             "name": "check_test_value",
             "path": "partials/check_test_value.zapt"
+        },
+        {
+            "name": "init_struct_member",
+            "path": "partials/init_struct_member.zapt"
         }
     ],
     "templates": [