feat: convert: Add format_config option

Author: duskmoon314

CHANGELOG-rust.md

@@ -5,6 +5,8 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [Unreleased]
 
+* `convert`: Add `format_config` option
+
 ## [v0.2.4] 2022-05-15
 
 * Added action to build binaries and release for every version tag and latest commit

Cargo.toml

@@ -27,9 +27,9 @@ edition = "2021"
 clap = { version = "3.0", features = ["derive"] }
 serde = { version = "1.0", features = ["derive"] }
 quick-xml = { version = "0.18", features = ["serialize"] }
-svd-rs = { version = "0.13.2", features = ["serde", "derive-from"]  }
-svd-parser = { version = "0.13.4", features = ["expand"] }
-svd-encoder = "0.13.1"
+svd-rs = { version = "0.14.0", features = ["serde", "derive-from"] }
+svd-parser = { version = "0.14.0", features = ["expand"] }
+svd-encoder = "0.14.0"
 yaml-rust = "0.4"
 serde_yaml = "0.8.23"
 serde_json = { version = "1.0", features = ["preserve_order"] }

src/cli.rs

@@ -71,6 +71,14 @@ enum Command {
         /// Skip enumeratedValues and writeConstraints during parsing (XML input only)
         #[clap(long)]
         ignore_enums: bool,
+
+        /// Path to format config file
+        ///
+        /// If not specified, the default format config will be used.
+        ///
+        /// Only used for SVD output format.
+        #[clap(long = "format-config", parse(from_os_str))]
+        format_config: Option<PathBuf>,
     },
 }
 
@@ -94,6 +102,7 @@ impl Command {
                 expand,
                 expand_properties,
                 ignore_enums,
+                format_config,
             } => convert_cli::convert(
                 in_path,
                 out_path,
@@ -102,6 +111,7 @@ impl Command {
                 *expand,
                 *expand_properties,
                 *ignore_enums,
+                format_config.as_ref().map(|p| p.as_path()),
             )?,
         }
         Ok(())

src/convert/convert_cli.rs

@@ -43,6 +43,24 @@ impl FromStr for OutputFormat {
     }
 }
 
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+#[non_exhaustive]
+pub enum ConfigFormat {
+    Yaml,
+    Json,
+}
+
+impl FromStr for ConfigFormat {
+    type Err = anyhow::Error;
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s {
+            "yml" | "yaml" | "YAML" => Ok(Self::Yaml),
+            "json" | "JSON" => Ok(Self::Json),
+            _ => Err(anyhow!("Unknown config file format")),
+        }
+    }
+}
+
 pub fn convert(
     in_path: &Path,
     out_path: &Path,
@@ -51,6 +69,7 @@ pub fn convert(
     expand: bool,
     expand_properties: bool,
     ignore_enums: bool,
+    format_config: Option<&Path>,
 ) -> Result<()> {
     let input_format = match input_format {
         None => match in_path.extension().and_then(|e| e.to_str()) {
@@ -87,8 +106,31 @@ pub fn convert(
         device
     };
 
+    let config = if let Some(format_config) = format_config {
+        let config_format = match format_config.extension().and_then(|e| e.to_str()) {
+            Some(s) => ConfigFormat::from_str(s)?,
+            _ => return Err(anyhow!("Unknown output file format")),
+        };
+        let mut config = String::new();
+        File::open(format_config)?.read_to_string(&mut config)?;
+
+        let config_map: std::collections::HashMap<String, String> = match config_format {
+            ConfigFormat::Yaml => serde_yaml::from_str(&config)?,
+            ConfigFormat::Json => serde_json::from_str(&config)?,
+        };
+
+        let mut config = svd_encoder::Config::default();
+        config_map
+            .iter()
+            .for_each(|(name, value)| config.update(name, value));
+
+        config
+    } else {
+        svd_encoder::Config::default()
+    };
+
     let output = match output_format {
-        OutputFormat::Xml => svd_encoder::encode(&device)?,
+        OutputFormat::Xml => svd_encoder::encode_with_config(&device, &config)?,
         OutputFormat::Yaml => serde_yaml::to_string(&device)?,
         OutputFormat::Json => serde_json::to_string_pretty(&device)?,
     };