Merge pull request #12 from darsor/dev/self-contained-use

Self-contained use statements, fixes #9

Author: darsor

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Fixed
+
+- Generate self-contained `use` statements that don't rely on the module structure outside the generated code. ([#9](https://github.com/darsor/PeakRDL-rust/issues/9))
+
 ## [0.7.1] - 2026-03-23
 
 ### Fixed

src/peakrdl_rust/component_context.py

@@ -305,7 +305,7 @@ def enter_addrmap_or_regfile_or_memory(
             else:
                 module_names = utils.crate_module_path(child)
                 scoped_module = "::".join(
-                    ["crate", "components"] + list(map(kw_filter, module_names))
+                    ["_root", "components"] + list(map(kw_filter, module_names))
                 )
                 named_type_instances.append((inst_name, scoped_module))
 
@@ -527,7 +527,7 @@ def enter_Field(self, node: FieldNode) -> Optional[WalkerAction]:
             instantiating_file = self.get_node_module_file(instantiating_node)
             assert instantiating_file in self.components
             scoped_module = "::".join(
-                ["crate", "components"] + list(map(kw_filter, module_names))
+                ["_root", "components"] + list(map(kw_filter, module_names))
             )
             self.components[instantiating_file].named_type_instances.append(
                 (snakecase(field.inst_name), scoped_module)

src/peakrdl_rust/templates/components.rs

@@ -1,6 +1,8 @@
 //! SystemRDL component definitions
 #![allow(non_camel_case_types)] // needed for type normalization suffixes
 
+use super::_root; // alias to root module of generated code
+
 {% for component in ctx.components %}
 pub mod {{component|kw_filter}};
 {% endfor %}

src/peakrdl_rust/templates/components/macros.jinja2

@@ -12,6 +12,8 @@ while {{idx}} < {{dims[depth]}} {
 {%- endmacro -%}
 
 {% macro includes(ctx) %}
+#[allow(unused_imports)]
+use super::_root; // alias to root module of generated code
 {% for use in ctx.use_statements %}
 {{use}}
 {% endfor %}
@@ -26,6 +28,8 @@ pub mod {{mod|kw_filter}};
 {% if ctx.named_type_declarations|length > 0 %}
 /// Named types defined within this component's body
 pub mod named_types {
+    #[allow(unused_imports)]
+    use super::_root; // alias to root module of generated code
     {% for mod in ctx.named_type_declarations %}
     pub mod {{mod|kw_filter}};
     {% endfor %}

src/peakrdl_rust/templates/mod.rs

@@ -16,6 +16,12 @@ pub mod components;
 pub use {{top_node}};
 {% endfor %}
 
+/// Alias this module as the root of the generated code
+mod _root {
+    #[allow(unused_imports)]
+    pub use super::*;
+}
+
 /// Version of PeakRDL-rust used to generate this code
 pub const PEAKRDL_RUST_VERSION: &str = "{{ctx.peakrdl_rust_version}}";
 

tests/rdl_src/non_root_module.rdl

@@ -0,0 +1,29 @@
+reg r_global {
+    field {} f1[4];
+
+    field myfield {};
+    myfield f2;
+    myfield f3[4];
+    field myfield2 {fieldwidth = 4;};
+    myfield2 f4;
+};
+
+regfile rf_global #(
+    longint unsigned NUM = 4
+){
+    reg r_local {
+        field {} f_param[NUM];
+        field myfield {};
+        myfield f_param2[NUM];
+    } r1;
+    r_global r2;
+
+    signal {} xyz;
+};
+
+addrmap top {
+    rf_global rf1;
+    rf_global #(.NUM (8)) rf2;
+    rf_global rf3[4] @ 0x1000 += 0x100;
+    rf_global rf4[4] @ 0x2000 += 0x200;
+};

tests/templates/Cargo.toml.tmpl tests/templates/Cargo.toml.jinja2tests/templates/Cargo.toml.tmpl renamed to tests/templates/Cargo.toml.jinja2

@@ -0,0 +1,4 @@
+pub mod generated;
+{% if ctx.test_name != "non_root_module" %}
+pub use generated::*;
+{% endif %}

tests/templates/lib.rs.jinja2

@@ -5,6 +5,7 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+import jinja2 as jj
 import pytest
 from systemrdl.compiler import RDLCompiler
 
@@ -71,11 +72,22 @@ def do_export(rdl_file: Path) -> Path:
         (crate_dir / "tests").mkdir(exist_ok=True)
         shutil.copyfile(integration_test, crate_dir / "tests" / integration_test.name)
 
-    # copy boilerplate templates
+    # render boilerplate templates
     templates_dir = Path(__file__).parent / "templates"
-    print(f"copied to {crate_dir / 'Cargo.toml'}")
-    shutil.copyfile(templates_dir / "Cargo.toml.tmpl", crate_dir / "Cargo.toml")
-    shutil.copyfile(templates_dir / "lib.rs.tmpl", src_dir / "lib.rs")
+    loader = jj.FileSystemLoader(templates_dir.resolve())
+    jj_env = jj.Environment(
+        loader=loader,
+        undefined=jj.StrictUndefined,
+        trim_blocks=True,
+        lstrip_blocks=True,
+    )
+    context = {
+        "test_name": rdl_file.stem,
+    }
+    with open(crate_dir / "Cargo.toml", "w") as f:
+        jj_env.get_template("Cargo.toml.jinja2").stream(ctx=context).dump(f)  # type: ignore # jinja incorrectly typed
+    with open(src_dir / "lib.rs", "w") as f:
+        jj_env.get_template("lib.rs.jinja2").stream(ctx=context).dump(f)  # type: ignore # jinja incorrectly typed
 
     return crate_dir