boa_ast 0.21.1

Abstract Syntax Tree definition for the Boa JavaScript engine.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! This module contains the ECMAScript representation regular expressions.
//!
//! More information:
//!  - [ECMAScript reference][spec]
//!  - [MDN documentation][mdn]
//!
//! [spec]: https://tc39.es/ecma262/#sec-literals-regular-expression-literals
//! [mdn]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions

use std::ops::ControlFlow;

use boa_interner::{Interner, Sym, ToInternedString};

use crate::{
    Span, Spanned,
    visitor::{VisitWith, Visitor, VisitorMut},
};

use super::Expression;

/// Regular expressions in ECMAScript.
///
/// More information:
///  - [ECMAScript reference][spec]
///  - [MDN documentation][mdn]
///
/// [spec]: https://tc39.es/ecma262/#sec-literals-regular-expression-literals
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RegExpLiteral {
    pattern: Sym,
    flags: Sym,
    span: Span,
}

impl RegExpLiteral {
    /// Create a new [`RegExpLiteral`].
    #[inline]
    #[must_use]
    pub const fn new(pattern: Sym, flags: Sym, span: Span) -> Self {
        Self {
            pattern,
            flags,
            span,
        }
    }

    /// Get the pattern part of the [`RegExpLiteral`].
    #[inline]
    #[must_use]
    pub const fn pattern(&self) -> Sym {
        self.pattern
    }

    /// Get the flags part of the [`RegExpLiteral`].
    #[inline]
    #[must_use]
    pub const fn flags(&self) -> Sym {
        self.flags
    }
}

impl Spanned for RegExpLiteral {
    #[inline]
    fn span(&self) -> Span {
        self.span
    }
}

impl ToInternedString for RegExpLiteral {
    #[inline]
    fn to_interned_string(&self, interner: &Interner) -> String {
        let pattern = interner.resolve_expect(self.pattern);
        let flags = interner.resolve_expect(self.flags);
        format!("/{pattern}/{flags}")
    }
}

impl From<RegExpLiteral> for Expression {
    #[inline]
    fn from(value: RegExpLiteral) -> Self {
        Self::RegExpLiteral(value)
    }
}

impl VisitWith for RegExpLiteral {
    #[inline]
    fn visit_with<'a, V>(&'a self, visitor: &mut V) -> ControlFlow<V::BreakTy>
    where
        V: Visitor<'a>,
    {
        visitor.visit_sym(&self.pattern)?;
        visitor.visit_sym(&self.flags)
    }

    #[inline]
    fn visit_with_mut<'a, V>(&'a mut self, visitor: &mut V) -> ControlFlow<V::BreakTy>
    where
        V: VisitorMut<'a>,
    {
        visitor.visit_sym_mut(&mut self.pattern)?;
        visitor.visit_sym_mut(&mut self.flags)
    }
}