pancakestack 0.6.1

use crate::parse::{parse_program_str, Command};
use std::collections::HashMap;
use std::fmt::{self, Display};
use std::io::{self, prelude::*, BufReader, Read, Write};
use unicode_segmentation::UnicodeSegmentation;

/// Parses and run the commands read from the given Read using the provided input and output.
/// Each command has to be on its own line.
/// ```rust
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn run() {
/// let file = File::open("example.pancake").unwrap();
/// let input = b"some input";
/// let mut output_buf = Vec::new();
/// pancakestack::run_program_from_read(file, &input[..], &mut output_buf).unwrap();
/// let output = std::str::from_utf8(&output_buf).unwrap();
/// # }
/// ```
///
/// # Errors
/// Will return `Err` if the given program performs an illegal operation or an io error occurs. See [`Error`](./enum.Error.html).
pub fn run_program_from_read(
    program: impl Read,
    input: impl Read,
    mut output: impl Write,
) -> Result<(), Error> {
    let mut program = BufReader::new(program);
    let mut input = BufReader::new(input);

    let mut stack = Vec::new();
    let mut labels = HashMap::new();
    let mut executed = Vec::new();
    let mut current_statement: Option<usize> = None;

    let mut program_line = String::new();
    let mut in_line = String::new();
    loop {
        let command = if let Some(ref mut index) = current_statement {
            if let Some(c) = executed.get(*index) {
                *index += 1;
                c
            } else {
                current_statement = None;
                continue;
            }
        } else {
            program_line.clear();
            let length = program.read_line(&mut program_line)?;
            if length == 0 {
                return Ok(());
            }
            trim_newline(&mut program_line);

            fn trim_newline(s: &mut String) {
                if s.ends_with('\n') {
                    s.pop();
                    if s.ends_with('\r') {
                        s.pop();
                    }
                }
            }

            let c = Command::from_line(&program_line);
            if c.is_err() {
                if !program_line.trim().is_empty() {
                    eprintln!("invalid command: \"{program_line}\"");
                }
                continue;
            }
            let c = c.unwrap().to_owned();
            executed.push(c.clone());
            executed.last().unwrap()
        };

        // TODO: Deduplicate this code
        match command {
            Command::PutThisPancakeOnTop(adjective) => {
                stack.push(adjective.graphemes(true).count() as u32);
            }
            Command::EatThePancakeOnTop => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                stack.pop();
            }
            Command::PutTheTopPancakesTogether => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                let result = first.checked_add(second).ok_or(Error::PancakeOverflow)?;
                stack.push(result);
            }
            Command::GiveMeAPancake => {
                input.read_line(&mut in_line)?;
                let number_input = in_line
                    .parse()
                    .map_err(|_| Error::InvalidPancake(in_line.clone()))?;
                stack.push(number_input);
                in_line.clear();
            }
            Command::HowAboutAHotcake => {
                let buf = input.fill_buf()?;
                let number_input = *buf.first().unwrap_or(&0);
                input.consume(1);
                stack.push(u32::from(number_input));
            }
            Command::ShowMeAPancake => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last().unwrap();
                let c = char::from_u32(*top).ok_or(Error::CanNotShowPancake(*top))?;
                write!(output, "{c}")?;
            }
            Command::TakeFromTheTopPancakes => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                let result = first.checked_sub(second).ok_or(Error::PancakeUnderflow)?;
                stack.push(result);
            }
            Command::FlipThePancakesOnTop => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                stack.push(first);
                stack.push(second);
            }
            Command::PutAnotherPancakeOnTop => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                stack.push(*stack.last().unwrap());
            }
            Command::Label(label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last().unwrap();
                labels.insert(label.clone(), (*top - 1) as usize);
            }
            Command::IfThePancakeIsntTastyGoOverTo(target_label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = *stack.last().unwrap();
                if top == 0 {
                    let label_position = labels
                        .get(target_label)
                        .ok_or_else(|| Error::UndefinedLabel(target_label.to_string()))?;
                    current_statement = Some(*label_position);
                }
            }
            Command::IfThePancakeIsTastyGoOverTo(target_label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = *stack.last().unwrap();
                if top != 0 {
                    let label_position = labels
                        .get(target_label)
                        .ok_or_else(|| Error::UndefinedLabel(target_label.to_string()))?;
                    current_statement = Some(*label_position);
                }
            }
            Command::PutSyrupOnThePancakes => {
                for value in &mut stack {
                    *value = value.checked_add(1).ok_or(Error::PancakeOverflow)?;
                }
            }
            Command::PutButterOnThePancakes => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last_mut().unwrap();
                *top = top.checked_add(1).ok_or(Error::PancakeOverflow)?;
            }
            Command::TakeOffTheSyrup => {
                for value in &mut stack {
                    *value = value.checked_sub(1).ok_or(Error::PancakeUnderflow)?;
                }
            }
            Command::TakeOffTheButter => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last_mut().unwrap();
                *top = top.checked_sub(1).ok_or(Error::PancakeUnderflow)?;
            }
            Command::EatAllOfThePancakes => {
                break;
            }
        }
    }
    Ok(())
}

/// Parses and run the commands contained in the given string using the provided input and output.
/// Each command has to be on its own line.
/// ```rust
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn run() {
/// // load program from file
/// let mut file = File::open("example.pancake").unwrap();
/// let mut program_str = String::new();
/// file.read_to_string(&mut program_str).unwrap();
///
/// // parse the program
/// let program = pancakestack::parse_program_str(&program_str);
///
/// // run the program
/// pancakestack::run_program(&program, std::io::stdin(), std::io::stdout()).unwrap();
/// # }
/// ```
///
/// # Errors
/// Will return `Err` if the given program performs an illegal operation or an io error occurs. See [`Error`](./enum.Error.html).
pub fn run_program_str(program: &str, input: impl Read, output: impl Write) -> Result<(), Error> {
    let parsed = parse_program_str(program);
    run_program(&parsed, input, output)
}

/// Runs the given slice of commands using the provided input and output.
/// ```rust
/// # use std::fs::File;
/// # use std::io::Read;
/// # fn run() {
/// // load program from file
/// let mut file = File::open("example.pancake").unwrap();
/// let mut program_str = String::new();
/// file.read_to_string(&mut program_str).unwrap();
///
/// // parse the program
/// let program = pancakestack::parse_program_str(&program_str);
///
/// // run the program
/// pancakestack::run_program(&program, std::io::stdin(), std::io::stdout()).unwrap();
/// # }
/// ```
///
/// # Errors
/// Will return `Err` if the given program performs an illegal operation or an io error occurs. See [`Error`](./enum.Error.html).
pub fn run_program(
    program: &[Command<'_>],
    input: impl Read,
    mut output: impl Write,
) -> Result<(), Error> {
    let mut input = BufReader::new(input);
    let mut in_line = String::new();

    let mut stack = Vec::new();
    let mut labels = HashMap::new();

    let mut current_statement: usize = 0;
    while let Some(command) = program.get(current_statement) {
        current_statement += 1;

        // TODO: Deduplicate this code
        match command {
            Command::PutThisPancakeOnTop(adjective) => {
                stack.push(adjective.graphemes(true).count() as u32);
            }
            Command::EatThePancakeOnTop => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                stack.pop();
            }
            Command::PutTheTopPancakesTogether => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                let result = first.checked_add(second).ok_or(Error::PancakeOverflow)?;
                stack.push(result);
            }
            Command::GiveMeAPancake => {
                input.read_line(&mut in_line)?;
                let number_input = in_line
                    .parse()
                    .map_err(|_| Error::InvalidPancake(in_line.clone()))?;
                stack.push(number_input);
                in_line.clear();
            }
            Command::HowAboutAHotcake => {
                let buf = input.fill_buf()?;
                let number_input = *buf.first().unwrap_or(&0);
                input.consume(1);
                stack.push(u32::from(number_input));
            }
            Command::ShowMeAPancake => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last().unwrap();
                let c = char::from_u32(*top).ok_or(Error::CanNotShowPancake(*top))?;
                write!(output, "{c}")?;
            }
            Command::TakeFromTheTopPancakes => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                let result = first.checked_sub(second).ok_or(Error::PancakeUnderflow)?;
                stack.push(result);
            }
            Command::FlipThePancakesOnTop => {
                if stack.len() < 2 {
                    return Err(Error::OutOfPancakes);
                }
                let first = stack.pop().unwrap();
                let second = stack.pop().unwrap();
                stack.push(first);
                stack.push(second);
            }
            Command::PutAnotherPancakeOnTop => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                stack.push(*stack.last().unwrap());
            }
            Command::Label(label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last().unwrap();
                labels.insert(label, (*top - 1) as usize);
            }
            Command::IfThePancakeIsntTastyGoOverTo(target_label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = *stack.last().unwrap();
                if top == 0 {
                    let label_position = labels
                        .get(target_label)
                        .ok_or_else(|| Error::UndefinedLabel((*target_label).to_string()))?;
                    current_statement = *label_position;
                }
            }
            Command::IfThePancakeIsTastyGoOverTo(target_label) => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = *stack.last().unwrap();
                if top != 0 {
                    let label_position = labels
                        .get(target_label)
                        .ok_or_else(|| Error::UndefinedLabel((*target_label).to_string()))?;
                    current_statement = *label_position;
                }
            }
            Command::PutSyrupOnThePancakes => {
                for value in &mut stack {
                    *value = value.checked_add(1).ok_or(Error::PancakeOverflow)?;
                }
            }
            Command::PutButterOnThePancakes => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last_mut().unwrap();
                *top = top.checked_add(1).ok_or(Error::PancakeOverflow)?;
            }
            Command::TakeOffTheSyrup => {
                for value in &mut stack {
                    *value = value.checked_sub(1).ok_or(Error::PancakeUnderflow)?;
                }
            }
            Command::TakeOffTheButter => {
                if stack.is_empty() {
                    return Err(Error::OutOfPancakes);
                }
                let top = stack.last_mut().unwrap();
                *top = top.checked_sub(1).ok_or(Error::PancakeUnderflow)?;
            }
            Command::EatAllOfThePancakes => {
                break;
            }
        }
    }
    Ok(())
}

/// An enum representing the possible errors when executing a pancakestack program.
#[derive(Debug)]
pub enum Error {
    /// You were greedy and wanted more pancakes than were available.
    OutOfPancakes,
    /// You gave me a pancake that was not a valid number.
    InvalidPancake(String),
    /// The pancake you tried to display was shy and hid outside of your visible spectrum (no a valid char).
    CanNotShowPancake(u32),
    /// You tried to go somewhere undefined.
    UndefinedLabel(String),
    /// You tried to produce an invalid pancake by underflowing u32.
    PancakeUnderflow,
    /// You tried to produce an invalid pancake by overflowing u32.
    PancakeOverflow,
    /// An Io Error occured while reading from the provided [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html) or writing from the provided [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html).
    Io(io::Error),
}
impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::OutOfPancakes => write!(f, "Out of pancakes!"),
            Error::InvalidPancake(s) => write!(f, "Invalid pancake: {s}"),
            Error::CanNotShowPancake(p) => {
                write!(f, "Pancake can not be shown (invalid char): {p}")
            }
            Error::UndefinedLabel(l) => write!(f, "Use of undefined label \"{l}\""),
            Error::PancakeUnderflow => write!(f, "Pancake underflowed its domain."),
            Error::PancakeOverflow => write!(f, "Pancake overflowed its domain."),
            Error::Io(io) => io.fmt(f),
        }
    }
}
impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}
impl From<io::Error> for Error {
    fn from(error: io::Error) -> Self {
        Error::Io(error)
    }
}