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
use crate::descriptors::component_descriptor::{ComponentDescriptor, ComponentDescriptorFnPointers};
use crate::{define_component_descriptor, Component, MAX_COMPONENTS_PER_ENTITY};

use crate::descriptors::component_group_descriptor::ComponentGroupDescriptor;
use private::SealedComponentGroup;

#[macro_export]
macro_rules! expr {
    ($x:expr) => {
        $x
    };
}

#[macro_export]
macro_rules! tuple_index {
    ($tuple:expr, $idx:tt) => {
        expr!($tuple.$idx)
    };
}

/// Represents a group of components. Used for specifying which component types should be matched in query's.
pub trait ComponentGroup<'c>: private::SealedComponentGroup + Sized + 'static {
    type RefTuple: 'c;
    type MutRefTuple: 'c;
    type SliceRefTuple: 'c;
    type SliceMutRefTuple: 'c;

    /// The descriptor which exactly specifies all components of the component group.
    const DESCRIPTOR: ComponentGroupDescriptor;

    /// Returns the sorted pointers given a reference to self.
    unsafe fn as_sorted_pointers(&mut self, ptrs: &mut [*mut u8; MAX_COMPONENTS_PER_ENTITY]);

    /// Returns an instance of self, read from the sorted pointers.
    unsafe fn read_from_sorted_pointers(pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY]) -> Self;

    /// Returns a reference tuple of component types given an array of sorted pointers.
    unsafe fn pointers_as_ref_tuple(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
    ) -> Self::RefTuple;

    /// Returns a mutable reference tuple of component types given an array of sorted pointers.
    unsafe fn pointers_as_mut_ref_tuple(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
    ) -> Self::MutRefTuple;

    /// Returns a tuple of slices extracted from the given pointers.
    /// # Safety:
    /// - The pointers must be sorted.
    unsafe fn slice_unchecked(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
        len: usize,
    ) -> Self::SliceRefTuple;

    /// Returns a tuple of mutable slices extracted from the given pointers.
    /// # Safety:
    /// - The pointers must be sorted.
    unsafe fn slice_unchecked_mut(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
        len: usize,
    ) -> Self::SliceMutRefTuple;

    /// Returns an tuple of empty slices.
    fn empty_slice() -> Self::SliceRefTuple;

    /// Returns an tuple of empty mutable slices.
    fn empty_slice_mut() -> Self::SliceMutRefTuple;
}

impl<'c, T: Component + SealedComponentGroup> ComponentGroup<'c> for T {
    type RefTuple = &'c T;
    type MutRefTuple = &'c mut T;

    type SliceRefTuple = &'c [T];
    type SliceMutRefTuple = &'c mut [T];

    const DESCRIPTOR: ComponentGroupDescriptor =
        ComponentGroupDescriptor::new(&[define_component_descriptor!(T)]);

    unsafe fn as_sorted_pointers(&mut self, ptrs: &mut [*mut u8; MAX_COMPONENTS_PER_ENTITY]) {
        ptrs[0] = self as *mut T as *mut u8;
    }

    unsafe fn read_from_sorted_pointers(pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY]) -> Self {
        core::ptr::read(pointers[0] as *mut T)
    }

    unsafe fn pointers_as_ref_tuple(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
    ) -> Self::RefTuple {
        &*(sorted_pointers[0] as *mut T)
    }

    unsafe fn pointers_as_mut_ref_tuple(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
    ) -> Self::MutRefTuple {
        &mut *(sorted_pointers[0] as *mut T)
    }

    unsafe fn slice_unchecked(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
        len: usize,
    ) -> Self::SliceRefTuple {
        core::slice::from_raw_parts(sorted_pointers[0] as *const T, len)
    }

    unsafe fn slice_unchecked_mut(
        sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
        len: usize,
    ) -> Self::SliceMutRefTuple {
        core::slice::from_raw_parts_mut(sorted_pointers[0] as *mut T, len)
    }

    fn empty_slice() -> Self::SliceRefTuple {
        &[]
    }

    fn empty_slice_mut() -> Self::SliceMutRefTuple {
        &mut []
    }
}

macro_rules! impl_component_tuple {
    ($len:expr, $(($elem:ident, $elem_idx:tt)), *) => {
        impl<'s, $($elem),*> ComponentGroup<'s> for ($($elem), *)
        where $( $elem : Component + SealedComponentGroup ),*, Self : SealedComponentGroup
        {
            type RefTuple = ($(&'s $elem),*);
            type MutRefTuple = ($(&'s mut $elem),*);

            type SliceRefTuple = ($(&'s [$elem]),*);
            type SliceMutRefTuple = ($(&'s mut [$elem]),*);

            fn empty_slice() -> Self::SliceRefTuple {
                ($(&[] as &[$elem]), *)
            }

            fn empty_slice_mut() -> Self::SliceMutRefTuple {
                ($(&mut [] as &mut [$elem]), *)
            }

            const DESCRIPTOR: ComponentGroupDescriptor =
                ComponentGroupDescriptor::new(&[$(define_component_descriptor!($elem)), *]);

            unsafe fn as_sorted_pointers(&mut self, ptrs: &mut [*mut u8; MAX_COMPONENTS_PER_ENTITY]) {
                $(
                    ptrs[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize] = &mut tuple_index!(self, $elem_idx) as *mut $elem as *mut u8;
                )*
            }

            unsafe fn read_from_sorted_pointers(pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY]) -> Self {
                ($(
                    core::ptr::read(pointers[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize] as *mut $elem)
                ),*)
            }

            unsafe fn pointers_as_ref_tuple(
                sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
            ) -> Self::RefTuple {
                ($(
                    &*((sorted_pointers[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize]) as *mut $elem),
                )*)
            }

            unsafe fn pointers_as_mut_ref_tuple(
                sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
            ) -> Self::MutRefTuple {
                ($(
                    &mut *((sorted_pointers[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize]) as *mut $elem),
                )*)
            }

            unsafe fn slice_unchecked(
                sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
                len: usize,
            ) -> Self::SliceRefTuple {
                ($(
                    core::slice::from_raw_parts(sorted_pointers[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize] as *const $elem, len),
                )*)
            }

            unsafe fn slice_unchecked_mut(
                sorted_pointers: &[*mut u8; MAX_COMPONENTS_PER_ENTITY],
                len: usize,
            ) -> Self::SliceMutRefTuple {
                                ($(
                    core::slice::from_raw_parts_mut(sorted_pointers[Self::DESCRIPTOR.unsorted_to_sorted($elem_idx) as usize] as *mut $elem, len),
                )*)
            }
        }
    }
}

#[cfg(test)]
mod test {
    extern crate std;
    use super::*;
    use crate::test_components::*;

    #[test]
    fn test_component_group_as_sorted_pointers() {
        unsafe {
            let mut group = (A::default(), B::default(), C::default());

            let mut ptrs = [core::ptr::null_mut(); MAX_COMPONENTS_PER_ENTITY];
            ComponentGroup::as_sorted_pointers(&mut group, &mut ptrs);
            assert_eq!(ptrs[0], &mut group.0 as *mut A as *mut u8);
            assert_eq!(ptrs[1], &mut group.1 as *mut B as *mut u8);
            assert_eq!(ptrs[2], &mut group.2 as *mut C as *mut u8);

            let mut group = (B::default(), C::default(), A::default());
            let mut ptrs = [core::ptr::null_mut(); MAX_COMPONENTS_PER_ENTITY];
            ComponentGroup::as_sorted_pointers(&mut group, &mut ptrs);
            assert_eq!(ptrs[0], &mut group.2 as *mut A as *mut u8);
            assert_eq!(ptrs[1], &mut group.0 as *mut B as *mut u8);
            assert_eq!(ptrs[2], &mut group.1 as *mut C as *mut u8);
        }
    }

    #[test]
    fn test_component_group_sorted_pointers_as_ref_tuples() {
        unsafe {
            let mut group = (A::default(), B::default(), C::default());

            let mut ptrs = [core::ptr::null_mut(); MAX_COMPONENTS_PER_ENTITY];
            ComponentGroup::as_sorted_pointers(&mut group, &mut ptrs);

            let result = <(A, B, C) as ComponentGroup<'_>>::pointers_as_ref_tuple(&ptrs);
            assert_eq!(result.0 as *const A as *mut u8, ptrs[0]);
            assert_eq!(result.1 as *const B as *mut u8, ptrs[1]);
            assert_eq!(result.2 as *const C as *mut u8, ptrs[2]);

            let result = <(A, B, C) as ComponentGroup<'_>>::pointers_as_mut_ref_tuple(&ptrs);
            assert_eq!(result.0 as *mut A as *mut u8, ptrs[0]);
            assert_eq!(result.1 as *mut B as *mut u8, ptrs[1]);
            assert_eq!(result.2 as *mut C as *mut u8, ptrs[2]);

            let result = <(B, C, A) as ComponentGroup<'_>>::pointers_as_ref_tuple(&ptrs);
            assert_eq!(result.0 as *const B as *mut u8, ptrs[1]);
            assert_eq!(result.1 as *const C as *mut u8, ptrs[2]);
            assert_eq!(result.2 as *const A as *mut u8, ptrs[0]);
            let result = <(C, A, B) as ComponentGroup<'_>>::pointers_as_mut_ref_tuple(&ptrs);
            assert_eq!(result.0 as *mut C as *mut u8, ptrs[2]);
            assert_eq!(result.1 as *mut A as *mut u8, ptrs[0]);
            assert_eq!(result.2 as *mut B as *mut u8, ptrs[1]);
        }
    }

    #[test]
    fn test_component_group_sorted_pointers_to_tuples() {
        unsafe {
            let mut group = (A::default(), B::default(), C::default());

            let mut ptrs = [core::ptr::null_mut(); MAX_COMPONENTS_PER_ENTITY];
            ComponentGroup::as_sorted_pointers(&mut group, &mut ptrs);

            let result = <(A, B, C) as ComponentGroup<'_>>::read_from_sorted_pointers(&ptrs);
            assert_eq!(result.0, group.0);
            assert_eq!(result.1, group.1);
            assert_eq!(result.2, group.2);

            let result = <(C, A, B) as ComponentGroup<'_>>::read_from_sorted_pointers(&ptrs);
            assert_eq!(result.1, group.0);
            assert_eq!(result.2, group.1);
            assert_eq!(result.0, group.2);
        }
    }

    #[test]
    fn test_component_group_slices() {
        unsafe {
            let mut slice_a = [
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
                A::default(),
            ];
            let mut slice_b = [
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
                B::default(),
            ];
            let mut slice_c = [
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
                C::default(),
            ];

            let mut pointers = [core::ptr::null_mut::<u8>(); MAX_COMPONENTS_PER_ENTITY];
            pointers[0] = slice_a.as_mut_ptr() as *mut u8;
            pointers[1] = slice_b.as_mut_ptr() as *mut u8;
            pointers[2] = slice_c.as_mut_ptr() as *mut u8;

            let slices: (&[A], &[B], &[C]) =
                <(A, B, C) as ComponentGroup<'_>>::slice_unchecked(&mut pointers, slice_a.len());
            assert_eq!(slices.0.as_ptr() as *mut u8, pointers[0]);
            assert_eq!(slices.1.as_ptr() as *mut u8, pointers[1]);
            assert_eq!(slices.2.as_ptr() as *mut u8, pointers[2]);

            let slices: (&[B], &[C], &[A]) =
                <(B, C, A) as ComponentGroup<'_>>::slice_unchecked(&mut pointers, slice_a.len());
            assert_eq!(slices.0.as_ptr() as *mut u8, pointers[1]);
            assert_eq!(slices.1.as_ptr() as *mut u8, pointers[2]);
            assert_eq!(slices.2.as_ptr() as *mut u8, pointers[0]);
        }
    }
}

// impl_component_tuple!(
//     16,
//     (T1, 0),
//     (T2, 1),
//     (T3, 2),
//     (T4, 3),
//     (T5, 4),
//     (T6, 5),
//     (T7, 6),
//     (T8, 7),
//     (T9, 8),
//     (T10, 9),
//     (T11, 10),
//     (T12, 11),
//     (T13, 12),
//     (T14, 13),
//     (T15, 14),
//     (T16, 15)
// );
//
// impl_component_tuple!(
//     15,
//     (T1, 0),
//     (T2, 1),
//     (T3, 2),
//     (T4, 3),
//     (T5, 4),
//     (T6, 5),
//     (T7, 6),
//     (T8, 7),
//     (T9, 8),
//     (T10, 9),
//     (T11, 10),
//     (T12, 11),
//     (T13, 12),
//     (T14, 13),
//     (T15, 14)
// );

impl_component_tuple!(
    14,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8),
    (T10, 9),
    (T11, 10),
    (T12, 11),
    (T13, 12),
    (T14, 13)
);

impl_component_tuple!(
    13,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8),
    (T10, 9),
    (T11, 10),
    (T12, 11),
    (T13, 12)
);

impl_component_tuple!(
    12,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8),
    (T10, 9),
    (T11, 10),
    (T12, 11)
);

impl_component_tuple!(
    11,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8),
    (T10, 9),
    (T11, 10)
);

impl_component_tuple!(
    10,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8),
    (T10, 9)
);

impl_component_tuple!(
    9,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7),
    (T9, 8)
);

impl_component_tuple!(
    8,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6),
    (T8, 7)
);
impl_component_tuple!(
    7,
    (T1, 0),
    (T2, 1),
    (T3, 2),
    (T4, 3),
    (T5, 4),
    (T6, 5),
    (T7, 6)
);

impl_component_tuple!(6, (T1, 0), (T2, 1), (T3, 2), (T4, 3), (T5, 4), (T6, 5));
impl_component_tuple!(5, (T1, 0), (T2, 1), (T3, 2), (T4, 3), (T5, 4));
impl_component_tuple!(4, (T1, 0), (T2, 1), (T3, 2), (T4, 3));
impl_component_tuple!(3, (T1, 0), (T2, 1), (T3, 2));
impl_component_tuple!(2, (T1, 0), (T2, 1));

mod private {
    use crate::Component;

    pub trait SealedComponentGroup {}

    impl<'s, T> SealedComponentGroup for T where T: Component {}

    macro_rules! impl_sealed_component_tuples {
        ($($ty:ident)*) => {}; //base case
        ($head:ident, $($tail:ident),*) => {
            impl<$($tail),*, $head> SealedComponentGroup for impl_sealed_component_tuples!([$($tail)*] $head)
            where $head : Component, $( $tail : Component ),* {}

            impl_sealed_component_tuples!($($tail),*);
        };
        ([] $($ty:ident)*) => {
            ($($ty), *)
        };
        ([$first:ident $($tail:ident)*] $($ty:ident)*) => {
            impl_sealed_component_tuples!([$($tail)*] $first $($ty)*)
        };
    }

    impl_sealed_component_tuples!(
        T16, T15, T14, T13, T12, T11, T10, T9, T8, T7, T6, T5, T4, T3, T2, T1
    );
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Component;
    struct Position;
    struct Rotation;
    struct Velocity;
    impl Component for Position {
        const NAME: &'static str = "Position";
    }
    impl Component for Rotation {
        const NAME: &'static str = "Rotation";
    }
    impl Component for Velocity {
        const NAME: &'static str = "Velocity";
    }

    #[test]
    fn test_component_group_len() {
        fn test_group_len<'c, G: ComponentGroup<'c>>(expected_len: usize) {
            assert_eq!(G::DESCRIPTOR.archetype().len() as usize, expected_len);
        }

        test_group_len::<Position>(1);
        test_group_len::<(Position, Rotation)>(2);
        test_group_len::<(Position, Rotation, Velocity)>(3);
    }

    #[test]
    fn test_component_group_descriptor() {
        #[cfg(test)]
        extern crate std;

        assert!(<Position as ComponentGroup>::DESCRIPTOR.is_valid());
        assert!(<(Position, Position) as ComponentGroup>::DESCRIPTOR.is_valid() == false);
        assert!(<(Position, Rotation) as ComponentGroup>::DESCRIPTOR.is_valid());
    }
}