Merge #83

83: missing derived_from r=Disasm a=burrbull

Parsing part of #81 

cc @Disasm 

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

Author: bors[bot]

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - [breaking-change] `Defaults` field renamed on `RegisterProperties`
   and added into `Peripheral` and `ClusterInfo`
+- Added `derived_from` into `Field` and `ClusterInfo`
 - Updated dependencies, use `Edition 2018`
 - Added missing `zeroToToggle`
 - Added serializing/deserializing with `serde`

src/svd/clusterinfo.rs

@@ -18,6 +18,7 @@ use crate::svd::{
 #[derive(Clone, Debug, PartialEq)]
 pub struct ClusterInfo {
     pub name: String,
+    pub derived_from: Option<String>,
     pub description: String,
     pub header_struct_name: Option<String>,
     pub address_offset: u32,
@@ -34,6 +35,7 @@ impl Parse for ClusterInfo {
     fn parse(tree: &Element) -> Result<ClusterInfo, SVDError> {
         Ok(ClusterInfo {
             name: tree.get_child_text("name")?, // TODO: Handle naming of cluster
+            derived_from: tree.attributes.get("derivedFrom").map(|s| s.to_owned()),
             description: tree.get_child_text("description")?,
             header_struct_name: tree.get_child_text_opt("headerStructName")?,
             address_offset: tree.get_child_u32("addressOffset")?,
@@ -57,6 +59,10 @@ impl Encode for ClusterInfo {
     fn encode(&self) -> Result<Element, SVDError> {
         let mut e = new_element("cluster", None);
 
+        if let Some(v) = &self.derived_from {
+            e.attributes.insert(String::from("derivedFrom"), format!("{}", v));
+        }
+
         e.children.push(new_element(
             "description",
             Some(self.description.clone()),

src/svd/enumeratedvalues.rs

@@ -38,9 +38,7 @@ impl Parse for EnumeratedValues {
         Ok(EnumeratedValues {
             name: tree.get_child_text_opt("name")?,
             usage: parse::optional::<Usage>("usage", tree)?,
-            derived_from: tree.attributes
-                .get(&"derivedFrom".to_owned())
-                .map(|s| s.to_owned()),
+            derived_from: tree.attributes.get("derivedFrom").map(|s| s.to_owned()),
             values: {
                 let values: Result<Vec<_>, _> = tree.children
                     .iter()

src/svd/field.rs

@@ -25,6 +25,7 @@ use crate::svd::{
 #[derive(Clone, Debug, PartialEq)]
 pub struct Field {
     pub name: String,
+    pub derived_from: Option<String>,
     pub description: Option<String>,
     pub bit_range: BitRange,
     pub access: Option<Access>,
@@ -59,6 +60,7 @@ impl Field {
     fn _parse(tree: &Element, name: String) -> Result<Field, SVDError> {
         Ok(Field {
             name,
+            derived_from: tree.attributes.get("derivedFrom").map(|s| s.to_owned()),
             description: tree.get_child_text_opt("description")?,
             bit_range: BitRange::parse(tree)?,
             access: parse::optional::<Access>("access", tree)?,
@@ -103,6 +105,10 @@ impl Encode for Field {
             text: None,
         };
 
+        if let Some(v) = &self.derived_from {
+            elem.attributes.insert(String::from("derivedFrom"), format!("{}", v));
+        }
+
         // Add bit range
         elem.children
             .append(&mut self.bit_range.encode()?);
@@ -146,6 +152,7 @@ mod tests {
             (
                 Field {
                     name: String::from("MODE"),
+                    derived_from: None,
                     description: Some(String::from("Read Mode")),
                     bit_range: BitRange {
                         offset: 24,
@@ -193,49 +200,27 @@ mod tests {
             </field>
             ",
             ),
-            // almost the same test but description info is missing
             (
                 Field {
                     name: String::from("MODE"),
+                    derived_from: Some(String::from("other field")),
                     description: None,
                     bit_range: BitRange {
                         offset: 24,
                         width: 2,
                         range_type: BitRangeType::OffsetWidth,
                     },
-                    access: Some(Access::ReadWrite),
-                    enumerated_values: vec![EnumeratedValues {
-                        name: None,
-                        usage: None,
-                        derived_from: None,
-                        values: vec![EnumeratedValue {
-                            name: String::from("WS0"),
-                            description: Some(String::from(
-                                "Zero wait-states inserted in fetch or read transfers",
-                            )),
-                            value: Some(0),
-                            is_default: None,
-                            _extensible: (),
-                        }],
-                        _extensible: (),
-                    }],
+                    access: None,
+                    enumerated_values: vec![],
                     write_constraint: None,
                     modified_write_values: None,
                     _extensible: (),
                 },
                 "
-            <field>
+            <field derivedFrom=\"other field\">
               <name>MODE</name>
               <bitOffset>24</bitOffset>
               <bitWidth>2</bitWidth>
-              <access>read-write</access>
-              <enumeratedValues>
-                <enumeratedValue>
-                  <name>WS0</name>
-                  <description>Zero wait-states inserted in fetch or read transfers</description>
-                  <value>0x00000000</value>
-                </enumeratedValue>
-              </enumeratedValues>
             </field>
             ",
             ),

src/svd/registerinfo.rs

@@ -220,6 +220,7 @@ mod tests {
                 reset_mask: Some(0x00000023),
                 fields: Some(vec![Field {
                     name: String::from("WREN"),
+                    derived_from: None,
                     description: Some(String::from(
                         "Enable Write/Erase Controller",
                     )),