PkmnLib_rs/src/dynamic_data/flow/choice_queue.rs

use crate::dynamic_data::choices::TurnChoice;
use crate::dynamic_data::Pokemon;

/// The ChoiceQueue is used to run choices one by one.
///
/// It functions internally by holding a vector of choices, and passing ownership of the turn choice
/// to the turn executor one by one, replacing it with empty spots at the start. It holds several
/// helper functions to change the turn order while doing the execution. This is needed, as several
/// moves in Pokemon actively mess with this order.
#[derive(Debug)]
pub struct ChoiceQueue {
    /// Our storage of turn choices. Starts out completely filled, then slowly empties as turns get
    /// executed.
    queue: Vec<Option<TurnChoice>>,
    /// The current index of the turn we need to execute next.
    current: usize,
}

impl ChoiceQueue {
    /// Initializes a ChoiceQueue. We expect the given queue to already be sorted here.
    pub(crate) fn new(queue: Vec<Option<TurnChoice>>) -> Self {
        Self { queue, current: 0 }
    }

    /// Dequeues the next turn choice to be executed. This gives ownership to the callee, and replaces
    /// our own reference to the turn choice with an empty spot. It also increments the current position
    /// by one.
    pub fn dequeue(&mut self) -> TurnChoice {
        let c = self.queue[self.current].take();
        self.current += 1;
        c.unwrap()
    }

    /// This reads what the next choice to execute will be, without modifying state.
    pub fn peek(&self) -> &TurnChoice {
        self.queue[self.current].as_ref().unwrap()
    }

    /// Check if we have any choices remaining.
    pub fn has_next(&self) -> bool {
        self.current < self.queue.len()
    }

    /// This resorts the yet to be executed choices. This can be useful for dealing with situations
    /// such as Pokemon changing forms just after the very start of a turn, when turn order has
    /// technically already been decided.
    pub fn resort(&mut self) {
        let len = self.queue.len();
        self.queue[self.current..len].sort_unstable_by(|a, b| b.cmp(a));
    }

    /// This moves the choice of a specific Pokemon up to the next choice to be executed.
    pub fn move_pokemon_choice_next(&mut self, _pokemon: &Pokemon) {
        todo!()
    }

    /// Internal helper function to be easily able to iterate over the yet to be executed choices.
    pub(crate) fn get_queue(&self) -> &[Option<TurnChoice>] {
        &self.queue[self.current..self.queue.len()]
    }
}