1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
use core::{any::TypeId, hash::Hash};
use std::{boxed::Box, vec::Vec};

use crate::{Archetype, World};
use bevy_utils::HashSet;

#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub enum Access {
    None,
    Read,
    Write,
}

#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct ArchetypeComponent {
    pub archetype_index: u32,
    pub component: TypeId,
}

impl ArchetypeComponent {
    #[inline]
    pub fn new<T: 'static>(archetype_index: u32) -> Self {
        ArchetypeComponent {
            archetype_index,
            component: TypeId::of::<T>(),
        }
    }

    #[inline]
    pub fn new_ty(archetype_index: u32, component: TypeId) -> Self {
        ArchetypeComponent {
            archetype_index,
            component,
        }
    }
}

pub enum QueryAccess {
    None,
    Read(TypeId, &'static str),
    Write(TypeId, &'static str),
    Optional(Box<QueryAccess>),
    With(TypeId, Box<QueryAccess>),
    Without(TypeId, Box<QueryAccess>),
    Union(Vec<QueryAccess>),
}

impl QueryAccess {
    pub fn read<T: 'static>() -> QueryAccess {
        QueryAccess::Read(TypeId::of::<T>(), std::any::type_name::<T>())
    }

    pub fn write<T: 'static>() -> QueryAccess {
        QueryAccess::Write(TypeId::of::<T>(), std::any::type_name::<T>())
    }

    pub fn with<T: 'static>(access: QueryAccess) -> QueryAccess {
        QueryAccess::With(TypeId::of::<T>(), Box::new(access))
    }

    pub fn without<T: 'static>(access: QueryAccess) -> QueryAccess {
        QueryAccess::Without(TypeId::of::<T>(), Box::new(access))
    }

    pub fn optional(access: QueryAccess) -> QueryAccess {
        QueryAccess::Optional(Box::new(access))
    }

    pub fn union(accesses: Vec<QueryAccess>) -> QueryAccess {
        QueryAccess::Union(accesses)
    }

    pub fn get_world_archetype_access(
        &self,
        world: &World,
        mut type_access: Option<&mut TypeAccess<ArchetypeComponent>>,
    ) {
        let archetypes = world.archetypes();
        for (i, archetype) in archetypes.enumerate() {
            let type_access = type_access.as_deref_mut();
            let _ = self.get_access(archetype, i as u32, type_access);
        }
    }

    pub fn get_type_name(&self, type_id: TypeId) -> Option<&'static str> {
        match self {
            QueryAccess::None => None,
            QueryAccess::Read(current_type_id, name) => {
                if type_id == *current_type_id {
                    Some(*name)
                } else {
                    None
                }
            }
            QueryAccess::Write(current_type_id, name) => {
                if type_id == *current_type_id {
                    Some(*name)
                } else {
                    None
                }
            }
            QueryAccess::Optional(query_access) => query_access.get_type_name(type_id),
            QueryAccess::With(_, query_access) => query_access.get_type_name(type_id),
            QueryAccess::Without(_, query_access) => query_access.get_type_name(type_id),
            QueryAccess::Union(query_accesses) => {
                for query_access in query_accesses.iter() {
                    if let Some(name) = query_access.get_type_name(type_id) {
                        return Some(name);
                    }
                }

                None
            }
        }
    }

    /// Returns how this [QueryAccess] accesses the given `archetype`.
    /// If `type_access` is set, it will populate type access with the types this query reads/writes
    pub fn get_access(
        &self,
        archetype: &Archetype,
        archetype_index: u32,
        type_access: Option<&mut TypeAccess<ArchetypeComponent>>,
    ) -> Option<Access> {
        match self {
            QueryAccess::None => Some(Access::None),
            QueryAccess::Read(ty, _) => {
                if archetype.has_type(*ty) {
                    if let Some(type_access) = type_access {
                        type_access.add_read(ArchetypeComponent::new_ty(archetype_index, *ty));
                    }
                    Some(Access::Read)
                } else {
                    None
                }
            }
            QueryAccess::Write(ty, _) => {
                if archetype.has_type(*ty) {
                    if let Some(type_access) = type_access {
                        type_access.add_write(ArchetypeComponent::new_ty(archetype_index, *ty));
                    }
                    Some(Access::Write)
                } else {
                    None
                }
            }
            QueryAccess::Optional(query_access) => {
                if let Some(access) = query_access.get_access(archetype, archetype_index, None) {
                    // only re-run get_archetype_access if we need to set type_access
                    if type_access.is_some() {
                        query_access.get_access(archetype, archetype_index, type_access)
                    } else {
                        Some(access)
                    }
                } else {
                    Some(Access::Read)
                }
            }
            QueryAccess::With(ty, query_access) => {
                if archetype.has_type(*ty) {
                    query_access.get_access(archetype, archetype_index, type_access)
                } else {
                    None
                }
            }
            QueryAccess::Without(ty, query_access) => {
                if !archetype.has_type(*ty) {
                    query_access.get_access(archetype, archetype_index, type_access)
                } else {
                    None
                }
            }
            QueryAccess::Union(query_accesses) => {
                let mut result = None;
                for query_access in query_accesses {
                    if let Some(access) = query_access.get_access(archetype, archetype_index, None)
                    {
                        result = Some(result.unwrap_or(Access::Read).max(access));
                    } else {
                        return None;
                    }
                }

                // only set the type access if there is a full match
                if let Some(type_access) = type_access {
                    if result.is_some() {
                        for query_access in query_accesses {
                            query_access.get_access(archetype, archetype_index, Some(type_access));
                        }
                    }
                }

                result
            }
        }
    }
}

/// Provides information about the types a [System] reads and writes
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct TypeAccess<T: Hash + Eq + PartialEq> {
    reads_and_writes: HashSet<T>,
    writes: HashSet<T>,
    reads: HashSet<T>,
}

impl<T: Hash + Eq + PartialEq> Default for TypeAccess<T> {
    fn default() -> Self {
        Self {
            reads_and_writes: Default::default(),
            writes: Default::default(),
            reads: Default::default(),
        }
    }
}

impl<T: Hash + Eq + PartialEq + Copy> TypeAccess<T> {
    pub fn new(reads: Vec<T>, writes: Vec<T>) -> Self {
        let mut type_access = TypeAccess::default();
        for write in writes {
            type_access.add_write(write);
        }

        for read in reads {
            type_access.add_read(read);
        }

        type_access
    }

    pub fn is_compatible(&self, other: &TypeAccess<T>) -> bool {
        self.writes.is_disjoint(&other.reads_and_writes)
            && self.reads_and_writes.is_disjoint(&other.writes)
    }

    pub fn get_conflict<'a>(&'a self, other: &'a TypeAccess<T>) -> Option<&'a T> {
        let conflict = self.writes.intersection(&other.reads_and_writes).next();
        if conflict.is_some() {
            return conflict;
        }
        self.reads_and_writes.intersection(&other.writes).next()
    }

    pub fn union(&mut self, other: &TypeAccess<T>) {
        self.writes.extend(&other.writes);
        self.reads.extend(&other.reads);
        self.reads_and_writes.extend(&other.reads_and_writes);
    }

    pub fn add_read(&mut self, ty: T) {
        self.reads_and_writes.insert(ty);
        self.reads.insert(ty);
    }

    pub fn add_write(&mut self, ty: T) {
        self.reads_and_writes.insert(ty);
        self.writes.insert(ty);
    }

    pub fn clear(&mut self) {
        self.reads_and_writes.clear();
        self.reads.clear();
        self.writes.clear();
    }

    pub fn is_read_or_write(&self, ty: &T) -> bool {
        self.reads_and_writes.contains(ty)
    }

    pub fn is_write(&self, ty: &T) -> bool {
        self.writes.contains(ty)
    }

    pub fn iter_reads(&self) -> impl Iterator<Item = &T> {
        self.reads.iter()
    }

    pub fn iter_writes(&self) -> impl Iterator<Item = &T> {
        self.writes.iter()
    }
}

#[cfg(test)]
mod tests {
    use crate::{ArchetypeComponent, Entity, Fetch, Query, TypeAccess, With, World};
    use std::vec;

    struct A;
    struct B;
    struct C;

    #[test]
    fn query_type_access() {
        let mut world = World::default();
        let e1 = world.spawn((A,));
        let e2 = world.spawn((A, B));
        let e3 = world.spawn((A, B, C));

        let e1_archetype = world.get_entity_location(e1).unwrap().archetype;
        let e2_archetype = world.get_entity_location(e2).unwrap().archetype;
        let e3_archetype = world.get_entity_location(e3).unwrap().archetype;

        let e1_a = ArchetypeComponent::new::<A>(e1_archetype);
        let e2_a = ArchetypeComponent::new::<A>(e2_archetype);
        let e2_b = ArchetypeComponent::new::<B>(e2_archetype);
        let e3_a = ArchetypeComponent::new::<A>(e3_archetype);
        let e3_b = ArchetypeComponent::new::<B>(e3_archetype);
        let e3_c = ArchetypeComponent::new::<C>(e3_archetype);

        let mut a_type_access = TypeAccess::default();
        <(&A,) as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_type_access));

        assert_eq!(
            a_type_access,
            TypeAccess::new(vec![e1_a, e2_a, e3_a], vec![])
        );

        let mut a_b_type_access = TypeAccess::default();
        <(&A, &B) as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_b_type_access));

        assert_eq!(
            a_b_type_access,
            TypeAccess::new(vec![e2_a, e2_b, e3_a, e3_b], vec![])
        );

        let mut a_bmut_type_access = TypeAccess::default();
        <(&A, &mut B) as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_bmut_type_access));

        assert_eq!(
            a_bmut_type_access,
            TypeAccess::new(vec![e2_a, e3_a], vec![e2_b, e3_b])
        );

        let mut a_option_bmut_type_access = TypeAccess::default();
        <(Entity, &A, Option<&mut B>) as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_option_bmut_type_access));

        assert_eq!(
            a_option_bmut_type_access,
            TypeAccess::new(vec![e1_a, e2_a, e3_a], vec![e2_b, e3_b])
        );

        let mut a_with_b_type_access = TypeAccess::default();
        <With<B, &A> as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_with_b_type_access));

        assert_eq!(
            a_with_b_type_access,
            TypeAccess::new(vec![e2_a, e3_a], vec![])
        );

        let mut a_with_b_option_c_type_access = TypeAccess::default();
        <With<B, (&A, Option<&mut C>)> as Query>::Fetch::access()
            .get_world_archetype_access(&world, Some(&mut a_with_b_option_c_type_access));

        assert_eq!(
            a_with_b_option_c_type_access,
            TypeAccess::new(vec![e2_a, e3_a], vec![e3_c])
        );
    }
}