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
use std::{
    cmp::Ordering,
    hash::{Hash, Hasher},
    marker::PhantomData,
    mem,
    ops::{Deref, DerefMut},
};

use crate::{
    schedule::{SystemLabel, SystemLabelId},
    system::{
        Local, LocalState, ReadOnlySystemParamFetch, Res, ResMut, ResMutInit, ResMutState,
        ResState, SystemMeta, SystemParam, SystemParamFetch, SystemParamState,
    },
    world::World,
};

/// [`Event`]s are used to communicate between systems.
///
/// Use an [`EventReader`] to read events and an [`EventWriter`] to send events.
pub trait Event: Send + Sync + 'static {}
impl<T: Send + Sync + 'static> Event for T {}

/// An identifier for an [`Event`].
pub struct EventId<E: Event> {
    pub id: usize,
    _marker: PhantomData<E>,
}

impl<E: Event> EventId<E> {
    #[inline]
    pub const fn new(id: usize) -> Self {
        EventId {
            id,
            _marker: PhantomData,
        }
    }
}

impl<E: Event> Clone for EventId<E> {
    #[inline]
    fn clone(&self) -> Self {
        EventId {
            id: self.id,
            _marker: PhantomData,
        }
    }
}

impl<E: Event> Copy for EventId<E> {}

impl<E: Event> PartialEq for EventId<E> {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.id == other.id
    }
}

impl<E: Event> Eq for EventId<E> {}

impl<E: Event> PartialOrd for EventId<E> {
    #[inline]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.id.partial_cmp(&other.id)
    }
}

impl<E: Event> Ord for EventId<E> {
    #[inline]
    fn cmp(&self, other: &Self) -> Ordering {
        self.id.cmp(&other.id)
    }
}

impl<E: Event> Hash for EventId<E> {
    #[inline]
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.id.hash(state);
    }
}

impl<E: Event> std::fmt::Debug for EventId<E> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "EventId<{}>({})", std::any::type_name::<E>(), self.id)
    }
}

#[derive(Debug)]
struct EventInstance<E: Event> {
    id: EventId<E>,
    event: E,
}

#[derive(Debug)]
struct EventSequence<E: Event> {
    events: Vec<EventInstance<E>>,
    start_event_count: usize,
}

impl<E: Event> Default for EventSequence<E> {
    #[inline]
    fn default() -> Self {
        EventSequence {
            events: Vec::new(),
            start_event_count: 0,
        }
    }
}

impl<E: Event> Deref for EventSequence<E> {
    type Target = Vec<EventInstance<E>>;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.events
    }
}

impl<E: Event> DerefMut for EventSequence<E> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.events
    }
}

/// A [`SystemLabel`] for [`Event::update_system`].
pub struct UpdateEventsSystem<T: Event> {
    _marker: PhantomData<T>,
}

impl<T: Event> UpdateEventsSystem<T> {
    #[inline]
    pub const fn new() -> Self {
        UpdateEventsSystem {
            _marker: PhantomData,
        }
    }
}

impl<T: Event> SystemLabel for UpdateEventsSystem<T> {
    #[inline]
    fn label(self) -> SystemLabelId {
        SystemLabelId::from_raw_parts::<Self>(std::any::type_name::<Self>(), 0)
    }
}

#[derive(Clone, Copy, Debug, Default)]
pub struct EventSystem;

impl SystemLabel for EventSystem {
    #[inline]
    fn label(self) -> SystemLabelId {
        SystemLabelId::from_raw_parts::<Self>(std::any::type_name::<Self>(), 0)
    }
}

/// Storage [`Resource`] for [`Event`]s.
///
/// This should usually not be used manually see, [`EventReader`] and [`EventWriter`].
#[derive(Debug)]
pub struct Events<E: Event> {
    events_a: EventSequence<E>,
    events_b: EventSequence<E>,
    event_count: usize,
}

impl<E: Event> Default for Events<E> {
    #[inline]
    fn default() -> Self {
        Events {
            events_a: EventSequence::default(),
            events_b: EventSequence::default(),
            event_count: 0,
        }
    }
}

impl<E: Event> Events<E> {
    #[inline]
    pub fn oldest_event_count(&self) -> usize {
        let a = self.events_a.start_event_count;
        let b = self.events_b.start_event_count;
        usize::min(a, b)
    }

    #[inline]
    pub fn send(&mut self, event: E) {
        let id = EventId::new(self.event_count);
        let instance = EventInstance { id, event };

        self.events_b.push(instance);
        self.event_count += 1;
    }

    #[inline]
    pub fn len(&self) -> usize {
        self.events_a.len() + self.events_b.len()
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    #[inline]
    pub fn update(&mut self) {
        mem::swap(&mut self.events_a, &mut self.events_b);
        self.events_b.clear();
        self.events_b.start_event_count = self.event_count;
    }

    #[inline]
    pub fn update_system(mut events: ResMutInit<Self>) {
        events.update();
    }

    #[inline]
    pub fn clear(&mut self) {
        self.reset();
        self.events_a.clear();
        self.events_b.clear();
    }

    #[inline]
    fn reset(&mut self) {
        self.events_a.start_event_count = self.event_count;
        self.events_b.start_event_count = self.event_count;
    }

    #[inline]
    pub fn drain(&mut self) -> impl Iterator<Item = E> + '_ {
        self.reset();

        self.events_a
            .drain(..)
            .chain(self.events_b.drain(..))
            .map(|e| e.event)
    }
}

/// A reader for [`Event`]s.
#[derive(Debug)]
pub struct EventReader<'w, 's, E: Event> {
    reader: Local<'s, ManualEventReader<E>>,
    events: Res<'w, Events<E>>,
}

impl<'w, 's, E: Event> EventReader<'w, 's, E> {
    #[inline]
    pub fn iter(&mut self) -> impl DoubleEndedIterator<Item = &E> {
        self.reader.iter(&self.events)
    }

    #[inline]
    pub fn iter_with_id(&mut self) -> impl DoubleEndedIterator<Item = (EventId<E>, &E)> {
        self.reader.iter_with_id(&self.events)
    }

    #[inline]
    pub fn len(&self) -> usize {
        self.reader.len(&self.events)
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        self.reader.is_empty(&self.events)
    }

    #[inline]
    pub fn clear(&mut self) {
        self.iter().last();
    }
}

#[doc(hidden)]
#[derive(Debug)]
pub struct EventReaderState<E: Event> {
    reader: LocalState<ManualEventReader<E>>,
    events: ResState<Events<E>>,
}

unsafe impl<E: Event> ReadOnlySystemParamFetch for EventReaderState<E> {}

unsafe impl<E: Event> SystemParamState for EventReaderState<E> {
    #[inline]
    fn init(world: &mut World, meta: &mut SystemMeta) -> Self {
        world.init_resource::<Events<E>>();

        Self {
            reader: LocalState::init(world, meta),
            events: ResState::init(world, meta),
        }
    }
}

impl<'w, 's, E: Event> SystemParamFetch<'w, 's> for EventReaderState<E> {
    type Item = EventReader<'w, 's, E>;

    #[inline]
    unsafe fn get_param(
        &'s mut self,
        meta: &SystemMeta,
        world: &'w World,
        change_tick: u32,
    ) -> Self::Item {
        EventReader {
            reader: unsafe { self.reader.get_param(meta, world, change_tick) },
            events: unsafe { self.events.get_param(meta, world, change_tick) },
        }
    }
}

impl<'w, 's, E: Event> SystemParam for EventReader<'w, 's, E> {
    type Fetch = EventReaderState<E>;
}

/// A writer for [`Event`]s.
///
/// Use [`EventWriter::send`] to send events.
#[derive(Debug)]
pub struct EventWriter<'w, E: Event> {
    events: ResMut<'w, Events<E>>,
}

impl<'w, E: Event> EventWriter<'w, E> {
    /// Sends an event.
    #[inline]
    pub fn send(&mut self, event: E) {
        self.events.send(event);
    }

    /// Sends [`Default::default`].
    #[inline]
    pub fn send_default(&mut self)
    where
        E: Default,
    {
        self.events.send(E::default());
    }
}

#[doc(hidden)]
#[derive(Debug)]
pub struct EventWriterState<E: Event> {
    events: ResMutState<Events<E>>,
}

unsafe impl<E: Event> SystemParamState for EventWriterState<E> {
    #[inline]
    fn init(world: &mut World, meta: &mut SystemMeta) -> Self {
        world.init_resource::<Events<E>>();

        Self {
            events: ResMutState::init(world, meta),
        }
    }
}

impl<'w, 's, E: Event> SystemParamFetch<'w, 's> for EventWriterState<E> {
    type Item = EventWriter<'w, E>;

    #[inline]
    unsafe fn get_param(
        &'s mut self,
        meta: &SystemMeta,
        world: &'w World,
        change_tick: u32,
    ) -> Self::Item {
        EventWriter {
            events: unsafe { self.events.get_param(meta, world, change_tick) },
        }
    }
}

impl<'w, E: Event> SystemParam for EventWriter<'w, E> {
    type Fetch = EventWriterState<E>;
}

/// A manual event reader.
///
/// This should usually be used through [`EventReader`].
#[derive(Debug)]
pub struct ManualEventReader<E: Event> {
    last_event_count: usize,
    _marker: PhantomData<E>,
}

impl<E: Event> Default for ManualEventReader<E> {
    #[inline]
    fn default() -> Self {
        ManualEventReader {
            last_event_count: 0,
            _marker: PhantomData,
        }
    }
}

impl<E: Event> ManualEventReader<E> {
    #[inline]
    pub fn iter<'a>(&'a mut self, events: &'a Events<E>) -> impl DoubleEndedIterator<Item = &'a E> {
        self.iter_with_id(events).map(|(_, event)| event)
    }

    #[inline]
    pub fn iter_with_id<'a>(
        &'a mut self,
        events: &'a Events<E>,
    ) -> impl DoubleEndedIterator<Item = (EventId<E>, &'a E)> {
        let a_index = (self.last_event_count).saturating_sub(events.events_a.start_event_count);
        let b_index = (self.last_event_count).saturating_sub(events.events_b.start_event_count);
        let a = events.events_a.get(a_index..).unwrap_or_default();
        let b = events.events_b.get(b_index..).unwrap_or_default();

        let unread_count = a.len() + b.len();

        self.last_event_count = events.event_count - unread_count;

        let iterator = a.iter().chain(b.iter());
        iterator
            .map(move |e| (e.id, &e.event))
            .inspect(move |(id, _)| {
                self.last_event_count = usize::max(id.id + 1, self.last_event_count)
            })
    }

    #[inline]
    pub fn missed_events(&self, events: &Events<E>) -> usize {
        events
            .oldest_event_count()
            .saturating_sub(self.last_event_count)
    }

    #[inline]
    pub fn len(&self, events: &Events<E>) -> usize {
        events
            .event_count
            .saturating_sub(self.last_event_count)
            .min(events.len())
    }

    #[inline]
    pub fn is_empty(&self, events: &Events<E>) -> bool {
        self.len(events) == 0
    }
}