compile: compile_stmt is a noop on null PExpr
[nit.git] / src / compiling / compiling_methods.nit
index 2dfb4a4..4955594 100644 (file)
@@ -24,6 +24,8 @@ redef class CompilerVisitor
        # Compile a statment node
        meth compile_stmt(n: PExpr)
        do
+               if n == null then return
+               add_instr("/* Compile stmt {n.locate} */")
                n.prepare_compile_stmt(self)
                var i = cfc._variable_index
                n.compile_stmt(self)
@@ -33,25 +35,27 @@ redef class CompilerVisitor
        # Compile is expression node
        meth compile_expr(n: PExpr): String
        do
+               add_instr("/* Compile expr {n.locate} */")
                var i = cfc._variable_index
                var s = n.compile_expr(self)
                cfc._variable_index = i
-               if s[0] == ' ' then
+               if s[0] == ' ' or cfc.is_valid_variable(s) then
                        return s
                end
-               var v = cfc.get_var
+               var v = cfc.get_var("Result for expr {n.locate}")
                add_assignment(v, s)
                return v
        end
 
        # Ensure that a c expression is a var
-       meth ensure_var(s: String): String
+       meth ensure_var(s: String, comment: String): String
        do
-               if s.substring(0,3) == "variable" then
+               if cfc.is_valid_variable(s) then
+                       add_instr("/* Ensure var {s}: {comment}*/")
                        return s
                end
-               var v = cfc.get_var
-               add_assignment(v, s)
+               var v = cfc.get_var(null)
+               add_assignment(v, "{s} /* Ensure var: {comment}*/")
                return v
        end
 
@@ -149,37 +153,40 @@ class CFunctionContext
        # Total number of variable
        attr _variable_index_max: Int = 0
 
-       # Association between nit variable and the corrsponding c variable
-       attr _varnames: Map[Variable, String] = new HashMap[Variable, String]
+       # Association between nit variable and the corrsponding c variable index
+       attr _varindexes: Map[Variable, Int] = new HashMap[Variable, Int]
 
        # Are we currenlty in a closure definition?
-       readable writable attr _in_closure: Bool = false
+       readable writable attr _closure: NitMethodContext = null
 
+       # Return the cvariable of a Nit variable
        meth varname(v: Variable): String
        do
-               if _in_closure then
-                       return "closctx->{_varnames[v]}"
+               if v isa ClosureVariable then
+                       return closure_variable(_varindexes[v])
                else
-                       return _varnames[v]
+                       return variable(_varindexes[v])
                end
        end
 
        # Return the next available variable
-       meth get_var: String
+       meth get_var(comment: String): String
        do
                var v = variable(_variable_index)
                _variable_index = _variable_index + 1
                if _variable_index > _variable_index_max then
-                       #visitor.add_decl("val_t {v};")
                        _variable_index_max = _variable_index 
                end
+               if comment != null then
+                       visitor.add_instr("/* Register {v}: {comment} */")
+               end
                return v
        end
 
        meth register_variable(v: Variable): String
        do
-               var s = get_var
-               _varnames[v] = "variable[{_variable_index-1}]"
+               _varindexes[v] = _variable_index
+               var s = get_var("Local variable")
                return s
        end
 
@@ -189,23 +196,54 @@ class CFunctionContext
        meth register_closurevariable(v: ClosureVariable): String
        do
                var s = "closurevariable[{_closurevariable_index}]"
+               _varindexes[v] = _closurevariable_index
                _closurevariable_index += 1
-               _varnames[v] = s
-               if _in_closure then
+               if _closure != null then
                        return "(closctx->{s})"
                else
                        return s
                end
        end
 
-       # Return the ith variable
+       # Return the ith cvariable
        protected meth variable(i: Int): String
        do
-               if _in_closure then
-                       return "(closctx->variable[{i}])"
+               if closure != null then
+                       var vn = once new Array[String]
+                       if vn.length <= i then
+                               for j in [vn.length..i] do
+                                       vn[j] = "(closctx->variable[{j}])"
+                               end
+                       end
+                       return vn[i]
                else
-                       return "variable[{i}]"
+                       var vn = once new Array[String]
+                       if vn.length <= i then
+                               for j in [vn.length..i] do
+                                       vn[j] = "variable[{j}]"
+                               end
+                       end
+                       return vn[i]
+               end
+       end
+
+       # Return the ith closurevariable
+       protected meth closure_variable(i: Int): String
+       do
+               if closure != null then
+                       return "(closctx->closurevariable[{i}])"
+               else
+                       return "closurevariable[{i}]"
+               end
+       end
+
+       # Is s a valid variable
+       protected meth is_valid_variable(s: String): Bool
+       do
+               for i in [0.._variable_index[ do
+                       if s == variable(i) then return true
                end
+               return false
        end
 
        # Mark the variable available
@@ -227,9 +265,9 @@ class CFunctionContext
                        visitor.add_decl("val_t *variable = NULL;")
                end
                if _closurevariable_index > 0 then
-                       visitor.add_decl("void *closurevariable[{_closurevariable_index}];")
+                       visitor.add_decl("struct WBT_ *closurevariable[{_closurevariable_index}];")
                else
-                       visitor.add_decl("void **closurevariable = NULL;")
+                       visitor.add_decl("struct WBT_ **closurevariable = NULL;")
                end
        end
 
@@ -320,12 +358,70 @@ redef class MMMethod
                end
        end
 
+       # Compile a call on self for given arguments and given closures
+       meth compile_call_and_closures(v: CompilerVisitor, cargs: Array[String], clos_defs: Array[PClosureDef]): String
+       do
+               var ve: String = null
+               var arity = 0
+               if clos_defs != null then arity = clos_defs.length
+
+               # Prepare result value.
+               # In case of procedure, the return value is still used to intercept breaks
+               var old_bv = v.nmc.break_value
+               ve = v.cfc.get_var("Closure return value and escape marker")
+               v.nmc.break_value = ve
+
+               # Compile closure to c function
+               var realcargs = new Array[String] # Args to pass to the C function call
+               var closcns = new Array[String] # Closure C structure names
+               realcargs.add_all(cargs)
+               for i in [0..arity[ do
+                       var cn = clos_defs[i].compile_closure(v, closure_cname(i))
+                       closcns.add(cn)
+                       realcargs.add(cn)
+               end
+               for i in [arity..signature.closures.length[ do
+                       realcargs.add("NULL")
+               end
+
+               v.nmc.break_value = old_bv
+
+               # Call
+               var e = compile_call(v, realcargs)
+               if e != null then
+                       v.add_assignment(ve, e)
+                       e = ve
+               end
+
+               # Intercept returns and breaks
+               for i in [0..arity[ do
+                       # A break or a return is intercepted
+                       v.add_instr("if ({closcns[i]}->has_broke != NULL) \{")
+                       v.indent
+                       # A passtrought break or a return is intercepted: go the the next closure
+                       v.add_instr("if ({closcns[i]}->has_broke != &({ve})) \{")
+                       v.indent
+                       if v.cfc.closure == v.nmc then v.add_instr("closctx->has_broke = {closcns[i]}->has_broke; closctx->broke_value = {closcns[i]}->broke_value;")
+                       v.add_instr("goto {v.nmc.return_label};")
+                       v.unindent
+                       # A direct break is interpected
+                       if e != null then
+                               # overwrite the returned value in a function
+                               v.add_instr("\} else {ve} = {closcns[i]}->broke_value;")
+                       else
+                               # Do nothing in a procedure
+                               v.add_instr("\}")
+                       end
+                       v.unindent
+                       v.add_instr("\}")
+               end
+               return e
+       end
+
        # Compile a call as constructor with given args
        meth compile_constructor_call(v: CompilerVisitor, recvtype: MMType, cargs: Array[String]): String
        do
-               var recv = v.cfc.get_var
-               v.add_instr("{recv} = NEW_{recvtype.local_class}_{global.intro.cname}({cargs.join(", ")}); /*new {recvtype}*/")
-               return recv
+               return "NEW_{recvtype.local_class}_{global.intro.cname}({cargs.join(", ")}) /*new {recvtype}*/"
        end
 
        # Compile a call as call-next-method on self with given args
@@ -339,7 +435,7 @@ redef class MMMethod
        # Cname of the i-th closure C struct type
        protected meth closure_cname(i: Int): String
        do
-               return "WBT_{cname}_{i}"
+               return "FWBT_{cname}_{i}"
        end
 end
 
@@ -374,17 +470,15 @@ redef class MMSrcMethod
                        var closcn = closure_cname(i)
                        var cs = signature.closures[i].signature # Closure signature
                        var subparams = new Array[String] # Parameters of the closure
-                       subparams.add("struct {closcn}*")
+                       subparams.add("struct WBT_ *")
                        for j in [0..cs.arity[ do
                                var p = "val_t"
                                subparams.add(p)
                        end
                        var r = "void"
                        if cs.return_type != null then r = "val_t"
-                       params.add("struct {closcn} *{args[first_closure_index+i]}")
-                       v.add_decl("struct {closcn};")
-                       v.add_decl("typedef {r} (*F{closcn})({subparams.join(", ")});")
-                       v.add_decl("struct {closcn} \{F{closcn} fun; val_t *has_broke; val_t broke_value; val_t *variable; void **closurevariable;\};")
+                       params.add("struct WBT_ *{args[first_closure_index+i]}")
+                       v.add_decl("typedef {r} (*{closcn})({subparams.join(", ")});")
                end
 
                if global.is_init then
@@ -552,7 +646,7 @@ redef class ASignature
                for i in [0..n_closure_decls.length[ do
                        var wd = n_closure_decls[i]
                        var cname = v.cfc.register_closurevariable(wd.variable)
-                       wd.variable.ctypename = "struct {v.nmc.method.closure_cname(i)} *"
+                       wd.variable.ctypename = v.nmc.method.closure_cname(i)
                        v.add_assignment(cname, "{params[orig_sig.arity + i]}")
                end
        end
@@ -583,13 +677,11 @@ redef class AConcreteMethPropdef
                end
 
                v.nmc.return_label = "return_label{v.new_number}"
-               v.nmc.return_value = v.cfc.get_var
+               v.nmc.return_value = v.cfc.get_var("Method return value and escape marker")
                if self isa AConcreteInitPropdef then
                        v.invoke_super_init_calls_after(null)
                end
-               if n_block != null then
-                       v.compile_stmt(n_block)
-               end
+               v.compile_stmt(n_block)
                v.add_instr("{v.nmc.return_label}: while(false);")
                if self isa AConcreteInitPropdef then
                        v.add_instr("init_table[{itpos}] = 1;")
@@ -870,7 +962,7 @@ redef class AReturnExpr
                        var e = v.compile_expr(n_expr)
                        v.add_assignment(v.nmc.return_value, e)
                end
-               if v.cfc.in_closure then v.add_instr("closctx->has_broke = &({v.nmc.return_value});")
+               if v.cfc.closure == v.nmc then v.add_instr("closctx->has_broke = &({v.nmc.return_value});")
                v.add_instr("goto {v.nmc.return_label};")
        end
 end
@@ -882,7 +974,7 @@ redef class ABreakExpr
                        var e = v.compile_expr(n_expr)
                        v.add_assignment(v.nmc.break_value, e)
                end
-               if v.cfc.in_closure then v.add_instr("closctx->has_broke = &({v.nmc.break_value}); closctx->broke_value = *closctx->has_broke;")
+               if v.cfc.closure == v.nmc then v.add_instr("closctx->has_broke = &({v.nmc.break_value}); closctx->broke_value = *closctx->has_broke;")
                v.add_instr("goto {v.nmc.break_label};")
        end
 end
@@ -908,9 +1000,7 @@ end
 redef class ADoExpr
        redef meth compile_stmt(v)
        do
-                if n_block != null then
-                        v.compile_stmt(n_block)
-                end
+               v.compile_stmt(n_block)
        end
 end
 
@@ -942,12 +1032,12 @@ redef class AIfexprExpr
                v.add_instr("if (UNTAG_Bool({e})) \{ /*if*/")
                v.cfc.free_var(e)
                v.indent
-               var e = v.ensure_var(v.compile_expr(n_then))
+               var e = v.ensure_var(v.compile_expr(n_then), "Then value")
                v.unindent
                v.add_instr("} else \{ /*if*/")
                v.cfc.free_var(e)
                v.indent
-               var e2 = v.ensure_var(v.compile_expr(n_else))
+               var e2 = v.ensure_var(v.compile_expr(n_else), "Else value")
                v.add_assignment(e, e2)
                v.unindent
                v.add_instr("}")
@@ -981,9 +1071,7 @@ redef class AWhileExpr
                var e = v.compile_expr(n_expr)
                v.add_instr("if (!UNTAG_Bool({e})) break; /* while*/")
                v.cfc.free_var(e)
-               if n_block != null then
-                       v.compile_stmt(n_block)
-               end
+               v.compile_stmt(n_block)
                v.add_instr("{v.nmc.continue_label}: while(0);")
                v.unindent
                v.add_instr("}")
@@ -994,34 +1082,22 @@ end
 redef class AForExpr
        redef meth compile_inside_block(v)
        do
-               v.compile_stmt(n_vardecl)
-       end
-end
-
-redef class AForVardeclExpr
-       redef meth compile_stmt(v)
-       do
                var e = v.compile_expr(n_expr)
                var ittype = meth_iterator.signature.return_type
                v.cfc.free_var(e)
-               var iter = v.cfc.get_var
+               var iter = v.cfc.get_var("For iterator")
                v.add_assignment(iter, meth_iterator.compile_call(v, [e]))
                v.add_instr("while (true) \{ /*for*/")
                v.indent
-               var ok = v.cfc.get_var
+               var ok = v.cfc.get_var("For 'is_ok' result")
                v.add_assignment(ok, meth_is_ok.compile_call(v, [iter]))
                v.add_instr("if (!UNTAG_Bool({ok})) break; /*for*/")
                v.cfc.free_var(ok)
                var e = meth_item.compile_call(v, [iter])
-               e = v.ensure_var(e)
+               e = v.ensure_var(e, "For item")
                var cname = v.cfc.register_variable(variable)
                v.add_assignment(cname, e)
-               var par = parent
-               assert par isa AForExpr
-               var n_block = par.n_block
-               if n_block != null then
-                       v.compile_stmt(n_block)
-               end
+               v.compile_stmt(n_block)
                v.add_instr("{v.nmc.continue_label}: while(0);")
                e = meth_next.compile_call(v, [iter])
                assert e == null
@@ -1078,7 +1154,7 @@ end
 redef class AOrExpr
        redef meth compile_expr(v)
        do
-               var e = v.ensure_var(v.compile_expr(n_expr))
+               var e = v.ensure_var(v.compile_expr(n_expr), "Left 'or' operand")
                v.add_instr("if (!UNTAG_Bool({e})) \{ /* or */")
                v.cfc.free_var(e)
                v.indent
@@ -1093,7 +1169,7 @@ end
 redef class AAndExpr
        redef meth compile_expr(v)
        do
-               var e = v.ensure_var(v.compile_expr(n_expr))
+               var e = v.ensure_var(v.compile_expr(n_expr), "Left 'and' operand")
                v.add_instr("if (UNTAG_Bool({e})) \{ /* and */")
                v.cfc.free_var(e)
                v.indent
@@ -1178,7 +1254,7 @@ redef class AStringFormExpr
        do
                compute_string_info
                var i = v.new_number
-               var cvar = v.cfc.get_var
+               var cvar = v.cfc.get_var("Once String constant")
                v.add_decl("static val_t once_value_{i} = NIT_NULL; /* Once value for string {cvar}*/")
                v.add_instr("if (once_value_{i} != NIT_NULL) {cvar} = once_value_{i};")
                v.add_instr("else \{")
@@ -1244,12 +1320,15 @@ redef class ASuperstringExpr
        redef meth compile_expr(v)
        do
                var array = meth_with_capacity.compile_constructor_call(v, atype, ["TAG_Int({n_exprs.length})"])
+               array = v.ensure_var(array, "Array (for super-string)")
 
                for ne in n_exprs do
-                       var e = v.ensure_var(v.compile_expr(ne))
+                       var e = v.ensure_var(v.compile_expr(ne), "super-string element")
                        if ne.stype != stype then
-                               v.add_assignment(e, meth_to_s.compile_call(v, [e]))
+                               v.cfc.free_var(e)
+                               e = meth_to_s.compile_call(v, [e])
                        end
+                       v.cfc.free_var(e)
                        meth_add.compile_call(v, [array, e])
                end
 
@@ -1268,6 +1347,7 @@ redef class AArrayExpr
        redef meth compile_expr(v)
        do
                var recv = meth_with_capacity.compile_constructor_call(v, stype, ["TAG_Int({n_exprs.length})"])
+               recv = v.ensure_var(recv, "Literal array")
 
                for ne in n_exprs do
                        var e = v.compile_expr(ne)
@@ -1361,59 +1441,7 @@ redef class ASendExpr
                if prop_signature.closures.is_empty then
                        e = prop.compile_call(v, cargs)
                else
-                       var cd = closure_defs
-                       var arity = 0
-                       if cd != null then arity = cd.length
-                       var closcns = new Array[String]
-                       var ve: String = null
-
-                       # Prepare result value.
-                       # In case of procedure, the return value is still used to intercept breaks
-                       var old_bv = v.nmc.break_value
-                       ve = v.cfc.get_var
-                       v.nmc.break_value = ve
-
-                       # Compile closure to c function
-                       for i in [0..arity[ do
-                               var cn = cd[i].compile_closure(v, prop.closure_cname(i))
-                               closcns.add(cn)
-                               cargs.add(cn)
-                       end
-                       for i in [arity..prop_signature.closures.length[ do
-                               cargs.add("NULL")
-                       end
-
-                       v.nmc.break_value = old_bv
-
-                       # Call
-                       e = prop.compile_call(v, cargs)
-                       if e != null then 
-                               v.add_assignment(ve, e)
-                               e = ve
-                       end
-
-                       # Intercept returns and breaks
-                       for i in [0..arity[ do
-                               # A break or a return is intercepted
-                               v.add_instr("if ({closcns[i]}->has_broke != NULL) \{")
-                               v.indent
-                               # A passtrought break or a return is intercepted: go the the next closure
-                               v.add_instr("if ({closcns[i]}->has_broke != &({ve})) \{")
-                               v.indent
-                               if v.cfc.in_closure then v.add_instr("closctx->has_broke = {closcns[i]}->has_broke; closctx->broke_value = {closcns[i]}->broke_value;")
-                               v.add_instr("goto {v.nmc.return_label};")
-                               v.unindent
-                               # A direct break is interpected
-                               if e != null then
-                                       # overwrite the returned value in a function
-                                       v.add_instr("\} else {ve} = {closcns[i]}->broke_value;")
-                               else
-                                       # Do nothing in a procedure
-                                       v.add_instr("\}")
-                               end
-                               v.unindent
-                               v.add_instr("\}")
-                       end
+                       e = prop.compile_call_and_closures(v, cargs, closure_defs)
                end
 
                if prop.global.is_init then
@@ -1479,12 +1507,12 @@ redef class AClosureDef
                v.ctx = new CContext
                v.out_contexts.add(v.ctx)
 
-               var cfc_old = v.cfc.in_closure
-               v.cfc.in_closure = true
+               var cfc_old = v.cfc.closure
+               v.cfc.closure = v.nmc
 
                var old_rv = v.nmc.return_value
                var old_bv = v.nmc.break_value
-               if not cfc_old then
+               if cfc_old == null then
                        v.nmc.return_value = "closctx->{old_rv}"
                        v.nmc.break_value = "closctx->{old_bv}"
                end
@@ -1523,14 +1551,16 @@ redef class AClosureDef
                v.add_instr("}")
                v.ctx = ctx_old
 
-               v.cfc.in_closure = cfc_old
+               v.cfc.closure = cfc_old
                v.nmc.return_value = old_rv
                v.nmc.break_value = old_bv
 
                # Build closure
                var closcnv = "wbclos{v.new_number}"
-               v.add_decl("struct {closcn} {closcnv} = \{{cname}, NULL\};")
-               if cfc_old then 
+               v.add_decl("struct WBT_ {closcnv};")
+               v.add_instr("{closcnv}.fun = (fun_t){cname};")
+               v.add_instr("{closcnv}.has_broke = NULL;")
+               if cfc_old != null then 
                        v.add_instr("{closcnv}.variable = closctx->variable;")
                        v.add_instr("{closcnv}.closurevariable = closctx->closurevariable;")
                else
@@ -1544,7 +1574,7 @@ redef class AClosureDef
        protected meth decl_csignature(v: CompilerVisitor, args: Array[String], closcn: String): String
        do
                var params = new Array[String]
-               params.add("struct {closcn}* closctx")
+               params.add("struct WBT_ *closctx")
                for i in [0..closure.signature.arity[ do
                        var p = "val_t {args[i]}"
                        params.add(p)
@@ -1557,7 +1587,6 @@ redef class AClosureDef
                end
                var p = params.join(", ")
                var s = "{ret} {cname}({p})"
-               v.add_decl("struct {closcn};")
                v.add_decl("typedef {ret} (* {cname}_t)({p});")
                v.add_decl(s + ";")
                return s
@@ -1574,11 +1603,11 @@ redef class AClosureDef
                var old_cl = v.nmc.continue_label
                var old_bl = v.nmc.break_label
 
-               v.nmc.continue_value = v.cfc.get_var
+               v.nmc.continue_value = v.cfc.get_var("Continue value and escape marker")
                v.nmc.continue_label = "continue_label{v.new_number}"
                v.nmc.break_label = v.nmc.return_label
 
-               if n_expr != null then v.compile_stmt(n_expr)
+               v.compile_stmt(n_expr)
 
                v.add_instr("{v.nmc.continue_label}: while(false);")
 
@@ -1605,11 +1634,11 @@ redef class AClosureDecl
                var old_cl = v.nmc.continue_label
                var old_bl = v.nmc.break_label
 
-               v.nmc.continue_value = v.cfc.get_var
+               v.nmc.continue_value = v.cfc.get_var("Continue value and escape marker")
                v.nmc.continue_label = "continue_label{v.new_number}"
                v.nmc.break_label = v.nmc.return_label
 
-               if n_expr != null then v.compile_stmt(n_expr)
+               v.compile_stmt(n_expr)
 
                v.add_instr("{v.nmc.continue_label}: while(false);")
 
@@ -1630,7 +1659,7 @@ redef class AClosureCallExpr
                var cargs = new Array[String]
                for a in arguments do cargs.add(v.compile_expr(a))
                var va: String = null
-               if variable.closure.signature.return_type != null then va = v.cfc.get_var
+               if variable.closure.signature.return_type != null then va = v.cfc.get_var("Closure call result value")
 
                if variable.closure.is_optional then
                        v.add_instr("if({v.cfc.varname(variable)}==NULL) \{")
@@ -1644,10 +1673,10 @@ redef class AClosureCallExpr
                        v.indent
                end
 
-               var ivar = "(({variable.ctypename})({v.cfc.varname(variable)}))"
+               var ivar = v.cfc.varname(variable)
                var cargs2 = [ivar]
                cargs2.append(cargs)
-               var s = "({ivar}->fun({cargs2.join(", ")})) /* Invoke closure {variable} */"
+               var s = "(({variable.ctypename})({ivar}->fun))({cargs2.join(", ")}) /* Invoke closure {variable} */"
                if va != null then
                        v.add_assignment(va, s)
                else
@@ -1658,7 +1687,7 @@ redef class AClosureCallExpr
                if n_closure_defs != null and n_closure_defs.length == 1 then do
                        n_closure_defs.first.do_compile_inside(v, null)
                end
-               if v.cfc.in_closure then v.add_instr("if ({ivar}->has_broke) \{ closctx->has_broke = {ivar}->has_broke; closctx->broke_value = {ivar}->broke_value;\}")
+               if v.cfc.closure == v.nmc then v.add_instr("if ({ivar}->has_broke) \{ closctx->has_broke = {ivar}->has_broke; closctx->broke_value = {ivar}->broke_value;\}")
                v.add_instr("goto {v.nmc.return_label};")
                v.unindent
                v.add_instr("\}")
@@ -1682,7 +1711,7 @@ redef class AOnceExpr
        redef meth compile_expr(v)
        do
                var i = v.new_number
-               var cvar = v.cfc.get_var
+               var cvar = v.cfc.get_var("Once expression result")
                v.add_decl("static val_t once_value_{i}; static int once_bool_{i}; /* Once value for {cvar}*/")
                v.add_instr("if (once_bool_{i}) {cvar} = once_value_{i};")
                v.add_instr("else \{")