proj-flow 0.18.0__tar.gz → 0.19.0__tar.gz

{proj_flow-0.18.0 → proj_flow-0.19.0}/CHANGELOG.rst

@@ -4,6 +4,14 @@ Changelog
 
 All notable changes to this project will be documented in this file.
 
+`0.19.0 <https://github.com/mzdun/proj-flow/compare/v0.18.0...v0.19.0>`_ (2026-01-18)
+=====================================================================================
+
+New Features
+------------
+
+- add codegen through WebIDL and {{mustache}} (`9cb7d52 <https://github.com/mzdun/proj-flow/commit/9cb7d527bb9529af6334514155f5b2aa2ce6f48d>`_)
+
 `0.18.0 <https://github.com/mzdun/proj-flow/compare/v0.17.2...v0.18.0>`_ (2026-01-11)
 =====================================================================================
 

{proj_flow-0.18.0 → proj_flow-0.19.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: proj-flow
-Version: 0.18.0
+Version: 0.19.0
 Summary: C++ project maintenance, automated
 Project-URL: Changelog, https://github.com/mzdun/proj-flow/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://proj-flow.readthedocs.io/en/latest/
@@ -20,6 +20,7 @@ Requires-Python: >=3.10
 Requires-Dist: argcomplete
 Requires-Dist: chevron2021
 Requires-Dist: prompt-toolkit
+Requires-Dist: pywebidl2
 Requires-Dist: pyyaml
 Requires-Dist: toml
 Description-Content-Type: text/markdown

{proj_flow-0.18.0 → proj_flow-0.19.0}/pyproject.toml

@@ -28,6 +28,7 @@ dependencies = [
   "prompt_toolkit",
   "PyYAML",
   "toml",
+  "pywebidl2",
 ]
 description = "C++ project maintenance, automated"
 dynamic = ["version"]

{proj_flow-0.18.0 → proj_flow-0.19.0}/src/proj_flow/__init__.py

@@ -6,4 +6,4 @@ The **proj_flow** contains only ``__version__`` to be updated, nothing more.
 This is in an attempt to make this module easy to load initially.
 """
 
-__version__ = "0.18.0"
+__version__ = "0.19.0"

proj_flow-0.19.0/src/proj_flow/ext/webidl/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+"""
+The **proj_flow.ext.webidl** provides ``webidl init``, ``webidl cmake``,
+``webidl depfile``and ``webidl gen`` commands, allowing for simple
+WebIDL/mustache generation.
+"""
+
+from . import cli
+
+__all__ = ["cli"]

proj_flow-0.19.0/src/proj_flow/ext/webidl/base/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)

proj_flow-0.19.0/src/proj_flow/ext/webidl/base/config.py

@@ -0,0 +1,425 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+
+import copy
+import json
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Callable, cast
+
+import chevron
+
+from proj_flow.ext.webidl.model.builders import ExtAttrsContextBuilders, TypeReplacement
+
+package_root = Path(__file__).parent.parent
+templates_dir = package_root / "data" / "templates"
+
+
+def load_package_template(name: str):
+    path = templates_dir / f"{name}.mustache"
+    return path.read_text(encoding="UTF-8")
+
+
+@dataclass
+class CMakeDirs:
+    base_dir: Path
+    project_source_dir: Path
+    project_binary_dir: Path
+    current_source_dir: Path
+    current_binary_dir: Path
+
+    @staticmethod
+    def from_config_path(config: Path, project_binary_dir: Path):
+        config = config.absolute()
+        project_binary_dir = project_binary_dir.absolute()
+        base_dir = config.parent
+        project_source_dir = Path().absolute()
+        current_source_dir = project_source_dir
+
+        for parent in config.parents:
+            cmake_lists = parent / "CMakeLists.txt"
+            if cmake_lists.exists():
+                current_source_dir = parent
+                break
+
+        current_binary_dir = project_binary_dir / current_source_dir.relative_to(
+            project_source_dir
+        )
+
+        return CMakeDirs(
+            base_dir=base_dir,
+            project_source_dir=project_source_dir,
+            project_binary_dir=project_binary_dir,
+            current_source_dir=current_source_dir,
+            current_binary_dir=current_binary_dir,
+        )
+
+    def filename_from_config(self, config: Path, ext: str):
+        in_source = config.absolute().relative_to(self.current_source_dir)
+        in_build = self.current_binary_dir / in_source
+        return Path(in_build.as_posix() + ext)
+
+    def dependency_from_config(self, config: Path):
+        return self.filename_from_config(config, ".deps")
+
+    def cmake_from_config(self, config: Path):
+        return self.filename_from_config(config, ".cmake")
+
+    def my_defines(self):
+        return {
+            "PROJECT_SOURCE_DIR": self.project_source_dir.as_posix(),
+            "PROJECT_BINARY_DIR": self.project_binary_dir.as_posix(),
+            "CMAKE_CURRENT_SOURCE_DIR": self.current_source_dir.as_posix(),
+            "CMAKE_CURRENT_BINARY_DIR": self.current_binary_dir.as_posix(),
+        }
+
+    def prefix(self, filename: str):
+        if "${" in filename:
+            return Path(filename)
+
+        full = self.base_dir / filename
+
+        if full.is_relative_to(self.current_binary_dir):
+            return Path("${CMAKE_CURRENT_BINARY_DIR}") / full.relative_to(
+                self.current_binary_dir
+            )
+        if full.is_relative_to(self.project_binary_dir):
+            return Path("${PROJECT_BINARY_DIR}") / full.relative_to(
+                self.project_binary_dir
+            )
+        if full.is_relative_to(self.current_source_dir):
+            return Path("${CMAKE_CURRENT_SOURCE_DIR}") / full.relative_to(
+                self.current_source_dir
+            )
+        if full.is_relative_to(self.project_source_dir):
+            return Path("${PROJECT_SOURCE_DIR}") / full.relative_to(
+                self.project_source_dir
+            )
+
+        return Path(filename)
+
+    def make_abs_path(self):
+        def impl(filename: str):
+            return self.prefix(filename)
+
+        return impl
+
+
+def _relative(path: Path, basedir: Path | None):
+    if not basedir:
+        return path
+    return path.relative_to(basedir, walk_up=True)
+
+
+class Rebuild:
+    @staticmethod
+    def __rebuild_map(data: dict, global_ctx: dict[str, str]):
+        for key, value in data.items():
+            data[key] = Rebuild.__rebuild_any(value, global_ctx)
+        return data
+
+    @staticmethod
+    def __rebuild_list(data: list, global_ctx: dict[str, str]):
+        for index, value in enumerate(data):
+            data[index] = Rebuild.__rebuild_any(value, global_ctx)
+        return data
+
+    @staticmethod
+    def __rebuild_str(data: str, global_ctx: dict[str, str]):
+        return chevron.render(data, global_ctx)
+
+    @staticmethod
+    def __rebuild_any(data, global_ctx: dict[str, str]):
+        if isinstance(data, str):
+            return Rebuild.__rebuild_str(data, global_ctx)
+        if isinstance(data, list):
+            return Rebuild.__rebuild_list(data, global_ctx)
+        if isinstance(data, dict):
+            return Rebuild.__rebuild_map(data, global_ctx)
+
+        return data
+
+    @staticmethod
+    def rebuild(initial_context: dict, global_ctx: dict[str, str]):
+        return Rebuild.__rebuild_map(initial_context, global_ctx)
+
+
+@dataclass
+class ConfigOutput:
+    output_name: str
+    mustache_template: str | None
+    output_template: str | None
+    lang: str | None
+    types: str | None
+    partials: str | None
+    initial_context: dict
+    debug: bool
+    ndebug: bool
+
+    @staticmethod
+    def from_config(
+        data: dict[str, str | dict[str, Any]], root_default: "ConfigOutput"
+    ):
+        result = [ConfigOutput.from_dict(key, item) for key, item in data.items()]
+
+        for index in range(len(result)):
+            default = result[index]
+            if default.output_name != "":
+                continue
+
+            del result[index]
+            for item in result:
+                item.update_from(default)
+
+            break
+
+        for item in result:
+            item.update_from(root_default)
+
+        return result
+
+    @staticmethod
+    def from_dict(
+        output_name: str, data: str | dict[str, str | dict]
+    ) -> "ConfigOutput":
+        if isinstance(data, str):
+            return ConfigOutput(
+                output_name=output_name,
+                mustache_template=data,
+                output_template=None,
+                lang=None,
+                types=None,
+                partials=None,
+                initial_context={},
+                debug=False,
+                ndebug=False,
+            )
+
+        mustache_template = cast(str | None, data.get("template", None))
+        output_template = cast(str | None, data.get("path", None))
+        lang = cast(str | None, data.get("lang", None))
+        types = cast(str | None, data.get("types", None))
+        partials = cast(str | None, data.get("partials", None))
+        initial_context = copy.deepcopy(cast(dict, data.get("context", {})))
+        debug = not not data.get("debug", {})
+        ndebug = not not data.get("ndebug", {})
+
+        return ConfigOutput(
+            output_name=output_name,
+            mustache_template=mustache_template,
+            output_template=output_template,
+            lang=lang,
+            types=types,
+            partials=partials,
+            initial_context=initial_context,
+            debug=debug,
+            ndebug=ndebug,
+        )
+
+    def update_from(self, default: "ConfigOutput"):
+        self.mustache_template = self.mustache_template or default.mustache_template
+        self.output_template = self.output_template or default.output_template
+        self.lang = self.lang or default.lang
+        self.types = self.types or default.types
+        self.partials = self.partials or default.partials
+        self.initial_context = {
+            **copy.deepcopy(self.initial_context),
+            **copy.deepcopy(default.initial_context),
+        }
+        self.debug = self.debug or default.debug
+        self.ndebug = self.ndebug or default.ndebug
+
+
+def _file_props(path: Path):
+    suffixes = "".join(path.suffixes)
+    name = path.name
+    shortest = name[: -len(suffixes)]
+    return {
+        "filename": path.as_posix(),
+        "dirname": path.parent.as_posix(),
+        "basename": path.name,
+        "stem": path.stem,
+        "suffix": path.suffix,
+        "suffixes": suffixes,
+        "shortest_stem": shortest,
+    }
+
+
+def _rel_file_props(path: Path, root: Path):
+    props: dict = _file_props(path)
+    if path.is_relative_to(root):
+        rel = path.relative_to(root)
+        props["relative"] = {
+            "filename": rel.as_posix(),
+            "dirname": rel.parent.as_posix(),
+        }
+    return props
+
+
+@dataclass
+class Output:
+    output: Path
+    mustache_template: Path | None
+    lang: str | None
+    types: Path | None
+    partials: Path | None
+    initial_context: dict
+    debug: bool
+
+    @staticmethod
+    def filename_context(filename: str, root_dir: Path):
+        return _rel_file_props(Path(filename), root_dir)
+
+    @staticmethod
+    def abs_path(basedir: Path, path: str):
+        return basedir / path
+
+    @staticmethod
+    def from_config(
+        context: dict[str, str],
+        root_default: ConfigOutput,
+        data: dict[str, str | dict[str, Any]],
+        abs_path: Callable[[str], Path],
+    ):
+        expand_path = lambda text: chevron.render(template=text, data=context)
+
+        result: list[Output] = []
+
+        for output in ConfigOutput.from_config(data, root_default):
+            output_name = expand_path(output.output_name)
+            context["PATH"] = str(output_name)
+
+            if output.output_template:
+                output_name = expand_path(output.output_template)
+            output_name = abs_path(output_name)
+
+            mustache_template = None
+            if output.mustache_template:
+                mustache_template = abs_path(expand_path(output.mustache_template))
+
+            types = None
+            if output.types:
+                types = abs_path(expand_path(output.types))
+
+            partials = None
+            if output.partials:
+                partials = abs_path(expand_path(output.partials))
+
+            result.append(
+                Output(
+                    output=output_name,
+                    mustache_template=mustache_template,
+                    lang=output.lang,
+                    types=types,
+                    partials=partials,
+                    initial_context=Rebuild.rebuild(output.initial_context, context),
+                    debug=output.debug and not output.ndebug,
+                )
+            )
+
+        return result
+
+    def get_type_replacements(self):
+        return TypeReplacement.load_config(self.lang, self.types)
+
+
+@dataclass
+class TemplateRule:
+    inputs: list[Path]
+    outputs: list[Output]
+
+    @staticmethod
+    def from_config(
+        global_ctx: dict, source_dir: Path, data: dict, abs_path: Callable[[str], Path]
+    ):
+        templates = cast(dict[str, dict[str, str | dict]], data.get("templates", {}))
+        inputs = cast(list[dict[str, str]], data.get("inputs", []))
+        return cast(
+            list[TemplateRule],
+            list(
+                filter(
+                    lambda v: v is not None,
+                    [
+                        TemplateRule.__get_rule(
+                            cast(list[str] | str, input.get("idl", [])),
+                            cast(str | None, input.get("template")),
+                            global_ctx,
+                            source_dir,
+                            templates,
+                            abs_path,
+                        )
+                        for input in inputs
+                    ],
+                )
+            ),
+        )
+
+    @staticmethod
+    def __get_rule(
+        input_names: str | list[str],
+        suite_id: str | None,
+        global_ctx: dict,
+        source_dir: Path,
+        templates: dict[str, dict[str, str | dict[str, Any]]],
+        abs_path: Callable[[str], Path],
+    ):
+        if suite_id is None:
+            return None
+
+        names = [input_names] if isinstance(input_names, str) else input_names
+        context = {**global_ctx, "input": Output.filename_context(names[0], source_dir)}
+
+        inputs = [abs_path(name) for name in names]
+        root_config = ConfigOutput.from_dict("", templates.get("", {}).get("", {}))
+        outputs = Output.from_config(
+            context, root_config, templates.get(suite_id, {}), abs_path
+        )
+
+        return TemplateRule(inputs=inputs, outputs=outputs)
+
+    def get_dependencies(
+        self, CMAKE_CURRENT_BINARY_DIR: Path | None, *additional_inputs: Path
+    ) -> dict[str, list[str]]:
+        def rel(path: Path):
+            return _relative(path, CMAKE_CURRENT_BINARY_DIR)
+
+        result: dict[str, list[str]] = {}
+        for out in self.outputs:
+            current_inputs: list[Path] = [*self.inputs, *additional_inputs]
+            if out.mustache_template:
+                current_inputs.append(out.mustache_template)
+            result[rel(out.output).as_posix()] = [
+                path.as_posix() for path in current_inputs
+            ]
+        return result
+
+
+@dataclass
+class TemplateConfig:
+    version: int
+    rules: list[TemplateRule]
+    ext_attrs: ExtAttrsContextBuilders
+
+    @staticmethod
+    def load_config(
+        config: Path,
+        context: dict,
+        source_dir: Path,
+        abs_path: Callable[[str], Path] | None = None,
+    ):
+        with config.open(encoding="UTF-8") as json_file:
+            data = cast(dict, json.load(json_file))
+
+        config_dep = config.absolute()
+        basedir = config_dep.parent
+
+        return TemplateConfig(
+            version=cast(int, data.get("version", 1)),
+            rules=TemplateRule.from_config(
+                context, source_dir, data, abs_path or (lambda path: basedir / path)
+            ),
+            ext_attrs=ExtAttrsContextBuilders.builtin().merge(
+                ExtAttrsContextBuilders.from_config(data)
+            ),
+        )

proj_flow-0.19.0/src/proj_flow/ext/webidl/cli/__init__.py

@@ -0,0 +1,10 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+from proj_flow.ext.webidl.cli.cmake import cmake
+from proj_flow.ext.webidl.cli.depfile import depfile
+from proj_flow.ext.webidl.cli.gen import gen
+from proj_flow.ext.webidl.cli.init import init
+from proj_flow.ext.webidl.cli.root import webidl
+
+__all__ = ["webidl", "init", "cmake", "depfile", "gen"]

proj_flow-0.19.0/src/proj_flow/ext/webidl/cli/cmake.py

@@ -0,0 +1,82 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+import typing
+from pathlib import Path
+
+import chevron
+
+from proj_flow.api import arg, env
+from proj_flow.ext.webidl.base.config import (
+    CMakeDirs,
+    TemplateConfig,
+    load_package_template,
+)
+from proj_flow.ext.webidl.cli.updater import update_file_if_needed
+
+
+@arg.command("webidl", "cmake")
+def cmake(
+    config_path: typing.Annotated[
+        str, arg.Argument(help="Input configuration", names=["--cfg"], meta="json-file")
+    ],
+    binary_dir: typing.Annotated[
+        str,
+        arg.Argument(
+            help="Project binary dir", names=["--binary-dir"], meta="project-binary-dir"
+        ),
+    ],
+    target: typing.Annotated[
+        str | None,
+        arg.Argument(
+            help="Name of the target to add output files to", meta="name", opt=True
+        ),
+    ],
+    rt: env.Runtime,
+):
+    """Write the CMake configuration based on given config"""
+
+    global_ctx = {
+        key: f"${{{key}}}"
+        for key in [
+            "CMAKE_CURRENT_SOURCE_DIR",
+            "CMAKE_CURRENT_BINARY_DIR",
+            "PROJECT_SOURCE_DIR",
+            "PROJECT_BINARY_DIR",
+        ]
+    }
+    config_filename = Path(config_path)
+    cmake_dirs = CMakeDirs.from_config_path(
+        config_filename, project_binary_dir=Path(binary_dir)
+    )
+
+    abs_path = cmake_dirs.make_abs_path()
+
+    depfile_ref = cmake_dirs.prefix(
+        str(cmake_dirs.dependency_from_config(config_filename))
+    )
+    cmake_filename = cmake_dirs.cmake_from_config(config_filename)
+    config_noext = cmake_dirs.filename_from_config(config_filename, "")
+
+    config = TemplateConfig.load_config(
+        config_filename.absolute(), global_ctx, cmake_dirs.project_source_dir, abs_path
+    )
+
+    context = {
+        "config": {
+            "binary": cmake_dirs.prefix(str(config_noext)).as_posix(),
+            "source": cmake_dirs.prefix(str(config_filename.absolute())).as_posix(),
+            "basename": config_filename.name,
+        },
+        "output": [
+            out.output.as_posix() for rule in config.rules for out in rule.outputs
+        ],
+        "target": target,
+        "depfile": depfile_ref.as_posix(),
+    }
+
+    text = load_package_template("cmake")
+    text = chevron.render(text, data=context, partials_path=None)
+    update_file_if_needed(
+        cmake_filename, text, f"Generating {cmake_filename.as_posix()}"
+    )

proj_flow-0.19.0/src/proj_flow/ext/webidl/cli/depfile.py

@@ -0,0 +1,83 @@
+# Copyright (c) 2026 Marcin Zdun
+# This code is licensed under MIT license (see LICENSE for details)
+
+import typing
+from pathlib import Path
+
+import chevron
+
+from proj_flow.api import arg, env
+from proj_flow.ext.webidl.base.config import (
+    CMakeDirs,
+    TemplateConfig,
+    load_package_template,
+)
+from proj_flow.ext.webidl.cli.updater import update_file_if_needed
+
+
+@arg.command("webidl", "depfile")
+def depfile(
+    config_path: typing.Annotated[
+        str, arg.Argument(help="Input configuration", names=["--cfg"], meta="json-file")
+    ],
+    binary_dir: typing.Annotated[
+        str,
+        arg.Argument(
+            help="Project binary dir", names=["--binary-dir"], meta="project-binary-dir"
+        ),
+    ],
+    output_path: typing.Annotated[
+        str | None,
+        arg.Argument(
+            help="Output path", names=["--out"], meta="dependency-file", opt=True
+        ),
+    ],
+    rt: env.Runtime,
+):
+    """Write the dependency file for CMake generators to use"""
+
+    cmake_dirs = CMakeDirs.from_config_path(
+        Path(config_path), project_binary_dir=Path(binary_dir)
+    )
+    global_ctx = cmake_dirs.my_defines()
+
+    config_filename = Path(config_path).absolute()
+    config = TemplateConfig.load_config(
+        config_filename, global_ctx, cmake_dirs.project_source_dir
+    )
+
+    output = (
+        Path(output_path)
+        if output_path
+        else cmake_dirs.dependency_from_config(Path(config_path))
+    )
+
+    flat_deps: dict[str, set[str]] = {}
+
+    for rule in config.rules:
+        for outname, inputs in rule.get_dependencies(None, config_filename).items():
+            try:
+                flat_deps[outname].update(inputs)
+            except KeyError:
+                flat_deps[outname] = set(inputs)
+    reverse: dict[str, set[str]] = {}
+    for key, value in flat_deps.items():
+        val = ";".join(sorted(value))
+        try:
+            reverse[val].update(key)
+        except KeyError:
+            reverse[val] = {key}
+
+    rules: list[dict] = []
+    for deps, tgts in reverse.items():
+        dependency = deps.split(";")
+        target = [{"sep": " \\\n", "pathname": pathname} for pathname in tgts]
+        target[0]["sep"] = ""
+        rules.append({"dependency": dependency, "target": target})
+
+    text = load_package_template("depfile")
+    update_file_if_needed(
+        output,
+        chevron.render(text, {"rule": rules}),
+        f"Generating {output.as_posix()}",
+    )