Merge #128

128: version, release 0.2.7 r=adamgreig a=burrbull



Co-authored-by: Andrey Zgarbul <[email protected]>

Author: bors[bot]

CHANGELOG-rust.md

@@ -5,6 +5,11 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [Unreleased]
 
+## [v0.2.7] 2022-09-18
+
+* Print svdtools version on error, update dependencies
+* Check `_delete`, `_strip`, etc. on array of strings
+
 ## [v0.2.6] 2022-08-21
 
 **Breaking changes**:

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "svdtools"
-version = "0.2.6"
+version = "0.2.7"
 repository = "https://github.com/stm32-rs/svdtools"
 description = "Tool for modifying bugs in CMSIS SVD"
 authors = [
@@ -24,22 +24,23 @@ include = ["/res", "/src", "/tests", "CHANGELOG-rust.md", "README.md", "LICENSE-
 edition = "2021"
 
 [dependencies]
-clap = { version = "3.2", features = ["derive"] }
+clap = { version = "3.2", features = ["derive", "cargo"] }
 serde = { version = "1.0", features = ["derive"] }
-quick-xml = { version = "0.18", features = ["serialize"] }
+quick-xml = { version = "0.25", features = ["serialize"] }
 svd-rs = { version = "0.14.0", features = ["serde", "derive-from"] }
 svd-parser = { version = "0.14.0", features = ["expand"] }
 svd-encoder = "0.14.1"
 yaml-rust = "0.4"
-serde_yaml = "0.8.23"
+# serde_yaml 0.9.x looks broken
+serde_yaml = "0.8.26"
 serde_json = { version = "1.0", features = ["preserve_order"] }
-anyhow = "1.0.43"
-thiserror = "1.0.30"
+anyhow = "1.0.65"
+thiserror = "1.0.35"
 linked-hash-map = "0.5"
 globset = "0.4.8"
 commands = "0.0.5"
 env_logger = "0.9"
 log = { version = "~0.4", features = ["std"] }
 
 [dev-dependencies]
-tempfile = "3.1"
+tempfile = "3.3"

src/cli.rs

@@ -127,10 +127,16 @@ struct CliArgs {
 }
 
 pub fn run() {
+    use anyhow::Context;
+
     env_logger::init();
 
     let args = CliArgs::parse();
-    if let Err(e) = args.command.run() {
+    if let Err(e) = args
+        .command
+        .run()
+        .with_context(|| format!("by svdtools ({})", clap::crate_version!()))
+    {
         log::error!("{:?}", e);
 
         std::process::exit(1);

src/patch/device.rs

@@ -64,7 +64,7 @@ impl DeviceExt for Device {
 
     fn process(&mut self, device: &Hash, update_fields: bool) -> PatchResult {
         // Handle any deletions
-        for pspec in device.str_vec_iter("_delete") {
+        for pspec in device.str_vec_iter("_delete")? {
             self.delete_peripheral(pspec)
                 .with_context(|| format!("Deleting peripheral matched to `{pspec}`"))?;
         }
@@ -120,7 +120,7 @@ impl DeviceExt for Device {
         }
 
         // Handle field clearing
-        for pspec in device.str_vec_iter("_clear_fields") {
+        for pspec in device.str_vec_iter("_clear_fields")? {
             self.clear_fields(pspec).with_context(|| {
                 format!("Clearing contents of fields in peripherals matched to `{pspec}` ")
             })?;

src/patch/peripheral.rs

@@ -98,7 +98,7 @@ impl PeripheralExt for Peripheral {
         // For derived peripherals, only process interrupts
         if self.derived_from.is_some() {
             if let Some(deletions) = pmod.get_hash("_delete").ok().flatten() {
-                for ispec in deletions.str_vec_iter("_interrupts") {
+                for ispec in deletions.str_vec_iter("_interrupts")? {
                     self.delete_interrupt(ispec)
                         .with_context(|| format!("Deleting interrupts matched to `{ispec}`"))?;
                 }
@@ -146,16 +146,27 @@ impl PeripheralExt for Peripheral {
                     }
                 }
                 Yaml::Hash(deletions) => {
-                    for rspec in deletions.str_vec_iter("_registers") {
+                    for rspec in deletions.str_vec_iter("_registers")? {
                         self.delete_register(rspec)
                             .with_context(|| format!("Deleting registers matched to `{rspec}`"))?;
                     }
-                    for ispec in deletions.str_vec_iter("_interrupts") {
+                    for ispec in deletions.str_vec_iter("_interrupts")? {
                         self.delete_interrupt(ispec)
                             .with_context(|| format!("Deleting interrupts matched to `{ispec}`"))?;
                     }
+                    for d in deletions.keys() {
+                        if !matches!(d, Yaml::String(s) if s == "_registers" || s =="_interrupts") {
+                            return Err(anyhow!(
+                                "`_delete` requires string value or array of strings"
+                            ));
+                        }
+                    }
+                }
+                _ => {
+                    return Err(anyhow!(
+                        "`_delete` requires string value or array of strings"
+                    ))
                 }
-                _ => {}
             }
         }
 
@@ -168,11 +179,11 @@ impl PeripheralExt for Peripheral {
         }
 
         // Handle strips
-        for prefix in pmod.str_vec_iter("_strip") {
+        for prefix in pmod.str_vec_iter("_strip")? {
             self.strip_start(prefix)
                 .with_context(|| format!("Stripping prefix `{prefix}` from register names"))?;
         }
-        for suffix in pmod.str_vec_iter("_strip_end") {
+        for suffix in pmod.str_vec_iter("_strip_end")? {
             self.strip_end(suffix)
                 .with_context(|| format!("Stripping suffix `{suffix}` from register names"))?;
         }
@@ -210,7 +221,7 @@ impl PeripheralExt for Peripheral {
         }
 
         // Handle field clearing
-        for rspec in pmod.str_vec_iter("_clear_fields") {
+        for rspec in pmod.str_vec_iter("_clear_fields")? {
             self.clear_fields(rspec).with_context(|| {
                 format!("Clearing contents of fields in registers matched to `{rspec}` ")
             })?;

src/patch/register.rs

@@ -94,23 +94,23 @@ impl RegisterExt for Register {
             return Ok(());
         }
         // Handle deletions
-        for fspec in rmod.str_vec_iter("_delete") {
+        for fspec in rmod.str_vec_iter("_delete")? {
             self.delete_field(fspec)
                 .with_context(|| format!("Deleting fields matched to `{fspec}`"))?;
         }
 
         // Handle strips
-        for prefix in rmod.str_vec_iter("_strip") {
+        for prefix in rmod.str_vec_iter("_strip")? {
             self.strip_start(prefix)
                 .with_context(|| format!("Stripping prefix `{prefix}` from field names"))?;
         }
-        for suffix in rmod.str_vec_iter("_strip_end") {
+        for suffix in rmod.str_vec_iter("_strip_end")? {
             self.strip_end(suffix)
                 .with_context(|| format!("Stripping suffix `{suffix}` from field names"))?;
         }
 
         // Handle field clearing
-        for fspec in rmod.str_vec_iter("_clear") {
+        for fspec in rmod.str_vec_iter("_clear")? {
             self.clear_field(fspec)
                 .with_context(|| format!("Clearing contents of fields matched to `{fspec}`"))?;
         }

src/patch/yaml_ext.rs

@@ -1,5 +1,5 @@
 use super::iterators::OptIter;
-use anyhow::{Context, Result};
+use anyhow::{anyhow, Context, Result};
 use yaml_rust::{yaml::Hash, Yaml};
 
 /// Errors that can occur during building.
@@ -164,7 +164,7 @@ pub trait GetVal {
     fn get_hash(&self, k: &str) -> Result<Option<&Hash>>;
     fn hash_iter<'a>(&'a self, k: &str) -> HashIter<'a>;
     fn get_vec(&self, k: &str) -> Result<Option<&Vec<Yaml>>>;
-    fn str_vec_iter<'a>(&'a self, k: &str) -> OptIter<OverStringIter<'a>>;
+    fn str_vec_iter<'a>(&'a self, k: &str) -> Result<OptIter<OverStringIter<'a>>>;
 }
 
 impl GetVal for Hash {
@@ -220,7 +220,13 @@ impl GetVal for Hash {
                 .map(Some),
         }
     }
-    fn str_vec_iter<'a>(&'a self, k: &str) -> OptIter<OverStringIter<'a>> {
-        OptIter::new(self.get(&k.to_yaml()).map(|y| OverStringIter(y, None)))
+    fn str_vec_iter<'a>(&'a self, k: &str) -> Result<OptIter<OverStringIter<'a>>> {
+        Ok(OptIter::new(match self.get(&k.to_yaml()) {
+            None => None,
+            Some(y) if matches!(y, Yaml::String(_) | Yaml::Array(_)) => {
+                Some(OverStringIter(y, None))
+            }
+            _ => return Err(anyhow!("`{k}` requires string value or array of strings")),
+        }))
     }
 }