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

use serde::Serialize;
use strum::Display;

use mago_span::HasSpan;
use mago_span::Span;

use crate::ast::ast::tag::ClosingTag;
use crate::ast::ast::tag::OpeningTag;

/// A statement terminator.
///
/// A PHP statement can be terminated with a semicolon `;` or a closing tag `?>`.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash, Serialize, PartialOrd, Ord, Display)]
#[serde(tag = "type", content = "value")]
pub enum Terminator<'arena> {
    /// A semicolon.
    Semicolon(Span),
    /// A closing tag.
    ClosingTag(ClosingTag),
    /// A closing tag followed immediately by an opening tag.
    TagPair(ClosingTag, OpeningTag<'arena>),
    /// Missing terminator.
    #[strum(disabled)]
    Missing(Span),
}

impl Terminator<'_> {
    #[must_use]
    #[inline]
    pub const fn is_semicolon(&self) -> bool {
        matches!(self, Terminator::Semicolon(_))
    }

    #[must_use]
    #[inline]
    pub const fn is_closing_tag(&self) -> bool {
        matches!(self, Terminator::ClosingTag(_))
    }
}

impl HasSpan for Terminator<'_> {
    fn span(&self) -> Span {
        match self {
            Terminator::Semicolon(s) => *s,
            Terminator::ClosingTag(t) => t.span(),
            Terminator::TagPair(c, o) => c.span().join(o.span()),
            Terminator::Missing(s) => *s,
        }
    }
}