remove ArrayProxy

Author: burrbull

.github/workflows/ci.yml

@@ -75,7 +75,7 @@ jobs:
           - { rust: stable, vendor: Spansion, options: "--atomics" }
           - { rust: stable, vendor: STMicro, options: "" }
           - { rust: stable, vendor: STMicro, options: "--atomics" }
-          - { rust: stable, vendor: STM32-patched, options: "--strict --array_proxy --pascal_enum_values --max_cluster_size --atomics --atomics_feature atomics" }
+          - { rust: stable, vendor: STM32-patched, options: "--strict --pascal_enum_values --max_cluster_size --atomics --atomics_feature atomics" }
           - { rust: stable, vendor: Toshiba, options: all }
           - { rust: stable, vendor: Toshiba, options: "" }
           # Test MSRV

CHANGELOG.md

@@ -7,9 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+- Use methods to access any register or cluster
 - Remove all deny lints from generated crate
 - Add `reexport_core_peripherals` and `reexport_interrupt` features disabled by default
-- rename `const-generic` feature to `array_proxy`
+- ~~rename `const-generic` feature to `array_proxy`~~ remove `ArrayProxy`
 - `FieldWriter` takes offset as struct field instead of const generic.
   Improves SVD field array access
   Add `width`, `offset` methods

ci/script.sh

@@ -31,7 +31,7 @@ main() {
 
     case $OPTIONS in
         all)
-            options="--array_proxy --strict --atomics"
+            options="--strict --atomics"
             ;;
         *)
             options=$OPTIONS

src/generate/array_proxy.rs

@@ -138,7 +138,6 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
 
     let generic_file = include_str!("generic.rs");
     let generic_atomic_file = include_str!("generic_atomic.rs");
-    let array_proxy = include_str!("array_proxy.rs");
     if config.generic_mod {
         let mut file = File::create(config.output_dir.join("generic.rs"))?;
         writeln!(file, "{generic_file}")?;
@@ -148,9 +147,6 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
             }
             writeln!(file, "\n{generic_atomic_file}")?;
         }
-        if config.array_proxy {
-            writeln!(file, "{array_proxy}")?;
-        }
 
         if !config.make_mod {
             out.extend(quote! {
@@ -168,9 +164,6 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
             }
             syn::parse_file(generic_atomic_file)?.to_tokens(&mut tokens);
         }
-        if config.array_proxy {
-            syn::parse_file(array_proxy)?.to_tokens(&mut tokens);
-        }
 
         out.extend(quote! {
             #[allow(unused_imports)]

src/generate/device.rs

@@ -15,7 +15,7 @@ use quote::{quote, ToTokens};
 use syn::{punctuated::Punctuated, Token};
 
 use crate::util::{
-    self, array_proxy_type, name_to_ty, path_segment, type_path, unsuffixed, Config, FullName,
+    self, name_to_ty, path_segment, type_path, unsuffixed, zst_type, Config, FullName,
     ToSanitizedCase, BITS_PER_BYTE,
 };
 use anyhow::{anyhow, bail, Context, Result};
@@ -1040,7 +1040,7 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
 
             let array_convertible = sequential_addresses && convert_list;
 
-            if array_convertible || config.array_proxy {
+            if !convert_list {
                 let span = Span::call_site();
                 let nb_name_sc = if let Some(dim_name) = array_info.dim_name.as_ref() {
                     dim_name.to_snake_case_ident(span)
@@ -1095,15 +1095,12 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
                         );
                     }
                 }
-                let syn_field = if array_convertible {
-                    let array_ty = new_syn_array(ty, array_info.dim);
-                    new_syn_field(nb_name_sc, array_ty)
+                let array_ty = if array_convertible {
+                    new_syn_array(ty, array_info.dim)
                 } else {
-                    // Include a ZST ArrayProxy giving indexed access to the
-                    // elements.
-                    let ap_path = array_proxy_type(ty, array_info);
-                    new_syn_field(ty_name.to_snake_case_ident(Span::call_site()), ap_path)
+                    zst_type()
                 };
+                let syn_field = new_syn_field(nb_name_sc, array_ty);
                 cluster_expanded.push(RegisterBlockField {
                     syn_field,
                     offset: info.address_offset,
@@ -1226,7 +1223,7 @@ fn expand_register(
             let array_proxy_convertible = ac && disjoint_sequential_addresses;
             let ty = name_to_ty(&ty_name);
 
-            if array_convertible || (array_proxy_convertible && config.array_proxy) {
+            if array_convertible || array_proxy_convertible {
                 let span = Span::call_site();
                 let nb_name_sc = if let Some(dim_name) = array_info.dim_name.as_ref() {
                     util::fullname(dim_name, &info.alternate_group, config.ignore_groups)
@@ -1287,7 +1284,7 @@ fn expand_register(
                 let array_ty = if array_convertible {
                     new_syn_array(ty, array_info.dim)
                 } else {
-                    array_proxy_type(ty, array_info)
+                    zst_type()
                 };
                 let syn_field = new_syn_field(nb_name_sc, array_ty);
                 register_expanded.push(RegisterBlockField {

src/generate/peripheral.rs

@@ -79,14 +79,6 @@ fn run() -> Result<()> {
                 .action(ArgAction::Set)
                 .value_name("FEATURE"),
         )
-        .arg(
-            Arg::new("array_proxy")
-            .long("array_proxy")
-            .action(ArgAction::SetTrue)
-            .help(
-                "Use ArrayProxy helper for non-sequential register arrays",
-            ),
-        )
         .arg(
             Arg::new("ignore_groups")
                 .long("ignore_groups")

src/main.rs

@@ -1,6 +1,6 @@
 use std::borrow::Cow;
 
-use crate::svd::{Access, Device, DimElement, Field, RegisterInfo, RegisterProperties};
+use crate::svd::{Access, Device, Field, RegisterInfo, RegisterProperties};
 use html_escape::encode_text_minimal;
 use inflections::Inflect;
 use proc_macro2::{Ident, Span, TokenStream};
@@ -10,8 +10,7 @@ use std::path::{Path, PathBuf};
 use svd_rs::{MaybeArray, Peripheral, PeripheralInfo};
 
 use syn::{
-    punctuated::Punctuated, token::PathSep, AngleBracketedGenericArguments, GenericArgument, Lit,
-    LitInt, PathArguments, PathSegment, Token, Type, TypePath,
+    punctuated::Punctuated, token::PathSep, Lit, LitInt, PathArguments, PathSegment, Type, TypePath,
 };
 
 use anyhow::{anyhow, bail, Result};
@@ -36,8 +35,6 @@ pub struct Config {
     #[cfg_attr(feature = "serde", serde(default))]
     pub make_mod: bool,
     #[cfg_attr(feature = "serde", serde(default))]
-    pub array_proxy: bool,
-    #[cfg_attr(feature = "serde", serde(default))]
     pub ignore_groups: bool,
     #[cfg_attr(feature = "serde", serde(default))]
     pub keep_list: bool,
@@ -118,7 +115,6 @@ impl Default for Config {
             atomics_feature: None,
             generic_mod: false,
             make_mod: false,
-            array_proxy: false,
             ignore_groups: false,
             keep_list: false,
             strict: false,
@@ -419,30 +415,11 @@ pub fn new_syn_u32(len: u32, span: Span) -> syn::Expr {
     })
 }
 
-pub fn array_proxy_type(ty: Type, array_info: &DimElement) -> Type {
-    let span = Span::call_site();
-    let inner_path = GenericArgument::Type(ty);
-    let mut args = Punctuated::new();
-    args.push(inner_path);
-    args.push(GenericArgument::Const(new_syn_u32(array_info.dim, span)));
-    args.push(GenericArgument::Const(syn::Expr::Lit(syn::ExprLit {
-        attrs: Vec::new(),
-        lit: syn::Lit::Int(hex(array_info.dim_increment as u64)),
-    })));
-    let arguments = PathArguments::AngleBracketed(AngleBracketedGenericArguments {
-        colon2_token: None,
-        lt_token: Token![<](span),
-        args,
-        gt_token: Token![>](span),
-    });
-
-    let mut segments = Punctuated::new();
-    segments.push(path_segment(Ident::new("crate", span)));
-    segments.push(PathSegment {
-        ident: Ident::new("ArrayProxy", span),
-        arguments,
-    });
-    Type::Path(type_path(segments))
+pub fn zst_type() -> Type {
+    Type::Tuple(syn::TypeTuple {
+        paren_token: syn::token::Paren::default(),
+        elems: Punctuated::new(),
+    })
 }
 
 pub fn name_to_ty(name: &str) -> Type {