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
#[cfg(feature = "render-debug")]
use std::collections::btree_map;
use std::collections::{BTreeMap, VecDeque};
use std::fmt;
#[cfg(feature = "render-debug")]
use std::sync::Arc;
use std::sync::{Mutex, RwLock};

use enum_map::EnumMap;

/// [`std::dbg!`] equivalent for wasm log
#[macro_export]
macro_rules! wasm_dbg {
    ($expr:expr) => {{
        #[cfg(test)]
        {
            dbg!($expr)
        }
        #[cfg(not(test))]
        {
            ::log::debug!("{} = {:#?}", stringify!($expr), &$expr);
            $expr
        }
    }};
}

use legion::systems::{ParallelRunnable, Runnable};
/// Generates legion system setup procedure for.
///
/// Consider this example:
///
/// ```
/// struct FooEvent(f32);
/// struct BarEvent(f32);
///
/// struct QuxComp(u32);
/// struct CorgeComp(u32);
///
/// #[derive(Default)]
/// struct GraultRes(u64);
/// #[derive(Default)]
/// struct WaldoRes(u64);
///
/// #[codegen::system(Simulate)]
/// #[read_component(QuxComp)]
/// #[write_component(CorgeComp)]
/// fn example(
///     world: &mut legion::world::SubWorld,
///     #[subscriber] foo_sub: impl Iterator<Item = FooEvent>,
///     #[publisher] bar_pub: impl FnMut(BarEvent),
///     #[resource] grault_res: &mut GraultRes,
///     #[resource] waldo_res: &WaldoRes,
///     #[state(0)] local_counter: &mut i32,
/// ) {
///     use legion::IntoQuery;
///
///     for (qux, corge) in <(&QuxComp, &mut CorgeComp)>::query().iter_mut(world) {
///         corge.0 = qux.0;
///     }
///
///     for &FooEvent(float) in foo_sub {
///         bar_pub(BarEvent(float));
///     }
///
///     grault_res.0 = waldo_res.0;
///
///     *local_counter += 1;
/// }
///
/// fn setup_ecs(setup: codegen::SetupEcs) -> codegen::SetupEcs { setup.uses(example_setup) }
/// ```
///
/// The parameter in the attribute is the [`SystemClass`] for the system.
///
/// If some of the parameters need to be thread-unsafe,
/// apply the `#[thread_local]` attribute on the function.
pub use traffloat_codegen_raw::system;

/// Whether debug info should be rendered.
pub const RENDER_DEBUG: bool = cfg!(feature = "render-debug");

/// The standard setup parameters
#[derive(Default)]
pub struct SetupEcs {
    /// Whether to enable server-only systems
    pub server:    bool,
    /// The legion::Scheduler builder
    pub builder:   legion::systems::Builder,
    /// The legion world storing entities and components
    pub world:     legion::World,
    /// The resource set storing legion resources
    pub resources: legion::Resources,
    /// The schedule of each class of systems
    classes:       EnumMap<SystemClass, ClassSchedule>,
}

/// A discrete batch of systems to execute.
#[derive(Debug, Clone, Copy, enum_map::Enum)]
pub enum SystemClass {
    /// The very first initial setup.
    Init,
    /// Receive inputs.
    Input,
    /// Respond to inputs.
    Response,
    /// Setup scheduler signals.
    Schedule,
    /// Prepare for simulation by initializing states.
    PreSimulate,
    /// Simulate game logic.
    Simulate,
    /// Flush changes in the game logic.
    Flush,
    /// Handle events dispatched during game logic.
    ///
    /// Also handles deletion events, but not post-deletion events.
    Handle,
    /// Execute child entity deletion requests.
    ///
    /// This is used when parent and child entities are deleted in conjunction.
    DeleteChild,
    /// Execute entity creation/deletion requests.
    Command,
    /// Execute child entity creation requests.
    ///
    /// This is used when parent and child entities are created in conjunction.
    CreateChild,
    /// Execute entity post-creation/post-deletion requests.
    PostCommand,
    /// Prepare resources for visualization, including debug info.
    PreVisualize,
    /// Read-only access to core game logic.
    ///
    /// This is used for client rendering, backup creation process and other roundup systems.
    Visualize,
    /// Flush results of a visualization request,
    /// e.g. produce the save artifact after
    /// the fields have been populated in [`Visualize`][SystemClass::Visualize].
    PostVisualize,
}

#[derive(Default)]
struct ClassSchedule {
    sync:   Vec<Box<dyn ParallelRunnable>>,
    unsync: Vec<Box<dyn Runnable>>,
}

impl SetupEcs {
    /// Register a bundle
    #[must_use]
    pub fn uses(self, setup_ecs: fn(Self) -> Self) -> Self { setup_ecs(self) }

    /// Add a system
    #[allow(clippy::indexing_slicing)]
    #[must_use]
    pub fn system(
        mut self,
        sys: impl legion::systems::ParallelRunnable + 'static,
        class: SystemClass,
    ) -> Self {
        self.classes[class].sync.push(Box::new(sys));
        self
    }
    /// Add a thread-local system
    #[allow(clippy::indexing_slicing)]
    #[must_use]
    pub fn system_local(
        mut self,
        sys: impl legion::systems::Runnable + 'static,
        class: SystemClass,
    ) -> Self {
        self.classes[class].unsync.push(Box::new(sys));
        self
    }

    /// Add an entity
    #[must_use]
    pub fn entity<T>(mut self, components: T) -> Self
    where
        Option<T>: legion::storage::IntoComponentSource,
    {
        self.world.push(components);
        self
    }
    /// Add entities
    #[must_use]
    pub fn entities<T>(mut self, components: impl legion::storage::IntoComponentSource) -> Self {
        self.world.extend(components);
        self
    }

    /// Add a resource
    #[must_use]
    pub fn resource(mut self, res: impl legion::systems::Resource) -> Self {
        self.resources.get_or_insert(res);
        self
    }
    /// Add a default resource
    #[must_use]
    pub fn resource_default<T: legion::systems::Resource + Default>(mut self) -> Self {
        self.resources.get_or_default::<T>();
        self
    }
    /// Declare a published event
    #[must_use]
    pub fn publisher<T: shrev::Event>(mut self) -> Self {
        let _ = self.resources.get_or_insert_with(shrev::EventChannel::<T>::new);
        self
    }
    /// Publish an event
    #[must_use]
    pub fn publish_event<T: shrev::Event>(mut self, t: T) -> Self {
        {
            let mut channel = self.resources.get_mut_or_insert_with(shrev::EventChannel::<T>::new);
            channel.single_write(t);
        }
        self
    }
    /// Declare a subscribed event
    pub fn subscriber<T: shrev::Event>(&mut self) -> shrev::ReaderId<T> {
        let mut channel = self.resources.get_mut_or_insert_with(shrev::EventChannel::<T>::new);
        channel.register_reader()
    }

    /// Build the setup into a legion
    pub fn build(mut self) -> Legion {
        for (_class, schedule) in self.classes {
            for system in schedule.sync {
                self.builder.add_system_boxed(system);
            }
            for system in schedule.unsync {
                self.builder.add_thread_local_boxed(system);
            }
            self.builder.flush();
        }

        Legion { world: self.world, resources: self.resources, schedule: self.builder.build() }
    }
}

/// The set of values required to run legion
pub struct Legion {
    /// The legion world storing entities and components
    pub world:     legion::World,
    /// The resource set storing legion resources
    pub resources: legion::Resources,
    /// The legion scheduler running systems
    pub schedule:  legion::Schedule,
}

impl Legion {
    /// Spins all systems once.
    pub fn run(&mut self) { self.schedule.execute(&mut self.world, &mut self.resources) }

    /// Publishes an event.
    pub fn publish<T: shrev::Event>(&mut self, event: T) {
        let mut channel = match self.resources.get_mut::<shrev::EventChannel<T>>() {
            Some(channel) => channel,
            None => panic!("EventChannel<{}> has not been initialized", std::any::type_name::<T>()),
        };
        channel.single_write(event);
    }
}

/// A marker trait for standard archetypes.
///
/// If `A: ReqiuredComponent<B>`,
/// this means that all entities with `B`
/// should also have `A`.
///
/// This dependency is not enforced anywhere.
/// It merely serves for documentation purpose.
/// This is used to annotate the standard component set of an entity,
/// using the identification type as `B`.
/// e.g. all required components for nodes implement `RequiredComponent<node::Id>`.
pub trait RequiredComponent<T>: Sized {}

/// A marker trait for standard archetypes.
///
/// If `A: OptionalComponent<B>`,
/// this means that all entities with `B`
/// should also have `A`.
///
/// This dependency is not enforced anywhere.
/// It merely serves for documentation purpose.
/// This is used to annotate the standard component set of an entity,
/// using the identification type as `B`.
/// e.g. all optional components for nodes implement `OptionalComponent<node::Id>`.
pub trait OptionalComponent<T>: Sized {}

/// Concise syntax to implement [`RequiredComponent`] and [`OptionalComponent`] for many types.
#[macro_export]
macro_rules! component_depends {
    ($id:ty = ($($required:ty),* $(,)?) + ?($($optional:ty),* $(,)?)) => {
        $(
            #[doc = concat!("[`", stringify!($required), "`] is a required component in the archetype of [`", stringify!($id), "`].")]
            impl $crate::RequiredComponent<$id> for $required {}
        )*
        $(
            #[doc = concat!("[`", stringify!($optional), "`] is an optional component in the archetype of [`", stringify!($id), "`].")]
            impl $crate::OptionalComponent<$id> for $optional {}
        )*
    }
}

/// Performance tracking
#[derive(Default)]
pub struct Perf {
    pub map: PerfMap,
}

pub type PerfMap = RwLock<BTreeMap<&'static str, Mutex<VecDeque<i64>>>>;

const MAX_FRAMES: usize = 100;

impl Perf {
    /// Update a timer
    pub fn push(&self, name: &'static str, value: i64) {
        loop {
            {
                let map = self.map.read().expect("Perf poisoned");
                if let Some(deque) = map.get(name) {
                    let mut deque = deque.lock().expect("Perf poisoned");
                    while deque.len() >= MAX_FRAMES {
                        deque.pop_front();
                    }
                    deque.push_back(value);
                    return;
                }
            }

            {
                let mut map = self.map.write().expect("Perf poisoned");
                let _ = map.entry(name).or_default();
            }
        }
    }
}

/// The resource storing debug entries to render.
#[cfg(feature = "render-debug")]
#[derive(Default, getset::Getters)]
pub struct DebugEntries {
    #[getset(get = "pub")]
    /// Entries in the format `entries[category][name]`.
    entries: BTreeMap<&'static str, BTreeMap<&'static str, DebugEntry>>,
}

#[cfg(feature = "render-debug")]
impl DebugEntries {
    /// Creates a new entry.
    pub fn entry(&mut self, category: &'static str, name: &'static str) -> DebugEntry {
        let entries = self.entries.entry(category).or_default();
        match entries.entry(name) {
            btree_map::Entry::Occupied(_) => panic!("Duplicate debug entry {}/{}", category, name),
            btree_map::Entry::Vacant(entry) => entry.insert(DebugEntry::default()).clone(),
        }
    }
}

/// The value of a debug entry.
#[cfg(feature = "render-debug")]
#[derive(Debug, Clone, Default)]
pub struct DebugEntry {
    value: Arc<Mutex<String>>,
}

/// Updates a debug entry.
///
/// Example:
/// ```n_run
/// use codegen::{DebugEntry, update_debug};
/// # fn get_entry() -> &'static mut DebugEntry{
///     unimplemented!()
/// # }
/// let pi_entry: &mut DebugEntry = get_entry();
/// update_debug!(pi_entry, "{:.1}", std::f32::consts::PI);
/// ```
#[macro_export]
macro_rules! update_debug {
    ($entry:expr, $lit:literal $($tt:tt)*) => {
        if cfg!(feature = "render-debug") {
            $entry._update(std::format_args!($lit $($tt)*));
        }
    }
}

#[cfg(feature = "render-debug")]
impl DebugEntry {
    /// Updates the debug entry.
    pub fn _update(&self, new: impl fmt::Display) {
        use fmt::Write;

        let mut value = self.value.lock().expect("Poisoned debug entry");
        value.clear();
        write!(value, "{}", new).expect("String::write_fmt never fails");
    }

    /// Returns the value as a str
    pub fn value(&self) -> impl AsRef<str> + '_ {
        use std::sync::MutexGuard;

        struct MutexStr<'t>(MutexGuard<'t, String>);
        impl<'t> AsRef<str> for MutexStr<'t> {
            fn as_ref(&self) -> &str { self.0.as_str() }
        }
        let value = self.value.lock().expect("Poisoned debug entry");
        MutexStr(value)
    }
}

/// Dummy struct for debug entry in non-render-debug builds.
#[cfg(not(feature = "render-debug"))]
// #[derive(Debug, Clone, Default)]
pub struct DebugEntry(pub ());

#[cfg(not(feature = "render-debug"))]
impl DebugEntry {
    /// Dummy method for debug entry in non-render-debug builds.
    pub fn _update(&self, _new: impl fmt::Display) { unimplemented!() }
}

/// The high-resolution clock in microseconds
#[cfg(target_arch = "wasm32")]
pub fn hrtime() -> i64 {
    (web_sys::window()
        .expect("Window uninitialized")
        .performance()
        .expect("window.performance uninitialized")
        .now()
        * 1000.) as i64
}

/// The high-resolution clock in microseconds
#[cfg(not(target_arch = "wasm32"))]
pub fn hrtime() -> i64 {
    use std::time::Instant;

    lazy_static::lazy_static! {
        static ref EPOCH: Instant = Instant::now();
    }

    EPOCH.elapsed().as_micros() as i64
}