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 special keyword `__DEBUG__`
744 # A token associated with an operator (and other lookalike symbols)
745 abstract class TokenOperator
749 return "operator '{text}'"
933 # A class (or formal type) identifier. They start with an uppercase.
938 do return "type identifier '{text}'"
942 # A standard identifier (variable, method...). They start with a lowercase.
947 do return "identifier '{text}'"
951 # An attribute identifier. They start with an underscore.
956 do return "attribute '{text}'"
960 # A token of a literal value (string, integer, etc).
961 abstract class TokenLiteral
965 do return "literal value '{text}'"
974 # A literal floating point number
979 # A literal character
989 # The starting part of a super string (between `"` and `{`)
994 # The middle part of a super string (between `}` and `{`)
999 # The final part of a super string (between `}` and `"`)
1004 # A malformed string
1009 do return "malformed string {text}"
1018 do return "malformed character {text}"
1022 # A extern code block
1023 class TExternCodeSegment
1032 return "end of file"
1036 # A mark of an error
1040 # A lexical error (unexpected character)
1044 # A syntactic error (unexpected token)
1049 # The main node of a Nit source-file
1053 # The declaration part of the module
1054 var n_moduledecl
: nullable AModuledecl = null is writable
1056 # List of importation clauses
1057 var n_imports
= new ANodes[AImport](self)
1059 # List of extern blocks
1060 var n_extern_code_blocks
= new ANodes[AExternCodeBlock](self)
1062 # List of class definition (including top-level methods and the main)
1063 var n_classdefs
= new ANodes[AClassdef](self)
1066 # Abstract class for definition of entities
1067 abstract class ADefinition
1070 var n_doc
: nullable ADoc = null is writable
1072 # The `redef` keyword
1073 var n_kwredef
: nullable TKwredef = null is writable
1075 # The declared visibility
1076 var n_visibility
: nullable AVisibility = null is writable
1079 # The declaration of the module with the documentation, name, and annotations
1083 # The `module` keyword
1084 var n_kwmodule
: TKwmodule is writable, noinit
1086 # The declared module name
1087 var n_name
: AModuleName is writable, noinit
1090 # A import clause of a module
1091 abstract class AImport
1094 # The declared visibility
1095 var n_visibility
: AVisibility is writable, noinit
1097 # The `import` keyword
1098 var n_kwimport
: TKwimport is writable, noinit
1101 # A standard import clause. eg `import x`
1104 # The imported module name
1105 var n_name
: AModuleName is writable, noinit
1108 # The special import clause of the kernel module. eg `import end`
1111 # The `end` keyword, that indicate the root module
1112 var n_kwend
: TKwend is writable, noinit
1115 # A visibility modifier
1117 # The public visibility is an empty production (no keyword).
1119 # Note: even if some visibilities are only valid on some placse (for instance, no `protected` class or no `intrude` method)
1120 # the parser has no such a restriction, therefore the semantic phases has to check that the visibilities make sense.
1121 abstract class AVisibility
1125 # An implicit or explicit public visibility modifier
1126 class APublicVisibility
1128 # The `public` keyword, if any
1129 var n_kwpublic
: nullable TKwpublic = null is writable
1131 # An explicit private visibility modifier
1132 class APrivateVisibility
1134 # The `private` keyword
1135 var n_kwprivate
: TKwprivate is writable, noinit
1137 # An explicit protected visibility modifier
1138 class AProtectedVisibility
1140 # The `protected` keyword
1141 var n_kwprotected
: TKwprotected is writable, noinit
1143 # An explicit intrude visibility modifier
1144 class AIntrudeVisibility
1146 # The `intrude` keyword
1147 var n_kwintrude
: TKwintrude is writable, noinit
1150 # A class definition
1151 # While most definition are `AStdClassdef`
1152 # There is tow special case of class definition
1153 abstract class AClassdef
1155 # All the declared properties (including the main method)
1156 var n_propdefs
= new ANodes[APropdef](self)
1159 # A standard class definition with a name, superclasses and properties
1164 # The class kind (interface, abstract class, etc.)
1165 var n_classkind
: AClasskind is writable, noinit
1167 # The name of the class
1168 var n_qid
: nullable AQclassid = null is writable
1171 var n_obra
: nullable TObra = null is writable
1173 # The list of formal parameter types
1174 var n_formaldefs
= new ANodes[AFormaldef](self)
1177 var n_cbra
: nullable TCbra = null is writable
1179 # The extern block code
1180 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1183 var n_kwend
: TKwend is writable, noinit
1185 fun n_superclasses
: Array[ASuperPropdef] do
1186 return [for d
in n_propdefs
do if d
isa ASuperPropdef then d
]
1189 redef fun hot_location
do return n_qid
.location
1192 # The implicit class definition of the implicit main method
1197 # The implicit class definition of the top-level methods
1202 # The modifier for the kind of class (abstract, interface, etc.)
1203 abstract class AClasskind
1207 # A default, or concrete class modifier (just `class`)
1208 class AConcreteClasskind
1211 # The `class` keyword.
1212 var n_kwclass
: TKwclass is writable, noinit
1215 # An abstract class modifier (`abstract class`)
1216 class AAbstractClasskind
1219 # The `abstract` keyword.
1220 var n_kwabstract
: TKwabstract is writable, noinit
1222 # The `class` keyword.
1223 var n_kwclass
: TKwclass is writable, noinit
1226 # An interface class modifier (`interface`)
1227 class AInterfaceClasskind
1230 # The `interface` keyword.
1231 var n_kwinterface
: TKwinterface is writable, noinit
1234 # An enum/universal class modifier (`enum class`)
1235 class AEnumClasskind
1238 # The `enum` keyword.
1239 var n_kwenum
: TKwenum is writable, noinit
1242 # An extern class modifier (`extern class`)
1243 class AExternClasskind
1246 # The `extern` keyword.
1247 var n_kwextern
: TKwextern is writable, noinit
1249 # The `class` keyword.
1250 var n_kwclass
: nullable TKwclass = null is writable
1253 # The definition of a formal generic parameter type. eg `X: Y`
1257 # The name of the parameter type
1258 var n_id
: TClassid is writable, noinit
1260 # The bound of the parameter type
1261 var n_type
: nullable AType = null is writable
1264 # The definition of a property
1265 abstract class APropdef
1269 # A definition of an attribute
1270 # For historical reason, old-syle and new-style attributes use the same `ANode` sub-class
1275 var n_kwvar
: TKwvar is writable, noinit
1277 # The identifier for a new-style attribute
1278 var n_id2
: TId is writable, noinit
1280 # The declared type of the attribute
1281 var n_type
: nullable AType = null is writable
1284 var n_assign
: nullable TAssign = null is writable
1286 # The initial value, if any (set with `=`)
1287 var n_expr
: nullable AExpr = null is writable
1290 var n_kwdo
: nullable TKwdo = null is writable
1292 # The initial value, if any (set with `do return`)
1293 var n_block
: nullable AExpr = null is writable
1296 var n_kwend
: nullable TKwend = null is writable
1298 redef fun hot_location
1300 return n_id2
.location
1304 # A definition of all kind of method (including constructors)
1308 # The `fun` keyword, if any
1309 var n_kwmeth
: nullable TKwmeth = null is writable
1311 # The `init` keyword, if any
1312 var n_kwinit
: nullable TKwinit = null is writable
1314 # The `new` keyword, if any
1315 var n_kwnew
: nullable TKwnew = null is writable
1317 # The name of the method, if any
1318 var n_methid
: nullable AMethid = null is writable
1320 # The signature of the method, if any
1321 var n_signature
: nullable ASignature = null is writable
1324 var n_kwdo
: nullable TKwdo = null is writable
1326 # The body (in Nit) of the method, if any
1327 var n_block
: nullable AExpr = null is writable
1330 var n_kwend
: nullable TKwend = null is writable
1332 # The list of declared callbacks (for extern methods)
1333 var n_extern_calls
: nullable AExternCalls = null is writable
1335 # The body (in extern code) of the method, if any
1336 var n_extern_code_block
: nullable AExternCodeBlock = null is writable
1338 redef fun hot_location
1340 if n_methid
!= null then
1341 return n_methid
.location
1342 else if n_kwinit
!= null then
1343 return n_kwinit
.location
1344 else if n_kwnew
!= null then
1345 return n_kwnew
.location
1352 # The implicit main method
1353 class AMainMethPropdef
1362 # A super-class. eg `super X`
1367 var n_kwsuper
: TKwsuper is writable, noinit
1369 # The super-class (indicated as a type)
1370 var n_type
: AType is writable, noinit
1374 # Declaration of callbacks for extern methods
1378 # The `import` keyword
1379 var n_kwimport
: TKwimport is writable, noinit
1381 # The list of declared callbacks
1382 var n_extern_calls
: ANodes[AExternCall] = new ANodes[AExternCall](self)
1385 # A single callback declaration
1386 abstract class AExternCall
1390 # A single callback declaration on a method
1391 abstract class APropExternCall
1395 # A single callback declaration on a method on the current receiver
1396 class ALocalPropExternCall
1397 super APropExternCall
1399 # The name of the called-back method
1400 var n_methid
: AMethid is writable, noinit
1403 # A single callback declaration on a method on an explicit receiver type.
1404 class AFullPropExternCall
1405 super APropExternCall
1407 # The type of the receiver of the called-back method
1408 var n_type
: AType is writable, noinit
1411 var n_dot
: nullable TDot = null is writable
1413 # The name of the called-back method
1414 var n_methid
: AMethid is writable, noinit
1417 # A single callback declaration on a method on a constructor
1418 class AInitPropExternCall
1419 super APropExternCall
1421 # The allocated type
1422 var n_type
: AType is writable, noinit
1425 # A single callback declaration on a `super` call
1426 class ASuperExternCall
1429 # The `super` keyword
1430 var n_kwsuper
: TKwsuper is writable, noinit
1433 # A single callback declaration on a cast
1434 abstract class ACastExternCall
1438 # A single callback declaration on a cast to a given type
1439 class ACastAsExternCall
1440 super ACastExternCall
1442 # The origin type of the cast
1443 var n_from_type
: AType is writable, noinit
1446 var n_dot
: nullable TDot = null is writable
1449 var n_kwas
: TKwas is writable, noinit
1451 # The destination of the cast
1452 var n_to_type
: AType is writable, noinit
1455 # A single callback declaration on a cast to a nullable type
1456 class AAsNullableExternCall
1457 super ACastExternCall
1459 # The origin type to cast as nullable
1460 var n_type
: AType is writable, noinit
1463 var n_kwas
: TKwas is writable, noinit
1465 # The `nullable` keyword
1466 var n_kwnullable
: TKwnullable is writable, noinit
1469 # A single callback declaration on a cast to a non-nullable type
1470 class AAsNotNullableExternCall
1471 super ACastExternCall
1473 # The destination type on a cast to not nullable
1474 var n_type
: AType is writable, noinit
1477 var n_kwas
: TKwas is writable, noinit
1480 var n_kwnot
: TKwnot is writable, noinit
1482 # The `nullable` keyword
1483 var n_kwnullable
: TKwnullable is writable, noinit
1486 # A definition of a virtual type
1490 # The `type` keyword
1491 var n_kwtype
: TKwtype is writable, noinit
1493 # The name of the virtual type
1494 var n_qid
: AQclassid is writable, noinit
1496 # The bound of the virtual type
1497 var n_type
: AType is writable, noinit
1500 # The identifier of a method in a method declaration.
1501 # There is a specific class because of operator and setters.
1502 abstract class AMethid
1506 # A method name with a simple identifier
1510 # The simple identifier
1511 var n_id
: TId is writable, noinit
1514 # A method name for an operator
1515 class AOperatorMethid
1518 # The associated operator symbol
1519 var n_op
: Token is writable, noinit
1523 super AOperatorMethid
1528 super AOperatorMethid
1533 super AOperatorMethid
1536 # A method name `**`
1537 class AStarstarMethid
1538 super AOperatorMethid
1543 super AOperatorMethid
1547 class APercentMethid
1548 super AOperatorMethid
1553 super AOperatorMethid
1558 super AOperatorMethid
1563 super AOperatorMethid
1568 super AOperatorMethid
1571 # A method name `==`
1573 super AOperatorMethid
1576 # A method name `!=`
1578 super AOperatorMethid
1581 # A method name `<=`
1583 super AOperatorMethid
1586 # A method name `>=`
1588 super AOperatorMethid
1593 super AOperatorMethid
1598 super AOperatorMethid
1601 # A method name `<<`
1603 super AOperatorMethid
1606 # A method name `>>`
1608 super AOperatorMethid
1611 # A method name `<=>`
1612 class AStarshipMethid
1613 super AOperatorMethid
1616 # A method name `[]`
1621 var n_obra
: TObra is writable, noinit
1624 var n_cbra
: TCbra is writable, noinit
1627 # A setter method name with a simple identifier (with a `=`)
1631 # The base identifier
1632 var n_id
: TId is writable, noinit
1635 var n_assign
: TAssign is writable, noinit
1638 # A method name `[]=`
1639 class ABraassignMethid
1643 var n_obra
: TObra is writable, noinit
1646 var n_cbra
: TCbra is writable, noinit
1649 var n_assign
: TAssign is writable, noinit
1652 # A potentially qualified simple identifier `foo::bar::baz`
1655 # The qualifier, if any
1656 var n_qualified
: nullable AQualified = null is writable
1658 # The final identifier
1659 var n_id
: TId is writable, noinit
1662 # A potentially qualified class identifier `foo::bar::Baz`
1665 # The qualifier, if any
1666 var n_qualified
: nullable AQualified = null is writable
1668 # The final identifier
1669 var n_id
: TClassid is writable, noinit
1672 # A signature in a method definition. eg `(x,y:X,z:Z):T`
1677 var n_opar
: nullable TOpar = null is writable
1679 # The list of parameters
1680 var n_params
= new ANodes[AParam](self)
1683 var n_cpar
: nullable TCpar = null is writable
1686 var n_type
: nullable AType = null is writable
1689 # A parameter definition in a signature. eg `x:X`
1693 # The name of the parameter
1694 var n_id
: TId is writable, noinit
1696 # The type of the parameter, if any
1697 var n_type
: nullable AType = null is writable
1699 # The `...` symbol to indicate varargs
1700 var n_dotdotdot
: nullable TDotdotdot = null is writable
1703 # A static type. eg `nullable X[Y]`
1706 # The `nullable` keyword
1707 var n_kwnullable
: nullable TKwnullable = null is writable
1709 # The name of the class or of the formal type
1710 var n_qid
: AQclassid is writable, noinit
1712 # The opening bracket
1713 var n_obra
: nullable TObra = null is writable
1715 # Type arguments for a generic type
1716 var n_types
= new ANodes[AType](self)
1718 # The closing bracket
1719 var n_cbra
: nullable TCbra = null is writable
1722 # A label at the end of a block or in a break/continue statement. eg `label x`
1726 # The `label` keyword
1727 var n_kwlabel
: TKwlabel is writable, noinit
1729 # The name of the label, if any
1730 var n_id
: nullable TId is writable, noinit
1733 # Expression and statements
1734 # From a AST point of view there is no distinction between statement and expressions (even if the parser has to distinguish them)
1735 abstract class AExpr
1739 # A sequence of `AExpr` (usually statements)
1740 # The last `AExpr` gives the value of the whole block
1744 # The list of statements in the bloc.
1745 # The last element is often considered as an expression that give the value of the whole block.
1746 var n_expr
= new ANodes[AExpr](self)
1749 var n_kwend
: nullable TKwend = null is writable
1752 # A declaration of a local variable. eg `var x: X = y`
1757 var n_kwvar
: nullable TKwvar = null is writable
1759 # The name of the local variable
1760 var n_id
: TId is writable, noinit
1762 # The declaration type of the local variable
1763 var n_type
: nullable AType = null is writable
1765 # The `=` symbol (for the initial value)
1766 var n_assign
: nullable TAssign = null is writable
1768 # The initial value, if any
1769 var n_expr
: nullable AExpr = null is writable
1772 # A `return` statement. eg `return x`
1776 # The `return` keyword
1777 var n_kwreturn
: nullable TKwreturn = null is writable
1779 # The return value, if any
1780 var n_expr
: nullable AExpr = null is writable
1783 # Something that has a label.
1784 abstract class ALabelable
1787 # The associated label declatation
1788 var n_label
: nullable ALabel = null is writable
1791 # A `break` or a `continue`
1792 abstract class AEscapeExpr
1796 # The return value, if nay (unused currently)
1797 var n_expr
: nullable AExpr = null is writable
1800 # A `break` statement.
1804 # The `break` keyword
1805 var n_kwbreak
: TKwbreak is writable, noinit
1808 # An `abort` statement
1812 # The `abort` keyword
1813 var n_kwabort
: TKwabort is writable, noinit
1816 # A `continue` statement
1820 # The `continue` keyword.
1821 var n_kwcontinue
: nullable TKwcontinue = null is writable
1830 var n_kwdo
: TKwdo is writable, noinit
1832 # The list of statements of the `do`.
1833 var n_block
: nullable AExpr = null is writable
1841 var n_kwif
: TKwif is writable, noinit
1843 # The expression used as the condition of the `if`
1844 var n_expr
: AExpr is writable, noinit
1846 # The `then` keyword
1847 var n_kwthen
: TKwthen is writable, noinit
1849 # The body of the `then` part
1850 var n_then
: nullable AExpr = null is writable
1852 # The `else` keyword
1853 var n_kwelse
: nullable TKwelse = null is writable
1855 # The body of the `else` part
1856 var n_else
: nullable AExpr = null is writable
1859 # A `if` expression (ternary conditional). eg. `if true then 1 else 0`
1864 var n_kwif
: TKwif is writable, noinit
1866 # The expression used as the condition of the `if`
1867 var n_expr
: AExpr is writable, noinit
1869 # The `then` keyword
1870 var n_kwthen
: TKwthen is writable, noinit
1872 # The expression in the `then` part
1873 var n_then
: AExpr is writable, noinit
1875 # The `else` keyword
1876 var n_kwelse
: TKwelse is writable, noinit
1878 # The expression in the `else` part
1879 var n_else
: AExpr is writable, noinit
1882 # A `while` statement
1887 # The `while` keyword
1888 var n_kwwhile
: TKwwhile is writable, noinit
1890 # The expression used as the condition of the `while`
1891 var n_expr
: AExpr is writable, noinit
1894 var n_kwdo
: TKwdo is writable, noinit
1896 # The body of the loop
1897 var n_block
: nullable AExpr = null is writable
1900 # A `loop` statement
1905 # The `loop` keyword
1906 var n_kwloop
: TKwloop is writable, noinit
1908 # The body of the loop
1909 var n_block
: nullable AExpr = null is writable
1918 var n_kwfor
: TKwfor is writable, noinit
1920 # The list of groups to iterate
1921 var n_groups
= new ANodes[AForGroup](self)
1924 var n_kwdo
: TKwdo is writable, noinit
1926 # The body of the loop
1927 var n_block
: nullable AExpr = null is writable
1930 # A collection iterated by a for, its automatic variables and its implicit iterator.
1932 # Standard `for` iterate on a single collection.
1933 # Multiple `for` can iterate on more than one collection at once.
1937 # The list of name of the automatic variables
1938 var n_ids
= new ANodes[TId](self)
1941 var n_kwin
: TKwin is writable, noinit
1943 # The expression used as the collection to iterate on
1944 var n_expr
: AExpr is writable, noinit
1947 # A `with` statement
1952 # The `with` keyword
1953 var n_kwwith
: TKwwith is writable, noinit
1955 # The expression used to get the value to control
1956 var n_expr
: AExpr is writable, noinit
1959 var n_kwdo
: TKwdo is writable, noinit
1961 # The body of the loop
1962 var n_block
: nullable AExpr = null is writable
1965 # An `assert` statement
1969 # The `assert` keyword
1970 var n_kwassert
: TKwassert is writable, noinit
1972 # The name of the assert, if any
1973 var n_id
: nullable TId = null is writable
1975 # The expression used as the condition of the `assert`
1976 var n_expr
: AExpr is writable, noinit
1978 # The `else` keyword
1979 var n_kwelse
: nullable TKwelse = null is writable
1981 # The body to execute when the assert fails
1982 var n_else
: nullable AExpr = null is writable
1985 # Whatever is a simple assignment. eg `= something`
1986 abstract class AAssignFormExpr
1990 var n_assign
: TAssign is writable, noinit
1992 # The right-value to assign.
1993 var n_value
: AExpr is writable, noinit
1996 # Whatever is a combined assignment. eg `+= something`
1997 abstract class AReassignFormExpr
2000 # The combined operator (eg. `+=`)
2001 var n_assign_op
: AAssignOp is writable, noinit
2003 # The right-value to apply on the combined operator.
2004 var n_value
: AExpr is writable, noinit
2007 # A `once` expression. eg `once x`
2011 # The `once` keyword
2012 var n_kwonce
: TKwonce is writable, noinit
2014 # The expression to evaluate only one time
2015 var n_expr
: AExpr is writable, noinit
2018 # A polymorphic invocation of a method
2019 # The form of the invocation (name, arguments, etc.) are specific
2020 abstract class ASendExpr
2022 # The receiver of the method invocation
2023 var n_expr
: AExpr is writable, noinit
2026 # A binary operation on a method
2027 abstract class ABinopExpr
2031 var n_op
: Token is writable, noinit
2033 # The second operand of the operation
2034 # Note: the receiver (`n_expr`) is the first operand
2035 var n_expr2
: AExpr is writable, noinit
2037 # The name of the operator (eg '+')
2038 fun operator
: String is abstract
2041 # Something that is boolean expression
2042 abstract class ABoolExpr
2046 # Something that is binary boolean expression
2047 abstract class ABinBoolExpr
2050 # The first boolean operand
2051 var n_expr
: AExpr is writable, noinit
2054 var n_op
: Token is writable, noinit
2056 # The second boolean operand
2057 var n_expr2
: AExpr is writable, noinit
2065 # A `and` expression
2070 # A `or else` expression
2074 # The `else` keyword
2075 var n_kwelse
: TKwelse is writable, noinit
2078 # A `implies` expression
2083 # A `not` expression
2088 var n_kwnot
: TKwnot is writable, noinit
2090 # The boolean operand of the `not`
2091 var n_expr
: AExpr is writable, noinit
2094 # A `==` or a `!=` expression
2096 # Both have a similar effect on adaptive typing, so this class factorizes the common behavior.
2104 redef fun operator
do return "=="
2110 redef fun operator
do return "!="
2116 redef fun operator
do return "<"
2122 redef fun operator
do return "<="
2128 redef fun operator
do return "<<"
2134 redef fun operator
do return ">"
2140 redef fun operator
do return ">="
2146 redef fun operator
do return ">>"
2149 # A type-ckeck expression. eg `x isa T`
2153 # The expression to check
2154 var n_expr
: AExpr is writable, noinit
2157 var n_kwisa
: TKwisa is writable, noinit
2159 # The destination type to check to
2160 var n_type
: AType is writable, noinit
2166 redef fun operator
do return "+"
2172 redef fun operator
do return "-"
2175 # A `<=>` expression
2178 redef fun operator
do return "<=>"
2184 redef fun operator
do return "*"
2190 redef fun operator
do return "**"
2196 redef fun operator
do return "/"
2202 redef fun operator
do return "%"
2208 redef fun operator
do return "|"
2214 redef fun operator
do return "^"
2220 redef fun operator
do return "&"
2223 # A unary operation on a method
2224 abstract class AUnaryopExpr
2228 var n_op
: Token is writable, noinit
2230 # The name of the operator (eg '+')
2231 fun operator
: String is abstract
2234 # A unary minus expression. eg `-x`
2237 redef fun operator
do return "-"
2240 # A unary plus expression. eg `+x`
2243 redef fun operator
do return "+"
2246 # A unary `~` expression
2249 redef fun operator
do return "~"
2252 # An explicit instantiation. eg `new T`
2257 var n_kwnew
: TKwnew is writable, noinit
2259 # The `type` keyword
2260 var n_type
: AType is writable, noinit
2262 # The name of the named-constructor, if any
2263 var n_qid
: nullable AQid = null is writable
2265 # The arguments of the `new`
2266 var n_args
: AExprs is writable, noinit
2269 # Whatever is a old-style attribute access
2270 abstract class AAttrFormExpr
2273 # The receiver of the attribute
2274 var n_expr
: AExpr is writable, noinit
2276 # The name of the attribute
2277 var n_id
: TAttrid is writable, noinit
2281 # The read of an attribute. eg `x._a`
2286 # The assignment of an attribute. eg `x._a=y`
2287 class AAttrAssignExpr
2289 super AAssignFormExpr
2292 # Whatever looks-like a call with a standard method and any number of arguments.
2293 abstract class ACallFormExpr
2296 # The name of the method
2297 var n_qid
: AQid is writable, noinit
2299 # The arguments of the call
2300 var n_args
: AExprs is writable, noinit
2303 # A complex setter call (standard or brackets)
2304 abstract class ASendReassignFormExpr
2306 super AReassignFormExpr
2309 # A complex attribute assignment. eg `x._a+=y`
2310 class AAttrReassignExpr
2312 super AReassignFormExpr
2315 # A call with a standard method-name and any number of arguments. eg `x.m(y)`. OR just a simple id
2316 # 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`.
2317 # Semantic analysis have to transform them to instance of `AVarExpr`.
2322 # A setter call with a standard method-name and any number of arguments. eg `x.m(y)=z`. OR just a simple assignment.
2323 # 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`.
2324 # Semantic analysis have to transform them to instance of `AVarAssignExpr`.
2325 class ACallAssignExpr
2327 super AAssignFormExpr
2330 # 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.
2331 # 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`.
2332 # Semantic analysis have to transform them to instance of `AVarReassignExpr`.
2333 class ACallReassignExpr
2335 super ASendReassignFormExpr
2338 # A call to `super`. OR a call of a super-constructor
2342 # The qualifier part before the super (currenlty unused)
2343 var n_qualified
: nullable AQualified = null is writable
2345 # The `super` keyword
2346 var n_kwsuper
: TKwsuper is writable, noinit
2348 # The arguments of the super
2349 var n_args
: AExprs is writable, noinit
2352 # A call to the `init` constructor.
2353 # Note: because `init` is a keyword and not a `TId`, the explicit call to init cannot be a `ACallFormExpr`.
2357 # The `init` keyword
2358 var n_kwinit
: TKwinit is writable, noinit
2360 # The arguments of the init
2361 var n_args
: AExprs is writable, noinit
2364 # Whatever looks-like a call of the brackets `[]` operator.
2365 abstract class ABraFormExpr
2368 # The arguments inside the brackets
2369 var n_args
: AExprs is writable, noinit
2372 # A call of the brackets operator. eg `x[y,z]`
2377 # A setter call of the bracket operator. eg `x[y,z]=t`
2378 class ABraAssignExpr
2380 super AAssignFormExpr
2383 # Whatever is an access to a local variable
2384 abstract class AVarFormExpr
2387 # The name of the attribute
2388 var n_id
: TId is writable, noinit
2391 # A complex setter call of the bracket operator. eg `x[y,z]+=t`
2392 class ABraReassignExpr
2394 super ASendReassignFormExpr
2397 # A local variable read access.
2398 # The parser cannot instantiate them, see `ACallExpr`.
2403 # A local variable simple assignment access
2404 # The parser cannot instantiate them, see `ACallAssignExpr`.
2405 class AVarAssignExpr
2407 super AAssignFormExpr
2410 # A local variable complex assignment access
2411 # The parser cannot instantiate them, see `ACallReassignExpr`.
2412 class AVarReassignExpr
2414 super AReassignFormExpr
2417 # A literal range, open or closed
2418 abstract class ARangeExpr
2421 # The left (lower) element of the range
2422 var n_expr
: AExpr is writable, noinit
2425 var n_dotdot
: TDotdot is writable, noinit
2427 # The right (upper) element of the range
2428 var n_expr2
: AExpr is writable, noinit
2431 # A closed literal range. eg `[x..y]`
2435 # The opening bracket `[`
2436 var n_obra
: TObra is writable, noinit
2438 # The closing bracket `]`
2439 var n_cbra
: TCbra is writable, noinit
2442 # An open literal range. eg `[x..y[`
2446 # The opening bracket `[`
2447 var n_obra
: TObra is writable, noinit
2449 # The closing bracket `[` (because open range)
2450 var n_cbra
: TObra is writable, noinit
2453 # A literal array. eg. `[x,y,z]`
2457 # The opening bracket `[`
2458 var n_obra
: TObra is writable, noinit
2460 # The elements of the array
2461 var n_exprs
= new ANodes[AExpr](self)
2463 # The type of the element of the array (if any)
2464 var n_type
: nullable AType = null is writable
2466 # The closing bracket `]`
2467 var n_cbra
: TCbra is writable, noinit
2474 # The `self` keyword
2475 var n_kwself
: nullable TKwself = null is writable
2478 # When there is no explicit receiver, `self` is implicit
2479 class AImplicitSelfExpr
2483 # A `true` boolean literal constant
2487 # The `true` keyword
2488 var n_kwtrue
: TKwtrue is writable, noinit
2491 # A `false` boolean literal constant
2495 # The `false` keyword
2496 var n_kwfalse
: TKwfalse is writable, noinit
2499 # A `null` literal constant
2503 # The `null` keyword
2504 var n_kwnull
: TKwnull is writable, noinit
2507 # An integer literal
2512 var n_integer
: TInteger is writable, noinit
2520 var n_float
: TFloat is writable, noinit
2523 # A character literal
2527 # The character token
2528 var n_char
: TChar is writable, noinit
2532 abstract class AStringFormExpr
2536 var n_string
: Token is writable, noinit
2539 # A simple string. eg. `"abc"`
2541 super AStringFormExpr
2544 # The start of a superstring. eg `"abc{`
2545 class AStartStringExpr
2546 super AStringFormExpr
2549 # The middle of a superstring. eg `}abc{`
2550 class AMidStringExpr
2551 super AStringFormExpr
2554 # The end of a superstrng. eg `}abc"`
2555 class AEndStringExpr
2556 super AStringFormExpr
2559 # A superstring literal. eg `"a{x}b{y}c"`
2560 # Each part is modeled a sequence of expression. eg. `["a{, x, }b{, y, }c"]`
2561 class ASuperstringExpr
2564 # The list of the expressions of the superstring
2565 var n_exprs
= new ANodes[AExpr](self)
2568 # A simple parenthesis. eg `(x)`
2572 # The opening parenthesis
2573 var n_opar
: TOpar is writable, noinit
2575 # The inner expression
2576 var n_expr
: AExpr is writable, noinit
2578 # The closing parenthesis
2579 var n_cpar
: TCpar is writable, noinit
2582 # A cast, against a type or `not null`
2586 # The expression to cast
2587 var n_expr
: AExpr is writable, noinit
2590 var n_kwas
: TKwas is writable, noinit
2592 # The opening parenthesis
2593 var n_opar
: nullable TOpar = null is writable
2595 # The closing parenthesis
2596 var n_cpar
: nullable TCpar = null is writable
2599 # A type cast. eg `x.as(T)`
2603 # The target type to cast to
2604 var n_type
: AType is writable, noinit
2607 # A as-not-null cast. eg `x.as(not null)`
2608 class AAsNotnullExpr
2612 var n_kwnot
: TKwnot is writable, noinit
2614 # The `null` keyword
2615 var n_kwnull
: TKwnull is writable, noinit
2618 # A is-set check of old-style attributes. eg `isset x._a`
2619 class AIssetAttrExpr
2622 # The `isset` keyword
2623 var n_kwisset
: TKwisset is writable, noinit
2626 # An ellipsis notation used to pass an expression as it, in a vararg parameter
2630 # The passed expression
2631 var n_expr
: AExpr is writable, noinit
2634 var n_dotdotdot
: TDotdotdot is writable, noinit
2637 # An named notation used to pass an expression by name in a parameter
2641 # The name of the argument
2642 var n_id
: TId is writable, noinit
2645 var n_assign
: TAssign is writable, noinit
2647 # The passed expression
2648 var n_expr
: AExpr is writable, noinit
2651 # A list of expression separated with commas (arguments for instance)
2655 # The list of expressions
2656 var n_exprs
= new ANodes[AExpr](self)
2659 # A special expression that encapsulates a static type
2660 # Can only be found in special construction like arguments of annotations.
2664 # The encapsulated type
2665 var n_type
: AType is writable, noinit
2668 # A special expression that encapsulates a method identifier
2669 # Can only be found in special construction like arguments of annotations.
2674 var n_expr
: AExpr is writable, noinit
2676 # The encapsulated method identifier
2677 var n_id
: AMethid is writable, noinit
2680 # A special expression that encapsulate an annotation
2681 # Can only be found in special construction like arguments of annotations.
2683 # The encapsulated annotations are in `n_annotations`
2688 # A special expression to debug types
2689 class ADebugTypeExpr
2692 # The `debug` keyword
2693 var n_kwdebug
: TKwdebug is writable, noinit
2695 # The `type` keyword
2696 var n_kwtype
: TKwtype is writable, noinit
2698 # The expression to check
2699 var n_expr
: AExpr is writable, noinit
2702 var n_type
: AType is writable, noinit
2705 # A list of expression separated with commas (arguments for instance)
2706 abstract class AExprs
2709 # The list of expressions
2710 var n_exprs
= new ANodes[AExpr](self)
2713 # A simple list of expressions
2718 # A list of expressions enclosed in parentheses
2722 # The opening parenthesis
2723 var n_opar
: TOpar is writable, noinit
2725 # The closing parenthesis
2726 var n_cpar
: TCpar is writable, noinit
2729 # A list of expressions enclosed in brackets
2733 # The opening bracket
2734 var n_obra
: TObra is writable, noinit
2736 # The closing bracket
2737 var n_cbra
: TCbra is writable, noinit
2740 # A complex assignment operator. (`+=` and `-=`)
2741 abstract class AAssignOp
2744 # The combined assignment operator
2745 var n_op
: Token is writable, noinit
2747 # The name of the operator without the `=` (eg '+')
2748 fun operator
: String is abstract
2751 # A `+=` assignment operation
2755 redef fun operator
do return "+"
2758 # A `-=` assignment operation
2759 class AMinusAssignOp
2762 redef fun operator
do return "-"
2765 # A `*=` assignment operation
2769 redef fun operator
do return "*"
2772 # A `/=` assignment operation
2773 class ASlashAssignOp
2776 redef fun operator
do return "/"
2779 # A `%=` assignment operation
2780 class APercentAssignOp
2783 redef fun operator
do return "%"
2786 # A `**=` assignment operation
2787 class AStarstarAssignOp
2790 redef fun operator
do return "**"
2793 # A `|=` assignment operation
2797 redef fun operator
do return "|"
2800 # A `^=` assignment operation
2801 class ACaretAssignOp
2804 redef fun operator
do return "^"
2807 # A `&=` assignment operation
2811 redef fun operator
do return "&"
2814 # A `<<=` assignment operation
2818 redef fun operator
do return "<<"
2821 # A `>>=` assignment operation
2825 redef fun operator
do return ">>"
2828 # A possibly fully-qualified module identifier
2832 # The starting quad (`::`)
2833 var n_quad
: nullable TQuad = null is writable
2835 # The list of quad-separated package/group identifiers
2836 var n_path
= new ANodes[TId](self)
2838 # The final module identifier
2839 var n_id
: TId is writable, noinit
2842 # A language declaration for an extern block
2847 var n_kwin
: TKwin is writable, noinit
2850 var n_string
: TString is writable, noinit
2853 # An full extern block
2854 class AExternCodeBlock
2857 # The language declration
2858 var n_in_language
: nullable AInLanguage = null is writable
2860 # The block of extern code
2861 var n_extern_code_segment
: TExternCodeSegment is writable, noinit
2864 # A possible full method qualifier.
2868 # The starting quad (`::`)
2869 var n_quad
: nullable TQuad = null is writable
2871 # The list of quad-separated package/group/module identifiers
2872 var n_id
= new ANodes[TId](self)
2874 # A class identifier
2875 var n_classid
: nullable TClassid = null is writable
2878 # A documentation of a definition
2879 # It contains the block of comments just above the declaration
2883 # A list of lines of comment
2884 var n_comment
= new ANodes[TComment](self)
2887 # A group of annotation on a node
2889 # This same class is used for the 3 kind of annotations:
2891 # * *is* annotations. eg `module foo is bar`.
2892 # * *at* annotations. eg `foo@bar` or `foo@(bar,baz)`.
2893 # * *class* annotations, defined in classes.
2897 # The `is` keyword, for *is* annotations
2898 var n_kwis
: nullable TKwis = null is writable
2900 # The `@` symbol, for *at* annotations
2901 var n_at
: nullable TAt = null is writable
2903 # The opening parenthesis in *at* annotations
2904 var n_opar
: nullable TOpar = null is writable
2906 # The list of annotations
2907 var n_items
= new ANodes[AAnnotation](self)
2909 # The closing parenthesis in *at* annotations
2910 var n_cpar
: nullable TCpar = null is writable
2912 # The `end` keyword, for *is* annotations
2913 var n_kwend
: nullable TKwend = null is writable
2916 # A single annotation
2920 # The name of the annotation
2921 var n_atid
: AAtid is writable, noinit
2923 # The opening parenthesis of the arguments
2924 var n_opar
: nullable TOpar = null is writable
2926 # The list of arguments
2927 var n_args
= new ANodes[AExpr](self)
2929 # The closing parenthesis
2930 var n_cpar
: nullable TCpar = null is writable
2932 # The name of the annotation
2935 return n_atid
.n_id
.text
2939 # An annotation name
2940 abstract class AAtid
2943 # The identifier of the annotation.
2944 # Can be a TId of a keyword
2945 var n_id
: Token is writable, noinit
2948 # An annotation name based on an identifier
2953 # An annotation name based on the keyword `extern`
2958 # An annotation name based on the keyword `import`
2963 # An annotation name based on the keyword `abstract`
2964 class AKwabstractAtid
2968 # The root of the AST
2973 var n_base
: nullable AModule is writable
2975 # The end of file (or error) token
2976 var n_eof
: EOF is writable