path: root/ecs/src/lib.rs

#![deny(clippy::all, clippy::pedantic)]

use std::any::{type_name, TypeId};
use std::collections::HashMap;
use std::fmt::Debug;
use std::mem::ManuallyDrop;
use std::ops::RangeBounds;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::vec::Drain;

use crate::actions::Action;
use crate::component::storage::Storage as ComponentStorage;
use crate::component::{Component, Id as ComponentId, Sequence as ComponentSequence};
use crate::event::{Event, Id as EventId, Ids, Sequence as EventSequence};
use crate::extension::{Collector as ExtensionCollector, Extension};
use crate::lock::Lock;
use crate::query::options::Options as QueryOptions;
use crate::sole::Sole;
use crate::system::{System, TypeErased as TypeErasedSystem};
use crate::type_name::TypeName;

pub mod actions;
pub mod component;
pub mod event;
pub mod extension;
pub mod lock;
pub mod query;
pub mod sole;
pub mod system;
pub mod tuple;
pub mod type_name;

mod archetype;

pub use ecs_macros::{Component, Sole};

pub use crate::query::Query;

#[derive(Debug, Default)]
pub struct World
{
    systems: Vec<TypeErasedSystem>,
    data: WorldData,
    stop: AtomicBool,
}

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

    /// Creates a new entity with the given components.
    ///
    /// # Panics
    /// Will panic if mutable internal lock cannot be acquired.
    pub fn create_entity<Comps>(&mut self, components: Comps)
    where
        Comps: ComponentSequence,
    {
        self.data
            .component_storage
            .write_nonblock()
            .expect("Failed to acquire read-write component storage lock")
            .push_entity(components.into_vec());
    }

    /// Adds a globally shared singleton value.
    ///
    /// # Errors
    /// Returns `Err` if this [`Sole`] has already been added.
    pub fn add_sole<SoleT>(&mut self, sole: SoleT) -> Result<(), SoleAlreadyExistsError>
    where
        SoleT: Sole,
    {
        self.data.sole_storage.insert(sole)
    }

    pub fn register_system<'this, EventT, SystemImpl>(
        &'this mut self,
        event: EventT,
        system: impl System<'this, SystemImpl>,
    ) where
        EventT: Event,
    {
        system.prepare(&self.data);

        self.systems.push(system.into_type_erased());

        self.data
            .events
            .entry(EventId::of::<EventT>())
            .or_default()
            .push(self.systems.len() - 1);

        drop(event);
    }

    /// Adds a extensions.
    ///
    /// # Panics
    /// Will panic if mutable internal lock cannot be acquired.
    pub fn add_extension(&mut self, extension: impl Extension)
    {
        let extension_collector = ExtensionCollector::new(self);

        extension.collect(extension_collector);
    }

    /// Emits a event, running all systems listening to the event for each compatible
    /// entity.
    ///
    /// # Panics
    /// Will panic if a system has dissapeared.
    pub fn emit<EventT>(&self, event: EventT)
    where
        EventT: Event,
    {
        self.emit_event_by_id(EventId::of::<EventT>());

        drop(event);
    }

    pub fn query<Comps, OptionsT>(&self) -> Query<Comps, OptionsT>
    where
        Comps: ComponentSequence,
        OptionsT: QueryOptions,
    {
        Query::new(&self.data.component_storage)
    }

    /// Peforms the actions that have been queued up using [`Actions`].
    ///
    /// # Panics
    /// Will panic if a mutable internal lock cannot be acquired.
    pub fn perform_queued_actions(&self)
    {
        for action in self
            .data
            .action_queue
            .write_nonblock()
            .expect("Failed to aquire read-write action queue lock")
            .drain(..)
        {
            match action {
                Action::Spawn(components) => {
                    {
                        let mut component_storage_lock =
                            self.data.component_storage.write_nonblock().expect(
                                "Failed to acquire read-write component storage lock",
                            );

                        component_storage_lock.push_entity(components);
                    }

                    for system in &self.systems {
                        unsafe {
                            system.prepare(&self.data);
                        }
                    }

                    let mut component_storage_lock =
                        self.data.component_storage.write_nonblock().expect(
                            "Failed to acquire read-write component storage lock",
                        );

                    component_storage_lock.make_archetype_lookup_entries();
                }
                Action::Stop => {
                    self.stop.store(true, Ordering::Relaxed);
                }
            }
        }
    }

    /// Prepares the world. Should be called before manually emitting events and after
    /// creating entities, registering systems & adding extensions. You do not need to
    /// call this function if you use [`event_loop`].
    pub fn prepare(&self)
    {
        self.data
            .component_storage
            .write_nonblock()
            .expect("Failed to acquire read-write component storage lock")
            .make_archetype_lookup_entries();
    }

    /// A event loop which runs until a stop is issued with [`Flags::stop`].
    ///
    /// # Panics
    /// Will panic if a internal lock cannot be acquired.
    pub fn event_loop<EventSeq: EventSequence>(&self)
    {
        self.prepare();

        let event_seq = EventSeq::ids();

        loop {
            for event_id in event_seq.iter() {
                self.emit_event_by_id(*event_id);
            }

            self.perform_queued_actions();

            if self.stop.load(Ordering::Relaxed) {
                break;
            }
        }
    }

    fn emit_event_by_id(&self, event_id: EventId)
    {
        let Some(system_indices) = self.data.events.get(&event_id) else {
            return;
        };

        for system_index in system_indices {
            let system = self.systems.get(*system_index).unwrap();

            // SAFETY: The world lives long enough
            unsafe {
                system.run(&self);
            }
        }
    }
}

#[derive(Debug, Default)]
pub struct WorldData
{
    events: HashMap<EventId, Vec<usize>>,
    component_storage: Arc<Lock<ComponentStorage>>,
    sole_storage: SoleStorage,
    action_queue: Arc<Lock<ActionQueue>>,
}

#[derive(Debug)]
#[non_exhaustive]
pub struct EntityComponent
{
    pub id: ComponentId,
    pub name: &'static str,
    pub component: Lock<Box<dyn Component>>,
}

#[derive(Debug, Default)]
struct ActionQueue
{
    queue: Vec<Action>,
}

impl ActionQueue
{
    fn push(&mut self, action: Action)
    {
        self.queue.push(action);
    }

    fn drain(&mut self, range: impl RangeBounds<usize>) -> Drain<Action>
    {
        self.queue.drain(range)
    }
}

impl TypeName for ActionQueue
{
    fn type_name(&self) -> &'static str
    {
        type_name::<Self>()
    }
}

#[derive(Debug, thiserror::Error)]
#[error("Sole {0} already exists")]
pub struct SoleAlreadyExistsError(pub &'static str);

#[derive(Debug)]
struct StoredSole
{
    sole: Arc<Lock<Box<dyn Sole>>>,
    drop_last: bool,
}

#[derive(Debug, Default)]
struct SoleStorage
{
    storage: HashMap<TypeId, ManuallyDrop<StoredSole>>,
}

impl SoleStorage
{
    fn get<SoleT: Sole>(&self) -> Option<&Arc<Lock<Box<dyn Sole>>>>
    {
        self.storage
            .get(&TypeId::of::<SoleT>())
            .map(|sole| &sole.sole)
    }

    fn insert<SoleT: Sole>(&mut self, sole: SoleT) -> Result<(), SoleAlreadyExistsError>
    {
        let sole_type_id = TypeId::of::<SoleT>();

        if self.storage.contains_key(&sole_type_id) {
            return Err(SoleAlreadyExistsError(type_name::<SoleT>()));
        }

        let drop_last = sole.drop_last();

        // TODO: Reconsider this maybe?
        #[allow(clippy::arc_with_non_send_sync)]
        self.storage.insert(
            sole_type_id,
            ManuallyDrop::new(StoredSole {
                sole: Arc::new(Lock::new(Box::new(sole))),
                drop_last,
            }),
        );

        Ok(())
    }
}

impl Drop for SoleStorage
{
    fn drop(&mut self)
    {
        let mut soles_to_drop_last = Vec::new();

        for sole in self.storage.values_mut() {
            if sole.drop_last {
                #[cfg(feature = "debug")]
                tracing::debug!(
                    "Sole {} pushed to dropping last queue",
                    sole.sole.read_nonblock().unwrap().type_name()
                );

                soles_to_drop_last.push(sole);
                continue;
            }

            #[cfg(feature = "debug")]
            tracing::debug!(
                "Dropping sole {}",
                sole.sole.read_nonblock().unwrap().type_name()
            );

            unsafe {
                ManuallyDrop::drop(sole);
            }
        }

        for sole in &mut soles_to_drop_last {
            #[cfg(feature = "debug")]
            tracing::debug!(
                "Dropping sole {} last",
                sole.sole.read_nonblock().unwrap().type_name()
            );

            unsafe {
                ManuallyDrop::drop(sole);
            }
        }
    }
}