matrix_engine 0.2.4

a small game engine developed by drmatrix
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
use std::marker::PhantomData;

use super::{
    data_state::DataStateAccessError,
    entity::SystemEntity,
    query::{Query, QueryError},
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum SystemError {
    MissingArgs,
}

pub trait System<Queryable, EngineArgs> {
    fn prepare_args(
        &mut self,
        queryable: &mut Queryable,
        system_id: &SystemEntity,
    ) -> Result<(), QueryError>;

    fn run(&mut self, run_args: &EngineArgs) -> Result<(), SystemError>;

    fn consume(
        &mut self,
        queryable: &mut Queryable,
        system_id: &SystemEntity,
    ) -> Result<(), DataStateAccessError>;
}

pub trait QuerySystem<Queryable, EngineArgs> {
    type Query: Query<Queryable>;
    fn run(&mut self, engine_args: &EngineArgs, args: &mut Self::Query);
}
pub trait IntoNonSendSystem<Queryable, EngineArgs, Placeholder> {
    fn into_system(self) -> impl System<Queryable, EngineArgs>;
}
pub trait IntoSendSystem<Queryable, EngineArgs: Send, Placeholder> {
    fn into_system(self) -> impl System<Queryable, EngineArgs> + Send;
}

pub struct QuerySystemWrapper<
    Q: Query<Queryable>,
    Queryable,
    EngineArgs,
    QS: QuerySystem<Queryable, EngineArgs, Query = Q>,
> {
    system: QS,
    args: Option<Q>,
    marker: PhantomData<(Queryable, EngineArgs)>,
}

impl<
        Q: Query<Queryable>,
        Queryable,
        EngineArgs,
        QS: QuerySystem<Queryable, EngineArgs, Query = Q>,
    > QuerySystemWrapper<Q, Queryable, EngineArgs, QS>
{
    pub fn new(system: QS) -> Self {
        Self {
            system,
            args: None,
            marker: PhantomData,
        }
    }
}

impl<
        Q: Query<Queryable>,
        Queryable,
        EngineArgs,
        QS: QuerySystem<Queryable, EngineArgs, Query = Q>,
    > System<Queryable, EngineArgs> for QuerySystemWrapper<Q, Queryable, EngineArgs, QS>
{
    fn prepare_args(
        &mut self,
        queryable: &mut Queryable,
        system_id: &SystemEntity,
    ) -> Result<(), QueryError> {
        assert!(self.args.is_none());
        self.args = Some(Q::query(queryable, system_id).map_err(|_| QueryError::NotAvailable)?);
        Ok(())
    }

    fn run(&mut self, engine_args: &EngineArgs) -> Result<(), SystemError> {
        let args = self.args.as_mut();
        if let Some(args) = args {
            self.system.run(engine_args, args);
            Ok(())
        } else {
            Err(SystemError::MissingArgs)
        }
    }

    fn consume(
        &mut self,
        queryable: &mut Queryable,
        system_id: &SystemEntity,
    ) -> Result<(), DataStateAccessError> {
        self.args.take().unwrap().consume(queryable, system_id)
    }
}

pub struct QuerySystemFn<Q: Query<Queryable>, Queryable, Fn: FnMut(&mut Q)>(
    Fn,
    PhantomData<(Q, Queryable)>,
);
// pub struct QuerySystemFnWithArgs<
//     Q: Query<Queryable>,
//     Queryable,
//     EngineArgs,
//     Fn: FnMut(&mut EngineArgs, &mut Q),
// >(Fn, PhantomData<(Q, Queryable, EngineArgs)>);

// impl<Q: Query<Queryable>, Queryable, EngineArgs, Fn: FnMut(&mut EngineArgs, &mut Q)>
//     QuerySystemFnWithArgs<Q, Queryable, EngineArgs, Fn>
// {
//     pub fn new(f: Fn) -> Self {
//         Self(f, PhantomData)
//     }
// }

// impl<Q: Query<Queryable>, Queryable, Fn: FnMut(&mut Q)> QuerySystemFn<Q, Queryable, Fn> {
//     pub fn new(f: Fn) -> Self {
//         Self(f, PhantomData)
//     }
// }

// impl<Q: Query<Queryable>, Queryable, Fn: FnMut(&mut Q), EngineArgs>
//     QuerySystem<Queryable, EngineArgs> for QuerySystemFn<Q, Queryable, Fn>
// {
//     type Query = Q;

//     fn run(&mut self, _engine_args: &mut EngineArgs, args: &mut Self::Query) {
//         (self.0)(args);
//     }
// }
// impl<Q: Query<Queryable>, Queryable, Fn: FnMut(&mut EngineArgs, &mut Q), EngineArgs>
//     QuerySystem<Queryable, EngineArgs> for QuerySystemFnWithArgs<Q, Queryable, EngineArgs, Fn>
// {
//     type Query = Q;

//     fn run(&mut self, engine_args: &mut EngineArgs, args: &mut Self::Query) {
//         (self.0)(engine_args, args);
//     }
// }

pub struct FnPlaceHolderNonSend<Q: Query<Queryable>, Queryable>(PhantomData<(Q, Queryable)>);

// impl<Q: Query<Queryable>, Queryable, EngineArgs, F: FnMut(&mut Q)>
//     IntoNonSendSystem<Queryable, EngineArgs, FnPlaceHolderNonSend<Q, Queryable>> for F
// {
//     fn into_system(self) -> impl System<Queryable, EngineArgs> {
//         QuerySystemWrapper::new(QuerySystemFn::new(self))
//     }
// }
pub struct QsNonSendPlaceHolder<Q: Query<Queryable>, Queryable>(PhantomData<(Q, Queryable)>);
impl<
        Q: Query<Queryable>,
        Queryable,
        EngineArgs,
        QS: QuerySystem<Queryable, EngineArgs, Query = Q>,
    > IntoNonSendSystem<Queryable, EngineArgs, QsNonSendPlaceHolder<Q, Queryable>> for QS
{
    fn into_system(self) -> impl System<Queryable, EngineArgs> {
        QuerySystemWrapper::new(self)
    }
}
pub struct QsSendPlaceHolder<Q: Query<Queryable> + Send, Queryable: Send>(
    PhantomData<(Q, Queryable)>,
);
impl<
        Q: Query<Queryable> + Send,
        Queryable: Send,
        EngineArgs: Send,
        QS: QuerySystem<Queryable, EngineArgs, Query = Q> + Send,
    > IntoSendSystem<Queryable, EngineArgs, QsSendPlaceHolder<Q, Queryable>> for QS
{
    fn into_system(self) -> impl System<Queryable, EngineArgs> + Send {
        QuerySystemWrapper::new(self)
    }
}

pub struct FnPlaceHolderSend<Q: Query<Queryable> + Send, Queryable: Send>(
    PhantomData<(Q, Queryable)>,
);
// impl<Q: Query<Queryable> + Send, Queryable: Send, EngineArgs: Send, F: FnMut(&mut Q) + Send>
//     IntoSendSystem<Queryable, EngineArgs, FnPlaceHolderNonSend<Q, Queryable>> for F
// {
//     fn into_system(self) -> impl System<Queryable, EngineArgs> + Send {
//         QuerySystemWrapper::new(QuerySystemFn::new(self))
//     }
// }
pub struct FnSendPlaceHolderWithArgs<Q: Query<Queryable> + Send, Queryable: Send>(
    PhantomData<(Q, Queryable)>,
);
// impl<
//         Q: Query<Queryable> + Send,
//         Queryable: Send,
//         EngineArgs: Send,
//         F: FnMut(&mut EngineArgs, &mut Q) + Send,
//     > IntoSendSystem<Queryable, EngineArgs, FnSendPlaceHolderWithArgs<Q, Queryable>> for F
// {
//     fn into_system(self) -> impl System<Queryable, EngineArgs> + Send {
//         QuerySystemWrapper::new(QuerySystemFnWithArgs::new(self))
//     }
// }

pub struct FnNonSendPlaceHolderWithArgs<Q: Query<Queryable>, Queryable>(
    PhantomData<(Q, Queryable)>,
);
// impl<Q: Query<Queryable>, Queryable, EngineArgs, F: FnMut(&mut EngineArgs, &mut Q)>
//     IntoNonSendSystem<Queryable, EngineArgs, FnNonSendPlaceHolderWithArgs<Q, Queryable>> for F
// {
//     fn into_system(self) -> impl System<Queryable, EngineArgs> {
//         QuerySystemWrapper::new(QuerySystemFnWithArgs::new(self))
//     }
// }

pub struct SystemRegistry<Queryable, SendEngineArgs: Send, NonSendEngineArgs> {
    send_systems: Vec<BoxedSendSystem<Queryable, SendEngineArgs>>,
    non_send_systems: Vec<BoxedNonSendSystem<Queryable, NonSendEngineArgs>>,
}

impl<Queryable, SendEngineArgs: Send, NonSendEngineArgs>
    SystemRegistry<Queryable, SendEngineArgs, NonSendEngineArgs>
{
    pub fn new() -> Self {
        Self {
            send_systems: Vec::new(),
            non_send_systems: Vec::new(),
        }
    }
    pub fn add_send_system(&mut self, system: Box<dyn System<Queryable, SendEngineArgs> + Send>) {
        self.send_systems.push(BoxedSendSystem::new(system));
    }

    pub fn add_non_send_system(&mut self, system: Box<dyn System<Queryable, NonSendEngineArgs>>) {
        self.non_send_systems.push(BoxedNonSendSystem::new(system));
    }

    pub fn send_systems(&self) -> &Vec<BoxedSendSystem<Queryable, SendEngineArgs>> {
        &self.send_systems
    }

    pub fn send_systems_mut(&mut self) -> &mut Vec<BoxedSendSystem<Queryable, SendEngineArgs>> {
        &mut self.send_systems
    }

    pub fn non_send_systems(&self) -> &Vec<BoxedNonSendSystem<Queryable, NonSendEngineArgs>> {
        &self.non_send_systems
    }

    pub fn non_send_systems_mut(
        &mut self,
    ) -> &mut Vec<BoxedNonSendSystem<Queryable, NonSendEngineArgs>> {
        &mut self.non_send_systems
    }

    pub(crate) fn destroy_system(&mut self, id: SystemEntity) -> bool {
        let i = self.send_systems.iter().position(|x| x.id == id);
        if let Some(i) = i {
            self.send_systems.remove(i);
            return true;
        }
        let i = self.non_send_systems.iter().position(|x| x.id == id);
        if let Some(i) = i {
            self.non_send_systems.remove(i);
            return true;
        }
        false
    }
}

impl<Queryable, SendEngineArgs: Send, NonSendEngineArgs> Default
    for SystemRegistry<Queryable, SendEngineArgs, NonSendEngineArgs>
{
    fn default() -> Self {
        Self::new()
    }
}

pub struct BoxedSendSystem<Queryable, Args: Send = ()> {
    id: SystemEntity,
    system: Box<dyn System<Queryable, Args> + Send>,
}

impl<Queryable, Args: Send> BoxedSendSystem<Queryable, Args> {
    pub fn new(system: Box<dyn System<Queryable, Args> + Send>) -> Self {
        Self {
            id: SystemEntity::new(),
            system,
        }
    }
    pub fn from_system(sys: impl System<Queryable, Args> + Send + 'static) -> Self {
        Self::new(Box::new(sys))
    }
    pub fn system(&self) -> &dyn System<Queryable, Args> {
        &*self.system
    }
    pub fn system_mut(&mut self) -> &mut dyn System<Queryable, Args> {
        &mut *self.system
    }
    pub fn id(&self) -> &SystemEntity {
        &self.id
    }

    pub fn prepare_args(&mut self, queryable: &mut Queryable) -> Result<(), QueryError> {
        self.system.prepare_args(queryable, &self.id)
    }
    pub fn run(&mut self, args: &Args) -> Result<(), SystemError> {
        self.system.run(args)
    }
    pub fn consume(&mut self, queryable: &mut Queryable) -> Result<(), DataStateAccessError> {
        self.system.consume(queryable, &self.id)
    }
}

pub struct BoxedNonSendSystem<Queryable, Args = ()> {
    id: SystemEntity,
    system: Box<dyn System<Queryable, Args>>,
}

impl<Queryable, Args> BoxedNonSendSystem<Queryable, Args> {
    pub fn new(system: Box<dyn System<Queryable, Args>>) -> Self {
        Self {
            id: SystemEntity::new(),
            system,
        }
    }
    pub fn from_system(sys: impl System<Queryable, Args> + 'static) -> Self {
        Self::new(Box::new(sys))
    }
    pub fn system(&self) -> &dyn System<Queryable, Args> {
        &*self.system
    }
    pub fn system_mut(&mut self) -> &mut dyn System<Queryable, Args> {
        &mut *self.system
    }
    pub fn id(&self) -> &SystemEntity {
        &self.id
    }

    pub fn prepare_args(&mut self, queryable: &mut Queryable) -> Result<(), QueryError> {
        self.system.prepare_args(queryable, &self.id)
    }
    pub fn run(&mut self, args: &Args) -> Result<(), SystemError> {
        self.system.run(args)
    }
    pub fn consume(&mut self, queryable: &mut Queryable) -> Result<(), DataStateAccessError> {
        self.system.consume(queryable, &self.id)
    }
}
#[cfg(test)]
mod test {
    use crate::engine::{
        entity::SystemEntity,
        query::{ReadC, WriteC},
        scene::SceneRegistryRefs,
    };

    use super::{IntoSendSystem, QuerySystem, System};

    fn system_a(_data: &mut ReadC<()>) {}

    struct A;
    impl QuerySystem<SceneRegistryRefs, ()> for A {
        type Query = WriteC<()>;

        fn run(&mut self, _engine_args: &(), _args: &mut Self::Query) {}
    }

    fn system_b(_args: &mut (), _data: &mut ReadC<()>) {}

    fn system_boxed<T: 'static>(
        a: impl IntoSendSystem<SceneRegistryRefs, (), T> + 'static,
    ) -> Box<dyn System<SceneRegistryRefs, ()>> {
        Box::new(a.into_system())
    }

    #[test]
    fn test_systems() {
        let mut reg = SceneRegistryRefs::dummy();
        let reg = &mut reg.registry;

        let mut b: Box<dyn System<SceneRegistryRefs, ()>> = system_boxed(system_a);
        let mut c: Box<dyn System<SceneRegistryRefs, ()>> = system_boxed(system_b);

        let mut d: Box<dyn System<SceneRegistryRefs, ()>> = system_boxed(A);
        let mut e: Box<dyn System<SceneRegistryRefs, ()>> = system_boxed(A);

        b.prepare_args(reg, &SystemEntity::new()).unwrap();
        c.prepare_args(reg, &SystemEntity::new()).unwrap();
        d.prepare_args(reg, &SystemEntity::new()).unwrap_err();

        b.run(&()).unwrap();
        c.run(&()).unwrap();

        b.consume(reg, &SystemEntity::new()).unwrap();
        c.consume(reg, &SystemEntity::new()).unwrap();

        d.prepare_args(reg, &SystemEntity::new()).unwrap();
        e.prepare_args(reg, &SystemEntity::new()).unwrap_err();

        d.run(&()).unwrap();

        d.consume(reg, &SystemEntity::new()).unwrap();
    }
}