[Merged by Bors] - Implement `WorldQuery` derive macro #2713

vladbat00 · 2021-08-22T21:50:47Z

Objective

This PR implements a derive macro that allows users to define their queries as structs with named fields.

Example

#[derive(WorldQuery)]
#[world_query(derive(Debug))]
struct NumQuery<'w, T: Component, P: Component> {
    entity: Entity,
    u: UNumQuery<'w>,
    generic: GenericQuery<'w, T, P>,
}

#[derive(WorldQuery)]
#[world_query(derive(Debug))]
struct UNumQuery<'w> {
    u_16: &'w u16,
    u_32_opt: Option<&'w u32>,
}

#[derive(WorldQuery)]
#[world_query(derive(Debug))]
struct GenericQuery<'w, T: Component, P: Component> {
    generic: (&'w T, &'w P),
}

#[derive(WorldQuery)]
#[world_query(filter)]
struct NumQueryFilter<T: Component, P: Component> {
    _u_16: With<u16>,
    _u_32: With<u32>,
    _or: Or<(With<i16>, Changed<u16>, Added<u32>)>,
    _generic_tuple: (With<T>, With<P>),
    _without: Without<Option<u16>>,
    _tp: PhantomData<(T, P)>,
}

fn print_nums_readonly(query: Query<NumQuery<u64, i64>, NumQueryFilter<u64, i64>>) {
    for num in query.iter() {
        println!("{:#?}", num);
    }
}

#[derive(WorldQuery)]
#[world_query(mutable, derive(Debug))]
struct MutNumQuery<'w, T: Component, P: Component> {
    i_16: &'w mut i16,
    i_32_opt: Option<&'w mut i32>,
}

fn print_nums(mut query: Query<MutNumQuery, NumQueryFilter<u64, i64>>) {
    for num in query.iter_mut() {
        println!("{:#?}", num);
    }
}

TODOs:

crates/bevy_ecs/src/query/fetch.rs

crates/bevy_ecs/macros/src/lib.rs

crates/bevy_ecs/src/query/fetch.rs

examples/README.md

examples/ecs/fetch.rs

vladbat00 · 2022-02-07T23:20:33Z

Thanks for gist! I'll try to finish it. I've also noticed that you commented out the dead_code workaround, just wanted to clarify: did you comment it out cause it got broken or did you try to get rid of it completely?

cart · 2022-02-07T23:35:32Z

I was planning on testing whether it was still necessary under the new impl. It feels like we shouldn't need it, given that we're using the same pattern as the built in Fetch impls.

vladbat00 · 2022-02-09T22:43:29Z

@cart done. I was even able to get rid of the TODO that I had previously left for the ReadOnly impl.
The dead_code workaround is still needed though, as original struct's fields are never read by anything (the Item types are used by the user's code instead).

crates/bevy_ecs/macros/src/fetch.rs

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

…_filter

Co-authored-by: MinerSebas <66798382+MinerSebas@users.noreply.github.com>

cart · 2022-02-24T00:19:20Z

Looks good to me! Fantastic work!

cart · 2022-02-24T00:19:31Z

bors r+

# Objective - Closes #786 - Closes #2252 - Closes #2588 This PR implements a derive macro that allows users to define their queries as structs with named fields. ## Example ```rust #[derive(WorldQuery)] #[world_query(derive(Debug))] struct NumQuery<'w, T: Component, P: Component> { entity: Entity, u: UNumQuery<'w>, generic: GenericQuery<'w, T, P>, } #[derive(WorldQuery)] #[world_query(derive(Debug))] struct UNumQuery<'w> { u_16: &'w u16, u_32_opt: Option<&'w u32>, } #[derive(WorldQuery)] #[world_query(derive(Debug))] struct GenericQuery<'w, T: Component, P: Component> { generic: (&'w T, &'w P), } #[derive(WorldQuery)] #[world_query(filter)] struct NumQueryFilter<T: Component, P: Component> { _u_16: With<u16>, _u_32: With<u32>, _or: Or<(With<i16>, Changed<u16>, Added<u32>)>, _generic_tuple: (With<T>, With<P>), _without: Without<Option<u16>>, _tp: PhantomData<(T, P)>, } fn print_nums_readonly(query: Query<NumQuery<u64, i64>, NumQueryFilter<u64, i64>>) { for num in query.iter() { println!("{:#?}", num); } } #[derive(WorldQuery)] #[world_query(mutable, derive(Debug))] struct MutNumQuery<'w, T: Component, P: Component> { i_16: &'w mut i16, i_32_opt: Option<&'w mut i32>, } fn print_nums(mut query: Query<MutNumQuery, NumQueryFilter<u64, i64>>) { for num in query.iter_mut() { println!("{:#?}", num); } } ``` ## TODOs: - [x] Add support for `&T` and `&mut T` - [x] Test - [x] Add support for optional types - [x] Test - [x] Add support for `Entity` - [x] Test - [x] Add support for nested `WorldQuery` - [x] Test - [x] Add support for tuples - [x] Test - [x] Add support for generics - [x] Test - [x] Add support for query filters - [x] Test - [x] Add support for `PhantomData` - [x] Test - [x] Refactor `read_world_query_field_type_info` - [x] Properly document `readonly` attribute for nested queries and the static assertions that guarantee safety - [x] Test that we never implement `ReadOnlyFetch` for types that need mutable access - [x] Test that we insert static assertions for nested `WorldQuery` that a user marked as readonly

bors · 2022-02-24T00:40:17Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Closes bevyengine#786 - Closes bevyengine#2252 - Closes bevyengine#2588 This PR implements a derive macro that allows users to define their queries as structs with named fields. ## Example ```rust #[derive(WorldQuery)] #[world_query(derive(Debug))] struct NumQuery<'w, T: Component, P: Component> { entity: Entity, u: UNumQuery<'w>, generic: GenericQuery<'w, T, P>, } #[derive(WorldQuery)] #[world_query(derive(Debug))] struct UNumQuery<'w> { u_16: &'w u16, u_32_opt: Option<&'w u32>, } #[derive(WorldQuery)] #[world_query(derive(Debug))] struct GenericQuery<'w, T: Component, P: Component> { generic: (&'w T, &'w P), } #[derive(WorldQuery)] #[world_query(filter)] struct NumQueryFilter<T: Component, P: Component> { _u_16: With<u16>, _u_32: With<u32>, _or: Or<(With<i16>, Changed<u16>, Added<u32>)>, _generic_tuple: (With<T>, With<P>), _without: Without<Option<u16>>, _tp: PhantomData<(T, P)>, } fn print_nums_readonly(query: Query<NumQuery<u64, i64>, NumQueryFilter<u64, i64>>) { for num in query.iter() { println!("{:#?}", num); } } #[derive(WorldQuery)] #[world_query(mutable, derive(Debug))] struct MutNumQuery<'w, T: Component, P: Component> { i_16: &'w mut i16, i_32_opt: Option<&'w mut i32>, } fn print_nums(mut query: Query<MutNumQuery, NumQueryFilter<u64, i64>>) { for num in query.iter_mut() { println!("{:#?}", num); } } ``` ## TODOs: - [x] Add support for `&T` and `&mut T` - [x] Test - [x] Add support for optional types - [x] Test - [x] Add support for `Entity` - [x] Test - [x] Add support for nested `WorldQuery` - [x] Test - [x] Add support for tuples - [x] Test - [x] Add support for generics - [x] Test - [x] Add support for query filters - [x] Test - [x] Add support for `PhantomData` - [x] Test - [x] Refactor `read_world_query_field_type_info` - [x] Properly document `readonly` attribute for nested queries and the static assertions that guarantee safety - [x] Test that we never implement `ReadOnlyFetch` for types that need mutable access - [x] Test that we insert static assertions for nested `WorldQuery` that a user marked as readonly

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Aug 22, 2021

alice-i-cecile reviewed Aug 22, 2021

View reviewed changes

crates/bevy_ecs/src/query/fetch.rs Show resolved Hide resolved

vladbat00 force-pushed the derive-world-query branch 3 times, most recently from 248296b to 6add635 Compare August 23, 2021 19:26

vladbat00 changed the title ~~Implement WorldQuery derive macro~~ Implement Fetch and FetchFilter derive macros Aug 23, 2021

vladbat00 changed the title ~~Implement Fetch and FetchFilter derive macros~~ Implement Fetch and FilterFetch derive macros Aug 23, 2021

vladbat00 force-pushed the derive-world-query branch 2 times, most recently from 02312ef to 30a3891 Compare August 23, 2021 20:19

vladbat00 marked this pull request as ready for review August 23, 2021 20:19