Merge #86

86: rename RegisterClusterArrayInfo -> DimElement r=therealprof a=burrbull

https://www.keil.com/pack/doc/CMSIS/SVD/html/elem_special.html#dimElementGroup_gr

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

Author: bors[bot]

src/svd/cluster.rs

@@ -8,13 +8,13 @@ use crate::elementext::ElementExt;
 #[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::*;
-use crate::svd::{clusterinfo::ClusterInfo, registerclusterarrayinfo::RegisterClusterArrayInfo};
+use crate::svd::{clusterinfo::ClusterInfo, dimelement::DimElement};
 
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum Cluster {
     Single(ClusterInfo),
-    Array(ClusterInfo, RegisterClusterArrayInfo),
+    Array(ClusterInfo, DimElement),
 }
 
 impl Deref for Cluster {
@@ -37,7 +37,7 @@ impl Parse for Cluster {
         let info = ClusterInfo::parse(tree)?;
 
         if tree.get_child("dimIncrement").is_some() {
-            let array_info = RegisterClusterArrayInfo::parse(tree)?;
+            let array_info = DimElement::parse(tree)?;
             if !info.name.contains("%s") {
                 // TODO: replace with real error
                 return Err(SVDError::from(SVDErrorKind::Other(

src/svd/registerclusterarrayinfo.rs renamed to src/svd/dimelement.rs

@@ -12,20 +12,20 @@ use crate::error::SVDError;
 
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
-pub struct RegisterClusterArrayInfo {
+pub struct DimElement {
     pub dim: u32,
     pub dim_increment: u32,
     pub dim_index: Option<Vec<String>>,
     // Reserve the right to add more fields to this struct
     _extensible: (),
 }
 
-impl Parse for RegisterClusterArrayInfo {
-    type Object = RegisterClusterArrayInfo;
+impl Parse for DimElement {
+    type Object = DimElement;
     type Error = SVDError;
 
-    fn parse(tree: &Element) -> Result<RegisterClusterArrayInfo, SVDError> {
-        Ok(RegisterClusterArrayInfo {
+    fn parse(tree: &Element) -> Result<DimElement, SVDError> {
+        Ok(DimElement {
             dim: tree.get_child_u32("dim")?,
             dim_increment: tree.get_child_u32("dimIncrement")?,
             dim_index: parse_optional::<DimIndex>("dimIndex", tree)?,
@@ -35,11 +35,11 @@ impl Parse for RegisterClusterArrayInfo {
 }
 
 #[cfg(feature = "unproven")]
-impl Encode for RegisterClusterArrayInfo {
+impl Encode for DimElement {
     type Error = SVDError;
 
     fn encode(&self) -> Result<Element, SVDError> {
-        let mut e = new_element("registerClusterArrayInfo", None);
+        let mut e = new_element("dimElement", None);
 
         e.children
             .push(new_element("dim", Some(format!("{}", self.dim))));
@@ -65,20 +65,20 @@ mod tests {
     #[test]
     fn decode_encode() {
         let tests = vec![(
-            RegisterClusterArrayInfo {
+            DimElement {
                 dim: 100,
                 dim_increment: 4,
                 dim_index: Some(vec!["10".to_owned(), "20".to_owned()]),
                 _extensible: (),
             },
-            "<registerClusterArrayInfo>
+            "<dimElement>
                 <dim>100</dim>
                 <dimIncrement>4</dimIncrement>
                 <dimIndex>10,20</dimIndex>
-            </registerClusterArrayInfo>
+            </dimElement>
             ",
         )];
 
-        run_test::<RegisterClusterArrayInfo>(&tests[..]);
+        run_test::<DimElement>(&tests[..]);
     }
 }

src/svd/mod.rs

@@ -52,8 +52,8 @@ pub use self::register::Register;
 pub mod registercluster;
 pub use self::registercluster::RegisterCluster;
 
-pub mod registerclusterarrayinfo;
-pub use self::registerclusterarrayinfo::RegisterClusterArrayInfo;
+pub mod dimelement;
+pub use self::dimelement::DimElement;
 
 pub mod peripheral;
 pub use self::peripheral::Peripheral;

src/svd/register.rs

@@ -9,13 +9,13 @@ use crate::elementext::ElementExt;
 #[cfg(feature = "unproven")]
 use crate::encode::Encode;
 use crate::error::SVDError;
-use crate::svd::{registerclusterarrayinfo::RegisterClusterArrayInfo, registerinfo::RegisterInfo};
+use crate::svd::{dimelement::DimElement, registerinfo::RegisterInfo};
 
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum Register {
     Single(RegisterInfo),
-    Array(RegisterInfo, RegisterClusterArrayInfo),
+    Array(RegisterInfo, DimElement),
 }
 
 impl Deref for Register {
@@ -39,7 +39,7 @@ impl Parse for Register {
         let info = RegisterInfo::parse(tree)?;
 
         if tree.get_child("dimIncrement").is_some() {
-            let array_info = RegisterClusterArrayInfo::parse(tree)?;
+            let array_info = DimElement::parse(tree)?;
             assert!(info.name.contains("%s"));
             if let Some(indices) = &array_info.dim_index {
                 assert_eq!(array_info.dim as usize, indices.len())