Apply new convention to refactor_headers.py

Author: jorisv

development/scripts/misc/refactor_headers.py

@@ -9,27 +9,6 @@
 
 from pathlib import Path
 
-# Walk in a directory
-# Find all xxx.hpp
-# Rename it into xxx-def.hxx
-#  Update guards
-#  Remove includes
-#  Add clangd_hack
-# if xxx.hxx associated
-#   Rename into xxx-decl.hxx
-#     Update guards
-#     Remove includes
-#     Add clangd_hack
-# if xxx.txx associated
-#   Rename into xxx-tpl.hxx
-#    Update guards
-#    Remove includes
-#     Add clangd_hack
-# Create xxx.hpp
-#   Add guards
-#   Add includes form def, decl and tpl
-#   include def, decl and tpl
-
 GUARD_PATTERN = re.compile("^#ifndef __(.*)__$", re.MULTILINE)
 INCLUDE_PATTERN = re.compile(r"^#include ([\"<].*[\">])\n", re.MULTILINE)
 
@@ -59,10 +38,10 @@
 // ...
 #endif // ifndef _pinocchio_python_spatial_se3i_hpp__"""
 
-HPP_MODULE_TPL_GUARD = """
+HPP_MODULE_EXPL_GUARD = """
 /// Explicit template instantiation
 #if PINOCCHIO_ENABLE_TEMPLATE_INSTANTIATION
-    #include "{module_tpl}"
+    #include "{module_expl}"
 #endif // PINOCCHIO_ENABLE_TEMPLATE_INSTANTIATION
 """
 
@@ -79,7 +58,7 @@
 // Module headers
 {module_includes}
 
-{module_tpl_include}
+{module_expl_include}
 
 #endif // ifndef {guard}
 """
@@ -175,13 +154,13 @@ def create_hpp_module(
     guard: str,
     dependencies_includes: list[str],
     module_includes: list[str],
-    module_tpl_include: str | None,
+    module_expl_include: str | None,
 ) -> str:
     """Create a module content.
     :ivar guard: Guard name.
     :ivar dependencies_includes: Module dependencies include paths (path with < or ").
     :ivar module_includes: Module internal include paths (path without < or ").
-    :ivar module_tpl: Module explicit template instantiation (path without < or ").
+    :ivar module_expl: Module explicit template instantiation (path without < or ").
     :return: Module content.
     >>> res = create_hpp_module("__pinocchio_python_spatial_se3_hpp__",\
         ['<eigenpy/eigenpy.hpp>', '<boost/python/tuple.hpp>', '"pinocchio/spatial/se3.hpp"', '"pinocchio/spatial/explog.hpp"'],\
@@ -212,7 +191,7 @@ def create_hpp_module(
     >>> res = create_hpp_module("__pinocchio_python_spatial_se3_hpp__",\
         ['<eigenpy/eigenpy.hpp>', '<boost/python/tuple.hpp>', '"pinocchio/spatial/se3.hpp"', '"pinocchio/spatial/explog.hpp"'],\
         ['pinocchio/bindings/python/spatial/se3_decl.hxx', 'pinocchio/bindings/python/spatial/se3_def.hxx'],\
-        "pinocchio/bindings/python/spatial/se3_tpl.hxx")
+        "pinocchio/bindings/python/spatial/se3_expl.hxx")
     >>> print(res)
     //
     // Copyright (c) 2025 INRIA
@@ -234,7 +213,7 @@ def create_hpp_module(
     <BLANKLINE>
     /// Explicit template instantiation
     #if PINOCCHIO_ENABLE_TEMPLATE_INSTANTIATION
-        #include "pinocchio/bindings/python/spatial/se3_tpl.hxx"
+        #include "pinocchio/bindings/python/spatial/se3_expl.hxx"
     #endif // PINOCCHIO_ENABLE_TEMPLATE_INSTANTIATION
     <BLANKLINE>
     <BLANKLINE>
@@ -243,14 +222,14 @@ def create_hpp_module(
     """
     deps = "\n".join([f"#include {d}" for d in dependencies_includes])
     modules = "\n".join([f'#include "{d}"' for d in module_includes])
-    module_tpl = ""
-    if module_tpl_include is not None:
-        module_tpl = HPP_MODULE_TPL_GUARD.format(module_tpl=module_tpl_include)
+    module_expl = ""
+    if module_expl_include is not None:
+        module_expl = HPP_MODULE_EXPL_GUARD.format(module_expl=module_expl_include)
     return HPP_MODULE.format(
         guard=guard,
         dep_includes=deps,
         module_includes=modules,
-        module_tpl_include=module_tpl,
+        module_expl_include=module_expl,
     )
 
 
@@ -309,15 +288,15 @@ def update_module(module_path: Path, include_root_path: Path, dry: bool = False)
 
     module_path_rel = module_path.relative_to(include_root_path)
     module_old_def = module_path.parent / Path(f"{module_path.stem}.hxx")
-    module_old_tpl = module_path.parent / Path(f"{module_path.stem}.txx")
+    module_old_expl = module_path.parent / Path(f"{module_path.stem}.txx")
     module_decl = module_path.parent / Path(f"{module_path.stem}-decl.hxx")
     module_def = module_path.parent / Path(f"{module_path.stem}-def.hxx")
-    module_tpl = module_path.parent / Path(f"{module_path.stem}-tpl.hxx")
+    module_expl = module_path.parent / Path(f"{module_path.stem}-expl.hxx")
 
     print(f"\tConvert {module_path} into {module_decl}")
     dependency_includes = []
     module_includes = [str(module_decl.relative_to(include_root_path))]
-    module_tpl_include = None
+    module_expl_include = None
 
     decl_includes, module_guard = update_content(
         module_path,
@@ -360,35 +339,35 @@ def update_module(module_path: Path, include_root_path: Path, dry: bool = False)
             )
         module_includes.append(str(module_def.relative_to(include_root_path)))
 
-    if module_old_tpl.exists():
-        print(f"\tConvert {module_old_tpl} into {module_tpl}")
-        tpl_includes, _ = update_content(
-            module_old_tpl,
+    if module_old_expl.exists():
+        print(f"\tConvert {module_old_expl} into {module_expl}")
+        expl_includes, _ = update_content(
+            module_old_expl,
             module_path_rel,
-            guard_from_path(module_tpl.relative_to(include_root_path)),
+            guard_from_path(module_expl.relative_to(include_root_path)),
             dry,
         )
-        dependency_includes += tpl_includes
+        dependency_includes += expl_includes
         if not dry:
             subprocess.run(
                 [
                     "git",
                     "-C",
                     str(include_root_path),
                     "mv",
-                    str(module_old_tpl),
-                    str(module_tpl),
+                    str(module_old_expl),
+                    str(module_expl),
                 ]
             )
-        module_tpl_include = str(module_tpl.relative_to(include_root_path))
+        module_expl_include = str(module_expl.relative_to(include_root_path))
 
     print(f"\tCreate new module {module_path}")
     print(f"\tNew module guard: {module_guard}")
     print(f"\tNew module dependencies: {', '.join(dependency_includes)}")
     print(f"\tNew module includes: {', '.join(module_includes)}")
-    print(f"\tNew module tpl: {module_tpl_include}")
+    print(f"\tNew module expl: {module_expl_include}")
     module_content = create_hpp_module(
-        module_guard, dependency_includes, module_includes, module_tpl_include
+        module_guard, dependency_includes, module_includes, module_expl_include
     )
     if not dry:
         with module_path.open("w") as module_path_desc:
@@ -427,6 +406,28 @@ def argument_parser() -> argparse.ArgumentParser:
 
 
 def main(args: list[str]):
+    """
+    Walk in a directory
+    Find all xxx.hpp
+    Rename it into xxx-def.hxx
+     Update guards
+     Remove includes
+     Add clangd_hack
+    if xxx.hxx associated
+      Rename into xxx-decl.hxx
+        Update guards
+        Remove includes
+        Add clangd_hack
+    if xxx.txx associated
+      Rename into xxx-expl.hxx
+       Update guards
+       Remove includes
+        Add clangd_hack
+    Create xxx.hpp
+      Add guards
+      Add includes form def, decl and expl
+      include def, decl and expl
+    """
     parser = argument_parser()
     args = parser.parse_args(args)