procedural_tilemaps_core 0.4.0

use super::{model::ModelInstance, GeneratedNode, Generator};

use crate::grid::{
    coordinate_system::CoordinateSystem,
    grid::{Grid, GridData},
};
#[cfg(feature = "bevy")]
use bevy::ecs::component::Component;

/// Update sent by a [`crate::generator::Generator`]
#[derive(Clone, Copy, Debug)]
pub enum GenerationUpdate {
    /// A node has been generated
    Generated(GeneratedNode),
    /// The generator is being reinitialized to its initial state, with a new seed.
    Reinitializing(u64),
    /// The generation failed due to a contradiction at the specified node_index
    Failed(usize),
}

/// Observer with a queue of the [`GenerationUpdate`] sent by the [`crate::generator::Generator`] which also maintains a coherent state of the current generation in a [`GridData`]
///
/// Can be used in a different thread than the generator's thread.
#[cfg_attr(feature = "bevy", derive(Component))]
pub struct QueuedStatefulObserver<T: CoordinateSystem, G: Grid<T>> {
    grid_data: GridData<T, Option<ModelInstance>, G>,
    receiver: crossbeam_channel::Receiver<GenerationUpdate>,
}

impl<T: CoordinateSystem, G: Grid<T>> QueuedStatefulObserver<T, G> {
    /// Creates a new [`QueuedStatefulObserver`] for a given [`crate::generator::Generator`]
    pub fn new(generator: &mut Generator<T, G>) -> Self {
        let receiver = generator.create_observer_queue();
        QueuedStatefulObserver::create(receiver, generator.grid())
    }

    pub(crate) fn create(
        receiver: crossbeam_channel::Receiver<GenerationUpdate>,
        grid: &G,
    ) -> Self {
        QueuedStatefulObserver {
            grid_data: GridData::new(grid.clone(), vec![None; grid.total_size()]),
            receiver,
        }
    }

    /// Returns a ref to the observer's [`GridData`]
    pub fn grid_data(&self) -> &GridData<T, Option<ModelInstance>, G> {
        &self.grid_data
    }

    /// Updates the internal state of the observer by dequeuing all queued updates.
    pub fn dequeue_all(&mut self) {
        while let Ok(update) = self.receiver.try_recv() {
            match update {
                GenerationUpdate::Generated(grid_node) => self
                    .grid_data
                    .set(grid_node.node_index, Some(grid_node.model_instance)),
                GenerationUpdate::Reinitializing(_) => self.grid_data.reset(None),
                GenerationUpdate::Failed(_) => self.grid_data.reset(None),
            }
        }
    }

    /// Updates the internal state of the observer by dequeuing 1 queued update.
    ///
    /// Returns [`Some(GenerationUpdate)`] if there was an update to process, else returns `None`.
    pub fn dequeue_one(&mut self) -> Option<GenerationUpdate> {
        match self.receiver.try_recv() {
            Ok(update) => {
                match update {
                    GenerationUpdate::Generated(grid_node) => self
                        .grid_data
                        .set(grid_node.node_index, Some(grid_node.model_instance)),
                    GenerationUpdate::Reinitializing(_) => self.grid_data.reset(None),
                    GenerationUpdate::Failed(_) => self.grid_data.reset(None),
                }
                Some(update)
            }
            Err(_) => None,
        }
    }
}

/// Observer with just a queue of the [`GenerationUpdate`] sent by the [`crate::generator::Generator`]
///
/// Can be used in a different thread than the generator's thread.
#[cfg_attr(feature = "bevy", derive(Component))]
pub struct QueuedObserver {
    receiver: crossbeam_channel::Receiver<GenerationUpdate>,
}

impl QueuedObserver {
    /// Creates a new [`QueuedObserver`] for a given [`crate::generator::Generator`]
    pub fn new<T: CoordinateSystem, G: Grid<T>>(generator: &mut Generator<T, G>) -> Self {
        let receiver = generator.create_observer_queue();
        QueuedObserver { receiver }
    }

    pub(crate) fn create(receiver: crossbeam_channel::Receiver<GenerationUpdate>) -> Self {
        Self { receiver }
    }

    /// Dequeues all queued updates.
    ///
    /// Returns all retrieved [`GenerationUpdate`] in a `Vec`.
    /// The `Vec` may be empty if no update was queued.
    pub fn dequeue_all(&mut self) -> Vec<GenerationUpdate> {
        let mut updates = Vec::new();
        while let Ok(update) = self.receiver.try_recv() {
            updates.push(update);
        }
        updates
    }

    /// Dequeues 1 queued update.
    ///
    /// Returns [`Some(GenerationUpdate)`] if there was an update to process, else returns `None`.
    pub fn dequeue_one(&mut self) -> Option<GenerationUpdate> {
        match self.receiver.try_recv() {
            Ok(update) => Some(update),
            Err(_) => None,
        }
    }
}