gecs 0.3.0

A generated entity component system.
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
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

use gecs::prelude::*;

mod inner {
    pub(crate) const TEST_CAPACITY: usize = 4;
}

pub struct CompA(pub u32);
pub struct CompZ; // ZST

ecs_world! {
    ecs_archetype!(
        ArchFoo,
        inner::TEST_CAPACITY + 1, // Should be 5 total for tests
        CompA,
        CompZ,
    );
}

#[test]
#[rustfmt::skip]
pub fn test_archetype_id() {
    assert_eq!(ArchFoo::ARCHETYPE_ID, 0); // Implicit
}

#[test]
#[rustfmt::skip]
pub fn test_single_create() {
    let mut world = EcsWorld::default();

    world.arch_foo.create((CompA(0), CompZ,));
    world.arch_foo.create((CompA(1), CompZ,));
    world.arch_foo.create((CompA(2), CompZ,));
    world.arch_foo.create((CompA(3), CompZ,));
    world.arch_foo.create((CompA(4), CompZ,));

    assert_eq!(world.arch_foo.len(), 5);

    assert!(world.arch_foo.try_create((CompA(6), CompZ,)).is_none());
}

#[test]
#[rustfmt::skip]
pub fn test_single_entity() {
    let mut world = EcsWorld::default();

    let entity_0 = world.arch_foo.create((CompA(0), CompZ,));
    let entity_1 = world.arch_foo.create((CompA(1), CompZ,));
    let entity_2 = world.arch_foo.create((CompA(2), CompZ,));
    let entity_3 = world.arch_foo.create((CompA(3), CompZ,));
    let entity_4 = world.arch_foo.create((CompA(4), CompZ,));

    assert!(ecs_find!(world, entity_0, |v: &Entity<ArchFoo>| assert!(*v == entity_0)).is_some());
    assert!(ecs_find!(world, entity_1, |v: &Entity<ArchFoo>| assert!(*v == entity_1)).is_some());
    assert!(ecs_find!(world, entity_2, |v: &Entity<ArchFoo>| assert!(*v == entity_2)).is_some());
    assert!(ecs_find!(world, entity_3, |v: &Entity<ArchFoo>| assert!(*v == entity_3)).is_some());
    assert!(ecs_find!(world, entity_4, |v: &Entity<ArchFoo>| assert!(*v == entity_4)).is_some());

    assert!(ecs_find_borrow!(world, entity_0, |v: &Entity<ArchFoo>| assert!(*v == entity_0)).is_some());
    assert!(ecs_find_borrow!(world, entity_1, |v: &Entity<ArchFoo>| assert!(*v == entity_1)).is_some());
    assert!(ecs_find_borrow!(world, entity_2, |v: &Entity<ArchFoo>| assert!(*v == entity_2)).is_some());
    assert!(ecs_find_borrow!(world, entity_3, |v: &Entity<ArchFoo>| assert!(*v == entity_3)).is_some());
    assert!(ecs_find_borrow!(world, entity_4, |v: &Entity<ArchFoo>| assert!(*v == entity_4)).is_some());

    assert!(world.arch_foo.destroy(entity_0).is_some());
    assert!(world.arch_foo.destroy(entity_1).is_some());
    assert!(world.arch_foo.destroy(entity_2).is_some());
    assert!(world.arch_foo.destroy(entity_3).is_some());
    assert!(world.arch_foo.destroy(entity_4).is_some());

    let entity_0b = world.arch_foo.create((CompA(0), CompZ,));
    let entity_1b = world.arch_foo.create((CompA(1), CompZ,));
    let entity_2b = world.arch_foo.create((CompA(2), CompZ,));
    let entity_3b = world.arch_foo.create((CompA(3), CompZ,));
    let entity_4b = world.arch_foo.create((CompA(4), CompZ,));

    assert!(entity_0 != entity_0b);
    assert!(entity_1 != entity_1b);
    assert!(entity_2 != entity_2b);
    assert!(entity_3 != entity_3b);
    assert!(entity_4 != entity_4b);

    assert!(ecs_find!(world, entity_0b, |v: &Entity<ArchFoo>| assert!(*v == entity_0b)).is_some());
    assert!(ecs_find!(world, entity_1b, |v: &Entity<ArchFoo>| assert!(*v == entity_1b)).is_some());
    assert!(ecs_find!(world, entity_2b, |v: &Entity<ArchFoo>| assert!(*v == entity_2b)).is_some());
    assert!(ecs_find!(world, entity_3b, |v: &Entity<ArchFoo>| assert!(*v == entity_3b)).is_some());
    assert!(ecs_find!(world, entity_4b, |v: &Entity<ArchFoo>| assert!(*v == entity_4b)).is_some());

    assert!(ecs_find_borrow!(world, entity_0b, |v: &Entity<ArchFoo>| assert!(*v == entity_0b)).is_some());
    assert!(ecs_find_borrow!(world, entity_1b, |v: &Entity<ArchFoo>| assert!(*v == entity_1b)).is_some());
    assert!(ecs_find_borrow!(world, entity_2b, |v: &Entity<ArchFoo>| assert!(*v == entity_2b)).is_some());
    assert!(ecs_find_borrow!(world, entity_3b, |v: &Entity<ArchFoo>| assert!(*v == entity_3b)).is_some());
    assert!(ecs_find_borrow!(world, entity_4b, |v: &Entity<ArchFoo>| assert!(*v == entity_4b)).is_some());
}

#[test]
#[rustfmt::skip]
pub fn test_single_find() {
    let mut world = EcsWorld::default();

    let entity_0 = world.arch_foo.create((CompA(0), CompZ,));
    let entity_1 = world.arch_foo.create((CompA(1), CompZ,));
    let entity_2 = world.arch_foo.create((CompA(2), CompZ,));
    let entity_3 = world.arch_foo.create((CompA(3), CompZ,));
    let entity_4 = world.arch_foo.create((CompA(4), CompZ,));

    assert!(ecs_find!(world, entity_0, |v: &CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find!(world, entity_1, |v: &CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find!(world, entity_2, |v: &CompA| assert_eq!(v.0, 2)).is_some());
    assert!(ecs_find!(world, entity_3, |v: &CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find!(world, entity_4, |v: &CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find_borrow!(world, entity_0, |v: &CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find_borrow!(world, entity_1, |v: &CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find_borrow!(world, entity_2, |v: &CompA| assert_eq!(v.0, 2)).is_some());
    assert!(ecs_find_borrow!(world, entity_3, |v: &CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find_borrow!(world, entity_4, |v: &CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find!(world, entity_0, |v: &mut CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find!(world, entity_1, |v: &mut CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find!(world, entity_2, |v: &mut CompA| assert_eq!(v.0, 2)).is_some());
    assert!(ecs_find!(world, entity_3, |v: &mut CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find!(world, entity_4, |v: &mut CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find_borrow!(world, entity_0, |v: &mut CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find_borrow!(world, entity_1, |v: &mut CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find_borrow!(world, entity_2, |v: &mut CompA| assert_eq!(v.0, 2)).is_some());
    assert!(ecs_find_borrow!(world, entity_3, |v: &mut CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find_borrow!(world, entity_4, |v: &mut CompA| assert_eq!(v.0, 4)).is_some());

    world.arch_foo.destroy(entity_2).unwrap();

    assert!(ecs_find!(world, entity_0, |v: &CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find!(world, entity_1, |v: &CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find!(world, entity_3, |v: &CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find!(world, entity_4, |v: &CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find_borrow!(world, entity_0, |v: &CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find_borrow!(world, entity_1, |v: &CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find_borrow!(world, entity_3, |v: &CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find_borrow!(world, entity_4, |v: &CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find!(world, entity_0, |v: &mut CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find!(world, entity_1, |v: &mut CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find!(world, entity_3, |v: &mut CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find!(world, entity_4, |v: &mut CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find_borrow!(world, entity_0, |v: &mut CompA| assert_eq!(v.0, 0)).is_some());
    assert!(ecs_find_borrow!(world, entity_1, |v: &mut CompA| assert_eq!(v.0, 1)).is_some());
    assert!(ecs_find_borrow!(world, entity_3, |v: &mut CompA| assert_eq!(v.0, 3)).is_some());
    assert!(ecs_find_borrow!(world, entity_4, |v: &mut CompA| assert_eq!(v.0, 4)).is_some());

    assert!(ecs_find!(world, entity_2, |_: &CompA| panic!()).is_none());
    assert!(ecs_find!(world, entity_2, |_: &mut CompA| panic!()).is_none());

    assert!(ecs_find_borrow!(world, entity_2, |_: &CompA| panic!()).is_none());
    assert!(ecs_find_borrow!(world, entity_2, |_: &mut CompA| panic!()).is_none());
}

#[test]
#[rustfmt::skip]
pub fn test_single_iter() {
    let mut world = EcsWorld::default();

    let _entity_0 = world.arch_foo.create((CompA(0), CompZ,));
    let _entity_1 = world.arch_foo.create((CompA(1), CompZ,));
    let _entity_2 = world.arch_foo.create((CompA(2), CompZ,));
    let _entity_3 = world.arch_foo.create((CompA(3), CompZ,));
    let _entity_4 = world.arch_foo.create((CompA(4), CompZ,));

    let mut sum = 0;
    ecs_iter!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 0+1+2+3+4);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 0+1+2+3+4);

    let mut sum = 0;
    ecs_iter!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 0+1+2+3+4);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 0+1+2+3+4);

    world.arch_foo.destroy(_entity_2).unwrap();

    let mut sum = 0;
    ecs_iter!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 0+1+3+4);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 0+1+3+4);

    let mut sum = 0;
    ecs_iter!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 0+1+3+4);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 0+1+3+4);
}

#[test]
#[rustfmt::skip]
pub fn test_single_iter_write() {
    let mut world = EcsWorld::default();

    let _entity_0 = world.arch_foo.create((CompA(0), CompZ,));
    let _entity_1 = world.arch_foo.create((CompA(1), CompZ,));
    let _entity_2 = world.arch_foo.create((CompA(2), CompZ,));
    let _entity_3 = world.arch_foo.create((CompA(3), CompZ,));
    let _entity_4 = world.arch_foo.create((CompA(4), CompZ,));

    ecs_iter!(world, |v: &mut CompA| v.0 += 100);

    let mut sum = 0;
    ecs_iter!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 100+101+102+103+104);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 100+101+102+103+104);

    let mut sum = 0;
    ecs_iter!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 100+101+102+103+104);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 100+101+102+103+104);

    world.arch_foo.destroy(_entity_2).unwrap();

    let mut sum = 0;
    ecs_iter!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 100+101+103+104);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &CompA| sum += v.0);
    assert_eq!(sum, 100+101+103+104);

    let mut sum = 0;
    ecs_iter!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 100+101+103+104);

    let mut sum = 0;
    ecs_iter_borrow!(world, |v: &mut CompA| sum += v.0);
    assert_eq!(sum, 100+101+103+104);
}

#[test]
#[rustfmt::skip]
pub fn test_single_destroy_replace() {
    let mut world = EcsWorld::default();

    let entity_0 = world.arch_foo.create((CompA(0), CompZ,));
    let entity_1 = world.arch_foo.create((CompA(1), CompZ,));
    let entity_2 = world.arch_foo.create((CompA(2), CompZ,));
    let entity_3 = world.arch_foo.create((CompA(3), CompZ,));
    let entity_4 = world.arch_foo.create((CompA(4), CompZ,));

    assert_eq!(world.arch_foo.len(), 5);

    assert_eq!(world.arch_foo.destroy(entity_4).unwrap().0.0, 4);
    assert_eq!(world.arch_foo.len(), 4);

    assert_eq!(world.arch_foo.destroy(entity_1).unwrap().0.0, 1);
    assert_eq!(world.arch_foo.len(), 3);

    assert_eq!(world.arch_foo.destroy(entity_2).unwrap().0.0, 2);
    assert_eq!(world.arch_foo.len(), 2);

    assert_eq!(world.arch_foo.destroy(entity_3).unwrap().0.0, 3);
    assert_eq!(world.arch_foo.len(), 1);

    assert_eq!(world.arch_foo.destroy(entity_0).unwrap().0.0, 0);
    assert_eq!(world.arch_foo.len(), 0);

    assert!(ecs_find!(world, entity_0, |_: &CompA| panic!()).is_none());
    assert!(ecs_find!(world, entity_1, |_: &CompA| panic!()).is_none());
    assert!(ecs_find!(world, entity_2, |_: &CompA| panic!()).is_none());
    assert!(ecs_find!(world, entity_3, |_: &CompA| panic!()).is_none());
    assert!(ecs_find!(world, entity_4, |_: &CompA| panic!()).is_none());

    assert!(ecs_find_borrow!(world, entity_0, |_: &CompA| panic!()).is_none());
    assert!(ecs_find_borrow!(world, entity_1, |_: &CompA| panic!()).is_none());
    assert!(ecs_find_borrow!(world, entity_2, |_: &CompA| panic!()).is_none());
    assert!(ecs_find_borrow!(world, entity_3, |_: &CompA| panic!()).is_none());
    assert!(ecs_find_borrow!(world, entity_4, |_: &CompA| panic!()).is_none());

    assert!(world.arch_foo.destroy(entity_0).is_none());
    assert!(world.arch_foo.destroy(entity_1).is_none());
    assert!(world.arch_foo.destroy(entity_2).is_none());
    assert!(world.arch_foo.destroy(entity_3).is_none());
    assert!(world.arch_foo.destroy(entity_4).is_none());

    let entity_0b = world.arch_foo.create((CompA(1000), CompZ,));
    let entity_1b = world.arch_foo.create((CompA(1001), CompZ,));
    let entity_2b = world.arch_foo.create((CompA(1002), CompZ,));
    let entity_3b = world.arch_foo.create((CompA(1003), CompZ,));
    let entity_4b = world.arch_foo.create((CompA(1004), CompZ,));

    assert!(ecs_find!(world, entity_0b, |v: &CompA| assert_eq!(v.0, 1000)).is_some());
    assert!(ecs_find!(world, entity_1b, |v: &CompA| assert_eq!(v.0, 1001)).is_some());
    assert!(ecs_find!(world, entity_2b, |v: &CompA| assert_eq!(v.0, 1002)).is_some());
    assert!(ecs_find!(world, entity_3b, |v: &CompA| assert_eq!(v.0, 1003)).is_some());
    assert!(ecs_find!(world, entity_4b, |v: &CompA| assert_eq!(v.0, 1004)).is_some());

    assert!(ecs_find_borrow!(world, entity_0b, |v: &CompA| assert_eq!(v.0, 1000)).is_some());
    assert!(ecs_find_borrow!(world, entity_1b, |v: &CompA| assert_eq!(v.0, 1001)).is_some());
    assert!(ecs_find_borrow!(world, entity_2b, |v: &CompA| assert_eq!(v.0, 1002)).is_some());
    assert!(ecs_find_borrow!(world, entity_3b, |v: &CompA| assert_eq!(v.0, 1003)).is_some());
    assert!(ecs_find_borrow!(world, entity_4b, |v: &CompA| assert_eq!(v.0, 1004)).is_some());
}