resolve conflicts

bevyengine · Dec 17, 2024 · 3671ee0 · 3671ee0
2 parents ac1faf0 + 00f0623
commit 3671ee0
Show file tree

Hide file tree

Showing 17 changed files with 631 additions and 115 deletions.
diff --git a/crates/bevy_core_pipeline/src/oit/mod.rs b/crates/bevy_core_pipeline/src/oit/mod.rs
@@ -71,10 +71,13 @@ impl Component for OrderIndependentTransparencySettings {
     type Mutability = Mutable;
 
     fn register_component_hooks(hooks: &mut ComponentHooks) {
-        hooks.on_add(|world, entity, _| {
+        hooks.on_add(|world, entity, _, caller| {
             if let Some(value) = world.get::<OrderIndependentTransparencySettings>(entity) {
                 if value.layer_count > 32 {
-                    warn!("OrderIndependentTransparencySettings layer_count set to {} might be too high.", value.layer_count);
+                    warn!("{}OrderIndependentTransparencySettings layer_count set to {} might be too high.", 
+                        caller.map(|location|format!("{location}: ")).unwrap_or_default(),
+                        value.layer_count
+                    );
                 }
             }
         });

diff --git a/crates/bevy_ecs/src/bundle.rs b/crates/bevy_ecs/src/bundle.rs
@@ -1037,12 +1037,16 @@ impl<'w> BundleInserter<'w> {
                         ON_REPLACE,
                         entity,
                         archetype_after_insert.iter_existing(),
+                        #[cfg(feature = "track_change_detection")]
+                        caller,
                     );
                 }
                 deferred_world.trigger_on_replace(
                     archetype,
                     entity,
                     archetype_after_insert.iter_existing(),
+                    #[cfg(feature = "track_change_detection")]
+                    caller,
                 );
             }
         }
@@ -1213,12 +1217,16 @@ impl<'w> BundleInserter<'w> {
                 new_archetype,
                 entity,
                 archetype_after_insert.iter_added(),
+                #[cfg(feature = "track_change_detection")]
+                caller,
             );
             if new_archetype.has_add_observer() {
                 deferred_world.trigger_observers(
                     ON_ADD,
                     entity,
                     archetype_after_insert.iter_added(),
+                    #[cfg(feature = "track_change_detection")]
+                    caller,
                 );
             }
             match insert_mode {
@@ -1228,12 +1236,16 @@ impl<'w> BundleInserter<'w> {
                         new_archetype,
                         entity,
                         archetype_after_insert.iter_inserted(),
+                        #[cfg(feature = "track_change_detection")]
+                        caller,
                     );
                     if new_archetype.has_insert_observer() {
                         deferred_world.trigger_observers(
                             ON_INSERT,
                             entity,
                             archetype_after_insert.iter_inserted(),
+                            #[cfg(feature = "track_change_detection")]
+                            caller,
                         );
                     }
                 }
@@ -1244,12 +1256,16 @@ impl<'w> BundleInserter<'w> {
                         new_archetype,
                         entity,
                         archetype_after_insert.iter_added(),
+                        #[cfg(feature = "track_change_detection")]
+                        caller,
                     );
                     if new_archetype.has_insert_observer() {
                         deferred_world.trigger_observers(
                             ON_INSERT,
                             entity,
                             archetype_after_insert.iter_added(),
+                            #[cfg(feature = "track_change_detection")]
+                            caller,
                         );
                     }
                 }
@@ -1325,6 +1341,7 @@ impl<'w> BundleSpawner<'w> {
     /// # Safety
     /// `entity` must be allocated (but non-existent), `T` must match this [`BundleInfo`]'s type
     #[inline]
+    #[track_caller]
     pub unsafe fn spawn_non_existent<T: DynamicBundle>(
         &mut self,
         entity: Entity,
@@ -1372,24 +1389,32 @@ impl<'w> BundleSpawner<'w> {
                 archetype,
                 entity,
                 bundle_info.iter_contributed_components(),
+                #[cfg(feature = "track_change_detection")]
+                caller,
             );
             if archetype.has_add_observer() {
                 deferred_world.trigger_observers(
                     ON_ADD,
                     entity,
                     bundle_info.iter_contributed_components(),
+                    #[cfg(feature = "track_change_detection")]
+                    caller,
                 );
             }
             deferred_world.trigger_on_insert(
                 archetype,
                 entity,
                 bundle_info.iter_contributed_components(),
+                #[cfg(feature = "track_change_detection")]
+                caller,
             );
             if archetype.has_insert_observer() {
                 deferred_world.trigger_observers(
                     ON_INSERT,
                     entity,
                     bundle_info.iter_contributed_components(),
+                    #[cfg(feature = "track_change_detection")]
+                    caller,
                 );
             }
         };
@@ -1642,6 +1667,7 @@ fn sorted_remove<T: Eq + Ord + Copy>(source: &mut Vec<T>, remove: &[T]) {
 mod tests {
     use crate as bevy_ecs;
     use crate::{component::ComponentId, prelude::*, world::DeferredWorld};
+    use core::panic::Location;
 
     #[derive(Component)]
     struct A;
@@ -1650,19 +1676,39 @@ mod tests {
     #[component(on_add = a_on_add, on_insert = a_on_insert, on_replace = a_on_replace, on_remove = a_on_remove)]
     struct AMacroHooks;
 
-    fn a_on_add(mut world: DeferredWorld, _: Entity, _: ComponentId) {
+    fn a_on_add(
+        mut world: DeferredWorld,
+        _: Entity,
+        _: ComponentId,
+        _: Option<&'static Location<'static>>,
+    ) {
         world.resource_mut::<R>().assert_order(0);
     }
 
-    fn a_on_insert<T1, T2>(mut world: DeferredWorld, _: T1, _: T2) {
+    fn a_on_insert<T1, T2>(
+        mut world: DeferredWorld,
+        _: T1,
+        _: T2,
+        _: Option<&'static Location<'static>>,
+    ) {
         world.resource_mut::<R>().assert_order(1);
     }
 
-    fn a_on_replace<T1, T2>(mut world: DeferredWorld, _: T1, _: T2) {
+    fn a_on_replace<T1, T2>(
+        mut world: DeferredWorld,
+        _: T1,
+        _: T2,
+        _: Option<&'static Location<'static>>,
+    ) {
         world.resource_mut::<R>().assert_order(2);
     }
 
-    fn a_on_remove<T1, T2>(mut world: DeferredWorld, _: T1, _: T2) {
+    fn a_on_remove<T1, T2>(
+        mut world: DeferredWorld,
+        _: T1,
+        _: T2,
+        _: Option<&'static Location<'static>>,
+    ) {
         world.resource_mut::<R>().assert_order(3);
     }
 
@@ -1695,10 +1741,10 @@ mod tests {
         world.init_resource::<R>();
         world
             .register_component_hooks::<A>()
-            .on_add(|mut world, _, _| world.resource_mut::<R>().assert_order(0))
-            .on_insert(|mut world, _, _| world.resource_mut::<R>().assert_order(1))
-            .on_replace(|mut world, _, _| world.resource_mut::<R>().assert_order(2))
-            .on_remove(|mut world, _, _| world.resource_mut::<R>().assert_order(3));
+            .on_add(|mut world, _, _, _| world.resource_mut::<R>().assert_order(0))
+            .on_insert(|mut world, _, _, _| world.resource_mut::<R>().assert_order(1))
+            .on_replace(|mut world, _, _, _| world.resource_mut::<R>().assert_order(2))
+            .on_remove(|mut world, _, _, _| world.resource_mut::<R>().assert_order(3));
 
         let entity = world.spawn(A).id();
         world.despawn(entity);
@@ -1722,10 +1768,10 @@ mod tests {
         world.init_resource::<R>();
         world
             .register_component_hooks::<A>()
-            .on_add(|mut world, _, _| world.resource_mut::<R>().assert_order(0))
-            .on_insert(|mut world, _, _| world.resource_mut::<R>().assert_order(1))
-            .on_replace(|mut world, _, _| world.resource_mut::<R>().assert_order(2))
-            .on_remove(|mut world, _, _| world.resource_mut::<R>().assert_order(3));
+            .on_add(|mut world, _, _, _| world.resource_mut::<R>().assert_order(0))
+            .on_insert(|mut world, _, _, _| world.resource_mut::<R>().assert_order(1))
+            .on_replace(|mut world, _, _, _| world.resource_mut::<R>().assert_order(2))
+            .on_remove(|mut world, _, _, _| world.resource_mut::<R>().assert_order(3));
 
         let mut entity = world.spawn_empty();
         entity.insert(A);
@@ -1739,8 +1785,8 @@ mod tests {
         let mut world = World::new();
         world
             .register_component_hooks::<A>()
-            .on_replace(|mut world, _, _| world.resource_mut::<R>().assert_order(0))
-            .on_insert(|mut world, _, _| {
+            .on_replace(|mut world, _, _, _| world.resource_mut::<R>().assert_order(0))
+            .on_insert(|mut world, _, _, _| {
                 if let Some(mut r) = world.get_resource_mut::<R>() {
                     r.assert_order(1);
                 }
@@ -1761,22 +1807,22 @@ mod tests {
         world.init_resource::<R>();
         world
             .register_component_hooks::<A>()
-            .on_add(|mut world, entity, _| {
+            .on_add(|mut world, entity, _, _| {
                 world.resource_mut::<R>().assert_order(0);
                 world.commands().entity(entity).insert(B);
             })
-            .on_remove(|mut world, entity, _| {
+            .on_remove(|mut world, entity, _, _| {
                 world.resource_mut::<R>().assert_order(2);
                 world.commands().entity(entity).remove::<B>();
             });
 
         world
             .register_component_hooks::<B>()
-            .on_add(|mut world, entity, _| {
+            .on_add(|mut world, entity, _, _| {
                 world.resource_mut::<R>().assert_order(1);
                 world.commands().entity(entity).remove::<A>();
             })
-            .on_remove(|mut world, _, _| {
+            .on_remove(|mut world, _, _, _| {
                 world.resource_mut::<R>().assert_order(3);
             });
 
@@ -1793,27 +1839,27 @@ mod tests {
         world.init_resource::<R>();
         world
             .register_component_hooks::<A>()
-            .on_add(|mut world, entity, _| {
+            .on_add(|mut world, entity, _, _| {
                 world.resource_mut::<R>().assert_order(0);
                 world.commands().entity(entity).insert(B).insert(C);
             });
 
         world
             .register_component_hooks::<B>()
-            .on_add(|mut world, entity, _| {
+            .on_add(|mut world, entity, _, _| {
                 world.resource_mut::<R>().assert_order(1);
                 world.commands().entity(entity).insert(D);
             });
 
         world
             .register_component_hooks::<C>()
-            .on_add(|mut world, _, _| {
+            .on_add(|mut world, _, _, _| {
                 world.resource_mut::<R>().assert_order(3);
             });
 
         world
             .register_component_hooks::<D>()
-            .on_add(|mut world, _, _| {
+            .on_add(|mut world, _, _, _| {
                 world.resource_mut::<R>().assert_order(2);
             });
 

diff --git a/crates/bevy_ecs/src/component.rs b/crates/bevy_ecs/src/component.rs
@@ -17,15 +17,14 @@ use bevy_ptr::{OwningPtr, UnsafeCellDeref};
 #[cfg(feature = "bevy_reflect")]
 use bevy_reflect::Reflect;
 use bevy_utils::{HashMap, HashSet, TypeIdMap};
-#[cfg(feature = "track_change_detection")]
-use core::panic::Location;
 use core::{
     alloc::Layout,
     any::{Any, TypeId},
     cell::UnsafeCell,
     fmt::Debug,
     marker::PhantomData,
     mem::needs_drop,
+    panic::Location,
 };
 use disqualified::ShortName;
 use thiserror::Error;
@@ -300,6 +299,7 @@ pub use bevy_ecs_macros::require;
 /// # use bevy_ecs::world::DeferredWorld;
 /// # use bevy_ecs::entity::Entity;
 /// # use bevy_ecs::component::ComponentId;
+/// # use core::panic::Location;
 /// #
 /// #[derive(Component)]
 /// #[component(on_add = my_on_add_hook)]
@@ -311,12 +311,12 @@ pub use bevy_ecs_macros::require;
 /// // #[component(on_replace = my_on_replace_hook, on_remove = my_on_remove_hook)]
 /// struct ComponentA;
 ///
-/// fn my_on_add_hook(world: DeferredWorld, entity: Entity, id: ComponentId) {
+/// fn my_on_add_hook(world: DeferredWorld, entity: Entity, id: ComponentId, caller: Option<&'static Location<'static>>) {
 ///     // ...
 /// }
 ///
 /// // You can also omit writing some types using generics.
-/// fn my_on_insert_hook<T1, T2>(world: DeferredWorld, _: T1, _: T2) {
+/// fn my_on_insert_hook<T1, T2>(world: DeferredWorld, _: T1, _: T2, caller: Option<&'static Location<'static>>) {
 ///     // ...
 /// }
 /// ```
@@ -493,8 +493,10 @@ pub enum StorageType {
     SparseSet,
 }
 
-/// The type used for [`Component`] lifecycle hooks such as `on_add`, `on_insert` or `on_remove`
-pub type ComponentHook = for<'w> fn(DeferredWorld<'w>, Entity, ComponentId);
+/// The type used for [`Component`] lifecycle hooks such as `on_add`, `on_insert` or `on_remove`.
+/// The caller location is `Some` if the `track_change_detection` feature is enabled.
+pub type ComponentHook =
+    for<'w> fn(DeferredWorld<'w>, Entity, ComponentId, Option<&'static Location<'static>>);
 
 /// [`World`]-mutating functions that run as part of lifecycle events of a [`Component`].
 ///
@@ -531,12 +533,12 @@ pub type ComponentHook = for<'w> fn(DeferredWorld<'w>, Entity, ComponentId);
 /// let mut tracked_component_query = world.query::<&MyTrackedComponent>();
 /// assert!(tracked_component_query.iter(&world).next().is_none());
 ///
-/// world.register_component_hooks::<MyTrackedComponent>().on_add(|mut world, entity, _component_id| {
+/// world.register_component_hooks::<MyTrackedComponent>().on_add(|mut world, entity, _component_id, _caller| {
 ///    let mut tracked_entities = world.resource_mut::<TrackedEntities>();
 ///   tracked_entities.0.insert(entity);
 /// });
 ///
-/// world.register_component_hooks::<MyTrackedComponent>().on_remove(|mut world, entity, _component_id| {
+/// world.register_component_hooks::<MyTrackedComponent>().on_remove(|mut world, entity, _component_id, _caller| {
 ///   let mut tracked_entities = world.resource_mut::<TrackedEntities>();
 ///   tracked_entities.0.remove(&entity);
 /// });

diff --git a/crates/bevy_ecs/src/lib.rs b/crates/bevy_ecs/src/lib.rs
@@ -1983,8 +1983,8 @@ mod tests {
         world.insert_resource(I(0));
         world
             .register_component_hooks::<Y>()
-            .on_add(|mut world, _, _| world.resource_mut::<A>().0 += 1)
-            .on_insert(|mut world, _, _| world.resource_mut::<I>().0 += 1);
+            .on_add(|mut world, _, _, _| world.resource_mut::<A>().0 += 1)
+            .on_insert(|mut world, _, _, _| world.resource_mut::<I>().0 += 1);
 
         // Spawn entity and ensure Y was added
         assert!(world.spawn(X).contains::<Y>());
@@ -2013,8 +2013,8 @@ mod tests {
         world.insert_resource(I(0));
         world
             .register_component_hooks::<Y>()
-            .on_add(|mut world, _, _| world.resource_mut::<A>().0 += 1)
-            .on_insert(|mut world, _, _| world.resource_mut::<I>().0 += 1);
+            .on_add(|mut world, _, _, _| world.resource_mut::<A>().0 += 1)
+            .on_insert(|mut world, _, _, _| world.resource_mut::<I>().0 += 1);
 
         // Spawn entity and ensure Y was added
         assert!(world.spawn_empty().insert(X).contains::<Y>());

diff --git a/crates/bevy_ecs/src/observer/entity_observer.rs b/crates/bevy_ecs/src/observer/entity_observer.rs
@@ -14,7 +14,7 @@ impl Component for ObservedBy {
     type Mutability = Mutable;
 
     fn register_component_hooks(hooks: &mut ComponentHooks) {
-        hooks.on_remove(|mut world, entity, _| {
+        hooks.on_remove(|mut world, entity, _, _| {
             let observed_by = {
                 let mut component = world.get_mut::<ObservedBy>(entity).unwrap();
                 core::mem::take(&mut component.0)