oak 0.8.0

A typed parser generator syntax extension for Parsing Expression Grammar (PEG).
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

// Copyright 2016 Pierre Talbot (IRCAM)

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at

//     http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![macro_use]

use std::default::Default;
use ast::*;
use ast::Expression::*;

pub trait Visitor<R: Default> : ExprByIndex
{
  fn visit_expr(&mut self, this: usize) -> R {
    walk_expr(self, this)
  }

  fn visit_str_literal(&mut self, _this: usize, _lit: String) -> R { R::default() }
  fn visit_non_terminal_symbol(&mut self, _this: usize, _rule: &Ident) -> R { R::default() }
  fn visit_external_non_terminal_symbol(&mut self, _this: usize, _rule: &syn::Path) -> R { R::default() }
  fn visit_atom(&mut self, _this: usize) -> R { R::default() }

  fn visit_any_single_char(&mut self, this: usize) -> R {
    self.visit_atom(this)
  }

  fn visit_character_class(&mut self, this: usize, _char_class: CharacterClassExpr) -> R {
    self.visit_atom(this)
  }

  fn visit_spanned_expr(&mut self, _this: usize, child: usize) -> R {
    self.visit_expr(child)
  }

  fn visit_range_expr(&mut self, _this: usize, child: usize) -> R {
    self.visit_expr(child)
  }

  fn visit_sequence(&mut self, _this: usize, children: Vec<usize>) -> R;
  fn visit_choice(&mut self, _this: usize, children: Vec<usize>) -> R;

  fn visit_repeat(&mut self, _this: usize, child: usize) -> R {
    self.visit_expr(child)
  }

  fn visit_zero_or_more(&mut self, this: usize, child: usize) -> R {
    self.visit_repeat(this, child)
  }

  fn visit_one_or_more(&mut self, this: usize, child: usize) -> R {
    self.visit_repeat(this, child)
  }

  fn visit_optional(&mut self, _this: usize, child: usize) -> R {
    self.visit_expr(child)
  }

  fn visit_syntactic_predicate(&mut self, _this: usize, child: usize) -> R {
    self.visit_expr(child)
  }

  fn visit_not_predicate(&mut self, this: usize, child: usize) -> R {
    self.visit_syntactic_predicate(this, child)
  }

  fn visit_and_predicate(&mut self, this: usize, child: usize) -> R {
    self.visit_syntactic_predicate(this, child)
  }

  fn visit_semantic_action(&mut self, _this: usize, child: usize, _boxed: bool, _action: syn::Expr) -> R {
    self.visit_expr(child)
  }

  fn visit_type_ascription(&mut self, _this: usize, child: usize, _ty: IType) -> R {
    self.visit_expr(child)
  }
}

/// We need this macro for factorizing the code since we can not specialize a trait on specific type parameter (we would need to specialize on `()` here).
macro_rules! unit_visitor_impl {
  (sequence) => (
    fn visit_sequence(&mut self, _this: usize, children: Vec<usize>) -> () {
      walk_exprs(self, children);
    }
  );
  (choice) => (
    fn visit_choice(&mut self, _this: usize, children: Vec<usize>) -> () {
      walk_exprs(self, children);
    }
  );
}

pub fn walk_expr<R: Default, V: ?Sized>(visitor: &mut V, this: usize) -> R where
  V: Visitor<R>
{
  match visitor.expr_by_index(this) {
    StrLiteral(lit) => {
      visitor.visit_str_literal(this, lit)
    }
    AnySingleChar => {
      visitor.visit_any_single_char(this)
    }
    NonTerminalSymbol(rule) => {
      visitor.visit_non_terminal_symbol(this, &rule)
    }
    ExternalNonTerminalSymbol(rule) => {
      visitor.visit_external_non_terminal_symbol(this, &rule)
    }
    Sequence(seq) => {
      visitor.visit_sequence(this, seq)
    }
    Choice(choices) => {
      visitor.visit_choice(this, choices)
    }
    ZeroOrMore(child) => {
      visitor.visit_zero_or_more(this, child)
    }
    OneOrMore(child) => {
      visitor.visit_one_or_more(this, child)
    }
    ZeroOrOne(child) => {
      visitor.visit_optional(this, child)
    }
    NotPredicate(child) => {
      visitor.visit_not_predicate(this, child)
    }
    AndPredicate(child) => {
      visitor.visit_and_predicate(this, child)
    }
    CharacterClass(char_class) => {
      visitor.visit_character_class(this, char_class)
    }
    SemanticAction(child, boxed, action) => {
      visitor.visit_semantic_action(this, child, boxed, action)
    }
    TypeAscription(child, ty) => {
      visitor.visit_type_ascription(this, child, ty)
    }
    SpannedExpr(child) => {
      visitor.visit_spanned_expr(this, child)
    }
    RangeExpr(child) => {
      visitor.visit_range_expr(this, child)
    }
  }
}

pub fn walk_exprs<R: Default, V: ?Sized>(visitor: &mut V, exprs: Vec<usize>) -> Vec<R> where
  V: Visitor<R>
{
  exprs.into_iter().map(|expr| visitor.visit_expr(expr)).collect()
}