From c901203cd1ef27050e87937bef9d8e7c862fc9f5 Mon Sep 17 00:00:00 2001
From: Gunnar Andersson <gunnar.andersson@mercedes-benz.com>
Date: Tue, 7 Jan 2025 16:48:20 +0100
Subject: [PATCH] Move templates to (temporary) new structure

Ideally each template should be under each technology dir but
the way the generic generator is written now, it assumes everything
under one directory.  For now, it can stay like this (but under
the output_filters directory).

Signed-off-by: Gunnar Andersson <gunnar.andersson@mercedes-benz.com>
---
 docs/static-developer-generators.md                         | 6 +++---
 models/ifex/ifex_generator.py                               | 2 +-
 {ifex => output_filters}/templates/D-Bus/AST.tpl            | 0
 {ifex => output_filters}/templates/D-Bus/Argument.tpl       | 0
 {ifex => output_filters}/templates/D-Bus/Enumeration.tpl    | 0
 {ifex => output_filters}/templates/D-Bus/Error.tpl          | 0
 {ifex => output_filters}/templates/D-Bus/Event.tpl          | 0
 {ifex => output_filters}/templates/D-Bus/Include.tpl        | 0
 {ifex => output_filters}/templates/D-Bus/Interface.tpl      | 0
 {ifex => output_filters}/templates/D-Bus/Member.tpl         | 0
 {ifex => output_filters}/templates/D-Bus/Method.tpl         | 0
 {ifex => output_filters}/templates/D-Bus/Namespace.tpl      | 0
 {ifex => output_filters}/templates/D-Bus/Option.tpl         | 0
 {ifex => output_filters}/templates/D-Bus/Property.tpl       | 0
 {ifex => output_filters}/templates/D-Bus/Struct.tpl         | 0
 {ifex => output_filters}/templates/D-Bus/Typedef.tpl        | 0
 {ifex => output_filters}/templates/JinjaTemplateEnv.py      | 2 +-
 {ifex => output_filters}/templates/TemplateDir.py           | 0
 {ifex => output_filters}/templates/__init__.py              | 0
 {ifex => output_filters}/templates/dtdl/AST_dtdl.tpl        | 0
 {ifex => output_filters}/templates/dtdl/dtdl.md             | 0
 .../templates/protobuf/AST_protobuf.tpl                     | 0
 {ifex => output_filters}/templates/protobuf/protobuf.md     | 0
 .../templates/sds-bamm/AST_sds-bamm-aspect-model.tpl        | 0
 .../templates/sds-bamm/sds-bamm-aspect-model.md             | 0
 .../templates/sds-bamm/sds-bamm-macros.tpl                  | 0
 .../templates/simple/AST-simple_doc.tpl                     | 0
 .../templates/simple/Argument-simple_doc.html               | 0
 .../templates/simple/Error-simple_doc.html                  | 0
 .../templates/simple/Member-simple_doc.html                 | 0
 .../templates/simple/Namespace-simple_doc.html              | 0
 .../templates/simple/Service-simple_doc.html                | 0
 .../templates/simple/simple_overview.tpl                    | 0
 setup.py                                                    | 2 +-
 34 files changed, 6 insertions(+), 6 deletions(-)
 rename {ifex => output_filters}/templates/D-Bus/AST.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Argument.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Enumeration.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Error.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Event.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Include.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Interface.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Member.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Method.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Namespace.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Option.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Property.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Struct.tpl (100%)
 rename {ifex => output_filters}/templates/D-Bus/Typedef.tpl (100%)
 rename {ifex => output_filters}/templates/JinjaTemplateEnv.py (97%)
 rename {ifex => output_filters}/templates/TemplateDir.py (100%)
 rename {ifex => output_filters}/templates/__init__.py (100%)
 rename {ifex => output_filters}/templates/dtdl/AST_dtdl.tpl (100%)
 rename {ifex => output_filters}/templates/dtdl/dtdl.md (100%)
 rename {ifex => output_filters}/templates/protobuf/AST_protobuf.tpl (100%)
 rename {ifex => output_filters}/templates/protobuf/protobuf.md (100%)
 rename {ifex => output_filters}/templates/sds-bamm/AST_sds-bamm-aspect-model.tpl (100%)
 rename {ifex => output_filters}/templates/sds-bamm/sds-bamm-aspect-model.md (100%)
 rename {ifex => output_filters}/templates/sds-bamm/sds-bamm-macros.tpl (100%)
 rename {ifex => output_filters}/templates/simple/AST-simple_doc.tpl (100%)
 rename {ifex => output_filters}/templates/simple/Argument-simple_doc.html (100%)
 rename {ifex => output_filters}/templates/simple/Error-simple_doc.html (100%)
 rename {ifex => output_filters}/templates/simple/Member-simple_doc.html (100%)
 rename {ifex => output_filters}/templates/simple/Namespace-simple_doc.html (100%)
 rename {ifex => output_filters}/templates/simple/Service-simple_doc.html (100%)
 rename {ifex => output_filters}/templates/simple/simple_overview.tpl (100%)

diff --git a/docs/static-developer-generators.md b/docs/static-developer-generators.md
index 133d24d2..04ebb81b 100644
--- a/docs/static-developer-generators.md
+++ b/docs/static-developer-generators.md
@@ -39,7 +39,7 @@ A simple generator (with only one template) can be done like this:
 
 Unless you need to add more logic, generating one input file with one (or several)
 templates is basically already available if ifex_generator.py is called as a
-main program.  You specify the directory name (relative to `<project-dir>/ifex/templates`)
+main program.  You specify the directory name (relative to `<project-dir>/output_filters/templates`)
 where the template(s) is stored.  Note that `setup.py` "installs" an executable entrypoint
 `ifexgen` to call the program:
 
@@ -53,7 +53,7 @@ An advanced generator (with several templates) can be done like this:
 * Import the ifex_generator.py and ifex_parser.py, and TemplateDir modules.
 * Get the needed Service description file(s) (YAML), for example from command line argument
 * For each file, get the Abstract Syntax Tree representation by calling `ifex_parser.get_ast_from_yaml_file(service_desc_file)`
-* Write templates according to (some, not all) node types.  You can call `gen(node)` or `gen(node, <Template>)` from within a template - see details below.  Templates must be under a specific sub-directory of `<project-dir>/ifex/templates` and must be named with the naming convention such that the node type is mentioned first (see template chapter).
+* Write templates according to (some, not all) node types.  You can call `gen(node)` or `gen(node, <Template>)` from within a template - see details below.  Templates must be under a specific sub-directory of `<project-dir>/output_filters/templates` and must be named with the naming convention such that the node type is mentioned first (see template chapter).
 * Once the template directory is known, ee-initialize the TemplateDir object if needed.  This will populate the default templates data structure such that gen() knows which template to use.  It automatically uses the naming of the templates to know which template is for which node type.
 * Implement the `gen()` function, normally by delegating directly into `ifex_generator.gen()`, but you can put your own logic here if needed.
 * Set the jinja environment, passing in the gen() and any other symbols that must be callable from within Jinja templates.
@@ -143,7 +143,7 @@ gen(node, 'My-alternative-method-template.tpl')
 ### Naming convention
 The only strict requirement is that all templates to be used by automatic type-to-template mapping in the gen() function, must be within the same subdirectory and must be named according to the naming conventioned mentioned before.
 
-Templates can be stored in the sub-directories of the ifex/templates/ directory.
+Templates can be stored in the sub-directories of the output_filters/templates/ directory.
 
 The intended target format (output format) is normally clear from the naming of the subdirectory.  E.g. "protobuf", or "D-Bus" or "ARXML" or other output format.
 
diff --git a/models/ifex/ifex_generator.py b/models/ifex/ifex_generator.py
index 9d76df1a..c79dbd47 100644
--- a/models/ifex/ifex_generator.py
+++ b/models/ifex/ifex_generator.py
@@ -19,7 +19,7 @@
 
 # For other features from parser module
 from typing import Any
-from ifex.templates import JinjaTemplateEnv
+from output_filters.templates import JinjaTemplateEnv
 
 # Module global - probably soon to be modified to run-time instantiation of a
 # JinjaTemplateEnv instance instead.
diff --git a/ifex/templates/D-Bus/AST.tpl b/output_filters/templates/D-Bus/AST.tpl
similarity index 100%
rename from ifex/templates/D-Bus/AST.tpl
rename to output_filters/templates/D-Bus/AST.tpl
diff --git a/ifex/templates/D-Bus/Argument.tpl b/output_filters/templates/D-Bus/Argument.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Argument.tpl
rename to output_filters/templates/D-Bus/Argument.tpl
diff --git a/ifex/templates/D-Bus/Enumeration.tpl b/output_filters/templates/D-Bus/Enumeration.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Enumeration.tpl
rename to output_filters/templates/D-Bus/Enumeration.tpl
diff --git a/ifex/templates/D-Bus/Error.tpl b/output_filters/templates/D-Bus/Error.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Error.tpl
rename to output_filters/templates/D-Bus/Error.tpl
diff --git a/ifex/templates/D-Bus/Event.tpl b/output_filters/templates/D-Bus/Event.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Event.tpl
rename to output_filters/templates/D-Bus/Event.tpl
diff --git a/ifex/templates/D-Bus/Include.tpl b/output_filters/templates/D-Bus/Include.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Include.tpl
rename to output_filters/templates/D-Bus/Include.tpl
diff --git a/ifex/templates/D-Bus/Interface.tpl b/output_filters/templates/D-Bus/Interface.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Interface.tpl
rename to output_filters/templates/D-Bus/Interface.tpl
diff --git a/ifex/templates/D-Bus/Member.tpl b/output_filters/templates/D-Bus/Member.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Member.tpl
rename to output_filters/templates/D-Bus/Member.tpl
diff --git a/ifex/templates/D-Bus/Method.tpl b/output_filters/templates/D-Bus/Method.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Method.tpl
rename to output_filters/templates/D-Bus/Method.tpl
diff --git a/ifex/templates/D-Bus/Namespace.tpl b/output_filters/templates/D-Bus/Namespace.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Namespace.tpl
rename to output_filters/templates/D-Bus/Namespace.tpl
diff --git a/ifex/templates/D-Bus/Option.tpl b/output_filters/templates/D-Bus/Option.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Option.tpl
rename to output_filters/templates/D-Bus/Option.tpl
diff --git a/ifex/templates/D-Bus/Property.tpl b/output_filters/templates/D-Bus/Property.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Property.tpl
rename to output_filters/templates/D-Bus/Property.tpl
diff --git a/ifex/templates/D-Bus/Struct.tpl b/output_filters/templates/D-Bus/Struct.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Struct.tpl
rename to output_filters/templates/D-Bus/Struct.tpl
diff --git a/ifex/templates/D-Bus/Typedef.tpl b/output_filters/templates/D-Bus/Typedef.tpl
similarity index 100%
rename from ifex/templates/D-Bus/Typedef.tpl
rename to output_filters/templates/D-Bus/Typedef.tpl
diff --git a/ifex/templates/JinjaTemplateEnv.py b/output_filters/templates/JinjaTemplateEnv.py
similarity index 97%
rename from ifex/templates/JinjaTemplateEnv.py
rename to output_filters/templates/JinjaTemplateEnv.py
index 88b12d58..49943319 100644
--- a/ifex/templates/JinjaTemplateEnv.py
+++ b/output_filters/templates/JinjaTemplateEnv.py
@@ -4,7 +4,7 @@
 import os
 import jinja2
 from typing import Dict, Any
-from ifex.templates import TemplateDir
+from output_filters.templates import TemplateDir
 
 class JinjaTemplateEnv:
 
diff --git a/ifex/templates/TemplateDir.py b/output_filters/templates/TemplateDir.py
similarity index 100%
rename from ifex/templates/TemplateDir.py
rename to output_filters/templates/TemplateDir.py
diff --git a/ifex/templates/__init__.py b/output_filters/templates/__init__.py
similarity index 100%
rename from ifex/templates/__init__.py
rename to output_filters/templates/__init__.py
diff --git a/ifex/templates/dtdl/AST_dtdl.tpl b/output_filters/templates/dtdl/AST_dtdl.tpl
similarity index 100%
rename from ifex/templates/dtdl/AST_dtdl.tpl
rename to output_filters/templates/dtdl/AST_dtdl.tpl
diff --git a/ifex/templates/dtdl/dtdl.md b/output_filters/templates/dtdl/dtdl.md
similarity index 100%
rename from ifex/templates/dtdl/dtdl.md
rename to output_filters/templates/dtdl/dtdl.md
diff --git a/ifex/templates/protobuf/AST_protobuf.tpl b/output_filters/templates/protobuf/AST_protobuf.tpl
similarity index 100%
rename from ifex/templates/protobuf/AST_protobuf.tpl
rename to output_filters/templates/protobuf/AST_protobuf.tpl
diff --git a/ifex/templates/protobuf/protobuf.md b/output_filters/templates/protobuf/protobuf.md
similarity index 100%
rename from ifex/templates/protobuf/protobuf.md
rename to output_filters/templates/protobuf/protobuf.md
diff --git a/ifex/templates/sds-bamm/AST_sds-bamm-aspect-model.tpl b/output_filters/templates/sds-bamm/AST_sds-bamm-aspect-model.tpl
similarity index 100%
rename from ifex/templates/sds-bamm/AST_sds-bamm-aspect-model.tpl
rename to output_filters/templates/sds-bamm/AST_sds-bamm-aspect-model.tpl
diff --git a/ifex/templates/sds-bamm/sds-bamm-aspect-model.md b/output_filters/templates/sds-bamm/sds-bamm-aspect-model.md
similarity index 100%
rename from ifex/templates/sds-bamm/sds-bamm-aspect-model.md
rename to output_filters/templates/sds-bamm/sds-bamm-aspect-model.md
diff --git a/ifex/templates/sds-bamm/sds-bamm-macros.tpl b/output_filters/templates/sds-bamm/sds-bamm-macros.tpl
similarity index 100%
rename from ifex/templates/sds-bamm/sds-bamm-macros.tpl
rename to output_filters/templates/sds-bamm/sds-bamm-macros.tpl
diff --git a/ifex/templates/simple/AST-simple_doc.tpl b/output_filters/templates/simple/AST-simple_doc.tpl
similarity index 100%
rename from ifex/templates/simple/AST-simple_doc.tpl
rename to output_filters/templates/simple/AST-simple_doc.tpl
diff --git a/ifex/templates/simple/Argument-simple_doc.html b/output_filters/templates/simple/Argument-simple_doc.html
similarity index 100%
rename from ifex/templates/simple/Argument-simple_doc.html
rename to output_filters/templates/simple/Argument-simple_doc.html
diff --git a/ifex/templates/simple/Error-simple_doc.html b/output_filters/templates/simple/Error-simple_doc.html
similarity index 100%
rename from ifex/templates/simple/Error-simple_doc.html
rename to output_filters/templates/simple/Error-simple_doc.html
diff --git a/ifex/templates/simple/Member-simple_doc.html b/output_filters/templates/simple/Member-simple_doc.html
similarity index 100%
rename from ifex/templates/simple/Member-simple_doc.html
rename to output_filters/templates/simple/Member-simple_doc.html
diff --git a/ifex/templates/simple/Namespace-simple_doc.html b/output_filters/templates/simple/Namespace-simple_doc.html
similarity index 100%
rename from ifex/templates/simple/Namespace-simple_doc.html
rename to output_filters/templates/simple/Namespace-simple_doc.html
diff --git a/ifex/templates/simple/Service-simple_doc.html b/output_filters/templates/simple/Service-simple_doc.html
similarity index 100%
rename from ifex/templates/simple/Service-simple_doc.html
rename to output_filters/templates/simple/Service-simple_doc.html
diff --git a/ifex/templates/simple/simple_overview.tpl b/output_filters/templates/simple/simple_overview.tpl
similarity index 100%
rename from ifex/templates/simple/simple_overview.tpl
rename to output_filters/templates/simple/simple_overview.tpl
diff --git a/setup.py b/setup.py
index 3863f2b7..cce794b8 100644
--- a/setup.py
+++ b/setup.py
@@ -4,7 +4,7 @@
 from setuptools import setup
 from setuptools import find_packages
 
-from ifex.templates import TemplateDir
+from output_filters.templates import TemplateDir
 
 def get_template_files():
       paths = []