enso/lib/rust/parser/debug/tests/parse.rs
Kaz Wesley 2b3bd2cc90
Move documentation into documentable types (#11441)
Move documentation into documentable types (implements #11302).

# Important Notes
GUI:
- Distinguish expression and statement
- `Ast.Ast` is still present, as the base class for AST objects. Most references to `Ast.Ast` are now references to `Ast.Expression`. Operations on blocks use `Ast.Statement`.
- `Ast.parse` has been replaced with: `Ast.parseExpression`, `Ast.parseStatement`, and `Ast.parseBlock`
- `syncToCode` is internally context-aware; it parses the provided code appropriately depending on whether its AST is an expression, a statement, or the top level of a module.
- Remove `wrappingExpression` / `innerExpression` APIs: Wrapper types have been eliminated; modifier lines are now fields inside parent types.
- Simplify AST printing:
- Fully implemented autospacing in `concreteChildren` implementations; the type returned by `concreteChildren` now ensures that spacing has been fully resolved.
- Eliminate `printBlock` / `printDocs`: `concreteChildren` is now aware of indentation context, and responsible for indentation of its child lines.
- The `Pattern` type is now parameterized to identify the AST type it constructs. The `Pattern.parseExpression` function helps create a `Pattern<Expression>`.
- Refactor `performCollape` for testability.
- e2e tests: Improve table viz test: It still doesn't pass on my Mac, but these changes are necessary if not sufficient.

Compiler (TreeToIr):
- An expression in statement context is now found in an `ExpressionStatement` wrapper.
- Documentation for a `Function` is now found inside the function node.
- Deduplicate some polyglot-function logic.
2024-11-04 15:33:53 +00:00

2066 lines
70 KiB
Rust

//! Parse expressions and compare their results to expected values.
// === Non-Standard Linter Configuration ===
#![allow(clippy::option_map_unit_fn)]
#![allow(clippy::precedence)]
#![allow(dead_code)]
#![deny(non_ascii_idents)]
#![deny(unconditional_recursion)]
#![warn(unsafe_code)]
#![warn(missing_copy_implementations)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![warn(trivial_casts)]
#![warn(trivial_numeric_casts)]
#![warn(unused_import_braces)]
#![warn(unused_qualifications)]
mod metadata;
use enso_parser_debug::to_s_expr;
use lexpr::sexp;
// ===========================
// === Test support macros ===
// ===========================
/// Parses input as a sequence of S-expressions, and wraps it in a `BodyBlock`.
macro_rules! block {
( $($statements:tt)* ) => {
sexp![(BodyBlock #( $( $statements )* ) )]
}
}
macro_rules! test {
( $code:expr, $($statements:tt)* ) => {
test($code, block![$( $statements )*])
}
}
macro_rules! test_block {
( $code:expr, $($statements:tt)* ) => {
test_block($code, block![$( $statements )*])
}
}
// ================================
// === Language Construct Tests ===
// ================================
#[test]
fn nothing() {
test("", block![()]);
}
#[test]
fn application() {
test("a b c", block![(App (App (Ident a) (Ident b)) (Ident c))]);
}
#[test]
fn parentheses() {
test!("(a b)", (Group (App (Ident a) (Ident b))));
expect_invalid_node("x)");
test!("(x", (Invalid));
test!("(a) (b)", (App (Group (Ident a)) (Group (Ident b))));
test!("((a b) c)",
(Group
(App (Group (App (Ident a) (Ident b)))
(Ident c))));
test!("(a).b", (OprApp (Group (Ident a)) (Ok ".") (Ident b)));
}
#[test]
fn section_simple() {
test!("+ a", (OprSectionBoundary 1 (OprApp () (Ok "+") (Ident a))));
test!("a +", (OprSectionBoundary 1 (OprApp (Ident a) (Ok "+") ())));
}
#[test]
fn inline_if() {
test!("if True then True else False",
(MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (Ident False)))));
}
#[test]
fn then_block() {
test!("if True then\n True",
(MultiSegmentApp #(((Ident if) (Ident True)) ((Ident then) (BodyBlock #((Ident True)))))));
}
#[test]
fn else_block() {
test!("if True then True else\n False",
(MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (BodyBlock #((Ident False)))))));
}
#[test]
fn if_then_else_chained_block() {
test!("if True then True else False\n . to_text",
(OperatorBlockApplication
(MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (Ident False)
)))
#(((Ok ".") (Ident to_text)))
#()
));
test!("(if True then True else False)\n . to_text",
(OperatorBlockApplication
(Group (MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (Ident False)
))))
#(((Ok ".") (Ident to_text)))
#()
));
test!("if True then True else False\n . to_text\n . as_value",
(OperatorBlockApplication
(MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (Ident False)
)))
#(((Ok ".") (Ident to_text)) ((Ok ".") (Ident as_value)))
#()
));
test!("if True then True else False\n . to_text\n . as_value\n . done 42",
(OperatorBlockApplication
(MultiSegmentApp #(((Ident if) (Ident True))
((Ident then) (Ident True))
((Ident else) (Ident False)
)))
#(((Ok ".") (Ident to_text)) ((Ok ".") (Ident as_value)) ((Ok ".") (App (Ident done) (Number () "42" ()))))
#()
));
}
// === Comments ===
#[test]
fn plain_comments() {
test!("# a b c", ()());
test(
"main = # define main\n 4",
block!(,(Function::new("main", block![() (Number () "4" ())]))),
);
}
#[test]
fn function_documentation() {
test!([
"## The Identity Function",
"",
" Arguments:",
" - x: value to do nothing to",
"id x = x",
].join("\n"),
,(Function::new("id", sexp![(Ident x)])
.with_docs(sexp![
((#((Section " The Identity Function") (Newline) (Newline)
(Section "Arguments:") (Newline)
(Section "- x: value to do nothing to")))
#(()))])
.with_arg("x")));
test!(&["type Foo", " ## Test indent handling", " ", " foo bar = foo"].join("\n"),
(TypeDef Foo #() #(
,(Function::new("foo", sexp![(Ident foo)])
.with_docs(sexp![((#((Section " Test indent handling"))) #(() ()))])
.with_arg("bar")))));
expect_invalid_node("expression ## unexpected doc comment on same line");
}
#[test]
fn expression_documentation() {
test_block!("## The value of x\nx",
(ExpressionStatement ((#((Section " The value of x"))) #(())) (Ident x)));
}
#[test]
fn unused_documentation() {
test!("## First docs\n## More docs\n\n## More docs after a gap",
(Documentation (#((Section " First docs"))))
(Documentation (#((Section " More docs"))))
()
(Documentation (#((Section " More docs after a gap")))));
}
// === Type Definitions ===
#[test]
fn type_definition_no_body() {
test!("type Bool", (TypeDef Bool #() #()));
test!("type Option a", (TypeDef Option #((() (Ident a) () ())) #()));
test!("type Option (a)", (TypeDef Option #((() (Ident a) () ())) #()));
test!("type Foo (a : Int)", (TypeDef Foo #((() (Ident a) (":" (Ident Int)) ())) #()));
test!("type A a=0", (TypeDef A #((() (Ident a) () ((Number () "0" ())))) #()));
test!("type Existing_Headers (column_names : Vector Text)",
(TypeDef Existing_Headers #(
(() (Ident column_names) (":" (App (Ident Vector) (Ident Text))) ())) #()));
test!("type 1", (Invalid));
}
#[test]
fn type_constructors() {
test!([
"type Geo",
" Circle",
" radius",
" x",
" Rectangle width height",
" Point",
].join("\n"),
(TypeDef Geo #()
#(,(Constructor::new("Circle").with_arg_line("radius").with_arg_line("x"))
,(Constructor::new("Rectangle").with_arg("width").with_arg("height"))
,(Constructor::new("Point")))));
test!("type Foo\n Bar (a : B = C.D)", (TypeDef Foo #() #(
,(Constructor::new("Bar")
.with_arg(sexp![(() (Ident a) (":" (Ident B)) ((OprApp (Ident C) (Ok ".") (Ident D))))]))
)));
test!(["type A", " Foo (a : Integer, b : Integer)"].join("\n"),
(TypeDef A #()
#(,(Constructor::new("Foo").with_arg(sexp![(() (Ident a) (":" (Invalid)) ())])))));
}
#[test]
fn type_constructor_documentation() {
test!("type Foo\n ## Bar\n Baz", (TypeDef Foo #() #(
,(Constructor::new("Baz").with_docs(sexp![((#((Section " Bar"))) #(()))])))));
}
#[test]
fn type_constructor_private() {
test!(["type Foo", " private Bar"].join("\n"),
(TypeDef Foo #() #(,(Constructor::new("Bar").private()))));
test!(["type Foo", " private Bar", " Foo"].join("\n"),
(TypeDef Foo #()
#(,(Constructor::new("Bar").private())
,(Constructor::new("Foo")))));
test!([ "type Geo",
" private Circle",
" radius",
" x",
" Rectangle width height",
" Point",
].join("\n"),
(TypeDef Geo #()
#(,(Constructor::new("Circle")
.private()
.with_arg_line("radius")
.with_arg_line("x"))
,(Constructor::new("Rectangle").with_arg("width").with_arg("height"))
,(Constructor::new("Point")))));
test!(["type My_Type", " private Value a b c"].join("\n"),
(TypeDef My_Type #()
#(,(Constructor::new("Value").private().with_arg("a").with_arg("b").with_arg("c")))));
}
#[test]
fn type_methods() {
test!(["type Geo", " number =", " x", " area self = x + x"].join("\n"),
(TypeDef Geo #()
#(,(Function::new("number", block![(Ident x)]))
,(Function::new("area", sexp![(OprApp (Ident x) (Ok "+") (Ident x))])
.with_arg("self")))));
test!([
"type Problem_Builder",
" ## Returns a vector containing all reported problems, aggregated.",
" build_problemset : Vector",
" build_problemset self =",
" self",
].join("\n"),
(TypeDef Problem_Builder #() #(
,(Function::new("build_problemset", block![(Ident self)])
.with_docs(sexp![((#((Section " Returns a vector containing all reported problems, aggregated."))) #(()))])
.with_sig(sexp![(Ident Vector)])
.with_arg("self")))));
test!("[foo., bar.]",
(Array (OprSectionBoundary 1 (OprApp (Ident foo) (Ok ".") ()))
#(("," (OprSectionBoundary 1 (OprApp (Ident bar) (Ok ".") ()))))));
}
#[test]
fn type_operator_methods() {
test!([ "type Foo",
" + : Foo -> Foo -> Foo",
" + self b = b",
" Foo.+ : Foo",
" Foo.+ self b = b",
].join("\n"),
(TypeDef Foo #()
#(,(Function::new("+", sexp![(Ident b)])
.with_sig(sexp![
(OprApp (Ident Foo) (Ok "->") (OprApp (Ident Foo) (Ok "->") (Ident Foo)))])
.with_arg("self")
.with_arg("b"))
,(Function::named(sexp![(OprApp (Ident Foo) (Ok ".") (Ident #"+"))], sexp![(Ident b)])
.with_sig(sexp![(Ident Foo)])
.with_arg("self")
.with_arg("b")))));
test!("Any.==", (OprApp (Ident Any) (Ok ".") (Ident #"==")));
expect_invalid_node("x.-y");
expect_invalid_node("x.-1");
expect_invalid_node("x.+y");
expect_invalid_node("x.+1");
expect_invalid_node("x.+'a'");
// Compile-time operators are never operator-identifiers.
test!("x.~y", (OprApp (Ident x) (Ok ".") (UnaryOprApp "~" (Ident y))));
test!("x.~1", (OprApp (Ident x) (Ok ".") (UnaryOprApp "~" (Number () "1" ()))));
}
#[test]
fn type_def_full() {
test!([ "type Geo",
" Circle",
" radius : float",
" x",
" Rectangle width height",
" Point",
"",
" number =",
" x",
" area self = x + x",
].join("\n"),
(TypeDef Geo #()
#(,(Constructor::new("Circle")
.with_arg_line(sexp![(() (Ident radius) (":" (Ident float)) ())])
.with_arg_line("x"))
,(Constructor::new("Rectangle").with_arg("width").with_arg("height"))
,(Constructor::new("Point"))
()
,(Function::new("number", block![(Ident x)]))
,(Function::new("area", sexp![(OprApp (Ident x) (Ok "+") (Ident x))])
.with_arg("self")))));
}
#[test]
fn type_def_defaults() {
let code = ["type Result error ok=Nothing", " Ok value:ok = Nothing"];
test!(code.join("\n"),
(TypeDef Result #((() (Ident error) () ())
(() (Ident ok) () ((Ident Nothing))))
#(,(Constructor::new("Ok")
.with_arg(sexp![(() (Ident value) (":" (Ident ok)) ((Ident Nothing)))])))));
}
#[test]
fn type_def_nested() {
let code = ["type Foo", " type Bar", " type Baz"];
test!(code.join("\n"),
(TypeDef Foo #()
#((TypeDef Bar #() #())
(TypeDef Baz #() #()))));
}
// === Variable Assignment ===
#[test]
fn assignment_simple() {
// At the top level of a module, this defines a function with no arguments.
test!("foo = x", ,(Function::new("foo", sexp![(Ident x)])));
// In a body block, this is a variable binding.
test_block!("main =\n foo = x",
,(Function::new("main", block![,(Assignment::new("foo", sexp![(Ident x)]))])));
test_block!("foo=x", ,(Assignment::new("foo", sexp![(Ident x)])));
test_block!("foo= x", ,(Assignment::new("foo", sexp![(Ident x)])));
expect_invalid_node("foo =x");
}
#[test]
fn assignment_documentation() {
test_block!("## The Foo\nfoo = x",
,(Assignment::new("foo", sexp![(Ident x)])
.with_docs(sexp![((#((Section " The Foo"))) #(()))])));
}
// === Functions ===
#[test]
fn function_inline_simple_args() {
test!("foo a = x",
,(Function::new("foo", sexp![(Ident x)]).with_arg("a")));
test!("foo a b = x",
,(Function::new("foo", sexp![(Ident x)]).with_arg("a").with_arg("b")));
test!("foo a b c = x",
,(Function::new("foo", sexp![(Ident x)]).with_arg("a").with_arg("b").with_arg("c")));
test!("foo _ = x",
,(Function::new("foo", sexp![(Ident x)]).with_arg(sexp![(() (Wildcard -1) () ())])));
expect_invalid_node("foo a =x");
}
#[test]
fn function_noargs_nobody() {
test!("foo =", ,(Function::new("foo", sexp![()])));
}
#[test]
fn function_no_body() {
test!("foo a =",
,(Function::new("foo", sexp![()]).with_arg("a")));
test!("foo a b =",
,(Function::new("foo", sexp![()]).with_arg("a").with_arg("b")));
test!("foo a b c =",
,(Function::new("foo", sexp![()]).with_arg("a").with_arg("b").with_arg("c")));
test!("foo _ =",
,(Function::new("foo", sexp![()]).with_arg(sexp![(() (Wildcard -1) () ())])));
}
#[test]
fn function_block_body() {
test!("foo a =\n a",
,(Function::new("foo", block![(Ident a)]).with_arg("a")));
test!("foo a b =\n a",
,(Function::new("foo", block![(Ident a)]).with_arg("a").with_arg("b")));
test!("foo a b c =\n a",
,(Function::new("foo", block![(Ident a)]).with_arg("a").with_arg("b").with_arg("c")));
}
#[test]
fn function_qualified() {
test!("Id.id x = x",
,(Function::named(sexp![(OprApp (Ident Id) (Ok ".") (Ident id))], sexp![(Ident x)])
.with_arg("x")));
}
#[test]
fn ignored_arguments() {
test!("f _ = x",
,(Function::new("f", sexp![(Ident x)]).with_arg(sexp![(() (Wildcard -1) () ())])));
test!("f ~_ = x",
,(Function::new("f", sexp![(Ident x)]).with_arg(sexp![("~" (Wildcard -1) () ())])));
}
#[test]
fn foreign_functions() {
test!("foreign python my_method a b = \"42\"",
(ForeignFunction python my_method
#((() (Ident a) () ()) (() (Ident b) () ()))
(TextLiteral #((Section "42")))));
test!("foreign python my_method = \"42\"",
(ForeignFunction python my_method #() (TextLiteral #((Section "42")))));
expect_invalid_node("private foreign python my_method = \"42\"");
}
#[test]
fn function_inline_return_specification() {
// Typical usage
test!("id self that:Integer -> Integer = that",
,(Function::new("id", sexp![(Ident that)])
.with_arg("self")
.with_arg(sexp![(() (Ident that) (":" (Ident Integer)) ())])
.with_return(sexp![(Ident Integer)])));
// Edge case
test!("number -> Integer = 23",
,(Function::new("number", sexp![(Number () "23" ())])
.with_return(sexp![(Ident Integer)])));
expect_invalid_node("f x : Integer -> Integer = 23");
}
// === Named arguments ===
#[test]
fn named_arguments() {
test!("f x=y", (NamedApp (Ident f) x (Ident y)));
test!("f (x = y)", (NamedApp (Ident f) x (Ident y)));
test!("(x a=b)", (Group (NamedApp (Ident x) a (Ident b))));
test!("(x a=b.c)", (Group (NamedApp (Ident x) a (OprApp (Ident b) (Ok ".") (Ident c)))));
test!("catch handler=exc->\n throw",
(NamedApp (Ident catch) handler
(OprApp (Ident exc) (Ok "->") (BodyBlock #((Ident throw))))));
test!("sort by=x-> y-> compare x y",
(NamedApp (Ident sort) by
(OprApp (Ident x) (Ok "->")
(OprApp (Ident y) (Ok "->") (App (App (Ident compare) (Ident x)) (Ident y))))));
test!("sort by=(<) xs",
(App
(NamedApp (Ident sort) by (Group (OprSectionBoundary 2 (OprApp () (Ok "<") ()))))
(Ident xs)));
test!("sort by=(x-> x) y-> compare x y",
(App
(NamedApp (Ident sort) by (Group (OprApp (Ident x) (Ok "->") (Ident x))))
(OprApp (Ident y) (Ok "->") (App (App (Ident compare) (Ident x)) (Ident y)))));
test!("sort by=(x-> x) 1",
(App
(NamedApp (Ident sort) by (Group (OprApp (Ident x) (Ok "->") (Ident x))))
(Number () "1" ())));
test!("foo to=", (App (Ident foo) (Invalid)));
test!("(foo to=)", (Group (App (Ident foo) (Invalid))));
test!("filter (foo to=(1))",
(App (Ident filter) (Group (NamedApp (Ident foo) to (Group (Number () "1" ()))))));
test!("foo . bar baz=quux",
(NamedApp (OprApp (Ident foo) (Ok ".") (Ident bar)) baz (Ident quux)));
}
// === Default arguments ===
#[test]
fn default_app() {
test!("f default", (App (Ident f) (Ident default)));
}
#[test]
fn argument_named_default() {
test!("f default x = x",
,(Function::new("f", sexp![(Ident x)]).with_arg("default").with_arg("x")));
test!("f x default = x",
,(Function::new("f", sexp![(Ident x)]).with_arg("x").with_arg("default")));
}
#[test]
fn complex_arguments() {
test!("f x=1 = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) () ((Number () "1" ())))])));
test!("f (x : Number) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ())])));
test!("f (x = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) () ((Number () "1" ())))])));
test!("f ((x = 1) : Number) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Invalid) (":" (Ident Number)) ())])));
test!("f (x=1 : Number) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Invalid) (":" (Ident Number)) ())])));
test!("f (x : Number = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f (x y) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Invalid) () ())])));
test!("f ((x : Number) = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f ((x : Array Number) = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![
(() (Ident x) (":" (App (Ident Array) (Ident Number))) ((Number () "1" ())))])));
test!("f (x):Number=1 = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Invalid) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f ((x:Number=1)) = x",
,(Function::new("f", sexp![(Ident x)]).with_arg(sexp![(() (Invalid) () ())])));
test!("f (x : Number)=1 = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f (x:Number = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f (x:Number=1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
test!("f x:Number=1 = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![(() (Ident x) (":" (Ident Number)) ((Number () "1" ())))])));
// Pattern in LHS:
test!("f ~x=1 = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![("~" (Ident x) () ((Number () "1" ())))])));
test!("f (~x = 1) = x", ,(Function::new("f", sexp![(Ident x)])
.with_arg(sexp![("~" (Ident x) () ((Number () "1" ())))])));
}
// === Code Blocks ===
#[test]
fn code_block_body() {
test!(["main =", " x"].join("\n"),
,(Function::new("main", block![(Ident x)])));
test!(["main =", " ", " x"].join("\n"),
,(Function::new("main", block![() (Ident x)])));
test!(["main =", " ", " x"].join("\n"),
,(Function::new("main", block![() (Ident x)])));
test!(["main =", " ", " x"].join("\n"),
,(Function::new("main", block![() (Ident x)])));
test!(["main =", "", " x"].join("\n"),
,(Function::new("main", block![() (Ident x)])));
test!(["main =", " +x", " print x"].join("\n"),
,(Function::new("main", block![
(OprSectionBoundary 1 (OprApp () (Ok "+") (Ident x)))
(App (Ident print) (Ident x))])));
}
#[test]
fn code_block_operator() {
test_block!(["value = nums", " * each random", " + constant"].join("\n"),
,(Assignment::new("value", sexp![
(OperatorBlockApplication (Ident nums)
#(((Ok "*") (App (Ident each) (Ident random)))
((Ok "+") (Ident constant)))
#())
])));
}
#[test]
fn dot_operator_blocks() {
let code = ["rect1", " . width * 7", " . abs", " + x"];
test!(code.join("\n"),
(OperatorBlockApplication (Ident rect1)
#(((Ok ".") (OprApp (Ident width) (Ok "*") (Number () "7" ())))
((Ok ".") (OperatorBlockApplication (Ident abs)
#(((Ok "+") (Ident x))) #()))) #()));
expect_invalid_node("rect1\n . width = 7");
}
#[test]
fn code_block_argument_list() {
test!("foo\n bar", (ArgumentBlockApplication (Ident foo) #((Ident bar))));
test_block!("value = foo\n bar",
,(Assignment::new("value", sexp![(ArgumentBlockApplication (Ident foo) #((Ident bar)))])));
let code = ["value = foo", " +x", " bar"];
test_block!(code.join("\n"),
,(Assignment::new("value", sexp![
(ArgumentBlockApplication (Ident foo) #(
(OprSectionBoundary 1 (OprApp () (Ok "+") (Ident x)))
(Ident bar)))])));
}
#[test]
fn code_block_empty() {
// The first line here should parse as a function with no body expression (which is an error).
// No input would parse as an empty `ArgumentBlock` or `OperatorBlock`, because those types are
// distinguished from a body continuation by the presence of non-empty indented lines.
test!(["foo =", "bar"].join("\n"), ,(Function::new("foo", sexp![()])) (Ident bar));
// This parses similarly to above; a line with no non-whitespace content does not create a code
// block.
test!(["foo =", " ", "bar"].join("\n"), ,(Function::new("foo", sexp![()])) () (Ident bar));
}
#[test]
fn code_block_bad_indents1() {
test!(["main =", " foo", " bar", " baz"].join("\n"),
,(Function::new("main", block![(Ident foo) (Ident bar) (Ident baz)])));
}
#[test]
fn code_block_bad_indents2() {
test!(["main =", " foo", " bar", "baz"].join("\n"),
,(Function::new("main", block![(Ident foo) (Ident bar)]))
(Ident baz));
}
#[test]
fn code_block_with_following_statement() {
test!(["main =", " foo", "bar"].join("\n"),
,(Function::new("main", block![(Ident foo)]))
(Ident bar));
}
#[test]
fn operator_block_nested() {
let code = ["foo", " + bar", " - baz"];
#[rustfmt::skip]
let expected = block![
(OperatorBlockApplication (Ident foo)
#(((Ok "+") (OperatorBlockApplication (Ident bar) #(((Ok "-") (Ident baz))) #())))
#())];
test(code.join("\n"), expected);
}
#[test]
fn operator_section_in_operator_block() {
let code = ["foo", " + bar +"];
#[rustfmt::skip]
let expected = block![
(OperatorBlockApplication (Ident foo)
#(((Ok "+") (OprSectionBoundary 1 (OprApp (Ident bar) (Ok "+") ()))))
#())];
test(code.join("\n"), expected);
}
#[test]
fn first_line_indented() {
test!(" a", (BodyBlock #((Ident a))));
}
// === Binary Operators ===
#[test]
fn multiple_operator_error() {
expect_multiple_operator_error("x + + x");
expect_multiple_operator_error("x + + + x");
expect_multiple_operator_error("x + +");
expect_multiple_operator_error("+ + x");
expect_multiple_operator_error("+ +");
expect_multiple_operator_error("+ -");
expect_multiple_operator_error("x + -");
}
#[test]
fn precedence() {
test!("x * y + z", (OprApp (OprApp (Ident x) (Ok "*") (Ident y)) (Ok "+") (Ident z)));
test!("x + y * z", (OprApp (Ident x) (Ok "+") (OprApp (Ident y) (Ok "*") (Ident z))));
test!("w + x + y * z",
(OprApp (OprApp (Ident w) (Ok "+") (Ident x)) (Ok "+")
(OprApp (Ident y) (Ok "*") (Ident z))));
test!("x - 1 + 2",
(OprApp (OprApp (Ident x) (Ok "-") (Number () "1" ())) (Ok "+") (Number () "2" ())));
test!("x+y * z", (OprApp (Ident x) (Ok "+") (OprApp (Ident y) (Ok "*") (Ident z))));
}
#[test]
fn dot_operator_precedence() {
test!("x y . f v", (App (OprApp (App (Ident x) (Ident y)) (Ok ".") (Ident f)) (Ident v)));
}
#[test]
fn dot_operator_template_function() {
test!("foo._", (TemplateFunction 1 (OprApp (Ident foo) (Ok ".") (Wildcard 0))));
test!("_.foo", (TemplateFunction 1 (OprApp (Wildcard 0) (Ok ".") (Ident foo))));
}
#[test]
fn right_associative_operators() {
test!("x --> y ---> z", (OprApp (Ident x) (Ok "-->") (OprApp (Ident y) (Ok "--->") (Ident z))));
test!("x <| y <<| z", (OprApp (Ident x) (Ok "<|") (OprApp (Ident y) (Ok "<<|") (Ident z))));
}
#[test]
fn left_associative_operators() {
test!("x + y + z", (OprApp (OprApp (Ident x) (Ok "+") (Ident y)) (Ok "+") (Ident z)));
}
#[test]
fn pipeline_operators() {
test("f <| a", block![(OprApp (Ident f) (Ok "<|") (Ident a))]);
test("a |> f", block![(OprApp (Ident a) (Ok "|>") (Ident f))]);
}
#[test]
fn accessor_operator() {
// Test that the accessor operator `.` is treated like any other operator.
test!("Console.", (OprSectionBoundary 1 (OprApp (Ident Console) (Ok ".") ())));
test!(".", (OprSectionBoundary 2 (OprApp () (Ok ".") ())));
test!(".log", (OprSectionBoundary 1 (OprApp () (Ok ".") (Ident log))));
}
#[test]
fn operator_sections() {
test!(".map (+2 * 3) *7",
(OprSectionBoundary 1
(App (App (OprApp () (Ok ".") (Ident map))
(Group
(OprSectionBoundary 1 (OprApp (OprApp () (Ok "+") (Number () "2" ()))
(Ok "*") (Number () "3" ())))))
(OprSectionBoundary 1 (OprApp () (Ok "*") (Number () "7" ()))))));
test!(".sum 1",
(OprSectionBoundary 1 (App (OprApp () (Ok ".") (Ident sum)) (Number () "1" ()))));
test!("+1 + x",
(OprSectionBoundary 1 (OprApp (OprApp () (Ok "+") (Number () "1" ()))
(Ok "+") (Ident x))));
test_block!("increment = 1 +",
,(Assignment::new("increment", sexp![
(OprSectionBoundary 1 (OprApp (Number () "1" ()) (Ok "+") ()))])));
test!("1+ << 2*",
(OprSectionBoundary 1
(OprApp (OprApp (Number () "1" ()) (Ok "+") ())
(Ok "<<")
(OprSectionBoundary 1 (OprApp (Number () "2" ()) (Ok "*") ())))));
test!("1+1+ << 2*2*",
(OprSectionBoundary 1
(OprApp (OprApp (OprApp (Number () "1" ())
(Ok "+")
(Number () "1" ()))
(Ok "+") ())
(Ok "<<")
(OprSectionBoundary 1
(OprApp (OprApp (Number () "2" ()) (Ok "*") (Number () "2" ()))
(Ok "*") ())))));
test!("+1 << *2",
(OprSectionBoundary 1
(OprApp (OprApp () (Ok "+") (Number () "1" ()))
(Ok "<<")
(OprSectionBoundary 1 (OprApp () (Ok "*") (Number () "2" ()))))));
test!("+1+1 << *2*2",
(OprSectionBoundary 1
(OprApp (OprApp (OprApp () (Ok "+") (Number () "1" ())) (Ok "+") (Number () "1" ()))
(Ok "<<")
(OprSectionBoundary 1 (OprApp (OprApp () (Ok "*") (Number () "2" ())) (Ok "*") (Number () "2" ()))))));
}
#[test]
fn template_functions() {
#[rustfmt::skip]
test("_.map (_ + 2*3) _*7", block![
(TemplateFunction 1
(App (App (OprApp (Wildcard 0) (Ok ".") (Ident map))
(Group (TemplateFunction 1
(OprApp (Wildcard 0)
(Ok "+")
(OprApp (Number () "2" ()) (Ok "*") (Number () "3" ()))))))
(TemplateFunction 1 (OprApp (Wildcard 0) (Ok "*") (Number () "7" ())))))]);
#[rustfmt::skip]
test("_.sum 1", block![
(TemplateFunction 1 (App (OprApp (Wildcard 0) (Ok ".") (Ident sum)) (Number () "1" ())))]);
#[rustfmt::skip]
test("_+1 + x", block![
(TemplateFunction 1 (OprApp (OprApp (Wildcard 0) (Ok "+") (Number () "1" ()))
(Ok "+") (Ident x)))]);
}
// === Unary Operators ===
#[test]
fn unevaluated_argument() {
test!("main ~foo = x",
,(Function::new("main", sexp![(Ident x)]).with_arg(sexp![("~" (Ident foo) () ())])));
}
#[test]
fn unary_operator_missing_operand() {
expect_invalid_node("main ~ = x");
}
#[test]
fn unary_operator_at_end_of_expression() {
expect_invalid_node("foo ~");
}
#[test]
fn unspaced_operator_sequence() {
// Add a negated value.
test_block!("x = y+-z",
,(Assignment::new("x", sexp![(OprApp (Ident y) (Ok "+") (UnaryOprApp "-" (Ident z)))])));
// Create an operator section that adds a negated value to its input.
test_block!("x = +-z",
,(Assignment::new("x", sexp![
(OprSectionBoundary 1
(OprApp () (Ok "+") (UnaryOprApp "-" (Ident z))))])));
// The `-` can only be lexed as a unary operator, and unary operators cannot form sections.
expect_invalid_node("main =\n x = y+-");
// Assign a negative number to x.
test_block!("x=-1", ,(Assignment::new("x", sexp![(UnaryOprApp "-" (Number () "1" ()))])));
// Assign a negated value to x.
test_block!("x=-y", ,(Assignment::new("x", sexp![(UnaryOprApp "-" (Ident y))])));
}
#[test]
fn minus_binary() {
test!("x - x", (OprApp (Ident x) (Ok "-") (Ident x)));
test!("x-x", (OprApp (Ident x) (Ok "-") (Ident x)));
test!("x-1", (OprApp (Ident x) (Ok "-") (Number () "1" ())));
}
#[test]
fn minus_section() {
#[rustfmt::skip]
let cases = [
("- x", block![(OprSectionBoundary 1 (OprApp () (Ok "-") (Ident x)))]),
("(- x)", block![(Group (OprSectionBoundary 1 (OprApp () (Ok "-") (Ident x))))]),
("- (x * x)", block![
(OprSectionBoundary 1 (OprApp () (Ok "-")
(Group (OprApp (Ident x) (Ok "*") (Ident x)))))]),
];
cases.into_iter().for_each(|(code, expected)| test(code, expected));
}
#[test]
fn minus_unary() {
test!("f -x", (App (Ident f) (UnaryOprApp "-" (Ident x))));
test!("-x", (UnaryOprApp "-" (Ident x)));
test!("(-x)", (Group (UnaryOprApp "-" (Ident x))));
test!("-(x * x)", (UnaryOprApp "-" (Group (OprApp (Ident x) (Ok "*") (Ident x)))));
test_block!("x=-x", ,(Assignment::new("x", sexp![(UnaryOprApp "-" (Ident x))])));
test!("-x+x", (OprApp (UnaryOprApp "-" (Ident x)) (Ok "+") (Ident x)));
test!("-x*x", (OprApp (UnaryOprApp "-" (Ident x)) (Ok "*") (Ident x)));
}
#[test]
fn minus_unary_decimal() {
test!("-2.1", (UnaryOprApp "-" (Number () "2" ("." "1"))));
}
#[test]
fn minus_unary_in_method_app() {
test!("-1.x", (OprApp (UnaryOprApp "-" (Number () "1" ())) (Ok ".") (Ident x)));
test!("-1.up_to 100",
(App (OprApp (UnaryOprApp "-" (Number () "1" ())) (Ok ".") (Ident up_to))
(Number () "100" ())));
}
#[test]
fn method_app_in_minus_unary() {
test!("-Number.positive_infinity",
(UnaryOprApp "-" (OprApp (Ident Number) (Ok ".") (Ident positive_infinity))));
}
#[test]
fn autoscope_operator() {
test!("x : ..True", (TypeSignatureDeclaration ((Ident x) ":" (AutoscopedIdentifier ".." True))));
test_block!("x = ..True", ,(Assignment::new("x", sexp![(AutoscopedIdentifier ".." True)])));
test_block!("x = f ..True",
,(Assignment::new("x", sexp![(App (Ident f) (AutoscopedIdentifier ".." True))])));
expect_invalid_node("x = ..not_a_constructor");
expect_invalid_node("x = case a of ..True -> True");
expect_invalid_node("x = ..4");
expect_invalid_node("x = ..Foo.Bar");
expect_invalid_node("x = f .. True");
expect_invalid_node("x = f (.. ..)");
expect_invalid_node("x = f (.. *)");
expect_invalid_node("x = f (.. True)");
expect_invalid_node("x = True..");
expect_invalid_node("x = True..True");
expect_invalid_node("x = ..");
expect_invalid_node("x = .. True");
expect_invalid_node("x : .. True");
}
// === Import/Export ===
#[test]
fn import() {
#[rustfmt::skip]
let cases = [
("import project.IO", block![
(Import () () ((Ident import) (OprApp (Ident project) (Ok ".") (Ident IO))) () () ())]),
("import Standard.Base as Enso_List", block![
(Import () ()
((Ident import) (OprApp (Ident Standard) (Ok ".") (Ident Base)))
()
((Ident as) (Ident Enso_List))
())]),
("from Standard.Base import all", block![
(Import ()
((Ident from) (OprApp (Ident Standard) (Ok ".") (Ident Base)))
((Ident import) ())
all () ())]),
("from Standard.Base import all hiding Number, Boolean", block![
(Import ()
((Ident from) (OprApp (Ident Standard) (Ok ".") (Ident Base)))
((Ident import) ())
all
()
((Ident hiding) (OprApp (Ident Number) (Ok ",") (Ident Boolean))))]),
("polyglot java import java.lang.Float", block![
(Import
((Ident polyglot) (Ident java))
()
((Ident import)
(OprApp (OprApp (Ident java) (Ok ".") (Ident lang)) (Ok ".") (Ident Float)))
() () ())]),
("polyglot java import java.net.URI as Java_URI", block![
(Import
((Ident polyglot) (Ident java))
()
((Ident import)
(OprApp (OprApp (Ident java) (Ok ".") (Ident net)) (Ok ".") (Ident URI)))
()
((Ident as) (Ident Java_URI))
())]),
("from Standard.Base import Foo, Bar, Baz", block![
(Import ()
((Ident from) (OprApp (Ident Standard) (Ok ".") (Ident Base)))
((Ident import) (OprApp (OprApp (Ident Foo) (Ok ",") (Ident Bar)) (Ok ",") (Ident Baz)))
() () ())]),
];
cases.into_iter().for_each(|(code, expected)| test(code, expected));
expect_invalid_node("from Standard.Base.Data.Array import new as array_new");
}
#[test]
fn export() {
test!("export prj.Data.Foo",
(Export ()
((Ident export)
(OprApp (OprApp (Ident prj) (Ok ".") (Ident Data)) (Ok ".") (Ident Foo)))
()));
test!("export Foo as Bar",
(Export () ((Ident export) (Ident Foo)) ((Ident as) (Ident Bar))));
test!("from Foo export Bar, Baz",
(Export
((Ident from) (Ident Foo))
((Ident export) (OprApp (Ident Bar) (Ok ",") (Ident Baz)))
()));
expect_invalid_node("from Foo export all hiding Bar, Baz");
test!("from Foo export all", (Invalid));
}
// === Metadata ===
#[test]
fn metadata_raw() {
let code = [
"x",
"",
"",
"",
"#### METADATA ####",
r#"[[{"index":{"value":7},"size":{"value":8}},"5bad897e-099b-4b00-9348-64092636746d"]]"#,
];
let code = code.join("\n");
let (_meta, code) = enso_parser::metadata::parse(&code).unwrap();
let expected = block![
(Ident x)
()
];
test(code, expected);
}
#[test]
fn metadata_parsing() {
let code = metadata::ORDERS_WITH_METADATA;
let (meta, code) = enso_parser::metadata::parse(code).unwrap();
let _ast = parse(code);
let _meta: enso_parser::metadata::Metadata = meta.unwrap();
}
// === Type annotations and signatures ===
#[test]
fn type_signatures() {
test!("val : Bool", (TypeSignatureDeclaration ((Ident val) ":" (Ident Bool))));
test_block!("val : Bool\nval", (TypeSignatureDeclaration ((Ident val) ":" (Ident Bool))) (Ident val));
test_block!("val : Bool", (TypeAnnotated (Ident val) ":" (Ident Bool)));
test!("val : Bool\nval = True",
,(Function::new("val", sexp![(Ident True)])
.with_sig(sexp![(Ident Bool)])));
test!("val : Bool\n\nval = True",
,(Function::new("val", sexp![(Ident True)])
.with_sig(sexp![(Ident Bool)])));
test!("val : Bool\n\n\nval = True",
,(Function::new("val", sexp![(Ident True)])
.with_sig(sexp![(Ident Bool)])));
test!("val : Bool\ndifferent_name = True",
(TypeSignatureDeclaration ((Ident val) ":" (Ident Bool)))
,(Function::new("different_name", sexp![(Ident True)])));
test!("val : List Int", (TypeSignatureDeclaration ((Ident val) ":" (App (Ident List) (Ident Int)))));
test!("foo : [Integer | Text] -> (Integer | Text)",
(TypeSignatureDeclaration ((Ident foo) ":"
(OprApp (Array (OprApp (Ident Integer) (Ok "|") (Ident Text)) #())
(Ok "->")
(Group (OprApp (Ident Integer) (Ok "|") (Ident Text)))))));
test!("f a (b : Int) : Double",
(TypeAnnotated
(App (App (Ident f) (Ident a)) (Group (TypeAnnotated (Ident b) ":" (Ident Int))))
":" (Ident Double)));
test!("f a (b = 1 : Int) : Double",
(TypeAnnotated
(NamedApp (App (Ident f) (Ident a)) b
(TypeAnnotated (Number () "1" ()) ":" (Ident Int))) ":" (Ident Double)));
}
#[test]
fn type_annotations() {
test_block!("val = x : Int",
,(Assignment::new("val", sexp![(TypeAnnotated (Ident x) ":" (Ident Int))])));
test_block!("val = foo (x : Int)",
,(Assignment::new("val", sexp![
(App (Ident foo)
(Group (TypeAnnotated (Ident x) ":" (Ident Int))))])));
test!("(x : My_Type _)",
(Group
(TypeAnnotated (Ident x)
":"
(App (Ident My_Type) (TemplateFunction 1 (Wildcard 0))))));
test!("x : List Int -> Int",
(TypeSignatureDeclaration ((Ident x) ":"
(OprApp (App (Ident List) (Ident Int)) (Ok "->") (Ident Int)))));
test!("p:Plus + m:Plus",
(OprApp (TypeAnnotated (Ident p) ":" (Ident Plus))
(Ok "+") (TypeAnnotated (Ident m) ":" (Ident Plus))));
}
// === Text Literals ===
#[test]
fn inline_text_literals() {
test!(r#""I'm an inline raw text!""#, (TextLiteral #((Section "I'm an inline raw text!"))));
test_block!(r#"zero_length = """#, ,(Assignment::new("zero_length", sexp![(TextLiteral #())])));
test!(r#""type""#, (TextLiteral #((Section "type"))));
test_block!(r#"unclosed = ""#, ,(Assignment::new("unclosed", sexp![(TextLiteral #())])));
test_block!(r#"unclosed = "a"#,
,(Assignment::new("unclosed", sexp![(TextLiteral #((Section "a")))])));
test!(r#"'Other quote type'"#, (TextLiteral #((Section "Other quote type"))));
test!(r#""Non-escape: \n""#, (TextLiteral #((Section "Non-escape: \\n"))));
test!(r#""Non-escape: \""#, (TextLiteral #((Section "Non-escape: \\"))));
test!(r#"'String with \' escape'"#,
(TextLiteral #((Section "String with ") (Escape 0x27) (Section " escape"))));
test!(r#"'\u0915\u094D\u0937\u093F'"#, (TextLiteral
#((Escape 0x0915) (Escape 0x094D) (Escape 0x0937) (Escape 0x093F))));
test!(r#"('\n')"#, (Group (TextLiteral #((Escape 0x0A)))));
test!(r#"`"#, (Invalid));
test!(r#"(")")"#, (Group (TextLiteral #((Section ")")))));
test!(r#"'\x'"#, (TextLiteral #((Escape 0xFFFFFFFFu32))));
test!(r#"'\u'"#, (TextLiteral #((Escape 0xFFFFFFFFu32))));
test!(r#"'\U'"#, (TextLiteral #((Escape 0xFFFFFFFFu32))));
}
#[test]
fn multiline_text_literals() {
test!("'''", (TextLiteral #()));
let code = r#""""
part of the string
3-spaces indented line, part of the Text Block
this does not end the string -> '''
`also` part of the string
x"#;
test!(code,
(TextLiteral
#((Section "part of the string") (Newline)
(Section " 3-spaces indented line, part of the Text Block") (Newline)
(Section "this does not end the string -> '''") (Newline)
(Newline)
(Section "`also` part of the string")))
()
(Ident x));
test!(r#""""
multiline string that doesn't end in a newline
x"#,
(TextLiteral #((Section "multiline string that doesn't end in a newline")))
(Ident x));
test_block!("x = \"\"\"\n Indented multiline\nx",
,(Assignment::new("x", sexp![(TextLiteral #((Section "Indented multiline")))]))
(Ident x));
test!("'''\n \\nEscape at start\n",
(TextLiteral #((Escape 0x0A) (Section "Escape at start"))) ());
test!("x =\n x = '''\n x\nx",
,(Function::new("x", block![
,(Assignment::new("x", sexp![(TextLiteral #((Section "x")))]))]))
(Ident x));
test_block!("foo = bar '''\n baz",
,(Assignment::new("foo", sexp![(App (Ident bar) (TextLiteral #((Section "baz"))))])));
test!("'''\n \\t'", (TextLiteral #((Escape 0x09) (Section "'"))));
test!("'''\n x\n \\t'", (TextLiteral #((Section "x") (Newline) (Escape 0x09) (Section "'"))));
}
#[test]
fn interpolated_literals_in_inline_text() {
test!(r#"'Simple case.'"#, (TextLiteral #((Section "Simple case."))));
test!(r#"'With a `splice`.'"#, (TextLiteral
#((Section "With a ")
(Splice (Ident splice))
(Section "."))));
test!(r#"'` SpliceWithLeadingWhitespace`'"#,
(TextLiteral #((Splice (Ident SpliceWithLeadingWhitespace)))));
test!(r#"'String with \n escape'"#,
(TextLiteral #((Section "String with ") (Escape 0x0A) (Section " escape"))));
test!(r#"'\x0Aescape'"#, (TextLiteral #((Escape 0x0A) (Section "escape"))));
test!(r#"'\u000Aescape'"#, (TextLiteral #((Escape 0x0A) (Section "escape"))));
test!(r#"'\u{0000A}escape'"#, (TextLiteral #((Escape 0x0A) (Section "escape"))));
test!(r#"'\U0000000Aescape'"#, (TextLiteral #((Escape 0x0A) (Section "escape"))));
}
#[test]
fn interpolated_literals_in_multiline_text() {
let code = r#"'''
`splice` at start"#;
#[rustfmt::skip]
let expected = block![
(TextLiteral #((Splice (Ident splice)) (Section " at start")))];
test(code, expected);
let code = r#"'''
text with a `splice`
and some \u000Aescapes\'"#;
#[rustfmt::skip]
let expected = block![
(TextLiteral
#((Section "text with a ") (Splice (Ident splice)) (Newline)
(Section "and some ") (Escape 0x0A) (Section "escapes") (Escape 0x27)))];
test(code, expected);
}
// === Lambdas ===
#[test]
fn new_lambdas() {
test!(r#"\v-> v"#, (Lambda "\\" #((() (Ident v) () ())) "->" (Ident v)));
test!(r#"\ v -> v"#, (Lambda "\\" #((() (Ident v) () ())) "->" (Ident v)));
test!(r#"\v -> v"#, (Lambda "\\" #((() (Ident v) () ())) "->" (Ident v)));
test!(r#"\ v-> v"#, (Lambda "\\" #((() (Ident v) () ())) "->" (Ident v)));
test!(r#"\ x -> x + y"#,
(Lambda "\\" #((() (Ident x) () ())) "->" (OprApp (Ident x) (Ok "+") (Ident y))));
test!("\\v->\n v", (Lambda "\\" #((() (Ident v) () ())) "->" (BodyBlock #((Ident v)))));
test!("\\ v ->\n v", (Lambda "\\" #((() (Ident v) () ())) "->" (BodyBlock #((Ident v)))));
test!("f \\ v ->\n v",
(App (Ident f) (Lambda "\\" #((() (Ident v) () ())) "->" (BodyBlock #((Ident v))))));
test!(r#"\a b -> x"#,
(Lambda "\\" #((() (Ident a) () ()) (() (Ident b) () ())) "->" (Ident x)));
test!(r#"\~x -> x"#, (Lambda "\\" #(("~" (Ident x) () ())) "->" (Ident x)));
test!(r#"\a (b = f _ 1) -> f a"#,
(Lambda "\\"
#((() (Ident a) () ())
(() (Ident b) ()
((App (App (Ident f) (TemplateFunction 1 (Wildcard 0)))
(Number () "1" ())))))
"->" (App (Ident f) (Ident a))));
expect_invalid_node("\\");
expect_invalid_node("\\ v");
expect_invalid_node("\\v");
expect_invalid_node("\\v->");
expect_invalid_node("\\v->\n");
expect_invalid_node("\\v->\nv");
}
#[test]
fn old_lambdas() {
test!("x -> y", (OprApp (Ident x) (Ok "->") (Ident y)));
test!("x->y", (OprApp (Ident x) (Ok "->") (Ident y)));
test!("x-> y", (OprApp (Ident x) (Ok "->") (Ident y)));
test!("x-> x + y", (OprApp (Ident x) (Ok "->") (OprApp (Ident x) (Ok "+") (Ident y))));
test!("x->\n y", (OprApp (Ident x) (Ok "->") (BodyBlock #((Ident y)))));
test!("x ->\n y", (OprApp (Ident x) (Ok "->") (BodyBlock #((Ident y)))));
test!("f x->\n y",
(App (Ident f) (OprApp (Ident x) (Ok "->") (BodyBlock #((Ident y))))));
test!("x->y-> z", (OprApp (Ident x) (Ok "->") (OprApp (Ident y) (Ok "->") (Ident z))));
test_block!("foo = x -> (y = bar x) -> x + y",
,(Assignment::new("foo", sexp![
(OprApp (Ident x) (Ok "->")
(OprApp (Group (OprApp (Ident y) (Ok "=") (App (Ident bar) (Ident x)))) (Ok "->")
(OprApp (Ident x) (Ok "+") (Ident y))))])));
}
// === Pattern Matching ===
#[test]
fn pattern_irrefutable() {
test_block!("Point x_val = my_point",
,(Assignment::pattern(sexp![(App (Ident Point) (Ident x_val))],
sexp![(Ident my_point)])));
test_block!("Vector _ = x",
,(Assignment::pattern(sexp![(App (Ident Vector) (Wildcard -1))], sexp![(Ident x)])));
test_block!("X.y = z",
,(Function::named(sexp![(OprApp (Ident X) (Ok ".") (Ident y))], sexp![(Ident z)])));
}
#[test]
fn pattern_invalid() {
expect_invalid_node("x + y = z");
expect_invalid_node("(x y) = z");
}
#[test]
fn case_expression() {
#[rustfmt::skip]
let code = [
"case a of",
" Some -> x",
" Int -> x",
];
test!(code.join("\n"),
(CaseOf (Ident a) #(
((() (Ident Some) "->" (Ident x)))
((() (Ident Int) "->" (Ident x))))));
let code = ["case a of", " Vector_2d x y -> x"];
test!(code.join("\n"),
(CaseOf (Ident a) #(
((() (App (App (Ident Vector_2d) (Ident x)) (Ident y)) "->" (Ident x))))));
#[rustfmt::skip]
let code = [
"case self of",
" Vector_2d -> x",
" _ -> x",
];
test!(code.join("\n"),
(CaseOf (Ident self) #(
((() (Ident Vector_2d) "->" (Ident x)))
((() (Wildcard -1) "->" (Ident x))))));
#[rustfmt::skip]
let code = [
"case foo of",
" v:My_Type -> x",
" v:(My_Type _ _) -> x",
];
test!(code.join("\n"),
(CaseOf (Ident foo) #(
((() (TypeAnnotated (Ident v) ":" (Ident My_Type)) "->" (Ident x)))
((() (TypeAnnotated (Ident v) ":"
(Group (App
(App
(Ident My_Type)
(TemplateFunction 1 (Wildcard 0)))
(TemplateFunction 1 (Wildcard 0)))))
"->" (Ident x))))));
}
#[test]
fn case_documentation() {
test!([
"case a of",
" ## The Some case",
" Some -> x",
" ## The Int case",
" Int -> x",
].join("\n"),
(CaseOf (Ident a) #(
((((#((Section " The Some case"))) #()) () () ()))
((() (Ident Some) "->" (Ident x)))
((((#((Section " The Int case"))) #()) () () ()))
((() (Ident Int) "->" (Ident x))))));
}
#[test]
fn case_by_type() {
macro_rules! test_case {
( $code:expr, $case:tt ) => {
test(&format!("case foo of\n {}", $code), block![(CaseOf (Ident foo) #(($case)))]);
}
}
test_case!("f:A->B -> x",
(() (TypeAnnotated (Ident f) ":" (OprApp (Ident A) (Ok "->") (Ident B))) "->" (Ident x)));
test_case!("f : A->B -> x",
(() (TypeAnnotated (Ident f) ":" (OprApp (Ident A) (Ok "->") (Ident B))) "->" (Ident x)));
test_case!("v : A -> x->x",
(() (TypeAnnotated (Ident v) ":" (Ident A)) "->" (OprApp (Ident x) (Ok "->") (Ident x))));
test_case!("v : A -> x -> x",
(() (TypeAnnotated (Ident v) ":" (Ident A)) "->" (OprApp (Ident x) (Ok "->") (Ident x))));
test_case!("v:A->x->x",
(() (TypeAnnotated (Ident v) ":" (Ident A)) "->" (OprApp (Ident x) (Ok "->") (Ident x))));
test_case!("v:A->x", (() (TypeAnnotated (Ident v) ":" (Ident A)) "->" (Ident x)));
test_case!("v : A -> _ + x",
(() (TypeAnnotated (Ident v) ":" (Ident A)) "->"
(TemplateFunction 1 (OprApp (Wildcard 0) (Ok "+") (Ident x)))));
}
#[test]
fn suspended_default_arguments_in_pattern() {
test!("case self of\n Vector_2d ... -> x",
(CaseOf (Ident self)
#(((() (App (Ident Vector_2d) (SuspendedDefaultArguments)) "->" (Ident x))))))
}
#[test]
fn suspended_default_arguments_in_expression() {
test_block!("c = self.value ...",
,(Assignment::new("c", sexp![
(App (OprApp (Ident self) (Ok ".") (Ident value)) (SuspendedDefaultArguments))])));
test_block!("c = self.value...",
,(Assignment::new("c", sexp![
(App (OprApp (Ident self) (Ok ".") (Ident value)) (SuspendedDefaultArguments))])));
}
// === Private (project-private) keyword ===
#[test]
fn private_keyword() {
test!("private", (Private private));
expect_invalid_node("private func");
// Private binding is not supported.
expect_invalid_node("main =\n private var = 42");
// Private function is not allowed in body block.
expect_invalid_node("main =\n private func x = 42");
expect_invalid_node("private ConstructorOutsideType");
expect_invalid_node("type My_Type\n private");
expect_invalid_node("private type My_Type\n Ctor");
}
#[test]
fn private_methods() {
test!("private method x = x",
,(Function::new("method", sexp![(Ident x)]).private().with_arg("x")));
test!("private method =\n 42",
,(Function::new("method", block![(Number () "42" ())]).private()));
test!("type T\n private method x = x",
(TypeDef T #() #(
,(Function::new("method", sexp![(Ident x)]).private().with_arg("x")))));
}
#[test]
#[ignore]
fn private_is_first_statement() {
// Comments and empty lines are allowed before `private`.
#[rustfmt::skip]
let lines = [
"# Some comment",
"# Other comment",
"",
"private"
];
test(lines.join("\n"), block![()()()(Private)]);
#[rustfmt::skip]
let lines = [
"type T",
"",
"private"
];
expect_invalid_node(&lines.join("\n"));
}
// === Array/tuple literals ===
#[test]
fn array_literals() {
let cases = [
("[]", block![(Array () #())]),
("[x]", block![(Array (Ident x) #())]),
("[x, y]", block![(Array (Ident x) #(("," (Ident y))))]),
("[x, y, z]", block![(Array (Ident x) #(("," (Ident y)) ("," (Ident z))))]),
("[ x , y ]", block![(Array (Ident x) #(("," (Ident y))))]),
("[ x , y , z ]", block![(Array (Ident x) #(("," (Ident y)) ("," (Ident z))))]),
];
cases.into_iter().for_each(|(code, expected)| test(code, expected));
}
#[test]
fn tuple_literals() {
let cases = [
("{}", block![(Tuple () #())]),
("{x}", block![(Tuple (Ident x) #())]),
("{x, y}", block![(Tuple (Ident x) #(("," (Ident y))))]),
];
cases.into_iter().for_each(|(code, expected)| test(code, expected));
}
// === Numeric literals ===
#[cfg(test)]
mod numbers {
use super::*;
#[test]
fn with_decimal() {
test_block!("pi = 3.14", ,(Assignment::new("pi", sexp![(Number () "3" ("." "14"))])));
}
#[test]
fn digits_spaced_dot() {
test!("1 . 0", (OprApp (Number () "1" ()) (Ok ".") (Number () "0" ())));
test!("1 .0",
(App (Number () "1" ()) (OprSectionBoundary 1 (OprApp () (Ok ".") (Number () "0" ())))));
test!("1. 0",
(OprSectionBoundary 1 (App (OprApp (Number () "1" ()) (Ok ".") ()) (Number () "0" ()))));
}
#[test]
fn non_digits_dot_digits() {
test!("x.0", (OprApp (Ident x) (Ok ".") (Number () "0" ())));
}
#[test]
fn digits_dot_non_digits() {
test!("0.0.x", (OprApp (Number () "0" ("." "0")) (Ok ".") (Ident x)));
test!("1.0.0", (OprApp (Number () "1" ("." "0")) (Ok ".") (Number () "0" ())));
test!("1.0x", (OprApp (Number () "1" ()) (Ok ".") (Number "0x" () ())));
test!("876543.is_even.should_be_false",
(OprApp
(OprApp (Number () "876543" ()) (Ok ".") (Ident is_even))
(Ok ".")
(Ident should_be_false)));
}
#[test]
fn with_base() {
test!("0b10101010", (Number "0b" "10101010" ()));
test!("0o122137", (Number "0o" "122137" ()));
test!("0xAE2F14", (Number "0x" "AE2F14" ()));
}
#[test]
fn base_only() {
test!("0x", (Number "0x" () ()));
test!("0b", (Number "0b" () ()));
test!("0o", (Number "0o" () ()));
}
#[test]
fn delimited() {
test!("100_000", (Number () "100_000" ()));
test!("10_000.99", (Number () "10_000" ("." "99")));
}
#[test]
fn old_hex() {
expect_invalid_node("16_17ffffffffffffffa");
}
}
// === Whitespace ===
#[test]
fn trailing_whitespace() {
test!("a ", (Ident a) ());
test!("a \n", (Ident a) ());
test!("a = \n x", ,(Function::new("a", block![(Ident x)])));
}
// === Annotations ===
#[test]
fn at_operator() {
expect_invalid_node("foo@bar");
expect_invalid_node("foo @ bar");
}
#[test]
fn annotations() {
test!("@on_problems P.g\nselect_columns : Text -> Table\nselect_columns text = to_table text",
,(Function::new("select_columns", sexp![(App (Ident to_table) (Ident text))])
.with_annotation("on_problems", sexp![(OprApp (Ident P) (Ok ".") (Ident g))])
.with_sig(sexp![(OprApp (Ident Text) (Ok "->") (Ident Table))])
.with_arg("text")));
test!("@a\n@b 1 + 1\nf x = x",
,(Function::new("f", sexp![(Ident x)])
.with_annotation("a", sexp![()])
.with_annotation("b", sexp![(OprApp (Number () "1" ()) (Ok "+") (Number () "1" ()))])
.with_arg("x")));
}
#[test]
fn annotations_on_type_methods() {
test!("type A\n @a z\n @b\n x y = x",
(TypeDef A #() #(
,(Function::new("x", sexp![(Ident x)])
.with_annotation("a", sexp![(Ident z)])
.with_annotation("b", sexp![()])
.with_arg("y")))));
}
#[test]
fn annotations_on_type_constructors() {
test!("type A\n @a z\n @b\n Baz x",
(TypeDef A #() #(
,(Constructor::new("Baz")
.with_annotation("a", sexp![(Ident z)])
.with_annotation("b", sexp![()])
.with_arg("x")))));
}
#[test]
fn inline_builtin_annotations() {
test!("@Tail_Call go t", (AnnotatedBuiltin Tail_Call #() (App (Ident go) (Ident t))));
test!("@Tail_Call go (x = y)",
(AnnotatedBuiltin Tail_Call #() (NamedApp (Ident go) x (Ident y))));
test!("@Tail_Call go\n a\n b",
(AnnotatedBuiltin Tail_Call #()
(ArgumentBlockApplication (Ident go) #((Ident a) (Ident b)))));
test!("map _-> @Tail_Call f",
(App (Ident map)
(OprApp (Wildcard 0) (Ok "->") (AnnotatedBuiltin Tail_Call #() (Ident f)))));
}
#[test]
fn multiline_builtin_annotations() {
test!("@Builtin_Type\ntype Date",
(AnnotatedBuiltin Builtin_Type #(()) (TypeDef Date #() #())));
}
// === SKIP and FREEZE ===
#[test]
fn freeze() {
test!("FREEZE x", (MultiSegmentApp #(((Ident FREEZE) (Ident x)))));
test!("FREEZE x + y", (MultiSegmentApp
#(((Ident FREEZE) (OprApp (Ident x) (Ok "+") (Ident y))))));
test!("FREEZE x.f", (MultiSegmentApp
#(((Ident FREEZE) (OprApp (Ident x) (Ok ".") (Ident f))))));
test!("FREEZE x.f y", (MultiSegmentApp #(((Ident FREEZE)
(App (OprApp (Ident x) (Ok ".") (Ident f)) (Ident y))))));
}
#[test]
fn skip() {
test!("SKIP x", (MultiSegmentApp #(((Ident SKIP) (Ident x)))));
test!("SKIP x + y", (MultiSegmentApp #(((Ident SKIP) (OprApp (Ident x) (Ok "+") (Ident y))))));
test!("SKIP x.f", (MultiSegmentApp #(((Ident SKIP) (OprApp (Ident x) (Ok ".") (Ident f))))));
test!("SKIP x.f y", (MultiSegmentApp #(((Ident SKIP)
(App (OprApp (Ident x) (Ok ".") (Ident f)) (Ident y))))));
}
// === Context errors ===
#[test]
fn statement_in_expression_context() {
test_block!("x = y = z", ,(Assignment::new("x", sexp![(Invalid)])));
test!("(y = z)", (Group(Invalid)));
test!("(y = z) x", (App (Group (Invalid)) (Ident x)));
test_block!("(f x = x)", (Group(Invalid)));
test_block!("y = f x = x", ,(Assignment::new("y", sexp![(Invalid)])));
}
// =========================
// === Scalability Tests ===
// =========================
/// Test an input that caused a stack overflow in a version of the parser that used recursion to
/// resolve macro segments.
#[test]
fn big_array() {
let mut big_array = "[".to_owned();
// This value was chosen to be large enough to cause a stack overflow, but not so large that it
// would take a long time to do so.
let array_length = 1000;
for _ in 0..array_length {
big_array.push_str(
r#"[{"index":{"value":1},"size":{"value":8}},"6063e6d3-3341-40f4-b4fb-7e986eb31ae8"],"#,
);
}
big_array.push_str("1]");
expect_valid(&big_array);
}
// ==========================
// === Syntax Error Tests ===
// ==========================
#[test]
fn space_required() {
expect_invalid_node("foo = if cond.x else.y");
}
#[test]
fn incomplete_type_definition() {
expect_invalid_node("type");
}
#[test]
fn bad_case() {
expect_invalid_node("foo = case x of\n 4");
expect_invalid_node("foo = case x of\n 4 ->");
expect_invalid_node("foo = case x of\n 4->");
}
#[test]
fn malformed_sequence() {
expect_invalid_node("(1, )");
expect_invalid_node("foo = (1, )");
}
#[test]
fn unmatched_delimiter() {
expect_invalid_node("(");
expect_invalid_node(")");
expect_invalid_node("[");
expect_invalid_node("]");
expect_invalid_node("foo = (");
expect_invalid_node("foo = )");
expect_invalid_node("foo = [");
expect_invalid_node("foo = ]");
}
#[test]
fn unexpected_special_operator() {
expect_invalid_node("foo = 1, 2");
}
#[test]
fn malformed_import() {
expect_invalid_node("import");
expect_invalid_node("import as Foo");
expect_invalid_node("import Foo as Foo, Bar");
expect_invalid_node("import Foo as Foo.Bar");
expect_invalid_node("import Foo as");
expect_invalid_node("import Foo as Bar.Baz");
expect_invalid_node("import Foo hiding");
expect_invalid_node("import Foo hiding X,");
expect_invalid_node("polyglot import Foo");
expect_invalid_node("polyglot java import");
expect_invalid_node("from import all");
expect_invalid_node("from Foo import all hiding");
expect_invalid_node("from Foo import all hiding X.Y");
expect_invalid_node("export");
expect_invalid_node("export as Foo");
expect_invalid_node("export Foo as Foo, Bar");
expect_invalid_node("export Foo as Foo.Bar");
expect_invalid_node("export Foo as");
expect_invalid_node("export Foo as Bar.Baz");
expect_invalid_node("export Foo hiding");
expect_invalid_node("export Foo hiding X,");
expect_invalid_node("from export all");
expect_invalid_node("from Foo export all hiding");
expect_invalid_node("from Foo export all hiding X.Y");
}
#[test]
fn invalid_token() {
expect_invalid_node("`");
expect_invalid_node("splice_outside_text = `");
}
#[test]
fn illegal_foreign_body() {
// Foreign is only a keyword on the LHS of an assignment operator.
test!("foreign 4", (App (Ident foreign) (Number () "4" ())));
// Missing name
expect_invalid_node("foreign foo = \"4\"");
// Body must be a type
expect_invalid_node("foreign js foo = 4");
}
#[test]
fn unexpected_tokens_in_inner_macro_segment() {
expect_invalid_node("from Foo import all What_Is_This_Doing_Here hiding Bar");
}
#[test]
fn invalid_unspaced_operator_sequence() {
// Typically, a sequence of operator identifiers is lexed as a single operator. However, an
// exception is made for some sequences of operator characters ending in the `-` character: An
// expression such as `x+-x` is accepted, and read equivalently to `x + -x` (see
// [`unspaced_operator_sequence`]).
//
// Due to this special case, there is no reasonable way to interpret this type of expression as
// valid when spaces are added in the following way:
expect_invalid_node("x = y +- z");
expect_multiple_operator_error("x =- y");
//
// Treating the `-` as a unary operator applied to `z` would be confusing, as it would be in
// contradiction to the associativity implied by the whitespace rules.
//
// However, it would also be confusing to lex a sequence of characters like `+-` as a single
// operator in spaced expressions, but as two operators in unspaced expressions.
//
// Lacking any reasonable valid interpretation, we treat this case as an error.
//
// Similar expressions with missing operands should be treated likewise:
expect_invalid_node("x = y +-");
expect_invalid_node("x = +- z");
expect_multiple_operator_error("x =-");
expect_multiple_operator_error("=- y");
expect_multiple_operator_error("=-");
}
#[test]
fn nonsense_inputs() {
expect_invalid_node("`a (b = 1).`");
expect_invalid_node("type M = B<d f<'a> F(M<'a>) -> S>;");
expect_invalid_node("'`'\nx `y`\nz");
expect_invalid_node("if (asGuestValue\n a");
expect_invalid_node("foo(\n a");
expect_invalid_node("(Vector(), true)");
}
#[test]
#[ignore]
fn nonsense_inputs_broken() {
// FIXME
expect_invalid_node("'`\n");
expect_invalid_node(".'\\\n");
}
// ====================
// === Test Support ===
// ====================
// === Testing helpers ===
/// Check that the given [`Tree`] is a valid representation of the given source code:
/// - Assert that the given [`Tree`] is composed of tokens that concatenate back to the given source
/// code.
/// - Assert that the given [`Tree`] can be serialized and deserialized without error.
fn expect_tree_representing_code(code: &str, ast: &enso_parser::syntax::Tree) {
assert_eq!(ast.code(), code, "{:?}", &ast);
let serialized = enso_parser::serialization::serialize_tree(ast).unwrap();
let deserialized = enso_parser::serialization::deserialize_tree(&serialized);
deserialized.unwrap();
}
// === Testing valid inputs ===
/// Given a block of input Enso code, test that:
/// - The given code parses to the AST represented by the given S-expression.
/// - The AST pretty-prints back to the original code.
/// - Rust's deserialization is compatible with Rust's serialization for the type. (The Java format
/// tests check Java's deserialization against Rust's deserialization).
///
/// The S-expression format is as documented for [`enso_metamodel_lexpr`], with some
/// postprocessing:
/// - For concision, field names are stripped (as if all structs were tuple structs).
/// - Most token types are represented as their contents, rather than as a token struct. For
/// example, a `token::Number` may be represented like: `sexp![10]`, and a `token::Ident` may look
/// like `sexp![foo]`.
fn test<T: AsRef<str>>(code: T, expect: lexpr::Value) {
let code = code.as_ref();
let ast = parse(code);
let ast_s_expr = to_s_expr(&ast, code);
assert_eq!(ast_s_expr.to_string(), expect.to_string(), "{:?}", &ast);
expect_tree_representing_code(code, &ast);
}
fn test_block<T: AsRef<str>>(code: T, expect: lexpr::Value) {
let code = code.as_ref();
let ast = parse_block(code);
let ast_s_expr = to_s_expr(&ast, code);
assert_eq!(ast_s_expr.to_string(), expect.to_string(), "{:?}", &ast);
expect_tree_representing_code(code, &ast);
}
fn parse(code: &str) -> enso_parser::syntax::tree::Tree {
let ast = enso_parser::Parser::new().parse_module(code);
validate_parse(code, &ast);
ast
}
fn parse_block(code: &str) -> enso_parser::syntax::tree::Tree {
let ast = enso_parser::Parser::new().parse_block(code);
validate_parse(code, &ast);
ast
}
fn validate_parse(code: &str, ast: &enso_parser::syntax::Tree) {
let expected_span = 0..(code.encode_utf16().count() as u32);
let mut locations = enso_parser::source::code::debug::LocationCheck::new();
enso_parser_debug::validate_spans(ast, expected_span, &mut locations).unwrap();
locations.check(code);
}
// === Testing inputs containing syntax errors ===
#[derive(Debug, Eq, PartialEq, Default, Copy, Clone)]
struct Errors {
invalid_node: bool,
multiple_operator: bool,
}
impl Errors {
fn collect(ast: &enso_parser::syntax::Tree, code: &str) -> Self {
expect_tree_representing_code(code, ast);
let errors = core::cell::Cell::new(Errors::default());
ast.visit_trees(|tree| match &tree.variant {
enso_parser::syntax::tree::Variant::Invalid(_) => {
errors.set(Self { invalid_node: true, ..errors.get() });
}
enso_parser::syntax::tree::Variant::OprApp(opr_app) if opr_app.opr.is_err() => {
errors.set(Self { multiple_operator: true, ..errors.get() });
}
_ => (),
});
errors.into_inner()
}
}
/// Checks that an input contains an `Invalid` node somewhere.
fn expect_invalid_node(code: &str) {
let ast = enso_parser::Parser::new().parse_module(code);
expect_tree_representing_code(code, &ast);
let errors = Errors::collect(&ast, code);
assert!(errors.invalid_node, "{}", to_s_expr(&ast, code));
}
/// Checks that an input contains a multiple-operator error somewhere.
fn expect_multiple_operator_error(code: &str) {
let ast = enso_parser::Parser::new().parse_module(code);
expect_tree_representing_code(code, &ast);
let errors = Errors::collect(&ast, code);
assert!(errors.multiple_operator || errors.invalid_node, "{}", to_s_expr(&ast, code));
assert!(errors.multiple_operator, "{:?}", ast);
}
/// Check that the input can be parsed, and doesn't yield any `Invalid` nodes.
fn expect_valid(code: &str) {
let ast = enso_parser::Parser::new().parse_module(code);
expect_tree_representing_code(code, &ast);
let errors = Errors::collect(&ast, code);
assert!(!errors.invalid_node);
}
// =========================
// === Test case helpers ===
// =========================
// === Functions ===
/// Builder for function definitions.
struct Function {
docs: lexpr::Value,
annotations: Vec<lexpr::Value>,
signature: lexpr::Value,
private: lexpr::Value,
name: lexpr::Value,
args: Vec<lexpr::Value>,
body: lexpr::Value,
ret: lexpr::Value,
}
impl Function {
fn new(name: &str, body: lexpr::Value) -> Self {
let name = lexpr::Value::symbol(name);
Self::named(sexp![(Ident, name)], body)
}
fn named(name: lexpr::Value, body: lexpr::Value) -> Self {
Self {
docs: sexp![()],
annotations: vec![],
signature: sexp![()],
private: sexp![()],
name,
args: vec![],
body,
ret: sexp![()],
}
}
#[rustfmt::skip]
fn with_docs(self, docs: lexpr::Value) -> Self {
Self { docs, ..self }
}
#[rustfmt::skip]
fn with_annotation(mut self, annotation: &str, arg: lexpr::Value) -> Self {
let annotation = lexpr::Value::symbol(annotation);
self.annotations.push(sexp![((,annotation ,arg) #(()))]);
self
}
#[rustfmt::skip]
fn with_sig(self, signature: lexpr::Value) -> Self {
let name = self.name.clone();
Self { signature: sexp![(,name ":" ,signature)], ..self }
}
fn with_arg(mut self, arg: impl Into<Arg>) -> Self {
self.args.push(arg.into().into());
self
}
fn with_return(self, ret: lexpr::Value) -> Self {
Self { ret: sexp![("->", ret)], ..self }
}
fn private(self) -> Self {
Self { private: sexp![private], ..self }
}
}
impl From<Function> for lexpr::Value {
#[rustfmt::skip]
fn from(Function { docs, annotations, signature, private, name, args, ret, body }: Function) -> Self {
sexp![(Function ,docs ,annotations ,signature ,private ,name ,args ,ret ,body)]
}
}
struct Arg(lexpr::Value);
impl From<&str> for Arg {
fn from(name: &str) -> Self {
let name = lexpr::Value::symbol(name);
Self(sexp![(()(Ident, name)()())])
}
}
impl From<lexpr::Value> for Arg {
fn from(arg: lexpr::Value) -> Self {
Self(arg)
}
}
impl From<Arg> for lexpr::Value {
fn from(Arg(arg): Arg) -> Self {
arg
}
}
// === Constructors ===
/// Builder for type constructor definitions.
struct Constructor {
docs: lexpr::Value,
annotations: Vec<lexpr::Value>,
private: lexpr::Value,
name: lexpr::Value,
args: Vec<lexpr::Value>,
arg_lines: Vec<lexpr::Value>,
}
impl Constructor {
fn new(name: &str) -> Self {
Self {
docs: sexp![()],
annotations: vec![],
private: sexp![()],
name: lexpr::Value::symbol(name),
args: vec![],
arg_lines: vec![],
}
}
#[rustfmt::skip]
fn with_docs(self, docs: lexpr::Value) -> Self {
Self { docs, ..self }
}
#[rustfmt::skip]
fn with_annotation(mut self, annotation: &str, arg: lexpr::Value) -> Self {
let annotation = lexpr::Value::symbol(annotation);
self.annotations.push(sexp![((,annotation ,arg) #(()))]);
self
}
fn with_arg(mut self, arg: impl Into<Arg>) -> Self {
self.args.push(arg.into().into());
self
}
fn with_arg_line(mut self, arg: impl Into<Arg>) -> Self {
let arg = arg.into();
self.arg_lines.push(sexp![(,arg)]);
self
}
fn private(self) -> Self {
Self { private: sexp![private], ..self }
}
}
impl From<Constructor> for lexpr::Value {
#[rustfmt::skip]
fn from(Constructor { docs, annotations, private, name, args, arg_lines }: Constructor) -> Self {
sexp![(ConstructorDefinition ,docs ,annotations ,private ,name ,args, arg_lines)]
}
}
// === Assignments ===
/// Builder for variable assignments.
struct Assignment {
docs: lexpr::Value,
pattern: lexpr::Value,
value: lexpr::Value,
}
impl Assignment {
fn new(name: &str, body: lexpr::Value) -> Self {
let name = lexpr::Value::symbol(name);
Self::pattern(sexp![(Ident, name)], body)
}
fn pattern(pattern: lexpr::Value, value: lexpr::Value) -> Self {
Self { docs: sexp![()], pattern, value }
}
#[rustfmt::skip]
fn with_docs(self, docs: lexpr::Value) -> Self {
Self { docs, ..self }
}
}
impl From<Assignment> for lexpr::Value {
#[rustfmt::skip]
fn from(Assignment { docs, pattern, value }: Assignment) -> Self {
sexp![(Assignment ,docs ,pattern ,value)]
}
}