Merge pull request #775 from rust-embedded/array_iter

iterate over arrays

Author: burrbull

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+- Add iterators for register/cluster/field arrays
+
 ## [v0.31.1] - 2023-11-27
 
 - Fix cluster arrays

ci/script.sh

@@ -580,7 +580,7 @@ main() {
             test_patched_stm32 stm32f7x3
             test_patched_stm32 stm32g070
             test_patched_stm32 stm32g473
-            test_patched_stm32 stm32h743
+            test_patched_stm32 stm32h753
             test_patched_stm32 stm32l0x3
             test_patched_stm32 stm32l162
             test_patched_stm32 stm32l4x6

src/generate/peripheral/accessor.rs

@@ -1,4 +1,4 @@
-use proc_macro2::{Ident, TokenStream};
+use proc_macro2::{Ident, Span, TokenStream};
 use quote::{quote, ToTokens};
 
 #[derive(Clone, Debug)]
@@ -138,12 +138,19 @@ pub struct ArrayAccessor {
 impl ToTokens for ArrayAccessor {
     fn to_tokens(&self, tokens: &mut TokenStream) {
         let Self { doc, name, ty, .. } = self;
+        let name_iter = Ident::new(&format!("{name}_iter"), Span::call_site());
         quote! {
             #[doc = #doc]
             #[inline(always)]
             pub const fn #name(&self, n: usize) -> &#ty {
                 &self.#name[n]
             }
+            #[doc = "Iterator for array of:"]
+            #[doc = #doc]
+            #[inline(always)]
+            pub fn #name_iter(&self) -> impl Iterator<Item=&#ty> {
+                self.#name.iter()
+            }
         }
         .to_tokens(tokens);
     }
@@ -169,13 +176,21 @@ impl ToTokens for RawArrayAccessor {
             dim,
             increment,
         } = self;
+        let name_iter = Ident::new(&format!("{name}_iter"), Span::call_site());
+        let cast = quote! { unsafe { &*(self as *const Self).cast::<u8>().add(#offset).add(#increment * n).cast() } };
         quote! {
             #[doc = #doc]
             #[inline(always)]
             pub const fn #name(&self, n: usize) -> &#ty {
                 #[allow(clippy::no_effect)]
                 [(); #dim][n];
-                unsafe { &*(self as *const Self).cast::<u8>().add(#offset).add(#increment * n).cast() }
+                #cast
+            }
+            #[doc = "Iterator for array of:"]
+            #[doc = #doc]
+            #[inline(always)]
+            pub fn #name_iter(&self) -> impl Iterator<Item=&#ty> {
+                (0..#dim).map(|n| #cast)
             }
         }
         .to_tokens(tokens);

src/generate/register.rs

@@ -613,10 +613,10 @@ pub fn fields(
 
         let brief_suffix = if let Field::Array(_, de) = &f {
             if let Some(range) = de.indexes_as_range() {
-                format!("[{}-{}]", *range.start(), *range.end())
+                format!("({}-{})", *range.start(), *range.end())
             } else {
                 let suffixes: Vec<_> = de.indexes().collect();
-                format!("[{}]", suffixes.join(","))
+                format!("({})", suffixes.join(","))
             }
         } else {
             String::new()
@@ -905,19 +905,27 @@ pub fn fields(
                 let increment = de.dim_increment;
                 let doc = util::replace_suffix(&description, &brief_suffix);
                 let first_name = svd::array::names(f, de).next().unwrap();
-                let array_doc =
-                    format!("{doc}\n\nNOTE: `n` is number of field in register. `n == 0` corresponds to `{first_name}` field");
+                let note = format!("NOTE: `n` is number of field in register. `n == 0` corresponds to `{first_name}` field");
                 let offset_calc = calculate_offset(increment, offset, true);
                 let value = quote! { ((self.bits >> #offset_calc) & #hexmask) #cast };
                 let dim = unsuffixed(de.dim);
+                let name_snake_case_iter = Ident::new(&format!("{name_snake_case}_iter"), span);
                 r_impl_items.extend(quote! {
-                    #[doc = #array_doc]
+                    #[doc = #doc]
+                    #[doc = ""]
+                    #[doc = #note]
                     #inline
                     pub fn #name_snake_case(&self, n: u8) -> #reader_ty {
                         #[allow(clippy::no_effect)]
                         [(); #dim][n as usize];
                         #reader_ty::new ( #value )
                     }
+                    #[doc = "Iterator for array of:"]
+                    #[doc = #doc]
+                    #inline
+                    pub fn #name_snake_case_iter(&self) -> impl Iterator<Item = #reader_ty> + '_ {
+                        (0..#dim).map(|n| #reader_ty::new ( #value ))
+                    }
                 });
 
                 for fi in svd::field::expand(f, de) {
@@ -1181,11 +1189,12 @@ pub fn fields(
                 let offset_calc = calculate_offset(increment, offset, false);
                 let doc = &util::replace_suffix(&description, &brief_suffix);
                 let first_name = svd::array::names(f, de).next().unwrap();
-                let array_doc =
-                    format!("{doc}\n\nNOTE: `n` is number of field in register. `n == 0` corresponds to `{first_name}` field");
+                let note = format!("NOTE: `n` is number of field in register. `n == 0` corresponds to `{first_name}` field");
                 let dim = unsuffixed(de.dim);
                 w_impl_items.extend(quote! {
-                    #[doc = #array_doc]
+                    #[doc = #doc]
+                    #[doc = ""]
+                    #[doc = #note]
                     #inline
                     #[must_use]
                     pub fn #name_snake_case(&mut self, n: u8) -> #writer_ty<#regspec_ident> {