Improve Could not find errors

Author: burrbull

CHANGELOG-rust.md

@@ -5,6 +5,8 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [Unreleased]
 
+* Improve "Could not find errors"
+
 ## [v0.3.3] 2023-10-02
 
 * Fast fix for #161

src/patch/device.rs

@@ -387,7 +387,14 @@ impl DeviceExt for Device {
                 .with_context(|| format!("Processing peripheral `{}`", ptag.name))?;
         }
         if pcount == 0 {
-            Err(anyhow!("Could not find `{pspec}`"))
+            Err(anyhow!(
+                "Could not find `{pspec}. Present peripherals: {}.`",
+                self.peripherals
+                    .iter()
+                    .map(|p| p.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ))
         } else {
             Ok(())
         }

src/patch/peripheral.rs

@@ -643,7 +643,13 @@ impl RegisterBlockExt for Peripheral {
                 .with_context(|| format!("Processing register `{}`", rtag.name))?;
         }
         if rcount == 0 {
-            Err(anyhow!("Could not find `{pname}:{rspec}`"))
+            Err(anyhow!(
+                "Could not find `{pname}:{rspec}. Present registers: {}.`",
+                self.registers()
+                    .map(|r| r.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ))
         } else {
             Ok(())
         }
@@ -659,7 +665,13 @@ impl RegisterBlockExt for Peripheral {
                 .with_context(|| format!("Processing cluster `{}`", ctag.name))?;
         }
         if ccount == 0 {
-            Err(anyhow!("Could not find `{pname}:{cspec}`"))
+            Err(anyhow!(
+                "Could not find `{pname}:{cspec}. Present clusters: {}.`",
+                self.clusters()
+                    .map(|c| c.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ))
         } else {
             Ok(())
         }
@@ -1088,7 +1100,14 @@ impl RegisterBlockExt for Cluster {
                 .with_context(|| format!("Processing register `{}`", rtag.name))?;
         }
         if rcount == 0 {
-            Err(anyhow!("Could not find `{pname}:{rspec}`"))
+            Err(anyhow!(
+                "Could not find `{pname}:{}:{rspec}. Present registers: {}.`",
+                self.name,
+                self.registers()
+                    .map(|r| r.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ))
         } else {
             Ok(())
         }
@@ -1104,7 +1123,14 @@ impl RegisterBlockExt for Cluster {
                 .with_context(|| format!("Processing cluster `{}`", ctag.name))?;
         }
         if ccount == 0 {
-            Err(anyhow!("Could not find `{pname}:{cspec}`"))
+            Err(anyhow!(
+                "Could not find `{pname}:{}:{cspec}. Present clusters: {}.`",
+                self.name,
+                self.clusters()
+                    .map(|c| c.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ))
         } else {
             Ok(())
         }

src/patch/register.rs

@@ -321,8 +321,12 @@ impl RegisterExt for Register {
 
         if names.is_empty() {
             return Err(anyhow!(
-                "Could not find any fields to merge {}.{key}",
-                self.name
+                "Could not find any fields to merge {}:{key}. Present fields: {}.`",
+                self.name,
+                self.fields()
+                    .map(|f| f.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
             ));
         }
         let mut bitwidth = 0;
@@ -430,15 +434,19 @@ impl RegisterExt for Register {
         let (new_fields, name) = match (it.next(), it.next()) {
             (None, _) => {
                 return Err(anyhow!(
-                    "Could not find any fields to split {}.{fspec}",
-                    self.name
-                ))
+                    "Could not find any fields to split {}:{fspec}. Present fields: {}.`",
+                    self.name,
+                    self.fields()
+                        .map(|f| f.name.as_str())
+                        .collect::<Vec<_>>()
+                        .join(", ")
+                ));
             }
             (Some(_), Some(_)) => {
                 return Err(anyhow!(
-                    "Only one field can be spitted at time {}.{fspec}",
+                    "Only one field can be splitted at time {}:{fspec}",
                     self.name
-                ))
+                ));
             }
             (Some(first), None) => {
                 let name = if let Some(n) = fsplit.get_str("name")? {
@@ -687,7 +695,14 @@ impl RegisterExt for Register {
                 .map(|f| (f.bit_range.offset, f.name.to_string()))
                 .collect::<Vec<_>>();
             if offsets.is_empty() {
-                return Err(anyhow!("Could not find {pname}:{}.{fspec}", self.name));
+                return Err(anyhow!(
+                    "Could not find field {pname}:{}:{fspec}. Present fields: {}.`",
+                    self.name,
+                    self.fields()
+                        .map(|f| f.name.as_str())
+                        .collect::<Vec<_>>()
+                        .join(", ")
+                ));
             }
             let (min_offset, fname) = offsets.iter().min_by_key(|on| on.0).unwrap();
             let name = make_ev_name(&fname.replace("%s", ""), usage)?;
@@ -727,7 +742,14 @@ impl RegisterExt for Register {
             set_any = true;
         }
         if !set_any {
-            return Err(anyhow!("Could not find {pname}:{}.{fspec}", self.name));
+            return Err(anyhow!(
+                "Could not find field {pname}:{}:{fspec}. Present fields: {}.`",
+                self.name,
+                self.fields()
+                    .map(|f| f.name.as_str())
+                    .collect::<Vec<_>>()
+                    .join(", ")
+            ));
         }
         Ok(())
     }