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 reverse_iterator
do return items
.reverse_iterator
207 redef fun length
do return items
.length
208 redef fun is_empty
do return items
.is_empty
227 var res
= items
.shift
239 redef fun []=(index
, e
)
241 hook_remove
(self[index
])
245 redef fun remove_at
(index
)
247 hook_remove
(items
[index
])
248 items
.remove_at
(index
)
250 private fun hook_add
(e
: E
)
252 #assert e.parent == null
255 private fun hook_remove
(e
: E
)
257 assert e
.parent
== parent
261 # Used in parent constructor to fill elements
262 private fun unsafe_add_all
(nodes
: Collection[Object])
264 var parent
= self.parent
272 private fun replace_child
(old_child
: ANode, new_child
: nullable ANode): Bool
274 var parent
= self.parent
275 for i
in [0..length
[ do
276 if self[i
] == old_child
then
277 if new_child
!= null then
278 assert new_child
isa E
280 new_child
.parent
= parent
290 private fun visit_all
(v
: Visitor)
292 for n
in self do v
.enter_visit
(n
)
296 # Ancestor of all tokens
297 # A token is a node that has a `text` but no children.
301 # The raw content on the token
302 fun text
: String is abstract
304 # The raw content on the token
305 fun text
=(text
: String) is abstract
307 # The previous token in the Lexer.
308 # May have disappeared in the AST
309 var prev_token
: nullable Token = null
311 # The next token in the Lexer.
312 # May have disappeared in the AST
313 var next_token
: nullable Token = null
315 # Is `self` a token discarded from the AST?
317 # Loose tokens are not present in the AST.
318 # It means they were identified by the lexer but were discarded by the parser.
319 # It also means that they are not visited or manipulated by AST-related functions.
321 # Each loose token is attached to the non-loose token that precedes or follows it.
322 # The rules are the following:
324 # * tokens that follow a non-loose token on a same line are attached to it.
326 # * other tokens, thus that precede a non-loose token on the same line or the next one,
327 # are attached to this one. See `prev_looses`.
329 # Loose tokens are mostly end of lines (`TEol`) and comments (`TComment`).
330 # Whitespace are ignored by the lexer, so they are not even considered as loose tokens.
331 # See `blank_before` to get the whitespace that separate tokens.
334 # Loose tokens that precede `self`.
336 # These tokens start the line or belong to a line with only loose tokens.
337 var prev_looses
= new Array[Token] is lazy
339 # Loose tokens that follow `self`
341 # These tokens are on the same line than `self`.
342 var next_looses
= new Array[Token] is lazy
344 # The verbatim blank text between `prev_token` and `self`
345 fun blank_before
: String
347 if prev_token
== null then return ""
348 var from
= prev_token
.location
.pend
+1
349 var to
= location
.pstart
350 return location
.file
.string
.substring
(from
,to-from
)
353 redef fun to_s
: String do
357 redef fun visit_all
(v
: Visitor) do end
358 redef fun replace_child
(old_child
: ANode, new_child
: nullable ANode) do end
361 redef class SourceFile
362 # The first token parser by the lexer
363 # May have disappeared in the final AST
364 var first_token
: nullable Token = null
366 # The first token parser by the lexer
367 # May have disappeared in the final AST
368 var last_token
: nullable Token = null
371 # Ancestor of all productions
372 # A production is a node without text but that usually has children.
376 # All the annotations attached directly to the node
377 var n_annotations
: nullable AAnnotations = null is writable
379 # Return all its annotations of a given name in the order of their declaration
380 # Retun an empty array if no such an annotation.
381 fun get_annotations
(name
: String): Array[AAnnotation]
383 var res
= new Array[AAnnotation]
384 var nas
= n_annotations
385 if nas
!= null then for na
in nas
.n_items
do
386 if na
.name
!= name
then continue
389 if self isa AClassdef then for na
in n_propdefs
do
390 if na
isa AAnnotPropdef then
391 if na
.name
!= name
then continue
399 redef fun replace_with
(n
: ANode)
403 if not isset n
._location
and isset _location
then n
._location
= _location
407 # Abstract standard visitor on the AST
408 abstract class Visitor
409 # What the visitor do when a node is visited
410 # Concrete visitors should implement this method.
412 protected fun visit
(e
: ANode) is abstract
414 # Ask the visitor to visit a given node.
415 # Usually automatically called by visit_all* methods.
416 # This method should not be redefined
417 fun enter_visit
(e
: nullable ANode)
419 if e
== null then return
420 var old
= _current_node
426 # The current visited node
427 var current_node
: nullable ANode = null is writable
430 # Token of end of line (basically `\n`)
439 # Token of a line of comments
440 # Starts with the `#` and contains the final end-of-line (if any)
445 # A token associated with a keyword
446 abstract class TokenKeyword
450 return "keyword '{text}'"
454 # The deprecated keyword `package`.
459 # The keyword `module`
464 # The keyword `import`
469 # The keyword `class`
474 # The keyword `abstract`
479 # The keyword `interface`
484 # The keywords `enum` ane `universal`
509 # The keyword `redef`
529 # The keyword `extern`
534 # The keyword `public`
539 # The keyword `protected`
544 # The keyword `private`
549 # The keyword `intrude`
569 # The keyword `while`
599 # The keyword `implies`
609 # The keyword `return`
614 # The keyword `continue`
619 # The keyword `break`
624 # The keyword `abort`
629 # The keyword `assert`
649 # The keyword `super`
664 # The keyword `false`
679 # The keyword `nullable`
684 # The keyword `isset`
689 # The keyword `label`
699 # The keyword `yield`
704 # The special keyword `__DEBUG__`
749 # A token associated with an operator (and other lookalike symbols)
750 abstract class TokenOperator
754 return "operator '{text}'"
938 # A class (or formal type) identifier. They start with an uppercase.
943 do return "type identifier '{text}'"
947 # A standard identifier (variable, method...). They start with a lowercase.
952 do return "identifier '{text}'"
956 # An attribute identifier. They start with an underscore.
961 do return "attribute '{text}'"
965 # A token of a literal value (string, integer, etc).
966 abstract class TokenLiteral
970 do return "literal value '{text}'"
979 # A literal floating point number
984 # A literal character
994 # The starting part of a super string (between `"` and `{`)
999 # The middle part of a super string (between `}` and `{`)
1004 # The final part of a super string (between `}` and `"`)
1009 # A malformed string
1014 do return "malformed string {text}"
1023 do return "malformed character {text}"
1027 # A extern code block
1028 class TExternCodeSegment
1037 return "end of file"
1041 # A mark of an error
1045 # A lexical error (unexpected character)
1049 # A syntactic error (unexpected token)
1054 # The main node of a Nit source-file
1058 # The declaration part of the module
1059 var n_moduledecl
: nullable AModuledecl = null is writable
1061 # List of importation clauses
1062 var n_imports
= new ANodes[AImport](self)
1064 # List of extern blocks
1065 var n_extern_code_blocks
= new ANodes[AExternCodeBlock](self)
1067 # List of class definition (including top-level methods and the main)
1068 var n_classdefs
= new ANodes[AClassdef](self)
1071 # Abstract class for definition of entities
1072 abstract class ADefinition
1075 var n_doc
: nullable ADoc = null is writable
1077 # The `redef` keyword
1078 var n_kwredef
: nullable TKwredef = null is writable
1080 # The declared visibility
1081 var n_visibility
: nullable AVisibility = null is writable
1084 # The declaration of the module with the documentation, name, and annotations
1088 # The `module` keyword
1089 var n_kwmodule
: TKwmodule is writable, noinit
1091 # The declared module name
1092 var n_name
: AModuleName is writable, noinit
1095 # A import clause of a module
1096 abstract class AImport
1099 # The declared visibility
1100 var n_visibility
: AVisibility is writable, noinit
1102 # The `import` keyword
1103 var n_kwimport
: TKwimport is writable, noinit
1106 # A standard import clause. eg `import x`
1109 # The imported module name
1110 var n_name
: AModuleName is writable, noinit
1113 # The special import clause of the kernel module. eg `import end`
1116 # The `end` keyword, that indicate the root module
1117 var n_kwend
: TKwend is writable, noinit
1120 # A visibility modifier
1122 # The public visibility is an empty production (no keyword).
1124 # Note: even if some visibilities are only valid on some placse (for instance, no `protected` class or no `intrude` method)
1125 # the parser has no such a restriction, therefore the semantic phases has to check that the visibilities make sense.
1126 abstract class AVisibility
1130 # An implicit or explicit public visibility modifier
1131 class APublicVisibility
1133 # The `public` keyword, if any
1134 var n_kwpublic
: nullable TKwpublic = null is writable
1136 # An explicit private visibility modifier
1137 class APrivateVisibility
1139 # The `private` keyword
1140 var n_kwprivate
: TKwprivate is writable, noinit
1142 # An explicit protected visibility modifier
1143 class AProtectedVisibility
1145 # The `protected` keyword
1146 var n_kwprotected
: TKwprotected is writable, noinit
1148 # An explicit intrude visibility modifier
1149 class AIntrudeVisibility
1151 # The `intrude` keyword
1152 var n_kwintrude
: TKwintrude is writable, noinit
1155 # A class definition
1156 # While most definition are `AStdClassdef`
1157 # There is tow special case of class definition
1158 abstract class AClassdef
1160 # All the declared properties (including the main method)
1161 var n_propdefs
= new ANodes[APropdef](self)
1164 # A standard class definition with a name, superclasses and properties
1169 # The class kind (interface, abstract class, etc.)
1170 var n_classkind
: AClasskind is writable, noinit
1172 # The name of the class
1173 var n_qid
: nullable AQclassid = null is writable
1176 var n_obra
: nullable TObra = null is writable
1178 # The list of formal parameter types
1179 var n_formaldefs
= new ANodes[AFormaldef](self)
1182 var n_cbra
: nullable TCbra = null is writable
1184 # The extern block code
1185 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1188 var n_kwend
: TKwend is writable, noinit
1190 fun n_superclasses
: Array[ASuperPropdef] do
1191 return [for d
in n_propdefs
do if d
isa ASuperPropdef then d
]
1194 redef fun hot_location
do return n_qid
.location
1197 # The implicit class definition of the implicit main method
1202 # The implicit class definition of the top-level methods
1207 # The modifier for the kind of class (abstract, interface, etc.)
1208 abstract class AClasskind
1212 # A default, or concrete class modifier (just `class`)
1213 class AConcreteClasskind
1216 # The `class` keyword.
1217 var n_kwclass
: TKwclass is writable, noinit
1220 # An abstract class modifier (`abstract class`)
1221 class AAbstractClasskind
1224 # The `abstract` keyword.
1225 var n_kwabstract
: TKwabstract is writable, noinit
1227 # The `class` keyword.
1228 var n_kwclass
: TKwclass is writable, noinit
1231 # An interface class modifier (`interface`)
1232 class AInterfaceClasskind
1235 # The `interface` keyword.
1236 var n_kwinterface
: TKwinterface is writable, noinit
1239 # An enum/universal class modifier (`enum class`)
1240 class AEnumClasskind
1243 # The `enum` keyword.
1244 var n_kwenum
: TKwenum is writable, noinit
1247 # An extern class modifier (`extern class`)
1248 class AExternClasskind
1251 # The `extern` keyword.
1252 var n_kwextern
: TKwextern is writable, noinit
1254 # The `class` keyword.
1255 var n_kwclass
: nullable TKwclass = null is writable
1258 # The definition of a formal generic parameter type. eg `X: Y`
1262 # The name of the parameter type
1263 var n_id
: TClassid is writable, noinit
1265 # The bound of the parameter type
1266 var n_type
: nullable AType = null is writable
1269 # The definition of a property
1270 abstract class APropdef
1274 # A definition of an attribute
1275 # For historical reason, old-syle and new-style attributes use the same `ANode` sub-class
1280 var n_kwvar
: TKwvar is writable, noinit
1282 # The identifier for a new-style attribute
1283 var n_id2
: TId is writable, noinit
1285 # The declared type of the attribute
1286 var n_type
: nullable AType = null is writable
1289 var n_assign
: nullable TAssign = null is writable
1291 # The initial value, if any (set with `=`)
1292 var n_expr
: nullable AExpr = null is writable
1295 var n_kwdo
: nullable TKwdo = null is writable
1297 # The initial value, if any (set with `do return`)
1298 var n_block
: nullable AExpr = null is writable
1301 var n_kwend
: nullable TKwend = null is writable
1303 redef fun hot_location
1305 return n_id2
.location
1309 # A definition of all kind of method (including constructors)
1313 # The `fun` keyword, if any
1314 var n_kwmeth
: nullable TKwmeth = null is writable
1316 # The `init` keyword, if any
1317 var n_kwinit
: nullable TKwinit = null is writable
1319 # The `new` keyword, if any
1320 var n_kwnew
: nullable TKwnew = null is writable
1322 # The name of the method, if any
1323 var n_methid
: nullable AMethid = null is writable
1325 # The signature of the method, if any
1326 var n_signature
: nullable ASignature = null is writable
1329 var n_kwdo
: nullable TKwdo = null is writable
1331 # The body (in Nit) of the method, if any
1332 var n_block
: nullable AExpr = null is writable
1335 var n_kwend
: nullable TKwend = null is writable
1337 # The list of declared callbacks (for extern methods)
1338 var n_extern_calls
: nullable AExternCalls = null is writable
1340 # The body (in extern code) of the method, if any
1341 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1343 redef fun hot_location
1345 if n_methid
!= null then
1346 return n_methid
.location
1347 else if n_kwinit
!= null then
1348 return n_kwinit
.location
1349 else if n_kwnew
!= null then
1350 return n_kwnew
.location
1357 # The implicit main method
1358 class AMainMethPropdef
1367 # A super-class. eg `super X`
1372 var n_kwsuper
: TKwsuper is writable, noinit
1374 # The super-class (indicated as a type)
1375 var n_type
: AType is writable, noinit
1379 # Declaration of callbacks for extern methods
1383 # The `import` keyword
1384 var n_kwimport
: TKwimport is writable, noinit
1386 # The list of declared callbacks
1387 var n_extern_calls
: ANodes[AExternCall] = new ANodes[AExternCall](self)
1390 # A single callback declaration
1391 abstract class AExternCall
1395 # A single callback declaration on a method
1396 abstract class APropExternCall
1400 # A single callback declaration on a method on the current receiver
1401 class ALocalPropExternCall
1402 super APropExternCall
1404 # The name of the called-back method
1405 var n_methid
: AMethid is writable, noinit
1408 # A single callback declaration on a method on an explicit receiver type.
1409 class AFullPropExternCall
1410 super APropExternCall
1412 # The type of the receiver of the called-back method
1413 var n_type
: AType is writable, noinit
1416 var n_dot
: nullable TDot = null is writable
1418 # The name of the called-back method
1419 var n_methid
: AMethid is writable, noinit
1422 # A single callback declaration on a method on a constructor
1423 class AInitPropExternCall
1424 super APropExternCall
1426 # The allocated type
1427 var n_type
: AType is writable, noinit
1430 # A single callback declaration on a `super` call
1431 class ASuperExternCall
1434 # The `super` keyword
1435 var n_kwsuper
: TKwsuper is writable, noinit
1438 # A single callback declaration on a cast
1439 abstract class ACastExternCall
1443 # A single callback declaration on a cast to a given type
1444 class ACastAsExternCall
1445 super ACastExternCall
1447 # The origin type of the cast
1448 var n_from_type
: AType is writable, noinit
1451 var n_dot
: nullable TDot = null is writable
1454 var n_kwas
: TKwas is writable, noinit
1456 # The destination of the cast
1457 var n_to_type
: AType is writable, noinit
1460 # A single callback declaration on a cast to a nullable type
1461 class AAsNullableExternCall
1462 super ACastExternCall
1464 # The origin type to cast as nullable
1465 var n_type
: AType is writable, noinit
1468 var n_kwas
: TKwas is writable, noinit
1470 # The `nullable` keyword
1471 var n_kwnullable
: TKwnullable is writable, noinit
1474 # A single callback declaration on a cast to a non-nullable type
1475 class AAsNotNullableExternCall
1476 super ACastExternCall
1478 # The destination type on a cast to not nullable
1479 var n_type
: AType is writable, noinit
1482 var n_kwas
: TKwas is writable, noinit
1485 var n_kwnot
: TKwnot is writable, noinit
1487 # The `nullable` keyword
1488 var n_kwnullable
: TKwnullable is writable, noinit
1491 # A definition of a virtual type
1495 # The `type` keyword
1496 var n_kwtype
: TKwtype is writable, noinit
1498 # The name of the virtual type
1499 var n_qid
: AQclassid is writable, noinit
1501 # The bound of the virtual type
1502 var n_type
: AType is writable, noinit
1505 # The identifier of a method in a method declaration.
1506 # There is a specific class because of operator and setters.
1507 abstract class AMethid
1511 # A method name with a simple identifier
1515 # The simple identifier
1516 var n_id
: TId is writable, noinit
1519 # A method name for an operator
1520 class AOperatorMethid
1523 # The associated operator symbol
1524 var n_op
: Token is writable, noinit
1528 super AOperatorMethid
1533 super AOperatorMethid
1538 super AOperatorMethid
1541 # A method name `**`
1542 class AStarstarMethid
1543 super AOperatorMethid
1548 super AOperatorMethid
1552 class APercentMethid
1553 super AOperatorMethid
1558 super AOperatorMethid
1563 super AOperatorMethid
1568 super AOperatorMethid
1573 super AOperatorMethid
1576 # A method name `==`
1578 super AOperatorMethid
1581 # A method name `!=`
1583 super AOperatorMethid
1586 # A method name `<=`
1588 super AOperatorMethid
1591 # A method name `>=`
1593 super AOperatorMethid
1598 super AOperatorMethid
1603 super AOperatorMethid
1606 # A method name `<<`
1608 super AOperatorMethid
1611 # A method name `>>`
1613 super AOperatorMethid
1616 # A method name `<=>`
1617 class AStarshipMethid
1618 super AOperatorMethid
1621 # A method name `[]`
1626 var n_obra
: TObra is writable, noinit
1629 var n_cbra
: TCbra is writable, noinit
1632 # A setter method name with a simple identifier (with a `=`)
1636 # The base identifier
1637 var n_id
: TId is writable, noinit
1640 var n_assign
: TAssign is writable, noinit
1643 # A method name `[]=`
1644 class ABraassignMethid
1648 var n_obra
: TObra is writable, noinit
1651 var n_cbra
: TCbra is writable, noinit
1654 var n_assign
: TAssign is writable, noinit
1657 # A potentially qualified simple identifier `foo::bar::baz`
1660 # The qualifier, if any
1661 var n_qualified
: nullable AQualified = null is writable
1663 # The final identifier
1664 var n_id
: TId is writable, noinit
1667 # A potentially qualified class identifier `foo::bar::Baz`
1670 # The qualifier, if any
1671 var n_qualified
: nullable AQualified = null is writable
1673 # The final identifier
1674 var n_id
: TClassid is writable, noinit
1677 # A signature in a method definition. eg `(x,y:X,z:Z):T`
1682 var n_opar
: nullable TOpar = null is writable
1684 # The list of parameters
1685 var n_params
= new ANodes[AParam](self)
1688 var n_cpar
: nullable TCpar = null is writable
1691 var n_type
: nullable AType = null is writable
1694 # A parameter definition in a signature. eg `x:X`
1698 # The name of the parameter
1699 var n_id
: TId is writable, noinit
1701 # The type of the parameter, if any
1702 var n_type
: nullable AType = null is writable
1704 # The `...` symbol to indicate varargs
1705 var n_dotdotdot
: nullable TDotdotdot = null is writable
1708 # A static type. eg `nullable X[Y]`
1711 # The `nullable` keyword
1712 var n_kwnullable
: nullable TKwnullable = null is writable
1714 # The name of the class or of the formal type
1715 var n_qid
: AQclassid is writable, noinit
1717 # The opening bracket
1718 var n_obra
: nullable TObra = null is writable
1720 # Type arguments for a generic type
1721 var n_types
= new ANodes[AType](self)
1723 # The closing bracket
1724 var n_cbra
: nullable TCbra = null is writable
1727 # A label at the end of a block or in a break/continue statement. eg `label x`
1731 # The `label` keyword
1732 var n_kwlabel
: TKwlabel is writable, noinit
1734 # The name of the label, if any
1735 var n_id
: nullable TId is writable, noinit
1738 # Expression and statements
1739 # From a AST point of view there is no distinction between statement and expressions (even if the parser has to distinguish them)
1740 abstract class AExpr
1744 # A sequence of `AExpr` (usually statements)
1745 # The last `AExpr` gives the value of the whole block
1749 # The list of statements in the bloc.
1750 # The last element is often considered as an expression that give the value of the whole block.
1751 var n_expr
= new ANodes[AExpr](self)
1754 var n_kwend
: nullable TKwend = null is writable
1757 # A declaration of a local variable. eg `var x: X = y`
1762 var n_kwvar
: nullable TKwvar = null is writable
1764 # The name of the local variable
1765 var n_id
: TId is writable, noinit
1767 # The declaration type of the local variable
1768 var n_type
: nullable AType = null is writable
1770 # The `=` symbol (for the initial value)
1771 var n_assign
: nullable TAssign = null is writable
1773 # The initial value, if any
1774 var n_expr
: nullable AExpr = null is writable
1777 # A `return` statement. eg `return x`
1781 # The `return` keyword
1782 var n_kwreturn
: nullable TKwreturn = null is writable
1784 # The return value, if any
1785 var n_expr
: nullable AExpr = null is writable
1788 # A `yield` statement. eg `yield x`
1792 # The `yield` keyword
1793 var n_kwyield
: nullable TKwyield = null is writable
1795 # The return value, if any
1796 var n_expr
: nullable AExpr = null is writable
1799 # Something that has a label.
1800 abstract class ALabelable
1803 # The associated label declatation
1804 var n_label
: nullable ALabel = null is writable
1807 # A `break` or a `continue`
1808 abstract class AEscapeExpr
1812 # The return value, if nay (unused currently)
1813 var n_expr
: nullable AExpr = null is writable
1816 # A `break` statement.
1820 # The `break` keyword
1821 var n_kwbreak
: TKwbreak is writable, noinit
1824 # An `abort` statement
1828 # The `abort` keyword
1829 var n_kwabort
: TKwabort is writable, noinit
1832 # A `continue` statement
1836 # The `continue` keyword.
1837 var n_kwcontinue
: nullable TKwcontinue = null is writable
1846 var n_kwdo
: TKwdo is writable, noinit
1848 # The list of statements of the `do`.
1849 var n_block
: nullable AExpr = null is writable
1857 var n_kwif
: TKwif is writable, noinit
1859 # The expression used as the condition of the `if`
1860 var n_expr
: AExpr is writable, noinit
1862 # The `then` keyword
1863 var n_kwthen
: TKwthen is writable, noinit
1865 # The body of the `then` part
1866 var n_then
: nullable AExpr = null is writable
1868 # The `else` keyword
1869 var n_kwelse
: nullable TKwelse = null is writable
1871 # The body of the `else` part
1872 var n_else
: nullable AExpr = null is writable
1875 # A `if` expression (ternary conditional). eg. `if true then 1 else 0`
1880 var n_kwif
: TKwif is writable, noinit
1882 # The expression used as the condition of the `if`
1883 var n_expr
: AExpr is writable, noinit
1885 # The `then` keyword
1886 var n_kwthen
: TKwthen is writable, noinit
1888 # The expression in the `then` part
1889 var n_then
: AExpr is writable, noinit
1891 # The `else` keyword
1892 var n_kwelse
: TKwelse is writable, noinit
1894 # The expression in the `else` part
1895 var n_else
: AExpr is writable, noinit
1898 # A `while` statement
1903 # The `while` keyword
1904 var n_kwwhile
: TKwwhile is writable, noinit
1906 # The expression used as the condition of the `while`
1907 var n_expr
: AExpr is writable, noinit
1910 var n_kwdo
: TKwdo is writable, noinit
1912 # The body of the loop
1913 var n_block
: nullable AExpr = null is writable
1916 # A `loop` statement
1921 # The `loop` keyword
1922 var n_kwloop
: TKwloop is writable, noinit
1924 # The body of the loop
1925 var n_block
: nullable AExpr = null is writable
1934 var n_kwfor
: TKwfor is writable, noinit
1936 # The list of groups to iterate
1937 var n_groups
= new ANodes[AForGroup](self)
1940 var n_kwdo
: TKwdo is writable, noinit
1942 # The body of the loop
1943 var n_block
: nullable AExpr = null is writable
1946 # A collection iterated by a for, its automatic variables and its implicit iterator.
1948 # Standard `for` iterate on a single collection.
1949 # Multiple `for` can iterate on more than one collection at once.
1953 # The list of name of the automatic variables
1954 var n_ids
= new ANodes[TId](self)
1957 var n_kwin
: TKwin is writable, noinit
1959 # The expression used as the collection to iterate on
1960 var n_expr
: AExpr is writable, noinit
1963 # A `with` statement
1968 # The `with` keyword
1969 var n_kwwith
: TKwwith is writable, noinit
1971 # The expression used to get the value to control
1972 var n_expr
: AExpr is writable, noinit
1975 var n_kwdo
: TKwdo is writable, noinit
1977 # The body of the loop
1978 var n_block
: nullable AExpr = null is writable
1981 # An `assert` statement
1985 # The `assert` keyword
1986 var n_kwassert
: TKwassert is writable, noinit
1988 # The name of the assert, if any
1989 var n_id
: nullable TId = null is writable
1991 # The expression used as the condition of the `assert`
1992 var n_expr
: AExpr is writable, noinit
1994 # The `else` keyword
1995 var n_kwelse
: nullable TKwelse = null is writable
1997 # The body to execute when the assert fails
1998 var n_else
: nullable AExpr = null is writable
2001 # Whatever is a simple assignment. eg `= something`
2002 abstract class AAssignFormExpr
2006 var n_assign
: TAssign is writable, noinit
2008 # The right-value to assign.
2009 var n_value
: AExpr is writable, noinit
2012 # Whatever is a combined assignment. eg `+= something`
2013 abstract class AReassignFormExpr
2016 # The combined operator (eg. `+=`)
2017 var n_assign_op
: AAssignOp is writable, noinit
2019 # The right-value to apply on the combined operator.
2020 var n_value
: AExpr is writable, noinit
2023 # A `once` expression. eg `once x`
2027 # The `once` keyword
2028 var n_kwonce
: TKwonce is writable, noinit
2030 # The expression to evaluate only one time
2031 var n_expr
: AExpr is writable, noinit
2034 # A polymorphic invocation of a method
2035 # The form of the invocation (name, arguments, etc.) are specific
2036 abstract class ASendExpr
2038 # The receiver of the method invocation
2039 var n_expr
: AExpr is writable, noinit
2042 # A binary operation on a method
2043 abstract class ABinopExpr
2047 var n_op
: Token is writable, noinit
2049 # The second operand of the operation
2050 # Note: the receiver (`n_expr`) is the first operand
2051 var n_expr2
: AExpr is writable, noinit
2053 # The name of the operator (eg '+')
2054 fun operator
: String is abstract
2057 # Something that is boolean expression
2058 abstract class ABoolExpr
2062 # Something that is binary boolean expression
2063 abstract class ABinBoolExpr
2066 # The first boolean operand
2067 var n_expr
: AExpr is writable, noinit
2070 var n_op
: Token is writable, noinit
2072 # The second boolean operand
2073 var n_expr2
: AExpr is writable, noinit
2081 # A `and` expression
2086 # A `or else` expression
2090 # The `else` keyword
2091 var n_kwelse
: TKwelse is writable, noinit
2094 # A `implies` expression
2099 # A `not` expression
2104 var n_kwnot
: TKwnot is writable, noinit
2106 # The boolean operand of the `not`
2107 var n_expr
: AExpr is writable, noinit
2110 # A `==` or a `!=` expression
2112 # Both have a similar effect on adaptive typing, so this class factorizes the common behavior.
2120 redef fun operator
do return "=="
2126 redef fun operator
do return "!="
2132 redef fun operator
do return "<"
2138 redef fun operator
do return "<="
2144 redef fun operator
do return "<<"
2150 redef fun operator
do return ">"
2156 redef fun operator
do return ">="
2162 redef fun operator
do return ">>"
2165 # A type-ckeck expression. eg `x isa T`
2169 # The expression to check
2170 var n_expr
: AExpr is writable, noinit
2173 var n_kwisa
: TKwisa is writable, noinit
2175 # The destination type to check to
2176 var n_type
: AType is writable, noinit
2182 redef fun operator
do return "+"
2188 redef fun operator
do return "-"
2191 # A `<=>` expression
2194 redef fun operator
do return "<=>"
2200 redef fun operator
do return "*"
2206 redef fun operator
do return "**"
2212 redef fun operator
do return "/"
2218 redef fun operator
do return "%"
2224 redef fun operator
do return "|"
2230 redef fun operator
do return "^"
2236 redef fun operator
do return "&"
2239 # A unary operation on a method
2240 abstract class AUnaryopExpr
2244 var n_op
: Token is writable, noinit
2246 # The name of the operator (eg '+')
2247 fun operator
: String is abstract
2250 # A unary minus expression. eg `-x`
2253 redef fun operator
do return "-"
2256 # A unary plus expression. eg `+x`
2259 redef fun operator
do return "+"
2262 # A unary `~` expression
2265 redef fun operator
do return "~"
2268 # An explicit instantiation. eg `new T`
2273 var n_kwnew
: TKwnew is writable, noinit
2275 # The `type` keyword
2276 var n_type
: AType is writable, noinit
2278 # The name of the named-constructor, if any
2279 var n_qid
: nullable AQid = null is writable
2281 # The arguments of the `new`
2282 var n_args
: AExprs is writable, noinit
2285 # Whatever is a old-style attribute access
2286 abstract class AAttrFormExpr
2289 # The receiver of the attribute
2290 var n_expr
: AExpr is writable, noinit
2292 # The name of the attribute
2293 var n_id
: TAttrid is writable, noinit
2297 # The read of an attribute. eg `x._a`
2302 # The assignment of an attribute. eg `x._a=y`
2303 class AAttrAssignExpr
2305 super AAssignFormExpr
2308 # Whatever looks-like a call with a standard method and any number of arguments.
2309 abstract class ACallFormExpr
2312 # The name of the method
2313 var n_qid
: AQid is writable, noinit
2315 # The arguments of the call
2316 var n_args
: AExprs is writable, noinit
2319 # A complex setter call (standard or brackets)
2320 abstract class ASendReassignFormExpr
2322 super AReassignFormExpr
2325 # A complex attribute assignment. eg `x._a+=y`
2326 class AAttrReassignExpr
2328 super AReassignFormExpr
2331 # A call with a standard method-name and any number of arguments. eg `x.m(y)`. OR just a simple id
2332 # 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`.
2333 # Semantic analysis have to transform them to instance of `AVarExpr`.
2338 # A setter call with a standard method-name and any number of arguments. eg `x.m(y)=z`. OR just a simple assignment.
2339 # 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`.
2340 # Semantic analysis have to transform them to instance of `AVarAssignExpr`.
2341 class ACallAssignExpr
2343 super AAssignFormExpr
2346 # 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.
2347 # 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`.
2348 # Semantic analysis have to transform them to instance of `AVarReassignExpr`.
2349 class ACallReassignExpr
2351 super ASendReassignFormExpr
2354 # A call to `super`. OR a call of a super-constructor
2358 # The qualifier part before the super (currenlty unused)
2359 var n_qualified
: nullable AQualified = null is writable
2361 # The `super` keyword
2362 var n_kwsuper
: TKwsuper is writable, noinit
2364 # The arguments of the super
2365 var n_args
: AExprs is writable, noinit
2368 # A call to the `init` constructor.
2369 # Note: because `init` is a keyword and not a `TId`, the explicit call to init cannot be a `ACallFormExpr`.
2373 # The `init` keyword
2374 var n_kwinit
: TKwinit is writable, noinit
2376 # The arguments of the init
2377 var n_args
: AExprs is writable, noinit
2380 # Whatever looks-like a call of the brackets `[]` operator.
2381 abstract class ABraFormExpr
2384 # The arguments inside the brackets
2385 var n_args
: AExprs is writable, noinit
2388 # A call of the brackets operator. eg `x[y,z]`
2393 # A setter call of the bracket operator. eg `x[y,z]=t`
2394 class ABraAssignExpr
2396 super AAssignFormExpr
2399 # Whatever is an access to a local variable
2400 abstract class AVarFormExpr
2403 # The name of the attribute
2404 var n_id
: TId is writable, noinit
2407 # A complex setter call of the bracket operator. eg `x[y,z]+=t`
2408 class ABraReassignExpr
2410 super ASendReassignFormExpr
2413 # A local variable read access.
2414 # The parser cannot instantiate them, see `ACallExpr`.
2419 # A local variable simple assignment access
2420 # The parser cannot instantiate them, see `ACallAssignExpr`.
2421 class AVarAssignExpr
2423 super AAssignFormExpr
2426 # A local variable complex assignment access
2427 # The parser cannot instantiate them, see `ACallReassignExpr`.
2428 class AVarReassignExpr
2430 super AReassignFormExpr
2433 # A literal range, open or closed
2434 abstract class ARangeExpr
2437 # The left (lower) element of the range
2438 var n_expr
: AExpr is writable, noinit
2441 var n_dotdot
: TDotdot is writable, noinit
2443 # The right (upper) element of the range
2444 var n_expr2
: AExpr is writable, noinit
2447 # A closed literal range. eg `[x..y]`
2451 # The opening bracket `[`
2452 var n_obra
: TObra is writable, noinit
2454 # The closing bracket `]`
2455 var n_cbra
: TCbra is writable, noinit
2458 # An open literal range. eg `[x..y[`
2462 # The opening bracket `[`
2463 var n_obra
: TObra is writable, noinit
2465 # The closing bracket `[` (because open range)
2466 var n_cbra
: TObra is writable, noinit
2469 # A literal array. eg. `[x,y,z]`
2473 # The opening bracket `[`
2474 var n_obra
: TObra is writable, noinit
2476 # The elements of the array
2477 var n_exprs
= new ANodes[AExpr](self)
2479 # The type of the element of the array (if any)
2480 var n_type
: nullable AType = null is writable
2482 # The closing bracket `]`
2483 var n_cbra
: TCbra is writable, noinit
2490 # The `self` keyword
2491 var n_kwself
: nullable TKwself = null is writable
2494 # When there is no explicit receiver, `self` is implicit
2495 class AImplicitSelfExpr
2499 # A `true` boolean literal constant
2503 # The `true` keyword
2504 var n_kwtrue
: TKwtrue is writable, noinit
2507 # A `false` boolean literal constant
2511 # The `false` keyword
2512 var n_kwfalse
: TKwfalse is writable, noinit
2515 # A `null` literal constant
2519 # The `null` keyword
2520 var n_kwnull
: TKwnull is writable, noinit
2523 # An integer literal
2528 var n_integer
: TInteger is writable, noinit
2536 var n_float
: TFloat is writable, noinit
2539 # A character literal
2543 # The character token
2544 var n_char
: TChar is writable, noinit
2548 abstract class AStringFormExpr
2552 var n_string
: Token is writable, noinit
2555 # A simple string. eg. `"abc"`
2557 super AStringFormExpr
2560 # The start of a superstring. eg `"abc{`
2561 class AStartStringExpr
2562 super AStringFormExpr
2565 # The middle of a superstring. eg `}abc{`
2566 class AMidStringExpr
2567 super AStringFormExpr
2570 # The end of a superstrng. eg `}abc"`
2571 class AEndStringExpr
2572 super AStringFormExpr
2575 # A superstring literal. eg `"a{x}b{y}c"`
2576 # Each part is modeled a sequence of expression. eg. `["a{, x, }b{, y, }c"]`
2577 class ASuperstringExpr
2580 # The list of the expressions of the superstring
2581 var n_exprs
= new ANodes[AExpr](self)
2584 # A simple parenthesis. eg `(x)`
2588 # The opening parenthesis
2589 var n_opar
: TOpar is writable, noinit
2591 # The inner expression
2592 var n_expr
: AExpr is writable, noinit
2594 # The closing parenthesis
2595 var n_cpar
: TCpar is writable, noinit
2598 # A cast, against a type or `not null`
2602 # The expression to cast
2603 var n_expr
: AExpr is writable, noinit
2606 var n_kwas
: TKwas is writable, noinit
2608 # The opening parenthesis
2609 var n_opar
: nullable TOpar = null is writable
2611 # The closing parenthesis
2612 var n_cpar
: nullable TCpar = null is writable
2615 # A type cast. eg `x.as(T)`
2619 # The target type to cast to
2620 var n_type
: AType is writable, noinit
2623 # A as-not-null cast. eg `x.as(not null)`
2624 class AAsNotnullExpr
2628 var n_kwnot
: TKwnot is writable, noinit
2630 # The `null` keyword
2631 var n_kwnull
: TKwnull is writable, noinit
2634 # A is-set check of old-style attributes. eg `isset x._a`
2635 class AIssetAttrExpr
2638 # The `isset` keyword
2639 var n_kwisset
: TKwisset is writable, noinit
2642 # An ellipsis notation used to pass an expression as it, in a vararg parameter
2646 # The passed expression
2647 var n_expr
: AExpr is writable, noinit
2650 var n_dotdotdot
: TDotdotdot is writable, noinit
2653 # An named notation used to pass an expression by name in a parameter
2657 # The name of the argument
2658 var n_id
: TId is writable, noinit
2661 var n_assign
: TAssign is writable, noinit
2663 # The passed expression
2664 var n_expr
: AExpr is writable, noinit
2667 # A list of expression separated with commas (arguments for instance)
2671 # The list of expressions
2672 var n_exprs
= new ANodes[AExpr](self)
2675 # A special expression that encapsulates a static type
2676 # Can only be found in special construction like arguments of annotations.
2680 # The encapsulated type
2681 var n_type
: AType is writable, noinit
2684 # A special expression that encapsulates a method identifier
2685 # Can only be found in special construction like arguments of annotations.
2690 var n_expr
: AExpr is writable, noinit
2692 # The encapsulated method identifier
2693 var n_id
: AMethid is writable, noinit
2696 # A special expression that encapsulate an annotation
2697 # Can only be found in special construction like arguments of annotations.
2699 # The encapsulated annotations are in `n_annotations`
2704 # A special expression to debug types
2705 class ADebugTypeExpr
2708 # The `debug` keyword
2709 var n_kwdebug
: TKwdebug is writable, noinit
2711 # The `type` keyword
2712 var n_kwtype
: TKwtype is writable, noinit
2714 # The expression to check
2715 var n_expr
: AExpr is writable, noinit
2718 var n_type
: AType is writable, noinit
2721 # A list of expression separated with commas (arguments for instance)
2722 abstract class AExprs
2725 # The list of expressions
2726 var n_exprs
= new ANodes[AExpr](self)
2729 # A simple list of expressions
2734 # A list of expressions enclosed in parentheses
2738 # The opening parenthesis
2739 var n_opar
: TOpar is writable, noinit
2741 # The closing parenthesis
2742 var n_cpar
: TCpar is writable, noinit
2745 # A list of expressions enclosed in brackets
2749 # The opening bracket
2750 var n_obra
: TObra is writable, noinit
2752 # The closing bracket
2753 var n_cbra
: TCbra is writable, noinit
2756 # A complex assignment operator. (`+=` and `-=`)
2757 abstract class AAssignOp
2760 # The combined assignment operator
2761 var n_op
: Token is writable, noinit
2763 # The name of the operator without the `=` (eg '+')
2764 fun operator
: String is abstract
2767 # A `+=` assignment operation
2771 redef fun operator
do return "+"
2774 # A `-=` assignment operation
2775 class AMinusAssignOp
2778 redef fun operator
do return "-"
2781 # A `*=` assignment operation
2785 redef fun operator
do return "*"
2788 # A `/=` assignment operation
2789 class ASlashAssignOp
2792 redef fun operator
do return "/"
2795 # A `%=` assignment operation
2796 class APercentAssignOp
2799 redef fun operator
do return "%"
2802 # A `**=` assignment operation
2803 class AStarstarAssignOp
2806 redef fun operator
do return "**"
2809 # A `|=` assignment operation
2813 redef fun operator
do return "|"
2816 # A `^=` assignment operation
2817 class ACaretAssignOp
2820 redef fun operator
do return "^"
2823 # A `&=` assignment operation
2827 redef fun operator
do return "&"
2830 # A `<<=` assignment operation
2834 redef fun operator
do return "<<"
2837 # A `>>=` assignment operation
2841 redef fun operator
do return ">>"
2844 # A possibly fully-qualified module identifier
2848 # The starting quad (`::`)
2849 var n_quad
: nullable TQuad = null is writable
2851 # The list of quad-separated package/group identifiers
2852 var n_path
= new ANodes[TId](self)
2854 # The final module identifier
2855 var n_id
: TId is writable, noinit
2858 # A language declaration for an extern block
2863 var n_kwin
: TKwin is writable, noinit
2866 var n_string
: TString is writable, noinit
2869 # An full extern block
2870 class AExternCodeBlock
2873 # The language declration
2874 var n_in_language
: nullable AInLanguage = null is writable
2876 # The block of extern code
2877 var n_extern_code_segment
: TExternCodeSegment is writable, noinit
2880 # A possible full method qualifier.
2884 # The starting quad (`::`)
2885 var n_quad
: nullable TQuad = null is writable
2887 # The list of quad-separated package/group/module identifiers
2888 var n_id
= new ANodes[TId](self)
2890 # A class identifier
2891 var n_classid
: nullable TClassid = null is writable
2894 # A documentation of a definition
2895 # It contains the block of comments just above the declaration
2899 # A list of lines of comment
2900 var n_comment
= new ANodes[TComment](self)
2903 # A group of annotation on a node
2905 # This same class is used for the 3 kind of annotations:
2907 # * *is* annotations. eg `module foo is bar`.
2908 # * *at* annotations. eg `foo@bar` or `foo@(bar,baz)`.
2909 # * *class* annotations, defined in classes.
2913 # The `is` keyword, for *is* annotations
2914 var n_kwis
: nullable TKwis = null is writable
2916 # The `@` symbol, for *at* annotations
2917 var n_at
: nullable TAt = null is writable
2919 # The opening parenthesis in *at* annotations
2920 var n_opar
: nullable TOpar = null is writable
2922 # The list of annotations
2923 var n_items
= new ANodes[AAnnotation](self)
2925 # The closing parenthesis in *at* annotations
2926 var n_cpar
: nullable TCpar = null is writable
2928 # The `end` keyword, for *is* annotations
2929 var n_kwend
: nullable TKwend = null is writable
2932 # A single annotation
2936 # The name of the annotation
2937 var n_atid
: AAtid is writable, noinit
2939 # The opening parenthesis of the arguments
2940 var n_opar
: nullable TOpar = null is writable
2942 # The list of arguments
2943 var n_args
= new ANodes[AExpr](self)
2945 # The closing parenthesis
2946 var n_cpar
: nullable TCpar = null is writable
2948 # The name of the annotation
2951 return n_atid
.n_id
.text
2955 # An annotation name
2956 abstract class AAtid
2959 # The identifier of the annotation.
2960 # Can be a TId of a keyword
2961 var n_id
: Token is writable, noinit
2964 # An annotation name based on an identifier
2969 # An annotation name based on the keyword `extern`
2974 # An annotation name based on the keyword `import`
2979 # An annotation name based on the keyword `abstract`
2980 class AKwabstractAtid
2984 # The root of the AST
2989 var n_base
: nullable AModule is writable
2991 # The end of file (or error) token
2992 var n_eof
: EOF is writable