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.

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

Cleaner macros utilizing syn::Member #18199

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
60 changes: 21 additions & 39 deletions crates/bevy_asset/macros/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

use bevy_macro_utils::BevyManifest;
use bevy_macro_utils::{as_member, BevyManifest};
use proc_macro::{Span, TokenStream};
use quote::{format_ident, quote};
use syn::{parse_macro_input, Data, DeriveInput, Path};
use syn::{parse_macro_input, Data, DataStruct, DeriveInput, Path};

pub(crate) fn bevy_asset_path() -> Path {
BevyManifest::shared().get_path("bevy_asset")
Expand All @@ -23,7 +23,6 @@ pub fn derive_asset(input: TokenStream) -> TokenStream {
Ok(dependency_visitor) => dependency_visitor,
Err(err) => return err.into_compile_error().into(),
};

TokenStream::from(quote! {
impl #impl_generics #bevy_asset_path::Asset for #struct_name #type_generics #where_clause { }
#dependency_visitor
Expand Down Expand Up @@ -52,52 +51,35 @@ fn derive_dependency_visitor_internal(
let field_has_dep = |f: &syn::Field| f.attrs.iter().any(is_dep_attribute);

let body = match &ast.data {
Data::Struct(data_struct) => {
let fields = data_struct.fields.iter();
let field_visitors = fields.enumerate().filter(|(_, f)| field_has_dep(f));
let field_visitors = field_visitors.map(|(i, field)| match &field.ident {
Some(ident) => visit_dep(quote!(&self.#ident)),
None => {
let index = syn::Index::from(i);
visit_dep(quote!(&self.#index))
}
});
Some(quote!( #(#field_visitors)* ))
Data::Struct(DataStruct { fields, .. }) => {
let field_visitors = fields
.iter()
.enumerate()
.filter(|(_, f)| field_has_dep(f))
.map(|(i, field)| as_member(field.ident.as_ref(), i))
.map(|member| visit_dep(quote!(&self.#member)));
Some(quote!(#(#field_visitors)*))
}
Data::Enum(data_enum) => {
let variant_has_dep = |v: &syn::Variant| v.fields.iter().any(field_has_dep);
let any_case_required = data_enum.variants.iter().any(variant_has_dep);
let cases = data_enum.variants.iter().filter(|v| variant_has_dep(v));
let cases = cases.map(|variant| {
let ident = &variant.ident;
let fields = &variant.fields;

let field_visitors = fields.iter().enumerate().filter(|(_, f)| field_has_dep(f));

let field_visitors = field_visitors.map(|(i, field)| match &field.ident {
Some(ident) => visit_dep(quote!(#ident)),
None => {
let ident = format_ident!("member{i}");
visit_dep(quote!(#ident))
}
});
let fields = match fields {
syn::Fields::Named(fields) => {
let named = fields.named.iter().map(|f| f.ident.as_ref());
quote!({ #(#named,)* .. })
}
syn::Fields::Unnamed(fields) => {
let named = (0..fields.unnamed.len()).map(|i| format_ident!("member{i}"));
quote!( ( #(#named,)* ) )
}
syn::Fields::Unit => unreachable!("Can't pass filter is_dep_attribute"),
};
quote!(Self::#ident #fields => {
let field_members = variant
.fields
.iter()
.enumerate()
.filter(|(_, f)| field_has_dep(f))
.map(|(i, field)| as_member(field.ident.as_ref(), i));
let field_locals = field_members.clone().map(|m| format_ident!("__self_{}", m));
let field_visitors = field_locals.clone().map(|i| visit_dep(quote!(#i)));
quote!(Self::#ident {#(#field_members: #field_locals,)* ..} => {
#(#field_visitors)*
})
},)
});

any_case_required.then(|| quote!(match self { #(#cases)*, _ => {} }))
any_case_required.then(|| quote!(match self { #(#cases)* _ => {} }))
}
Data::Union(_) => {
return Err(syn::Error::new(
Expand Down
14 changes: 0 additions & 14 deletions crates/bevy_ecs/compile_fail/tests/ui/world_query_derive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,6 @@ struct MutableInvalidAttribute {
a: &'static mut Foo,
}

#[derive(QueryData)]
#[query_data(mutable(foo))]
//~^ ERROR: `mutable` does not take any arguments
struct MutableInvalidAttributeParameters {
a: &'static mut Foo,
}

#[derive(QueryData)]
#[query_data(derive)]
//~^ ERROR: `derive` requires at least one argument
struct MutableMissingAttributeParameters {
a: &'static mut Foo,
}

#[derive(QueryData)]
#[query_data(mutable)]
struct MutableMarked {
Expand Down
12 changes: 0 additions & 12 deletions crates/bevy_ecs/compile_fail/tests/ui/world_query_derive.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@ error: invalid attribute, expected `mutable` or `derive`
14 | #[query_data(mut)]
| ^^^

error: `mutable` does not take any arguments
--> tests/ui/world_query_derive.rs:21:14
|
21 | #[query_data(mutable(foo))]
| ^^^^^^^

error: `derive` requires at least one argument
--> tests/ui/world_query_derive.rs:28:14
|
28 | #[query_data(derive)]
| ^^^^^^

error[E0277]: the trait bound `&'static mut Foo: ReadOnlyQueryData` is not satisfied
--> tests/ui/world_query_derive.rs:10:8
|
Expand Down
21 changes: 7 additions & 14 deletions crates/bevy_ecs/macros/src/component.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use bevy_macro_utils::{as_member, fq_std::FQOption};
use proc_macro::TokenStream;
use proc_macro2::{Span, TokenStream as TokenStream2};
use quote::{format_ident, quote, ToTokens};
Expand Down Expand Up @@ -330,13 +331,10 @@ fn visit_entities(
|| relationship.is_some_and(|relationship| relationship == *field)
})
.for_each(|(index, field)| {
let field_member = field
.ident
.clone()
.map_or(Member::from(index), Member::Named);
let member = as_member(field.ident.as_ref(), index);

visit.push(quote!(this.#field_member.visit_entities(&mut func);));
visit_mut.push(quote!(this.#field_member.visit_entities_mut(&mut func);));
visit.push(quote!(this.#member.visit_entities(&mut func);));
visit_mut.push(quote!(this.#member.visit_entities_mut(&mut func);));
});
if visit.is_empty() {
return quote!();
Expand All @@ -363,12 +361,7 @@ fn visit_entities(
.iter()
.enumerate()
.filter(|(_, field)| field.attrs.iter().any(|a| a.path().is_ident(ENTITIES)))
.map(|(index, field)| {
field
.ident
.clone()
.map_or(Member::from(index), Member::Named)
})
.map(|(index, field)| as_member(field.ident.as_ref(), index))
.collect::<Vec<_>>();

let ident = &variant.ident;
Expand Down Expand Up @@ -634,8 +627,8 @@ fn hook_register_function_call(
) -> Option<TokenStream2> {
function.map(|meta| {
quote! {
fn #hook() -> ::core::option::Option<#bevy_ecs_path::component::ComponentHook> {
::core::option::Option::Some(#meta)
fn #hook() -> #FQOption<#bevy_ecs_path::component::ComponentHook> {
#FQOption::Some(#meta)
}
}
})
Expand Down
Loading