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

Print array fields separate instead of as array in Debug and defmt::Format impls. #45

Merged
merged 4 commits into from
Feb 17, 2025
Merged

Print array fields separate instead of as array in Debug and defmt::Format impls. #45

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e808a1
Print array fields separate instead of as array.
de-vri-es Jan 5, 2025
db76534
Use original field names for array elements in Debug and defmt impls.
de-vri-es Jan 5, 2025
663174d
Use either original field name or array index in Debug/Format impls.
de-vri-es Jan 8, 2025
34fc0dc
Remove original array field names.
de-vri-es Feb 17, 2025
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
70 changes: 44 additions & 26 deletions src/generate/fieldset.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use anyhow::Result;
use proc_macro2::TokenStream;
use proc_macro2::{Ident, Literal, Span};
use proc_macro2::{Ident, Span};
use quote::quote;

use crate::ir::*;
Expand All @@ -12,7 +12,6 @@ pub fn render(opts: &super::Options, ir: &IR, fs: &FieldSet, path: &str) -> Resu
let span = Span::call_site();
let mut items = TokenStream::new();
let mut field_names = Vec::with_capacity(fs.fields.len());
let mut field_names_str = Vec::with_capacity(fs.fields.len());
let mut field_getters = Vec::with_capacity(fs.fields.len());
let mut field_types = Vec::with_capacity(fs.fields.len());

Expand Down Expand Up @@ -68,14 +67,16 @@ pub fn render(opts: &super::Options, ir: &IR, fs: &FieldSet, path: &str) -> Resu
}
}

field_names.push(name.clone());
field_names_str.push(f.name.as_str());
if let Some(array) = &f.array {
let len = array.len();
let i = 0..len;
field_types.push(quote!([#field_ty; #len]));
field_getters.push(quote!([#( self.#name(#i), )*]));
// Print array fields using array indexing: "field[0]"
for i in 0..array.len() {
let debug_name = format!("{}[{i}]", f.name);
field_names.push(debug_name);
field_types.push(field_ty.clone());
field_getters.push(quote!(self.#name(#i)));
}
} else {
field_names.push(f.name.clone());
field_types.push(field_ty.clone());
field_getters.push(quote!(self.#name()));
}
Expand Down Expand Up @@ -181,31 +182,37 @@ pub fn render(opts: &super::Options, ir: &IR, fs: &FieldSet, path: &str) -> Resu
}

let (_, name) = super::split_path(path);
let name_str = {
let mut literal = Literal::string(name);
literal.set_span(span);
literal
};
let name_str = name;
let name = Ident::new(name, span);
let doc = util::doc(&fs.description);

let impl_defmt_format = opts.defmt_feature.as_ref().map(|defmt_feature| {
let mut defmt_format_string = String::new();
defmt_format_string.push_str(name_str);
defmt_format_string.push_str(" {{");
for (i, (field_name, field_type)) in field_names.iter().zip(&field_types).enumerate() {
if i > 0 {
defmt_format_string.push_str(", ");
} else {
defmt_format_string.push_str(" ");
}
defmt_format_string.push_str(field_name);

if is_defmt_primitive_type(field_type) {
defmt_format_string.push_str(": {=");
defmt_format_string.push_str(&field_type.to_string());
defmt_format_string.push_str(":?}");
} else {
defmt_format_string.push_str(": {:?}");
}
}
defmt_format_string.push_str(" }}");

quote! {
#[cfg(feature = #defmt_feature)]
impl defmt::Format for #name {
fn format(&self, f: defmt::Formatter) {
#[derive(defmt::Format)]
struct #name {
#(
#field_names: #field_types,
)*
}
let proxy = #name {
#(
#field_names: #field_getters,
)*
};
defmt::write!(f, "{}", proxy)
defmt::write!(f, #defmt_format_string, #(#field_getters),*)
}
}
}
Expand All @@ -232,7 +239,7 @@ pub fn render(opts: &super::Options, ir: &IR, fs: &FieldSet, path: &str) -> Resu
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
f.debug_struct(#name_str)
#(
.field(#field_names_str, &#field_getters)
.field(#field_names, &#field_getters)
)*
.finish()
}
Expand All @@ -243,3 +250,14 @@ pub fn render(opts: &super::Options, ir: &IR, fs: &FieldSet, path: &str) -> Resu

Ok(out)
}

fn is_defmt_primitive_type(ty: &TokenStream) -> bool {
// Supported by defmt but not included: [u8; N], [u8] and str.
// Parsing these types is more complicated, so we skip them.
// They should never occur as the field of a fieldset,
// so this should not be a problem.
let primitives = [
"bool", "u8", "i8", "u16", "i16", "u32", "i32", "u64", "i64", "u128", "i128", "f32", "f64",
];
primitives.as_slice().contains(&ty.to_string().as_str())
}