src/parser/xss/nodes.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
  19 $ template make_abs_nodes()
  20 # Root of the AST hierarchy
  21 abstract class PNode
  22         readable var _location: nullable Location
  23 end
  24
  25 # Ancestor of all tokens
  26 abstract class Token
  27 special PNode
  28 end
  29
  30 # Ancestor of all productions
  31 abstract class Prod
  32 special PNode
  33         fun location=(loc: nullable Location) do _location = loc
  34 end
  35 $ end template
  36
  37 $ template make_nodes()
  38 redef class PNode
  39         # Parent of the node in the AST
  40         readable writable var _parent: nullable PNode
  41
  42         # Remove a child from the AST
  43         fun remove_child(child: PNode)
  44         do
  45                 replace_child(child, null)
  46         end
  47
  48         # Replace a child with an other node in the AST
  49         fun replace_child(old_child: PNode, new_child: nullable PNode) is abstract
  50
  51         # Replace itself with an other node in the AST
  52         fun replace_with(node: PNode)
  53         do
  54                 if (_parent != null) then
  55                         _parent.replace_child(self, node)
  56                 end
  57         end
  58
  59         # Visit all nodes in order.
  60         # Thus, call "v.visit(e)" for each node e
  61         fun visit_all(v: Visitor) is abstract
  62
  63         # Visit all nodes in reverse order.
  64         # Thus, call "v.visit(e)" for each node e starting from the last child
  65         fun visit_all_reverse(v: Visitor) is abstract
  66
  67         # Debug method: output a message prefixed with the location.
  68         fun printl(str: String)
  69         do
  70                 if location == null then
  71                         print("???: {str}\n")
  72                 else
  73                         print("{location}: {str}\n")
  74                 end
  75         end
  76 end
  77
  78 redef class Token
  79         redef fun visit_all(v: Visitor) do end
  80         redef fun visit_all_reverse(v: Visitor) do end
  81         redef fun replace_child(old_child: PNode, new_child: nullable PNode) do end
  82 end
  83
  84 redef class Prod
  85         # The first token of the production node
  86         readable writable var _first_token: nullable Token
  87
  88         # The last token of the production node
  89         readable writable var _last_token: nullable Token
  90
  91         redef fun replace_with(n: PNode)
  92         do
  93                 super
  94                 assert n isa Prod
  95                 n.first_token = first_token
  96                 n.last_token = last_token
  97                 n.location = location
  98         end
  99 end
 100
 101 # Abstract standard visitor
 102 class Visitor
 103         # What the visitor do when a node is visited
 104         # Concrete visitors should redefine this method.
 105         protected fun visit(e: nullable PNode) is abstract
 106
 107         # Ask the visitor to visit a given node.
 108         # Usually automatically called by visit_all* methods.
 109         # This methos should not be redefined
 110         fun enter_visit(e: nullable PNode)
 111         do
 112                 var old = _current_node
 113                 _current_node = e
 114                 visit(e)
 115                 _current_node = old
 116         end
 117
 118         # The current visited node
 119         readable var _current_node: nullable PNode = null
 120 end
 121
 122 $ end template