forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

move system_param fetch struct into anonymous scope to avoid name collisions (#4100)

Browse Source 
# Objective

avoid naming collisions with user structs when deriving ``system_param``.

## Solution

~rename the fetch struct created by ``#[derive(system_param)]`` from ``{}State`` to ``{}SysParamState``.~
place the fetch struct into an anonymous scope.

## Migration Guide

For code that was using a system param's fetch struct, such as ``EventReader``'s ``EventReaderState``, the fetch struct can now be identified via the SystemParam trait associated type ``Fetch``, e.g. for ``EventReader<T>`` it can be identified as ``<EventReader<'static, 'static, T> as SystemParam>::Fetch``
This commit is contained in:
robtfm 2022-05-02 18:26:50 +00:00
parent a011f4d53c
commit b9f738da8d
1 changed files with 39 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
crates/bevy_ecs/macros/src/lib.rs
View File

@ -368,51 +368,55 @@ pub fn derive_system_param(input: TokenStream) -> TokenStream {
})); }));
let struct_name = &ast.ident; let struct_name = &ast.ident;
let fetch_struct_name = Ident::new(&format!("{}State", struct_name), Span::call_site());
let fetch_struct_visibility = &ast.vis; let fetch_struct_visibility = &ast.vis;
TokenStream::from(quote! { TokenStream::from(quote! {
impl #impl_generics #path::system::SystemParam for #struct_name #ty_generics #where_clause { // We define the FetchState struct in an anonymous scope to avoid polluting the user namespace.
type Fetch = #fetch_struct_name <(#(<#field_types as #path::system::SystemParam>::Fetch,)*), #punctuated_generic_idents>; // The struct can still be accessed via SystemParam::Fetch, e.g. EventReaderState can be accessed via
} // <EventReader<'static, 'static, T> as SystemParam>::Fetch
const _: () = {
impl #impl_generics #path::system::SystemParam for #struct_name #ty_generics #where_clause {
type Fetch = FetchState <(#(<#field_types as #path::system::SystemParam>::Fetch,)*), #punctuated_generic_idents>;
}
#[doc(hidden)] #[doc(hidden)]
#fetch_struct_visibility struct #fetch_struct_name<TSystemParamState, #punctuated_generic_idents> { #fetch_struct_visibility struct FetchState <TSystemParamState, #punctuated_generic_idents> {
state: TSystemParamState, state: TSystemParamState,
marker: std::marker::PhantomData<fn()->(#punctuated_generic_idents)> marker: std::marker::PhantomData<fn()->(#punctuated_generic_idents)>
} }
unsafe impl<TSystemParamState: #path::system::SystemParamState, #punctuated_generics> #path::system::SystemParamState for #fetch_struct_name<TSystemParamState, #punctuated_generic_idents> #where_clause { unsafe impl<TSystemParamState: #path::system::SystemParamState, #punctuated_generics> #path::system::SystemParamState for FetchState <TSystemParamState, #punctuated_generic_idents> #where_clause {
fn init(world: &mut #path::world::World, system_meta: &mut #path::system::SystemMeta) -> Self { fn init(world: &mut #path::world::World, system_meta: &mut #path::system::SystemMeta) -> Self {
Self { Self {
state: TSystemParamState::init(world, system_meta), state: TSystemParamState::init(world, system_meta),
marker: std::marker::PhantomData, marker: std::marker::PhantomData,
}
}
fn new_archetype(&mut self, archetype: &#path::archetype::Archetype, system_meta: &mut #path::system::SystemMeta) {
self.state.new_archetype(archetype, system_meta)
}
fn apply(&mut self, world: &mut #path::world::World) {
self.state.apply(world)
} }
} }
fn new_archetype(&mut self, archetype: &#path::archetype::Archetype, system_meta: &mut #path::system::SystemMeta) { impl #impl_generics #path::system::SystemParamFetch<'w, 's> for FetchState <(#(<#field_types as #path::system::SystemParam>::Fetch,)*), #punctuated_generic_idents> #where_clause {
self.state.new_archetype(archetype, system_meta) type Item = #struct_name #ty_generics;
} unsafe fn get_param(
state: &'s mut Self,
fn apply(&mut self, world: &mut #path::world::World) { system_meta: &#path::system::SystemMeta,
self.state.apply(world) world: &'w #path::world::World,
} change_tick: u32,
} ) -> Self::Item {
#struct_name {
impl #impl_generics #path::system::SystemParamFetch<'w, 's> for #fetch_struct_name <(#(<#field_types as #path::system::SystemParam>::Fetch,)*), #punctuated_generic_idents> #where_clause { #(#fields: <<#field_types as #path::system::SystemParam>::Fetch as #path::system::SystemParamFetch>::get_param(&mut state.state.#field_indices, system_meta, world, change_tick),)*
type Item = #struct_name #ty_generics; #(#ignored_fields: <#ignored_field_types>::default(),)*
unsafe fn get_param( }
state: &'s mut Self,
system_meta: &#path::system::SystemMeta,
world: &'w #path::world::World,
change_tick: u32,
) -> Self::Item {
#struct_name {
#(#fields: <<#field_types as #path::system::SystemParam>::Fetch as #path::system::SystemParamFetch>::get_param(&mut state.state.#field_indices, system_meta, world, change_tick),)*
#(#ignored_fields: <#ignored_field_types>::default(),)*
} }
} }
} };
}) })
} }