Moving the astvalidation module in astbuilder
[nit.git] / src / astbuilder.nit
index f0e0c95..6340ad2 100644 (file)
 module astbuilder
 
 intrude import semantize::typing
-intrude import semantize::literal
-intrude import semantize::parser
+intrude import literal
+intrude import parser
 intrude import semantize::scope
 
 # General factory to build semantic nodes in the AST of expressions
 class ASTBuilder
        # The module used as reference for the building
-       # It is used to gather types and other stufs
+       # It is used to gather types and other stuff
        var mmodule: MModule
 
        # The anchor used for some mechanism relying on types
        var anchor: nullable MClassType
 
        # Make a new Int literal
-       fun make_int(value: Int): AIntExpr
+       fun make_int(value: Int): AIntegerExpr
        do
-               return new ADecIntExpr.make(value, mmodule.get_primitive_class("Int").mclass_type)
+               return new AIntegerExpr.make(value, mmodule.int_type)
        end
 
-       # Make a new instatiation
+       # Make a new instantiation
        fun make_new(callsite: CallSite, args: nullable Array[AExpr]): ANewExpr
        do
                return new ANewExpr.make(callsite, args)
@@ -53,6 +53,12 @@ class ASTBuilder
                return new ABlockExpr.make
        end
 
+       # Make a new, empty, loop of statements
+       fun make_loop: ALoopExpr
+       do
+               return new ALoopExpr.make
+       end
+
        # Make a new variable read
        fun make_var_read(variable: Variable, mtype: MType): AVarExpr
        do
@@ -84,7 +90,13 @@ class ASTBuilder
                return new ADoExpr.make
        end
 
-       # Make a new condinionnal
+       # Make a new break for a given escapemark
+       fun make_break(escapemark: EscapeMark): ABreakExpr
+       do
+               return new ABreakExpr.make(escapemark)
+       end
+
+       # Make a new conditional
        # `mtype` is the return type of the whole if, in case of a ternary operator.
        fun make_if(condition: AExpr, mtype: nullable MType): AIfExpr
        do
@@ -116,17 +128,19 @@ redef class AExpr
        private var variable_cache: nullable Variable
 
        # The `detach` method completely remove the node in the parent.
-       # Owever, sometime, it is useful to keep the emplacement of the removed child.
+       # However, sometime, it is useful to keep the emplacement of the removed child.
        #
-       # The standard usecase is the insertion of a node beetwen a parent `p` and a child `p.c`.
+       # The standard use case is the insertion of a node between a parent `p` and a child `p.c`.
        # To create the new node `n`, we need to attach the child to it.
        # But, to put `n` where `c` was in `p`, the place has to be remembered.
        #
-       #     var p: AExpr
-       #     var c = p.c
-       #     var h = c.detach_with_placeholder
-       #     var n = astbuilder.make_XXX(c)
-       #     h.replace_with(n)
+       # ~~~nitish
+       # var p: AExpr
+       # var c = p.c
+       # var h = c.detach_with_placeholder
+       # var n = astbuilder.make_XXX(c)
+       # h.replace_with(n)
+       # ~~~
        fun detach_with_placeholder: AExpr
        do
                var h = new APlaceholderExpr.make
@@ -142,12 +156,21 @@ redef class AExpr
        # Note: this method, aimed to `ABlockExpr` is promoted to `AExpr` because of the limitations of the hierarchies generated by sablecc3
        fun add(expr: AExpr)
        do
+               print "add not implemented in {inspect}"
                abort
        end
+
+       redef fun accept_ast_validation(v)
+       do
+               super
+               if mtype == null and not is_typed then
+                       #debug "TYPING: untyped expression"
+               end
+       end
 end
 
 # A placeholder for a `AExpr` node
-# Instances are transiantly used to mark some specific emplacments in the AST
+# Instances are transiantly used to mark some specific emplacements in the AST
 # during complex transformations.
 #
 # Their must not appear in a valid AST
@@ -158,6 +181,12 @@ class APlaceholderExpr
        private init make
        do
        end
+
+       redef fun accept_ast_validation(v)
+       do
+               super
+               debug "PARENT: remaining placeholder"
+       end
 end
 
 redef class ABlockExpr
@@ -166,35 +195,60 @@ redef class ABlockExpr
                self.is_typed = true
        end
 
-       redef fun add(expr: AExpr)
+       redef fun add(expr)
        do
                n_expr.add expr
        end
 end
 
+redef class ALoopExpr
+       private init make
+       do
+               _n_kwloop = new TKwloop
+               self.is_typed = true
+               n_block = new ABlockExpr
+               n_block.is_typed = true
+       end
+
+       redef fun add(expr)
+       do
+               n_block.add expr
+       end
+end
+
 redef class ADoExpr
        private init make
        do
                _n_kwdo = new TKwdo
-               escapemark = new EscapeMark(null)
+               self.is_typed = true
+               n_block = new ABlockExpr
+               n_block.is_typed = true
        end
 
        # Make a new break expression of the given do
        fun make_break: ABreakExpr
        do
-               var escapemark = self.escapemark
+               var escapemark = self.break_mark
                if escapemark == null then
                        escapemark = new EscapeMark(null)
-                       self.escapemark = escapemark
+                       self.break_mark = escapemark
                end
                return new ABreakExpr.make(escapemark)
        end
+
+       redef fun add(expr)
+       do
+               n_block.add expr
+       end
 end
 
 redef class ABreakExpr
        private init make(escapemark: EscapeMark)
        do
+               _n_kwbreak = new TKwbreak
                self.escapemark = escapemark
+               escapemark.escapes.add self
+               self.is_typed = true
        end
 end
 
@@ -204,7 +258,9 @@ redef class AIfExpr
                _n_kwif = new TKwif
                _n_expr = condition
                _n_expr.parent = self
+               _n_kwthen = new TKwthen
                _n_then = new ABlockExpr.make
+               _n_kwelse = new TKwelse
                _n_else = new ABlockExpr.make
                self.mtype = mtype
                self.is_typed = true
@@ -214,15 +270,18 @@ end
 redef class AType
        private init make
        do
-               _n_id = new TClassid
+               var n_id = new TClassid
+               var n_qid = new AQclassid
+               n_qid.n_id = n_id
+               _n_qid = n_qid
        end
 end
 
-redef class ADecIntExpr
+redef class AIntegerExpr
        private init make(value: Int, t: MType)
        do
                self.value = value
-               self._n_number = new TNumber # dummy
+               self._n_integer = new TInteger # dummy
                self.mtype = t
        end
 end
@@ -237,7 +296,12 @@ redef class ANewExpr
                        n_args.n_exprs.add_all(args)
                end
                self.callsite = callsite
-               self.mtype = callsite.recv
+               self.recvtype = callsite.recv.as(MClassType)
+               if callsite.mproperty.is_new then
+                       self.mtype = callsite.msignature.return_mtype
+               else
+                       self.mtype = callsite.recv
+               end
                self.is_typed = true
        end
 end
@@ -247,11 +311,11 @@ redef class ACallExpr
        do
                self._n_expr = recv
                _n_args = new AListExprs
-               _n_id = new TId
+               _n_qid = new AQid
+               _n_qid.n_id = new TId
                if args != null then
                        self.n_args.n_exprs.add_all(args)
                end
-               var mtype = recv.mtype.as(not null)
                self.callsite = callsite
                self.mtype = callsite.msignature.return_mtype
                self.is_typed = true
@@ -304,3 +368,66 @@ redef class AVarAssignExpr
        end
 end
 
+# Check the consitency of AST
+class ASTValidationVisitor
+       super Visitor
+       redef fun visit(node)
+       do
+               node.accept_ast_validation(self)
+       end
+       private var path = new CircularArray[ANode]
+       private var seen = new HashSet[ANode]
+end
+
+redef class ANode
+       # Recursively validate a AST node.
+       # This ensure that location and parenting are defined and coherent.
+       #
+       # After complex low-level AST manipulation and construction,
+       # it is recommended to call it.
+       #
+       # Note: this just instantiate and run an `ASTValidationVisitor`.
+       fun validate
+       do
+               (new ASTValidationVisitor).enter_visit(self)
+       end
+
+       private fun accept_ast_validation(v: ASTValidationVisitor)
+       do
+               var parent = self.parent
+               var path = v.path
+
+               if path.length > 0 then
+                       var path_parent = v.path.first
+                       if parent == null then
+                               self.parent = path_parent
+                               #debug "PARENT: expected parent: {path_parent}"
+                               v.seen.add(self)
+                       else if parent != path_parent then
+                               self.parent = path_parent
+                               if v.seen.has(self) then
+                                       debug "DUPLICATE (NOTATREE): already seen node with parent {parent} now with {path_parent}."
+                               else
+                                       v.seen.add(self)
+                                       debug "PARENT: expected parent: {path_parent}, got {parent}"
+                               end
+                       end
+               end
+
+               if not isset _location then
+                       #debug "LOCATION: unlocated node {v.path.join(", ")}"
+                       _location = self.parent.location
+               end
+
+               path.unshift(self)
+               visit_all(v)
+               path.shift
+       end
+end
+
+redef class AAnnotation
+       redef fun accept_ast_validation(v)
+       do
+               # Do not enter in annotations
+       end
+end