Remove CHIPClusters.h and corresponding .zapt file from the build (…

…project-chip#32004) * Completely remove all references to CHIPClusters.h * Restyle * Remove references to CHIPClusters.zapt as well * Use BaseCluster instead of specific clusters * Fix names and includes
erwinpan1 · Feb 13, 2024 · 52d33da · 52d33da
1 parent 8e9cdd9
commit 52d33da
Show file tree

Hide file tree

Showing 15 changed files with 13 additions and 223 deletions.
diff --git a/build/chip/chip_codegen.cmake b/build/chip/chip_codegen.cmake
@@ -108,7 +108,6 @@ endfunction()
 #      GENERATOR "app-templates"
 #      OUTPUTS
 #            "zap-generated/access.h",
-#            "zap-generated/CHIPClusters.h"
 #            "zap-generated/endpoint_config.h",
 #            "zap-generated/gen_config.h",
 #            "zap-generated/IMClusterCommandHandler.cpp"
@@ -162,7 +161,6 @@ function(chip_zapgen TARGET_NAME)
             SET(EXTRA_DEPENDENCIES
                 "${CHIP_ROOT}/src/app/zap-templates/partials/header.zapt"
                 "${CHIP_ROOT}/src/app/zap-templates/templates/app/access.zapt"
-                "${CHIP_ROOT}/src/app/zap-templates/templates/app/CHIPClusters.zapt"
                 "${CHIP_ROOT}/src/app/zap-templates/templates/app/endpoint_config.zapt"
                 "${CHIP_ROOT}/src/app/zap-templates/templates/app/gen_config.zapt"
                 "${CHIP_ROOT}/src/app/zap-templates/templates/app/im-cluster-command-handler.zapt"

diff --git a/build/chip/chip_codegen.gni b/build/chip/chip_codegen.gni
@@ -144,7 +144,6 @@ template("_chip_build_time_zapgen") {
 
       # Application templates, actually generating files
       "${_template_dir}/access.zapt",
-      "${_template_dir}/CHIPClusters.zapt",
       "${_template_dir}/endpoint_config.zapt",
       "${_template_dir}/gen_config.zapt",
       "${_template_dir}/im-cluster-command-handler.zapt",

diff --git a/build/chip/esp32/esp32_codegen.cmake b/build/chip/esp32/esp32_codegen.cmake
@@ -61,7 +61,6 @@ macro(chip_app_component_zapgen ZAP_NAME)
       GENERATOR "app-templates"
       OUTPUTS
             "zap-generated/access.h"
-            "zap-generated/CHIPClusters.h"
             "zap-generated/endpoint_config.h"
             "zap-generated/gen_config.h"
             "zap-generated/IMClusterCommandHandler.cpp"

diff --git a/examples/thermostat/asr/include/CHIPClusters.h b/examples/thermostat/asr/include/CHIPClusters.h
diff --git a/examples/tv-app/android/java/TVApp-JNI.cpp b/examples/tv-app/android/java/TVApp-JNI.cpp
@@ -34,14 +34,14 @@
 #include <app/app-platform/ContentAppPlatform.h>
 #include <app/server/Dnssd.h>
 #include <app/server/java/AndroidAppServerWrapper.h>
+#include <controller/CHIPCluster.h>
 #include <credentials/DeviceAttestationCredsProvider.h>
 #include <credentials/examples/DeviceAttestationCredsExample.h>
 #include <jni.h>
 #include <lib/core/CHIPError.h>
 #include <lib/support/CHIPJNIError.h>
 #include <lib/support/JniReferences.h>
 #include <lib/support/JniTypeWrappers.h>
-#include <zap-generated/CHIPClusters.h>
 
 using namespace chip;
 using namespace chip::app;
@@ -216,7 +216,7 @@ class MyPostCommissioningListener : public PostCommissioningListener
                                 const SessionHandle & sessionHandle) override
     {
         // read current binding list
-        chip::Controller::BindingCluster cluster(exchangeMgr, sessionHandle, kTargetBindingClusterEndpointId);
+        chip::Controller::ClusterBase cluster(exchangeMgr, sessionHandle, kTargetBindingClusterEndpointId);
 
         cacheContext(vendorId, productId, nodeId, exchangeMgr, sessionHandle);
 

diff --git a/examples/tv-app/tv-common/src/AppTv.cpp b/examples/tv-app/tv-common/src/AppTv.cpp
@@ -21,15 +21,17 @@
 
 #include "AppTv.h"
 
+#include <cstdio>
+#include <inttypes.h>
+
 #include <app-common/zap-generated/attributes/Accessors.h>
 #include <app-common/zap-generated/ids/Attributes.h>
 #include <app-common/zap-generated/ids/Clusters.h>
 #include <app/CommandHandler.h>
 #include <app/server/Dnssd.h>
 #include <app/server/Server.h>
 #include <app/util/af.h>
-#include <cstdio>
-#include <inttypes.h>
+#include <controller/CHIPCluster.h>
 #include <lib/core/CHIPCore.h>
 #include <lib/core/DataModelTypes.h>
 #include <lib/support/CHIPArgParser.hpp>
@@ -38,7 +40,6 @@
 #include <lib/support/ZclString.h>
 #include <platform/CHIPDeviceLayer.h>
 #include <platform/DeviceInstanceInfoProvider.h>
-#include <zap-generated/CHIPClusters.h>
 
 #if CHIP_DEVICE_CONFIG_ENABLE_BOTH_COMMISSIONER_AND_COMMISSIONEE
 #include <controller/CHIPDeviceController.h>
@@ -126,7 +127,7 @@ class MyPostCommissioningListener : public PostCommissioningListener
                                 const SessionHandle & sessionHandle) override
     {
         // read current binding list
-        chip::Controller::BindingCluster cluster(exchangeMgr, sessionHandle, kTargetBindingClusterEndpointId);
+        chip::Controller::ClusterBase cluster(exchangeMgr, sessionHandle, kTargetBindingClusterEndpointId);
 
         cacheContext(vendorId, productId, nodeId, exchangeMgr, sessionHandle);
 

diff --git a/examples/virtual-device-app/android/java/DeviceApp-JNI.cpp b/examples/virtual-device-app/android/java/DeviceApp-JNI.cpp
@@ -34,7 +34,6 @@
 #include <lib/support/CHIPJNIError.h>
 #include <lib/support/JniReferences.h>
 #include <lib/support/JniTypeWrappers.h>
-#include <zap-generated/CHIPClusters.h>
 
 using namespace chip;
 using namespace chip::app;

diff --git a/scripts/tools/zap/tests/available_tests.yaml b/scripts/tools/zap/tests/available_tests.yaml
@@ -12,15 +12,13 @@
 #     and the expected content for those output files.
 inputs/all-clusters-app.zap:
     ../../../../src/app/zap-templates/app-templates.json:
-        CHIPClusters.h: outputs/all-clusters-app/app-templates/CHIPClusters.h
         endpoint_config.h: outputs/all-clusters-app/app-templates/endpoint_config.h
         gen_config.h: outputs/all-clusters-app/app-templates/gen_config.h
         access.h: outputs/all-clusters-app/app-templates/access.h
         IMClusterCommandHandler.cpp: outputs/all-clusters-app/app-templates/IMClusterCommandHandler.cpp
 
 inputs/lighting-app.zap:
     ../../../../src/app/zap-templates/app-templates.json:
-        CHIPClusters.h: outputs/lighting-app/app-templates/CHIPClusters.h
         endpoint_config.h: outputs/lighting-app/app-templates/endpoint_config.h
         gen_config.h: outputs/lighting-app/app-templates/gen_config.h
         access.h: outputs/lighting-app/app-templates/access.h

diff --git a/scripts/tools/zap/tests/outputs/all-clusters-app/app-templates/CHIPClusters.h b/scripts/tools/zap/tests/outputs/all-clusters-app/app-templates/CHIPClusters.h
diff --git a/scripts/tools/zap/tests/outputs/lighting-app/app-templates/CHIPClusters.h b/scripts/tools/zap/tests/outputs/lighting-app/app-templates/CHIPClusters.h
diff --git a/src/app/chip_data_model.cmake b/src/app/chip_data_model.cmake
@@ -123,7 +123,6 @@ function(chip_configure_data_model APP_TARGET)
         GENERATOR "app-templates"
         OUTPUTS
         "zap-generated/access.h"
-        "zap-generated/CHIPClusters.h"
         "zap-generated/endpoint_config.h"
         "zap-generated/gen_config.h"
         "zap-generated/IMClusterCommandHandler.cpp"

diff --git a/src/app/chip_data_model.gni b/src/app/chip_data_model.gni
@@ -66,24 +66,22 @@ template("chip_data_model") {
     input = rebase_path(invoker.zap_file)
     generator = "app-templates"
 
+    # NOTE: these files MUST be in sync with outputs in
+    #       src/app/zap-templates/app-templates.json
     outputs = [
       "zap-generated/access.h",
       "zap-generated/gen_config.h",
       "zap-generated/endpoint_config.h",
     ]
 
+    # NOTE: these are ALSO auto-generated but handled below:
+    #       "zap-generated/IMClusterCommandHandler.cpp"
+    #         -> contains one large DispatchSingleClusterCommand and DispatchServerCommand
+
     if (chip_code_pre_generated_directory == "") {
       prune_outputs = []
     }
 
-    if (chip_controller) {
-      outputs += [ "zap-generated/CHIPClusters.h" ]
-    } else {
-      if (defined(prune_outputs)) {
-        prune_outputs += [ "zap-generated/CHIPClusters.h" ]
-      }
-    }
-
     # TODO: It is unclear here why `zap_pregenerated_dir` has any relevance
     #       in including IMClusterCommandHandler or not.
     #

diff --git a/src/app/zap-templates/app-templates.json b/src/app/zap-templates/app-templates.json
@@ -35,11 +35,6 @@
             "name": "CHIP Client Callbacks for Interaction Model",
             "output": "IMClusterCommandHandler.cpp"
         },
-        {
-            "path": "templates/app/CHIPClusters.zapt",
-            "name": "C++ ZCL API Header",
-            "output": "CHIPClusters.h"
-        },
         {
             "path": "templates/app/access.zapt",
             "name": "Matter access definitions",

diff --git a/src/app/zap-templates/templates/app/CHIPClusters.zapt b/src/app/zap-templates/templates/app/CHIPClusters.zapt
diff --git a/src/lib/shell/commands/BUILD.gn b/src/lib/shell/commands/BUILD.gn
@@ -56,16 +56,6 @@ source_set("commands") {
   if (chip_enable_ota_requestor && chip_device_platform != "none" &&
       chip_device_platform != "linux" && chip_device_platform != "darwin") {
     sources += [ "Ota.cpp" ]
-
-    # TODO: the ota commands in shell should use the interfaces in /src/app/clusters/ota-requestor
-    #
-    # Awkward dependencies below say:
-    #   - codegen via zap the CHIPClusters.h (which is the CLIENT SIDE)
-    #   - ensure include path can see zap-generated/CHIPClusters.h
-    deps = [ "${chip_root}/src/controller/data_model:data_model_zapgen_files" ]
-
-    configs +=
-        [ "${chip_root}/src/controller/data_model:data_model_zapgen_config" ]
   }
 
   if (chip_system_config_provide_statistics) {