backyard-parser 0.1.10

Parse PHP code to AST node.
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
use std::{ collections::HashSet, fmt::Debug };

use bumpalo::{ vec, collections::Vec, Bump };
use backyard_lexer::token::{ Token, TokenType };
use backyard_nodes::{ Location, Node, NodeType, RangeLocation };
use crate::{
  error::ParserError,
  internal::{
    attribute::AttributeParser,
    block::BlockParser,
    echo::EchoParser,
    globals::GlobalParser,
    statics::StaticsParser,
  },
  utils::LookupResult,
};

use super::internal::{
  array::ArrayParser,
  arraylookup::ArrayLookupParser,
  assignment::AssignmentParser,
  bin::BinParser,
  call::CallParser,
  class::ClassParser,
  comment::CommentParser,
  consts::ConstParser,
  declare::DeclareParser,
  dowhile::DoWhileParser,
  enums::EnumParser,
  eval::EvalParser,
  exit::ExitParser,
  foreach::ForeachParser,
  fors::ForParser,
  function::FunctionParser,
  identifier::IdentifierParser,
  ifs::IfParser,
  include::IncludeParser,
  interface::InterfaceParser,
  label::LabelParser,
  list::ListParser,
  magic::MagicParser,
  matchs::MatchParser,
  namespace::NamespaceParser,
  number::NumberParser,
  objectaccess::ObjectAccessParser,
  parenthesis::ParenthesisParser,
  post::PostParser,
  pre::PreParser,
  singles::SinglesParser,
  staticlookup::StaticLookupParser,
  string::StringParser,
  switch::SwitchParser,
  ternary::TernaryParser,
  traits::TraitParser,
  tries::TryParser,
  uses::UseParser,
  variable::VariableParser,
  whiles::WhileParser,
  yields::YieldParser,
};

type InternalParserTest = for<'arena, 'a> fn(
  parser: &mut Parser<'arena, 'a>,
  args: &mut LoopArgument
) -> Option<std::vec::Vec<LookupResult<'arena>>>;
type InternalParserParse = for<'arena, 'a, 'b> fn(
  parser: &mut Parser<'arena, 'a>,
  matched: std::vec::Vec<LookupResult<'arena>>,
  start_loc: Location,
  _: &mut LoopArgument<'arena, 'b>
) -> Result<Node<'arena>, ParserError>;
type InternalParser = (InternalParserTest, InternalParserParse);
pub static DEFAULT_PARSERS: [InternalParser; 46] = [
  (CommentParser::test, CommentParser::parse),
  (ListParser::test, ListParser::parse),
  (ArrayLookupParser::test, ArrayLookupParser::parse),
  (ArrayParser::test, ArrayParser::parse),
  (AssignmentParser::test, AssignmentParser::parse),
  (BinParser::test, BinParser::parse),
  (ObjectAccessParser::test, ObjectAccessParser::parse),
  (DeclareParser::test, DeclareParser::parse),
  (DoWhileParser::test, DoWhileParser::parse),
  (NamespaceParser::test, NamespaceParser::parse),
  (IncludeParser::test, IncludeParser::parse),
  (TryParser::test, TryParser::parse),
  (IfParser::test, IfParser::parse),
  (MatchParser::test, MatchParser::parse),
  (UseParser::test, UseParser::parse),
  (ForParser::test, ForParser::parse),
  (ForeachParser::test, ForeachParser::parse),
  (FunctionParser::test, FunctionParser::parse),
  (CallParser::test, CallParser::parse),
  (ParenthesisParser::test, ParenthesisParser::parse),
  (ClassParser::test, ClassParser::parse),
  (InterfaceParser::test, InterfaceParser::parse),
  (TraitParser::test, TraitParser::parse),
  (EnumParser::test, EnumParser::parse),
  (ConstParser::test, ConstParser::parse),
  (EvalParser::test, EvalParser::parse),
  (ExitParser::test, ExitParser::parse),
  (MagicParser::test, MagicParser::parse),
  (NumberParser::test, NumberParser::parse),
  (PostParser::test, PostParser::parse),
  (PreParser::test, PreParser::parse),
  (StaticLookupParser::test, StaticLookupParser::parse),
  (YieldParser::test, YieldParser::parse),
  (StringParser::test, StringParser::parse),
  (SwitchParser::test, SwitchParser::parse),
  (StaticsParser::test, StaticsParser::parse),
  (GlobalParser::test, GlobalParser::parse),
  (VariableParser::test, VariableParser::parse),
  (TernaryParser::test, TernaryParser::parse),
  (WhileParser::test, WhileParser::parse),
  (LabelParser::test, LabelParser::parse),
  (IdentifierParser::test, IdentifierParser::parse),
  (SinglesParser::test, SinglesParser::parse),
  (EchoParser::test, EchoParser::parse),
  (AttributeParser::test, AttributeParser::parse),
  (BlockParser::test, BlockParser::parse),
];

#[derive(Debug)]
pub struct LoopArgument<'arena, 'a> {
  #[allow(dead_code)]
  pub context: &'a str,
  pub parsers: &'a [InternalParser],
  pub separators: &'a [TokenType],
  pub breakers: &'a [TokenType],
  pub last_expr: Option<Node<'arena>>,
  pub statements: Option<Vec<'arena, Node<'arena>>>,
  pub should_fail: bool,
}

impl<'arena, 'a> LoopArgument<'arena, 'a> {
  pub fn new(
    arena: &'arena Bump,
    context: &'a str,
    separators: &'a [TokenType],
    breakers: &'a [TokenType],
    parsers: &'a [InternalParser]
  ) -> Self {
    LoopArgument {
      context,
      parsers,
      separators,
      breakers,
      last_expr: None,
      statements: Some(vec![in arena]),
      should_fail: true,
    }
  }

  pub fn safe(
    arena: &'arena Bump,
    context: &'a str,
    separators: &'a [TokenType],
    breakers: &'a [TokenType],
    parsers: &'a [InternalParser]
  ) -> Self {
    LoopArgument {
      context,
      parsers,
      separators,
      breakers,
      last_expr: None,
      statements: Some(vec![in arena]),
      should_fail: false,
    }
  }

  pub fn default(arena: &'arena Bump, context: &'a str) -> Self {
    LoopArgument {
      context,
      parsers: &DEFAULT_PARSERS,
      separators: &[TokenType::Semicolon],
      breakers: &[TokenType::RightCurlyBracket],
      last_expr: None,
      statements: Some(vec![in arena]),
      should_fail: true,
    }
  }

  pub fn with_tokens(
    arena: &'arena Bump,
    context: &'a str,
    separators: &'a [TokenType],
    breakers: &'a [TokenType]
  ) -> Self {
    LoopArgument {
      context,
      parsers: &DEFAULT_PARSERS,
      separators,
      breakers,
      last_expr: None,
      statements: Some(vec![in arena]),
      should_fail: true,
    }
  }
}

pub struct Parser<'arena, 'a> {
  pub arena: &'arena Bump,
  pub tokens: &'a [Token],
  pub position: usize,
}

impl<'arena, 'a> Parser<'arena, 'a> {
  pub fn new(arena: &'arena Bump, tokens: &'a [Token]) -> Self {
    Parser {
      arena,
      tokens,
      position: 0,
    }
  }

  #[inline]
  pub fn get_token(&self, index: usize) -> Result<&Token, ParserError> {
    self.tokens.get(index).ok_or(ParserError::Eof)
  }

  pub fn get_children<'b>(
    &mut self,
    args: &mut LoopArgument<'arena, 'b>
  ) -> Result<Vec<'arena, Node<'arena>>, ParserError> {
    while let Some(token) = self.tokens.get(self.position) {
      if args.breakers.contains(&token.token_type) {
        self.position += 1;
        break;
      }
      if args.separators.contains(&token.token_type) {
        self.position += 1;
        continue;
      }
      let statement = self.get_statement(args);
      if statement.is_err() {
        return Err(statement.err().unwrap());
      }
      if let Some(statement) = statement.unwrap() {
        args.statements.as_mut().unwrap().push(statement);
      } else {
        break;
      }
    }
    Ok(args.statements.take().unwrap())
  }

  pub fn get_statement<'b>(
    &mut self,
    args: &mut LoopArgument<'arena, 'b>
  ) -> Result<Option<Node<'arena>>, ParserError> {
    while let Some(token) = self.tokens.get(self.position) {
      // println!("");
      // println!("context: {:?}", args.context);
      // println!("token: {:?}", token);
      // println!("last_expr: {:?}", args.last_expr);

      if
        args.separators.contains(&token.token_type) ||
        args.breakers.contains(&token.token_type) ||
        (token.token_type == TokenType::Inline && args.last_expr.is_some())
      {
        break;
      }
      match self.find_match(args) {
        Ok(n) => {
          if n.is_none() {
            break;
          }
          let n = n.unwrap();
          let force_end_statement = [
            NodeType::Declare,
            NodeType::Namespace,
            NodeType::Function,
            NodeType::AnonymousFunction,
            NodeType::ArrowFunction,
            NodeType::Class,
            NodeType::Interface,
            NodeType::Trait,
            NodeType::Enum,
            NodeType::Property,
            NodeType::Method,
            NodeType::TraitUse,
            NodeType::Foreach,
            NodeType::For,
            NodeType::While,
            NodeType::DoWhile,
            NodeType::Match,
            NodeType::MatchArm,
            NodeType::If,
            NodeType::Switch,
            NodeType::Case,
            NodeType::Label,
            NodeType::Try,
            NodeType::Catch,
            NodeType::Finally,
            NodeType::CommentLine,
            NodeType::CommentBlock,
            NodeType::Inline,
            NodeType::Program,
            NodeType::PropertyHook,
          ].contains(&n.node_type);
          args.last_expr = Some(n);
          if force_end_statement {
            break;
          }
        }
        Err(e) => {
          args.last_expr = None;
          return Err(e);
        }
      }
    }

    Ok(args.last_expr.take())
  }

  #[inline]
  pub fn find_match<'b>(
    &mut self,
    args: &mut LoopArgument<'arena, 'b>
  ) -> Result<Option<Node<'arena>>, ParserError> {
    for (test, parse) in args.parsers {
      if let Some(matched) = test(self, args) {
        if let Some(start_loc) = self.tokens.get(self.position).map(|x| x.get_location().unwrap()) {
          self.position += matched
            .iter()
            .map(|x| x.size)
            .sum::<usize>();
          if let Ok(parsed) = parse(self, matched, start_loc, args) {
            return Ok(Some(parsed));
          } else {
            break;
          }
        } else {
          return Err(ParserError::Eof);
        }
      }
    }
    if args.should_fail {
      if let Some(token) = self.tokens.get(self.position) {
        Err(ParserError::UnexpectedToken(token.to_owned()))
      } else {
        Err(ParserError::Eof)
      }
    } else {
      Ok(None)
    }
  }

  pub fn gen_loc(&self, start: Location) -> Option<RangeLocation> {
    let end = self.tokens.get(self.position - 1);
    end.and_then(|x| x.get_location()).map(|end| RangeLocation { start, end })
  }
}

pub trait LocationHelper {
  fn get_location(&self) -> Option<Location>;
  fn get_range_location(&self) -> Option<RangeLocation>;
}

impl<'a> LocationHelper for &Node<'a> {
  #[inline]
  fn get_location(&self) -> Option<Location> {
    self.loc.as_ref().map(|loc| loc.start.clone())
  }

  #[inline]
  fn get_range_location(&self) -> Option<RangeLocation> {
    self.loc.clone()
  }
}

impl LocationHelper for &Token {
  #[inline]
  fn get_location(&self) -> Option<Location> {
    Some(Location { line: self.line, column: self.column, offset: self.offset })
  }

  fn get_range_location(&self) -> Option<RangeLocation> {
    if let Some(start_loc) = self.get_location() {
      let len = self.value.len() as u32;
      let end_loc = Location {
        line: start_loc.line,
        column: start_loc.column + len,
        offset: start_loc.offset + len,
      };
      Some(RangeLocation {
        start: start_loc,
        end: end_loc,
      })
    } else {
      None
    }
  }
}

pub trait TokenTypeArrayCombine {
  fn combine(self, tokens: &[TokenType]) -> std::vec::Vec<TokenType>;
}

impl TokenTypeArrayCombine for &[TokenType] {
  fn combine(self, tokens: &[TokenType]) -> std::vec::Vec<TokenType> {
    let combined: std::vec::Vec<TokenType> = [self, tokens].concat();
    let unique: HashSet<_> = combined.into_iter().collect();
    unique.into_iter().collect()
  }
}

pub trait OptionNodeOrInternal<'arena> {
  fn ok_internal(self) -> Result<Node<'arena>, ParserError>;
}

impl<'arena> OptionNodeOrInternal<'arena> for Option<Node<'arena>> {
  #[inline]
  fn ok_internal(self) -> Result<Node<'arena>, ParserError> {
    self.ok_or(ParserError::Internal)
  }
}