shiv 0.1.0-alpha.10

A simple modern 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
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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
use std::sync::atomic::{AtomicU32, Ordering};

use crate::{
    bundle::{Bundle, Bundles},
    change_detection::{Mut, Ticks},
    query::{QueryState, ReadOnlyWorldQuery, WorldQuery},
    storage::{ComponentStorage, Resource, Storages},
    world::Entities,
};

use super::{Component, ComponentId, Components, Entity, EntityMut, EntityRef, Storage};

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct WorldId(usize);

impl WorldId {
    #[inline]
    pub fn new() -> Self {
        static NEXT_ID: AtomicU32 = AtomicU32::new(0);
        Self(NEXT_ID.fetch_add(1, Ordering::AcqRel) as usize)
    }

    #[inline]
    pub const fn index(self) -> usize {
        self.0
    }
}

pub trait FromWorld: Sized {
    fn from_world(world: &mut World) -> Self;
}

impl<T: Default> FromWorld for T {
    #[inline]
    fn from_world(_: &mut World) -> Self {
        Self::default()
    }
}

pub struct World {
    id: WorldId,
    pub(crate) entities: Entities,
    pub(crate) storage: Storages,
    pub(crate) bundles: Bundles,
    pub(crate) components: Components,
    pub(crate) change_tick: AtomicU32,
    pub(crate) last_change_tick: u32,
}

unsafe impl Send for World {}
unsafe impl Sync for World {}

impl Default for World {
    #[inline]
    fn default() -> Self {
        Self {
            id: WorldId::new(),
            entities: Entities::default(),
            storage: Storages::default(),
            bundles: Bundles::default(),
            components: Components::default(),
            change_tick: AtomicU32::new(1),
            last_change_tick: 0,
        }
    }
}

impl World {
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }

    #[inline]
    pub fn id(&self) -> WorldId {
        self.id
    }

    #[inline]
    pub fn entities(&self) -> &Entities {
        &self.entities
    }

    #[inline]
    pub fn reserve_entity(&self) -> Entity {
        self.entities.reserve()
    }

    #[inline]
    pub fn flush(&mut self) {
        self.entities.flush();
    }

    #[inline]
    pub fn contains_entity(&self, entity: Entity) -> bool {
        self.entities.contains(entity)
    }

    #[inline]
    pub fn init_component<T: Component>(&mut self) -> ComponentId {
        let id = self.components.init_component::<T>();
        let info = unsafe { self.components.get_unchecked(id) };

        let storage_sets = <T::Storage as Storage>::get_mut(&mut self.storage);
        storage_sets.initialize(info);

        id
    }
}

impl World {
    #[inline]
    pub fn query<Q: WorldQuery>(&mut self) -> QueryState<Q, ()> {
        QueryState::new(self)
    }

    #[inline]
    pub fn query_filtered<Q: WorldQuery, F: ReadOnlyWorldQuery>(&mut self) -> QueryState<Q, F> {
        QueryState::new(self)
    }
}

impl World {
    #[inline]
    pub fn contains_resource<T: Resource>(&self) -> bool {
        if let Some(id) = self.components.get_resource::<T>() {
            self.storage.resources.contains(id)
        } else {
            false
        }
    }

    #[inline]
    pub fn insert_resource<T: Resource>(&mut self, resource: T) {
        let id = self.components.init_resource::<T>();

        unsafe {
            self.storage
                .resources
                .insert(id, Box::new(resource), self.change_tick())
        };
    }

    #[inline]
    pub fn init_resource<T: Resource + FromWorld>(&mut self) {
        if !self.contains_resource::<T>() {
            let resource = T::from_world(self);
            self.insert_resource(resource);
        }
    }

    #[inline]
    pub fn remove_resource<T: Resource>(&mut self) -> Option<T> {
        let id = self.components.init_resource::<T>();
        let resource = self.storage.resources.remove(id)?;
        unsafe { Some(*Box::from_raw(resource as *mut T)) }
    }

    #[inline]
    pub fn get_resource<T: Resource>(&self) -> Option<&T> {
        let id = self.components.get_resource::<T>()?;
        let resource = self.storage.resources.get(id)?;
        unsafe { Some(&*(resource as *mut T)) }
    }

    #[inline]
    pub fn get_resource_mut<T: Resource>(&mut self) -> Option<Mut<T>> {
        let id = self.components.get_resource::<T>()?;
        let (resource, change_ticks) = self.storage.resources.get_with_ticks(id)?;

        Some(Mut {
            value: unsafe { &mut *(resource as *mut T) },
            ticks: Ticks {
                ticks: unsafe { &mut *change_ticks },
                last_change_tick: self.last_change_tick(),
                change_tick: self.change_tick(),
            },
        })
    }

    #[inline]
    #[track_caller]
    pub fn resource<T: Resource>(&self) -> &T {
        self.get_resource().unwrap_or_else(|| {
            panic!(
                "resource `{}` does not exist in world",
                std::any::type_name::<T>(),
            )
        })
    }

    #[inline]
    #[track_caller]
    pub fn resource_mut<T: Resource>(&mut self) -> Mut<T> {
        self.get_resource_mut().unwrap_or_else(|| {
            panic!(
                "resource `{}` does not exist in world",
                std::any::type_name::<T>(),
            )
        })
    }

    #[inline]
    pub fn resource_or_default<T: Resource + FromWorld>(&mut self) -> Mut<T> {
        self.init_resource::<T>();
        self.resource_mut()
    }
}

impl World {
    #[inline]
    pub fn spawn(&mut self) -> EntityMut<'_> {
        let entity = self.entities.alloc();
        EntityMut::new(self, entity)
    }

    #[inline]
    pub fn get_or_spawn(&mut self, entity: Entity) -> EntityMut<'_> {
        if self.contains_entity(entity) {
            EntityMut::new(self, entity)
        } else {
            if let Some(entity) = self.entities.get(entity.index() as usize) {
                self.despawn(entity);
            }

            self.entities.alloc_at(entity);
            EntityMut::new(self, entity)
        }
    }

    #[inline]
    pub fn remove<T: Bundle>(&mut self, entity: Entity) -> Option<T> {
        let bundle_info = self.bundles.init_bundle::<T>(&mut self.components);
        unsafe { bundle_info.remove::<T>(entity, &mut self.components, &mut self.storage) }
    }

    #[inline]
    pub fn get_entity(&self, entity: Entity) -> Option<EntityRef<'_>> {
        if self.entities.contains(entity) {
            Some(EntityRef::new(self, entity))
        } else {
            None
        }
    }

    #[inline]
    pub fn get_entity_mut(&mut self, entity: Entity) -> Option<EntityMut<'_>> {
        if self.entities.contains(entity) {
            Some(EntityMut::new(self, entity))
        } else {
            None
        }
    }

    #[inline]
    #[track_caller]
    pub fn entity(&self, entity: Entity) -> EntityRef<'_> {
        if let Some(entity) = self.get_entity(entity) {
            entity
        } else {
            panic!(
                "Attempting to create EntityRef for entity {}, which does not exist.",
                entity,
            )
        }
    }

    #[inline]
    #[track_caller]
    pub fn entity_mut(&mut self, entity: Entity) -> EntityMut<'_> {
        if let Some(entity) = self.get_entity_mut(entity) {
            entity
        } else {
            panic!(
                "Attempting to create EntityMut for entity {}, which does not exist.",
                entity,
            )
        }
    }

    #[inline]
    pub fn contains<T: Component>(&self, entity: Entity) -> bool {
        let id = if let Some(id) = self.components.get_component::<T>() {
            id
        } else {
            return false;
        };

        let storage_sets = <T::Storage as Storage>::get(&self.storage);
        let storage = unsafe { storage_sets.get_unchecked(id) };

        storage.contains(entity)
    }

    #[inline]
    pub fn get<T: Component>(&self, entity: Entity) -> Option<&T> {
        let id = self.components.get_component::<T>()?;

        let storage_sets = <T::Storage as Storage>::get(&self.storage);
        let storage = unsafe { storage_sets.get_unchecked(id) };

        let ptr = storage.get(entity)?;
        Some(unsafe { &*(ptr as *const T) })
    }

    #[inline]
    pub fn get_mut<T: Component>(&mut self, entity: Entity) -> Option<Mut<'_, T>> {
        let id = self.components.get_component::<T>()?;

        let storage_sets = <T::Storage as Storage>::get_mut(&mut self.storage);
        let storage = unsafe { storage_sets.get_unchecked_mut(id) };

        let ptr = storage.get(entity)?;
        let ticks = unsafe { storage.get_ticks_unchecked(entity) };

        Some(Mut {
            value: unsafe { &mut *(ptr as *mut T) },
            ticks: Ticks {
                ticks: unsafe { &mut *ticks.get() },
                last_change_tick: self.last_change_tick(),
                change_tick: self.change_tick(),
            },
        })
    }

    #[inline]
    pub fn despawn(&mut self, entity: Entity) -> bool {
        self.storage.remove(entity);
        self.entities.free(entity)
    }
}

impl World {
    #[inline]
    pub fn check_change_ticks(&mut self) {
        let change_tick = self.change_tick();

        self.storage.check_change_ticks(change_tick);
    }

    pub fn clear_trackers(&mut self) {
        self.last_change_tick = self.change_tick();
    }
}

impl World {
    #[inline]
    pub fn increment_change_tick(&self) -> u32 {
        self.change_tick.fetch_add(1, Ordering::AcqRel)
    }

    #[inline]
    pub fn change_tick(&self) -> u32 {
        self.change_tick.load(Ordering::Acquire)
    }

    #[inline]
    pub fn set_last_change_tick(&mut self, tick: u32) {
        self.last_change_tick = tick;
    }

    #[inline]
    pub fn last_change_tick(&self) -> u32 {
        self.last_change_tick
    }
}

impl std::fmt::Debug for World {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("World")
            .field("entity_count", &self.entities.len())
            .field("component_count", &self.components.len())
            .field("resource_count", &self.storage.resources.len())
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use shiv_macro::Bundle;

    use crate as shiv;
    use crate::query::Or;
    use crate::{
        query::{With, Without},
        storage::DenseStorage,
        world::{Component, Entity, World},
    };

    impl Component for i32 {
        type Storage = DenseStorage;
    }

    impl Component for f32 {
        type Storage = DenseStorage;
    }

    impl Component for bool {
        type Storage = DenseStorage;
    }

    #[test]
    fn components() {
        let mut world = World::new();
        let entity = world.spawn().insert(2i32).insert(false).entity();

        assert_eq!(*world.entity(entity).get::<i32>().unwrap(), 2);
        assert_eq!(*world.entity(entity).get::<bool>().unwrap(), false);
    }

    #[test]
    fn replace_component() {
        let mut world = World::new();

        let entity = world.spawn().insert(2i32).entity();

        assert_eq!(*world.entity(entity).get::<i32>().unwrap(), 2);

        world.entity_mut(entity).insert(3i32);

        assert_eq!(*world.entity(entity).get::<i32>().unwrap(), 3);
    }

    #[test]
    fn despawn() {
        let mut world = World::new();
        let entity = world.spawn().insert(2i32).insert(false).entity();

        assert!(world.despawn(entity));
        assert!(!world.despawn(entity));
        assert!(!world.contains_entity(entity));

        let new_entity = world.spawn().entity();

        assert!(world.contains_entity(new_entity));
        assert!(!world.contains_entity(entity));

        world.entity_mut(new_entity).insert(2i32);

        assert_eq!(*world.entity(new_entity).get::<i32>().unwrap(), 2);
        assert!(!world.contains_entity(entity));
    }

    #[test]
    fn zst() {
        #[derive(Component, Debug, PartialEq)]
        struct Zst;

        let mut world = World::new();
        let a = world.spawn().insert(Zst).insert(2i32).entity();
        let b = world.spawn().insert(2i32).insert(Zst).entity();

        let query = world.query::<(Entity, &Zst, &i32)>();
        let mut iter = query.iter(&world);

        assert_eq!(iter.next(), Some((a, &Zst, &2)));
        assert_eq!(iter.next(), Some((b, &Zst, &2)));
    }

    #[test]
    fn multiple_entities() {
        let mut world = World::new();
        let entity1 = world.spawn().insert(2i32).entity();
        let entity2 = world.spawn().insert(false).entity();

        assert_eq!(*world.entity(entity1).get::<i32>().unwrap(), 2);
        assert_eq!(*world.entity(entity2).get::<bool>().unwrap(), false);
    }

    #[test]
    fn query_get() {
        let mut world = World::new();
        let entity1 = world.spawn().insert(2i32).entity();
        let entity2 = world.spawn().insert(3i32).entity();
        let entity3 = world.spawn().entity();

        let mut query = world.query::<&mut i32>();

        assert_eq!(query.get(&world, entity1).unwrap(), &2);
        assert_eq!(query.get(&world, entity2).unwrap(), &3);
        assert!(query.get(&world, entity3).is_none());

        *query.get_mut(&mut world, entity1).unwrap() *= 2;

        assert_eq!(query.get(&world, entity1).unwrap(), &4);
    }

    #[test]
    fn query_filter() {
        let mut world = World::new();

        let entity1 = world.spawn().insert(2i32).entity();
        let entity2 = world.spawn().insert(3i32).insert(false).entity();

        let query = world.query_filtered::<&i32, Without<bool>>();

        assert_eq!(query.get(&world, entity1).unwrap(), &2);
        assert!(query.get(&world, entity2).is_none());

        let query = world.query_filtered::<&i32, With<bool>>();

        assert!(query.get(&world, entity1).is_none());
        assert_eq!(query.get(&world, entity2).unwrap(), &3);
    }

    #[test]
    fn query_iter() {
        let mut world = World::new();

        let entity1 = world.spawn().insert(2i32).entity();
        let entity2 = world.spawn().entity();
        let entity3 = world.spawn().insert(3i32).entity();

        let mut query = world.query::<(Entity, &mut i32)>();

        let mut iter = query.iter(&world);
        assert_eq!(iter.next().unwrap(), (entity1, &2));
        assert_eq!(iter.next().unwrap(), (entity3, &3));
        assert!(iter.next().is_none());

        let mut iter = query.iter_mut(&mut world);
        *iter.next().unwrap().1 *= 2;
        *iter.next().unwrap().1 *= 3;

        let mut iter = query.iter(&world);
        assert_eq!(iter.next().unwrap(), (entity1, &4));
        assert_eq!(iter.next().unwrap(), (entity3, &9));
        assert!(iter.next().is_none());

        let query = world.query::<Entity>();

        let mut iter = query.iter(&world);
        assert_eq!(iter.next().unwrap(), entity1);
        assert_eq!(iter.next().unwrap(), entity2);
        assert_eq!(iter.next().unwrap(), entity3);
    }

    #[test]
    fn query_iter_filter() {
        let mut world = World::new();

        let entity1 = world.spawn().insert(2i32).entity();
        let entity2 = world.spawn().insert(3i32).insert(false).entity();
        let entity3 = world.spawn().insert(4i32).insert(0.4f32).entity();

        let query = world.query_filtered::<(Entity, &i32), Without<bool>>();

        let mut iter = query.iter(&world);

        assert_eq!(iter.next().unwrap(), (entity1, &2));
        assert_eq!(iter.next().unwrap(), (entity3, &4));
        assert!(iter.next().is_none());

        let query = world.query_filtered::<(Entity, &i32), With<bool>>();

        let mut iter = query.iter(&world);

        assert_eq!(iter.next().unwrap(), (entity2, &3));
        assert!(iter.next().is_none());

        let query = world.query_filtered::<&i32, Or<(With<f32>, With<bool>)>>();

        let mut iter = query.iter(&world);

        assert_eq!(iter.next().unwrap(), &3);
        assert_eq!(iter.next().unwrap(), &4);
        assert!(iter.next().is_none());
    }

    #[test]
    fn query_option() {
        let mut world = World::new();

        world.spawn().insert(2i32);
        world.spawn();
        world.spawn().insert(3i32).insert(true);
        world.spawn().insert(4i32);

        let query = world.query::<(&i32, Option<&bool>)>();
        let mut iter = query.iter(&world);

        assert_eq!(iter.next().unwrap(), (&2, None));
        assert_eq!(iter.next().unwrap(), (&3, Some(&true)));
        assert_eq!(iter.next().unwrap(), (&4, None));
        assert!(iter.next().is_none());
    }

    #[test]
    fn bundle() {
        #[derive(Bundle)]
        struct TestBundle {
            a: i32,
            b: bool,
        }

        let bundle = TestBundle { a: 2, b: true };

        let mut world = World::new();
        let mut entity = world.spawn();
        entity.insert(bundle);

        assert_eq!(entity.get::<i32>().unwrap(), &2);
        assert_eq!(entity.get::<bool>().unwrap(), &true);

        let bundle = entity.remove::<TestBundle>().unwrap();

        assert_eq!(bundle.a, 2);
        assert_eq!(bundle.b, true);
    }
}