X-Git-Url: http://nitlanguage.org diff --git a/src/parser/parser_nodes.nit b/src/parser/parser_nodes.nit index 41ac8ca..10e732a 100644 --- a/src/parser/parser_nodes.nit +++ b/src/parser/parser_nodes.nit @@ -17,14 +17,14 @@ module parser_nodes import location +import ordered_tree +private import console # Root of the AST class-hierarchy abstract class ANode - var _location: nullable Location = null - - # Location is set during AST building. Once built, location cannon be null. + # Location is set during AST building. Once built, location can not be null. # However, manual instantiated nodes may need more care. - fun location: Location do return _location.as(not null) + var location: Location is writable, noinit # The location of the important part of the node (identifier or whatever) fun hot_location: Location do return location @@ -32,20 +32,91 @@ abstract class ANode # Display a message for the colored location of the node fun debug(message: String) do - print "{hot_location} {self.class_name}: {message}\n{hot_location.colored_line("0;32")}" + sys.stderr.write "{hot_location} {self.class_name}: {message}\n{hot_location.colored_line("0;32")}\n" + end + + # Is `self` a token or a pure-structural production like `AQId`? + fun is_structural: Bool do return false + + # Write the subtree on stdout. + # + # Visit the subtree and display it with additional and useful information. + # + # By default, this displays all kind of nodes and the corresponding lines of codes. + # + # See `ASTDump` for details. + fun dump_tree(display_structural, display_line: nullable Bool) + do + var d = new ASTDump(display_structural or else true, display_line or else true) + d.enter_visit(self) + d.write_to(sys.stdout) end + # Information to display on a node + # + # Refine this method to add additional information on each node type. + fun dump_info(v: ASTDump): String do return "" + # Parent of the node in the AST var parent: nullable ANode = null - # Protect form invalid instantiation of nodes - private init do end + # The topmost ancestor of the element + # This just apply `parent` until the first one + fun root: ANode + do + var res = self + loop + var p = res.parent + if p == null then return res + res = p + end + end + + # The most specific common parent between `self` and `other` + # Return null if the two node are unrelated (distinct root) + fun common_parent(other: ANode): nullable ANode + do + # First, get the same depth + var s: nullable ANode = self + var o: nullable ANode = other + var d = s.depth - o.depth + while d > 0 do + s = s.parent + d -= 1 + end + while d < 0 do + o = o.parent + d += 1 + end + assert o.depth == s.depth + # Second, go up until same in found + while s != o do + s = s.parent + o = o.parent + end + return s + end + + # Number of nodes between `self` and the `root` of the AST + # ENSURE `self == self.root implies result == 0 ` + # ENSURE `self != self.root implies result == self.parent.depth + 1` + fun depth: Int + do + var n = self + var res = 0 + loop + var p = n.parent + if p == null then return res + n = p + res += 1 + end + end # Replace a child with an other node in the AST private fun replace_child(old_child: ANode, new_child: nullable ANode) is abstract # Detach a node from its parent - # Aborts if the node is not detashable. use `replace_with` instead + # Aborts if the node is not detachable. use `replace_with` instead # REQUIRE: parent != null # REQUIRE: is_detachable # ENDURE: parent == null @@ -70,15 +141,118 @@ abstract class ANode # Visit all nodes in order. # Thus, call `v.enter_visit(e)` for each child `e` fun visit_all(v: Visitor) is abstract + + # Do a deep search and return an array of tokens that match a given text + fun collect_tokens_by_text(text: String): Array[Token] + do + var v = new CollectTokensByTextVisitor(text) + v.enter_visit(self) + return v.result + end + + # Do a deep search and return an array of node that are annotated + # The attached node can be retrieved by two invocations of parent + fun collect_annotations_by_name(name: String): Array[AAnnotation] + do + var v = new CollectAnnotationsByNameVisitor(name) + v.enter_visit(self) + return v.result + end +end + +private class CollectTokensByTextVisitor + super Visitor + var text: String + var result = new Array[Token] + redef fun visit(node) + do + node.visit_all(self) + if node isa Token and node.text == text then result.add(node) + end +end + +private class CollectAnnotationsByNameVisitor + super Visitor + var name: String + var result = new Array[AAnnotation] + redef fun visit(node) + do + node.visit_all(self) + if node isa AAnnotation and node.n_atid.n_id.text == name then result.add(node) + end +end + +# A helper class to handle (print) Nit AST as an OrderedTree +class ASTDump + super Visitor + super OrderedTree[ANode] + + # Reference to the last parent in the Ordered Tree + # Is used to handle the initial node parent and workaround possible inconsistent `ANode::parent` + private var last_parent: nullable ANode = null + + # Display tokens and structural production? + # + # Should tokens (and structural production like AQId) be displayed? + var display_structural: Bool + + # Display lines? + # + # Should each new line be displayed (numbered and in gray)? + var display_line: Bool + + # Current line number (when printing lines) + private var line = 0 + + redef fun visit(n) + do + if not display_structural and n.is_structural then return + var p = last_parent + add(p, n) + last_parent = n + n.visit_all(self) + last_parent = p + end + + redef fun write_line(o, n, p) + do + if display_line then + var ls = n.location.line_start + var file = n.location.file + var line = self.line + if ls > line and file != null then + if line == 0 then line = ls - 1 + while line < ls do + line += 1 + o.write "{line}\t{file.get_line(line)}\n".light_gray + end + self.line = ls + end + end + + super + end + + redef fun display(n) + do + return "{n.class_name} {n.dump_info(self)} @{n.location}" + end + + # `s` as yellow + fun yellow(s: String): String do return s.yellow + + # `s` as red + fun red(s: String): String do return s.red end # A sequence of nodes -# There is a specifc class (instead of a using Array) to track the parent/child relation when nodes are added or removed +# It is a specific class (instead of using a Array) to track the parent/child relation when nodes are added or removed class ANodes[E: ANode] super Sequence[E] private var parent: ANode private var items = new Array[E] redef fun iterator do return items.iterator + redef fun reverse_iterator do return items.reverse_iterator redef fun length do return items.length redef fun is_empty do return items.is_empty redef fun push(e) @@ -132,6 +306,40 @@ class ANodes[E: ANode] assert e.parent == parent e.parent = null end + + # Used in parent constructor to fill elements + private fun unsafe_add_all(nodes: Collection[Object]) + do + var parent = self.parent + for n in nodes do + assert n isa E + add n + n.parent = parent + end + end + + private fun replace_child(old_child: ANode, new_child: nullable ANode): Bool + do + var parent = self.parent + for i in [0..length[ do + if self[i] == old_child then + if new_child != null then + assert new_child isa E + self[i] = new_child + new_child.parent = parent + else + self.remove_at(i) + end + return true + end + end + return false + end + + private fun visit_all(v: Visitor) + do + for n in self do v.enter_visit(n) + end end # Ancestor of all tokens @@ -141,15 +349,59 @@ abstract class Token # The raw content on the token fun text: String is abstract + + # The raw content on the token fun text=(text: String) is abstract # The previous token in the Lexer. - # May have disapeared in the AST - var prev_token: nullable Token + # May have disappeared in the AST + var prev_token: nullable Token = null # The next token in the Lexer. - # May have disapeared in the AST - var next_token: nullable Token + # May have disappeared in the AST + var next_token: nullable Token = null + + # Is `self` a token discarded from the AST? + # + # Loose tokens are not present in the AST. + # It means they were identified by the lexer but were discarded by the parser. + # It also means that they are not visited or manipulated by AST-related functions. + # + # Each loose token is attached to the non-loose token that precedes or follows it. + # The rules are the following: + # + # * tokens that follow a non-loose token on a same line are attached to it. + # See `next_looses`. + # * other tokens, thus that precede a non-loose token on the same line or the next one, + # are attached to this one. See `prev_looses`. + # + # Loose tokens are mostly end of lines (`TEol`) and comments (`TComment`). + # Whitespace are ignored by the lexer, so they are not even considered as loose tokens. + # See `blank_before` to get the whitespace that separate tokens. + var is_loose = false + + redef fun is_structural do return true + + redef fun dump_info(v) do return " {text.escape_to_c}" + + # Loose tokens that precede `self`. + # + # These tokens start the line or belong to a line with only loose tokens. + var prev_looses = new Array[Token] is lazy + + # Loose tokens that follow `self` + # + # These tokens are on the same line than `self`. + var next_looses = new Array[Token] is lazy + + # The verbatim blank text between `prev_token` and `self` + fun blank_before: String + do + if prev_token == null then return "" + var from = prev_token.location.pend+1 + var to = location.pstart + return location.file.string.substring(from,to-from) + end redef fun to_s: String do return "'{text}'" @@ -159,21 +411,49 @@ abstract class Token redef fun replace_child(old_child: ANode, new_child: nullable ANode) do end end +redef class SourceFile + # The first token parser by the lexer + # May have disappeared in the final AST + var first_token: nullable Token = null + + # The first token parser by the lexer + # May have disappeared in the final AST + var last_token: nullable Token = null +end + # Ancestor of all productions # A production is a node without text but that usually has children. abstract class Prod super ANode - fun location=(l: Location) do _location = l - # All the annotations attached directly to the node - readable writable var _n_annotations: nullable AAnnotations = null + var n_annotations: nullable AAnnotations = null is writable + + # Return all its annotations of a given name in the order of their declaration + # Retun an empty array if no such an annotation. + fun get_annotations(name: String): Array[AAnnotation] + do + var res = new Array[AAnnotation] + var nas = n_annotations + if nas != null then for na in nas.n_items do + if na.name != name then continue + res.add(na) + end + if self isa AClassdef then for na in n_propdefs do + if na isa AAnnotPropdef then + if na.name != name then continue + res.add na + end + end + + return res + end redef fun replace_with(n: ANode) do super assert n isa Prod - if n._location == null then n._location = _location + if not isset n._location and isset _location then n._location = _location end end @@ -197,7 +477,7 @@ abstract class Visitor end # The current visited node - readable writable var _current_node: nullable ANode = null + var current_node: nullable ANode = null is writable end # Token of end of line (basically `\n`) @@ -223,180 +503,308 @@ abstract class TokenKeyword return "keyword '{text}'" end end + +# The deprecated keyword `package`. class TKwpackage super TokenKeyword end + +# The keyword `module` class TKwmodule super TokenKeyword end + +# The keyword `import` class TKwimport super TokenKeyword end + +# The keyword `class` class TKwclass super TokenKeyword end + +# The keyword `abstract` class TKwabstract super TokenKeyword end + +# The keyword `interface` class TKwinterface super TokenKeyword end + +# The keywords `enum` and `universal` class TKwenum super TokenKeyword end + +# The keyword `subset` +class TKwsubset + super TokenKeyword +end + +# The keyword `end` class TKwend super TokenKeyword end + +# The keyword `fun` class TKwmeth super TokenKeyword end + +# The keyword `type` class TKwtype super TokenKeyword end + +# The keyword `init` class TKwinit super TokenKeyword end + +# The keyword `redef` class TKwredef super TokenKeyword end + +# The keyword `is` class TKwis super TokenKeyword end + +# The keyword `do` class TKwdo super TokenKeyword end -class TKwreadable - super TokenKeyword -end -class TKwwritable + +# The keyword `catch` +class TKwcatch super TokenKeyword end + +# The keyword `var` class TKwvar super TokenKeyword end -class TKwintern + +# The keyword `extern` +class TKwextern super TokenKeyword end -class TKwextern + +# The keyword `public` +class TKwpublic super TokenKeyword end + +# The keyword `protected` class TKwprotected super TokenKeyword end + +# The keyword `private` class TKwprivate super TokenKeyword end + +# The keyword `intrude` class TKwintrude super TokenKeyword end + +# The keyword `if` class TKwif super TokenKeyword end + +# The keyword `then` class TKwthen super TokenKeyword end + +# The keyword `else` class TKwelse super TokenKeyword end + +# The keyword `while` class TKwwhile super TokenKeyword end + +# The keyword `loop` class TKwloop super TokenKeyword end + +# The keyword `for` class TKwfor super TokenKeyword end + +# The keyword `in` class TKwin super TokenKeyword end + +# The keyword `and` class TKwand super TokenKeyword end + +# The keyword `or` class TKwor super TokenKeyword end + +# The keyword `implies` class TKwimplies super TokenKeyword end + +# The keyword `not` class TKwnot super TokenKeyword end + +# The keyword `return` class TKwreturn super TokenKeyword end + +# The keyword `continue` class TKwcontinue super TokenKeyword end + +# The keyword `break` class TKwbreak super TokenKeyword end + +# The keyword `abort` class TKwabort super TokenKeyword end + +# The keyword `assert` class TKwassert super TokenKeyword end + +# The keyword `new` class TKwnew super TokenKeyword end + +# The keyword `isa` class TKwisa super TokenKeyword end + +# The keyword `once` class TKwonce super TokenKeyword end + +# The keyword `super` class TKwsuper super TokenKeyword end + +# The keyword `self` class TKwself super TokenKeyword end + +# The keyword `true` class TKwtrue super TokenKeyword end + +# The keyword `false` class TKwfalse super TokenKeyword end + +# The keyword `null` class TKwnull super TokenKeyword end + +# The keyword `as` class TKwas super TokenKeyword end + +# The keyword `nullable` class TKwnullable super TokenKeyword end + +# The keyword `isset` class TKwisset super TokenKeyword end + +# The keyword `label` class TKwlabel super TokenKeyword end + +# The keyword `with` +class TKwwith + super TokenKeyword +end + +# The keyword `yield` +class TKwyield + super TokenKeyword +end + +# The special keyword `__DEBUG__` class TKwdebug super Token end + +# The symbol `(` class TOpar super Token end + +# The symbol `)` class TCpar super Token end + +# The symbol `[` class TObra super Token end + +# The symbol `]` class TCbra super Token end + +# The symbol `,` class TComma super Token end + +# The symbol `:` class TColumn super Token end + +# The symbol `::` class TQuad super Token end + +# The symbol `=` class TAssign super Token end @@ -409,70 +817,192 @@ abstract class TokenOperator return "operator '{text}'" end end + +# The operator `+=` class TPluseq super TokenOperator end + +# The operator `-=` class TMinuseq super TokenOperator end -class TDotdotdot + +# The operator `*=` +class TStareq super TokenOperator end -class TDotdot + +# The operator `/=` +class TSlasheq super TokenOperator end -class TDot + +# The operator `%=` +class TPercenteq + super TokenOperator +end + +# The operator `**=` +class TStarstareq super TokenOperator end + +# The operator `|=` +class TPipeeq + super TokenOperator +end + +# The operator `^=` +class TCareteq + super TokenOperator +end + +# The operator `&=` +class TAmpeq + super TokenOperator +end + +# The operator `<<=` +class TLleq + super TokenOperator +end + +# The operator `>>=` +class TGgeq + super TokenOperator +end + +# The symbol `...` +class TDotdotdot + super Token +end + +# The symbol `..` +class TDotdot + super Token +end + +# The symbol `.` +class TDot + super Token +end + +# The operator `+` class TPlus super TokenOperator end + +# The operator `-` class TMinus super TokenOperator end + +# The operator `*` class TStar super TokenOperator end + +# The operator `**` +class TStarstar + super TokenOperator +end + +# The operator `/` class TSlash super TokenOperator end + +# The operator `%` class TPercent super TokenOperator end + +# The operator `|` +class TPipe + super TokenOperator +end + +# The operator `^` +class TCaret + super TokenOperator +end + +# The operator `&` +class TAmp + super TokenOperator +end + +# The operator `~` +class TTilde + super TokenOperator +end + +# The operator `==` class TEq super TokenOperator end + +# The operator `!=` class TNe super TokenOperator end + +# The operator `<` class TLt super TokenOperator end + +# The operator `<=` class TLe super TokenOperator end + +# The operator `<<` class TLl super TokenOperator end + +# The operator `>` class TGt super TokenOperator end + +# The operator `>=` class TGe super TokenOperator end + +# The operator `>>` class TGg super TokenOperator end + +# The operator `<=>` class TStarship super TokenOperator end + +# The operator `?` +class TQuest + super TokenOperator +end + +# The operator `!` class TBang super TokenOperator end + +# The symbol `@` class TAt super Token end +# The symbol `;` +class TSemi + super Token +end + # A class (or formal type) identifier. They start with an uppercase. class TClassid super Token @@ -482,7 +1012,7 @@ class TClassid end end -# A standard identifier (variable, method...). They start with a lowercase. +# A standard identifier (variable, method...). They start with a lowercase. class TId super Token redef fun to_s @@ -508,24 +1038,38 @@ abstract class TokenLiteral do return "literal value '{text}'" end end -class TNumber + +# A literal integer +class TInteger super TokenLiteral end + +# A literal floating point number class TFloat super TokenLiteral end + +# A literal character class TChar super TokenLiteral end + +# A literal string class TString super TokenLiteral end + +# The starting part of a super string (between `"` and `{`) class TStartString super TokenLiteral end + +# The middle part of a super string (between `}` and `{`) class TMidString super TokenLiteral end + +# The final part of a super string (between `}` and `"`) class TEndString super TokenLiteral end @@ -539,6 +1083,11 @@ class TBadString end end +# A malformed triple quoted string +class TBadTString + super TBadString +end + # A malformed char class TBadChar super Token @@ -548,10 +1097,20 @@ class TBadChar end end +# A extern code block class TExternCodeSegment super Token end +# A malformed extern code block +class TBadExtern + super Token + redef fun to_s + do + do return "malformed extern segment {text}" + end +end + # A end of file class EOF super Token @@ -565,9 +1124,11 @@ end class AError super EOF end +# A lexical error (unexpected character) class ALexerError super AError end +# A syntactic error (unexpected token) class AParserError super AError end @@ -576,39 +1137,66 @@ end class AModule super Prod - readable writable var _n_moduledecl: nullable AModuledecl = null - readable var _n_imports: ANodes[AImport] = new ANodes[AImport](self) - readable var _n_extern_code_blocks: ANodes[AExternCodeBlock] = new ANodes[AExternCodeBlock](self) - readable var _n_classdefs: ANodes[AClassdef] = new ANodes[AClassdef](self) + # The declaration part of the module + var n_moduledecl: nullable AModuledecl = null is writable + + # List of importation clauses + var n_imports = new ANodes[AImport](self) + + # List of extern blocks + var n_extern_code_blocks = new ANodes[AExternCodeBlock](self) + + # List of class definition (including top-level methods and the main) + var n_classdefs = new ANodes[AClassdef](self) +end + +# Abstract class for definition of entities +abstract class ADefinition + super Prod + # The documentation + var n_doc: nullable ADoc = null is writable + + # The `redef` keyword + var n_kwredef: nullable TKwredef = null is writable + + # The declared visibility + var n_visibility: nullable AVisibility = null is writable end # The declaration of the module with the documentation, name, and annotations class AModuledecl - super Prod - readable writable var _n_doc: nullable ADoc = null - readable writable var _n_kwmodule: TKwmodule - readable writable var _n_name: AModuleName + super ADefinition + + # The `module` keyword + var n_kwmodule: TKwmodule is writable, noinit + + # The declared module name + var n_name: AModuleName is writable, noinit end # A import clause of a module abstract class AImport super Prod + + # The declared visibility + var n_visibility: AVisibility is writable, noinit + + # The `import` keyword + var n_kwimport: TKwimport is writable, noinit end # A standard import clause. eg `import x` class AStdImport super AImport - readable writable var _n_visibility: AVisibility - readable writable var _n_kwimport: TKwimport - readable writable var _n_name: AModuleName + # The imported module name + var n_name: AModuleName is writable, noinit end # The special import clause of the kernel module. eg `import end` class ANoImport super AImport - readable writable var _n_visibility: AVisibility - readable writable var _n_kwimport: TKwimport - readable writable var _n_kwend: TKwend + # The `end` keyword, that indicate the root module + var n_kwend: TKwend is writable, noinit end # A visibility modifier @@ -620,43 +1208,74 @@ end abstract class AVisibility super Prod end + +# An implicit or explicit public visibility modifier class APublicVisibility super AVisibility + # The `public` keyword, if any + var n_kwpublic: nullable TKwpublic = null is writable end +# An explicit private visibility modifier class APrivateVisibility super AVisibility - readable writable var _n_kwprivate: TKwprivate + # The `private` keyword + var n_kwprivate: TKwprivate is writable, noinit end +# An explicit protected visibility modifier class AProtectedVisibility super AVisibility - readable writable var _n_kwprotected: TKwprotected + # The `protected` keyword + var n_kwprotected: TKwprotected is writable, noinit end +# An explicit intrude visibility modifier class AIntrudeVisibility super AVisibility - readable writable var _n_kwintrude: TKwintrude + # The `intrude` keyword + var n_kwintrude: TKwintrude is writable, noinit end # A class definition -# While most definition are `AStdClassdef` -# There is tow special case of class definition -abstract class AClassdef super Prod - readable var _n_propdefs: ANodes[APropdef] = new ANodes[APropdef](self) +# +# While most definitions are `AStdClassdef`s, +# there are 2 special cases of class definitions. +abstract class AClassdef + super Prod + # All the declared properties (including the main method) + var n_propdefs = new ANodes[APropdef](self) end # A standard class definition with a name, superclasses and properties class AStdClassdef super AClassdef - readable writable var _n_doc: nullable ADoc = null - readable writable var _n_kwredef: nullable TKwredef = null - readable writable var _n_visibility: AVisibility - readable writable var _n_classkind: AClasskind - readable writable var _n_id: nullable TClassid = null - readable var _n_formaldefs: ANodes[AFormaldef] = new ANodes[AFormaldef](self) - readable writable var _n_extern_code_block: nullable AExternCodeBlock = null - readable var _n_superclasses: ANodes[ASuperclass] = new ANodes[ASuperclass](self) - readable writable var _n_kwend: TKwend - redef fun hot_location do return n_id.location -end + super ADefinition + + # The class kind (interface, abstract class, etc.) + var n_classkind: AClasskind is writable, noinit + + # The name of the class + var n_qid: nullable AQclassid = null is writable + + # The `[` symbol + var n_obra: nullable TObra = null is writable + + # The list of formal parameter types + var n_formaldefs = new ANodes[AFormaldef](self) + + # The `]` symbol + var n_cbra: nullable TCbra = null is writable + + # The extern block code + var n_extern_code_block: nullable AExternCodeBlock = null is writable + + # The `end` keyword + var n_kwend: TKwend is writable, noinit + + fun n_superclasses: Array[ASuperPropdef] do + return [for d in n_propdefs do if d isa ASuperPropdef then d] + end + + redef fun hot_location do return n_qid.location +end # The implicit class definition of the implicit main method class ATopClassdef @@ -672,232 +1291,313 @@ end abstract class AClasskind super Prod end + +# A default, or concrete class modifier (just `class`) class AConcreteClasskind super AClasskind - readable writable var _n_kwclass: TKwclass + + # The `class` keyword. + var n_kwclass: TKwclass is writable, noinit end + +# An abstract class modifier (`abstract class`) class AAbstractClasskind super AClasskind - readable writable var _n_kwabstract: TKwabstract - readable writable var _n_kwclass: TKwclass + + # The `abstract` keyword. + var n_kwabstract: TKwabstract is writable, noinit + + # The `class` keyword. + var n_kwclass: TKwclass is writable, noinit end + +# An interface class modifier (`interface`) class AInterfaceClasskind super AClasskind - readable writable var _n_kwinterface: TKwinterface + + # The `interface` keyword. + var n_kwinterface: TKwinterface is writable, noinit end + +# An enum/universal class modifier (`enum class`) class AEnumClasskind super AClasskind - readable writable var _n_kwenum: TKwenum + + # The `enum` keyword. + var n_kwenum: TKwenum is writable, noinit end + +# An extern class modifier (`extern class`) class AExternClasskind super AClasskind - readable writable var _n_kwextern: TKwextern - readable writable var _n_kwclass: nullable TKwclass = null + + # The `extern` keyword. + var n_kwextern: TKwextern is writable, noinit + + # The `class` keyword. + var n_kwclass: nullable TKwclass = null is writable +end + +class ASubsetClasskind + super AClasskind + + # The `subset` keyword. + var n_kwsubset: TKwsubset is writable, noinit + + redef fun visit_all(v) do + # TODO: Remove this redefinition once generated from the grammar. + v.enter_visit(n_kwsubset) + end end # The definition of a formal generic parameter type. eg `X: Y` class AFormaldef super Prod - readable writable var _n_id: TClassid - # The bound of the parameter type - readable writable var _n_type: nullable AType = null -end -# A super-class. eg `super X` -class ASuperclass - super Prod - readable writable var _n_kwsuper: TKwsuper - readable writable var _n_type: AType + # The name of the parameter type + var n_id: TClassid is writable, noinit + + # The bound of the parameter type + var n_type: nullable AType = null is writable end # The definition of a property abstract class APropdef - super Prod - readable writable var _n_doc: nullable ADoc = null + super ADefinition end # A definition of an attribute # For historical reason, old-syle and new-style attributes use the same `ANode` sub-class class AAttrPropdef super APropdef - readable writable var _n_kwredef: nullable TKwredef = null - readable writable var _n_visibility: AVisibility - readable writable var _n_kwvar: TKwvar - # The identifier for an old-style attribute (null if new-style) - readable writable var _n_id: nullable TAttrid + # The `var` keyword + var n_kwvar: TKwvar is writable, noinit - # The identifier for a new-style attribute (null if old-style) - readable writable var _n_id2: nullable TId + # The identifier for a new-style attribute + var n_id2: TId is writable, noinit - readable writable var _n_type: nullable AType = null - readable writable var _n_readable: nullable AAble = null - readable writable var _n_writable: nullable AAble = null + # The declared type of the attribute + var n_type: nullable AType = null is writable + + # The `=` symbol + var n_assign: nullable TAssign = null is writable + + # The initial value, if any (set with `=`) + var n_expr: nullable AExpr = null is writable + + # The `do` keyword + var n_kwdo: nullable TKwdo = null is writable + + # The initial value, if any (set with `do return`) + var n_block: nullable AExpr = null is writable + + # The `end` keyword + var n_kwend: nullable TKwend = null is writable - # The initial value, if any - readable writable var _n_expr: nullable AExpr = null redef fun hot_location do - if n_id != null then return n_id.location else return n_id2.location + return n_id2.location end end # A definition of all kind of method (including constructors) -abstract class AMethPropdef +class AMethPropdef super APropdef - readable writable var _n_kwredef: nullable TKwredef = null - readable writable var _n_visibility: nullable AVisibility - readable writable var _n_methid: nullable AMethid = null - readable writable var _n_signature: nullable ASignature + + # The `fun` keyword, if any + var n_kwmeth: nullable TKwmeth = null is writable + + # The `init` keyword, if any + var n_kwinit: nullable TKwinit = null is writable + + # The `isa` keyword, if any + var n_kwisa: nullable TKwisa = null is writable + + # The `new` keyword, if any + var n_kwnew: nullable TKwnew = null is writable + + # The name of the method, if any + var n_methid: nullable AMethid = null is writable + + # The signature of the method, if any + var n_signature: nullable ASignature = null is writable + + # The `do` keyword + var n_kwdo: nullable TKwdo = null is writable + + # The body (in Nit) of the method, if any + var n_block: nullable AExpr = null is writable + + # The `end` keyword + var n_kwend: nullable TKwend = null is writable + + # The list of declared callbacks (for extern methods) + var n_extern_calls: nullable AExternCalls = null is writable + + # The body (in extern code) of the method, if any + var n_extern_code_block: nullable AExternCodeBlock = null is writable + redef fun hot_location do if n_methid != null then return n_methid.location + else if n_kwinit != null then + return n_kwinit.location + else if n_kwnew != null then + return n_kwnew.location else return location end end end -# A method marked abstract -# *deferred* is a old synonynmous of *abstract* that comes from PRM, that comes from Eiffel. -class ADeferredMethPropdef - super AMethPropdef - readable writable var _n_kwmeth: TKwmeth -end - -# A method marked intern -class AInternMethPropdef - super AMethPropdef - readable writable var _n_kwmeth: TKwmeth -end - -# A method of a constructor marked extern -abstract class AExternPropdef +# The implicit main method +class AMainMethPropdef super AMethPropdef - readable writable var _n_extern: nullable TString = null - readable writable var _n_extern_calls: nullable AExternCalls = null - readable writable var _n_extern_code_block: nullable AExternCodeBlock = null -end - -# A method marked extern -class AExternMethPropdef - super AExternPropdef - readable writable var _n_kwmeth: TKwmeth end -# A method with a body -class AConcreteMethPropdef - super AMethPropdef - readable writable var _n_kwmeth: nullable TKwmeth - readable writable var _n_block: nullable AExpr = null +class AAnnotPropdef + super APropdef + super AAnnotation end -# A constructor -abstract class AInitPropdef - super AMethPropdef -end +# A super-class. eg `super X` +class ASuperPropdef + super APropdef -# A constructor with a body -class AConcreteInitPropdef - super AConcreteMethPropdef - super AInitPropdef - readable writable var _n_kwinit: TKwinit - redef fun hot_location do return n_kwinit.location -end + # The super keyword + var n_kwsuper: TKwsuper is writable, noinit -# A constructor marked extern (defined with the `new` keyword) -class AExternInitPropdef - super AExternPropdef - super AInitPropdef - readable writable var _n_kwnew: TKwnew + # The super-class (indicated as a type) + var n_type: AType is writable, noinit end -# The implicit main method -class AMainMethPropdef - super AConcreteMethPropdef -end # Declaration of callbacks for extern methods class AExternCalls super Prod - readable writable var _n_kwimport: TKwimport - readable var _n_extern_calls: ANodes[AExternCall] = new ANodes[AExternCall](self) + + # The `import` keyword + var n_kwimport: TKwimport is writable, noinit + + # The list of declared callbacks + var n_extern_calls: ANodes[AExternCall] = new ANodes[AExternCall](self) end + +# A single callback declaration abstract class AExternCall super Prod end + +# A single callback declaration on a method abstract class APropExternCall super AExternCall end + +# A single callback declaration on a method on the current receiver class ALocalPropExternCall super APropExternCall - readable writable var _n_methid: AMethid + + # The name of the called-back method + var n_methid: AMethid is writable, noinit end + +# A single callback declaration on a method on an explicit receiver type. class AFullPropExternCall super APropExternCall - readable writable var _n_classid: TClassid - readable writable var _n_quad: nullable TQuad = null - readable writable var _n_methid: AMethid + + # The type of the receiver of the called-back method + var n_type: AType is writable, noinit + + # The dot `.` + var n_dot: nullable TDot = null is writable + + # The name of the called-back method + var n_methid: AMethid is writable, noinit end + +# A single callback declaration on a method on a constructor class AInitPropExternCall super APropExternCall - readable writable var _n_classid: TClassid + + # The allocated type + var n_type: AType is writable, noinit end + +# A single callback declaration on a `super` call class ASuperExternCall super AExternCall - readable writable var _n_kwsuper: TKwsuper + + # The `super` keyword + var n_kwsuper: TKwsuper is writable, noinit end + +# A single callback declaration on a cast abstract class ACastExternCall super AExternCall end + +# A single callback declaration on a cast to a given type class ACastAsExternCall super ACastExternCall - readable writable var _n_from_type: AType - readable writable var _n_kwas: TKwas - readable writable var _n_to_type: AType + + # The origin type of the cast + var n_from_type: AType is writable, noinit + + # The dot (`.`) + var n_dot: nullable TDot = null is writable + + # The `as` keyword + var n_kwas: TKwas is writable, noinit + + # The destination of the cast + var n_to_type: AType is writable, noinit end + +# A single callback declaration on a cast to a nullable type class AAsNullableExternCall super ACastExternCall - readable writable var _n_type: AType - readable writable var _n_kwas: TKwas - readable writable var _n_kwnullable: TKwnullable + + # The origin type to cast as nullable + var n_type: AType is writable, noinit + + # The `as` keyword + var n_kwas: TKwas is writable, noinit + + # The `nullable` keyword + var n_kwnullable: TKwnullable is writable, noinit end + +# A single callback declaration on a cast to a non-nullable type class AAsNotNullableExternCall super ACastExternCall - readable writable var _n_type: AType - readable writable var _n_kwas: TKwas - readable writable var _n_kwnot: TKwnot - readable writable var _n_kwnullable: TKwnullable + + # The destination type on a cast to not nullable + var n_type: AType is writable, noinit + + # The `as` keyword. + var n_kwas: TKwas is writable, noinit + + # The `not` keyword + var n_kwnot: TKwnot is writable, noinit + + # The `nullable` keyword + var n_kwnullable: TKwnullable is writable, noinit end # A definition of a virtual type class ATypePropdef super APropdef - readable writable var _n_kwredef: nullable TKwredef = null - readable writable var _n_visibility: AVisibility - readable writable var _n_kwtype: TKwtype - readable writable var _n_id: TClassid - readable writable var _n_type: AType -end -# A `writable` or `readable` modifier -abstract class AAble - super Prod - readable writable var _n_visibility: nullable AVisibility = null - readable writable var _n_kwredef: nullable TKwredef = null -end + # The `type` keyword + var n_kwtype: TKwtype is writable, noinit -# A `readable` modifier -class AReadAble - super AAble - readable writable var _n_kwreadable: TKwreadable -end + # The name of the virtual type + var n_qid: AQclassid is writable, noinit -# A `writable` modifier -class AWriteAble - super AAble - readable writable var _n_kwwritable: TKwwritable + # The bound of the virtual type + var n_type: AType is writable, noinit end # The identifier of a method in a method declaration. @@ -905,117 +1605,236 @@ end abstract class AMethid super Prod end + +# A method name with a simple identifier class AIdMethid super AMethid - readable writable var _n_id: TId + + # The simple identifier + var n_id: TId is writable, noinit end -class APlusMethid + +# A method name for an operator +class AOperatorMethid super AMethid - readable writable var _n_plus: TPlus + + # The associated operator symbol + var n_op: Token is writable, noinit end +# A method name `+` +class APlusMethid + super AOperatorMethid +end + +# A method name `-` class AMinusMethid - super AMethid - readable writable var _n_minus: TMinus + super AOperatorMethid end + +# A method name `*` class AStarMethid - super AMethid - readable writable var _n_star: TStar + super AOperatorMethid +end + +# A method name `**` +class AStarstarMethid + super AOperatorMethid end + +# A method name `/` class ASlashMethid - super AMethid - readable writable var _n_slash: TSlash + super AOperatorMethid end + +# A method name `%` class APercentMethid - super AMethid - readable writable var _n_percent: TPercent + super AOperatorMethid +end + +# A method name `|` +class APipeMethid + super AOperatorMethid +end + +# A method name `^` +class ACaretMethid + super AOperatorMethid end + +# A method name `&` +class AAmpMethid + super AOperatorMethid +end + +# A method name `~` +class ATildeMethid + super AOperatorMethid +end + +# A method name `==` class AEqMethid - super AMethid - readable writable var _n_eq: TEq + super AOperatorMethid end + +# A method name `!=` class ANeMethid - super AMethid - readable writable var _n_ne: TNe + super AOperatorMethid end + +# A method name `<=` class ALeMethid - super AMethid - readable writable var _n_le: TLe + super AOperatorMethid end + +# A method name `>=` class AGeMethid - super AMethid - readable writable var _n_ge: TGe + super AOperatorMethid end + +# A method name `<` class ALtMethid - super AMethid - readable writable var _n_lt: TLt + super AOperatorMethid end + +# A method name `>` class AGtMethid - super AMethid - readable writable var _n_gt: TGt + super AOperatorMethid end + +# A method name `<<` class ALlMethid - super AMethid - readable writable var _n_ll: TLl + super AOperatorMethid end + +# A method name `>>` class AGgMethid - super AMethid - readable writable var _n_gg: TGg -end -class ABraMethid - super AMethid - readable writable var _n_obra: TObra - readable writable var _n_cbra: TCbra + super AOperatorMethid end + +# A method name `<=>` class AStarshipMethid + super AOperatorMethid +end + +# A method name `[]` +class ABraMethid super AMethid - readable writable var _n_starship: TStarship + + # The `[` symbol + var n_obra: TObra is writable, noinit + + # The `]` symbol + var n_cbra: TCbra is writable, noinit end + +# A setter method name with a simple identifier (with a `=`) class AAssignMethid super AMethid - readable writable var _n_id: TId - readable writable var _n_assign: TAssign + + # The base identifier + var n_id: TId is writable, noinit + + # The `=` symbol + var n_assign: TAssign is writable, noinit end + +# A method name `[]=` class ABraassignMethid super AMethid - readable writable var _n_obra: TObra - readable writable var _n_cbra: TCbra - readable writable var _n_assign: TAssign + + # The `[` symbol + var n_obra: TObra is writable, noinit + + # The `]` symbol + var n_cbra: TCbra is writable, noinit + + # The `=` symbol + var n_assign: TAssign is writable, noinit +end + +# A potentially qualified simple identifier `foo::bar::baz` +class AQid + super Prod + # The qualifier, if any + var n_qualified: nullable AQualified = null is writable + + # The final identifier + var n_id: TId is writable, noinit + + redef fun is_structural do return true +end + +# A potentially qualified class identifier `foo::bar::Baz` +class AQclassid + super Prod + # The qualifier, if any + var n_qualified: nullable AQualified = null is writable + + # The final identifier + var n_id: TClassid is writable, noinit + + redef fun is_structural do return true end # A signature in a method definition. eg `(x,y:X,z:Z):T` class ASignature super Prod - readable writable var _n_opar: nullable TOpar = null - readable var _n_params: ANodes[AParam] = new ANodes[AParam](self) - readable writable var _n_cpar: nullable TCpar = null - readable writable var _n_type: nullable AType = null + + # The `(` symbol + var n_opar: nullable TOpar = null is writable + + # The list of parameters + var n_params = new ANodes[AParam](self) + + # The `)` symbol + var n_cpar: nullable TCpar = null is writable + + # The return type + var n_type: nullable AType = null is writable end # A parameter definition in a signature. eg `x:X` class AParam super Prod - readable writable var _n_id: TId - readable writable var _n_type: nullable AType = null - readable writable var _n_dotdotdot: nullable TDotdotdot = null + + # The name of the parameter + var n_id: TId is writable, noinit + + # The type of the parameter, if any + var n_type: nullable AType = null is writable + + # The `...` symbol to indicate varargs + var n_dotdotdot: nullable TDotdotdot = null is writable end # A static type. eg `nullable X[Y]` class AType super Prod - readable writable var _n_kwnullable: nullable TKwnullable = null + # The `nullable` keyword + var n_kwnullable: nullable TKwnullable = null is writable # The name of the class or of the formal type - readable writable var _n_id: TClassid + var n_qid: AQclassid is writable, noinit + + # The opening bracket + var n_obra: nullable TObra = null is writable # Type arguments for a generic type - readable var _n_types: ANodes[AType] = new ANodes[AType](self) + var n_types = new ANodes[AType](self) + + # The closing bracket + var n_cbra: nullable TCbra = null is writable end # A label at the end of a block or in a break/continue statement. eg `label x` class ALabel super Prod - readable writable var _n_kwlabel: TKwlabel - readable writable var _n_id: TId + + # The `label` keyword + var n_kwlabel: TKwlabel is writable, noinit + + # The name of the label, if any + var n_id: nullable TId is writable, noinit end # Expression and statements @@ -1024,161 +1843,320 @@ abstract class AExpr super Prod end -# A sequence of AExpr (usually statements) -# The last AExpr gives the value of the whole block +# A sequence of `AExpr` (usually statements) +# The last `AExpr` gives the value of the whole block class ABlockExpr super AExpr - readable var _n_expr: ANodes[AExpr] = new ANodes[AExpr](self) - readable writable var _n_kwend: nullable TKwend = null + + # The list of statements in the bloc. + # The last element is often considered as an expression that give the value of the whole block. + var n_expr = new ANodes[AExpr](self) + + # The `end` keyword + var n_kwend: nullable TKwend = null is writable end # A declaration of a local variable. eg `var x: X = y` class AVardeclExpr super AExpr - readable writable var _n_kwvar: TKwvar - readable writable var _n_id: TId - readable writable var _n_type: nullable AType = null - readable writable var _n_assign: nullable TAssign = null + + # The `var` keyword + var n_kwvar: nullable TKwvar = null is writable + + # The name of the local variable + var n_id: TId is writable, noinit + + # The declaration type of the local variable + var n_type: nullable AType = null is writable + + # The `=` symbol (for the initial value) + var n_assign: nullable TAssign = null is writable # The initial value, if any - readable writable var _n_expr: nullable AExpr = null + var n_expr: nullable AExpr = null is writable end # A `return` statement. eg `return x` class AReturnExpr + super AEscapeExpr + + # The `return` keyword + var n_kwreturn: nullable TKwreturn = null is writable +end + +# A `yield` statement. eg `yield x` +class AYieldExpr super AExpr - readable writable var _n_kwreturn: nullable TKwreturn = null - readable writable var _n_expr: nullable AExpr = null + + # The `yield` keyword + var n_kwyield: nullable TKwyield = null is writable + + # The return value, if any + var n_expr: nullable AExpr = null is writable end # Something that has a label. abstract class ALabelable super Prod - readable writable var _n_label: nullable ALabel = null + + # The associated label declatation + var n_label: nullable ALabel = null is writable end -# A `break` statement. -class ABreakExpr +# A `break` or a `continue` +abstract class AEscapeExpr super AExpr super ALabelable - readable writable var _n_kwbreak: TKwbreak - readable writable var _n_expr: nullable AExpr = null + + # The return value, if nay (unused currently) + var n_expr: nullable AExpr = null is writable +end + +# A `break` statement. +class ABreakExpr + super AEscapeExpr + + # The `break` keyword + var n_kwbreak: TKwbreak is writable, noinit end # An `abort` statement class AAbortExpr super AExpr - readable writable var _n_kwabort: TKwabort + + # The `abort` keyword + var n_kwabort: TKwabort is writable, noinit end # A `continue` statement class AContinueExpr - super AExpr - super ALabelable - readable writable var _n_kwcontinue: nullable TKwcontinue = null - readable writable var _n_expr: nullable AExpr = null + super AEscapeExpr + + # The `continue` keyword. + var n_kwcontinue: nullable TKwcontinue = null is writable end # A `do` statement class ADoExpr super AExpr super ALabelable - readable writable var _n_kwdo: TKwdo - readable writable var _n_block: nullable AExpr = null + + # The `do` keyword + var n_kwdo: TKwdo is writable, noinit + + # The list of statements of the `do`. + var n_block: nullable AExpr = null is writable + + # The `catch` keyword + var n_kwcatch: nullable TKwcatch = null is writable + + # The do catch block + var n_catch: nullable AExpr = null is writable end # A `if` statement class AIfExpr super AExpr - readable writable var _n_kwif: TKwif - readable writable var _n_expr: AExpr - readable writable var _n_then: nullable AExpr = null - readable writable var _n_else: nullable AExpr = null + + # The `if` keyword + var n_kwif: TKwif is writable, noinit + + # The expression used as the condition of the `if` + var n_expr: AExpr is writable, noinit + + # The `then` keyword + var n_kwthen: TKwthen is writable, noinit + + # The body of the `then` part + var n_then: nullable AExpr = null is writable + + # The `else` keyword + var n_kwelse: nullable TKwelse = null is writable + + # The body of the `else` part + var n_else: nullable AExpr = null is writable end -# A `if` expression +# A `if` expression (ternary conditional). eg. `if true then 1 else 0` class AIfexprExpr super AExpr - readable writable var _n_kwif: TKwif - readable writable var _n_expr: AExpr - readable writable var _n_kwthen: TKwthen - readable writable var _n_then: AExpr - readable writable var _n_kwelse: TKwelse - readable writable var _n_else: AExpr + + # The `if` keyword + var n_kwif: TKwif is writable, noinit + + # The expression used as the condition of the `if` + var n_expr: AExpr is writable, noinit + + # The `then` keyword + var n_kwthen: TKwthen is writable, noinit + + # The expression in the `then` part + var n_then: AExpr is writable, noinit + + # The `else` keyword + var n_kwelse: TKwelse is writable, noinit + + # The expression in the `else` part + var n_else: AExpr is writable, noinit end # A `while` statement class AWhileExpr super AExpr super ALabelable - readable writable var _n_kwwhile: TKwwhile - readable writable var _n_expr: AExpr - readable writable var _n_kwdo: TKwdo - readable writable var _n_block: nullable AExpr = null + + # The `while` keyword + var n_kwwhile: TKwwhile is writable, noinit + + # The expression used as the condition of the `while` + var n_expr: AExpr is writable, noinit + + # The `do` keyword + var n_kwdo: TKwdo is writable, noinit + + # The body of the loop + var n_block: nullable AExpr = null is writable end # A `loop` statement class ALoopExpr super AExpr super ALabelable - readable writable var _n_kwloop: TKwloop - readable writable var _n_block: nullable AExpr = null + + # The `loop` keyword + var n_kwloop: TKwloop is writable, noinit + + # The body of the loop + var n_block: nullable AExpr = null is writable end # A `for` statement class AForExpr super AExpr super ALabelable - readable writable var _n_kwfor: TKwfor - readable var _n_ids: ANodes[TId] = new ANodes[TId](self) - readable writable var _n_expr: AExpr - readable writable var _n_kwdo: TKwdo - readable writable var _n_block: nullable AExpr = null + + # The `for` keyword + var n_kwfor: TKwfor is writable, noinit + + # The list of groups to iterate + var n_groups = new ANodes[AForGroup](self) + + # The `do` keyword + var n_kwdo: TKwdo is writable, noinit + + # The body of the loop + var n_block: nullable AExpr = null is writable +end + +# A collection iterated by a for, its automatic variables and its implicit iterator. +# +# Standard `for` iterate on a single collection. +# Multiple `for` can iterate on more than one collection at once. +class AForGroup + super Prod + + # The list of name of the automatic variables + var n_ids = new ANodes[TId](self) + + # The `in` keyword + var n_kwin: TKwin is writable, noinit + + # The expression used as the collection to iterate on + var n_expr: AExpr is writable, noinit +end + +# A `with` statement +class AWithExpr + super AExpr + super ALabelable + + # The `with` keyword + var n_kwwith: TKwwith is writable, noinit + + # The expression used to get the value to control + var n_expr: AExpr is writable, noinit + + # The `do` keyword + var n_kwdo: TKwdo is writable, noinit + + # The body of the loop + var n_block: nullable AExpr = null is writable end # An `assert` statement class AAssertExpr super AExpr - readable writable var _n_kwassert: TKwassert - readable writable var _n_id: nullable TId = null - readable writable var _n_expr: AExpr - readable writable var _n_else: nullable AExpr = null + + # The `assert` keyword + var n_kwassert: TKwassert is writable, noinit + + # The name of the assert, if any + var n_id: nullable TId = null is writable + + # The expression used as the condition of the `assert` + var n_expr: AExpr is writable, noinit + + # The `else` keyword + var n_kwelse: nullable TKwelse = null is writable + + # The body to execute when the assert fails + var n_else: nullable AExpr = null is writable end # Whatever is a simple assignment. eg `= something` abstract class AAssignFormExpr super AExpr - readable writable var _n_assign: TAssign - readable writable var _n_value: AExpr + + # The `=` symbol + var n_assign: TAssign is writable, noinit + + # The right-value to assign. + var n_value: AExpr is writable, noinit end # Whatever is a combined assignment. eg `+= something` abstract class AReassignFormExpr super AExpr - readable writable var _n_assign_op: AAssignOp - readable writable var _n_value: AExpr + + # The combined operator (eg. `+=`) + var n_assign_op: AAssignOp is writable, noinit + + # The right-value to apply on the combined operator. + var n_value: AExpr is writable, noinit end # A `once` expression. eg `once x` class AOnceExpr - super AProxyExpr - readable writable var _n_kwonce: TKwonce + super AExpr + + # The `once` keyword + var n_kwonce: TKwonce is writable, noinit + + # The expression to evaluate only one time + var n_expr: AExpr is writable, noinit end # A polymorphic invocation of a method -# The form of the invocation (name, arguments, etc) are specific +# The form of the invocation (name, arguments, etc.) are specific abstract class ASendExpr super AExpr # The receiver of the method invocation - readable writable var _n_expr: AExpr + var n_expr: AExpr is writable, noinit end # A binary operation on a method abstract class ABinopExpr super ASendExpr + + # The operator + var n_op: Token is writable, noinit + # The second operand of the operation # Note: the receiver (`n_expr`) is the first operand - readable writable var _n_expr2: AExpr + var n_expr2: AExpr is writable, noinit + + # The name of the operator (eg '+') + fun operator: String is abstract end # Something that is boolean expression @@ -1186,140 +2164,227 @@ abstract class ABoolExpr super AExpr end -# A `or` expression -class AOrExpr +# Something that is binary boolean expression +abstract class ABinBoolExpr super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr + + # The first boolean operand + var n_expr: AExpr is writable, noinit + + # The operator + var n_op: Token is writable, noinit + + # The second boolean operand + var n_expr2: AExpr is writable, noinit +end + +# A `or` expression +class AOrExpr + super ABinBoolExpr end # A `and` expression class AAndExpr - super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr + super ABinBoolExpr end # A `or else` expression class AOrElseExpr - super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr + super ABinBoolExpr + + # The `else` keyword + var n_kwelse: TKwelse is writable, noinit end # A `implies` expression class AImpliesExpr - super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr + super ABinBoolExpr end # A `not` expression class ANotExpr super ABoolExpr - readable writable var _n_kwnot: TKwnot - readable writable var _n_expr: AExpr + + # The `not` keyword + var n_kwnot: TKwnot is writable, noinit + + # The boolean operand of the `not` + var n_expr: AExpr is writable, noinit end -# A `==` expression -class AEqExpr +# A `==` or a `!=` expression +# +# Both have a similar effect on adaptive typing, so this class factorizes the common behavior. +class AEqFormExpr super ABinopExpr end -# A `is` expression -class AEeExpr - super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr +# A `==` expression +class AEqExpr + super AEqFormExpr + redef fun operator do return "==" end # A `!=` expression class ANeExpr - super ABinopExpr + super AEqFormExpr + redef fun operator do return "!=" end # A `<` expression class ALtExpr super ABinopExpr + redef fun operator do return "<" end # A `<=` expression class ALeExpr super ABinopExpr + redef fun operator do return "<=" end # A `<<` expression class ALlExpr super ABinopExpr + redef fun operator do return "<<" end # A `>` expression class AGtExpr super ABinopExpr + redef fun operator do return ">" end # A `>=` expression class AGeExpr super ABinopExpr + redef fun operator do return ">=" end # A `>>` expression class AGgExpr super ABinopExpr + redef fun operator do return ">>" end # A type-ckeck expression. eg `x isa T` class AIsaExpr super ABoolExpr - readable writable var _n_expr: AExpr - readable writable var _n_type: AType + + # The expression to check + var n_expr: AExpr is writable, noinit + + # The `isa` keyword + var n_kwisa: TKwisa is writable, noinit + + # The destination type to check to + var n_type: AType is writable, noinit end # A `+` expression class APlusExpr super ABinopExpr + redef fun operator do return "+" end # A `-` expression class AMinusExpr super ABinopExpr + redef fun operator do return "-" end # A `<=>` expression class AStarshipExpr super ABinopExpr + redef fun operator do return "<=>" end # A `*` expression class AStarExpr super ABinopExpr + redef fun operator do return "*" +end + +# A `**` expression +class AStarstarExpr + super ABinopExpr + redef fun operator do return "**" end # A `/` expression class ASlashExpr super ABinopExpr + redef fun operator do return "/" end # A `%` expression class APercentExpr super ABinopExpr + redef fun operator do return "%" +end + +# A `|` expression +class APipeExpr + super ABinopExpr + redef fun operator do return "|" +end + +# A `^` expression +class ACaretExpr + super ABinopExpr + redef fun operator do return "^" +end + +# A `&` expression +class AAmpExpr + super ABinopExpr + redef fun operator do return "&" +end + +# A unary operation on a method +abstract class AUnaryopExpr + super ASendExpr + + # The operator + var n_op: Token is writable, noinit + + # The name of the operator (eg '+') + fun operator: String is abstract end # A unary minus expression. eg `-x` class AUminusExpr - super ASendExpr - readable writable var _n_minus: TMinus + super AUnaryopExpr + redef fun operator do return "-" +end + +# A unary plus expression. eg `+x` +class AUplusExpr + super AUnaryopExpr + redef fun operator do return "+" +end + +# A unary `~` expression +class AUtildeExpr + super AUnaryopExpr + redef fun operator do return "~" end # An explicit instantiation. eg `new T` class ANewExpr super AExpr - readable writable var _n_kwnew: TKwnew - readable writable var _n_type: AType + + # The `new` keyword + var n_kwnew: TKwnew is writable, noinit + + # The `type` keyword + var n_type: AType is writable, noinit # The name of the named-constructor, if any - readable writable var _n_id: nullable TId = null - readable writable var _n_args: AExprs + var n_qid: nullable AQid = null is writable + + # The arguments of the `new` + var n_args: AExprs is writable, noinit end # Whatever is a old-style attribute access @@ -1327,10 +2392,11 @@ abstract class AAttrFormExpr super AExpr # The receiver of the attribute - readable writable var _n_expr: AExpr + var n_expr: AExpr is writable, noinit # The name of the attribute - readable writable var _n_id: TAttrid + var n_id: TAttrid is writable, noinit + end # The read of an attribute. eg `x._a` @@ -1349,10 +2415,10 @@ abstract class ACallFormExpr super ASendExpr # The name of the method - readable writable var _n_id: TId + var n_qid: AQid is writable, noinit # The arguments of the call - readable writable var _n_args: AExprs + var n_args: AExprs is writable, noinit end # A complex setter call (standard or brackets) @@ -1383,33 +2449,66 @@ class ACallAssignExpr end # 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. -# Note: because the parser cannot distinguish a variable write with a compex setter call with an implicit receiver and no arguments, it always returns a `ACallReassignExpr`. +# 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`. # Semantic analysis have to transform them to instance of `AVarReassignExpr`. class ACallReassignExpr super ACallFormExpr super ASendReassignFormExpr end +# A reference to a method with a captured receiver. eg. `&x.foo` or just `&foo` is self is captured. +# +# Currently, the syntax is analogous to a simple call (`recv.foo`) with a prefix `&`. +# On chains, only the last call is captured (`.` has a higher precedence than `&`). +# +# The syntax is analogous to a call (except the &), there is always a receiver (including the implicit self or sys) and arguments are accepted by the parser. +# +# TODO There is no clear syntax proposal +# +# * to avoid the capture of a receiver since a receiver is statically expected to resolve the method name +# * for special method names (setters, brackets and operators) +# +# Note: The class specializes `ASendExpr` (trough `ACallFormExpr`) so some behavior of a genuine send expression must be redefined. +class ACallrefExpr + super ACallFormExpr + + # The `&` operator + var n_amp: TAmp is writable, noinit +end + + # A call to `super`. OR a call of a super-constructor class ASuperExpr super AExpr - readable writable var _n_qualified: nullable AQualified = null - readable writable var _n_kwsuper: TKwsuper - readable writable var _n_args: AExprs + + # The qualifier part before the super (currenlty unused) + var n_qualified: nullable AQualified = null is writable + + # The `super` keyword + var n_kwsuper: TKwsuper is writable, noinit + + # The arguments of the super + var n_args: AExprs is writable, noinit end # A call to the `init` constructor. -# Note: because `init` is a keyword and not a `TId`, the explicit call to init cannot be a ACallFormExpr. +# Note: because `init` is a keyword and not a `TId`, the explicit call to init cannot be a `ACallFormExpr`. class AInitExpr super ASendExpr - readable writable var _n_kwinit: TKwinit - readable writable var _n_args: AExprs + + # The `init` keyword + var n_kwinit: TKwinit is writable, noinit + + # The arguments of the init + var n_args: AExprs is writable, noinit end # Whatever looks-like a call of the brackets `[]` operator. abstract class ABraFormExpr super ASendExpr - readable writable var _n_args: AExprs + + # The arguments inside the brackets + var n_args: AExprs is writable, noinit end # A call of the brackets operator. eg `x[y,z]` @@ -1426,7 +2525,9 @@ end # Whatever is an access to a local variable abstract class AVarFormExpr super AExpr - readable writable var _n_id: TId + + # The name of the attribute + var n_id: TId is writable, noinit end # A complex setter call of the bracket operator. eg `x[y,z]+=t` @@ -1441,7 +2542,7 @@ class AVarExpr super AVarFormExpr end -# A local variable simple assigment access +# A local variable simple assignment access # The parser cannot instantiate them, see `ACallAssignExpr`. class AVarAssignExpr super AVarFormExpr @@ -1458,34 +2559,62 @@ end # A literal range, open or closed abstract class ARangeExpr super AExpr - readable writable var _n_expr: AExpr - readable writable var _n_expr2: AExpr + + # The left (lower) element of the range + var n_expr: AExpr is writable, noinit + + # The `..` + var n_dotdot: TDotdot is writable, noinit + + # The right (upper) element of the range + var n_expr2: AExpr is writable, noinit end # A closed literal range. eg `[x..y]` class ACrangeExpr super ARangeExpr - readable writable var _n_obra: TObra - readable writable var _n_cbra: TCbra + + # The opening bracket `[` + var n_obra: TObra is writable, noinit + + # The closing bracket `]` + var n_cbra: TCbra is writable, noinit end # An open literal range. eg `[x..y[` class AOrangeExpr super ARangeExpr - readable writable var _n_obra: TObra - readable writable var _n_cbra: TObra + + # The opening bracket `[` + var n_obra: TObra is writable, noinit + + # The closing bracket `[` (because open range) + var n_cbra: TObra is writable, noinit end # A literal array. eg. `[x,y,z]` class AArrayExpr super AExpr - readable writable var _n_exprs: AExprs + + # The opening bracket `[` + var n_obra: TObra is writable, noinit + + # The elements of the array + var n_exprs = new ANodes[AExpr](self) + + # The type of the element of the array (if any) + var n_type: nullable AType = null is writable + + # The closing bracket `]` + var n_cbra: TCbra is writable, noinit end -# A read of `self` +# A read of `self` class ASelfExpr super AExpr - readable writable var _n_kwself: nullable TKwself + + # The `self` keyword + var n_kwself: nullable TKwself = null is writable end # When there is no explicit receiver, `self` is implicit @@ -1496,37 +2625,57 @@ end # A `true` boolean literal constant class ATrueExpr super ABoolExpr - readable writable var _n_kwtrue: TKwtrue + + # The `true` keyword + var n_kwtrue: TKwtrue is writable, noinit end + # A `false` boolean literal constant class AFalseExpr super ABoolExpr - readable writable var _n_kwfalse: TKwfalse + + # The `false` keyword + var n_kwfalse: TKwfalse is writable, noinit end + # A `null` literal constant class ANullExpr super AExpr - readable writable var _n_kwnull: TKwnull + + # The `null` keyword + var n_kwnull: TKwnull is writable, noinit end + # An integer literal -class AIntExpr +class AIntegerExpr super AExpr - readable writable var _n_number: TNumber + + # The integer token + var n_integer: TInteger is writable, noinit end + # A float literal class AFloatExpr super AExpr - readable writable var _n_float: TFloat + + # The float token + var n_float: TFloat is writable, noinit end + # A character literal class ACharExpr super AExpr - readable writable var _n_char: TChar + + # The character token + var n_char: TChar is writable, noinit end + # A string literal abstract class AStringFormExpr super AExpr - readable writable var _n_string: Token + + # The string token + var n_string: Token is writable, noinit end # A simple string. eg. `"abc"` @@ -1550,64 +2699,168 @@ class AEndStringExpr end # A superstring literal. eg `"a{x}b{y}c"` -# Each part is modelized a sequence of expression. eg. `["a{, x, }b{, y, }c"]` +# Each part is modeled a sequence of expression. eg. `["a{, x, }b{, y, }c"]` class ASuperstringExpr super AExpr - readable var _n_exprs: ANodes[AExpr] = new ANodes[AExpr](self) + + # The list of the expressions of the superstring + var n_exprs = new ANodes[AExpr](self) end # A simple parenthesis. eg `(x)` class AParExpr - super AProxyExpr - readable writable var _n_opar: TOpar - readable writable var _n_cpar: TCpar + super AExpr + + # The opening parenthesis + var n_opar: TOpar is writable, noinit + + # The inner expression + var n_expr: AExpr is writable, noinit + + # The closing parenthesis + var n_cpar: TCpar is writable, noinit end -# Whatevej just contains (and mimic) an other expression -abstract class AProxyExpr +# A cast, against a type or `not null` +class AAsCastForm super AExpr - readable writable var _n_expr: AExpr + + # The expression to cast + var n_expr: AExpr is writable, noinit + + # The `as` keyword + var n_kwas: TKwas is writable, noinit + + # The opening parenthesis + var n_opar: nullable TOpar = null is writable + + # The closing parenthesis + var n_cpar: nullable TCpar = null is writable end # A type cast. eg `x.as(T)` class AAsCastExpr - super AExpr - readable writable var _n_expr: AExpr - readable writable var _n_kwas: TKwas - readable writable var _n_opar: TOpar - readable writable var _n_type: AType - readable writable var _n_cpar: TCpar + super AAsCastForm + + # The target type to cast to + var n_type: AType is writable, noinit end # A as-not-null cast. eg `x.as(not null)` class AAsNotnullExpr - super AExpr - readable writable var _n_expr: AExpr - readable writable var _n_kwas: TKwas - readable writable var _n_opar: TOpar - readable writable var _n_kwnot: TKwnot - readable writable var _n_kwnull: TKwnull - readable writable var _n_cpar: TCpar + super AAsCastForm + + # The `not` keyword + var n_kwnot: TKwnot is writable, noinit + + # The `null` keyword + var n_kwnull: TKwnull is writable, noinit end # A is-set check of old-style attributes. eg `isset x._a` class AIssetAttrExpr super AAttrFormExpr - readable writable var _n_kwisset: TKwisset + + # The `isset` keyword + var n_kwisset: TKwisset is writable, noinit +end + +# An ellipsis notation used to pass an expression as it, in a vararg parameter +class AVarargExpr + super AExpr + + # The passed expression + var n_expr: AExpr is writable, noinit + + # The `...` symbol + var n_dotdotdot: TDotdotdot is writable, noinit +end + +# A receiver with a `?` suffix used in safe call operator. +class ASafeExpr + super AExpr + + # The expression made safe + var n_expr: AExpr is writable, noinit + + # The `?` symbol + var n_quest: TQuest is writable, noinit +end + +# An named notation used to pass an expression by name in a parameter +class ANamedargExpr + super AExpr + + # The name of the argument + var n_id: TId is writable, noinit + + # The `=` synbol + var n_assign: TAssign is writable, noinit + + # The passed expression + var n_expr: AExpr is writable, noinit end # A list of expression separated with commas (arguments for instance) -abstract class AExprs - super Prod - readable var _n_exprs: ANodes[AExpr] = new ANodes[AExpr](self) +class AManyExpr + super AExpr + + # The list of expressions + var n_exprs = new ANodes[AExpr](self) +end + +# A special expression that encapsulates a static type +# Can only be found in special construction like arguments of annotations. +class ATypeExpr + super AExpr + + # The encapsulated type + var n_type: AType is writable, noinit +end + +# A special expression that encapsulates a method identifier +# Can only be found in special construction like arguments of annotations. +class AMethidExpr + super AExpr + + # The receiver + var n_expr: AExpr is writable, noinit + + # The encapsulated method identifier + var n_id: AMethid is writable, noinit +end + +# A special expression that encapsulate an annotation +# Can only be found in special construction like arguments of annotations. +# +# The encapsulated annotations are in `n_annotations` +class AAtExpr + super AExpr end +# A special expression to debug types class ADebugTypeExpr super AExpr - readable writable var _n_kwdebug: TKwdebug - readable writable var _n_kwtype: TKwtype - readable writable var _n_expr: AExpr - readable writable var _n_type: AType + + # The `debug` keyword + var n_kwdebug: TKwdebug is writable, noinit + + # The `type` keyword + var n_kwtype: TKwtype is writable, noinit + + # The expression to check + var n_expr: AExpr is writable, noinit + + # The type to check + var n_type: AType is writable, noinit +end + +# A list of expression separated with commas (arguments for instance) +abstract class AExprs + super Prod + + # The list of expressions + var n_exprs = new ANodes[AExpr](self) end # A simple list of expressions @@ -1618,119 +2871,261 @@ end # A list of expressions enclosed in parentheses class AParExprs super AExprs - readable writable var _n_opar: TOpar - readable writable var _n_cpar: TCpar + + # The opening parenthesis + var n_opar: TOpar is writable, noinit + + # The closing parenthesis + var n_cpar: TCpar is writable, noinit end # A list of expressions enclosed in brackets class ABraExprs super AExprs - readable writable var _n_obra: TObra - readable writable var _n_cbra: TCbra + + # The opening bracket + var n_obra: TObra is writable, noinit + + # The closing bracket + var n_cbra: TCbra is writable, noinit end -# A complex assignment operator. eg `+=` +# A complex assignment operator. (`+=` and `-=`) abstract class AAssignOp super Prod + + # The combined assignment operator + var n_op: Token is writable, noinit + + # The name of the operator without the `=` (eg '+') + fun operator: String is abstract end + +# A `+=` assignment operation class APlusAssignOp super AAssignOp - readable writable var _n_pluseq: TPluseq + + redef fun operator do return "+" end + +# A `-=` assignment operation class AMinusAssignOp super AAssignOp - readable writable var _n_minuseq: TMinuseq + + redef fun operator do return "-" +end + +# A `*=` assignment operation +class AStarAssignOp + super AAssignOp + + redef fun operator do return "*" +end + +# A `/=` assignment operation +class ASlashAssignOp + super AAssignOp + + redef fun operator do return "/" +end + +# A `%=` assignment operation +class APercentAssignOp + super AAssignOp + + redef fun operator do return "%" +end + +# A `**=` assignment operation +class AStarstarAssignOp + super AAssignOp + + redef fun operator do return "**" +end + +# A `|=` assignment operation +class APipeAssignOp + super AAssignOp + + redef fun operator do return "|" +end + +# A `^=` assignment operation +class ACaretAssignOp + super AAssignOp + + redef fun operator do return "^" end +# A `&=` assignment operation +class AAmpAssignOp + super AAssignOp + + redef fun operator do return "&" +end + +# A `<<=` assignment operation +class ALlAssignOp + super AAssignOp + + redef fun operator do return "<<" +end + +# A `>>=` assignment operation +class AGgAssignOp + super AAssignOp + + redef fun operator do return ">>" +end + +# A possibly fully-qualified module identifier class AModuleName super Prod - readable writable var _n_quad: nullable TQuad = null - readable var _n_path: ANodes[TId] = new ANodes[TId](self) - readable writable var _n_id: TId + + # The starting quad (`::`) + var n_quad: nullable TQuad = null is writable + + # The list of quad-separated package/group identifiers + var n_path = new ANodes[TId](self) + + # The final module identifier + var n_id: TId is writable, noinit end + +# A language declaration for an extern block class AInLanguage super Prod - readable writable var _n_kwin: TKwin - readable writable var _n_string: TString + + # The `in` keyword + var n_kwin: TKwin is writable, noinit + + # The language name + var n_string: TString is writable, noinit end + +# An full extern block class AExternCodeBlock super Prod - readable writable var _n_in_language: nullable AInLanguage = null - readable writable var _n_extern_code_segment: TExternCodeSegment + + # The language declration + var n_in_language: nullable AInLanguage = null is writable + + # The block of extern code + var n_extern_code_segment: TExternCodeSegment is writable, noinit end + +# A possible full method qualifier. class AQualified super Prod - readable writable var _n_quad: nullable TQuad = null - readable var _n_id: ANodes[TId] = new ANodes[TId](self) - readable writable var _n_classid: nullable TClassid = null + + # The starting quad (`::`) + var n_quad: nullable TQuad = null is writable + + # The list of quad-separated package/group/module identifiers + var n_id = new ANodes[TId](self) + + # A class identifier + var n_classid: nullable TClassid = null is writable end # A documentation of a definition # It contains the block of comments just above the declaration class ADoc super Prod - readable var _n_comment: ANodes[TComment] = new ANodes[TComment](self) + + # A list of lines of comment + var n_comment = new ANodes[TComment](self) end +# A group of annotation on a node +# +# This same class is used for the 3 kind of annotations: +# +# * *is* annotations. eg `module foo is bar`. +# * *at* annotations. eg `foo@bar` or `foo@(bar,baz)`. +# * *class* annotations, defined in classes. class AAnnotations super Prod - readable writable var _n_at: nullable TAt = null - readable writable var _n_opar: nullable TOpar = null - readable var _n_items: ANodes[AAnnotation] = new ANodes[AAnnotation](self) - readable writable var _n_cpar: nullable TCpar = null + + # The `is` keyword, for *is* annotations + var n_kwis: nullable TKwis = null is writable + + # The `@` symbol, for *at* annotations + var n_at: nullable TAt = null is writable + + # The opening parenthesis in *at* annotations + var n_opar: nullable TOpar = null is writable + + # The list of annotations + var n_items = new ANodes[AAnnotation](self) + + # The closing parenthesis in *at* annotations + var n_cpar: nullable TCpar = null is writable + + # The `end` keyword, for *is* annotations + var n_kwend: nullable TKwend = null is writable end + +# A single annotation class AAnnotation - super Prod - readable writable var _n_atid: AAtid - readable writable var _n_opar: nullable TOpar = null - readable var _n_args: ANodes[AAtArg] = new ANodes[AAtArg](self) - readable writable var _n_cpar: nullable TCpar = null -end -abstract class AAtArg - super Prod -end -class ATypeAtArg - super AAtArg - readable writable var _n_type: AType -end -class AExprAtArg - super AAtArg - readable writable var _n_expr: AExpr -end -class AAtAtArg - super AAtArg + super ADefinition + + # The name of the annotation + var n_atid: AAtid is writable, noinit + + # The opening parenthesis of the arguments + var n_opar: nullable TOpar = null is writable + + # The list of arguments + var n_args = new ANodes[AExpr](self) + + # The closing parenthesis + var n_cpar: nullable TCpar = null is writable + + # The name of the annotation + fun name: String + do + return n_atid.n_id.text + end end + +# An annotation name abstract class AAtid super Prod - readable writable var _n_id: Token + + # The identifier of the annotation. + # + # Can be a TId or a keyword. + var n_id: Token is writable, noinit end + +# An annotation name based on an identifier class AIdAtid super AAtid end + +# An annotation name based on the keyword `extern` class AKwexternAtid super AAtid end -class AKwinternAtid - super AAtid -end -class AKwreadableAtid - super AAtid -end -class AKwwritableAtid + +# An annotation name based on the keyword `import` +class AKwimportAtid super AAtid end -class AKwimportAtid + +# An annotation name based on the keyword `abstract` +class AKwabstractAtid super AAtid end # The root of the AST class Start super Prod - readable writable var _n_base: nullable AModule - readable writable var _n_eof: EOF - init(n_base: nullable AModule, n_eof: EOF) - do - self._n_base = n_base - self._n_eof = n_eof - end + + # The main module + var n_base: nullable AModule is writable + + # The end of file (or error) token + var n_eof: EOF is writable end