nullable: convert lib, tools and tests
[nit.git] / src / syntax / syntax_base.nit
index 3da7ef7..21cfba4 100644 (file)
@@ -29,9 +29,9 @@ special MMModule
        # Concrete NIT source local classs by name
        readable attr _src_local_classes: Map[Symbol, MMSrcLocalClass]
 
-       init(c: MMContext, source: AModule, dir: MMDirectory, name: Symbol)
+       init(c: MMContext, source: AModule, dir: MMDirectory, name: Symbol, filename: String)
        do
-               super(name, dir, c)
+               super(name, dir, c, filename)
                _node = source
                _src_local_classes = new HashMap[Symbol, MMSrcLocalClass]
        end
@@ -63,14 +63,14 @@ special MMConcreteClass
        readable attr _nodes: Array[PClassdef]
 
        # Concrete NIT source generic formal parameter by name
-       readable writable attr _formal_dict: Map[Symbol, MMTypeFormalParameter]
+       readable attr _formal_dict: Map[Symbol, MMTypeFormalParameter] = new HashMap[Symbol, MMTypeFormalParameter]
 
        # Concrete NIT source properties by name
-       readable attr _src_local_properties: Map[Symbol, MMLocalProperty] 
+       readable attr _src_local_properties: Map[Symbol, MMLocalProperty]
 
-       init(n: Symbol, cla: PClassdef, a: Int)
+       init(mod: MMSrcModule, n: Symbol, cla: PClassdef, a: Int)
        do
-               super(n, a)
+               super(mod, n, a)
                _nodes = [cla]
                _src_local_properties = new HashMap[Symbol, MMLocalProperty]
        end
@@ -101,7 +101,7 @@ end
 
 redef class MMLocalProperty
        # The attached node (if any)
-       meth node: PNode do return null
+       meth node: nullable PNode do return null
 
        # Is the concrete method defined as init
        meth is_init: Bool do return false
@@ -156,8 +156,8 @@ end
 class MMMethSrcMethod
 special MMSrcMethod
        redef meth is_init do return _node isa AConcreteInitPropdef
-       redef readable attr _node: AMethPropdef
-       init(name: Symbol, cla: MMLocalClass, n: AMethPropdef)
+       redef readable attr _node: nullable AMethPropdef
+       init(name: Symbol, cla: MMLocalClass, n: nullable AMethPropdef)
        do
                super(name, cla)
                _node = n
@@ -193,22 +193,20 @@ end
 # Local variables
 abstract class Variable
        # Name of the variable
-       readable attr _name: Symbol 
+       readable attr _name: Symbol
 
        # Declaration AST node
-       readable attr _decl: PNode
+       readable attr _decl: nullable PNode
 
        # Static type
-       readable writable attr _stype: MMType 
+       readable writable attr _stype: nullable MMType
 
        redef meth to_s do return _name.to_s
 
        meth kind: String is abstract
 
-       init(n: Symbol, d: PNode)
+       init(n: Symbol, d: nullable PNode)
        do
-               #assert n != null
-               #assert d != null
                _name = n
                _decl = d
        end
@@ -225,7 +223,7 @@ end
 class ParamVariable
 special Variable
        redef meth kind do return once "parameter"
-       init(n: Symbol, d: PNode) do super
+       init(n: Symbol, d: nullable PNode) do super
 end
 
 # Automatic variable (like in the 'for' statement)
@@ -242,12 +240,12 @@ special Variable
        redef meth kind do return once "closure"
 
        # The signature of the closure
-       readable attr _signature: MMSignature
+       readable attr _closure: MMClosure
 
-       init(n: Symbol, d: PNode, s: MMSignature)
+       init(n: Symbol, d: PNode, c: MMClosure)
        do
                super(n, d)
-               _signature = s
+               _closure = c
        end
 end
 
@@ -256,6 +254,12 @@ end
 # Visitor used during the syntax analysis
 class AbsSyntaxVisitor
 special Visitor
+       # The root type Object
+       meth type_object: MMType
+       do
+               return _module.class_by_name(once ("Object".to_symbol)).get_type
+       end
+
        # The primitive type Bool
        meth type_bool: MMType
        do
@@ -286,10 +290,10 @@ special Visitor
                return _module.class_by_name(once ("String".to_symbol)).get_type
        end
 
-       # The primitive type Collection[Object]
+       # The primitive type Collection[nullable Object]
        meth type_collection: MMType
        do
-               return _module.class_by_name(once ("Collection".to_symbol)).get_type
+               return _module.class_by_name(once ("Collection".to_symbol)).get_instantiate_type([type_object.as_nullable])
        end
 
        # The primitive type Array[?]
@@ -317,59 +321,70 @@ special Visitor
        end
 
        # The current module
-       readable writable attr _module: MMSrcModule 
+       readable attr _module: MMSrcModule
 
        # The current class
-       readable writable attr _local_class: MMSrcLocalClass 
+       meth local_class: MMSrcLocalClass do return _local_class.as(not null)
+       writable attr _local_class: nullable MMSrcLocalClass
 
        # The current property
-       readable writable attr _local_property: MMLocalProperty
+       meth local_property: MMLocalProperty do return _local_property.as(not null)
+       writable attr _local_property: nullable MMLocalProperty
 
        # The current tool configuration/status
        readable attr _tc: ToolContext 
 
        # Display an error for a given syntax node
-       meth error(n: PNode, s: String)
+       meth error(n: nullable PNode, s: String)
        do
                _tc.error("{locate(n)}: {s}")
        end
 
        # Display a warning for a given syntax node
-       meth warning(n: PNode, s: String)
+       meth warning(n: nullable PNode, s: String)
        do
                _tc.warning("{locate(n)}: {s}")
        end
 
        #
-       meth locate(n: PNode): String
+       meth locate(n: nullable PNode): String
        do
                if n != null then return n.locate
                return _module.filename
        end
 
        # Check conformity and display error
-       meth check_conform(n: PNode, subtype: MMType, stype: MMType): Bool
+       meth check_conform(n: PNode, subtype: nullable MMType, stype: nullable MMType): Bool
        do
                if stype == null or subtype == null then
                        return false
                end
-               if subtype < stype then
+               if subtype < stype  then
+                       return true
+               end
+               # Do not enforce nullable subtype rules yet
+               if subtype isa MMTypeNone or subtype.as_notnull < stype.as_notnull then
+                       warning(n, "Nullable type warning: expected {stype}, got {subtype}")
                        return true
                end
-               #error(n, "Type error: expected {stype}'{stype.module}, got {subtype}'{subtype.module}")
-               #abort
                error(n, "Type error: expected {stype}, got {subtype}")
                return false
        end
-       
+
        # Check that an expression has a static type and that 
        # Display an error and return false if n is a statement
        # Require that the static type of n is known
        meth check_expr(n: PExpr): Bool
        do
-               # FIXME: The tc.error_count is a workaround since currently there is no way
-               # to distingate statements from buggy expressions: both have a null stype
-               if tc.error_count == 0 and n.stype == null then
+               if not n.is_typed then
+                       if tc.error_count == 0 then
+                               print("{n.locate} not typed but not error")
+                               abort
+                       end
+                       # An error occured in a sub node,
+                       # sillently cascade fail
+                       return false
+               else if n.is_statement then
                        error(n, "Type error: expected expression.")
                        return false
                end
@@ -377,11 +392,50 @@ special Visitor
        end
 
        # Combine check_conform and check_expr
-       meth check_conform_expr(n: PExpr, stype: MMType): Bool
+       meth check_conform_expr(n: PExpr, stype: nullable MMType): Bool
        do
+               if stype == null then return false
                if check_expr(n) then return check_conform(n, n.stype, stype) else return false
        end
 
+       # Check conformance between multiple expressions and a static type
+       # Conformance is granted if among them there is a most general type
+       # Return the most general type if a conformance is found
+       # Display an error and return null if no conformance is found
+       # The only allowed combinaison is with the nullable marker
+       # @param stype is a possible additional type (without node)
+       # Examples:
+       #   Int, Int, Object => return Object
+       #   Int, Float => display error, return null
+       #   nullable Int, Object => return nullable Object
+       meth check_conform_multiexpr(stype: nullable MMType, nodes: Collection[PExpr]): nullable MMType
+       do
+               var node: nullable PExpr = null # candidate node
+               for n in nodes do
+                       if not check_expr(n) then return null
+                       var ntype = n.stype
+                       if stype != null and stype.is_nullable != ntype.is_nullable then
+                               # nullable combinaison: if one of them is nulable, considers that both are
+                               stype = stype.as_nullable
+                               ntype = ntype.as_nullable
+                       end
+                       if stype == null or stype < ntype then
+                               stype = ntype
+                               node = n
+                       end
+               end
+               for n in nodes do
+                       if not n.stype < stype.as(not null) then
+                               if node == null then
+                                       error(n, "Type error: no most general type. Got {n.stype} and {stype}.")
+                               else
+                                       error(n, "Type error: no most general type. Got {n.stype} and {stype} at {node.locate}.")
+                               end
+                               return null
+                       end
+               end
+               return stype
+       end
 
        protected init(tc: ToolContext, module: MMSrcModule)
        do
@@ -397,16 +451,16 @@ redef class PNode
 end
 
 redef class Token
-       attr _symbol: Symbol
+       attr _symbol_cache: nullable Symbol
 
        # Symbol associated with the text
        # Lazily computed
        meth to_symbol: Symbol
        do
-               var s = _symbol
+               var s = _symbol_cache
                if s == null then
                        s = text.to_symbol
-                       _symbol = s
+                       _symbol_cache = s
                end
                return s
        end
@@ -422,10 +476,10 @@ redef class AAttrPropdef
        meth prop: MMSrcAttribute is abstract
 
        # Associated read accessor (MM entity)
-       meth readmethod: MMSrcMethod is abstract
+       meth readmethod: nullable MMSrcMethod is abstract
 
        # Associated write accessor (MM entity)
-       meth writemethod: MMSrcMethod is abstract
+       meth writemethod: nullable MMSrcMethod is abstract
 end
 
 redef class AMethPropdef
@@ -450,10 +504,7 @@ redef class PParam
 end
 
 redef class PClosureDecl
-       # The signature of the declared closure
-       meth signature: MMSignature is abstract
-
-       # Associated bloc variable
+       # Associated closure variable
        meth variable: ClosureVariable is abstract
 end
 
@@ -461,17 +512,17 @@ redef class PType
        # Retrieve the local class corresponding to the type.
        # Display an error and return null if there is no class
        # Display an error and return null if the type is not class based (formal one)
-       meth get_local_class(v: AbsSyntaxVisitor): MMLocalClass is abstract
+       meth get_local_class(v: AbsSyntaxVisitor): nullable MMLocalClass is abstract
 
        # Retrieve corresponding static type.
        # Display an error and return null if there is a problem
-       meth get_stype(v: AbsSyntaxVisitor): MMType is abstract
+       meth get_stype(v: AbsSyntaxVisitor): nullable MMType is abstract
 
        # Retrieve corresponding static type.
        # Display an error and return null if there is a problem
        # But do not performs any subtype check.
        # get_unchecked_stype should be called to check that the static type is fully valid
-       meth get_unchecked_stype(v: AbsSyntaxVisitor): MMType is abstract
+       meth get_unchecked_stype(v: AbsSyntaxVisitor): nullable MMType is abstract
 
        # Check that a static definition type is conform with regard to formal types
        # Useful with get_unchecked_stype
@@ -480,7 +531,7 @@ redef class PType
 end
 
 redef class AType
-       attr _stype_cache: MMType
+       attr _stype_cache: nullable MMType = null
        attr _stype_cached: Bool = false
 
        redef meth get_local_class(v)
@@ -489,7 +540,7 @@ redef class AType
                var mod = v.module
                var cla = v.local_class
 
-               if (cla.formal_dict != null and cla.formal_dict.has_key(name)) or (cla.global_properties != null and cla.has_global_property_by_name(name)) then
+               if cla.formal_dict.has_key(name) or cla.has_global_property_by_name(name) then
                        v.error(n_id, "Type error: {name} is a formal type")
                        _stype_cached = true
                        return null
@@ -514,27 +565,30 @@ redef class AType
                var name = n_id.to_symbol
                var mod = v.module
                var cla = v.local_class
+               var t: nullable MMType
 
                if cla.formal_dict.has_key(name) then
                        if n_types.length > 0 then
                                v.error(self, "Type error: formal type {name} cannot have formal parameters.")
                                return null
                        end
-                       var formal = cla.formal_dict[name]
-                       _stype_cache = formal
-                       return formal
+                       t = cla.formal_dict[name]
+                       if n_kwnullable != null then t = t.as_nullable
+                       _stype_cache = t
+                       return t
                end
 
-               if cla.global_properties != null and cla.has_global_property_by_name(name) then
+               if cla.has_global_property_by_name(name) then
                        if n_types.length > 0 then
                                v.error(self, "Type error: formal type {name} cannot have formal parameters.")
                                return null
                        end
-                       var t = cla.get_type.local_class.select_virtual_type(name).stype_for(cla.get_type)
+                       t = cla.get_type.local_class.select_virtual_type(name).stype_for(cla.get_type)
                        if t == null then
                                v.error(self, "Type error: circular definition in formal type {name}.")
                                return null
                        end
+                       if n_kwnullable != null then t = t.as_nullable
                        _stype_cache = t
                        return t
                end
@@ -551,22 +605,25 @@ redef class AType
                if arity > 0 then
                        var tab = new Array[MMType]
                        for p in n_types do
-                               tab.add(p.get_unchecked_stype(v))
+                               var t2 = p.get_unchecked_stype(v)
+                               if t2 == null then return null
+                               tab.add(t2)
                        end
-                       var t = local_class.get_instantiate_type(tab)
-                       _stype_cache = t
-                       return t
+                       t = local_class.get_instantiate_type(tab)
                else
-                       var t = local_class.get_type
-                       _stype_cache = t
-                       return t
+                       t = local_class.get_type
                end
+               if n_kwnullable != null then t = t.as_nullable
+               _stype_cache = t
+               return t
        end
        
        redef meth get_stype(v)
        do
                var t = get_unchecked_stype(v)
-               if t != null then check_conform(v)
+               if t == null then return null
+               if not t.is_valid then return null
+               check_conform(v)
                return t
        end
 
@@ -580,8 +637,9 @@ redef class AType
                        for i in [0..arity[ do
                                var p = n_types[i]
                                var pt = p.get_stype(v)
-                               var bt = local_class.get_formal(i).bound
-                               if bt == null then return
+                               var b = local_class.get_formal(i)
+                               if not b.is_valid then return
+                               var bt = b.bound
                                bt = bt.adapt_to(st) # We need to abapt because of F-genericity
                                v.check_conform(p, pt, bt)
                        end
@@ -590,40 +648,55 @@ redef class AType
 end
 
 redef class PExpr
-       # Static type
-       # Is null for statement and for erronus expression
+       # Is the expression node correcly typed
+       # Return false if typed was not yet computed or
+       # if an error occured during the typing computation
+       meth is_typed: Bool is abstract
+
+       # Is the expression node a statement? (ie has no return value)
+       # require: is_typed
+       meth is_statement: Bool is abstract
+
+       # The static type of the expression
+       # require: is_typed and not is_statement
        meth stype: MMType is abstract
 end
 
 redef class AVardeclExpr
        # Assiociated local variable
-       readable writable attr _variable: VarVariable
+       meth variable: VarVariable is abstract
+       #readable writable attr _variable: nullable VarVariable
 end
 
-redef class AForVardeclExpr
+redef class AForExpr
        # Associated automatic local variable
-       readable writable attr _variable: AutoVariable
+       meth variable: AutoVariable is abstract
+       #readable writable attr _variable: nullable AutoVariable
 end
 
 redef class ASelfExpr
        # Associated local variable
-       readable writable attr _variable: ParamVariable 
+       meth variable: ParamVariable is abstract
+       #readable writable attr _variable: nullable ParamVariable
 end
 
 redef class AVarFormExpr
        # Associated local variable
-       readable writable attr _variable: Variable 
+       meth variable: Variable is abstract
+       #readable writable attr _variable: nullable Variable
 end
 
 redef class AClosureCallExpr
        # Associated closure variable
-       readable writable attr _variable: ClosureVariable
+       meth variable: ClosureVariable is abstract
+       #readable writable attr _variable: nullable ClosureVariable
 end
 
 redef class PClosureDef
-       # Associated signature
-       readable writable attr _signature: MMSignature
+       # Associated closure
+       #readable writable attr _closure: nullable MMClosure
+       meth closure: MMClosure is abstract
 
        # Automatic variables
-       readable writable attr _variables: Array[AutoVariable]
+       readable writable attr _variables: nullable Array[AutoVariable]
 end