Skip to content

chore(shadows): Introduce into_reported as a substitute for From impl, and add ShadowPatch impl for basic std structs #81

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

Open
MathiasKoch wants to merge 2 commits into
base: feature/async
Choose a base branch
from
Open

chore(shadows): Introduce into_reported as a substitute for From impl, and add ShadowPatch impl for basic std structs #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ee1d4f
Introduce into_reported as a substitute for From impl, and add Shadow…
MathiasKoch Jul 28, 2025
b147c17
Rebase on feature/async
MathiasKoch Jul 28, 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
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ hex = { version = "0.4.3", features = ["alloc"] }


[features]
default = ["ota_mqtt_data", "metric_cbor", "provision_cbor"]
default = ["ota_mqtt_data", "metric_cbor", "provision_cbor", "std"]

metric_cbor = ["dep:minicbor", "dep:minicbor-serde"]

Expand Down
126 changes: 2 additions & 124 deletions rustot_derive/src/shadow/generation/generator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
use proc_macro2::TokenStream;
use quote::quote;
use syn::{punctuated::Punctuated, spanned::Spanned as _, Data, DeriveInput, Token};
use syn::{punctuated::Punctuated, Data, DeriveInput, Token};

use crate::shadow::{
generation::variant_or_field_visitor::{borrow_fields, get_attr, has_shadow_arg, is_primitive},
CFG_ATTRIBUTE, DEFAULT_ATTRIBUTE,
};
use crate::shadow::{generation::variant_or_field_visitor::get_attr, DEFAULT_ATTRIBUTE};

pub trait Generator {
fn generate(&mut self, original: &DeriveInput, output: &DeriveInput) -> TokenStream;
Expand All @@ -21,125 +18,6 @@ impl Generator for NewGenerator {
}
}

pub struct GenerateFromImpl;

impl GenerateFromImpl {
fn variables_actions<'a>(
fields: impl Iterator<Item = &'a syn::Field>,
) -> (
Punctuated<syn::Ident, Token![,]>,
Punctuated<TokenStream, Token![,]>,
) {
fields.enumerate().fold(
(Punctuated::new(), Punctuated::new()),
|(mut variables, mut actions), (i, field)| {
let var_ident = field.ident.clone().unwrap_or_else(|| {
syn::Ident::new(&format!("{}", (b'a' + i as u8) as char), field.span())
});

let action = if is_primitive(&field.ty) || has_shadow_arg(&field.attrs, "leaf") {
quote! {Some(#var_ident)}
} else {
quote! {Some(#var_ident.into())}
};

actions.push(
field
.ident
.as_ref()
.map(|ident| quote! {#ident: #action})
.unwrap_or(action),
);

variables.push(var_ident);

(variables, actions)
},
)
}
}

impl Generator for GenerateFromImpl {
fn generate(&mut self, original: &DeriveInput, output: &DeriveInput) -> TokenStream {
let (impl_generics, ty_generics, where_clause) = original.generics.split_for_impl();
let orig_name = &original.ident;
let new_name = &output.ident;

let from_impl = match (&original.data, &output.data) {
(Data::Struct(data_struct_old), Data::Struct(data_struct_new)) => {
let original_fields = borrow_fields(data_struct_old);
let new_fields = borrow_fields(data_struct_new);

let from_fields = original_fields.iter().fold(quote! {}, |acc, field| {
let is_leaf = is_primitive(&field.ty) || has_shadow_arg(&field.attrs, "leaf");

let has_new_field = new_fields
.iter()
.find(|&f| f.ident == field.ident)
.is_some();

let cfg_attr = get_attr(&field.attrs, CFG_ATTRIBUTE);

let ident = &field.ident;
if !has_new_field {
quote! { #acc #cfg_attr #ident: None, }
} else if is_leaf {
quote! { #acc #cfg_attr #ident: Some(v.#ident), }
} else {
quote! { #acc #cfg_attr #ident: Some(v.#ident.into()), }
}
});

quote! {
Self {
#from_fields
}
}
}
(Data::Enum(data_struct_old), Data::Enum(_)) => {
let match_arms = data_struct_old
.variants
.iter()
.fold(Punctuated::<TokenStream, Token![,]>::new(), |mut acc, variant| {
let variant_ident = &variant.ident;
let cfg_attr = get_attr(&variant.attrs, CFG_ATTRIBUTE);

acc.push(match &variant.fields {
syn::Fields::Named(fields_named) => {
let (variables, actions) = Self::variables_actions(fields_named.named.iter());
quote! {#cfg_attr #orig_name::#variant_ident { #variables } => Self::#variant_ident { #actions }}
}
syn::Fields::Unnamed(fields_unnamed) => {
let (variables, actions) = Self::variables_actions(fields_unnamed.unnamed.iter());
quote! {#cfg_attr #orig_name::#variant_ident ( #variables ) => Self::#variant_ident ( #actions )}
}
syn::Fields::Unit => {
quote! {#cfg_attr #orig_name::#variant_ident => Self::#variant_ident}
}
});

acc
});

quote! {
match v {
#match_arms
}
}
}
_ => panic!(),
};

quote! {
impl #impl_generics From<#orig_name #ty_generics> for #new_name #ty_generics #where_clause {
fn from(v: #orig_name #ty_generics) -> Self {
#from_impl
}
}
}
}
}

pub struct DefaultGenerator(pub bool);

impl Generator for DefaultGenerator {
Expand Down
107 changes: 106 additions & 1 deletion rustot_derive/src/shadow/generation/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ use generator::Generator;
use modifier::Modifier;
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::{punctuated::Punctuated, Data, DeriveInput, Path, Token};
use syn::{punctuated::Punctuated, spanned::Spanned as _, Data, DeriveInput, Path, Token};
use variant_or_field_visitor::{
borrow_fields_mut, get_attr, has_shadow_arg, is_primitive, VariantOrFieldVisitor,
};

use crate::shadow::generation::variant_or_field_visitor::borrow_fields;

use super::CFG_ATTRIBUTE;

pub struct ShadowGenerator {
Expand Down Expand Up @@ -92,6 +94,40 @@ impl GenerateShadowPatchImplVisitor {
apply_patch_impl: quote! {},
}
}

fn variables_actions<'a>(
fields: impl Iterator<Item = &'a syn::Field>,
) -> (
Punctuated<syn::Ident, Token![,]>,
Punctuated<TokenStream, Token![,]>,
) {
fields.enumerate().fold(
(Punctuated::new(), Punctuated::new()),
|(mut variables, mut actions), (i, field)| {
let var_ident = field.ident.clone().unwrap_or_else(|| {
syn::Ident::new(&format!("{}", (b'a' + i as u8) as char), field.span())
});

let action = if is_primitive(&field.ty) || has_shadow_arg(&field.attrs, "leaf") {
quote! {Some(#var_ident)}
} else {
quote! {Some(#var_ident.into_reported())}
};

actions.push(
field
.ident
.as_ref()
.map(|ident| quote! {#ident: #action})
.unwrap_or(action),
);

variables.push(var_ident);

(variables, actions)
},
)
}
}

impl Generator for GenerateShadowPatchImplVisitor {
Expand All @@ -116,6 +152,71 @@ impl Generator for GenerateShadowPatchImplVisitor {
}
};

let into_reported_impl = match (&original.data, &output.data) {
(Data::Struct(data_struct_old), Data::Struct(data_struct_new)) => {
let original_fields = borrow_fields(data_struct_old);
let new_fields = borrow_fields(data_struct_new);

let from_fields = original_fields.iter().fold(quote! {}, |acc, field| {
let is_leaf = is_primitive(&field.ty) || has_shadow_arg(&field.attrs, "leaf");

let has_new_field = new_fields
.iter()
.find(|&f| f.ident == field.ident)
.is_some();

let cfg_attr = get_attr(&field.attrs, CFG_ATTRIBUTE);

let ident = &field.ident;
if !has_new_field {
quote! { #acc #cfg_attr #ident: None, }
} else if is_leaf {
quote! { #acc #cfg_attr #ident: Some(self.#ident), }
} else {
quote! { #acc #cfg_attr #ident: Some(self.#ident.into_reported()), }
}
});

quote! {
Self::Reported {
#from_fields
}
}
}
(Data::Enum(data_struct_old), Data::Enum(_)) => {
let match_arms = data_struct_old
.variants
.iter()
.fold(Punctuated::<TokenStream, Token![,]>::new(), |mut acc, variant| {
let variant_ident = &variant.ident;
let cfg_attr = get_attr(&variant.attrs, CFG_ATTRIBUTE);

acc.push(match &variant.fields {
syn::Fields::Named(fields_named) => {
let (variables, actions) = Self::variables_actions(fields_named.named.iter());
quote! {#cfg_attr #orig_name::#variant_ident { #variables } => Self::Reported::#variant_ident { #actions }}
}
syn::Fields::Unnamed(fields_unnamed) => {
let (variables, actions) = Self::variables_actions(fields_unnamed.unnamed.iter());
quote! {#cfg_attr #orig_name::#variant_ident ( #variables ) => Self::Reported::#variant_ident ( #actions )}
}
syn::Fields::Unit => {
quote! {#cfg_attr #orig_name::#variant_ident => Self::Reported::#variant_ident}
}
});

acc
});

quote! {
match self {
#match_arms
}
}
}
_ => panic!(),
};

quote! {
impl #impl_generics rustot::shadows::ShadowPatch for #orig_name #ty_generics #where_clause {
type Delta = #delta_name #ty_generics;
Expand All @@ -124,6 +225,10 @@ impl Generator for GenerateShadowPatchImplVisitor {
fn apply_patch(&mut self, delta: Self::Delta) {
#apply_patch_impl
}

fn into_reported(self) -> Self::Reported {
#into_reported_impl
}
}
}
}
Expand Down
3 changes: 1 addition & 2 deletions rustot_derive/src/shadow/shadow_patch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use syn::{
};

use crate::shadow::generation::{
generator::{DefaultGenerator, GenerateFromImpl, NewGenerator},
generator::{DefaultGenerator, NewGenerator},
modifier::{RenameModifier, ReportOnlyModifier, WithDerivesModifier},
variant_or_field_visitor::{
AddSerdeSkipAttribute, RemoveShadowAttributesVisitor, SetNewTypeVisitor,
Expand Down Expand Up @@ -128,7 +128,6 @@ pub fn shadow_patch(attr: TokenStream, input: TokenStream) -> TokenStream {
.variant_or_field_visitor(&mut RemoveShadowAttributesVisitor)
.generator(&mut NewGenerator)
.modifier(&mut ReportOnlyModifier)
.generator(&mut GenerateFromImpl)
.finalize()
};

Expand Down
8 changes: 4 additions & 4 deletions rustot_derive/tests/shadow.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ fn nested() {
assert_eq!(Foo::MAX_PAYLOAD_SIZE, 256);

assert_eq!(
ReportedFoo::from(foo.clone()),
foo.clone().into_reported(),
ReportedFoo {
bar: Some(56),
baz: Some("HelloWorld".to_string()),
Expand Down Expand Up @@ -151,7 +151,7 @@ fn simple_enum() {
bar: Some(Either::B),
});

assert_eq!(ReportedFoo::from(desired), reported);
assert_eq!(desired.into_reported(), reported);
}

#[test]
Expand Down Expand Up @@ -211,7 +211,7 @@ fn complex_enum() {
bar: Either::D(InnerA { hello: 56 }, InnerB::default())
}
);
assert_eq!(ReportedFoo::from(desired), reported);
assert_eq!(desired.into_reported(), reported);
}

#[test]
Expand Down Expand Up @@ -271,7 +271,7 @@ fn manual_reported() {
Self {
bar: Some(v.bar),
baz: Some(v.baz),
inner: Some(v.inner.into()),
inner: Some(v.inner.into_reported()),
..Default::default()
}
}
Expand Down
Loading
Loading