Merge #195

195: encode dimIndex ranges r=adamgreig a=burrbull

cc `@adamgreig` 
Partially related to stm32-rs/stm32-rs#701 (comment)

Co-authored-by: Andrey Zgarbul <[email protected]>

Author: bors[bot]

svd-encoder/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+- Encode "dimIndex" ranges
+
 ## [v0.13.0] - 2022-01-02
 
 - Bump `svd-rs`

svd-encoder/src/dimelement.rs

@@ -13,7 +13,12 @@ impl Encode for crate::svd::DimElement {
         ));
 
         if let Some(di) = &self.dim_index {
-            e.children.push(new_node("dimIndex", di.join(",")));
+            e.children
+                .push(if let Some(range) = self.indexes_as_range() {
+                    new_node("dimIndex", format!("{}-{}", range.start(), range.end()))
+                } else {
+                    new_node("dimIndex", di.join(","))
+                });
         }
 
         if let Some(dim_name) = &self.dim_name {

svd-rs/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+- add `indexes_as_range` for `DimElement`
+
 ## [v0.13.0] - 2022-01-04
 
 - fixed `BitRange` deserializing

svd-rs/src/dimelement.rs

@@ -1,5 +1,6 @@
 use super::{BuildError, EmptyToNone, EnumeratedValue, SvdError, ValidateLevel};
 use std::borrow::Cow;
+use std::ops::RangeInclusive;
 
 /// Defines arrays and lists.
 #[cfg_attr(
@@ -136,6 +137,24 @@ impl DimElement {
     pub fn builder() -> DimElementBuilder {
         DimElementBuilder::default()
     }
+    /// Try to represent [`DimElement`] as range of integer indexes
+    pub fn indexes_as_range(&self) -> Option<RangeInclusive<u32>> {
+        let mut integers = Vec::with_capacity(self.dim as usize);
+        for idx in self.indexes() {
+            integers.push(idx.parse::<u32>().ok()?);
+        }
+        let min = *integers.iter().min()?;
+        let max = *integers.iter().max()?;
+        if max - min + 1 != self.dim {
+            return None;
+        }
+        for (&i, r) in integers.iter().zip(min..=max) {
+            if i != r {
+                return None;
+            }
+        }
+        Some(min..=max)
+    }
     /// Modify an existing [`DimElement`] based on a [builder](DimElementBuilder).
     pub fn modify_from(
         &mut self,

tests/src/dimelement.rs

@@ -5,18 +5,76 @@ use crate::svd::{DimElement, ValidateLevel};
 fn decode_encode() {
     let tests = vec![(
         DimElement::builder()
-            .dim(100)
+            .dim(2)
             .dim_increment(4)
             .dim_index(Some(vec!["10".to_string(), "20".to_string()]))
             .build(ValidateLevel::Strict)
             .unwrap(),
         "<dimElement>
-            <dim>100</dim>
+            <dim>2</dim>
             <dimIncrement>0x4</dimIncrement>
             <dimIndex>10,20</dimIndex>
         </dimElement>
         ",
     )];
+    run_test::<DimElement>(&tests[..]);
 
+    let tests = vec![(
+        DimElement::builder()
+            .dim(3)
+            .dim_increment(4)
+            .dim_index(Some(vec![
+                "3".to_string(),
+                "4".to_string(),
+                "5".to_string(),
+            ]))
+            .build(ValidateLevel::Strict)
+            .unwrap(),
+        "<dimElement>
+            <dim>3</dim>
+            <dimIncrement>0x4</dimIncrement>
+            <dimIndex>3-5</dimIndex>
+        </dimElement>
+        ",
+    )];
+    run_test::<DimElement>(&tests[..]);
+
+    let tests = vec![(
+        DimElement::builder()
+            .dim(3)
+            .dim_increment(4)
+            .dim_index(Some(vec![
+                "3".to_string(),
+                "5".to_string(),
+                "4".to_string(),
+            ]))
+            .build(ValidateLevel::Strict)
+            .unwrap(),
+        "<dimElement>
+            <dim>3</dim>
+            <dimIncrement>0x4</dimIncrement>
+            <dimIndex>3,5,4</dimIndex>
+        </dimElement>
+        ",
+    )];
+    run_test::<DimElement>(&tests[..]);
+
+    let tests = vec![(
+        DimElement::builder()
+            .dim(1)
+            .dim_increment(0)
+            .dim_index(Some(vec!["3".to_string()]))
+            .build(ValidateLevel::Strict)
+            .unwrap(),
+        "<dimElement>
+            <dim>1</dim>
+            <dimIncrement>0x0</dimIncrement>
+            <dimIndex>3-3</dimIndex>
+        </dimElement>
+        ",
+    )];
     run_test::<DimElement>(&tests[..]);
 }
+
+#[test]
+fn decode_encode_one_element() {}