Skip to content

Commit

Permalink
Revert "constrain WorldQuery::init_state argument to ComponentInitial… (
Browse files Browse the repository at this point in the history
bevyengine#13804)

…izer (bevyengine#13442)"

This reverts commit 5cfb063.

- This PR broke bevy-trait-query, which needs to be able to write a
resource in init_state. See bevyengine#13798 for more details.
- Note this doesn't fix everything as transmutes for bevy-trait-query
will still be broken,. But the current usage in that crate is UB, so we
need to find another solution.
  • Loading branch information
hymm authored Jun 11, 2024
1 parent d659a1f commit 07a8567
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 142 deletions.
4 changes: 2 additions & 2 deletions crates/bevy_ecs/macros/src/world_query.rs
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ pub(crate) fn world_query_impl(
#( <#field_types>::update_component_access(&state.#named_field_idents, _access); )*
}

fn init_state(initializer: &mut #path::component::ComponentInitializer) -> #state_struct_name #user_ty_generics {
fn init_state(world: &mut #path::world::World) -> #state_struct_name #user_ty_generics {
#state_struct_name {
#(#named_field_idents: <#field_types>::init_state(initializer),)*
#(#named_field_idents: <#field_types>::init_state(world),)*
}
}

Expand Down
70 changes: 0 additions & 70 deletions crates/bevy_ecs/src/component.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ use std::{
borrow::Cow,
marker::PhantomData,
mem::needs_drop,
ops::Deref,
};

/// A data type that can be used to store data for an [entity].
Expand Down Expand Up @@ -838,75 +837,6 @@ impl Components {
}
}

/// A wrapper over a mutable [`Components`] reference that allows for state initialization.
/// This can be obtained with [`World::component_initializer`].
pub struct ComponentInitializer<'w> {
pub(crate) components: &'w mut Components,
pub(crate) storages: &'w mut Storages,
}

impl<'w> Deref for ComponentInitializer<'w> {
type Target = Components;

fn deref(&self) -> &Components {
self.components
}
}

impl<'w> ComponentInitializer<'w> {
/// Initializes a component of type `T` with this instance.
/// If a component of this type has already been initialized, this will return
/// the ID of the pre-existing component.
///
/// # See also
///
/// * [`Components::component_id()`]
/// * [`Components::init_component_with_descriptor()`]
#[inline]
pub fn init_component<T: Component>(&mut self) -> ComponentId {
self.components.init_component::<T>(self.storages)
}

/// Initializes a component described by `descriptor`.
///
/// ## Note
///
/// If this method is called multiple times with identical descriptors, a distinct `ComponentId`
/// will be created for each one.
///
/// # See also
///
/// * [`Components::component_id()`]
/// * [`Components::init_component()`]
pub fn init_component_with_descriptor(
&mut self,
descriptor: ComponentDescriptor,
) -> ComponentId {
self.components
.init_component_with_descriptor(self.storages, descriptor)
}

/// Initializes a [`Resource`] of type `T` with this instance.
/// If a resource of this type has already been initialized, this will return
/// the ID of the pre-existing resource.
///
/// # See also
///
/// * [`Components::resource_id()`]
#[inline]
pub fn init_resource<T: Resource>(&mut self) -> ComponentId {
self.components.init_resource::<T>()
}

/// Initializes a [non-send resource](crate::system::NonSend) of type `T` with this instance.
/// If a resource of this type has already been initialized, this will return
/// the ID of the pre-existing resource.
#[inline]
pub fn init_non_send<T: Any>(&mut self) -> ComponentId {
self.components.init_non_send::<T>()
}
}

/// A value that tracks when a system ran relative to other systems.
/// This is used to power change detection.
///
Expand Down
14 changes: 6 additions & 8 deletions crates/bevy_ecs/src/query/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@ pub struct QueryBuilder<'w, D: QueryData = (), F: QueryFilter = ()> {
impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F> {
/// Creates a new builder with the accesses required for `Q` and `F`
pub fn new(world: &'w mut World) -> Self {
let initializer = &mut world.component_initializer();
let fetch_state = D::init_state(initializer);
let filter_state = F::init_state(initializer);
let fetch_state = D::init_state(world);
let filter_state = F::init_state(world);

let mut access = FilteredAccess::default();
D::update_component_access(&fetch_state, &mut access);
Expand Down Expand Up @@ -96,7 +95,7 @@ impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F> {

/// Adds accesses required for `T` to self.
pub fn data<T: QueryData>(&mut self) -> &mut Self {
let state = T::init_state(&mut self.world.component_initializer());
let state = T::init_state(self.world);
let mut access = FilteredAccess::default();
T::update_component_access(&state, &mut access);
self.extend_access(access);
Expand All @@ -105,7 +104,7 @@ impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F> {

/// Adds filter from `T` to self.
pub fn filter<T: QueryFilter>(&mut self) -> &mut Self {
let state = T::init_state(&mut self.world.component_initializer());
let state = T::init_state(self.world);
let mut access = FilteredAccess::default();
T::update_component_access(&state, &mut access);
self.extend_access(access);
Expand Down Expand Up @@ -223,9 +222,8 @@ impl<'w, D: QueryData, F: QueryFilter> QueryBuilder<'w, D, F> {
pub fn transmute_filtered<NewD: QueryData, NewF: QueryFilter>(
&mut self,
) -> &mut QueryBuilder<'w, NewD, NewF> {
let initializer = &mut self.world.component_initializer();
let mut fetch_state = NewD::init_state(initializer);
let filter_state = NewF::init_state(initializer);
let mut fetch_state = NewD::init_state(self.world);
let filter_state = NewF::init_state(self.world);

NewD::set_access(&mut fetch_state, &self.access);

Expand Down
54 changes: 27 additions & 27 deletions crates/bevy_ecs/src/query/fetch.rs
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
use crate::{
archetype::{Archetype, Archetypes},
change_detection::{Ticks, TicksMut},
component::{Component, ComponentId, ComponentInitializer, Components, StorageType, Tick},
component::{Component, ComponentId, Components, StorageType, Tick},
entity::{Entities, Entity, EntityLocation},
query::{Access, DebugCheckedUnwrap, FilteredAccess, WorldQuery},
storage::{ComponentSparseSet, Table, TableRow},
world::{
unsafe_world_cell::UnsafeWorldCell, EntityMut, EntityRef, FilteredEntityMut,
FilteredEntityRef, Mut, Ref,
FilteredEntityRef, Mut, Ref, World,
},
};
use bevy_ptr::{ThinSlicePtr, UnsafeCellDeref};
use bevy_utils::all_tuples;
use std::{cell::UnsafeCell, marker::PhantomData};

/// Types that can be fetched from a [`World`](crate::world::World) using a [`Query`].
/// Types that can be fetched from a [`World`] using a [`Query`].
///
/// There are many types that natively implement this trait:
///
Expand Down Expand Up @@ -335,7 +335,7 @@ unsafe impl WorldQuery for Entity {

fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess<ComponentId>) {}

fn init_state(_initializer: &mut ComponentInitializer) {}
fn init_state(_world: &mut World) {}

fn get_state(_components: &Components) -> Option<()> {
Some(())
Expand Down Expand Up @@ -407,7 +407,7 @@ unsafe impl WorldQuery for EntityLocation {

fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess<ComponentId>) {}

fn init_state(_initializer: &mut ComponentInitializer) {}
fn init_state(_world: &mut World) {}

fn get_state(_components: &Components) -> Option<()> {
Some(())
Expand Down Expand Up @@ -486,7 +486,7 @@ unsafe impl<'a> WorldQuery for EntityRef<'a> {
access.read_all();
}

fn init_state(_initializer: &mut ComponentInitializer) {}
fn init_state(_world: &mut World) {}

fn get_state(_components: &Components) -> Option<()> {
Some(())
Expand Down Expand Up @@ -562,7 +562,7 @@ unsafe impl<'a> WorldQuery for EntityMut<'a> {
access.write_all();
}

fn init_state(_initializer: &mut ComponentInitializer) {}
fn init_state(_world: &mut World) {}

fn get_state(_components: &Components) -> Option<()> {
Some(())
Expand Down Expand Up @@ -660,7 +660,7 @@ unsafe impl<'a> WorldQuery for FilteredEntityRef<'a> {
filtered_access.access.extend(&state.access);
}

fn init_state(_initializer: &mut ComponentInitializer) -> Self::State {
fn init_state(_world: &mut World) -> Self::State {
FilteredAccess::default()
}

Expand Down Expand Up @@ -772,7 +772,7 @@ unsafe impl<'a> WorldQuery for FilteredEntityMut<'a> {
filtered_access.access.extend(&state.access);
}

fn init_state(_initializer: &mut ComponentInitializer) -> Self::State {
fn init_state(_world: &mut World) -> Self::State {
FilteredAccess::default()
}

Expand Down Expand Up @@ -846,7 +846,7 @@ unsafe impl WorldQuery for &Archetype {

fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess<ComponentId>) {}

fn init_state(_initializer: &mut ComponentInitializer) {}
fn init_state(_world: &mut World) {}

fn get_state(_components: &Components) -> Option<()> {
Some(())
Expand Down Expand Up @@ -995,8 +995,8 @@ unsafe impl<T: Component> WorldQuery for &T {
access.add_read(component_id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1178,8 +1178,8 @@ unsafe impl<'__w, T: Component> WorldQuery for Ref<'__w, T> {
access.add_read(component_id);
}

fn init_state(initializer: &mut ComponentInitializer<'_>) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1361,8 +1361,8 @@ unsafe impl<'__w, T: Component> WorldQuery for &'__w mut T {
access.add_write(component_id);
}

fn init_state(initializer: &mut ComponentInitializer<'_>) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1460,8 +1460,8 @@ unsafe impl<'__w, T: Component> WorldQuery for Mut<'__w, T> {
}

// Forwarded to `&mut T`
fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
<&mut T as WorldQuery>::init_state(initializer)
fn init_state(world: &mut World) -> ComponentId {
<&mut T as WorldQuery>::init_state(world)
}

// Forwarded to `&mut T`
Expand Down Expand Up @@ -1581,8 +1581,8 @@ unsafe impl<T: WorldQuery> WorldQuery for Option<T> {
access.extend_access(&intermediate);
}

fn init_state(initializer: &mut ComponentInitializer) -> T::State {
T::init_state(initializer)
fn init_state(world: &mut World) -> T::State {
T::init_state(world)
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1736,8 +1736,8 @@ unsafe impl<T: Component> WorldQuery for Has<T> {
access.access_mut().add_archetypal(component_id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1882,8 +1882,8 @@ macro_rules! impl_anytuple_fetch {
*_access = _new_access;
}
#[allow(unused_variables)]
fn init_state(initializer: &mut ComponentInitializer) -> Self::State {
($($name::init_state(initializer),)*)
fn init_state(world: &mut World) -> Self::State {
($($name::init_state(world),)*)
}
#[allow(unused_variables)]
fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -1959,8 +1959,8 @@ unsafe impl<D: QueryData> WorldQuery for NopWorldQuery<D> {

fn update_component_access(_state: &D::State, _access: &mut FilteredAccess<ComponentId>) {}

fn init_state(initializer: &mut ComponentInitializer) -> Self::State {
D::init_state(initializer)
fn init_state(world: &mut World) -> Self::State {
D::init_state(world)
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -2026,7 +2026,7 @@ unsafe impl<T: ?Sized> WorldQuery for PhantomData<T> {

fn update_component_access(_state: &Self::State, _access: &mut FilteredAccess<ComponentId>) {}

fn init_state(_initializer: &mut ComponentInitializer) -> Self::State {}
fn init_state(_world: &mut World) -> Self::State {}

fn get_state(_components: &Components) -> Option<Self::State> {
Some(())
Expand Down
24 changes: 12 additions & 12 deletions crates/bevy_ecs/src/query/filter.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
use crate::{
archetype::Archetype,
component::{Component, ComponentId, ComponentInitializer, Components, StorageType, Tick},
component::{Component, ComponentId, Components, StorageType, Tick},
entity::Entity,
query::{DebugCheckedUnwrap, FilteredAccess, WorldQuery},
storage::{Column, ComponentSparseSet, Table, TableRow},
world::unsafe_world_cell::UnsafeWorldCell,
world::{unsafe_world_cell::UnsafeWorldCell, World},
};
use bevy_ptr::{ThinSlicePtr, UnsafeCellDeref};
use bevy_utils::all_tuples;
Expand Down Expand Up @@ -183,8 +183,8 @@ unsafe impl<T: Component> WorldQuery for With<T> {
access.and_with(id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -291,8 +291,8 @@ unsafe impl<T: Component> WorldQuery for Without<T> {
access.and_without(id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -461,8 +461,8 @@ macro_rules! impl_or_query_filter {
*access = _new_access;
}

fn init_state(initializer: &mut ComponentInitializer) -> Self::State {
($($filter::init_state(initializer),)*)
fn init_state(world: &mut World) -> Self::State {
($($filter::init_state(world),)*)
}

fn get_state(components: &Components) -> Option<Self::State> {
Expand Down Expand Up @@ -693,8 +693,8 @@ unsafe impl<T: Component> WorldQuery for Added<T> {
access.add_read(id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<ComponentId> {
Expand Down Expand Up @@ -904,8 +904,8 @@ unsafe impl<T: Component> WorldQuery for Changed<T> {
access.add_read(id);
}

fn init_state(initializer: &mut ComponentInitializer) -> ComponentId {
initializer.init_component::<T>()
fn init_state(world: &mut World) -> ComponentId {
world.init_component::<T>()
}

fn get_state(components: &Components) -> Option<ComponentId> {
Expand Down
Loading

0 comments on commit 07a8567

Please sign in to comment.