Merge pull request #183 from rust-embedded/config

show patch on error

Author: burrbull

CHANGELOG-rust.md

@@ -9,6 +9,7 @@ This changelog tracks the Rust `svdtools` project. See
 * `-1` for default enum value
 * Update `displayName` during collect, improve searching common `description`
 * mmaps: peripheral arrays, bump `svd` crates
+* patch: `--show-patch-on-error` prints yaml patches on error
 
 ## [v0.3.4] 2023-10-14
 

src/cli.rs

@@ -23,6 +23,10 @@ enum Command {
         /// If not specified, the default format config will be used.
         #[clap(long)]
         format_config: Option<PathBuf>,
+
+        /// When a patch error happens print formatted yaml with all rules included
+        #[clap(long)]
+        show_patch_on_error: bool,
     },
     /// Generate Make dependency file listing dependencies for a YAML file.
     Makedeps {
@@ -112,8 +116,16 @@ impl Command {
                 yaml_file,
                 out_path,
                 format_config,
+                show_patch_on_error,
             } => {
-                patch_cli::patch(yaml_file, out_path.as_deref(), format_config.as_deref())?;
+                let mut config = svdtools::patch::Config::default();
+                config.show_patch_on_error = *show_patch_on_error;
+                patch_cli::patch(
+                    yaml_file,
+                    out_path.as_deref(),
+                    format_config.as_deref(),
+                    &config,
+                )?
             }
             Self::Makedeps {
                 yaml_file,

src/patch/mod.rs

@@ -30,10 +30,17 @@ use crate::get_encoder_config;
 
 const VAL_LVL: ValidateLevel = ValidateLevel::Weak;
 
+#[non_exhaustive]
+#[derive(Clone, Debug, Default)]
+pub struct Config {
+    pub show_patch_on_error: bool,
+}
+
 pub fn process_file(
     yaml_file: &Path,
     out_path: Option<&Path>,
     format_config: Option<&Path>,
+    config: &Config,
 ) -> Result<()> {
     // Load the specified YAML root file
     let f = File::open(yaml_file)?;
@@ -61,16 +68,25 @@ pub fn process_file(
     let f = File::open(svdpath)?;
     let mut contents = String::new();
     (&f).read_to_string(&mut contents)?;
-    let mut config = svd_parser::Config::default();
-    config.validate_level = ValidateLevel::Disabled;
-    let mut svd = svd_parser::parse_with_config(&contents, &config)?;
+    let mut parser_config = svd_parser::Config::default();
+    parser_config.validate_level = ValidateLevel::Disabled;
+    let mut svd = svd_parser::parse_with_config(&contents, &parser_config)?;
 
     // Load all included YAML files
     yaml_includes(root)?;
 
     // Process device
-    svd.process(root, true)
-        .with_context(|| format!("Processing device `{}`", svd.name))?;
+    svd.process(root, true).with_context(|| {
+        let name = &svd.name;
+        let mut out_str = String::new();
+        let mut emitter = yaml_rust::YamlEmitter::new(&mut out_str);
+        emitter.dump(&Yaml::Hash(root.clone())).unwrap();
+        if config.show_patch_on_error {
+            format!("Processing device `{name}`. Patches looks like:\n{out_str}")
+        } else {
+            format!("Processing device `{name}`")
+        }
+    })?;
 
     // SVD should now be updated, write it out
     let config = get_encoder_config(format_config)?;

src/patch/patch_cli.rs

@@ -1,11 +1,13 @@
+use super::Config;
 use anyhow::Result;
 use std::path::Path;
 
 pub fn patch(
     yaml_file: &Path,
     out_path: Option<&Path>,
     format_config: Option<&Path>,
+    config: &Config,
 ) -> Result<()> {
-    super::process_file(yaml_file, out_path, format_config)?;
+    super::process_file(yaml_file, out_path, format_config, config)?;
     Ok(())
 }

tests/example1.rs

@@ -7,7 +7,13 @@ fn example1() {
     let expected_svd_path = test_dir.join("expected.svd");
     let expected_svd = svd_reader::device(&expected_svd_path).unwrap();
 
-    patch::patch_cli::patch(&test_dir.join("patch.yaml"), None, None).unwrap();
+    patch::patch_cli::patch(
+        &test_dir.join("patch.yaml"),
+        None,
+        None,
+        &Default::default(),
+    )
+    .unwrap();
     let actual_svd_path = test_dir.join("stm32l4x2.svd.patched");
 
     let actual_svd = svd_reader::device(&actual_svd_path).unwrap();