Merge pull request #178 from rust-embedded/desc

collect in cluster/array descriptions

CHANGELOG-rust.md

@@ -7,6 +7,7 @@ This changelog tracks the Rust `svdtools` project. See
 
 * Move field with derived enums before other
 * `-1` for default enum value
+* Update `displayName` during collect, improve searching common `description`
 * mmaps: peripheral arrays, bump `svd` crates
 
 ## [v0.3.4] 2023-10-14

example/common_patches/tsc/tsc.yaml

@@ -4,5 +4,8 @@ TSC:
   IOHCR:
     _array:
       G1_IO?: {}
+    G1_IO*:
+      Disabled: [0, "Gx_IOy Schmitt trigger hysteresis disabled"]
+      Enabled: [1, "Gx_IOy Schmitt trigger hysteresis enabled"]
     G2_IO*:
       _derivedFrom: "G1_IO1"

example/incomplete-stm32l4x2.yaml

@@ -1,5 +1,10 @@
 _svd: stm32l4x2.svd
 
+LCD:
+  RAM_COM6:
+    _array:
+      S?? : {}
+
 # SVD incorrectly labels APB1ENR1 bit 18 as USART1EN instead of USART3EN.
 # SVD incorrectly labels APB1ENR1 bit 26 as USBF instead of USBFSEN.
 RCC:

src/html/html_cli.rs

@@ -245,7 +245,7 @@ fn parse_register(
         filling |= bit_mask;
 
         let faccs = ftag.access.map(Access::as_str).unwrap_or(raccs);
-        let enums = ftag.enumerated_values.get(0);
+        let enums = ftag.enumerated_values.first();
         let wc = &ftag.write_constraint;
         let mut fdoc = None;
         if enums.is_some() || wc.is_some() || faccs == "read-only" {

src/patch/mod.rs

@@ -337,7 +337,7 @@ fn make_dim_element(h: &Hash) -> Result<Option<DimElementBuilder>> {
                     }
                     Some(v)
                 }
-                _ => return Err(DimIndexParse).map_err(Into::into),
+                _ => return Err(DimIndexParse.into()),
             }
         } else {
             None
@@ -637,3 +637,42 @@ fn check_offsets(offsets: &[u32], dim_increment: u32) -> bool {
     }
     true
 }
+
+/// Tries to get common description (or displayNames) for register/field array with "%s" in index position.
+/// Returns `None` if incoming descriptions have more then 1 difference
+fn common_description(descs: &[Option<&str>], dim_index: &[String]) -> Option<Option<String>> {
+    if let Some(desc0) = descs[0] {
+        let idx0 = &dim_index[0];
+        if desc0.contains(idx0) {
+            for (i1, _) in desc0.match_indices(idx0) {
+                let (s1, sx) = desc0.split_at(i1);
+                let (_, s2) = sx.split_at(idx0.len());
+                let dsc = Some(format!("{s1}%s{s2}"));
+                let mut same = true;
+                for (d, idx) in descs.iter().zip(dim_index).skip(1) {
+                    if d != &dsc
+                        .as_ref()
+                        .map(|dsc| dsc.replacen("%s", idx, 1))
+                        .as_deref()
+                    {
+                        same = false;
+                        break;
+                    }
+                }
+                if same {
+                    return Some(dsc);
+                }
+            }
+        }
+    }
+    // If descriptions are identical, do not change.
+    let desc0 = &descs[0];
+    let mut same = true;
+    for d in &descs[1..] {
+        if d != desc0 {
+            same = false;
+            break;
+        }
+    }
+    same.then(|| desc0.map(Into::into))
+}

src/patch/peripheral.rs

@@ -10,8 +10,8 @@ use super::iterators::{MatchIter, Matched};
 use super::register::{RegisterExt, RegisterInfoExt};
 use super::yaml_ext::{AsType, GetVal, ToYaml};
 use super::{
-    check_offsets, make_dim_element, matchname, matchsubspec, modify_dim_element, spec_ind,
-    PatchResult, VAL_LVL,
+    check_offsets, common_description, make_dim_element, matchname, matchsubspec,
+    modify_dim_element, spec_ind, PatchResult, VAL_LVL,
 };
 use super::{make_cluster, make_interrupt, make_register};
 
@@ -1207,21 +1207,43 @@ fn collect_in_array(
             path
         ));
     }
-    let mut rinfo = registers.swap_remove(0);
-    rinfo.name = if let Some(name) = rmod.get_str("name")? {
+
+    registers[0].name = if let Some(name) = rmod.get_str("name")? {
         name.into()
     } else {
         format!("{}%s{}", &rspec[..li], &rspec[rspec.len() - ri..])
     };
+
     if let Some(desc) = rmod.get_str("description")? {
         if desc != "_original" {
-            rinfo.description = Some(desc.into());
+            registers[0].description = Some(desc.into());
         }
-    } else if dim_index[0] == "0" {
-        if let Some(desc) = rinfo.description.as_mut() {
-            *desc = desc.replace('0', "%s");
+    } else {
+        let descs: Vec<_> = registers.iter().map(|r| r.description.as_deref()).collect();
+        registers[0].description = common_description(&descs, &dim_index).ok_or_else(|| {
+            anyhow!(
+                "{}: registers cannot be collected into {rspec} array. Please, specify description",
+                path
+            )
+        })?;
+    }
+    if let Some(dname) = rmod.get_str("displayName")? {
+        if dname != "_original" {
+            registers[0].display_name = Some(dname.into());
         }
+    } else {
+        let names: Vec<_> = registers
+            .iter()
+            .map(|r| r.display_name.as_deref())
+            .collect();
+        registers[0].display_name = common_description(&names, &dim_index).ok_or_else(|| {
+            anyhow!(
+                "{}: registers cannot be collected into {rspec} array. Please, specify displayName",
+                path
+            )
+        })?;
     }
+    let rinfo = registers.swap_remove(0);
     let mut reg = rinfo.array(
         DimElement::builder()
             .dim(dim as u32)

src/patch/register.rs

@@ -9,7 +9,8 @@ use yaml_rust::{yaml::Hash, Yaml};
 use super::iterators::{MatchIter, Matched};
 use super::yaml_ext::{AsType, GetVal, ToYaml};
 use super::{
-    check_offsets, make_dim_element, matchname, modify_dim_element, spec_ind, PatchResult, VAL_LVL,
+    check_offsets, common_description, make_dim_element, matchname, modify_dim_element, spec_ind,
+    PatchResult, VAL_LVL,
 };
 use super::{make_derived_enumerated_values, make_ev_array, make_ev_name, make_field};
 
@@ -404,21 +405,27 @@ impl RegisterExt for Register {
                     self.name
                 ));
             }
-            let mut finfo = fields.swap_remove(0);
-            if let Some(name) = fmod.get_str("name")? {
-                finfo.name = name.into();
+            fields[0].name = if let Some(name) = fmod.get_str("name")? {
+                name.into()
             } else {
-                finfo.name = format!("{}%s{}", &fspec[..li], &fspec[fspec.len() - ri..]);
-            }
+                format!("{}%s{}", &fspec[..li], &fspec[fspec.len() - ri..])
+            };
             if let Some(desc) = fmod.get_str("description")? {
                 if desc != "_original" {
-                    finfo.description = Some(desc.into());
+                    fields[0].description = Some(desc.into());
                 }
-            } else if dim_index[0] == "0" {
-                if let Some(desc) = finfo.description.as_mut() {
-                    *desc = desc.replace('0', "%s");
+            } else {
+                let descs: Vec<_> = fields.iter().map(|r| r.description.as_deref()).collect();
+                if let Some(desc) = common_description(&descs, &dim_index) {
+                    fields[0].description = desc;
+                } else {
+                    return Err(anyhow!(
+                        "{}: fields cannot be collected into {fspec} array. Please, specify description",
+                        self.name
+                    ));
                 }
             }
+            let finfo = fields.swap_remove(0);
             let field = finfo.array(
                 DimElement::builder()
                     .dim(dim as u32)