mago-syntax 1.20.1

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

#![expect(clippy::module_inception)]

use std::fmt::Debug;

use bumpalo::collections::Vec;
use serde::Serialize;

use mago_database::file::FileId;
use mago_span::HasSpan;
use mago_span::Position;
use mago_span::Span;

pub use crate::ast::ast::*;
pub use crate::ast::node::*;
pub use crate::ast::sequence::Sequence;
pub use crate::ast::trivia::Trivia;
pub use crate::ast::trivia::TriviaKind;
use crate::error::ParseError;

pub mod ast;
pub mod node;
pub mod sequence;
pub mod trivia;

#[derive(Debug, Clone, Eq, PartialEq, Hash, Serialize, PartialOrd, Ord)]
pub struct Program<'arena> {
    pub file_id: FileId,
    pub source_text: &'arena str,
    pub trivia: Sequence<'arena, Trivia<'arena>>,
    pub statements: Sequence<'arena, Statement<'arena>>,
    pub errors: Vec<'arena, ParseError>,
}

impl Program<'_> {
    /// Returns `true` if the program contains any parsing errors.
    #[inline]
    pub fn has_errors(&self) -> bool {
        !self.errors.is_empty()
    }

    /// Returns `true` if the program contains any non-inline script statements.
    #[must_use]
    pub fn has_script(&self) -> bool {
        for statement in &self.statements {
            if !matches!(statement, Statement::Inline(_)) {
                return true;
            }
        }

        false
    }
}

impl HasSpan for Program<'_> {
    fn span(&self) -> Span {
        let start = self.statements.first().map_or_else(Position::zero, |stmt| stmt.span().start);
        let end = self.statements.last().map_or_else(Position::zero, |stmt| stmt.span().end);

        Span::new(self.file_id, start, end)
    }
}