3a8cc061a8df4a48ffdec330ae99edd87a7a24ba
[nit.git] / src / parser / xss / parser.xss
1 $ // This file is part of NIT ( http://www.nitlanguage.org ).
2 $ //
3 $ // Copyright 2008 Jean Privat <jean@pryen.org>
4 $ // Based on algorithms developped for ( http://www.sablecc.org/ ).
5 $ //
6 $ // Licensed under the Apache License, Version 2.0 (the "License");
7 $ // you may not use this file except in compliance with the License.
8 $ // You may obtain a copy of the License at
9 $ //
10 $ //     http://www.apache.org/licenses/LICENSE-2.0
11 $ //
12 $ // Unless required by applicable law or agreed to in writing, software
13 $ // distributed under the License is distributed on an "AS IS" BASIS,
14 $ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 $ // See the License for the specific language governing permissions and
16 $ // limitations under the License.
17
18 $ template make_parser()
19
20 # State of the parser automata as stored in the parser stack.
21 private class State
22         # The internal state number
23         readable writable var _state: Int
24
25         # The node stored with the state in the stack
26         readable writable var _nodes: nullable Object
27
28         init(state: Int, nodes: nullable Object)
29         do
30                 _state = state
31                 _nodes = nodes
32         end
33 end
34
35 class Parser
36         super TablesCapable
37         # Associated lexer
38         var _lexer: Lexer
39
40         # Stack of pushed states and productions
41         var _stack: Array[State]
42
43         # Position in the stack
44         var _stack_pos: Int
45
46         # Create a new parser based on a given lexer
47         init(lexer: Lexer)
48         do
49                 _lexer = lexer
50                 _stack = new Array[State]
51                 _stack_pos = -1
52                 build_reduce_table
53         end
54
55         # Do a transition in the automata
56         private fun go_to(index: Int): Int
57         do
58                 var state = state
59                 var low = 1
60                 var high = parser_goto(index, 0) - 1
61
62                 while low <= high do
63                         var middle = (low + high) / 2
64                         var subindex = middle * 2 + 1 # +1 because parser_goto(index, 0) is the length
65
66                         var goal = parser_goto(index, subindex)
67                         if state < goal then
68                                 high = middle - 1
69                         else if state > goal then
70                                 low = middle + 1
71                         else
72                                 return parser_goto(index, subindex+1)
73                         end
74                 end
75
76                 return parser_goto(index, 2) # Default value
77         end
78
79         # Push someting in the state stack
80         private fun push(numstate: Int, list_node: nullable Object)
81         do
82                 var pos = _stack_pos + 1
83                 _stack_pos = pos
84                 if pos < _stack.length then
85                         var state = _stack[pos]
86                         state.state = numstate
87                         state.nodes = list_node
88                 else
89                         _stack.push(new State(numstate, list_node))
90                 end
91         end
92
93         # The current state
94         private fun state: Int
95         do
96                 return _stack[_stack_pos].state
97         end
98
99         # Pop something from the stack state
100         private fun pop: nullable Object
101         do
102                 var res = _stack[_stack_pos].nodes
103                 _stack_pos = _stack_pos -1
104                 return res
105         end
106
107         # Build and return a full AST.
108         fun parse: Start
109         do
110                 push(0, null)
111
112                 var lexer = _lexer
113                 loop
114                         var token = lexer.peek
115                         if token isa PError then
116                                 return new Start(null, token)
117                         end
118
119                         var state = self.state
120                         var index = token.parser_index
121                         var action_type = parser_action(state, 2)
122                         var action_value = parser_action(state, 3)
123
124                         var low = 1
125                         var high = parser_action(state, 0) - 1
126
127                         while low <= high do
128                                 var middle = (low + high) / 2
129                                 var subindex = middle * 3 + 1 # +1 because parser_action(state, 0) is the length
130
131                                 var goal = parser_action(state, subindex)
132                                 if index < goal then
133                                         high = middle - 1
134                                 else if index > goal then
135                                         low = middle + 1
136                                 else
137                                         action_type = parser_action(state, subindex+1)
138                                         action_value = parser_action(state, subindex+2)
139                                         break
140                                 end
141                         end
142
143                         if action_type == 0 then # SHIFT
144                                 push(action_value, lexer.next)
145                         else if action_type == 1 then # REDUCE
146                                 _reduce_table[action_value].action(self)
147                         else if action_type == 2 then # ACCEPT
148                                 var node2 = lexer.next
149                                 assert node2 isa EOF
150                                 var node1 = pop
151                                 assert node1 isa ${/parser/prods/prod/@ename}
152                                 var node = new Start(node1, node2)
153                                 (new ComputeProdLocationVisitor).enter_visit(node)
154                                 return node
155                         else if action_type == 3 then # ERROR
156                                 var node2 = new PError.init_error("Syntax error: unexpected {token}.", token.location)
157                                 var node = new Start(null, node2)
158                                 return node
159                         end
160                 end
161         end
162
163         var _reduce_table: Array[ReduceAction]
164         private fun build_reduce_table
165         do
166                 _reduce_table = new Array[ReduceAction].with_items(
167 $ foreach {rules/rule}
168                         new ReduceAction@index(@leftside)[-sep ','-]
169 $ end foreach
170                 )
171         end
172 end
173
174 redef class Prod
175         # Location on the first token after the start of a production
176         # So outside the production for epilon production
177         var _first_location: nullable Location
178
179         # Location of the last token before the end of a production
180         # So outside the production for epilon production
181         var _last_location: nullable Location
182 end
183
184 # Find location of production nodes
185 # Uses existing token locations to infer location of productions.
186 private class ComputeProdLocationVisitor
187         super Visitor
188         # Currenlty visited productions that need a first token
189         var _need_first_prods: Array[Prod] = new Array[Prod]
190
191         # Already visited epsilon productions that waits something after them
192         var _need_after_epsilons: Array[Prod] = new Array[Prod]
193
194         # Already visited epsilon production that waits something before them
195         var _need_before_epsilons: Array[Prod] = new Array[Prod]
196
197         # Location of the last visited token in the current production
198         var _last_location: nullable Location = null
199
200         redef fun visit(n: nullable PNode)
201         do
202                 if n == null then
203                         return
204                 else if n isa Token then
205                         var loc = n.location
206                         _last_location = loc
207
208                         # Add a first token to productions that need one
209                         for no in _need_first_prods do
210                                 no._first_location = loc
211                         end
212                         _need_first_prods.clear
213
214                         # Find location for already visited epsilon production that need one
215                         for no in _need_after_epsilons do
216                                 # Epsilon production that is in the middle of a non-epsilon production
217                                 # The epsilon production has both a token before and after it
218                                 var endl = loc
219                                 var startl = no._last_location
220                                 no.location = new Location(endl.file, startl.line_end, endl.line_start, startl.column_end, endl.column_start)
221                         end
222                         _need_after_epsilons.clear
223                 else
224                         assert n isa Prod
225                         _need_first_prods.add(n)
226
227                         var old_last = _last_location
228                         _last_location = null
229                         n.visit_all(self)
230                         var endl = _last_location
231                         if endl == null then _last_location = old_last
232
233                         n._last_location = endl
234                         var startl = n._first_location
235                         if startl != null then
236                                 # Non-epsilon production
237                                 assert endl != null
238
239                                 n.location = new Location(startl.file, startl.line_start, endl.line_end, startl.column_start, endl.column_end)
240
241                                 for no in _need_before_epsilons do
242                                         # Epsilon production that starts the current non-epsilon production
243                                         #var startl = n.location
244                                         no.location = new Location(startl.file, startl.line_start, startl.line_start, startl.column_start, startl.column_start)
245                                 end
246                                 _need_before_epsilons.clear
247
248                                 for no in _need_after_epsilons do
249                                         # Epsilon production that finishes the current non-epsilon production
250                                         #var endl = n.location
251                                         no.location = new Location(endl.file, endl.line_end, endl.line_end, endl.column_end, endl.column_end)
252                                 end
253                                 _need_after_epsilons.clear
254                         else
255                                 # No first token means epsilon production (or "throw all my tokens" production)
256                                 # So, it must be located it later
257                                 if endl == null then
258                                         # Epsilon production that starts a parent non-epsilon production
259                                         _need_before_epsilons.add(n)
260                                 else
261                                         # Epsilon production in the middle or that finishes a parent non-epsilon production
262                                         _need_after_epsilons.add(n)
263                                 end
264                         end
265                 end
266         end
267
268         init do end
269 end
270
271 # Each reduca action has its own class, this one is the root of the hierarchy.
272 private abstract class ReduceAction
273         fun action(p: Parser) is abstract
274         fun concat(l1, l2 : Array[Object]): Array[Object]
275         do
276                 if l1.is_empty then return l2
277                 l1.append(l2)
278                 return l1
279         end
280         var _goto: Int
281         init(g: Int) do _goto = g
282 end
283
284 $ foreach {rules/rule}
285 private class ReduceAction@index
286         super ReduceAction
287         redef fun action(p: Parser)
288         do
289                                         var node_list: nullable Object = null
290 $   foreach {action}
291 $   choose
292 $     when {@cmd='POP'}
293                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} = p.pop
294 $     end
295 $     when {@cmd='FETCHLIST'}
296                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} = ${translate(@from,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}
297                                         assert ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} isa Array[Object]
298 $     end
299 $     when {@cmd='FETCHNODE'}
300                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} = ${translate(@from,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}
301                                         assert ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} isa nullable @etype
302 $     end
303 $     when {@cmd='ADDNODE'}
304                                         if ${translate(@node,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} != null then
305                                                 ${translate(@tolist,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}.add(${translate(@node,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")})
306                                         end
307 $     end
308 $     when {@cmd='ADDLIST'}
309                                         ${translate(@tolist,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} = concat(${translate(@tolist,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}, ${translate(@fromlist,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")})
310 $     end
311 $     when {@cmd='MAKELIST'}
312                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")} = new Array[Object]
313 $     end
314 $     when {@cmd='MAKENODE'}
315 $      if {count(arg)!=0}
316                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}: nullable @etype = new @etype.init_${translate(@etype,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}(
317 $       foreach {arg}
318 $           if @null
319                                                 null[-sep ','-]
320 $           else
321                                                 ${translate(.,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}[-sep ','-]
322 $           end
323 $       end foreach
324                                         )
325 $      else
326                                         var ${translate(@result,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}: nullable @etype = new @etype.init_${translate(@etype,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}
327 $      end
328 $     end
329 $     when {@cmd='RETURNNODE'}
330 $       if @null
331                                         node_list = null
332 $       else
333                                         node_list = ${translate(@node,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}
334 $       end
335 $     end
336 $     when {@cmd='RETURNLIST'}
337                                         node_list = ${translate(@list,"ABCDEFGHIJKLMNOPQRSTUVWXYZ","abcdefghijklmnopqrstuvwxyz")}
338 $     end
339 $   end choose
340 $   end foreach
341                                         p.push(p.go_to(_goto), node_list)
342         end
343 end
344 $ end foreach
345 $ end template
346
347 $ template make_parser_table()
348 $ foreach {parser_data/action_table/row}
349 static int parser_action_row${position()}[] = {
350         ${count(action)},
351 $   foreach {action}
352         @from, @action, @to[-sep ','-]
353 $   end foreach
354 };
355 $ end foreach
356
357 const int* const parser_action_table[] = {
358 $ foreach {parser_data/action_table/row}
359         parser_action_row${position()}[-sep ','-]
360 $ end foreach
361 };
362
363 $ foreach {parser_data/goto_table/row}
364 static int parser_goto_row${position()}[] = {
365         ${count(goto)},
366 $   foreach {goto}
367         @from, @to[-sep ','-]
368 $   end foreach
369 };
370 $ end foreach
371
372 const int* const parser_goto_table[] = {
373 $ foreach {parser_data/goto_table/row}
374         parser_goto_row${position()}[-sep ','-]
375 $ end foreach
376 };
377 $ end template