mago-syntax 1.30.0

A correct, fast, and memory-efficient PHP syntax implementation, including Lexer, Parser, AST, and utilities for Mago.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Fixture-based parser tests.

mod runner {
    use std::borrow::Cow;

    use bumpalo::Bump;

    use mago_database::file::File;
    use mago_syntax::parser::parse_file;

    pub fn parse_file_test(name: &'static str, code: &'static str, expected_errors: usize) {
        let arena = Bump::new();
        let file = File::ephemeral(Cow::Borrowed(name.as_bytes()), Cow::Borrowed(code.as_bytes()));
        let program = parse_file(&arena, &file);
        let actual = program.errors.len();
        if actual != expected_errors {
            panic!(
                "Test case '{name}' expected {expected_errors} parse error(s), got {actual}.\nErrors: {:#?}",
                program.errors,
            );
        }
    }
}

/// Generates a test that parses `tests/fixtures/<name>.php` and asserts the
/// resulting parse-error count matches `$expected_errors`.
///
/// - `test_parsing!(file_name, 0)` - file must parse with no errors.
/// - `test_parsing!(file_name, N)` - file must produce exactly N errors.
macro_rules! test_parsing {
    ($name:ident, $expected_errors:expr) => {
        #[test]
        fn $name() {
            let content = include_str!(concat!("fixtures/", stringify!($name), ".php"));
            crate::runner::parse_file_test(stringify!($name), content, $expected_errors);
        }
    };
}

test_parsing!(hello_world, 0);

// Fixtures lifted from nikic/PHP-Parser's test/code/parser/. Each one is
// invalid PHP at the syntax level (verified with `php -l`); the assertion is
// that mago keeps rejecting them. If a count drifts after a parser change,
// triage whether the new behavior is correct before bumping the number.
test_parsing!(error_handling_eof_error, 1);
test_parsing!(error_handling_lexer_errors, 1);
test_parsing!(error_handling_recovery, 3);
test_parsing!(expr_alternative_array_syntax, 22);
test_parsing!(expr_fetch_and_call_args, 5);
test_parsing!(expr_first_class_callables, 6);
test_parsing!(expr_new_without_class, 2);
test_parsing!(expr_uvs_global_non_simple_var_error, 3);
test_parsing!(scalar_encapsed_neg_var_offset, 6);
test_parsing!(scalar_float, 1);
test_parsing!(scalar_int, 14);
test_parsing!(scalar_invalid_octal, 1);
test_parsing!(scalar_number_separators, 8);
test_parsing!(stmt_class_short_echo_as_identifier, 8);
test_parsing!(stmt_halt_compiler_invalid_syntax, 1);
test_parsing!(stmt_halt_compiler_outermost_scope, 1);
test_parsing!(stmt_namespace_group_use_errors, 1);