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
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.
- # See `ASTDump`
- fun dump_tree
+ #
+ # 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
+ 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
# 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
last_parent = p
end
- redef fun display(n)
+ redef fun write_line(o, n, p)
do
- if n isa Token then
- return "{n.class_name} \"{n.text.escape_to_c}\" @{n.location}"
- else
- return "{n.class_name} @{n.location}"
+ 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
# 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.
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
end
end
+# A malformed triple quoted string
+class TBadTString
+ super TBadString
+end
+
# A malformed char
class TBadChar
super Token
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
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)
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
# 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 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`
# 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`
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