derive_more

Author: burrbull

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Disable two clippy warnings in `array_proxy.rs`
 - Add comments in docs about `readAction`
 - Add CI to build and release binaries
+- Use `derive_more::{Deref,From}` for register reader & writer
 
 ## [v0.23.1] - 2022-04-29
 

ci/script.sh

@@ -9,7 +9,7 @@ test_svd() {
 
     # NOTE we care about errors in svd2rust, but not about errors / warnings in rustfmt
     pushd $td
-    RUST_BACKTRACE=1 svd2rust $strict $const_generic -i ${1}.svd
+    RUST_BACKTRACE=1 svd2rust $strict $const_generic $derive_more -i ${1}.svd
 
     mv lib.rs src/lib.rs
 
@@ -43,18 +43,22 @@ main() {
         all)
             const_generic="--const_generic"
             strict="--strict"
+            derive_more="--derive_more"
             ;;
         strict)
             const_generic=""
             strict="--strict"
+            derive_more=""
             ;;
         const)
             const_generic="--const_generic"
             strict=""
+            derive_more=""
             ;;
         *)
             const_generic=""
             strict=""
+            derive_more=""
             ;;
     esac
 
@@ -63,6 +67,9 @@ main() {
     echo 'cortex-m = "0.7.4"' >> $td/Cargo.toml
     echo 'cortex-m-rt = "0.7.1"' >> $td/Cargo.toml
     echo 'vcell = "0.1.3"' >> $td/Cargo.toml
+    if [ $derive_more ]; then
+        echo 'derive_more = "0.99"' >> $td/Cargo.toml
+    fi
     echo '[profile.dev]' >> $td/Cargo.toml
     echo 'incremental = false' >> $td/Cargo.toml
 

src/generate/register.rs

@@ -58,58 +58,78 @@ pub fn render(
 
     if can_read {
         let desc = format!("Register `{}` reader", register.name);
+        let derive = if config.derive_more {
+            Some(quote! { #[derive(derive_more::Deref, derive_more::From)] })
+        } else {
+            None
+        };
         mod_items.extend(quote! {
             #[doc = #desc]
+            #derive
             pub struct R(crate::R<#name_uc_spec>);
+        });
 
-            impl core::ops::Deref for R {
-                type Target = crate::R<#name_uc_spec>;
+        if !config.derive_more {
+            mod_items.extend(quote! {
+                impl core::ops::Deref for R {
+                    type Target = crate::R<#name_uc_spec>;
 
-                #[inline(always)]
-                fn deref(&self) -> &Self::Target {
-                    &self.0
+                    #[inline(always)]
+                    fn deref(&self) -> &Self::Target {
+                        &self.0
+                    }
                 }
-            }
 
-            impl From<crate::R<#name_uc_spec>> for R {
-                #[inline(always)]
-                fn from(reader: crate::R<#name_uc_spec>) -> Self {
-                    R(reader)
+                impl From<crate::R<#name_uc_spec>> for R {
+                    #[inline(always)]
+                    fn from(reader: crate::R<#name_uc_spec>) -> Self {
+                        R(reader)
+                    }
                 }
-            }
-        });
+            });
+        }
         methods.push("read");
     }
 
     if can_write {
         let desc = format!("Register `{}` writer", register.name);
+        let derive = if config.derive_more {
+            Some(quote! { #[derive(derive_more::Deref, derive_more::DerefMut, derive_more::From)] })
+        } else {
+            None
+        };
         mod_items.extend(quote! {
             #[doc = #desc]
+            #derive
             pub struct W(crate::W<#name_uc_spec>);
+        });
 
-            impl core::ops::Deref for W {
-                type Target = crate::W<#name_uc_spec>;
+        if !config.derive_more {
+            mod_items.extend(quote! {
+                impl core::ops::Deref for W {
+                    type Target = crate::W<#name_uc_spec>;
 
-                #[inline(always)]
-                fn deref(&self) -> &Self::Target {
-                    &self.0
+                    #[inline(always)]
+                    fn deref(&self) -> &Self::Target {
+                        &self.0
+                    }
                 }
-            }
 
-            impl core::ops::DerefMut for W {
-                #[inline(always)]
-                fn deref_mut(&mut self) -> &mut Self::Target {
-                    &mut self.0
+                impl core::ops::DerefMut for W {
+                    #[inline(always)]
+                    fn deref_mut(&mut self) -> &mut Self::Target {
+                        &mut self.0
+                    }
                 }
-            }
 
-            impl From<crate::W<#name_uc_spec>> for W {
-                #[inline(always)]
-                fn from(writer: crate::W<#name_uc_spec>) -> Self {
-                    W(writer)
+                impl From<crate::W<#name_uc_spec>> for W {
+                    #[inline(always)]
+                    fn from(writer: crate::W<#name_uc_spec>) -> Self {
+                        W(writer)
+                    }
                 }
-            }
-        });
+            });
+        }
         methods.push("write_with_zero");
         if can_reset {
             methods.push("reset");

src/main.rs

@@ -92,6 +92,11 @@ fn run() -> Result<()> {
                 .long("pascal_enum_values")
                 .help("Use PascalCase in stead of UPPER_CASE for enumerated values"),
         )
+        .arg(
+            Arg::with_name("derive_more")
+                .long("derive_more")
+                .help("Use derive_more procedural macros to implement Deref and From"),
+        )
         .arg(
             Arg::with_name("source_type")
                 .long("source_type")
@@ -162,6 +167,8 @@ fn run() -> Result<()> {
     let strict = cfg.bool_flag("strict", Filter::Arg) || cfg.bool_flag("strict", Filter::Conf);
     let pascal_enum_values = cfg.bool_flag("pascal_enum_values", Filter::Arg)
         || cfg.bool_flag("pascal_enum_values", Filter::Conf);
+    let derive_more =
+        cfg.bool_flag("derive_more", Filter::Arg) || cfg.bool_flag("derive_more", Filter::Conf);
 
     let mut source_type = cfg
         .grab()
@@ -185,6 +192,7 @@ fn run() -> Result<()> {
         keep_list,
         strict,
         pascal_enum_values,
+        derive_more,
         output_dir: path.clone(),
         source_type,
     };

src/util.rs

@@ -29,6 +29,7 @@ pub struct Config {
     pub keep_list: bool,
     pub strict: bool,
     pub pascal_enum_values: bool,
+    pub derive_more: bool,
     pub output_dir: PathBuf,
     pub source_type: SourceType,
 }
@@ -45,6 +46,7 @@ impl Default for Config {
             keep_list: false,
             strict: false,
             pascal_enum_values: false,
+            derive_more: false,
             output_dir: PathBuf::from("."),
             source_type: SourceType::default(),
         }