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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use std::{marker::PhantomData, rc::Rc};

use crate::prelude::*;

use super::untyped::UntypedComponentStore;

/// A typed wrapper around [`UntypedComponentStore`].
#[derive(Clone)]
#[repr(transparent)]
pub struct ComponentStore<T: HasSchema> {
    untyped: UntypedComponentStore,
    _phantom: PhantomData<T>,
}

impl<T: HasSchema> Default for ComponentStore<T> {
    fn default() -> Self {
        Self {
            untyped: UntypedComponentStore::for_type::<T>(),
            _phantom: PhantomData,
        }
    }
}

impl<T: HasSchema> TryFrom<UntypedComponentStore> for ComponentStore<T> {
    type Error = SchemaMismatchError;

    fn try_from(untyped: UntypedComponentStore) -> Result<Self, Self::Error> {
        if untyped.schema == T::schema() {
            Ok(Self {
                untyped,
                _phantom: PhantomData,
            })
        } else {
            Err(SchemaMismatchError)
        }
    }
}

impl<T: HasSchema> ComponentStore<T> {
    /// Converts to the internal, untyped [`ComponentStore`].
    #[inline]
    pub fn into_untyped(self) -> UntypedComponentStore {
        self.untyped
    }

    /// Creates a [`ComponentStore`] from an [`UntypedComponentStore`].
    /// # Panics
    /// Panics if the schema doesn't match `T`.
    #[track_caller]
    pub fn from_untyped(untyped: UntypedComponentStore) -> Self {
        untyped.try_into().unwrap()
    }

    // TODO: Replace ComponentStore functions with non-validating ones.
    // Right now functions like `insert`, `get`, and `get_mut` use the checked and panicing versions
    // of the `untyped` functions. These functions do an extra check to see that the schema matches,
    // but we've already validated that in the construction of the `ComponentStore`, so we should
    // bypass the extra schema check for performance.

    /// Inserts a component for the given `Entity` index.
    /// Returns the previous component, if any.
    #[inline]
    pub fn insert(&mut self, entity: Entity, component: T) -> Option<T> {
        self.untyped.insert(entity, component)
    }

    /// Gets an immutable reference to the component of `Entity`.
    #[inline]
    pub fn get(&self, entity: Entity) -> Option<&T> {
        self.untyped.get(entity)
    }

    /// Gets a mutable reference to the component of `Entity`.
    #[inline]
    pub fn get_mut(&mut self, entity: Entity) -> Option<&mut T> {
        self.untyped.get_mut(entity)
    }

    /// Get a mutable reference to component if it exists.
    /// Otherwise inserts `T` generated by calling parameter: `f`.
    #[inline]
    pub fn get_mut_or_insert(&mut self, entity: Entity, f: impl FnOnce() -> T) -> &mut T {
        self.untyped.get_mut_or_insert(entity, f)
    }

    /// Get mutable references to the component data for multiple entities at the same time.
    ///
    /// # Panics
    ///
    /// This will panic if the same entity is specified multiple times. This is invalid because it
    /// would mean you would have two mutable references to the same component data at the same
    /// time.
    #[track_caller]
    pub fn get_many_mut<const N: usize>(&mut self, entities: [Entity; N]) -> [Option<&mut T>; N] {
        let mut result = self.untyped.get_many_ref_mut(entities);

        std::array::from_fn(move |i| {
            // SOUND: we know that the schema matches.
            result[i]
                .take()
                .map(|x| unsafe { x.cast_into_mut_unchecked() })
        })
    }

    /// Removes the component of `Entity`.
    /// Returns `Some(T)` if the entity did have the component.
    /// Returns `None` if the entity did not have the component.
    #[inline]
    pub fn remove(&mut self, entity: Entity) -> Option<T> {
        self.untyped.remove(entity)
    }

    /// Gets an immutable reference to the component if there is exactly one instance of it.
    #[inline]
    pub fn get_single_with_bitset(&self, bitset: Rc<BitSetVec>) -> Result<&T, QuerySingleError> {
        // SOUND: we know the schema matches.
        self.untyped
            .get_single_with_bitset(bitset)
            .map(|x| unsafe { x.cast_into_unchecked() })
    }

    /// Gets a mutable reference to the component if there is exactly one instance of it.
    #[inline]
    pub fn get_single_with_bitset_mut(
        &mut self,
        bitset: Rc<BitSetVec>,
    ) -> Result<&mut T, QuerySingleError> {
        // SOUND: we know the schema matches.
        self.untyped
            .get_single_with_bitset_mut(bitset)
            .map(|x| unsafe { x.cast_into_mut_unchecked() })
    }

    /// Iterates immutably over all components of this type.
    /// Very fast but doesn't allow joining with other component types.
    #[inline]
    pub fn iter(&self) -> impl Iterator<Item = &T> {
        // SOUND: we know the schema matches.
        self.untyped
            .iter()
            .map(|x| unsafe { x.cast_into_unchecked() })
    }

    /// Iterates mutably over all components of this type.
    /// Very fast but doesn't allow joining with other component types.
    #[inline]
    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut T> {
        // SOUND: we know the schema matches.
        self.untyped
            .iter_mut()
            .map(|x| unsafe { x.cast_into_mut_unchecked() })
    }
}

/// This trait factors out functions for iterating with bitset over component store.
/// Separated from `impl ComponentStore` for usage in generic trait types that must
/// be able to create [`ComponentBitsetIterator`] and related types.
///
/// Automatically implemented for [`ComponentStore`].
pub trait ComponentIterBitset<'a, T: HasSchema> {
    /// Gets an immutable reference to the component if there is exactly one instance of it.
    fn get_single_with_bitset(&self, bitset: Rc<BitSetVec>) -> Result<&T, QuerySingleError>;

    /// Gets a mutable reference to the component if there is exactly one instance of it.
    fn get_single_mut_with_bitset(
        &mut self,
        bitset: Rc<BitSetVec>,
    ) -> Result<&mut T, QuerySingleError>;

    /// Iterates immutably over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    fn iter_with_bitset(&self, bitset: Rc<BitSetVec>) -> ComponentBitsetIterator<T>;

    /// Iterates immutably over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    fn iter_with_bitset_optional(
        &self,
        bitset: Rc<BitSetVec>,
    ) -> ComponentBitsetOptionalIterator<T>;

    /// Iterates mutable over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    fn iter_mut_with_bitset(&mut self, bitset: Rc<BitSetVec>) -> ComponentBitsetIteratorMut<T>;

    /// Iterates mutably over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    fn iter_mut_with_bitset_optional(
        &mut self,
        bitset: Rc<BitSetVec>,
    ) -> ComponentBitsetOptionalIteratorMut<T>;

    /// Get bitset of [`ComponentStore`] / implementor.
    fn bitset(&self) -> &BitSetVec;

    /// Check whether or not this component store has data for the given entity.
    fn contains(&self, entity: Entity) -> bool;

    /// Get [`ComponentStore`] for usage with generic types implementing [`ComponentIterBitset`].
    fn component_store(&self) -> &ComponentStore<T>;
}

impl<'a, T: HasSchema> ComponentIterBitset<'a, T> for ComponentStore<T> {
    /// Gets an immutable reference to the component if there is exactly one instance of it.
    fn get_single_with_bitset(&self, bitset: Rc<BitSetVec>) -> Result<&T, QuerySingleError> {
        // SOUND: we know the schema matches.
        fn map<T>(r: SchemaRef) -> &T {
            unsafe { r.cast_into_unchecked() }
        }
        self.untyped.get_single_with_bitset(bitset).map(map)
    }

    /// Gets a mutable reference to the component if there is exactly one instance of it.
    fn get_single_mut_with_bitset(
        &mut self,
        bitset: Rc<BitSetVec>,
    ) -> Result<&mut T, QuerySingleError> {
        // SOUND: we know the schema matches.
        fn map<T>(r: SchemaRefMut) -> &mut T {
            unsafe { r.cast_into_mut_unchecked() }
        }
        self.untyped.get_single_with_bitset_mut(bitset).map(map)
    }

    /// Iterates immutably over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    #[inline]
    fn iter_with_bitset(&self, bitset: Rc<BitSetVec>) -> ComponentBitsetIterator<T> {
        // SOUND: we know the schema matches.
        fn map<T>(r: SchemaRef) -> &T {
            unsafe { r.cast_into_unchecked() }
        }
        self.untyped.iter_with_bitset(bitset).map(map)
    }

    /// Iterates immutably over the components of this type where `bitset`
    /// indicates the indices of entities where iterator returns an Option.
    /// None is returned for entities in bitset when Component is not in [`ComponentStore`]
    #[inline]
    fn iter_with_bitset_optional(
        &self,
        bitset: Rc<BitSetVec>,
    ) -> ComponentBitsetOptionalIterator<T> {
        // SOUND: we know the schema matches.
        fn map<T>(r: Option<SchemaRef>) -> Option<&T> {
            r.map(|r| unsafe { r.cast_into_unchecked() })
        }
        self.untyped.iter_with_bitset_optional(bitset).map(map)
    }

    /// Iterates mutable over the components of this type where `bitset`
    /// indicates the indices of entities.
    /// Slower than `iter()` but allows joining between multiple component types.
    #[inline]
    fn iter_mut_with_bitset(&mut self, bitset: Rc<BitSetVec>) -> ComponentBitsetIteratorMut<T> {
        // SOUND: we know the schema matches.
        fn map<T>(r: SchemaRefMut) -> &mut T {
            unsafe { r.cast_into_mut_unchecked() }
        }

        self.untyped.iter_mut_with_bitset(bitset).map(map)
    }

    /// Iterates mutably over the components of this type where `bitset`
    /// indicates the indices of entities where iterator returns an Option.
    /// None is returned for entities in bitset when Component is not in [`ComponentStore`
    #[inline]
    fn iter_mut_with_bitset_optional(
        &mut self,
        bitset: Rc<BitSetVec>,
    ) -> ComponentBitsetOptionalIteratorMut<T> {
        // SOUND: we know the schema matches.
        fn map<T>(r: Option<SchemaRefMut>) -> Option<&mut T> {
            r.map(|r| unsafe { r.cast_into_mut_unchecked() })
        }
        self.untyped.iter_mut_with_bitset_optional(bitset).map(map)
    }

    /// Read the bitset containing the list of entites with this component type on it.
    #[inline]
    fn bitset(&self) -> &BitSetVec {
        self.untyped.bitset()
    }

    /// Check whether or not this component store has data for the given entity.
    #[inline]
    fn contains(&self, entity: Entity) -> bool {
        self.bitset().contains(entity)
    }

    //// Get [`ComponentStore`] for usage with generic types implementing [`ComponentIterBitset`].
    #[inline]
    fn component_store(&self) -> &ComponentStore<T> {
        self
    }
}

#[cfg(test)]
mod tests {
    #![allow(non_snake_case)]

    use std::{iter, rc::Rc};

    use crate::prelude::*;

    #[derive(Debug, Clone, Copy, PartialEq, Eq, HasSchema, Default)]
    #[repr(C)]
    struct A(u32);

    #[derive(Debug, Clone, Copy, PartialEq, Eq, HasSchema, Default)]
    #[repr(C)]
    struct B(u32);

    fn entity(index: u32) -> Entity {
        Entity::new(index, 0)
    }

    fn store(entities: &[u32]) -> ComponentStore<A> {
        let mut store = ComponentStore::default();
        for &i in entities {
            store.insert(entity(i), A(i));
        }
        store
    }

    fn bitset(enabled: &[usize]) -> Rc<BitSetVec> {
        let mut bitset = BitSetVec::default();
        for &i in enabled {
            bitset.bit_set(i);
        }
        Rc::new(bitset)
    }

    #[test]
    fn create_remove_components() {
        let mut entities = Entities::default();
        let e1 = entities.create();
        let e2 = entities.create();

        let mut storage = ComponentStore::<A>::default();
        storage.insert(e1, A(1));
        storage.insert(e2, A(2));
        assert!(storage.get(e1).is_some());
        storage.remove(e1);
        assert!(storage.get(e1).is_none());
        assert!(storage.iter().eq(iter::once(&A(2))));
    }

    #[test]
    fn get_mut_or_insert() {
        let mut entities = Entities::default();
        let e1 = entities.create();

        let mut storage = ComponentStore::<A>::default();
        {
            // Test that inserted component is correct
            let comp = storage.get_mut_or_insert(e1, || A(1));
            assert_eq!(comp.0, 1);

            // Mutate component
            comp.0 = 2;
        }

        // Should not insert the unexpected value but retrieve original mutated component.
        let comp = storage.get_mut_or_insert(e1, || A(u32::MAX));

        // Test that existing component is retrieved
        assert_eq!(comp.0, 2);
    }

    #[test]
    fn iter() {
        let mut store = store(&[10, 20, 30]);
        let expected = vec![10, 20, 30];

        let actual = store.iter().map(|c| c.0).collect::<Vec<_>>();
        assert_eq!(actual, expected);

        let actual = store.iter_mut().map(|c| c.0).collect::<Vec<_>>();
        assert_eq!(actual, expected);
    }

    #[test]
    fn get_single_with_bitset() {
        {
            let (mut store, bitset) = (store(&[]), bitset(&[]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::NoEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::NoEntities));
        }

        {
            let (mut store, bitset) = (store(&[1]), bitset(&[]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::NoEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::NoEntities));
        }

        {
            let (mut store, bitset) = (store(&[]), bitset(&[1]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::NoEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::NoEntities));
        }

        {
            let (mut store, bitset) = (store(&[3]), bitset(&[3]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Ok(&A(3)));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Ok(&mut A(3)));
        }

        {
            let (mut store, bitset) = (store(&[5, 6]), bitset(&[5, 6]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::MultipleEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::MultipleEntities));
        }

        {
            let (mut store, bitset) = (store(&[11, 21, 31]), bitset(&[12, 22, 32]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::NoEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::NoEntities));
        }

        {
            let (mut store, bitset) = (store(&[11, 20, 31, 41]), bitset(&[12, 20, 32, 42]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Ok(&A(20)));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Ok(&mut A(20)));
        }

        {
            let (mut store, bitset) = (store(&[11, 21, 30, 41, 50]), bitset(&[12, 22, 30, 42, 50]));
            let result = store.get_single_with_bitset(bitset.clone());
            assert_eq!(result, Err(QuerySingleError::MultipleEntities));
            let result = store.get_single_with_bitset_mut(bitset);
            assert_eq!(result, Err(QuerySingleError::MultipleEntities));
        }
    }

    #[test]
    fn iter_with_bitset() {
        {
            let (mut store, bitset) = (store(&[]), bitset(&[]));

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset);
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[]), bitset(&[10, 20]));

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset);
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[10, 20]), bitset(&[]));

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset);
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[11, 21, 31]), bitset(&[12, 22, 32]));

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset.clone());
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[5]), bitset(&[5]));

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), Some(&A(5)));
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset);
            assert_eq!(iter.next(), Some(&mut A(5)));
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (
                store(&[11, 20, 31, 41, 50, 61]),
                bitset(&[12, 20, 32, 42, 50, 62]),
            );

            let mut iter = store.iter_with_bitset(bitset.clone());
            assert_eq!(iter.next(), Some(&A(20)));
            assert_eq!(iter.next(), Some(&A(50)));
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset(bitset);
            assert_eq!(iter.next(), Some(&mut A(20)));
            assert_eq!(iter.next(), Some(&mut A(50)));
            assert_eq!(iter.next(), None);
        }
    }

    #[test]
    fn iter_with_bitset_optional() {
        {
            let (mut store, bitset) = (store(&[]), bitset(&[]));

            let mut iter = store.iter_with_bitset_optional(bitset.clone());
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset_optional(bitset);
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[]), bitset(&[5, 6]));

            let mut iter = store.iter_with_bitset_optional(bitset.clone());
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset_optional(bitset);
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[11, 21, 31]), bitset(&[12, 22, 32]));

            let mut iter = store.iter_with_bitset_optional(bitset.clone());
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset_optional(bitset);
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);
        }

        {
            let (mut store, bitset) = (store(&[11, 20, 31]), bitset(&[12, 20, 32]));

            let mut iter = store.iter_with_bitset_optional(bitset.clone());
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(Some(&A(20))));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);

            let mut iter = store.iter_mut_with_bitset_optional(bitset);
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), Some(Some(&mut A(20))));
            assert_eq!(iter.next(), Some(None));
            assert_eq!(iter.next(), None);
        }
    }
}