Create a codegen that converts idl back into .matter formats

scripts/build/test.py

@@ -48,6 +48,7 @@ def build_actual_output(root: str, out: str, args: List[str]) -> List[str]:
         'IMX_SDK_ROOT': 'IMX_SDK_ROOT',
         'TI_SYSCONFIG_ROOT': 'TEST_TI_SYSCONFIG_ROOT',
         'JAVA_PATH': 'TEST_JAVA_PATH',
+        'GSDK_ROOT': 'TEST_GSDK_ROOT',
     })
 
     retval = subprocess.run([

scripts/build/testdata/dry_run_efr32-brd4161a-light-rpc-no-version.txt

@@ -2,7 +2,7 @@
 cd "{root}"
 
 # Generating efr32-brd4161a-light-rpc-no-version
-gn gen --check --fail-on-unused-args --export-compile-commands --root={root}/examples/lighting-app/silabs '--args=silabs_board="BRD4161A" is_debug=false import("//with_pw_rpc.gni")' {out}/efr32-brd4161a-light-rpc-no-version
+gn gen --check --fail-on-unused-args --export-compile-commands --root={root}/examples/lighting-app/silabs '--args=silabs_board="BRD4161A" is_debug=false import("//with_pw_rpc.gni") efr32_sdk_root="TEST_GSDK_ROOT" openthread_root="TEST_GSDK_ROOT/util/third_party/openthread"' {out}/efr32-brd4161a-light-rpc-no-version
 
 # Building efr32-brd4161a-light-rpc-no-version
 ninja -C {out}/efr32-brd4161a-light-rpc-no-version

scripts/py_matter_idl/BUILD.gn

@@ -62,6 +62,7 @@ pw_python_package("matter_idl") {
     "matter_idl/test_backwards_compatibility.py",
     "matter_idl/test_matter_idl_parser.py",
     "matter_idl/test_generators.py",
+    "matter_idl/test_idl_generator.py",
     "matter_idl/test_xml_parser.py",
   ]
 

scripts/py_matter_idl/files.gni

@@ -7,6 +7,7 @@ matter_idl_generator_templates = [
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/cpp/application/PluginApplicationCallbacksHeader.jinja",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/cpp/tlvmeta/TLVMetaData_cpp.jinja",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/cpp/tlvmeta/TLVMetaData_h.jinja",
+  "${chip_root}/scripts/py_matter_idl/matter_idl/generators/idl/MatterIdl.jinja",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/java/CHIPCallbackTypes.jinja",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/java/ChipClustersCpp.jinja",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/java/ChipClustersRead.jinja",
@@ -27,6 +28,7 @@ matter_idl_generator_sources = [
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/cpp/application/__init__.py",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/cpp/tlvmeta/__init__.py",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/filters.py",
+  "${chip_root}/scripts/py_matter_idl/matter_idl/generators/idl/__init__.py",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/java/__init__.py",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/registry.py",
   "${chip_root}/scripts/py_matter_idl/matter_idl/generators/types.py",

scripts/py_matter_idl/matter_idl/generators/idl/MatterIdl.jinja

@@ -0,0 +1,150 @@
+{% macro render_field(field) -%}{#
+ Macro for the output of a single field entry such as:
+
+ int16u identifyTime = 0;
+ optional int16u transitionTime = 3;
+ optional nullable int16u transitionTime = 2;
+ optional ExtensionFieldSet extensionFieldSets[] = 5;
+#}
+
+{%- if field.qualities %}{{field.qualities | idltxt}} {% endif -%}
+{{field.data_type.name}}
+{%- if field.data_type.max_length -%} <{{field.data_type.max_length}}> {%- endif -%}
+{##} {{field.name}}
+{%- if field.is_list %}[]{% endif -%}
+{##} = {{field.code}};
+{%- endmacro -%}
+
+{% macro render_struct(s) -%}{#
+ Macro for the output of a complete struct
+#}
+  {%- if s.tag %}{{s.tag | idltxt}} {% endif -%}
+  {% if s.qualities %}{{s.qualities | idltxt}} {% endif -%}
+  struct {{s.name}} {##}
+  {%- if s.code is not none %}= {{s.code}} {% endif -%}
+  {
+    {% for field in s.fields %}
+    {{render_field(field)}}
+    {% endfor %}
+  }
+{%- endmacro -%}
+
+
+// This IDL was auto-generated from a parsed data structure
+
+{%  for cluster in idl.clusters %}
+{% if cluster.description %}/** {{cluster.description}} */
+{% endif %}
+{{cluster.api_maturity | idltxt}}{{cluster.side | idltxt}} cluster {{cluster.name}} = {{cluster.code}} {
+  {%- for enum in cluster.enums %}
+
+  enum {{enum.name}} : {{ enum.base_type}} {
+    {% for entry in enum.entries %}
+    {{entry.name}} = {{entry.code}};
+    {% endfor %}
+  }
+  {% endfor %}
+
+  {%- for bitmap in cluster.bitmaps %}
+
+  bitmap {{bitmap.name}} : {{ bitmap.base_type}} {
+    {% for entry in bitmap.entries %}
+    {{entry.name}} = 0x{{"%X" | format(entry.code)}};
+    {% endfor %}
+  }
+  {% endfor %}
+
+  {%- for s in cluster.structs | rejectattr("tag") %}
+  {% if loop.first %}
+
+  {% endif %}
+  {{render_struct(s)}}
+  {% if not loop.last %}
+
+  {% endif %}
+  {% endfor %}
+
+  {%- for e in cluster.events %}
+  {% if loop.first %}
+
+  {% endif %}
+  {##}  {##}{% if e.qualities %}{{e.qualities | idltxt}} {% endif -%}
+  {{e.priority | idltxt}} event {{e | event_access}}{{e.name}} = {{e.code}} {
+    {% for field in e.fields %}
+    {{render_field(field)}}
+    {% endfor %}
+  }
+  {% if not loop.last %}
+
+  {% endif %}
+  {% endfor %}
+
+  {%- for a in cluster.attributes %}
+  {% if loop.first %}
+
+  {% endif %}
+  {{a.qualities | idltxt}}attribute {{a | attribute_access}}{{render_field(a.definition)}}
+  {% endfor %}
+
+  {%- for s in cluster.structs | selectattr("tag") %}
+
+  {{render_struct(s)}}
+  {% endfor %}
+
+  {%- for c in cluster.commands %}
+  {% if loop.first %}
+
+  {% endif %}
+  {% if c.description %}
+  /** {{c.description}} */
+  {% endif %}
+  {{c.qualities | idltxt}}command {{c | command_access}}{{c.name}}(
+     {%- if c.input_param %}{{c.input_param}}{% endif -%}
+  ): {{c.output_param}} = {{c.code}};
+  {% endfor %}
+}
+
+{% endfor %}
+
+{%- if idl.endpoints %}
+{%- for endpoint in idl.endpoints %}
+endpoint {{endpoint.number}} {
+  {% for t in endpoint.device_types %}
+  device type {{t.name}} = {{t.code}}, version {{t.version}};
+  {% endfor%}
+
+  {%-for b in endpoint.client_bindings %}
+  {% if loop.first %}
+
+  {% endif %}
+  binding cluster {{b}};
+  {% endfor %}
+
+  {%-for c in endpoint.server_clusters %}
+
+  server cluster {{c.name}} {
+    {% for e in c.events_emitted %}
+    emits event {{e}};
+    {% if loop.last %}
+
+    {% endif %}
+    {% endfor %}
+    {% for a in c.attributes %}
+    {{"%-8s" | format(a.storage|idltxt) }} attribute {{a.name}}
+    {%- if a.default is not none %} default = {{a.default|render_default}} {%- endif %};
+    {% endfor %}
+    {% for cmd in c.commands %}
+    {% if loop.first %}
+
+    {% endif %}
+    handle command {{cmd.name}};
+    {% endfor %}
+  }
+  {% endfor %}
+
+}
+{% if not loop.last %}
+
+{% endif %}
+{%  endfor %}
+{%  endif %}

scripts/py_matter_idl/matter_idl/generators/idl/README.md

@@ -0,0 +1,32 @@
+## Generator description
+
+Generates a structured `Idl` data type into a human-readable text format
+(`.matter` file).
+
+It is useful for tools that ingest non-idl data but convert into idl data (e.g.
+`zapxml` or CSA data model XML data.)
+
+### Usage
+
+A no-op usage can be:
+
+```
+./scripts/codegen.py -g idl --output-dir out/idlgen examples/all-clusters-app/all-clusters-common/all-clusters-app.matter
+```
+
+which would re-generate the entire `all-clusters-app.matter` into
+`out/idlgen/idl.matter`
+
+This generation is useful for testing/validating that both parsing and
+generation works. Actual usage of this generator would be inside XML tools.
+
+### Within XML parsing
+
+A XML parser will use this code generator to output a human readable view of the
+parsed data:
+
+```
+./scripts/py_matter_idl/matter_idl/xml_parser.py \
+    ./src/app/zap-templates/zcl/data-model/chip/onoff-cluster.xml \
+    ./src/app/zap-templates/zcl/data-model/chip/global-attributes.xm
+```