Replacing a state helper such as chip_server_cluster_attributes with …

…a stateless helper zcl_attributes_server such that we can get deprecate the stateful helpers one by one. Also deprecating if_basic_global_response with if_basic_attribute. The generation diff that is being seen here pertains to generating all server attributes for the corresponding client clusters instead of hacking the server attributes in the zap file. The hack here referes to how server attributes being generated are those attributes which have been enabled without the corresponding server cluster enabled. To avoid this hack, the code now generates all server attributes for the corresponding client cluster. This seems to be in sync with the non java/python templates in terms of generation. Another generation diff seen here is that there is no basic global response for certain attributes which refer to atomic types such as group_id and vendor_id. I am not sure why that is the case. These attributes seem basic enough. Updating the zap being used - Updating min zap version to 3.16 instead of 3.17 - Github: ZAP#898
project-chip · Mar 22, 2023 · 8f5ec21 · 8f5ec21
1 parent 6be032d
commit 8f5ec21
Show file tree

Hide file tree

Showing 22 changed files with 12,710 additions and 1,045 deletions.
diff --git a/src/controller/java/generated/java/chip/devicecontroller/ClusterWriteMapping.java b/src/controller/java/generated/java/chip/devicecontroller/ClusterWriteMapping.java
diff --git a/src/controller/java/templates/CHIPAttributeTLVValueDecoder-src.zapt b/src/controller/java/templates/CHIPAttributeTLVValueDecoder-src.zapt
@@ -42,7 +42,7 @@ jobject DecodeAttributeValue(const app::ConcreteAttributePath & aPath, TLV::TLVR
             using namespace app::Clusters::{{asUpperCamelCase name}};
             switch (aPath.mAttributeId)
             {
-                {{#chip_server_cluster_attributes}}
+                {{#zcl_attributes_server removeKeys='isOptional'}}
                 case Attributes::{{asUpperCamelCase name}}::Id: {
                     using TypeInfo = Attributes::{{asUpperCamelCase name}}::TypeInfo;
                     TypeInfo::DecodableType cppValue;
@@ -54,7 +54,7 @@ jobject DecodeAttributeValue(const app::ConcreteAttributePath & aPath, TLV::TLVR
                     {{>decode_value target="value" source="cppValue" cluster=(asUpperCamelCase parent.name) depth=0 earlyReturn="nullptr"}}
                     return value;
                 }
-                {{/chip_server_cluster_attributes}}
+                {{/zcl_attributes_server}}
                 default:
                     *aError = CHIP_ERROR_IM_MALFORMED_ATTRIBUTE_PATH_IB;
                     break;

diff --git a/src/controller/java/templates/CHIPCallbackTypes.zapt b/src/controller/java/templates/CHIPCallbackTypes.zapt
@@ -14,12 +14,12 @@ typedef void (*CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase nam
 
 {{! TODO: global response types?}}
 
-{{#chip_server_cluster_attributes}}
+{{#zcl_attributes_server}}
 {{#if isArray}}
 typedef void (*CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallbackType)(void *, const chip::app::Clusters::{{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo::DecodableType &);
 {{else}}
 typedef void (*CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallbackType)(void *, chip::app::Clusters::{{asUpperCamelCase parent.name}}::Attributes::{{asUpperCamelCase name}}::TypeInfo::DecodableArgType);
 {{/if}}
-{{/chip_server_cluster_attributes}}
+{{/zcl_attributes_server}}
 {{/chip_client_clusters}}
 {{/if}}
diff --git a/src/controller/java/templates/CHIPClustersWrite-JNI.zapt b/src/controller/java/templates/CHIPClustersWrite-JNI.zapt
@@ -30,8 +30,9 @@ using namespace chip;
 using namespace chip::Controller;
 
 {{#chip_client_clusters}}
-{{#chip_server_cluster_attributes}}
-{{#unless (isStrEqual chipCallback.name "Unsupported")}}
+{{#zcl_attributes_server removeKeys='isOptional'}}
+{{#if_unsupported_attribute_callback type isArray ../id}}
+{{else}}
 {{#if isWritableAttribute}}
 
 JNI_METHOD(void, {{asUpperCamelCase ../name}}Cluster, write{{asUpperCamelCase name}}Attribute)(JNIEnv * env, jobject self, jlong clusterPtr, jobject callback, {{asJniBasicType type true}} value, jobject timedWriteTimeoutMs)
@@ -74,8 +75,8 @@ JNI_METHOD(void, {{asUpperCamelCase ../name}}Cluster, write{{asUpperCamelCase na
     onFailure.release();
 }
 {{/if}}
-{{/unless}}
-{{/chip_server_cluster_attributes}}
+{{/if_unsupported_attribute_callback}}
+{{/zcl_attributes_server}}
 {{/chip_client_clusters}}
 {{/if}}
 

diff --git a/src/controller/java/templates/CHIPReadCallbacks-src.zapt b/src/controller/java/templates/CHIPReadCallbacks-src.zapt
@@ -86,11 +86,12 @@ void CHIP{{chipCallback.name}}AttributeCallback::CallbackFn(void * context, {{ch
 {{/chip_server_global_responses}}
 
 {{#chip_client_clusters}}
-{{#chip_server_cluster_attributes}}
+{{#zcl_attributes_server removeKeys='isOptional'}}
 {{! TODO: Add support for struct-typed attributes }}
-{{#unless (isStrEqual chipCallback.name "Unsupported")}}
+{{#if_unsupported_attribute_callback type isArray ../id}}
+{{else}}
 
-{{#if_basic_global_response}}
+{{#if_basic_attribute type ../id}}
 {{else}}
 CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback::CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback(jobject javaCallback, bool keepAlive) :
     chip::Callback::Callback<CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallbackType>(CallbackFn, this), keepAlive(keepAlive)
@@ -116,7 +117,7 @@ CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback::
     }
     env->DeleteGlobalRef(javaCallbackRef);
 }
-{{/if_basic_global_response}}
+{{/if_basic_attribute}}
 
 {{#if isArray}}
 void CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback::CallbackFn(void * context, {{zapTypeToDecodableClusterObjectType type ns=parent.name isArgument=true}} list)
@@ -144,7 +145,7 @@ void CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallb
     env->CallVoidMethod(javaCallbackRef, javaMethod, arrayListObj);
 }
 {{else}}
-  {{#if_basic_global_response}}
+  {{#if_basic_attribute type ../id}}
   {{else}}
     void CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback::CallbackFn(void * context, {{zapTypeToDecodableClusterObjectType type ns=parent.name isArgument=true}} value)
     {
@@ -168,10 +169,10 @@ void CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallb
 
         env->CallVoidMethod(javaCallbackRef, javaMethod, javaValue);
     }
-  {{/if_basic_global_response}}
+  {{/if_basic_attribute}}
 {{/if}}
-{{/unless}}
-{{/chip_server_cluster_attributes}}
+{{/if_unsupported_attribute_callback}}
+{{/zcl_attributes_server}}
 {{/chip_client_clusters}}
 
 {{/if}}
diff --git a/src/controller/java/templates/CHIPReadCallbacks.zapt b/src/controller/java/templates/CHIPReadCallbacks.zapt
@@ -37,9 +37,10 @@ private:
 {{/chip_server_global_responses}}
 
 {{#chip_client_clusters}}
-{{#chip_server_cluster_attributes}}
-{{#unless (isStrEqual chipCallback.name "Unsupported")}}
-{{#if_basic_global_response}}
+{{#zcl_attributes_server removeKeys='isOptional'}}
+{{#if_unsupported_attribute_callback type isArray ../id}}
+{{else}}
+{{#if_basic_attribute type ../id}}
 {{else}}
 class CHIP{{asUpperCamelCase parent.name}}{{asUpperCamelCase name}}AttributeCallback : public chip::Callback::Callback<CHIP{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallbackType>
 {
@@ -65,10 +66,10 @@ private:
     jobject javaCallbackRef;
     bool keepAlive;
 };
-{{/if_basic_global_response}}
+{{/if_basic_attribute}}
 
-{{/unless}}
-{{/chip_server_cluster_attributes}}
+{{/if_unsupported_attribute_callback}}
+{{/zcl_attributes_server}}
 {{/chip_client_clusters}}
 
 {{/if}}
diff --git a/src/controller/java/templates/ChipClusters-java.zapt b/src/controller/java/templates/ChipClusters-java.zapt
@@ -141,9 +141,10 @@ public class ChipClusters {
 
   {{/chip_cluster_responses}}
 
-  {{#chip_server_cluster_attributes}}
-  {{#unless (isStrEqual chipCallback.name "Unsupported")}}
-  {{#if_basic_global_response}}
+  {{#zcl_attributes_server removeKeys='isOptional'}}
+  {{#if_unsupported_attribute_callback type isArray ../id}}
+  {{else}}
+  {{#if_basic_attribute type ../id}}
   {{else}}
     {{! NOTE: asJavaType ends up sniffing for isArray on the context. Since we want the type of our _entry_, force isArray to
           false. }}
@@ -161,19 +162,20 @@ public class ChipClusters {
         default void onSubscriptionEstablished(long subscriptionId) {}
       }
     {{/if}}
-  {{/if_basic_global_response}}
-  {{/unless}}
-  {{/chip_server_cluster_attributes}}
-  {{#chip_server_cluster_attributes}}
+  {{/if_basic_attribute}}
+  {{/if_unsupported_attribute_callback}}
+  {{/zcl_attributes_server}}
+  {{#zcl_attributes_server removeKeys='isOptional'}}
   {{! TODO: Add support for struct-typed attributes }}
-  {{#unless (isStrEqual chipCallback.name "Unsupported")}}
+  {{#if_unsupported_attribute_callback type isArray ../id}}
+  {{else}}
 
     public void read{{asUpperCamelCase name}}Attribute(
-    {{#if_basic_global_response}}
-      {{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback callback
+    {{#if_basic_attribute type ../id}}
+      {{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback callback
     {{else}}
       {{asUpperCamelCase name}}AttributeCallback callback
-    {{/if_basic_global_response}}
+    {{/if_basic_attribute}}
     ) {
       read{{asUpperCamelCase name}}Attribute(chipClusterPtr, callback);
     }
@@ -190,42 +192,43 @@ public class ChipClusters {
   {{/if}}
   {{#if isReportableAttribute}}
     public void subscribe{{asCamelCased name false}}Attribute(
-      {{#if_basic_global_response}}
-        {{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback callback
+      {{#if_basic_attribute type ../id}}
+        {{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback callback
       {{else}}
         {{asUpperCamelCase name}}AttributeCallback callback
-      {{/if_basic_global_response}},
+      {{/if_basic_attribute}},
       int minInterval, int maxInterval) {
       subscribe{{asCamelCased name false}}Attribute(chipClusterPtr, callback, minInterval, maxInterval);
     }
   {{/if}}
-  {{/unless}}
-  {{/chip_server_cluster_attributes}}
-  {{#chip_server_cluster_attributes}}
+  {{/if_unsupported_attribute_callback}}
+  {{/zcl_attributes_server}}
+  {{#zcl_attributes_server removeKeys='isOptional'}}
   {{! TODO: Add support for struct-typed attributes }}
-  {{#unless (isStrEqual chipCallback.name "Unsupported")}}
+  {{#if_unsupported_attribute_callback type isArray ../id }}
+  {{else}}
 
     private native void read{{asUpperCamelCase name}}Attribute(long chipClusterPtr,
-      {{#if_basic_global_response}}
-        {{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback callback
+      {{#if_basic_attribute type ../id}}
+        {{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback callback
       {{else}}
         {{asUpperCamelCase name}}AttributeCallback callback
-      {{/if_basic_global_response}}
+      {{/if_basic_attribute}}
     );
   {{#if isWritableAttribute}}
 
     private native void write{{asUpperCamelCase name}}Attribute(long chipClusterPtr, DefaultClusterCallback callback, {{asJavaType type chipType parent.name}} value, @Nullable Integer timedWriteTimeoutMs);
   {{/if}}
   {{#if isReportableAttribute}}
     private native void subscribe{{asCamelCased name false}}Attribute(long chipClusterPtr,
-      {{#if_basic_global_response}}
-        {{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback callback
+      {{#if_basic_attribute type ../id}}
+        {{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback callback
       {{else}}
         {{asUpperCamelCase name}}AttributeCallback callback
-      {{/if_basic_global_response}}, int minInterval, int maxInterval);
+      {{/if_basic_attribute}}, int minInterval, int maxInterval);
   {{/if}}
-  {{/unless}}
-  {{/chip_server_cluster_attributes}}
+  {{/if_unsupported_attribute_callback}}
+  {{/zcl_attributes_server}}
   }
   {{#not_last}}
 

diff --git a/src/controller/java/templates/ChipIdLookup-java.zapt b/src/controller/java/templates/ChipIdLookup-java.zapt
@@ -24,11 +24,11 @@ public final class ChipIdLookup {
   public static String attributeIdToName(long clusterId, long attributeId) {
     {{#chip_client_clusters}}
     if (clusterId == {{code}}L) {
-      {{#chip_server_cluster_attributes}}
+      {{#zcl_attributes_server}}
       if (attributeId == {{code}}L) {
         return "{{asUpperCamelCase name}}";
       }
-      {{/chip_server_cluster_attributes}}
+      {{/zcl_attributes_server}}
       return "";
     }
     {{/chip_client_clusters}}

diff --git a/src/controller/java/templates/ClusterInfo-java.zapt b/src/controller/java/templates/ClusterInfo-java.zapt
@@ -235,9 +235,10 @@ public class ClusterInfoMapping {
       }
 
   {{/chip_cluster_responses}}
-      {{#chip_server_cluster_attributes}}
-      {{#unless (isStrEqual chipCallback.name "Unsupported")}}
-      {{#if_basic_global_response}}
+      {{#zcl_attributes_server removeKeys='isOptional'}}
+      {{#if_unsupported_attribute_callback type isArray ../id}}
+      {{else}}
+      {{#if_basic_attribute type ../id}}
       {{else}}
       public static class Delegated{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallback implements ChipClusters.{{asUpperCamelCase ../name}}Cluster.{{asUpperCamelCase name}}AttributeCallback, DelegatedClusterCallback {
         private ClusterCommandCallback callback;
@@ -270,9 +271,9 @@ public class ClusterInfoMapping {
           callback.onFailure(ex);
         }
       }
-      {{/if_basic_global_response}}
-      {{/unless}}
-      {{/chip_server_cluster_attributes}}
+      {{/if_basic_attribute}}
+      {{/if_unsupported_attribute_callback}}
+      {{/zcl_attributes_server}}
 
   {{/chip_client_clusters}}
 

diff --git a/src/controller/java/templates/ClusterInfo-read-interaction.zapt b/src/controller/java/templates/ClusterInfo-read-interaction.zapt
@@ -15,30 +15,31 @@ public class ClusterReadMapping {
     Map<String, Map<String, InteractionInfo>> readAttributeMap = new HashMap<>();
     {{#chip_client_clusters}}
        Map<String, InteractionInfo> read{{asUpperCamelCase name}}InteractionInfo = new LinkedHashMap<>();
-        {{#chip_server_cluster_attributes}}
+        {{#zcl_attributes_server removeKeys='isOptional'}}
         {{! TODO: Add support for struct-typed attributes }}
-        {{#unless (isStrEqual chipCallback.name "Unsupported")}}
+        {{#if_unsupported_attribute_callback type isArray ../id}}
+        {{else}}
         Map<String, CommandParameterInfo> read{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams = new LinkedHashMap<String, CommandParameterInfo>();
         InteractionInfo read{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}AttributeInteractionInfo = new InteractionInfo(
           (cluster, callback, commandArguments) -> {
             ((ChipClusters.{{asUpperCamelCase ../name}}Cluster) cluster).read{{asUpperCamelCase name}}Attribute(
-              ({{#if_basic_global_response}}
-                ChipClusters.{{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback
+              ({{#if_basic_attribute type ../id}}
+                ChipClusters.{{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback
               {{else}}
                 ChipClusters.{{asUpperCamelCase ../name}}Cluster.{{asUpperCamelCase name}}AttributeCallback
-              {{/if_basic_global_response}}) callback
+              {{/if_basic_attribute}}) callback
             );
           },
-          {{#if_basic_global_response}}
-            () -> new ClusterInfoMapping.Delegated{{convertAttributeCallbackTypeToJavaName chipCallback.type}}AttributeCallback(),
+          {{#if_basic_attribute type ../id}}
+            () -> new ClusterInfoMapping.Delegated{{as_underlying_java_zcl_type type ../id boolean="Boolean"}}AttributeCallback(),
           {{else}}
             () -> new ClusterInfoMapping.Delegated{{asUpperCamelCase parent.name}}Cluster{{asUpperCamelCase name}}AttributeCallback(),
-          {{/if_basic_global_response}}
+          {{/if_basic_attribute}}
           read{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams
         );
         read{{asUpperCamelCase ../name}}InteractionInfo.put("read{{asUpperCamelCase name}}Attribute", read{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}AttributeInteractionInfo);
-        {{/unless}}
-        {{/chip_server_cluster_attributes}}
+        {{/if_unsupported_attribute_callback}}
+        {{/zcl_attributes_server}}
         readAttributeMap.put("{{asLowerCamelCase name}}", read{{asUpperCamelCase name}}InteractionInfo);
         {{/chip_client_clusters}}
         return readAttributeMap;

diff --git a/src/controller/java/templates/ClusterInfo-write-interaction.zapt b/src/controller/java/templates/ClusterInfo-write-interaction.zapt
@@ -0,0 +1,50 @@
+{{> header}}
+{{#if (chip_has_client_clusters)}}
+
+package chip.devicecontroller;
+
+import chip.clusterinfo.CommandParameterInfo;
+import chip.clusterinfo.InteractionInfo;
+import chip.devicecontroller.ChipClusters.DefaultClusterCallback;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+public class ClusterWriteMapping {
+  public Map<String, Map<String, InteractionInfo>> getWriteAttributeMap() {
+    Map<String, Map<String, InteractionInfo>> writeAttributeMap = new HashMap<>();
+    {{#chip_client_clusters}}
+      Map<String, InteractionInfo> write{{asUpperCamelCase name}}InteractionInfo = new LinkedHashMap<>();
+        {{#zcl_attributes_server removeKeys='isOptional'}}
+        {{! TODO: Add support for struct-typed attributes }}
+        {{#if_unsupported_attribute_callback type isArray ../id}}
+        {{else}}
+        {{#if isWritableAttribute}}
+        {{#unless isArray}}
+        Map<String, CommandParameterInfo> write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams = new LinkedHashMap<String, CommandParameterInfo>();
+        CommandParameterInfo {{asLowerCamelCase ../name}}{{asLowerCamelCase name}}CommandParameterInfo = new CommandParameterInfo("value", {{asJavaType type null parent.parent.name removeGenericType=true}}.class, {{asJavaType type null parent.parent.name underlyingType=true}}.class);
+        write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams.put("value",{{asLowerCamelCase ../name}}{{asLowerCamelCase name}}CommandParameterInfo);
+        InteractionInfo write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}AttributeInteractionInfo = new InteractionInfo(
+          (cluster, callback, commandArguments) -> {
+            ((ChipClusters.{{asUpperCamelCase ../name}}Cluster) cluster).write{{asUpperCamelCase name}}Attribute(
+              (DefaultClusterCallback) callback,
+              ({{as_underlying_java_zcl_type type ../id boolean="Boolean" isBoxedJavaType=true}})
+              commandArguments.get("value")
+              {{#if mustUseTimedWrite}}, 10000{{/if}}
+            );
+          },
+          () -> new ClusterInfoMapping.DelegatedDefaultClusterCallback(),
+          write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}CommandParams
+        );
+        write{{asUpperCamelCase ../name}}InteractionInfo.put("write{{asUpperCamelCase name}}Attribute", write{{asUpperCamelCase ../name}}{{asUpperCamelCase name}}AttributeInteractionInfo);
+        {{/unless}}
+        {{/if}}
+        {{/if_unsupported_attribute_callback}}
+        {{/zcl_attributes_server}}
+        writeAttributeMap.put("{{asLowerCamelCase name}}", write{{asUpperCamelCase name}}InteractionInfo);
+    {{/chip_client_clusters}}
+    return writeAttributeMap;
+  }
+}
+
+{{/if}}