dynec 0.2.1

An opinionated ECS-like framework
Documentation 
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

#![allow(clippy::extra_unused_type_parameters)] // due to test_storage macro consistency

use std::marker::PhantomData;
use std::num::NonZeroU32;

use crate::storage::{Access, Partition};
use crate::Storage;

macro_rules! test_storage {
    ($ident:ident $storage:ty) => {
        crate::storage::tests::test_storage! { @$ident $storage =>
            test_single_small_hole
            test_single_big_hole_with_reinsertion
            test_partition_no_panic
            #[should_panic = "Entity 3 is not in the partition 5.."] test_partition_panic_right_some
            #[should_panic = "Entity 4 is not in the partition 5.."] test_partition_panic_right_none
            #[should_panic = "Entity 2 is not in the partition 3.."] test_repartition_panic_lr_ll
            #[should_panic = "Entity 2 is not in the partition 5.."] test_repartition_panic_rl_l
            #[should_panic = "Entity 3 is not in the partition 7.."] test_repartition_panic_rr_l
            #[should_panic = "Entity 6 is not in the partition 7.."] test_repartition_panic_rr_rl
        }
    };
    (@CHUNKED $storage:ty => $($(#[$meta:meta])* $tests:ident)*) => {
        $(
            $(#[$meta])*
            #[test]
            fn $tests() {
                crate::storage::tests::$tests::<$storage, crate::storage::tests::RealChunker<$storage>>();
            }
        )*
    };
    (@NON_CHUNKED $storage:ty => $($(#[$meta:meta])* $tests:ident)*) => {
        $(
            $(#[$meta])*
            #[test]
            fn $tests() {
                crate::storage::tests::$tests::<$storage, crate::storage::tests::FakeChunker>();
            }
        )*
    }
}

pub(crate) use test_storage;

/// Wraps the chunk capabilities of storage types if available.
pub(super) trait Chunker<S> {
    fn to_chunks(s: &S) -> Option<Vec<(u32, Vec<i64>)>>;
    fn to_chunks_mut(s: &mut S) -> Option<Vec<(u32, Vec<i64>)>>;
}

pub(super) struct RealChunker<S>(PhantomData<S>);
impl<S: Storage<RawEntity = NonZeroU32, Comp = i64>> Chunker<S> for RealChunker<S> {
    fn to_chunks(s: &S) -> Option<Vec<(u32, Vec<i64>)>> {
        Some(s.iter_chunks().map(|chunk| (chunk.start.get(), chunk.slice.to_vec())).collect())
    }
    fn to_chunks_mut(s: &mut S) -> Option<Vec<(u32, Vec<i64>)>> {
        Some(s.iter_chunks_mut().map(|chunk| (chunk.start.get(), chunk.slice.to_vec())).collect())
    }
}

pub(super) struct FakeChunker;
impl<S> Chunker<S> for FakeChunker {
    fn to_chunks(_: &S) -> Option<Vec<(u32, Vec<i64>)>> { None }
    fn to_chunks_mut(_: &mut S) -> Option<Vec<(u32, Vec<i64>)>> { None }
}

pub(super) fn test_single_small_hole<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
    P: Chunker<S>,
{
    let mut storage = S::default();
    for i in 1..=10 {
        storage.set(NonZeroU32::new(i).unwrap(), Some(i64::from(i)));
    }

    for i in 1..=10 {
        assert_eq!(storage.get(NonZeroU32::new(i).unwrap()), Some(&i64::from(i)));
    }

    storage.set(NonZeroU32::new(3).unwrap(), None);
    for i in (1..3).chain(4..=10) {
        assert_eq!(storage.get(NonZeroU32::new(i).unwrap()), Some(&i64::from(i)));
    }

    let items: Vec<_> = storage.iter().map(|(entity, value)| (entity.get(), *value)).collect();
    assert_eq!(
        items,
        vec![(1, 1), (2, 2), (4, 4), (5, 5), (6, 6), (7, 7), (8, 8), (9, 9), (10, 10)]
    );

    let items: Vec<_> = storage.iter_mut().map(|(entity, value)| (entity.get(), *value)).collect();
    assert_eq!(
        items,
        vec![(1, 1), (2, 2), (4, 4), (5, 5), (6, 6), (7, 7), (8, 8), (9, 9), (10, 10)]
    );

    if let Some(chunks) = P::to_chunks(&storage) {
        assert_eq!(chunks, vec![(1, vec![1, 2]), (4, vec![4, 5, 6, 7, 8, 9, 10])]);
    }

    if let Some(chunks) = P::to_chunks_mut(&mut storage) {
        assert_eq!(chunks, vec![(1, vec![1, 2]), (4, vec![4, 5, 6, 7, 8, 9, 10])]);
    }
}

pub(super) fn test_single_big_hole_with_reinsertion<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
    P: Chunker<S>,
{
    let mut storage = S::default();
    for i in 1..=10 {
        storage.set(NonZeroU32::new(i).unwrap(), Some(i64::from(i)));
    }

    for i in 1..=10 {
        assert_eq!(storage.get(NonZeroU32::new(i).unwrap()), Some(&i64::from(i)));
    }

    for i in 3..6 {
        storage.set(NonZeroU32::new(i).unwrap(), None);
    }
    storage.set(NonZeroU32::new(4).unwrap(), Some(i64::from(4)));

    for i in (1..3).chain(6..=10) {
        assert_eq!(storage.get(NonZeroU32::new(i).unwrap()), Some(&i64::from(i)));
    }

    let items: Vec<_> = storage.iter().map(|(entity, value)| (entity.get(), *value)).collect();
    assert_eq!(items, vec![(1, 1), (2, 2), (4, 4), (6, 6), (7, 7), (8, 8), (9, 9), (10, 10)]);

    let items: Vec<_> = storage.iter_mut().map(|(entity, value)| (entity.get(), *value)).collect();
    assert_eq!(items, vec![(1, 1), (2, 2), (4, 4), (6, 6), (7, 7), (8, 8), (9, 9), (10, 10)]);

    if let Some(chunks) = P::to_chunks(&storage) {
        assert_eq!(chunks, vec![(1, vec![1, 2]), (4, vec![4]), (6, vec![6, 7, 8, 9, 10])]);
    }

    if let Some(chunks) = P::to_chunks_mut(&mut storage) {
        assert_eq!(chunks, vec![(1, vec![1, 2]), (4, vec![4]), (6, vec![6, 7, 8, 9, 10])]);
    }
}

/// Returns a storage containing entities 1,2,3,5,6,8,9 (without 4 and 7).
fn setup_partition_storage<S: Storage<RawEntity = NonZeroU32, Comp = i64>>() -> S {
    let mut storage = S::default();
    for i in [1, 2, 3, 5, 6, 8, 9] {
        storage.set(NonZeroU32::new(i).unwrap(), Some(i64::from(i)));
    }
    storage
}

pub(super) fn test_partition_no_panic<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
{
    let mut storage: S = setup_partition_storage();
    {
        let (mut left, mut right) = storage.as_partition().split_at(NonZeroU32::new(4).unwrap());
        assert_eq!(left.get_mut(NonZeroU32::new(1).unwrap()), Some(&mut 1));
        assert_eq!(left.get_mut(NonZeroU32::new(3).unwrap()), Some(&mut 3));
        assert_eq!(right.get_mut(NonZeroU32::new(4).unwrap()), None);
        assert_eq!(right.get_mut(NonZeroU32::new(5).unwrap()), Some(&mut 5));
        assert_eq!(right.get_mut(NonZeroU32::new(9).unwrap()), Some(&mut 9));
    }
    {
        let (mut left, mut right) = storage.as_partition().split_at(NonZeroU32::new(5).unwrap());
        assert_eq!(left.get_mut(NonZeroU32::new(1).unwrap()), Some(&mut 1));
        assert_eq!(left.get_mut(NonZeroU32::new(3).unwrap()), Some(&mut 3));
        assert_eq!(left.get_mut(NonZeroU32::new(4).unwrap()), None);
        assert_eq!(right.get_mut(NonZeroU32::new(5).unwrap()), Some(&mut 5));
        assert_eq!(right.get_mut(NonZeroU32::new(9).unwrap()), Some(&mut 9));
    }
}

pub(super) fn test_partition_panic_left_some<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
{
    let mut storage: S = setup_partition_storage();
    let (mut left, _) = storage.as_partition().split_at(NonZeroU32::new(4).unwrap());
    left.get_mut(NonZeroU32::new(5).unwrap());
}

pub(super) fn test_partition_panic_left_none<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
{
    let mut storage: S = setup_partition_storage();
    let (mut left, _) = storage.as_partition().split_at(NonZeroU32::new(4).unwrap());
    left.get_mut(NonZeroU32::new(4).unwrap());
}

pub(super) fn test_partition_panic_right_some<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
{
    let mut storage: S = setup_partition_storage();
    let (_, mut right) = storage.as_partition().split_at(NonZeroU32::new(5).unwrap());
    right.get_mut(NonZeroU32::new(3).unwrap());
}

pub(super) fn test_partition_panic_right_none<S, P>()
where
    S: Storage<RawEntity = NonZeroU32, Comp = i64>,
{
    let mut storage: S = setup_partition_storage();
    let (_, mut right) = storage.as_partition().split_at(NonZeroU32::new(5).unwrap());
    right.get_mut(NonZeroU32::new(4).unwrap());
}

macro_rules! repartition_panic_test {
    (
        $(
            $ident:ident {
                partition $first_cut:literal take $first_half:ident;
                partition $second_cut:literal take $second_half:ident;
                panic at get_mut($probe:literal);
            }
        )*
    ) => { $(
        pub(super) fn $ident<S, P>()
        where
            S: Storage<RawEntity = NonZeroU32, Comp = i64>,
        {
            let mut storage: S = setup_partition_storage();

            let first_pair = storage.as_partition().split_at(NonZeroU32::new($first_cut).unwrap());
            let first = repartition_panic_test!(@take $first_half of first_pair);

            let second_pair = first.split_at(NonZeroU32::new($second_cut).unwrap());
            let mut second = repartition_panic_test!(@take $second_half of second_pair);

            second.get_mut(NonZeroU32::new($probe).unwrap());
        }
    )* };
    (@take left of $v:expr) => {
        ($v).0
    };
    (@take right of $v:expr) => {
        ($v).1
    };
}

repartition_panic_test! {
    test_repartition_panic_ll_lr {
        partition 5 take left;
        partition 3 take left;
        panic at get_mut(4);
    }
    test_repartition_panic_ll_r {
        partition 5 take left;
        partition 3 take left;
        panic at get_mut(8);
    }
    test_repartition_panic_lr_ll {
        partition 5 take left;
        partition 3 take right;
        panic at get_mut(2);
    }
    test_repartition_panic_lr_r {
        partition 5 take left;
        partition 3 take right;
        panic at get_mut(8);
    }
    test_repartition_panic_rl_l {
        partition 5 take right;
        partition 7 take left;
        panic at get_mut(2);
    }
    test_repartition_panic_rl_rr {
        partition 5 take right;
        partition 7 take left;
        panic at get_mut(8);
    }
    test_repartition_panic_rr_l {
        partition 5 take right;
        partition 7 take right;
        panic at get_mut(3);
    }
    test_repartition_panic_rr_rl {
        partition 5 take right;
        partition 7 take right;
        panic at get_mut(6);
    }
}