1 $ // This file is part of NIT ( http://www.nitlanguage.org ).
3 $ // Copyright 2008 Jean Privat <jean@pryen.org>
4 $ // Based on algorithms developped for ( http://www.sablecc.org/ ).
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
10 $ // http://www.apache.org/licenses/LICENSE-2.0
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.
18 $ template make_abs_nodes()
19 # Root of the AST hierarchy
21 var _location: nullable Location
23 # Location is set during AST building. Once built, location cannon be null
24 # However, manual instanciated nodes may need mode care
25 fun location: Location do return _location.as(not null)
28 # Ancestor of all tokens
33 # Ancestor of all productions
36 fun location=(loc: Location) do _location = loc
40 $ template make_nodes()
42 # Parent of the node in the AST
43 readable writable var _parent: nullable PNode
45 # Remove a child from the AST
46 fun remove_child(child: PNode)
48 replace_child(child, null)
51 # Replace a child with an other node in the AST
52 fun replace_child(old_child: PNode, new_child: nullable PNode) is abstract
54 # Replace itself with an other node in the AST
55 fun replace_with(node: PNode)
57 if (_parent != null) then
58 _parent.replace_child(self, node)
62 # Visit all nodes in order.
63 # Thus, call "v.visit(e)" for each node e
64 fun visit_all(v: Visitor) is abstract
66 # Visit all nodes in reverse order.
67 # Thus, call "v.visit(e)" for each node e starting from the last child
68 fun visit_all_reverse(v: Visitor) is abstract
72 redef fun visit_all(v: Visitor) do end
73 redef fun visit_all_reverse(v: Visitor) do end
74 redef fun replace_child(old_child: PNode, new_child: nullable PNode) do end
78 redef fun replace_with(n: PNode)
86 # Abstract standard visitor
88 # What the visitor do when a node is visited
89 # Concrete visitors should redefine this method.
90 protected fun visit(e: nullable PNode) is abstract
92 # Ask the visitor to visit a given node.
93 # Usually automatically called by visit_all* methods.
94 # This methos should not be redefined
95 fun enter_visit(e: nullable PNode)
97 var old = _current_node
103 # The current visited node
104 readable var _current_node: nullable PNode = null