figcraft/crates/doc/src/proto_expr_parse_tests.rs

//! Prototype expressions typed as text: parsing, errors, type checks and reading back what
//! `display` writes.

use crate::color::Color;
use crate::proto::*;
use crate::proto_expr_tests::vars;
use crate::{VariableType, VariableValue};

fn parse(text: &str) -> Expr {
    Expr::parse(text, &vars()).unwrap_or_else(|e| panic!("{text}: {e:?}"))
}

fn error(text: &str) -> String {
    match Expr::parse(text, &vars()) {
        Ok(e) => panic!("{text} parsed as {e:?}"),
        Err(e) => e.message,
    }
}

fn n(x: f64) -> Expr {
    Expr::Value(VariableValue::Number(x))
}

#[test]
fn reads_variables_literals_and_precedence() {
    use ExprOp::*;
    assert_eq!(parse("n-name + 1"), Expr::op(Add, vec![Expr::var("n"), n(1.0)]), "names with symbols read whole");
    assert_eq!(parse("{n-name}*2"), Expr::op(Multiply, vec![Expr::var("n"), n(2.0)]));
    assert_eq!(parse("n"), Expr::var("n"), "ids work too");
    assert_eq!(parse("1 + 2 * 3"), Expr::op(Add, vec![n(1.0), Expr::op(Multiply, vec![n(2.0), n(3.0)])]));
    assert_eq!(parse("10 - 2 - 3"), Expr::op(Subtract, vec![n(10.0), n(2.0), n(3.0)]), "one run, left to right");
    assert_eq!(parse("1 + 2 - 3"), Expr::op(Subtract, vec![Expr::op(Add, vec![n(1.0), n(2.0)]), n(3.0)]));
    assert_eq!(parse("-3"), n(-3.0));
    assert_eq!(parse("-n-name"), Expr::op(Negate, vec![Expr::var("n")]));
    assert_eq!(parse("2.5e1"), n(25.0));
    assert_eq!(parse("'single'"), Expr::Value(VariableValue::String("single".into())));
    assert_eq!(parse(r#""say \"hi\"""#), Expr::Value(VariableValue::String("say \"hi\"".into())));
    assert_eq!(parse("#ff0000"), Expr::Value(VariableValue::Color(Color::from_hex("ff0000").unwrap())));
    assert_eq!(parse("TRUE"), Expr::Value(VariableValue::Boolean(true)));
    // Logic: not binds looser than comparisons, and looser than not, or loosest.
    assert_eq!(parse("not n-name == 3"), Expr::op(Not, vec![Expr::op(Equals, vec![Expr::var("n"), n(3.0)])]));
    assert_eq!(
        parse("b-name and n-name >= 2 or !b-name"),
        Expr::op(
            Or,
            vec![Expr::op(And, vec![Expr::var("b"), Expr::op(GreaterOrEqual, vec![Expr::var("n"), n(2.0)])]), Expr::op(Not, vec![Expr::var("b")])]
        )
    );
    assert_eq!(parse("b-name && b-name || false"), parse("(b-name and b-name) or false"));
    assert_eq!(parse("n-name = 3"), parse("n-name == 3"), "a single = compares");
    assert_eq!(parse("1 == 1 == 1"), Expr::op(Equals, vec![n(1.0), n(1.0), n(1.0)]));
    assert_eq!(parse("  ( ( n-name ) ) "), Expr::var("n"));
}

#[test]
fn errors_say_what_is_wrong() {
    assert_eq!(error(""), "Type an expression");
    assert_eq!(error("   "), "Type an expression");
    assert_eq!(error("count + 1"), "No variable `count`");
    assert_eq!(error("{nope}"), "No variable `nope`");
    assert_eq!(error("n-name +"), "Something is missing at the end");
    assert_eq!(error("(1 + 2"), "Add a closing )");
    assert_eq!(error("1 + 2)"), "Unexpected ): there's no ( to close");
    assert_eq!(error("\"open"), "Close the text with \"");
    assert_eq!(error("n-name s-name"), "Add an operator before `s`");
    assert_eq!(error("1 < 2 < 3"), "Compare two values at a time: join comparisons with `and` or `or`");
    assert_eq!(error("#12"), "`#12` isn't a colour (use #RRGGBB)");
    assert_eq!(error("1.2.3"), "`1.2.3` isn't a number");
    assert_eq!(error("{n-name"), "Add a closing }");
    assert_eq!(error("1 ? 2"), "Unexpected ?");
    assert_eq!(error("'it''s'"), "Unexpected '");
    let e = Expr::parse("n-name + nope", &vars()).unwrap_err();
    assert_eq!(e.at, 9, "where it went wrong");
}

#[test]
fn display_reads_back_as_the_same_expression() {
    let v = vars();
    for text in [
        "n-name + 1",
        "(n-name + 1) == 4",
        "not b-name",
        "not (b-name and false)",
        "(not b-name) == true",
        "not not b-name",
        "(not b-name) and b-name",
        "\"Count: \" + n-name",
        "\"quote \\\" and \\\\ slash\"",
        "0.125 * -3",
        "s-name != \"yo\" or n-name < 0.1",
        "-(n-name + 2)",
        "#FF8000 == #FF8000",
        "(1 + 2) + 3",
        "1 + 2 + 3",
    ] {
        let e = parse(text);
        let shown = e.display(&v);
        assert_eq!(Expr::parse(&shown, &v).as_ref(), Ok(&e), "{text} → {shown}");
    }
    assert_eq!(parse("0.125 * 2").display(&v), "0.125 * 2", "exact numbers");
}

#[test]
fn type_checks_explain_mismatches() {
    let v = vars();
    let ty = |t: &str| parse(t).type_of(&v);
    assert_eq!(ty("n-name + 1"), Ok(VariableType::Number));
    assert_eq!(ty("\"n = \" + n-name + b-name"), Ok(VariableType::String));
    assert_eq!(ty("n-name >= 2 and b-name"), Ok(VariableType::Boolean));
    assert_eq!(ty("-b-name"), Ok(VariableType::Boolean));
    assert_eq!(ty("b-name + 1"), Err("`+` adds numbers or joins text".into()));
    assert_eq!(ty("s-name * 2"), Err("`*` needs numbers".into()));
    assert_eq!(ty("n-name == s-name"), Err("Can't compare a number with text".into()));
    assert_eq!(ty("b-name < true"), Err("`<` compares two numbers or two texts".into()));
    assert_eq!(ty("n-name and b-name"), Err("`and` needs true or false on both sides".into()));
    assert_eq!(ty("not n-name"), Err("`not` needs true or false".into()));
    assert_eq!(ty("\"a\" + #FFFFFF"), Err("Colours can't be joined to text".into()));
    assert_eq!(Expr::var("gone").type_of(&v), Err("No variable `gone`".into()));
    assert_eq!(Expr::op(ExprOp::Equals, vec![n(1.0)]).type_of(&v), Err("`==` compares two values".into()));
    assert_eq!(n(f64::NAN).type_of(&v), Err("Numbers must be finite".into()));
    // Conditions give true or false; values fit their variable (text takes numbers).
    assert_eq!(parse("n-name > 1").check_condition(&v), Ok(()));
    assert_eq!(parse("n-name + 1").check_condition(&v), Err("A condition must be true or false, not a number".into()));
    assert_eq!(parse("n-name + 1").check_value(&v, VariableType::String), Ok(()));
    assert_eq!(parse("\"x\"").check_value(&v, VariableType::Number), Err("This gives text, but the variable holds a number".into()));
}

#[test]
fn hostile_text_is_bounded() {
    let v = vars();
    // Deep brackets stop with an error instead of overflowing the stack.
    let deep = format!("{}1{}", "(".repeat(5000), ")".repeat(5000));
    assert!(Expr::parse(&deep, &v).is_err());
    let nested = format!("{}1{}", "(".repeat(200), ")".repeat(200));
    assert_eq!(Expr::parse(&nested, &v).map_err(|e| e.message), Err("The expression is nested too deeply".into()));
    assert!(Expr::parse(&"not ".repeat(2000), &v).is_err());
    assert!(Expr::parse(&"1+".repeat(3000), &v).is_err(), "too long");
    // A long flat sum is fine, and type checks without recursion trouble.
    let flat = vec!["1"; 500].join("+");
    assert_eq!(Expr::parse(&flat, &v).map(|e| e.type_of(&v)), Ok(Ok(VariableType::Number)));
    // Deep expressions built by hand fail the type check, not the stack.
    let mut e = n(1.0);
    for _ in 0..(MAX_EXPR_DEPTH + 3) {
        e = Expr::op(ExprOp::Negate, vec![e]);
    }
    assert_eq!(e.type_of(&v), Err("The expression is nested too deeply".into()));
    for junk in ["\u{0}", "{}", "{", "#", "-", "--", "!", "!=", "e5", ".", "1e", "1e+", "\"\\", "and", "or or", "==", "((", "))", "🙂", "n-name🙂"]
    {
        let _ = Expr::parse(junk, &v);
    }
    // Mode lookups and modes as junk: whatever parses writes back to the same expression and
    // evaluates without trouble.
    let modes = std::collections::BTreeMap::from([("c".to_string(), "dark".to_string())]);
    for junk in [
        "n-name[",
        "n-name[]]",
        "n-name[[Dark]]",
        "n-name[Dark][Light]",
        "n-name [\u{0}]",
        "{n-name}[\"",
        "mode(",
        "mode((",
        "mode(Theme)[Dark]",
        "mode(mode(Theme))",
        "mode()()",
        "mode(\"Theme\"",
        "n-name[Dark] + mode(Theme)",
        "-n-name[Dark] * n-name[Light] / 0",
        "n-name[🙂]",
        "not mode(Theme)",
        "mode(Theme) < mode(Theme) == true",
    ] {
        if let Ok(e) = Expr::parse(junk, &v) {
            assert_eq!(Expr::parse(&e.display(&v), &v), Ok(e.clone()), "{junk}");
            let _ = e.eval(&v, &modes);
        }
    }
}

#[test]
fn names_that_look_like_literals_read_back_as_variables() {
    for name in ["count", "count total", "2x", "1", "-3", ".5", "(x)", "#ff", "\"q\"", "not", "true"] {
        let mut v = vars();
        if let Some(var) = v.variables.iter_mut().find(|x| x.id == "n") {
            var.name = name.into();
        }
        for e in [Expr::var("n"), Expr::op(ExprOp::Add, vec![Expr::var("n"), n(1.0)]), Expr::InMode { variable: "n".into(), mode: "dark".into() }] {
            let shown = e.display(&v);
            assert_eq!(Expr::parse(&shown, &v), Ok(e.clone()), "{name:?} shown as {shown:?}");
        }
    }
    // Plain names stay bare, and literals still read as literals.
    let v = vars();
    assert_eq!(Expr::var("n").display(&v), "n-name");
    assert_eq!(parse("1"), n(1.0));
    assert_eq!(parse("\"q\""), Expr::Value(VariableValue::String("q".into())));
}