endbasic-std 0.11.1

// EndBASIC
// Copyright 2021 Julio Merino
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License.  You may obtain a copy
// of the License at:
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
// License for the specific language governing permissions and limitations
// under the License.

//! Commands for console interaction.

use crate::console::readline::read_line;
use crate::console::{CharsXY, ClearType, Console, ConsoleClearable, Key};
use crate::strings::{
    format_boolean, format_double, format_integer, parse_boolean, parse_double, parse_integer,
};
use async_trait::async_trait;
use endbasic_core::ast::{ArgSep, ExprType, Value, VarRef};
use endbasic_core::compiler::{
    ArgSepSyntax, OptionalValueSyntax, RepeatedSyntax, RepeatedTypeSyntax, RequiredRefSyntax,
    RequiredValueSyntax, SingularArgSyntax,
};
use endbasic_core::exec::{Machine, Scope, ValueTag};
use endbasic_core::syms::{
    CallError, CallResult, Callable, CallableMetadata, CallableMetadataBuilder,
};
use endbasic_core::LineCol;
use std::borrow::Cow;
use std::cell::RefCell;
use std::convert::TryFrom;
use std::io;
use std::rc::Rc;

/// Category description for all symbols provided by this module.
const CATEGORY: &str = "Console
The EndBASIC console is the display you are seeing: both the interpreter and the \
effects of all commands happen within the same console.  There is no separate output window as \
other didactical interpreters provide.  This unified console supports text and, depending on the \
output backend, graphics.  This help section focuses on the textual console; for information about \
graphics, run HELP \"GRAPHICS\".
The text console is a matrix of variable size.  The upper left position is row 0 and column 0.  \
Each position in this matrix contains a character and a color attribute.  The color attribute \
indicates the foreground and background colors of that character.  There is a default attribute \
to match the default settings of your terminal, which might not be a color: for example, in a \
terminal emulator configured with a black tint (aka a transparent terminal), the default color \
respects the transparency whereas color 0 (black) does not.
If you are writing a script and do not want the script to interfere with other parts of the \
console, you should restrict the script to using only the INPUT and PRINT commands.
Be aware that the console currently reacts poorly to size changes.  Avoid resizing your terminal \
or web browser.  If you do resize them, however, restart the interpreter.";

/// The `CLS` command.
pub struct ClsCommand {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl ClsCommand {
    /// Creates a new `CLS` command that clears the `console`.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("CLS")
                .with_syntax(&[(&[], None)])
                .with_category(CATEGORY)
                .with_description("Clears the screen.")
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for ClsCommand {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        debug_assert_eq!(0, scope.nargs());
        self.console.borrow_mut().clear(ClearType::All)?;
        Ok(())
    }
}

/// The `COLOR` command.
pub struct ColorCommand {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl ColorCommand {
    const NO_COLOR: i32 = 0;
    const HAS_COLOR: i32 = 1;

    /// Creates a new `COLOR` command that changes the color of the `console`.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("COLOR")
                .with_syntax(&[
                    (&[], None),
                    (
                        &[SingularArgSyntax::RequiredValue(
                            RequiredValueSyntax {
                                name: Cow::Borrowed("fg"),
                                vtype: ExprType::Integer,
                            },
                            ArgSepSyntax::End,
                        )],
                        None,
                    ),
                    (
                        &[
                            SingularArgSyntax::OptionalValue(
                                OptionalValueSyntax {
                                    name: Cow::Borrowed("fg"),
                                    vtype: ExprType::Integer,
                                    missing_value: Self::NO_COLOR,
                                    present_value: Self::HAS_COLOR,
                                },
                                ArgSepSyntax::Exactly(ArgSep::Long),
                            ),
                            SingularArgSyntax::OptionalValue(
                                OptionalValueSyntax {
                                    name: Cow::Borrowed("bg"),
                                    vtype: ExprType::Integer,
                                    missing_value: Self::NO_COLOR,
                                    present_value: Self::HAS_COLOR,
                                },
                                ArgSepSyntax::End,
                            ),
                        ],
                        None,
                    ),
                ])
                .with_category(CATEGORY)
                .with_description(
                    "Sets the foreground and background colors.
Color numbers are given as ANSI numbers and can be between 0 and 255.  If a color number is not \
specified, then the color is reset to the console's default.  The console default does not \
necessarily match any other color specifiable in the 0 to 255 range, as it might be transparent.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for ColorCommand {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, mut scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        fn get_color((i, pos): (i32, LineCol)) -> Result<Option<u8>, CallError> {
            if i >= 0 && i <= u8::MAX as i32 {
                Ok(Some(i as u8))
            } else {
                Err(CallError::ArgumentError(pos, "Color out of range".to_owned()))
            }
        }

        fn get_optional_color(scope: &mut Scope<'_>) -> Result<Option<u8>, CallError> {
            match scope.pop_integer() {
                ColorCommand::NO_COLOR => Ok(None),
                ColorCommand::HAS_COLOR => get_color(scope.pop_integer_with_pos()),
                _ => unreachable!(),
            }
        }

        let (fg, bg) = if scope.nargs() == 0 {
            (None, None)
        } else if scope.nargs() == 1 {
            (get_color(scope.pop_integer_with_pos())?, None)
        } else {
            (get_optional_color(&mut scope)?, get_optional_color(&mut scope)?)
        };

        self.console.borrow_mut().set_color(fg, bg)?;
        Ok(())
    }
}

/// The `INKEY` function.
pub struct InKeyFunction {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl InKeyFunction {
    /// Creates a new `INKEY` function that waits for a key press.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("INKEY")
                .with_return_type(ExprType::Text)
                .with_syntax(&[(&[], None)])
                .with_category(CATEGORY)
                .with_description(
                    "Checks for an available key press and returns it.
If a key press is available to be read, returns its name.  Otherwise, returns the empty string.  \
The returned key matches its name, number, or symbol and maintains case.  In other words, \
pressing the X key will return 'x' or 'X' depending on the SHIFT modifier.
The following special keys are recognized: arrow keys (UP, DOWN, LEFT, RIGHT), backspace (BS), \
end or CTRL+E (END), enter (ENTER), CTRL+D (EOF), escape (ESC), home or CTRL+A (HOME), \
CTRL+C (INT), page up (PGUP), page down (PGDOWN), and tab (TAB).
This function never blocks.  To wait for a key press, you need to explicitly poll the keyboard.  \
For example, to wait until the escape key is pressed, you could do:
    k$ = \"\": WHILE k$ <> \"ESC\": k = INKEY$: SLEEP 0.01: WEND
This non-blocking design lets you to combine the reception of multiple evens, such as from \
GPIO_INPUT?, within the same loop.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for InKeyFunction {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        debug_assert_eq!(0, scope.nargs());

        let key = self.console.borrow_mut().poll_key().await?;
        let key_name = match key {
            Some(Key::ArrowDown) => "DOWN".to_owned(),
            Some(Key::ArrowLeft) => "LEFT".to_owned(),
            Some(Key::ArrowRight) => "RIGHT".to_owned(),
            Some(Key::ArrowUp) => "UP".to_owned(),

            Some(Key::Backspace) => "BS".to_owned(),
            Some(Key::CarriageReturn) => "ENTER".to_owned(),
            Some(Key::Char(x)) => format!("{}", x),
            Some(Key::End) => "END".to_owned(),
            Some(Key::Eof) => "EOF".to_owned(),
            Some(Key::Escape) => "ESC".to_owned(),
            Some(Key::Home) => "HOME".to_owned(),
            Some(Key::Interrupt) => "INT".to_owned(),
            Some(Key::NewLine) => "ENTER".to_owned(),
            Some(Key::PageDown) => "PGDOWN".to_owned(),
            Some(Key::PageUp) => "PGUP".to_owned(),
            Some(Key::Tab) => "TAB".to_owned(),
            Some(Key::Unknown(_)) => "".to_owned(),

            None => "".to_owned(),
        };
        scope.return_string(key_name)
    }
}

/// The `INPUT` command.
pub struct InputCommand {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl InputCommand {
    /// Creates a new `INPUT` command that uses `console` to gather user input.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("INPUT")
                .with_syntax(&[
                    (
                        &[SingularArgSyntax::RequiredRef(
                            RequiredRefSyntax {
                                name: Cow::Borrowed("vref"),
                                require_array: false,
                                define_undefined: true,
                            },
                            ArgSepSyntax::End,
                        )],
                        None,
                    ),
                    (
                        &[
                            SingularArgSyntax::OptionalValue(
                                OptionalValueSyntax {
                                    name: Cow::Borrowed("prompt"),
                                    vtype: ExprType::Text,
                                    missing_value: 0,
                                    present_value: 1,
                                },
                                ArgSepSyntax::OneOf(ArgSep::Long, ArgSep::Short),
                            ),
                            SingularArgSyntax::RequiredRef(
                                RequiredRefSyntax {
                                    name: Cow::Borrowed("vref"),
                                    require_array: false,
                                    define_undefined: true,
                                },
                                ArgSepSyntax::End,
                            ),
                        ],
                        None,
                    ),
                ])
                .with_category(CATEGORY)
                .with_description(
                    "Obtains user input from the console.
The first expression to this function must be empty or evaluate to a string, and specifies \
the prompt to print.  If this first argument is followed by the short `;` separator, the \
prompt is extended with a question mark.
The second expression to this function must be a bare variable reference and indicates the \
variable to update with the obtained input.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for InputCommand {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, mut scope: Scope<'_>, machine: &mut Machine) -> CallResult {
        let prompt = if scope.nargs() == 1 {
            "".to_owned()
        } else {
            debug_assert!((3..=4).contains(&scope.nargs()));

            let has_prompt = scope.pop_integer();

            let mut prompt = if has_prompt == 1 {
                scope.pop_string()
            } else {
                debug_assert_eq!(0, has_prompt);
                String::new()
            };

            match scope.pop_sep_tag() {
                ArgSep::Long => (),
                ArgSep::Short => prompt.push_str("? "),
                _ => unreachable!(),
            }

            prompt
        };
        let (vname, vtype, pos) = scope.pop_varref_with_pos();

        let mut console = self.console.borrow_mut();
        let mut previous_answer = String::new();
        let vref = VarRef::new(vname.to_string(), Some(vtype));
        loop {
            match read_line(&mut *console, &prompt, &previous_answer, None).await {
                Ok(answer) => {
                    let trimmed_answer = answer.trim_end();
                    let e = match vtype {
                        ExprType::Boolean => match parse_boolean(trimmed_answer) {
                            Ok(b) => {
                                machine
                                    .get_mut_symbols()
                                    .set_var(&vref, Value::Boolean(b))
                                    .map_err(|e| CallError::EvalError(pos, format!("{}", e)))?;
                                return Ok(());
                            }
                            Err(e) => e,
                        },

                        ExprType::Double => match parse_double(trimmed_answer) {
                            Ok(d) => {
                                machine
                                    .get_mut_symbols()
                                    .set_var(&vref, Value::Double(d))
                                    .map_err(|e| CallError::EvalError(pos, format!("{}", e)))?;
                                return Ok(());
                            }
                            Err(e) => e,
                        },

                        ExprType::Integer => match parse_integer(trimmed_answer) {
                            Ok(i) => {
                                machine
                                    .get_mut_symbols()
                                    .set_var(&vref, Value::Integer(i))
                                    .map_err(|e| CallError::EvalError(pos, format!("{}", e)))?;
                                return Ok(());
                            }
                            Err(e) => e,
                        },

                        ExprType::Text => {
                            machine
                                .get_mut_symbols()
                                .set_var(&vref, Value::Text(trimmed_answer.to_owned()))
                                .map_err(|e| CallError::EvalError(pos, format!("{}", e)))?;
                            return Ok(());
                        }
                    };

                    console.print(&format!("Retry input: {}", e))?;
                    previous_answer = answer;
                }
                Err(e) if e.kind() == io::ErrorKind::InvalidData => {
                    console.print(&format!("Retry input: {}", e))?
                }
                Err(e) => return Err(e.into()),
            }
        }
    }
}

/// The `LOCATE` command.
pub struct LocateCommand {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl LocateCommand {
    /// Creates a new `LOCATE` command that moves the cursor of the `console`.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("LOCATE")
                .with_syntax(&[(
                    &[
                        SingularArgSyntax::RequiredValue(
                            RequiredValueSyntax {
                                name: Cow::Borrowed("column"),
                                vtype: ExprType::Integer,
                            },
                            ArgSepSyntax::Exactly(ArgSep::Long),
                        ),
                        SingularArgSyntax::RequiredValue(
                            RequiredValueSyntax {
                                name: Cow::Borrowed("row"),
                                vtype: ExprType::Integer,
                            },
                            ArgSepSyntax::End,
                        ),
                    ],
                    None,
                )])
                .with_category(CATEGORY)
                .with_description("Moves the cursor to the given position.")
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for LocateCommand {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, mut scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        fn get_coord((i, pos): (i32, LineCol), name: &str) -> Result<(u16, LineCol), CallError> {
            match u16::try_from(i) {
                Ok(v) => Ok((v, pos)),
                Err(_) => Err(CallError::ArgumentError(pos, format!("{} out of range", name))),
            }
        }

        debug_assert_eq!(2, scope.nargs());
        let (column, column_pos) = get_coord(scope.pop_integer_with_pos(), "Column")?;
        let (row, row_pos) = get_coord(scope.pop_integer_with_pos(), "Row")?;

        let mut console = self.console.borrow_mut();
        let size = console.size_chars()?;

        if column >= size.x {
            return Err(CallError::ArgumentError(
                column_pos,
                format!("Column {} exceeds visible range of {}", column, size.x - 1),
            ));
        }
        if row >= size.y {
            return Err(CallError::ArgumentError(
                row_pos,
                format!("Row {} exceeds visible range of {}", row, size.y - 1),
            ));
        }

        console.locate(CharsXY::new(column, row))?;
        Ok(())
    }
}

/// The `PRINT` command.
pub struct PrintCommand {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl PrintCommand {
    /// Creates a new `PRINT` command that writes to `console`.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("PRINT")
                .with_syntax(&[(
                    &[],
                    Some(&RepeatedSyntax {
                        name: Cow::Borrowed("expr"),
                        type_syn: RepeatedTypeSyntax::AnyValue,
                        sep: ArgSepSyntax::OneOf(ArgSep::Long, ArgSep::Short),
                        require_one: false,
                        allow_missing: true,
                    }),
                )])
                .with_category(CATEGORY)
                .with_description(
                    "Prints one or more values to the console.
The expressions given as arguments are all evaluated and converted to strings before they are \
printed.  See the documentation of STR$() for the conversion rules.
Using a `;` separator between arguments causes the two adjacent values to be displayed together.  \
For strings, this means that no space is added between them; for all other types, a space is added \
after the value on the left side.
Using a `,` separator between arguments works the same as `;` except that the fields are \
left-aligned to 14-character wide fields on the screen.
If the last expression is empty (i.e. if the statement ends in a semicolon or a comma), then \
the cursor position remains on the same line of the message right after what was printed.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for PrintCommand {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, mut scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        let mut text = String::new();
        let mut nl = true;
        while scope.nargs() > 0 {
            let mut add_space = false;

            match scope.pop_value_tag() {
                ValueTag::Boolean => {
                    let b = scope.pop_boolean();
                    add_space = true;
                    nl = true;
                    text += format_boolean(b);
                }
                ValueTag::Double => {
                    let d = scope.pop_double();
                    add_space = true;
                    nl = true;
                    text += &format_double(d);
                }
                ValueTag::Integer => {
                    let i = scope.pop_integer();
                    add_space = true;
                    nl = true;
                    text += &format_integer(i);
                }
                ValueTag::Text => {
                    let s = scope.pop_string();
                    nl = true;
                    text += &s;
                }
                ValueTag::Missing => {
                    nl = false;
                }
            }

            if scope.nargs() > 0 {
                match scope.pop_sep_tag() {
                    ArgSep::Short => {
                        if add_space {
                            text += " "
                        }
                    }
                    ArgSep::Long => {
                        text += " ";
                        while text.len() % 14 != 0 {
                            text += " ";
                        }
                    }
                    _ => unreachable!(),
                }
            }
        }

        if nl {
            self.console.borrow_mut().print(&text)?;
        } else {
            self.console.borrow_mut().write(&text)?;
        }
        Ok(())
    }
}

/// The `SCRCOLS` function.
pub struct ScrColsFunction {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl ScrColsFunction {
    /// Creates a new instance of the function.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("SCRCOLS")
                .with_return_type(ExprType::Integer)
                .with_syntax(&[(&[], None)])
                .with_category(CATEGORY)
                .with_description(
                    "Returns the number of columns in the text console.
See SCRROWS to query the other dimension.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for ScrColsFunction {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        debug_assert_eq!(0, scope.nargs());
        let size = self.console.borrow().size_chars()?;
        scope.return_integer(i32::from(size.x))
    }
}

/// The `SCRROWS` function.
pub struct ScrRowsFunction {
    metadata: CallableMetadata,
    console: Rc<RefCell<dyn Console>>,
}

impl ScrRowsFunction {
    /// Creates a new instance of the function.
    pub fn new(console: Rc<RefCell<dyn Console>>) -> Rc<Self> {
        Rc::from(Self {
            metadata: CallableMetadataBuilder::new("SCRROWS")
                .with_return_type(ExprType::Integer)
                .with_syntax(&[(&[], None)])
                .with_category(CATEGORY)
                .with_description(
                    "Returns the number of rows in the text console.
See SCRCOLS to query the other dimension.",
                )
                .build(),
            console,
        })
    }
}

#[async_trait(?Send)]
impl Callable for ScrRowsFunction {
    fn metadata(&self) -> &CallableMetadata {
        &self.metadata
    }

    async fn exec(&self, scope: Scope<'_>, _machine: &mut Machine) -> CallResult {
        debug_assert_eq!(0, scope.nargs());
        let size = self.console.borrow().size_chars()?;
        scope.return_integer(i32::from(size.y))
    }
}

/// Adds all console-related commands for the given `console` to the `machine`.
pub fn add_all(machine: &mut Machine, console: Rc<RefCell<dyn Console>>) {
    machine.add_clearable(ConsoleClearable::new(console.clone()));
    machine.add_callable(ClsCommand::new(console.clone()));
    machine.add_callable(ColorCommand::new(console.clone()));
    machine.add_callable(InKeyFunction::new(console.clone()));
    machine.add_callable(InputCommand::new(console.clone()));
    machine.add_callable(LocateCommand::new(console.clone()));
    machine.add_callable(PrintCommand::new(console.clone()));
    machine.add_callable(ScrColsFunction::new(console.clone()));
    machine.add_callable(ScrRowsFunction::new(console));
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::testutils::*;

    #[test]
    fn test_cls_ok() {
        Tester::default().run("CLS").expect_output([CapturedOut::Clear(ClearType::All)]).check();
    }

    #[test]
    fn test_cls_errors() {
        check_stmt_compilation_err("1:1: In call to CLS: expected no arguments", "CLS 1");
    }

    #[test]
    fn test_color_ok() {
        fn t() -> Tester {
            Tester::default()
        }
        t().run("COLOR").expect_output([CapturedOut::SetColor(None, None)]).check();
        t().run("COLOR ,").expect_output([CapturedOut::SetColor(None, None)]).check();
        t().run("COLOR 1").expect_output([CapturedOut::SetColor(Some(1), None)]).check();
        t().run("COLOR 1,").expect_output([CapturedOut::SetColor(Some(1), None)]).check();
        t().run("COLOR , 1").expect_output([CapturedOut::SetColor(None, Some(1))]).check();
        t().run("COLOR 10, 5").expect_output([CapturedOut::SetColor(Some(10), Some(5))]).check();
        t().run("COLOR 0, 0").expect_output([CapturedOut::SetColor(Some(0), Some(0))]).check();
        t().run("COLOR 255, 255")
            .expect_output([CapturedOut::SetColor(Some(255), Some(255))])
            .check();
    }

    #[test]
    fn test_color_errors() {
        check_stmt_compilation_err(
            "1:1: In call to COLOR: expected <> | <fg%> | <[fg%], [bg%]>",
            "COLOR 1, 2, 3",
        );
        check_stmt_compilation_err(
            "1:1: In call to COLOR: expected <> | <fg%> | <[fg%], [bg%]>",
            "COLOR 1; 2",
        );

        check_stmt_err("1:1: In call to COLOR: 1:7: Color out of range", "COLOR 1000, 0");
        check_stmt_err("1:1: In call to COLOR: 1:10: Color out of range", "COLOR 0, 1000");

        check_stmt_compilation_err(
            "1:1: In call to COLOR: 1:7: BOOLEAN is not a number",
            "COLOR TRUE, 0",
        );
        check_stmt_compilation_err(
            "1:1: In call to COLOR: 1:10: BOOLEAN is not a number",
            "COLOR 0, TRUE",
        );
    }

    #[test]
    fn test_inkey_ok() {
        Tester::default()
            .run("result = INKEY")
            .expect_var("result", Value::Text("".to_owned()))
            .check();

        Tester::default()
            .add_input_chars("x")
            .run("result = INKEY")
            .expect_var("result", Value::Text("x".to_owned()))
            .check();

        Tester::default()
            .add_input_keys(&[Key::CarriageReturn, Key::Backspace, Key::NewLine])
            .run("r1 = INKEY$: r2 = INKEY: r3 = INKEY$")
            .expect_var("r1", Value::Text("ENTER".to_owned()))
            .expect_var("r2", Value::Text("BS".to_owned()))
            .expect_var("r3", Value::Text("ENTER".to_owned()))
            .check();
    }

    #[test]
    fn test_inkey_errors() {
        check_expr_compilation_error(
            "1:10: In call to INKEY: expected no arguments nor parenthesis",
            "INKEY()",
        );
        check_expr_compilation_error(
            "1:10: In call to INKEY: expected no arguments nor parenthesis",
            "INKEY(1)",
        );
    }

    #[test]
    fn test_input_ok() {
        fn t<V: Into<Value>>(stmt: &str, input: &str, output: &str, var: &str, value: V) {
            Tester::default()
                .add_input_chars(input)
                .run(stmt)
                .expect_prints([output])
                .expect_var(var, value)
                .check();
        }

        t("INPUT foo\nPRINT foo", "9\n", " 9", "foo", 9);
        t("INPUT ; foo\nPRINT foo", "9\n", " 9", "foo", 9);
        t("INPUT ; foo\nPRINT foo", "-9\n", "-9", "foo", -9);
        t("INPUT , bar?\nPRINT bar", "true\n", "TRUE", "bar", true);
        t("INPUT ; foo$\nPRINT foo", "\n", "", "foo", "");
        t(
            "INPUT \"With question mark\"; a$\nPRINT a$",
            "some long text\n",
            "some long text",
            "a",
            "some long text",
        );

        Tester::default()
            .add_input_chars("42\n")
            .run("prompt$ = \"Indirectly without question mark\"\nINPUT prompt$, b\nPRINT b * 2")
            .expect_prints([" 84"])
            .expect_var("prompt", "Indirectly without question mark")
            .expect_var("b", 42)
            .check();
    }

    #[test]
    fn test_input_on_predefined_vars() {
        Tester::default()
            .add_input_chars("1.5\n")
            .run("d = 3.0\nINPUT ; d")
            .expect_var("d", 1.5)
            .check();

        Tester::default()
            .add_input_chars("foo bar\n")
            .run("DIM s AS STRING\nINPUT ; s")
            .expect_var("s", "foo bar")
            .check();

        Tester::default()
            .add_input_chars("5\ntrue\n")
            .run("DIM b AS BOOLEAN\nINPUT ; b")
            .expect_prints(["Retry input: Invalid boolean literal 5"])
            .expect_var("b", true)
            .check();
    }

    #[test]
    fn test_input_retry() {
        Tester::default()
            .add_input_chars("\ntrue\n")
            .run("INPUT ; b?")
            .expect_prints(["Retry input: Invalid boolean literal "])
            .expect_var("b", true)
            .check();

        Tester::default()
            .add_input_chars("0\ntrue\n")
            .run("INPUT ; b?")
            .expect_prints(["Retry input: Invalid boolean literal 0"])
            .expect_var("b", true)
            .check();

        Tester::default()
            .add_input_chars("\n7\n")
            .run("a = 3\nINPUT ; a")
            .expect_prints(["Retry input: Invalid integer literal "])
            .expect_var("a", 7)
            .check();

        Tester::default()
            .add_input_chars("x\n7\n")
            .run("a = 3\nINPUT ; a")
            .expect_prints(["Retry input: Invalid integer literal x"])
            .expect_var("a", 7)
            .check();
    }

    #[test]
    fn test_input_errors() {
        check_stmt_compilation_err(
            "1:1: In call to INPUT: expected <vref> | <[prompt$] <,|;> vref>",
            "INPUT",
        );
        check_stmt_compilation_err(
            "1:1: In call to INPUT: expected <vref> | <[prompt$] <,|;> vref>",
            "INPUT ; ,",
        );
        check_stmt_compilation_err(
            "1:1: In call to INPUT: expected <vref> | <[prompt$] <,|;> vref>",
            "INPUT ;",
        );
        check_stmt_compilation_err(
            "1:1: In call to INPUT: 1:7: INTEGER is not a STRING",
            "INPUT 3 ; a",
        );
        check_stmt_compilation_err(
            "1:1: In call to INPUT: expected <vref> | <[prompt$] <,|;> vref>",
            "INPUT \"foo\" AS bar",
        );
        check_stmt_err("1:1: In call to INPUT: 1:7: Undefined variable a", "INPUT a + 1 ; b");
        Tester::default()
            .run("a = 3: INPUT ; a + 1")
            .expect_compilation_err(
                "1:8: In call to INPUT: 1:16: Requires a variable reference, not a value",
            )
            .check();
        check_stmt_err(
            "1:1: In call to INPUT: 1:11: Cannot + STRING and BOOLEAN",
            "INPUT \"a\" + TRUE; b?",
        );
    }

    #[test]
    fn test_locate_ok() {
        Tester::default()
            .run("LOCATE 0, 0")
            .expect_output([CapturedOut::Locate(CharsXY::default())])
            .check();

        Tester::default()
            .run("LOCATE 63000, 64000")
            .expect_output([CapturedOut::Locate(CharsXY::new(63000, 64000))])
            .check();
    }

    #[test]
    fn test_locate_errors() {
        check_stmt_compilation_err("1:1: In call to LOCATE: expected column%, row%", "LOCATE");
        check_stmt_compilation_err("1:1: In call to LOCATE: expected column%, row%", "LOCATE 1");
        check_stmt_compilation_err(
            "1:1: In call to LOCATE: expected column%, row%",
            "LOCATE 1, 2, 3",
        );
        check_stmt_compilation_err("1:1: In call to LOCATE: expected column%, row%", "LOCATE 1; 2");

        check_stmt_err("1:1: In call to LOCATE: 1:8: Column out of range", "LOCATE -1, 2");
        check_stmt_err("1:1: In call to LOCATE: 1:8: Column out of range", "LOCATE 70000, 2");
        check_stmt_compilation_err(
            "1:1: In call to LOCATE: 1:8: BOOLEAN is not a number",
            "LOCATE TRUE, 2",
        );
        check_stmt_compilation_err("1:1: In call to LOCATE: expected column%, row%", "LOCATE , 2");

        check_stmt_err("1:1: In call to LOCATE: 1:11: Row out of range", "LOCATE 1, -2");
        check_stmt_err("1:1: In call to LOCATE: 1:11: Row out of range", "LOCATE 1, 70000");
        check_stmt_compilation_err(
            "1:1: In call to LOCATE: 1:11: BOOLEAN is not a number",
            "LOCATE 1, TRUE",
        );
        check_stmt_compilation_err("1:1: In call to LOCATE: expected column%, row%", "LOCATE 1,");

        let mut t = Tester::default();
        t.get_console().borrow_mut().set_size_chars(CharsXY { x: 30, y: 20 });
        t.run("LOCATE 30, 0")
            .expect_err("1:1: In call to LOCATE: 1:8: Column 30 exceeds visible range of 29")
            .check();
        t.run("LOCATE 31, 0")
            .expect_err("1:1: In call to LOCATE: 1:8: Column 31 exceeds visible range of 29")
            .check();
        t.run("LOCATE 0, 20")
            .expect_err("1:1: In call to LOCATE: 1:11: Row 20 exceeds visible range of 19")
            .check();
        t.run("LOCATE 0, 21")
            .expect_err("1:1: In call to LOCATE: 1:11: Row 21 exceeds visible range of 19")
            .check();
    }

    #[test]
    fn test_print_ok() {
        Tester::default().run("PRINT").expect_prints([""]).check();
        Tester::default().run("PRINT ;").expect_output([CapturedOut::Write("".to_owned())]).check();
        Tester::default()
            .run("PRINT ,")
            .expect_output([CapturedOut::Write("              ".to_owned())])
            .check();
        Tester::default()
            .run("PRINT ;,;,")
            .expect_output([CapturedOut::Write("                            ".to_owned())])
            .check();

        Tester::default()
            .run("PRINT \"1234567890123\", \"4\"")
            .expect_prints(["1234567890123 4"])
            .check();
        Tester::default()
            .run("PRINT \"12345678901234\", \"5\"")
            .expect_prints(["12345678901234              5"])
            .check();

        Tester::default().run("PRINT \"abcdefg\", 1").expect_prints(["abcdefg        1"]).check();
        Tester::default().run("PRINT \"abcdefgh\", 1").expect_prints(["abcdefgh       1"]).check();

        Tester::default().run("PRINT 3").expect_prints([" 3"]).check();
        Tester::default().run("PRINT -3").expect_prints(["-3"]).check();
        Tester::default().run("PRINT 3 = 5").expect_prints(["FALSE"]).check();

        Tester::default().run("PRINT 3; -1; 4").expect_prints([" 3 -1  4"]).check();
        Tester::default().run("PRINT \"foo\"; \"bar\"").expect_prints(["foobar"]).check();
        Tester::default()
            .run(r#"PRINT "foo";: PRINT "bar""#)
            .expect_output([
                CapturedOut::Write("foo".to_owned()),
                CapturedOut::Print("bar".to_owned()),
            ])
            .check();
        Tester::default()
            .run("PRINT true;123;\"foo bar\"")
            .expect_prints(["TRUE  123 foo bar"])
            .check();

        Tester::default()
            .run("PRINT 6,1;3,5")
            .expect_prints([" 6             1  3          5"])
            .check();

        Tester::default()
            .run(r#"word = "foo": PRINT word, word: PRINT word + "s""#)
            .expect_prints(["foo           foo", "foos"])
            .expect_var("word", "foo")
            .check();

        Tester::default()
            .run(r#"word = "foo": PRINT word,: PRINT word;: PRINT word + "s""#)
            .expect_output([
                CapturedOut::Write("foo           ".to_owned()),
                CapturedOut::Write("foo".to_owned()),
                CapturedOut::Print("foos".to_owned()),
            ])
            .expect_var("word", "foo")
            .check();
    }

    #[test]
    fn test_print_control_chars() {
        let mut found_any = false;
        for i in 0..1024 {
            let ch = char::from_u32(i).unwrap();
            let ch_var = format!("{}", ch);
            let exp_ch = if ch.is_control() {
                found_any = true;
                " "
            } else {
                &ch_var
            };
            Tester::default()
                .set_var("ch", Value::Text(ch_var.clone()))
                .run("PRINT ch")
                .expect_prints([exp_ch])
                .expect_var("ch", Value::Text(ch_var.clone()))
                .check();
        }
        assert!(found_any, "Test did not exercise what we wanted");
    }

    #[test]
    fn test_print_errors() {
        check_stmt_compilation_err(
            "1:1: In call to PRINT: expected [expr1 <,|;> .. <,|;> exprN]",
            "PRINT 3 AS 4",
        );
        check_stmt_compilation_err(
            "1:1: In call to PRINT: expected [expr1 <,|;> .. <,|;> exprN]",
            "PRINT 3, 4 AS 5",
        );
        // Ensure type errors from `Expr` and `Value` bubble up.
        check_stmt_err("1:9: Unexpected value in expression", "PRINT a b");
        check_stmt_err("1:9: Cannot + INTEGER and BOOLEAN", "PRINT 3 + TRUE");
    }

    #[test]
    fn test_scrcols() {
        let mut t = Tester::default();
        t.get_console().borrow_mut().set_size_chars(CharsXY { x: 12345, y: 0 });
        t.run("result = SCRCOLS").expect_var("result", 12345i32).check();

        check_expr_compilation_error(
            "1:10: In call to SCRCOLS: expected no arguments nor parenthesis",
            "SCRCOLS()",
        );
        check_expr_compilation_error(
            "1:10: In call to SCRCOLS: expected no arguments nor parenthesis",
            "SCRCOLS(1)",
        );
    }

    #[test]
    fn test_scrrows() {
        let mut t = Tester::default();
        t.get_console().borrow_mut().set_size_chars(CharsXY { x: 0, y: 768 });
        t.run("result = SCRROWS").expect_var("result", 768i32).check();

        check_expr_compilation_error(
            "1:10: In call to SCRROWS: expected no arguments nor parenthesis",
            "SCRROWS()",
        );
        check_expr_compilation_error(
            "1:10: In call to SCRROWS: expected no arguments nor parenthesis",
            "SCRROWS(1)",
        );
    }
}