brood 0.9.1

A fast and flexible entity component system library.
Documentation
use crate::{
    archetype,
    archetype::Archetype,
    entity,
    registry,
};
use alloc::vec::Vec;
use core::{
    fmt,
    mem::ManuallyDrop,
};

struct Components<R>
where
    R: registry::Debug,
{
    pointers: Vec<*const u8>,
    identifier: archetype::IdentifierRef<R>,
}

impl<R> fmt::Debug for Components<R>
where
    R: registry::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut debug_map = f.debug_map();
        // SAFETY: `pointers` is guaranteed to contain the same number of values as there are
        // components, each pointing to a valid component of type `C`. Also, `self.identifier` will
        // yield the same number of values as there are components in `R`.
        unsafe {
            R::debug_components(&self.pointers, &mut debug_map, self.identifier.iter());
        }
        debug_map.finish()
    }
}

struct Row<R>
where
    R: registry::Debug,
{
    identifier: entity::Identifier,
    components: Components<R>,
}

impl<R> fmt::Debug for Row<R>
where
    R: registry::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Row")
            .field("identifier", &self.identifier)
            .field("components", &self.components)
            .finish()
    }
}

impl<R> fmt::Debug for Archetype<R>
where
    R: registry::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut debug_map = f.debug_map();

        let entity_identifiers = ManuallyDrop::new(
            // SAFETY: `self.identifiers`, together with `self.length`, are guaranteed to be the
            // raw parts for a valid `Vec<entity::Identifier>`.
            unsafe {
                Vec::from_raw_parts(
                    self.entity_identifiers.0,
                    self.length,
                    self.entity_identifiers.1,
                )
            },
        );

        for i in 0..self.length {
            let mut component_pointers = Vec::new();
            // SAFETY: `self.components` contains the same number of values as
            // `self.identifier.iter()` has bits. Each tuple in `components` corresponds to a valid
            // `Vec<C>` for each component `C` with a length of `self.length`. Therefore, `i` will
            // be within the bounds of each of those `Vec<C>`s as well.
            unsafe {
                R::extract_component_pointers(
                    i,
                    &self.components,
                    &mut component_pointers,
                    self.identifier.iter(),
                );
            }
            debug_map.entry(
                &i,
                &Row::<R> {
                    // SAFETY: `entity_identifiers` is guaranteed to be of length `self.length`.
                    identifier: *unsafe { entity_identifiers.get_unchecked(i) },
                    components: Components {
                        pointers: component_pointers,
                        // SAFETY: This `IdentifierRef` will not outlive its referenced
                        // `Identifier`.
                        identifier: unsafe { self.identifier.as_ref() },
                    },
                },
            );
        }

        debug_map.finish()
    }
}