Merge pull request #276 from rust-embedded/prefix

prefix & suffix

Author: burrbull

CHANGELOG-rust.md

@@ -5,6 +5,8 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [Unreleased]
 
+* Add `prefix` and `suffix` as opposite to `strip` and `strip_end`
+
 ## [v0.4.3] 2025-01-31
 
 * Allow shorthand when `_derive` across clusters

src/patch/peripheral.rs

@@ -32,6 +32,8 @@ pub(crate) trait PeripheralExt: InterruptExt + RegisterBlockExt {
         "_copy",
         "_strip",
         "_strip_end",
+        "_prefix",
+        "_suffix",
         "_modify",
         "_clear_fields",
         "_add",
@@ -57,6 +59,8 @@ pub(crate) trait ClusterExt: RegisterBlockExt {
         "_copy",
         "_strip",
         "_strip_end",
+        "_prefix",
+        "_suffix",
         "_modify",
         "_clear_fields",
         "_add",
@@ -568,6 +572,34 @@ pub(crate) trait RegisterBlockExt: Name {
         Ok(())
     }
 
+    /// Add prefix at the beginning of register names inside ptag
+    fn add_prefix(&mut self, prefix: &str) -> PatchResult {
+        for rtag in self.regs_mut() {
+            rtag.name.insert_str(0, prefix);
+            if let Some(dname) = rtag.display_name.as_mut() {
+                dname.insert_str(0, prefix);
+            }
+            if let Some(name) = rtag.alternate_register.as_mut() {
+                name.insert_str(0, prefix);
+            }
+        }
+        Ok(())
+    }
+
+    /// Add suffix at the ending of register names inside ptag
+    fn add_suffix(&mut self, suffix: &str) -> PatchResult {
+        for rtag in self.regs_mut() {
+            rtag.name.push_str(suffix);
+            if let Some(dname) = rtag.display_name.as_mut() {
+                dname.push_str(suffix);
+            }
+            if let Some(name) = rtag.alternate_register.as_mut() {
+                name.push_str(suffix);
+            }
+        }
+        Ok(())
+    }
+
     /// Collect same registers in peripheral into register array
     fn collect_in_array(
         &mut self,
@@ -1078,6 +1110,15 @@ impl PeripheralExt for Peripheral {
                 .with_context(|| format!("Stripping suffix `{suffix}` from register names"))?;
         }
 
+        if let Some(prefix) = pmod.get_str("_prefix")? {
+            self.add_prefix(prefix)
+                .with_context(|| format!("Adding prefix `{prefix}` to register names"))?;
+        }
+        if let Some(suffix) = pmod.get_str("_suffix")? {
+            self.add_suffix(suffix)
+                .with_context(|| format!("Adding suffix `{suffix}` to register names"))?;
+        }
+
         // Handle modifications
         for (rspec, rmod) in pmod.hash_iter("_modify") {
             let rmod = rmod.hash()?;
@@ -1386,6 +1427,15 @@ impl ClusterExt for Cluster {
                 .with_context(|| format!("Stripping suffix `{suffix}` from register names"))?;
         }
 
+        if let Some(prefix) = cmod.get_str("_prefix")? {
+            self.add_prefix(prefix)
+                .with_context(|| format!("Adding prefix `{prefix}` to register names"))?;
+        }
+        if let Some(suffix) = cmod.get_str("_suffix")? {
+            self.add_suffix(suffix)
+                .with_context(|| format!("Adding suffix `{suffix}` to register names"))?;
+        }
+
         // Handle modifications
         for (rspec, rmod) in cmod.hash_iter("_modify") {
             let rmod = rmod.hash()?;

src/patch/register.rs

@@ -47,6 +47,8 @@ pub trait RegisterExt {
         "_derive",
         "_strip",
         "_strip_end",
+        "_prefix",
+        "_suffix",
         "_clear",
         "_modify",
         "_add",
@@ -115,6 +117,12 @@ pub trait RegisterExt {
     /// Delete substring from the ending bitfield names inside rtag
     fn strip_end(&mut self, substr: &str) -> PatchResult;
 
+    /// Add prefix at the beginning of bitfield names inside rtag
+    fn add_prefix(&mut self, prefix: &str) -> PatchResult;
+
+    /// Add suffix at the ending of bitfield names inside rtag
+    fn add_suffix(&mut self, suffix: &str) -> PatchResult;
+
     /// Modify fspec inside rtag according to fmod
     fn modify_field(&mut self, fspec: &str, fmod: &Hash, rpath: &RegisterPath) -> PatchResult;
 
@@ -172,6 +180,15 @@ impl RegisterExt for Register {
                 .with_context(|| format!("Stripping suffix `{suffix}` from field names"))?;
         }
 
+        if let Some(prefix) = rmod.get_str("_prefix")? {
+            self.add_prefix(prefix)
+                .with_context(|| format!("Adding prefix `{prefix}` to field names"))?;
+        }
+        if let Some(suffix) = rmod.get_str("_suffix")? {
+            self.add_suffix(suffix)
+                .with_context(|| format!("Adding suffix `{suffix}` to field names"))?;
+        }
+
         // Handle field clearing
         for fspec in rmod.str_vec_iter("_clear")? {
             self.clear_field(fspec)
@@ -288,6 +305,22 @@ impl RegisterExt for Register {
         Ok(())
     }
 
+    /// Add prefix at the beginning of bitfield names inside rtag
+    fn add_prefix(&mut self, prefix: &str) -> PatchResult {
+        for ftag in self.fields_mut() {
+            ftag.name.insert_str(0, prefix);
+        }
+        Ok(())
+    }
+
+    /// Add suffix at the ending of bitfield names inside rtag
+    fn add_suffix(&mut self, suffix: &str) -> PatchResult {
+        for ftag in self.fields_mut() {
+            ftag.name.push_str(suffix);
+        }
+        Ok(())
+    }
+
     fn modify_field(&mut self, fspec: &str, fmod: &Hash, rpath: &RegisterPath) -> PatchResult {
         let (fspec, ignore) = fspec.spec();
         let ftags = self.iter_fields(fspec).collect::<Vec<_>>();