Merge #64

64: Make register description optional as per svd spec r=ryankurte a=Emilgardis

Fixes #59

Co-authored-by: Emil Gardström <[email protected]>
Co-authored-by: Ryan <[email protected]>

Author: 3 people

src/lib.rs

@@ -102,13 +102,23 @@ pub fn run_test<
     tests: &[(T, &str)],
 ) {
     for t in tests {
-        let tree1 = Element::parse(t.1.as_bytes()).unwrap();
-        let elem = T::parse(&tree1).unwrap();
+        let mut tree1 = Element::parse(t.1.as_bytes()).unwrap();
+        let mut elem = T::parse(&tree1).unwrap();
+        // Hack to make assert be order agnostic
+        tree1.children.sort_by(|e1,e2| e1.name.cmp(&e2.name));
+        tree1.children.iter_mut().for_each(|e| { 
+            e.children.sort_by(|e1,e2| e1.name.cmp(&e2.name));
+        });
         assert_eq!(
             elem, t.0,
             "Error parsing xml` (mismatch between parsed and expected)"
         );
-        let tree2 = elem.encode().unwrap();
+        let  mut tree2 = elem.encode().unwrap();
+        // Hack to make assert be order agnostic
+        tree2.children.sort_by(|e1,e2| e1.name.cmp(&e2.name));
+        tree2.children.iter_mut().for_each(|e| { 
+            e.children.sort_by(|e1,e2| e1.name.cmp(&e2.name));
+        });
         assert_eq!(
             tree1, tree2,
             "Error encoding xml (mismatch between encoded and original)"

src/svd/registerinfo.rs

@@ -24,7 +24,7 @@ pub struct RegisterInfo {
     pub alternate_group: Option<String>,
     pub alternate_register: Option<String>,
     pub derived_from: Option<String>,
-    pub description: String,
+    pub description: Option<String>,
     pub address_offset: u32,
     pub size: Option<u32>,
     pub access: Option<Access>,
@@ -59,8 +59,8 @@ impl RegisterInfo {
             name,
             alternate_group: tree.get_child_text_opt("alternateGroup")?,
             alternate_register: tree.get_child_text_opt("alternateRegister")?,
+            description: tree.get_child_text_opt("description")?,
             derived_from: tree.attributes.get("derivedFrom").map(|s| s.to_owned()),
-            description: tree.get_child_text("description")?,
             address_offset: tree.get_child_u32("addressOffset")?,
             size: parse::optional::<u32>("size", tree)?,
             access: parse::optional::<Access>("access", tree)?,
@@ -105,15 +105,22 @@ impl Encode for RegisterInfo {
             attributes: HashMap::new(),
             children: vec![
                 new_element("name", Some(self.name.clone())),
-                new_element("description", Some(self.description.clone())),
                 new_element(
                     "addressOffset",
                     Some(format!("0x{:x}", self.address_offset)),
                 ),
             ],
             text: None,
         };
-
+        match self.description {
+            Some(ref v) => {
+                elem.children.push(new_element(
+                    "description",
+                    Some(v.clone()),
+                ));
+            }
+            None => (),
+        }
         match self.alternate_group {
             Some(ref v) => {
                 elem.children.push(new_element(
@@ -225,7 +232,7 @@ mod tests {
                 alternate_group: Some(String::from("alternate group")),
                 alternate_register: Some(String::from("alternate register")),
                 derived_from: Some(String::from("derived from")),
-                description: String::from("Write Control Register"),
+                description: Some(String::from("Write Control Register")),
                 address_offset: 8,
                 size: Some(32),
                 access: Some(Access::ReadWrite),