Use Jinja preprocessor to remove some constant variables from the code

Author: object-Object

.gitignore

@@ -5,6 +5,7 @@
 *.hex
 /build/
 /out/
+/src/main.mlog
 
 node_modules/
 

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "files.associations": {
-        "*.s": "riscv"
+        "*.s": "riscv",
+        "*.mlog.jinja": "mlog"
     },
     "[markdown]": {
         "editor.formatOnSave": true,

nodemon.json

@@ -0,0 +1,5 @@
+{
+    "watch": ["src", "python"],
+    "ext": "jinja,py",
+    "exec": "python -m mlogv32.preprocessor src/main.mlog.jinja -o src/main.mlog"
+}

pyproject.toml

@@ -7,6 +7,7 @@ name = "mlogv32"
 version = "0.1.0"
 requires-python = ">=3.12"
 dependencies = [
+    "jinja2>=3.1.6",
     "pydantic>=2.11.5",
     "pymsch>=0.0.11",
     "pyperclip>=1.9.0",

python/src/mlogv32/preprocessor/__init__.py

@@ -0,0 +1 @@
+"""Fairly simple mlog preprocessor script."""

python/src/mlogv32/preprocessor/__main__.py

@@ -0,0 +1,3 @@
+from .app import app
+
+app()

python/src/mlogv32/preprocessor/app.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+from typing import Annotated
+
+from jinja2 import Environment, FileSystemLoader, StrictUndefined
+from typer import Option, Typer
+
+from . import filters
+
+app = Typer()
+
+
+@app.command()
+def main(
+    path: Path,
+    output: Annotated[Path | None, Option("-o", "--output")] = None,
+):
+    path = path.resolve()
+
+    env = Environment(
+        loader=FileSystemLoader(path.parent),
+        line_statement_prefix="#%",
+        line_comment_prefix="#%#",
+        autoescape=False,
+        lstrip_blocks=True,
+        trim_blocks=True,
+        undefined=StrictUndefined,
+    )
+    env.filters |= {  # pyright: ignore[reportAttributeAccessIssue]
+        "ram_variable": filters.ram_variable,
+        "quote": filters.quote,
+        "csr": filters.csr,
+    }
+
+    template = env.get_template(path.name)
+    result = template.render()
+
+    if output:
+        output.parent.mkdir(parents=True, exist_ok=True)
+        output.write_text(result, "utf-8")
+    else:
+        print(result)
+
+
+if __name__ == "__main__":
+    app()

python/src/mlogv32/preprocessor/filters.py

@@ -0,0 +1,113 @@
+import functools
+from typing import Any, Callable
+
+from jinja2.runtime import Context
+
+from mlogv32.scripts.ram_proc import VariableFormat
+
+
+# from hexdoc.jinja.filters
+def make_jinja_exceptions_suck_a_bit_less[**P, R](f: Callable[P, R]) -> Callable[P, R]:
+    @functools.wraps(f)
+    def wrapper(*args: P.args, **kwargs: P.kwargs):
+        try:
+            return f(*args, **kwargs)
+        except Exception as e:
+            args_ = list(args)
+            if args_ and isinstance(args_[0], Context):
+                args_ = args_[1:]
+
+            e.add_note(f"args:   {args_}")
+            e.add_note(f"kwargs: {kwargs}")
+            raise
+
+    return wrapper
+
+
+@make_jinja_exceptions_suck_a_bit_less
+def ram_variable(index: int):
+    return VariableFormat.minimized.get_variable(index)
+
+
+@make_jinja_exceptions_suck_a_bit_less
+def csr(name: str | int):
+    match name:
+        case str():
+            if name not in CSRS:
+                raise KeyError(f"Invalid CSR: {name}")
+            return ram_variable(CSRS[name])
+        case int():
+            return ram_variable(name)
+
+
+@make_jinja_exceptions_suck_a_bit_less
+def quote(value: Any):
+    return f'"{value}"'
+
+
+CSRS: dict[str, int] = {
+    # unprivileged
+    "cycle": 0xC00,
+    "time": 0xC01,
+    "instret": 0xC02,
+    **{f"hpmcounter{i}": 0xC00 + i for i in range(3, 32)},
+    "cycleh": 0xC80,
+    "timeh": 0xC81,
+    "instreth": 0xC82,
+    **{f"hpmcounter{i}h": 0xC80 + i for i in range(3, 32)},
+    # supervisor
+    "sstatus": 0x100,
+    "sie": 0x104,
+    "stvec": 0x105,
+    "scounteren": 0x106,
+    "senvcfg": 0x10A,
+    "scountinhibit": 0x120,
+    "sscratch": 0x140,
+    "sepc": 0x141,
+    "scause": 0x142,
+    "stval": 0x143,
+    "sip": 0x144,
+    "scountovf": 0xDA0,
+    "satp": 0x180,
+    "scontext": 0x5A8,
+    "sstateen0": 0x10C,
+    "sstateen1": 0x10D,
+    "sstateen2": 0x10E,
+    "sstateen3": 0x10F,
+    # machine
+    "mvendorid": 0xF11,
+    "marchid": 0xF12,
+    "mimpid": 0xF13,
+    "mhartid": 0xF14,
+    "mconfigptr": 0xF15,
+    "mstatus": 0x300,
+    "misa": 0x301,
+    "medeleg": 0x302,
+    "mideleg": 0x303,
+    "mie": 0x304,
+    "mtvec": 0x305,
+    "mcounteren": 0x306,
+    "mstatush": 0x310,
+    "medelegh": 0x312,
+    "mscratch": 0x340,
+    "mepc": 0x341,
+    "mcause": 0x342,
+    "mtval": 0x343,
+    "mip": 0x344,
+    "mtinst": 0x34A,
+    "mtval2": 0x34B,
+    "menvcfg": 0x30A,
+    "menvcfgh": 0x31A,
+    "mseccfg": 0x747,
+    "mseccfgh": 0x757,
+    **{f"pmpcfg{i}": 0x3A0 + i for i in range(0, 16)},
+    **{f"pmpaddr{i}": 0x3B0 + i for i in range(0, 64)},
+    "mstateen0": 0x30C,
+    "mstateen1": 0x30D,
+    "mstateen2": 0x30E,
+    "mstateen3": 0x30F,
+    "mstateen0h": 0x31C,
+    "mstateen1h": 0x31D,
+    "mstateen2h": 0x31E,
+    "mstateen3h": 0x31F,
+}

src/main.constants.jinja

@@ -0,0 +1,17 @@
+{#- preprocessor constants for main.mlog.jinja -#}
+
+{#- linked buildings -#}
+{% set REGISTERS = 'cell1' %}
+{% set CSRS = 'processor17' %}
+{% set INCR = 'processor18' %}
+{% set CONFIG = 'processor19' %}
+
+{% set ERROR_OUTPUT = 'message1' %}
+{% set RESET_SWITCH = 'switch1' %}
+{% set PAUSE_SWITCH = 'switch2' %}
+{% set SINGLE_STEP_SWITCH = 'switch3' %}
+
+{% set KBCONV_DATA = 'cell2' %}
+{% set DISPLAY = 'display1' %}
+
+{% block contents %}{% endblock %}