syntax: add safe call syntax `x?.foo`
[nit.git] / src / parser / parser_nodes.nit
index 5073193..92dbea0 100644 (file)
@@ -18,10 +18,11 @@ module parser_nodes
 
 import location
 import ordered_tree
+private import console
 
 # Root of the AST class-hierarchy
 abstract class ANode
-       # 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.
        var location: Location is writable, noinit
 
@@ -38,10 +39,15 @@ abstract class ANode
        fun is_structural: Bool do return false
 
        # Write the subtree on stdout.
-       # See `ASTDump`
-       fun dump_tree(display_structural: nullable Bool)
+       #
+       # 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)
+               var d = new ASTDump(display_structural or else true, display_line or else true)
                d.enter_visit(self)
                d.write_to(sys.stdout)
        end
@@ -190,6 +196,14 @@ class ASTDump
        # 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
@@ -200,10 +214,35 @@ class ASTDump
                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
@@ -495,11 +534,16 @@ class TKwinterface
        super TokenKeyword
 end
 
-# The keywords `enum` ane `universal`
+# 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
@@ -939,6 +983,11 @@ class TStarship
        super TokenOperator
 end
 
+# The operator `?`
+class TQuest
+       super TokenOperator
+end
+
 # The operator `!`
 class TBang
        super TokenOperator
@@ -1034,6 +1083,11 @@ class TBadString
        end
 end
 
+# A malformed triple quoted string
+class TBadTString
+       super TBadString
+end
+
 # A malformed char
 class TBadChar
        super Token
@@ -1048,6 +1102,15 @@ 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
@@ -1172,8 +1235,9 @@ class AIntrudeVisibility
 end
 
 # A class definition
-# While most definition are `AStdClassdef`
-# There is tow special case of class definition
+#
+# 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)
@@ -1274,6 +1338,18 @@ class AExternClasskind
        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
@@ -1335,6 +1411,9 @@ class AMethPropdef
        # 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
 
@@ -2676,6 +2755,17 @@ class AVarargExpr
        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
@@ -2983,7 +3073,8 @@ abstract class AAtid
        super Prod
 
        # The identifier of the annotation.
-       # Can be a TId of a keyword
+       #
+       # Can be a TId or a keyword.
        var n_id: Token is writable, noinit
 end