Merge #81

81: DerivedFrom trait r=therealprof a=burrbull



Co-authored-by: Andrey Zgarbul <zgarbul.andrey@gmail.com>

Author: bors[bot]

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [breaking-change] `Field` splitted on `Field` enum and `FieldInfo` struct
   to support field arrays
 - Added `derived_from` into `Field` and `ClusterInfo`
+- [breaking-change] implement `DeriveFrom` for `ClusterInfo`,
+  `RegisterInfo` and `EnumeratedValues`
 - Updated dependencies, use `Edition 2018`
 - Added missing `zeroToToggle`
 - Added serializing/deserializing with `serde`

Cargo.toml

@@ -10,6 +10,7 @@ edition = "2018"
 version = "0.7.0"
 
 [features]
+derive-from = []
 unproven = []
 
 [dependencies]

src/derive_from.rs

@@ -0,0 +1,78 @@
+use crate::{ClusterInfo, EnumeratedValues, Peripheral, RegisterInfo, RegisterProperties};
+
+/// Fill empty fields of structure with values of other structure
+pub trait DeriveFrom {
+    /// Derive contents
+    fn derive_from(&self, other: &Self) -> Self;
+}
+
+impl DeriveFrom for ClusterInfo {
+    fn derive_from(&self, other: &Self) -> Self {
+        let mut derived = self.clone();
+        derived.default_register_properties = derived
+            .default_register_properties
+            .derive_from(&other.default_register_properties);
+        derived.header_struct_name = derived
+            .header_struct_name
+            .or(other.header_struct_name.clone());
+        if derived.children.is_empty() {
+            derived.children = other.children.clone();
+        }
+        derived
+    }
+}
+
+impl DeriveFrom for EnumeratedValues {
+    fn derive_from(&self, other: &Self) -> Self {
+        let mut derived = self.clone();
+        derived.usage = derived.usage.or(other.usage.clone());
+        if derived.values.is_empty() {
+            derived.values = other.values.clone();
+        }
+        derived
+    }
+}
+
+impl DeriveFrom for Peripheral {
+    fn derive_from(&self, other: &Self) -> Self {
+        let mut derived = self.clone();
+        derived.group_name = derived.group_name.or(other.group_name.clone());
+        derived.description = derived.description.or(other.description.clone());
+        derived.default_register_properties = derived
+            .default_register_properties
+            .derive_from(&other.default_register_properties);
+        derived.registers = derived.registers.or(other.registers.clone());
+        if derived.interrupt.is_empty() {
+            derived.interrupt = other.interrupt.clone();
+        }
+        derived
+    }
+}
+
+impl DeriveFrom for RegisterInfo {
+    fn derive_from(&self, other: &RegisterInfo) -> RegisterInfo {
+        let mut derived = self.clone();
+        derived.description = derived.description.or(other.description.clone());
+        derived.size = derived.size.or(other.size);
+        derived.access = derived.access.or(other.access);
+        derived.reset_value = derived.reset_value.or(other.reset_value);
+        derived.reset_mask = derived.reset_mask.or(other.reset_mask);
+        derived.fields = derived.fields.or(other.fields.clone());
+        derived.write_constraint = derived.write_constraint.or(other.write_constraint);
+        derived.modified_write_values = derived
+            .modified_write_values
+            .or(other.modified_write_values);
+        derived
+    }
+}
+
+impl DeriveFrom for RegisterProperties {
+    fn derive_from(&self, other: &Self) -> Self {
+        let mut derived = self.clone();
+        derived.size = derived.size.or(other.size);
+        derived.reset_value = derived.reset_value.or(other.reset_value);
+        derived.reset_mask = derived.reset_mask.or(other.reset_mask);
+        derived.access = derived.access.or(other.access);
+        derived
+    }
+}

src/lib.rs

@@ -48,6 +48,11 @@ use encode::Encode;
 // Types defines simple types and parse/encode implementations
 pub mod types;
 
+#[cfg(feature = "derive-from")]
+mod derive_from;
+#[cfg(feature = "derive-from")]
+pub use derive_from::DeriveFrom;
+
 /// Parses the contents of an SVD (XML) string
 pub fn parse(xml: &str) -> Result<Device, SVDError> {
     let xml = trim_utf8_bom(xml);

src/svd/peripheral.rs

@@ -56,20 +56,6 @@ impl Parse for Peripheral {
 }
 
 impl Peripheral {
-    pub fn derive_from(&self, other: &Peripheral) -> Peripheral {
-        let mut derived = self.clone();
-        derived.group_name = derived.group_name.or_else(|| other.group_name.clone());
-        derived.description = derived.description.or_else(|| other.description.clone());
-        derived.default_register_properties = derived
-            .default_register_properties
-            .derive_from(&other.default_register_properties);
-        derived.registers = derived.registers.or_else(|| other.registers.clone());
-        if derived.interrupt.is_empty() {
-            derived.interrupt = other.interrupt.clone();
-        }
-        derived
-    }
-
     fn _parse(tree: &Element, name: String) -> Result<Peripheral, SVDError> {
         Ok(Peripheral {
             name,

src/svd/registerproperties.rs

@@ -24,16 +24,6 @@ pub struct RegisterProperties {
     _extensible: (),
 }
 
-impl RegisterProperties {
-    pub fn derive_from(mut self, other: &Self) -> Self {
-        self.size = self.size.or(other.size);
-        self.reset_value = self.reset_value.or(other.reset_value);
-        self.reset_mask = self.reset_mask.or(other.reset_mask);
-        self.access = self.access.or(other.access);
-        self
-    }
-}
-
 impl Parse for RegisterProperties {
     type Object = RegisterProperties;
     type Error = SVDError;