Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

clippy #871

Merged
merged 4 commits into from
Oct 19, 2024
Merged

clippy #871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb66cd4
clippy
burrbull Oct 18, 2024
dbd8734
clean accessors
burrbull Oct 19, 2024
c13b87d
strings
burrbull Oct 19, 2024
8aadb82
Add warning about indexing register arrays
burrbull Oct 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

- Add warning about indexing register arrays
- Skip generating `.add(0)` and `1 *` in accessors
- Bump MSRV of generated code to 1.76
- move `must_use` from methods to generic type

Expand Down
8 changes: 4 additions & 4 deletions src/generate/interrupt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@ pub fn render(
interrupt
.0
.description
.as_ref()
.map(|s| util::respace(s))
.as_ref()
.map(|s| util::escape_special_chars(s))
.as_deref()
.map(util::respace)
.as_deref()
.map(util::escape_special_chars)
.unwrap_or_else(|| interrupt.0.name.clone())
);

Expand Down
42 changes: 25 additions & 17 deletions src/generate/peripheral.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ impl Region {
let mut idents: Vec<_> = self
.rbfs
.iter()
.filter_map(|f| f.syn_field.ident.as_ref().map(|ident| ident.to_string()))
.filter_map(|f| f.syn_field.ident.as_ref().map(ToString::to_string))
.collect();
if idents.is_empty() {
return None;
Expand Down Expand Up @@ -343,7 +343,7 @@ impl Region {
let idents: Vec<_> = self
.rbfs
.iter()
.filter_map(|f| f.syn_field.ident.as_ref().map(|ident| ident.to_string()))
.filter_map(|f| f.syn_field.ident.as_ref().map(ToString::to_string))
.collect();

if idents.is_empty() {
Expand Down Expand Up @@ -726,7 +726,7 @@ fn check_erc_derive_infos(
};
match register {
Register::Single(_) => {
let ty_name = info_name.to_string();
let ty_name = info_name.clone();
*derive_info = match explicit_rpath {
None => {
match compare_this_against_prev(
Expand Down Expand Up @@ -758,7 +758,7 @@ fn check_erc_derive_infos(
let re = Regex::new(format!("^{re_string}$").as_str()).map_err(|_| {
anyhow!("Error creating regex for register {}", register.name)
})?;
let ty_name = info_name.to_string(); // keep suffix for regex matching
let ty_name = info_name.clone(); // keep suffix for regex matching
*derive_info = match explicit_rpath {
None => {
match compare_this_against_prev(
Expand Down Expand Up @@ -787,7 +787,7 @@ fn check_erc_derive_infos(
}
RegisterCluster::Cluster(cluster) => {
*derive_info = DeriveInfo::Cluster;
ercs_type_info.push((cluster.name.to_string(), None, erc, derive_info));
ercs_type_info.push((cluster.name.clone(), None, erc, derive_info));
}
};
}
Expand Down Expand Up @@ -998,7 +998,7 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
doc,
name,
ty,
offset: unsuffixed(info.address_offset),
offset: info.address_offset,
})
.raw_if(false);
cluster_expanded.push(RegisterBlockField {
Expand Down Expand Up @@ -1052,14 +1052,19 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
&description,
);
let mut accessors = Vec::with_capacity((array_info.dim + 1) as _);
let first_name = svd::array::names(info, array_info).next().unwrap();
let note = (array_info.indexes().next().unwrap() != "0").then(||
format!("<div class=\"warning\">`n` is the index of {0} in the array. `n == 0` corresponds to `{first_name}` {0}.</div>", "cluster")
);
accessors.push(
Accessor::Array(ArrayAccessor {
doc,
name: accessor_name.clone(),
ty: ty.clone(),
offset: unsuffixed(info.address_offset),
dim: unsuffixed(array_info.dim),
increment: unsuffixed(array_info.dim_increment),
offset: info.address_offset,
dim: array_info.dim,
increment: array_info.dim_increment,
note,
})
.raw_if(!array_convertible),
);
Expand All @@ -1071,7 +1076,6 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
ci.address_offset,
ci.description.as_deref().unwrap_or(&ci.name),
);
let i = unsuffixed(i as u64);
accessors.push(
Accessor::ArrayElem(ArrayElemAccessor {
doc,
Expand Down Expand Up @@ -1114,7 +1118,7 @@ fn expand_cluster(cluster: &Cluster, config: &Config) -> Result<Vec<RegisterBloc
doc,
name,
ty: ty.clone(),
offset: unsuffixed(info.address_offset),
offset: info.address_offset,
})
.raw_if(false);
cluster_expanded.push(RegisterBlockField {
Expand Down Expand Up @@ -1166,7 +1170,7 @@ fn expand_register(
doc,
name,
ty,
offset: unsuffixed(info.address_offset),
offset: info.address_offset,
})
.raw_if(false);
register_expanded.push(RegisterBlockField {
Expand Down Expand Up @@ -1235,14 +1239,19 @@ fn expand_register(
&description,
);
let mut accessors = Vec::with_capacity((array_info.dim + 1) as _);
let first_name = svd::array::names(info, array_info).next().unwrap();
let note = (array_info.indexes().next().unwrap() != "0").then(||
format!("<div class=\"warning\">`n` is the index of {0} in the array. `n == 0` corresponds to `{first_name}` {0}.</div>", "register")
);
accessors.push(
Accessor::Array(ArrayAccessor {
doc,
name: accessor_name.clone(),
ty: ty.clone(),
offset: unsuffixed(info.address_offset),
dim: unsuffixed(array_info.dim),
increment: unsuffixed(array_info.dim_increment),
offset: info.address_offset,
dim: array_info.dim,
increment: array_info.dim_increment,
note,
})
.raw_if(!array_convertible),
);
Expand All @@ -1259,7 +1268,6 @@ fn expand_register(
ri.address_offset,
ri.description.as_deref().unwrap_or(&ri.name),
);
let i = unsuffixed(i as u64);
accessors.push(
Accessor::ArrayElem(ArrayElemAccessor {
doc,
Expand Down Expand Up @@ -1302,7 +1310,7 @@ fn expand_register(
doc,
name,
ty: ty.clone(),
offset: unsuffixed(info.address_offset),
offset: info.address_offset,
})
.raw_if(false);
register_expanded.push(RegisterBlockField {
Expand Down
35 changes: 27 additions & 8 deletions src/generate/peripheral/accessor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
use proc_macro2::{Ident, Span, TokenStream};
use quote::{quote, ToTokens};

use crate::util::unsuffixed;

#[derive(Clone, Debug)]
pub enum Accessor {
Reg(RegAccessor),
Expand Down Expand Up @@ -51,18 +53,24 @@ impl ToTokens for AccessType {
ty,
offset,
})) => {
let offset = (*offset != 0).then(|| unsuffixed(*offset)).map(|o| quote!(.add(#o)));
quote! {
#[doc = #doc]
#[inline(always)]
pub const fn #name(&self) -> &#ty {
unsafe { &*core::ptr::from_ref(self).cast::<u8>().add(#offset).cast() }
unsafe { &*core::ptr::from_ref(self).cast::<u8>() #offset .cast() }
}
}
}
Self::Ref(Accessor::Array(ArrayAccessor { doc, name, ty, .. })) => {
Self::Ref(Accessor::Array(ArrayAccessor { doc, name, ty, note, .. })) => {
let name_iter = Ident::new(&format!("{name}_iter"), Span::call_site());
let note = note.as_ref().map(|note| quote! {
#[doc = ""]
#[doc = #note]
});
quote! {
#[doc = #doc]
#note
#[inline(always)]
pub const fn #name(&self, n: usize) -> &#ty {
&self.#name[n]
Expand All @@ -82,11 +90,20 @@ impl ToTokens for AccessType {
offset,
dim,
increment,
note,
})) => {
let name_iter = Ident::new(&format!("{name}_iter"), Span::call_site());
let cast = quote! { unsafe { &*core::ptr::from_ref(self).cast::<u8>().add(#offset).add(#increment * n).cast() } };
let offset = (*offset != 0).then(|| unsuffixed(*offset)).map(|o| quote!(.add(#o)));
let dim = unsuffixed(*dim);
let increment = (*increment != 1).then(|| unsuffixed(*increment)).map(|i| quote!(#i *));
let note = note.as_ref().map(|note| quote! {
#[doc = ""]
#[doc = #note]
});
let cast = quote! { unsafe { &*core::ptr::from_ref(self).cast::<u8>() #offset .add(#increment n).cast() } };
quote! {
#[doc = #doc]
#note
#[inline(always)]
pub const fn #name(&self, n: usize) -> &#ty {
#[allow(clippy::no_effect)]
Expand All @@ -109,6 +126,7 @@ impl ToTokens for AccessType {
basename,
i,
} = elem;
let i = unsuffixed(*i as u64);
quote! {
#[doc = #doc]
#[inline(always)]
Expand All @@ -127,17 +145,18 @@ pub struct RegAccessor {
pub doc: String,
pub name: Ident,
pub ty: syn::Type,
pub offset: syn::LitInt,
pub offset: u32,
}

#[derive(Clone, Debug)]
pub struct ArrayAccessor {
pub doc: String,
pub name: Ident,
pub ty: syn::Type,
pub offset: syn::LitInt,
pub dim: syn::LitInt,
pub increment: syn::LitInt,
pub offset: u32,
pub dim: u32,
pub increment: u32,
pub note: Option<String>,
}

#[derive(Clone, Debug)]
Expand All @@ -146,5 +165,5 @@ pub struct ArrayElemAccessor {
pub name: Ident,
pub ty: syn::Type,
pub basename: Ident,
pub i: syn::LitInt,
pub i: usize,
}
6 changes: 3 additions & 3 deletions src/generate/register.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ use crate::svd::{
ModifiedWriteValues, ReadAction, Register, RegisterProperties, Usage, WriteConstraint,
WriteConstraintRange,
};
use core::u64;
use log::warn;
use proc_macro2::{Delimiter, Group, Ident, Span, TokenStream};
use quote::quote;
Expand Down Expand Up @@ -117,7 +116,7 @@ pub fn render(
register.properties.reset_value.is_some(),
&mod_ty,
false,
&register,
register,
&rpath,
config,
)?,
Expand Down Expand Up @@ -162,6 +161,7 @@ fn read_action_docs(can_read: bool, read_action: Option<ReadAction>) -> String {
doc
}

#[allow(clippy::too_many_arguments)]
fn api_docs(
can_read: bool,
can_write: bool,
Expand Down Expand Up @@ -222,7 +222,7 @@ fn api_docs(
let idx = format!("[{idx}]");
rpath.name.replace("[%s]", &idx).replace("%s", &idx)
} else {
rpath.name.to_string()
rpath.name.clone()
};
// TODO: support html_urls for registers in cluster
if rpath.block.path.is_empty() {
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
//!
//! - `build.rs`, build script that places `device.x` somewhere the linker can find.
//! - `device.x`, linker script that weakly aliases all the interrupt handlers to the default
//! exception handler (`DefaultHandler`).
//! exception handler (`DefaultHandler`).
//! - `lib.rs`, the generated code.
//!
//! All these files must be included in the same device crate. The `lib.rs` file contains several
Expand Down Expand Up @@ -95,7 +95,7 @@
//!
//! - `build.rs`, build script that places `device.x` somewhere the linker can find.
//! - `device.x`, linker script that weakly aliases all the interrupt handlers to the default
//! exception handler (`DefaultHandler`).
//! exception handler (`DefaultHandler`).
//! - `lib.rs`, the generated code.
//!
//! All these files must be included in the same device crate. The `lib.rs` file contains several
Expand Down
Loading