1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # AST nodes of the Nit language
16 # Was previously based on parser_abs.nit.
22 # Root of the AST class-hierarchy
24 # Location is set during AST building. Once built, location cannon be null.
25 # However, manual instantiated nodes may need more care.
26 var location
: Location is writable, noinit
28 # The location of the important part of the node (identifier or whatever)
29 fun hot_location
: Location do return location
31 # Display a message for the colored location of the node
32 fun debug
(message
: String)
34 sys
.stderr
.write
"{hot_location} {self.class_name}: {message}\n{hot_location.colored_line("0;32")}\n"
37 # Write the subtree on stdout.
43 d
.write_to
(sys
.stdout
)
46 # Parent of the node in the AST
47 var parent
: nullable ANode = null
49 # The topmost ancestor of the element
50 # This just apply `parent` until the first one
56 if p
== null then return res
61 # The most specific common parent between `self` and `other`
62 # Return null if the two node are unrelated (distinct root)
63 fun common_parent
(other
: ANode): nullable ANode
65 # First, get the same depth
66 var s
: nullable ANode = self
67 var o
: nullable ANode = other
68 var d
= s
.depth
- o
.depth
77 assert o
.depth
== s
.depth
78 # Second, go up until same in found
86 # Number of nodes between `self` and the `root` of the AST
87 # ENSURE `self == self.root implies result == 0 `
88 # ENSURE `self != self.root implies result == self.parent.depth + 1`
95 if p
== null then return res
101 # Replace a child with an other node in the AST
102 private fun replace_child
(old_child
: ANode, new_child
: nullable ANode) is abstract
104 # Detach a node from its parent
105 # Aborts if the node is not detachable. use `replace_with` instead
106 # REQUIRE: parent != null
107 # REQUIRE: is_detachable
108 # ENDURE: parent == null
111 assert parent
!= null
112 parent
.replace_child
(self, null)
116 # Replace itself with an other node in the AST
117 # REQUIRE: parent != null
118 # ENSURE: node.parent == old(parent)
119 # ENSURE: parent == null
120 fun replace_with
(node
: ANode)
122 assert parent
!= null
123 parent
.replace_child
(self, node
)
127 # Visit all nodes in order.
128 # Thus, call `v.enter_visit(e)` for each child `e`
129 fun visit_all
(v
: Visitor) is abstract
131 # Do a deep search and return an array of tokens that match a given text
132 fun collect_tokens_by_text
(text
: String): Array[Token]
134 var v
= new CollectTokensByTextVisitor(text
)
139 # Do a deep search and return an array of node that are annotated
140 # The attached node can be retrieved by two invocations of parent
141 fun collect_annotations_by_name
(name
: String): Array[AAnnotation]
143 var v
= new CollectAnnotationsByNameVisitor(name
)
149 private class CollectTokensByTextVisitor
152 var result
= new Array[Token]
153 redef fun visit
(node
)
156 if node
isa Token and node
.text
== text
then result
.add
(node
)
160 private class CollectAnnotationsByNameVisitor
163 var result
= new Array[AAnnotation]
164 redef fun visit
(node
)
167 if node
isa AAnnotation and node
.n_atid
.n_id
.text
== name
then result
.add
(node
)
171 # A helper class to handle (print) Nit AST as an OrderedTree
174 super OrderedTree[ANode]
176 # Reference to the last parent in the Ordered Tree
177 # Is used to handle the initial node parent and workaround possible inconsistent `ANode::parent`
178 private var last_parent
: nullable ANode = null
192 return "{n.class_name} \"{n.text.escape_to_c}\
" @{n.location}"
194 return "{n.class_name} @{n.location}"
199 # A sequence of nodes
200 # It is a specific class (instead of using a Array) to track the parent/child relation when nodes are added or removed
201 class ANodes[E
: ANode]
203 private var parent
: ANode
204 private var items
= new Array[E
]
205 redef fun iterator
do return items
.iterator
206 redef fun length
do return items
.length
207 redef fun is_empty
do return items
.is_empty
226 var res
= items
.shift
238 redef fun []=(index
, e
)
240 hook_remove
(self[index
])
244 redef fun remove_at
(index
)
246 hook_remove
(items
[index
])
247 items
.remove_at
(index
)
249 private fun hook_add
(e
: E
)
251 #assert e.parent == null
254 private fun hook_remove
(e
: E
)
256 assert e
.parent
== parent
260 # Used in parent constructor to fill elements
261 private fun unsafe_add_all
(nodes
: Collection[Object])
263 var parent
= self.parent
271 private fun replace_child
(old_child
: ANode, new_child
: nullable ANode): Bool
273 var parent
= self.parent
274 for i
in [0..length
[ do
275 if self[i
] == old_child
then
276 if new_child
!= null then
277 assert new_child
isa E
279 new_child
.parent
= parent
289 private fun visit_all
(v
: Visitor)
291 for n
in self do v
.enter_visit
(n
)
295 # Ancestor of all tokens
296 # A token is a node that has a `text` but no children.
300 # The raw content on the token
301 fun text
: String is abstract
303 # The raw content on the token
304 fun text
=(text
: String) is abstract
306 # The previous token in the Lexer.
307 # May have disappeared in the AST
308 var prev_token
: nullable Token = null
310 # The next token in the Lexer.
311 # May have disappeared in the AST
312 var next_token
: nullable Token = null
314 # The verbatim blank text between `prev_token` and `self`
315 fun blank_before
: String
317 if prev_token
== null then return ""
318 var from
= prev_token
.location
.pend
+1
319 var to
= location
.pstart
320 return location
.file
.string
.substring
(from
,to-from
)
323 redef fun to_s
: String do
327 redef fun visit_all
(v
: Visitor) do end
328 redef fun replace_child
(old_child
: ANode, new_child
: nullable ANode) do end
331 redef class SourceFile
332 # The first token parser by the lexer
333 # May have disappeared in the final AST
334 var first_token
: nullable Token = null
336 # The first token parser by the lexer
337 # May have disappeared in the final AST
338 var last_token
: nullable Token = null
341 # Ancestor of all productions
342 # A production is a node without text but that usually has children.
346 # All the annotations attached directly to the node
347 var n_annotations
: nullable AAnnotations = null is writable
349 # Return all its annotations of a given name in the order of their declaration
350 # Retun an empty array if no such an annotation.
351 fun get_annotations
(name
: String): Array[AAnnotation]
353 var res
= new Array[AAnnotation]
354 var nas
= n_annotations
355 if nas
!= null then for na
in nas
.n_items
do
356 if na
.name
!= name
then continue
359 if self isa AClassdef then for na
in n_propdefs
do
360 if na
isa AAnnotPropdef then
361 if na
.name
!= name
then continue
369 redef fun replace_with
(n
: ANode)
373 if not isset n
._location
and isset _location
then n
._location
= _location
377 # Abstract standard visitor on the AST
378 abstract class Visitor
379 # What the visitor do when a node is visited
380 # Concrete visitors should implement this method.
382 protected fun visit
(e
: ANode) is abstract
384 # Ask the visitor to visit a given node.
385 # Usually automatically called by visit_all* methods.
386 # This method should not be redefined
387 fun enter_visit
(e
: nullable ANode)
389 if e
== null then return
390 var old
= _current_node
396 # The current visited node
397 var current_node
: nullable ANode = null is writable
400 # Token of end of line (basically `\n`)
409 # Token of a line of comments
410 # Starts with the `#` and contains the final end-of-line (if any)
415 # A token associated with a keyword
416 abstract class TokenKeyword
420 return "keyword '{text}'"
424 # The deprecated keyword `package`.
429 # The keyword `module`
434 # The keyword `import`
439 # The keyword `class`
444 # The keyword `abstract`
449 # The keyword `interface`
454 # The keywords `enum` ane `universal`
479 # The keyword `redef`
499 # The keyword `extern`
504 # The keyword `public`
509 # The keyword `protected`
514 # The keyword `private`
519 # The keyword `intrude`
539 # The keyword `while`
569 # The keyword `implies`
579 # The keyword `return`
584 # The keyword `continue`
589 # The keyword `break`
594 # The keyword `abort`
599 # The keyword `assert`
619 # The keyword `super`
634 # The keyword `false`
649 # The keyword `nullable`
654 # The keyword `isset`
659 # The keyword `label`
669 # The special keyword `__DEBUG__`
714 # A token associated with an operator (and other lookalike symbols)
715 abstract class TokenOperator
719 return "operator '{text}'"
863 # A class (or formal type) identifier. They start with an uppercase.
868 do return "type identifier '{text}'"
872 # A standard identifier (variable, method...). They start with a lowercase.
877 do return "identifier '{text}'"
881 # An attribute identifier. They start with an underscore.
886 do return "attribute '{text}'"
890 # A token of a literal value (string, integer, etc).
891 abstract class TokenLiteral
895 do return "literal value '{text}'"
899 # A literal decimal integer
904 # A literal hexadecimal integer
909 # A literal floating point number
914 # A literal character
924 # The starting part of a super string (between `"` and `{`)
929 # The middle part of a super string (between `}` and `{`)
934 # The final part of a super string (between `}` and `"`)
944 do return "malformed string {text}"
953 do return "malformed character {text}"
957 # A extern code block
958 class TExternCodeSegment
975 # A lexical error (unexpected character)
979 # A syntactic error (unexpected token)
984 # The main node of a Nit source-file
988 # The declaration part of the module
989 var n_moduledecl
: nullable AModuledecl = null is writable
991 # List of importation clauses
992 var n_imports
= new ANodes[AImport](self)
994 # List of extern blocks
995 var n_extern_code_blocks
= new ANodes[AExternCodeBlock](self)
997 # List of class definition (including top-level methods and the main)
998 var n_classdefs
= new ANodes[AClassdef](self)
1001 # Abstract class for definition of entities
1002 abstract class ADefinition
1005 var n_doc
: nullable ADoc = null is writable
1007 # The `redef` keyword
1008 var n_kwredef
: nullable TKwredef = null is writable
1010 # The declared visibility
1011 var n_visibility
: nullable AVisibility = null is writable
1014 # The declaration of the module with the documentation, name, and annotations
1018 # The `module` keyword
1019 var n_kwmodule
: TKwmodule is writable, noinit
1021 # The declared module name
1022 var n_name
: AModuleName is writable, noinit
1025 # A import clause of a module
1026 abstract class AImport
1029 # The declared visibility
1030 var n_visibility
: AVisibility is writable, noinit
1032 # The `import` keyword
1033 var n_kwimport
: TKwimport is writable, noinit
1036 # A standard import clause. eg `import x`
1039 # The imported module name
1040 var n_name
: AModuleName is writable, noinit
1043 # The special import clause of the kernel module. eg `import end`
1046 # The `end` keyword, that indicate the root module
1047 var n_kwend
: TKwend is writable, noinit
1050 # A visibility modifier
1052 # The public visibility is an empty production (no keyword).
1054 # Note: even if some visibilities are only valid on some placse (for instance, no `protected` class or no `intrude` method)
1055 # the parser has no such a restriction, therefore the semantic phases has to check that the visibilities make sense.
1056 abstract class AVisibility
1060 # An implicit or explicit public visibility modifier
1061 class APublicVisibility
1063 # The `public` keyword, if any
1064 var n_kwpublic
: nullable TKwpublic is writable
1066 # An explicit private visibility modifier
1067 class APrivateVisibility
1069 # The `private` keyword
1070 var n_kwprivate
: TKwprivate is writable, noinit
1072 # An explicit protected visibility modifier
1073 class AProtectedVisibility
1075 # The `protected` keyword
1076 var n_kwprotected
: TKwprotected is writable, noinit
1078 # An explicit intrude visibility modifier
1079 class AIntrudeVisibility
1081 # The `intrude` keyword
1082 var n_kwintrude
: TKwintrude is writable, noinit
1085 # A class definition
1086 # While most definition are `AStdClassdef`
1087 # There is tow special case of class definition
1088 abstract class AClassdef
1090 # All the declared properties (including the main method)
1091 var n_propdefs
= new ANodes[APropdef](self)
1094 # A standard class definition with a name, superclasses and properties
1099 # The class kind (interface, abstract class, etc.)
1100 var n_classkind
: AClasskind is writable, noinit
1102 # The name of the class
1103 var n_id
: nullable TClassid = null is writable
1105 # The list of formal parameter types
1106 var n_formaldefs
= new ANodes[AFormaldef](self)
1108 # The extern block code
1109 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1112 var n_kwend
: TKwend is writable, noinit
1114 fun n_superclasses
: Array[ASuperPropdef] do
1115 return [for d
in n_propdefs
do if d
isa ASuperPropdef then d
]
1118 redef fun hot_location
do return n_id
.location
1121 # The implicit class definition of the implicit main method
1126 # The implicit class definition of the top-level methods
1131 # The modifier for the kind of class (abstract, interface, etc.)
1132 abstract class AClasskind
1136 # A default, or concrete class modifier (just `class`)
1137 class AConcreteClasskind
1140 # The `class` keyword.
1141 var n_kwclass
: TKwclass is writable, noinit
1144 # An abstract class modifier (`abstract class`)
1145 class AAbstractClasskind
1148 # The `abstract` keyword.
1149 var n_kwabstract
: TKwabstract is writable, noinit
1151 # The `class` keyword.
1152 var n_kwclass
: TKwclass is writable, noinit
1155 # An interface class modifier (`interface`)
1156 class AInterfaceClasskind
1159 # The `interface` keyword.
1160 var n_kwinterface
: TKwinterface is writable, noinit
1163 # An enum/universal class modifier (`enum class`)
1164 class AEnumClasskind
1167 # The `enum` keyword.
1168 var n_kwenum
: TKwenum is writable, noinit
1171 # An extern class modifier (`extern class`)
1172 class AExternClasskind
1175 # The `extern` keyword.
1176 var n_kwextern
: TKwextern is writable, noinit
1178 # The `class` keyword.
1179 var n_kwclass
: nullable TKwclass = null is writable
1182 # The definition of a formal generic parameter type. eg `X: Y`
1186 # The name of the parameter type
1187 var n_id
: TClassid is writable, noinit
1189 # The bound of the parameter type
1190 var n_type
: nullable AType = null is writable
1193 # The definition of a property
1194 abstract class APropdef
1198 # A definition of an attribute
1199 # For historical reason, old-syle and new-style attributes use the same `ANode` sub-class
1203 # The identifier for a old-style attribute (null if new-style)
1204 var n_kwvar
: TKwvar is writable, noinit
1206 # The identifier for a new-style attribute (null if old-style)
1207 var n_id2
: TId is writable, noinit
1209 # The declared type of the attribute
1210 var n_type
: nullable AType = null is writable
1212 # The initial value, if any (set with `=`)
1213 var n_expr
: nullable AExpr = null is writable
1215 # The initial value, if any (set with `do return`)
1216 var n_block
: nullable AExpr = null is writable
1218 redef fun hot_location
1220 return n_id2
.location
1224 # A definition of all kind of method (including constructors)
1228 # The `fun` keyword, if any
1229 var n_kwmeth
: nullable TKwmeth = null is writable
1231 # The `init` keyword, if any
1232 var n_kwinit
: nullable TKwinit = null is writable
1234 # The `new` keyword, if any
1235 var n_kwnew
: nullable TKwnew = null is writable
1237 # The name of the method, if any
1238 var n_methid
: nullable AMethid = null is writable
1240 # The signature of the method, if any
1241 var n_signature
: nullable ASignature = null is writable
1243 # The body (in Nit) of the method, if any
1244 var n_block
: nullable AExpr = null is writable
1246 # The list of declared callbacks (for extern methods)
1247 var n_extern_calls
: nullable AExternCalls = null is writable
1249 # The body (in extern code) of the method, if any
1250 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1252 redef fun hot_location
1254 if n_methid
!= null then
1255 return n_methid
.location
1256 else if n_kwinit
!= null then
1257 return n_kwinit
.location
1258 else if n_kwnew
!= null then
1259 return n_kwnew
.location
1266 # The implicit main method
1267 class AMainMethPropdef
1276 # A super-class. eg `super X`
1281 var n_kwsuper
: TKwsuper is writable, noinit
1283 # The super-class (indicated as a type)
1284 var n_type
: AType is writable, noinit
1288 # Declaration of callbacks for extern methods
1292 # The `import` keyword
1293 var n_kwimport
: TKwimport is writable, noinit
1295 # The list of declared callbacks
1296 var n_extern_calls
: ANodes[AExternCall] = new ANodes[AExternCall](self)
1299 # A single callback declaration
1300 abstract class AExternCall
1304 # A single callback declaration on a method
1305 abstract class APropExternCall
1309 # A single callback declaration on a method on the current receiver
1310 class ALocalPropExternCall
1311 super APropExternCall
1313 # The name of the called-back method
1314 var n_methid
: AMethid is writable, noinit
1317 # A single callback declaration on a method on an explicit receiver type.
1318 class AFullPropExternCall
1319 super APropExternCall
1321 # The type of the receiver of the called-back method
1322 var n_type
: AType is writable, noinit
1325 var n_dot
: nullable TDot = null is writable
1327 # The name of the called-back method
1328 var n_methid
: AMethid is writable, noinit
1331 # A single callback declaration on a method on a constructor
1332 class AInitPropExternCall
1333 super APropExternCall
1335 # The allocated type
1336 var n_type
: AType is writable, noinit
1339 # A single callback declaration on a `super` call
1340 class ASuperExternCall
1343 # The `super` keyword
1344 var n_kwsuper
: TKwsuper is writable, noinit
1347 # A single callback declaration on a cast
1348 abstract class ACastExternCall
1352 # A single callback declaration on a cast to a given type
1353 class ACastAsExternCall
1354 super ACastExternCall
1356 # The origin type of the cast
1357 var n_from_type
: AType is writable, noinit
1360 var n_dot
: nullable TDot = null is writable
1363 var n_kwas
: TKwas is writable, noinit
1365 # The destination of the cast
1366 var n_to_type
: AType is writable, noinit
1369 # A single callback declaration on a cast to a nullable type
1370 class AAsNullableExternCall
1371 super ACastExternCall
1373 # The origin type to cast as nullable
1374 var n_type
: AType is writable, noinit
1377 var n_kwas
: TKwas is writable, noinit
1379 # The `nullable` keyword
1380 var n_kwnullable
: TKwnullable is writable, noinit
1383 # A single callback declaration on a cast to a non-nullable type
1384 class AAsNotNullableExternCall
1385 super ACastExternCall
1387 # The destination type on a cast to not nullable
1388 var n_type
: AType is writable, noinit
1391 var n_kwas
: TKwas is writable, noinit
1394 var n_kwnot
: TKwnot is writable, noinit
1396 # The `nullable` keyword
1397 var n_kwnullable
: TKwnullable is writable, noinit
1400 # A definition of a virtual type
1404 # The `type` keyword
1405 var n_kwtype
: TKwtype is writable, noinit
1407 # The name of the virtual type
1408 var n_id
: TClassid is writable, noinit
1410 # The bound of the virtual type
1411 var n_type
: AType is writable, noinit
1414 # The identifier of a method in a method declaration.
1415 # There is a specific class because of operator and setters.
1416 abstract class AMethid
1420 # A method name with a simple identifier
1424 # The simple identifier
1425 var n_id
: TId is writable, noinit
1433 var n_plus
: TPlus is writable, noinit
1441 var n_minus
: TMinus is writable, noinit
1449 var n_star
: TStar is writable, noinit
1452 # A method name `**`
1453 class AStarstarMethid
1457 var n_starstar
: TStarstar is writable, noinit
1465 var n_slash
: TSlash is writable, noinit
1469 class APercentMethid
1473 var n_percent
: TPercent is writable, noinit
1476 # A method name `==`
1481 var n_eq
: TEq is writable, noinit
1484 # A method name `!=`
1489 var n_ne
: TNe is writable, noinit
1492 # A method name `<=`
1497 var n_le
: TLe is writable, noinit
1500 # A method name `>=`
1505 var n_ge
: TGe is writable, noinit
1513 var n_lt
: TLt is writable, noinit
1521 var n_gt
: TGt is writable, noinit
1524 # A method name `<<`
1529 var n_ll
: TLl is writable, noinit
1532 # A method name `>>`
1537 var n_gg
: TGg is writable, noinit
1540 # A method name `[]`
1545 var n_obra
: TObra is writable, noinit
1548 var n_cbra
: TCbra is writable, noinit
1551 # A method name `<=>`
1552 class AStarshipMethid
1556 var n_starship
: TStarship is writable, noinit
1559 # A setter method name with a simple identifier (with a `=`)
1563 # The base identifier
1564 var n_id
: TId is writable, noinit
1567 var n_assign
: TAssign is writable, noinit
1570 # A method name `[]=`
1571 class ABraassignMethid
1575 var n_obra
: TObra is writable, noinit
1578 var n_cbra
: TCbra is writable, noinit
1581 var n_assign
: TAssign is writable, noinit
1584 # A signature in a method definition. eg `(x,y:X,z:Z):T`
1589 var n_opar
: nullable TOpar = null is writable
1591 # The list of parameters
1592 var n_params
= new ANodes[AParam](self)
1595 var n_cpar
: nullable TCpar = null is writable
1598 var n_type
: nullable AType = null is writable
1601 # A parameter definition in a signature. eg `x:X`
1605 # The name of the parameter
1606 var n_id
: TId is writable, noinit
1608 # The type of the parameter, if any
1609 var n_type
: nullable AType = null is writable
1611 # The `...` symbol to indicate varargs
1612 var n_dotdotdot
: nullable TDotdotdot = null is writable
1615 # A static type. eg `nullable X[Y]`
1618 # The `nullable` keyword
1619 var n_kwnullable
: nullable TKwnullable = null is writable
1621 # The name of the class or of the formal type
1622 var n_id
: TClassid is writable, noinit
1624 # Type arguments for a generic type
1625 var n_types
= new ANodes[AType](self)
1628 # A label at the end of a block or in a break/continue statement. eg `label x`
1632 # The `label` keyword
1633 var n_kwlabel
: TKwlabel is writable, noinit
1635 # The name of the label, if any
1636 var n_id
: nullable TId is writable, noinit
1639 # Expression and statements
1640 # From a AST point of view there is no distinction between statement and expressions (even if the parser has to distinguish them)
1641 abstract class AExpr
1645 # A sequence of `AExpr` (usually statements)
1646 # The last `AExpr` gives the value of the whole block
1650 # The list of statements in the bloc.
1651 # The last element is often considered as an expression that give the value of the whole block.
1652 var n_expr
= new ANodes[AExpr](self)
1655 var n_kwend
: nullable TKwend = null is writable
1658 # A declaration of a local variable. eg `var x: X = y`
1663 var n_kwvar
: nullable TKwvar = null is writable
1665 # The name of the local variable
1666 var n_id
: TId is writable, noinit
1668 # The declaration type of the local variable
1669 var n_type
: nullable AType = null is writable
1671 # The `=` symbol (for the initial value)
1672 var n_assign
: nullable TAssign = null is writable
1674 # The initial value, if any
1675 var n_expr
: nullable AExpr = null is writable
1678 # A `return` statement. eg `return x`
1682 # The `return` keyword
1683 var n_kwreturn
: nullable TKwreturn = null is writable
1685 # The return value, if any
1686 var n_expr
: nullable AExpr = null is writable
1689 # Something that has a label.
1690 abstract class ALabelable
1693 # The associated label declatation
1694 var n_label
: nullable ALabel = null is writable
1697 # A `break` or a `continue`
1698 abstract class AEscapeExpr
1702 # The return value, if nay (unused currently)
1703 var n_expr
: nullable AExpr = null is writable
1706 # A `break` statement.
1710 # The `break` keyword
1711 var n_kwbreak
: TKwbreak is writable, noinit
1714 # An `abort` statement
1718 # The `abort` keyword
1719 var n_kwabort
: TKwabort is writable, noinit
1722 # A `continue` statement
1726 # The `continue` keyword.
1727 var n_kwcontinue
: nullable TKwcontinue = null is writable
1736 var n_kwdo
: TKwdo is writable, noinit
1738 # The list of statements of the `do`.
1739 var n_block
: nullable AExpr = null is writable
1747 var n_kwif
: TKwif is writable, noinit
1749 # The expression used as the condition of the `if`
1750 var n_expr
: AExpr is writable, noinit
1752 # The body of the `then` part
1753 var n_then
: nullable AExpr = null is writable
1755 # The body of the `else` part
1756 var n_else
: nullable AExpr = null is writable
1759 # A `if` expression (ternary conditional). eg. `if true then 1 else 0`
1764 var n_kwif
: TKwif is writable, noinit
1766 # The expression used as the condition of the `if`
1767 var n_expr
: AExpr is writable, noinit
1769 # The `then` keyword
1770 var n_kwthen
: TKwthen is writable, noinit
1772 # The expression in the `then` part
1773 var n_then
: AExpr is writable, noinit
1775 # The `else` keyword
1776 var n_kwelse
: TKwelse is writable, noinit
1778 # The expression in the `else` part
1779 var n_else
: AExpr is writable, noinit
1782 # A `while` statement
1787 # The `while` keyword
1788 var n_kwwhile
: TKwwhile is writable, noinit
1790 # The expression used as the condition of the `while`
1791 var n_expr
: AExpr is writable, noinit
1794 var n_kwdo
: TKwdo is writable, noinit
1796 # The body of the loop
1797 var n_block
: nullable AExpr = null is writable
1800 # A `loop` statement
1805 # The `loop` keyword
1806 var n_kwloop
: TKwloop is writable, noinit
1808 # The body of the loop
1809 var n_block
: nullable AExpr = null is writable
1818 var n_kwfor
: TKwfor is writable, noinit
1820 # The list of name of the automatic variables
1821 var n_ids
= new ANodes[TId](self)
1823 # The expression used as the collection to iterate on
1824 var n_expr
: AExpr is writable, noinit
1827 var n_kwdo
: TKwdo is writable, noinit
1829 # The body of the loop
1830 var n_block
: nullable AExpr = null is writable
1833 # A `with` statement
1838 # The `with` keyword
1839 var n_kwwith
: TKwwith is writable, noinit
1841 # The expression used to get the value to control
1842 var n_expr
: AExpr is writable, noinit
1845 var n_kwdo
: TKwdo is writable, noinit
1847 # The body of the loop
1848 var n_block
: nullable AExpr = null is writable
1851 # An `assert` statement
1855 # The `assert` keyword
1856 var n_kwassert
: TKwassert is writable, noinit
1858 # The name of the assert, if any
1859 var n_id
: nullable TId = null is writable
1861 # The expression used as the condition of the `assert`
1862 var n_expr
: AExpr is writable, noinit
1864 # The body to execute when the assert fails
1865 var n_else
: nullable AExpr = null is writable
1868 # Whatever is a simple assignment. eg `= something`
1869 abstract class AAssignFormExpr
1873 var n_assign
: TAssign is writable, noinit
1875 # The right-value to assign.
1876 var n_value
: AExpr is writable, noinit
1879 # Whatever is a combined assignment. eg `+= something`
1880 abstract class AReassignFormExpr
1883 # The combined operator (eg. `+=`)
1884 var n_assign_op
: AAssignOp is writable, noinit
1886 # The right-value to apply on the combined operator.
1887 var n_value
: AExpr is writable, noinit
1890 # A `once` expression. eg `once x`
1894 # The `once` keyword
1895 var n_kwonce
: TKwonce is writable, noinit
1897 # The expression to evaluate only one time
1898 var n_expr
: AExpr is writable, noinit
1901 # A polymorphic invocation of a method
1902 # The form of the invocation (name, arguments, etc.) are specific
1903 abstract class ASendExpr
1905 # The receiver of the method invocation
1906 var n_expr
: AExpr is writable, noinit
1909 # A binary operation on a method
1910 abstract class ABinopExpr
1914 var n_op
: Token is writable, noinit
1916 # The second operand of the operation
1917 # Note: the receiver (`n_expr`) is the first operand
1918 var n_expr2
: AExpr is writable, noinit
1920 # The name of the operator (eg '+')
1921 fun operator
: String is abstract
1924 # Something that is boolean expression
1925 abstract class ABoolExpr
1929 # Something that is binary boolean expression
1930 abstract class ABinBoolExpr
1933 # The first boolean operand
1934 var n_expr
: AExpr is writable, noinit
1937 var n_op
: Token is writable, noinit
1939 # The second boolean operand
1940 var n_expr2
: AExpr is writable, noinit
1948 # A `and` expression
1953 # A `or else` expression
1957 # The `else` keyword
1958 var n_kwelse
: TKwelse is writable, noinit
1961 # A `implies` expression
1966 # A `not` expression
1971 var n_kwnot
: TKwnot is writable, noinit
1973 # The boolean operand of the `not`
1974 var n_expr
: AExpr is writable, noinit
1980 redef fun operator
do return "=="
1986 redef fun operator
do return "!="
1992 redef fun operator
do return "<"
1998 redef fun operator
do return "<="
2004 redef fun operator
do return "<<"
2010 redef fun operator
do return ">"
2016 redef fun operator
do return ">="
2022 redef fun operator
do return ">>"
2025 # A type-ckeck expression. eg `x isa T`
2029 # The expression to check
2030 var n_expr
: AExpr is writable, noinit
2033 var n_kwisa
: TKwisa is writable, noinit
2035 # The destination type to check to
2036 var n_type
: AType is writable, noinit
2042 redef fun operator
do return "+"
2048 redef fun operator
do return "-"
2051 # A `<=>` expression
2054 redef fun operator
do return "<=>"
2060 redef fun operator
do return "*"
2066 redef fun operator
do return "**"
2072 redef fun operator
do return "/"
2078 redef fun operator
do return "%"
2081 # A unary minus expression. eg `-x`
2086 var n_minus
: TMinus is writable, noinit
2089 # A unary plus expression. eg `+x`
2094 var n_plus
: TPlus is writable, noinit
2097 # An explicit instantiation. eg `new T`
2102 var n_kwnew
: TKwnew is writable, noinit
2104 # The `type` keyword
2105 var n_type
: AType is writable, noinit
2107 # The name of the named-constructor, if any
2108 var n_id
: nullable TId = null is writable
2110 # The arguments of the `new`
2111 var n_args
: AExprs is writable, noinit
2114 # Whatever is a old-style attribute access
2115 abstract class AAttrFormExpr
2118 # The receiver of the attribute
2119 var n_expr
: AExpr is writable, noinit
2121 # The name of the attribute
2122 var n_id
: TAttrid is writable, noinit
2126 # The read of an attribute. eg `x._a`
2131 # The assignment of an attribute. eg `x._a=y`
2132 class AAttrAssignExpr
2134 super AAssignFormExpr
2137 # Whatever looks-like a call with a standard method and any number of arguments.
2138 abstract class ACallFormExpr
2141 # The name of the method
2142 var n_id
: TId is writable, noinit
2144 # The arguments of the call
2145 var n_args
: AExprs is writable, noinit
2148 # A complex setter call (standard or brackets)
2149 abstract class ASendReassignFormExpr
2151 super AReassignFormExpr
2154 # A complex attribute assignment. eg `x._a+=y`
2155 class AAttrReassignExpr
2157 super AReassignFormExpr
2160 # A call with a standard method-name and any number of arguments. eg `x.m(y)`. OR just a simple id
2161 # Note: because the parser cannot distinguish a variable read with a method call with an implicit receiver and no arguments, it always returns a `ACallExpr`.
2162 # Semantic analysis have to transform them to instance of `AVarExpr`.
2167 # A setter call with a standard method-name and any number of arguments. eg `x.m(y)=z`. OR just a simple assignment.
2168 # Note: because the parser cannot distinguish a variable write with a setter call with an implicit receiver and no arguments, it always returns a `ACallAssignExpr`.
2169 # Semantic analysis have to transform them to instance of `AVarAssignExpr`.
2170 class ACallAssignExpr
2172 super AAssignFormExpr
2175 # A complex setter call with a standard method-name and any number of arguments. eg `x.m(y)+=z`. OR just a simple complex assignment.
2176 # Note: because the parser cannot distinguish a variable write with a complex setter call with an implicit receiver and no arguments, it always returns a `ACallReassignExpr`.
2177 # Semantic analysis have to transform them to instance of `AVarReassignExpr`.
2178 class ACallReassignExpr
2180 super ASendReassignFormExpr
2183 # A call to `super`. OR a call of a super-constructor
2187 # The qualifier part before the super (currenlty unused)
2188 var n_qualified
: nullable AQualified = null is writable
2190 # The `super` keyword
2191 var n_kwsuper
: TKwsuper is writable, noinit
2193 # The arguments of the super
2194 var n_args
: AExprs is writable, noinit
2197 # A call to the `init` constructor.
2198 # Note: because `init` is a keyword and not a `TId`, the explicit call to init cannot be a `ACallFormExpr`.
2202 # The `init` keyword
2203 var n_kwinit
: TKwinit is writable, noinit
2205 # The arguments of the init
2206 var n_args
: AExprs is writable, noinit
2209 # Whatever looks-like a call of the brackets `[]` operator.
2210 abstract class ABraFormExpr
2213 # The arguments inside the brackets
2214 var n_args
: AExprs is writable, noinit
2217 # A call of the brackets operator. eg `x[y,z]`
2222 # A setter call of the bracket operator. eg `x[y,z]=t`
2223 class ABraAssignExpr
2225 super AAssignFormExpr
2228 # Whatever is an access to a local variable
2229 abstract class AVarFormExpr
2232 # The name of the attribute
2233 var n_id
: TId is writable, noinit
2236 # A complex setter call of the bracket operator. eg `x[y,z]+=t`
2237 class ABraReassignExpr
2239 super ASendReassignFormExpr
2242 # A local variable read access.
2243 # The parser cannot instantiate them, see `ACallExpr`.
2248 # A local variable simple assignment access
2249 # The parser cannot instantiate them, see `ACallAssignExpr`.
2250 class AVarAssignExpr
2252 super AAssignFormExpr
2255 # A local variable complex assignment access
2256 # The parser cannot instantiate them, see `ACallReassignExpr`.
2257 class AVarReassignExpr
2259 super AReassignFormExpr
2262 # A literal range, open or closed
2263 abstract class ARangeExpr
2266 # The left (lower) element of the range
2267 var n_expr
: AExpr is writable, noinit
2269 # The right (uppr) element of the range
2270 var n_expr2
: AExpr is writable, noinit
2273 # A closed literal range. eg `[x..y]`
2277 # The opening bracket `[`
2278 var n_obra
: TObra is writable, noinit
2280 # The closing bracket `]`
2281 var n_cbra
: TCbra is writable, noinit
2284 # An open literal range. eg `[x..y[`
2288 # The opening bracket `[`
2289 var n_obra
: TObra is writable, noinit
2291 # The closing bracket `[` (because open range)
2292 var n_cbra
: TObra is writable, noinit
2295 # A literal array. eg. `[x,y,z]`
2299 # The opening bracket `[`
2300 var n_obra
: TObra is writable, noinit
2302 # The elements of the array
2303 var n_exprs
= new ANodes[AExpr](self)
2305 # The type of the element of the array (if any)
2306 var n_type
: nullable AType = null is writable
2308 # The closing bracket `]`
2309 var n_cbra
: TCbra is writable, noinit
2316 # The `self` keyword
2317 var n_kwself
: nullable TKwself = null is writable
2320 # When there is no explicit receiver, `self` is implicit
2321 class AImplicitSelfExpr
2325 # A `true` boolean literal constant
2329 # The `true` keyword
2330 var n_kwtrue
: TKwtrue is writable, noinit
2333 # A `false` boolean literal constant
2337 # The `false` keyword
2338 var n_kwfalse
: TKwfalse is writable, noinit
2341 # A `null` literal constant
2345 # The `null` keyword
2346 var n_kwnull
: TKwnull is writable, noinit
2349 # An integer literal
2354 # An integer literal in decimal format
2359 var n_number
: TNumber is writable, noinit
2362 # An integer literal in hexadecimal format
2366 # The hexadecimal token
2367 var n_hex_number
: THexNumber is writable, noinit
2375 var n_float
: TFloat is writable, noinit
2378 # A character literal
2382 # The character token
2383 var n_char
: TChar is writable, noinit
2387 abstract class AStringFormExpr
2391 var n_string
: Token is writable, noinit
2394 # A simple string. eg. `"abc"`
2396 super AStringFormExpr
2399 # The start of a superstring. eg `"abc{`
2400 class AStartStringExpr
2401 super AStringFormExpr
2404 # The middle of a superstring. eg `}abc{`
2405 class AMidStringExpr
2406 super AStringFormExpr
2409 # The end of a superstrng. eg `}abc"`
2410 class AEndStringExpr
2411 super AStringFormExpr
2414 # A superstring literal. eg `"a{x}b{y}c"`
2415 # Each part is modeled a sequence of expression. eg. `["a{, x, }b{, y, }c"]`
2416 class ASuperstringExpr
2419 # The list of the expressions of the superstring
2420 var n_exprs
= new ANodes[AExpr](self)
2423 # A simple parenthesis. eg `(x)`
2427 # The opening parenthesis
2428 var n_opar
: TOpar is writable, noinit
2430 # The inner expression
2431 var n_expr
: AExpr is writable, noinit
2433 # The closing parenthesis
2434 var n_cpar
: TCpar is writable, noinit
2437 # A cast, against a type or `not null`
2441 # The expression to cast
2442 var n_expr
: AExpr is writable, noinit
2445 var n_kwas
: TKwas is writable, noinit
2447 # The opening parenthesis
2448 var n_opar
: nullable TOpar = null is writable
2450 # The closing parenthesis
2451 var n_cpar
: nullable TCpar = null is writable
2454 # A type cast. eg `x.as(T)`
2458 # The target type to cast to
2459 var n_type
: AType is writable, noinit
2462 # A as-not-null cast. eg `x.as(not null)`
2463 class AAsNotnullExpr
2467 var n_kwnot
: TKwnot is writable, noinit
2469 # The `null` keyword
2470 var n_kwnull
: TKwnull is writable, noinit
2473 # A is-set check of old-style attributes. eg `isset x._a`
2474 class AIssetAttrExpr
2477 # The `isset` keyword
2478 var n_kwisset
: TKwisset is writable, noinit
2481 # An ellipsis notation used to pass an expression as it, in a vararg parameter
2485 # The passed expression
2486 var n_expr
: AExpr is writable, noinit
2489 var n_dotdotdot
: TDotdotdot is writable, noinit
2492 # A list of expression separated with commas (arguments for instance)
2496 # The list of expressions
2497 var n_exprs
= new ANodes[AExpr](self)
2500 # A special expression that encapsulates a static type
2501 # Can only be found in special construction like arguments of annotations.
2505 # The encapsulated type
2506 var n_type
: AType is writable, noinit
2509 # A special expression that encapsulates a method identifier
2510 # Can only be found in special construction like arguments of annotations.
2515 var n_expr
: AExpr is writable, noinit
2517 # The encapsulated method identifier
2518 var n_id
: AMethid is writable, noinit
2521 # A special expression that encapsulate an annotation
2522 # Can only be found in special construction like arguments of annotations.
2524 # The encapsulated annotations are in `n_annotations`
2529 # A special expression to debug types
2530 class ADebugTypeExpr
2533 # The `debug` keyword
2534 var n_kwdebug
: TKwdebug is writable, noinit
2536 # The `type` keyword
2537 var n_kwtype
: TKwtype is writable, noinit
2539 # The expression to check
2540 var n_expr
: AExpr is writable, noinit
2543 var n_type
: AType is writable, noinit
2546 # A list of expression separated with commas (arguments for instance)
2547 abstract class AExprs
2550 # The list of expressions
2551 var n_exprs
= new ANodes[AExpr](self)
2554 # A simple list of expressions
2559 # A list of expressions enclosed in parentheses
2563 # The opening parenthesis
2564 var n_opar
: TOpar is writable, noinit
2566 # The closing parenthesis
2567 var n_cpar
: TCpar is writable, noinit
2570 # A list of expressions enclosed in brackets
2574 # The opening bracket
2575 var n_obra
: TObra is writable, noinit
2577 # The closing bracket
2578 var n_cbra
: TCbra is writable, noinit
2581 # A complex assignment operator. (`+=` and `-=`)
2582 abstract class AAssignOp
2585 # The combined assignment operator
2586 var n_op
: Token is writable, noinit
2588 # The name of the operator without the `=` (eg '+')
2589 fun operator
: String is abstract
2592 # A `+=` assignment operation
2596 redef fun operator
do return "+"
2599 # A `-=` assignment operation
2600 class AMinusAssignOp
2603 redef fun operator
do return "-"
2606 # A `*=` assignment operation
2610 redef fun operator
do return "*"
2613 # A `/=` assignment operation
2614 class ASlashAssignOp
2617 redef fun operator
do return "/"
2620 # A `%=` assignment operation
2621 class APercentAssignOp
2624 redef fun operator
do return "%"
2627 # A `**=` assignment operation
2628 class AStarstarAssignOp
2631 redef fun operator
do return "**"
2634 # A `<<=` assignment operation
2638 redef fun operator
do return "<<"
2641 # A `>>=` assignment operation
2645 redef fun operator
do return ">>"
2648 # A possibly fully-qualified module identifier
2652 # The starting quad (`::`)
2653 var n_quad
: nullable TQuad = null is writable
2655 # The list of quad-separated project/group identifiers
2656 var n_path
= new ANodes[TId](self)
2658 # The final module identifier
2659 var n_id
: TId is writable, noinit
2662 # A language declaration for an extern block
2667 var n_kwin
: TKwin is writable, noinit
2670 var n_string
: TString is writable, noinit
2673 # An full extern block
2674 class AExternCodeBlock
2677 # The language declration
2678 var n_in_language
: nullable AInLanguage = null is writable
2680 # The block of extern code
2681 var n_extern_code_segment
: TExternCodeSegment is writable, noinit
2684 # A possible full method qualifier.
2688 # The starting quad (`::`)
2689 var n_quad
: nullable TQuad = null is writable
2691 # The list of quad-separated project/group/module identifiers
2692 var n_id
= new ANodes[TId](self)
2694 # A class identifier
2695 var n_classid
: nullable TClassid = null is writable
2698 # A documentation of a definition
2699 # It contains the block of comments just above the declaration
2703 # A list of lines of comment
2704 var n_comment
= new ANodes[TComment](self)
2707 # A group of annotation on a node
2709 # This same class is used for the 3 kind of annotations:
2711 # * *is* annotations. eg `module foo is bar`.
2712 # * *at* annotations. eg `foo@bar` or `foo@(bar,baz)`.
2713 # * *class* annotations, defined in classes.
2717 # The `@` symbol, for *at* annotations
2718 var n_at
: nullable TAt = null is writable
2720 # The opening parenthesis in *at* annotations
2721 var n_opar
: nullable TOpar = null is writable
2723 # The list of annotations
2724 var n_items
= new ANodes[AAnnotation](self)
2726 # The closing parenthesis in *at* annotations
2727 var n_cpar
: nullable TCpar = null is writable
2730 # A single annotation
2734 # The name of the annotation
2735 var n_atid
: AAtid is writable, noinit
2737 # The opening parenthesis of the arguments
2738 var n_opar
: nullable TOpar = null is writable
2740 # The list of arguments
2741 var n_args
= new ANodes[AExpr](self)
2743 # The closing parenthesis
2744 var n_cpar
: nullable TCpar = null is writable
2746 # The name of the annotation
2749 return n_atid
.n_id
.text
2753 # An annotation name
2754 abstract class AAtid
2757 # The identifier of the annotation.
2758 # Can be a TId of a keyword
2759 var n_id
: Token is writable, noinit
2762 # An annotation name based on an identifier
2767 # An annotation name based on the keyword `extern`
2772 # An annotation name based on the keyword `import`
2777 # An annotation name based on the keyword `abstract`
2778 class AKwabstractAtid
2782 # The root of the AST
2787 var n_base
: nullable AModule is writable
2789 # The end of file (or error) token
2790 var n_eof
: EOF is writable