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.

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

Jump to bottom

Pass target location through System::run. #14

Merged
merged 1 commit into from
Feb 13, 2024
Merged

Pass target location through System::run. #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions evenio_macros/src/system_param.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ pub(crate) fn derive_system_param(input: TokenStream) -> Result<TokenStream> {
state,
info,
event_ptr,
target_location,
world
);

Expand All @@ -81,6 +82,7 @@ pub(crate) fn derive_system_param(input: TokenStream) -> Result<TokenStream> {
state,
info,
event_ptr,
target_location,
world
);

Expand Down Expand Up @@ -130,6 +132,7 @@ pub(crate) fn derive_system_param(input: TokenStream) -> Result<TokenStream> {
state: &'__a mut Self::State,
info: &'__a ::evenio::system::SystemInfo,
event_ptr: ::evenio::event::EventPtr<'__a>,
target_location: ::evenio::entity::EntityLocation,
world: ::evenio::world::UnsafeWorldCell<'__a>,
) -> Self::Item<'__a> {
#get_body
Expand Down
6 changes: 6 additions & 0 deletions src/archetype.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,7 @@ unsafe impl SystemParam for &'_ Archetypes {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
world.archetypes()
Expand Down Expand Up @@ -529,6 +530,11 @@ unsafe impl SparseIndex for ArchetypeIdx {
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
pub struct ArchetypeRow(pub u32);

impl ArchetypeRow {
/// The archetype row that is always invalid.
pub const NULL: Self = Self(u32::MAX);
}

/// A container for all entities with a particular set of components.
///
/// Each component has a corresponding columnm of contiguous data in
Expand Down
2 changes: 2 additions & 0 deletions src/component.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ pub use evenio_macros::Component;
use crate::archetype::Archetype;
use crate::assert::UnwrapDebugChecked;
use crate::drop::DropFn;
use crate::entity::EntityLocation;
use crate::event::{Event, EventId, EventPtr};
use crate::map::{Entry, TypeIdMap};
use crate::prelude::World;
Expand Down Expand Up @@ -179,6 +180,7 @@ unsafe impl SystemParam for &'_ Components {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
world.components()
Expand Down
9 changes: 9 additions & 0 deletions src/entity.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ unsafe impl SystemParam for &'_ Entities {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
world.entities()
Expand All @@ -137,6 +138,14 @@ pub struct EntityLocation {
pub row: ArchetypeRow,
}

impl EntityLocation {
/// A location which is always invalid.
pub(crate) const NULL: Self = Self {
archetype: ArchetypeIdx::NULL,
row: ArchetypeRow::NULL,
};
}

/// Lightweight identifier for an entity.
///
/// Entity identifiers are implemented using an [index] and a generation count.
Expand Down
59 changes: 41 additions & 18 deletions src/event.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use crate::assert::{
};
use crate::component::ComponentIdx;
use crate::drop::DropFn;
use crate::entity::EntityId;
use crate::entity::{EntityId, EntityLocation};
use crate::fetch::FetcherState;
use crate::map::{Entry, TypeIdMap};
use crate::prelude::Component;
Expand Down Expand Up @@ -222,6 +222,7 @@ unsafe impl SystemParam for &'_ Events {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
world.events()
Expand Down Expand Up @@ -869,6 +870,7 @@ unsafe impl<E: Event> SystemParam for Receiver<'_, E> {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
_world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
Receiver {
Expand Down Expand Up @@ -921,16 +923,15 @@ unsafe impl<E: Event, Q: Query + 'static> SystemParam for Receiver<'_, E, Q> {
state: &'a mut Self::State,
_info: &'a SystemInfo,
event_ptr: EventPtr<'a>,
world: UnsafeWorldCell<'a>,
target_location: EntityLocation,
_world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
assert!(E::IS_TARGETED);

let event = event_ptr.as_ptr().cast::<E>().as_ref();
let target = event.target();

// SAFETY: The target entity is guaranteed to match the query.
let query = state
.get_mut(world.entities(), target)
.unwrap_debug_checked();
// SAFETY: Caller guarantees the target entity matches the query.
let query = state.get_by_location_mut(target_location);

Receiver { event, query }
}
Expand Down Expand Up @@ -988,6 +989,7 @@ unsafe impl<E: Event> SystemParam for ReceiverMut<'_, E> {
_state: &'a mut Self::State,
_info: &'a SystemInfo,
event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
_world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
ReceiverMut {
Expand Down Expand Up @@ -1038,17 +1040,15 @@ unsafe impl<E: Event, Q: Query + 'static> SystemParam for ReceiverMut<'_, E, Q>
state: &'a mut Self::State,
_info: &'a SystemInfo,
event_ptr: EventPtr<'a>,
world: UnsafeWorldCell<'a>,
target_location: EntityLocation,
_world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
assert!(E::IS_TARGETED);

let event = EventMut::<E>::new(event_ptr);
let target = event.target();

// SAFETY: The target entity is guaranteed to match the query.
let query = state
.get_mut(world.entities(), target)
.unwrap_debug_checked();
// SAFETY: Caller guarantees the target entity matches the query.
let query = state.get_by_location_mut(target_location);

ReceiverMut { event, query }
}
Expand Down Expand Up @@ -1305,6 +1305,7 @@ unsafe impl<T: EventSet> SystemParam for Sender<'_, T> {
state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
Sender { state, world }
Expand Down Expand Up @@ -1378,14 +1379,14 @@ unsafe impl<E: Event> EventSet for E {

macro_rules! impl_event_set_tuple {
($(($E:ident, $e:ident)),*) => {
#[allow(clippy::unused_unit)]
#[allow(unused_variables, clippy::unused_unit)]
unsafe impl<$($E: EventSet),*> EventSet for ($($E,)*) {
type EventIndices = ($($E::EventIndices,)*);

fn new_state(_world: &mut World) -> Self::EventIndices {
fn new_state(world: &mut World) -> Self::EventIndices {
(
$(
$E::new_state(_world),
$E::new_state(world),
)*
)
}
Expand All @@ -1401,9 +1402,9 @@ macro_rules! impl_event_set_tuple {
None
}

fn for_each_idx<F: FnMut(EventIdx)>(($($e,)*): &Self::EventIndices, mut _f: F) {
fn for_each_idx<F: FnMut(EventIdx)>(($($e,)*): &Self::EventIndices, #[allow(unused_mut)] mut f: F) {
$(
$E::for_each_idx($e, &mut _f);
$E::for_each_idx($e, &mut f);
)*
}
}
Expand Down Expand Up @@ -1656,4 +1657,26 @@ mod tests {
let Result(values) = world.get_component_mut::<Result>(e).unwrap();
assert_eq!(values, &[1, 2, 3]);
}

#[test]
fn change_event_target() {
let mut world = World::new();

#[derive(Event)]
struct E(#[event(target)] EntityId);

#[derive(Component)]
struct C;

world.add_system(|mut r: ReceiverMut<E, &C>| {
r.event.0 = EntityId::NULL;
});

world.add_system(|_: Receiver<E, &C>| {});

let e = world.spawn();
world.insert(e, C);

world.send(E(e));
}
}
18 changes: 15 additions & 3 deletions src/fetch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use core::{any, fmt};

use crate::archetype::{Archetype, ArchetypeIdx, ArchetypeRow, Archetypes};
use crate::assert::{assume_debug_checked, UnwrapDebugChecked};
use crate::entity::{Entities, EntityId};
use crate::entity::{Entities, EntityId, EntityLocation};
use crate::event::EventPtr;
use crate::query::{Query, ReadOnlyQuery};
use crate::sparse_map::SparseMap;
Expand Down Expand Up @@ -64,7 +64,7 @@ impl<Q: Query> FetcherState<Q> {
return Err(GetError::NoSuchEntity);
};

// Eliminate a panicking branch.
// Eliminate a branch in `SparseMap::get`.
assume_debug_checked(loc.archetype != ArchetypeIdx::NULL);

let Some(state) = self.map.get(loc.archetype) else {
Expand Down Expand Up @@ -97,6 +97,15 @@ impl<Q: Query> FetcherState<Q> {
Ok(Q::get(state, loc.row))
}

#[inline]
pub(crate) unsafe fn get_by_location_mut(&mut self, loc: EntityLocation) -> Q::Item<'_> {
let state = self
.map
.get(loc.archetype)
.expect_debug_checked("invalid entity location");
Q::get(state, loc.row)
}

// TODO: get_many_mut

#[inline]
Expand Down Expand Up @@ -316,6 +325,7 @@ where
state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
Fetcher { state, world }
Expand Down Expand Up @@ -375,9 +385,10 @@ unsafe impl<Q: Query + 'static> SystemParam for Single<'_, Q> {
state: &'a mut Self::State,
info: &'a SystemInfo,
event_ptr: EventPtr<'a>,
target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
match TrySingle::get(state, info, event_ptr, world) {
match TrySingle::get(state, info, event_ptr, target_location, world) {
TrySingle(Ok(item)) => Single(item),
TrySingle(Err(e)) => {
panic!(
Expand Down Expand Up @@ -417,6 +428,7 @@ unsafe impl<Q: Query + 'static> SystemParam for TrySingle<'_, Q> {
state: &'a mut Self::State,
_info: &'a SystemInfo,
_event_ptr: EventPtr<'a>,
_target_location: EntityLocation,
world: UnsafeWorldCell<'a>,
) -> Self::Item<'a> {
let mut it = state.iter_mut(world.archetypes());
Expand Down
Loading
Loading