1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Analysis and verification of class definitions to instantiate model element
22 redef class ToolContext
23 var modelize_class_phase
: Phase = new ModelizeClassPhase(self, null)
26 private class ModelizeClassPhase
29 redef fun process_nmodule
(nmodule
)
31 toolcontext
.modelbuilder
.build_classes
(nmodule
)
35 redef class ModelBuilder
36 # Visit the AST and create the `MClass` objects
37 private fun build_a_mclass
(nmodule
: AModule, nclassdef
: AClassdef)
39 var mmodule
= nmodule
.mmodule
.as(not null)
42 var nkind
: nullable AClasskind
44 var nvisibility
: nullable AVisibility
45 var mvisibility
: nullable MVisibility
47 if nclassdef
isa AStdClassdef then
48 name
= nclassdef
.n_id
.text
49 nkind
= nclassdef
.n_classkind
51 nvisibility
= nclassdef
.n_visibility
52 mvisibility
= nvisibility
.mvisibility
53 arity
= nclassdef
.n_formaldefs
.length
54 if mvisibility
== protected_visibility
then
55 error
(nvisibility
, "Error: only properties can be protected.")
57 else if mvisibility
== intrude_visibility
then
58 error
(nvisibility
, "Error: intrude is not a legal visibility for classes.")
61 else if nclassdef
isa ATopClassdef then
64 mkind
= interface_kind
66 mvisibility
= public_visibility
67 else if nclassdef
isa AMainClassdef then
72 mvisibility
= public_visibility
77 var mclass
= try_get_mclass_by_name
(nclassdef
, mmodule
, name
)
78 if mclass
== null then
79 mclass
= new MClass(mmodule
, name
, arity
, mkind
, mvisibility
)
80 #print "new class {mclass}"
81 else if nclassdef
isa AStdClassdef and nmodule
.mclass2nclassdef
.has_key
(mclass
) then
82 error
(nclassdef
, "Error: A class {name} is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.")
84 else if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
== null then
85 error
(nclassdef
, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
87 else if mclass
.arity
!= arity
then
88 error
(nclassdef
, "Redef error: Formal parameter arity missmatch; got {arity}, expected {mclass.arity}.")
90 else if nkind
!= null and mkind
!= concrete_kind
and mclass
.kind
!= mkind
then
91 error
(nkind
, "Error: refinement changed the kind from a {mclass.kind} to a {mkind}")
92 else if nvisibility
!= null and mvisibility
!= public_visibility
and mclass
.visibility
!= mvisibility
then
93 error
(nvisibility
, "Error: refinement changed the visibility from a {mclass.visibility} to a {mvisibility}")
95 nclassdef
.mclass
= mclass
96 nmodule
.mclass2nclassdef
[mclass
] = nclassdef
99 # Visit the AST and create the `MClassDef` objects
100 private fun build_a_mclassdef
(nmodule
: AModule, nclassdef
: AClassdef)
102 var mmodule
= nmodule
.mmodule
.as(not null)
103 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
104 var mclass
= nclassdef
.mclass
105 if mclass
== null then return # Skip error
106 #var mclassdef = nclassdef.mclassdef.as(not null)
108 var names
= new Array[String]
109 var bounds
= new Array[MType]
110 if nclassdef
isa AStdClassdef and mclass
.arity
> 0 then
111 # Collect formal parameter names
112 for i
in [0..mclass
.arity
[ do
113 var nfd
= nclassdef
.n_formaldefs
[i
]
114 var ptname
= nfd
.n_id
.text
115 if names
.has
(ptname
) then
116 error
(nfd
, "Error: A formal parameter type `{ptname}' already exists")
119 for c
in ptname
do if c
>= 'a' and c
<= 'z' then
120 warning
(nfd
, "Warning: lowercase in the formal parameter type {ptname}")
124 nfd
.mtype
= mclass
.mclass_type
.arguments
[i
].as(MParameterType)
127 # Revolve bound for formal parameter names
128 for i
in [0..mclass
.arity
[ do
129 var nfd
= nclassdef
.n_formaldefs
[i
]
130 var nfdt
= nfd
.n_type
132 var bound
= resolve_mtype_unchecked
(nclassdef
, nfdt
, false)
133 if bound
== null then return # Forward error
134 if bound
.need_anchor
then
136 error
(nfd
, "Error: Formal parameter type `{names[i]}' bounded with a formal parameter type")
141 else if mclass
.mclassdefs
.is_empty
then
142 # No bound, then implicitely bound by nullable Object
143 var bound
= objectclass
.mclass_type
.as_nullable
148 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
155 var bound_mtype
= mclass
.get_mtype
(bounds
)
156 var mclassdef
= new MClassDef(mmodule
, bound_mtype
, nclassdef
.location
, names
)
157 nclassdef
.mclassdef
= mclassdef
158 self.mclassdef2nclassdef
[mclassdef
] = nclassdef
160 if mclassdef
.is_intro
then
161 self.toolcontext
.info
("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3)
163 self.toolcontext
.info
("{mclassdef} refine {mclass.kind} {mclass.full_name}", 3)
167 # Visit the AST and set the super-types of the `MClassDef` objects
168 private fun collect_a_mclassdef_inheritance
(nmodule
: AModule, nclassdef
: AClassdef)
170 var mmodule
= nmodule
.mmodule
.as(not null)
171 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
172 var pointerclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Pointer")
173 var mclass
= nclassdef
.mclass
.as(not null)
174 var mclassdef
= nclassdef
.mclassdef
.as(not null)
176 var specobject
= true
177 var supertypes
= new Array[MClassType]
178 if nclassdef
isa AStdClassdef then
179 for nsc
in nclassdef
.n_superclasses
do
181 var ntype
= nsc
.n_type
182 var mtype
= resolve_mtype_unchecked
(nclassdef
, ntype
, false)
183 if mtype
== null then continue # Skip because of error
184 if not mtype
isa MClassType then
185 error
(ntype
, "Error: supertypes cannot be a formal type")
189 #print "new super : {mclass} < {mtype}"
192 if specobject
and mclassdef
.is_intro
then
193 if mclass
.kind
== extern_kind
then
194 if mclass
.name
== "Pointer" then
195 supertypes
.add objectclass
.mclass_type
197 supertypes
.add pointerclass
.mclass_type
199 else if mclass
.name
!= "Object" and objectclass
!= null then
200 supertypes
.add objectclass
.mclass_type
204 mclassdef
.set_supertypes
(supertypes
)
205 if not supertypes
.is_empty
then self.toolcontext
.info
("{mclassdef} new super-types: {supertypes.join(", ")}", 3)
208 # Check the validity of the specialization heirarchy
209 private fun check_supertypes
(nmodule
: AModule, nclassdef
: AClassdef)
211 var mmodule
= nmodule
.mmodule
.as(not null)
212 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
213 var mclass
= nclassdef
.mclass
.as(not null)
214 var mclassdef
= nclassdef
.mclassdef
.as(not null)
216 for s
in mclassdef
.supertypes
do
217 if s
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, mclassdef
.bound_mtype
) then
218 error
(nclassdef
, "Error: Inheritance loop for class {mclass} with type {s}")
223 # Build the classes of the module `nmodule`.
224 # REQUIRE: classes of imported modules are already build. (let `phase` do the job)
225 private fun build_classes
(nmodule
: AModule)
227 var errcount
= toolcontext
.error_count
228 # Force building recursively
229 if nmodule
.build_classes_is_done
then return
230 nmodule
.build_classes_is_done
= true
231 var mmodule
= nmodule
.mmodule
.as(not null)
232 for imp
in mmodule
.in_importation
.direct_greaters
do
234 build_classes
(mmodule2nmodule
[imp
])
237 if errcount
!= toolcontext
.error_count
then return
240 for nclassdef
in nmodule
.n_classdefs
do
241 self.build_a_mclass
(nmodule
, nclassdef
)
244 if errcount
!= toolcontext
.error_count
then return
246 # Create all classdefs
247 for nclassdef
in nmodule
.n_classdefs
do
248 self.build_a_mclassdef
(nmodule
, nclassdef
)
251 if errcount
!= toolcontext
.error_count
then return
253 # Create inheritance on all classdefs
254 for nclassdef
in nmodule
.n_classdefs
do
255 self.collect_a_mclassdef_inheritance
(nmodule
, nclassdef
)
258 if errcount
!= toolcontext
.error_count
then return
260 # Create the mclassdef hierarchy
261 for nclassdef
in nmodule
.n_classdefs
do
262 var mclassdef
= nclassdef
.mclassdef
.as(not null)
263 mclassdef
.add_in_hierarchy
266 if errcount
!= toolcontext
.error_count
then return
269 for nclassdef
in nmodule
.n_classdefs
do
270 self.check_supertypes
(nmodule
, nclassdef
)
273 if errcount
!= toolcontext
.error_count
then return
275 # Check unchecked ntypes
276 for nclassdef
in nmodule
.n_classdefs
do
277 if nclassdef
isa AStdClassdef then
278 # check bound of formal parameter
279 for nfd
in nclassdef
.n_formaldefs
do
280 var nfdt
= nfd
.n_type
281 if nfdt
!= null and nfdt
.mtype
!= null then
282 var bound
= resolve_mtype
(nclassdef
, nfdt
)
283 if bound
== null then return # Forward error
286 # check declared super types
287 for nsc
in nclassdef
.n_superclasses
do
288 var ntype
= nsc
.n_type
289 if ntype
.mtype
!= null then
290 var mtype
= resolve_mtype
(nclassdef
, ntype
)
291 if mtype
== null then return # Forward error
297 if errcount
!= toolcontext
.error_count
then return
299 # Check clash of ancestors
300 for nclassdef
in nmodule
.n_classdefs
do
301 var mclassdef
= nclassdef
.mclassdef
.as(not null)
302 var superclasses
= new HashMap[MClass, MClassType]
303 for scd
in mclassdef
.in_hierarchy
.greaters
do
304 for st
in scd
.supertypes
do
305 if not superclasses
.has_key
(st
.mclass
) then
306 superclasses
[st
.mclass
] = st
307 else if superclasses
[st
.mclass
] != st
then
308 var st1
= superclasses
[st
.mclass
].resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
309 var st2
= st
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
311 error
(nclassdef
, "Error: Incompatibles ancestors for {mclassdef.mclass}: {st1}, {st2}")
318 if errcount
!= toolcontext
.error_count
then return
320 # TODO: Check that the super-class is not intrusive
322 # Check that the superclasses are not already known (by transitivity)
323 for nclassdef
in nmodule
.n_classdefs
do
324 if not nclassdef
isa AStdClassdef then continue
325 var mclassdef
= nclassdef
.mclassdef
.as(not null)
327 # Get the direct superclasses
328 # Since we are a mclassdef, just look at the mclassdef hierarchy
329 var parents
= new Array[MClass]
330 for sup
in mclassdef
.in_hierarchy
.direct_greaters
do
331 parents
.add
(sup
.mclass
)
334 # Used to track duplicates of superclasses
335 var seen_parents
= new ArrayMap[MClass, AType]
338 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
340 # Check each declared superclass to see if it belong to the direct superclass
341 for nsc
in nclassdef
.n_superclasses
do
342 var ntype
= nsc
.n_type
343 var mtype
= ntype
.mtype
344 if mtype
== null then continue
345 assert mtype
isa MClassType
346 var sc
= mtype
.mclass
347 if not parents
.has
(sc
) or sc
== objectclass
then
348 warning
(ntype
, "Warning: superfluous super-class {mtype} in class {mclassdef.mclass}.")
349 else if not seen_parents
.has_key
(sc
) then
350 seen_parents
[sc
] = ntype
352 warning
(ntype
, "Warning: duplicated super-class {mtype} in class {mclassdef.mclass}.")
358 # Register the nclassdef associated to each mclassdef
359 # FIXME: why not refine the `MClassDef` class with a nullable attribute?
360 var mclassdef2nclassdef
: HashMap[MClassDef, AClassdef] = new HashMap[MClassDef, AClassdef]
362 # Return the static type associated to the node `ntype`.
363 # `nclassdef` is the context where the call is made (used to understand formal types)
364 # The mmodule used as context is `nclassdef.mmodule`
365 # In case of problem, an error is displayed on `ntype` and null is returned.
366 # FIXME: the name "resolve_mtype" is awful
367 fun resolve_mtype_unchecked
(nclassdef
: AClassdef, ntype
: AType, with_virtual
: Bool): nullable MType
369 var name
= ntype
.n_id
.text
370 var mclassdef
= nclassdef
.mclassdef
371 var mmodule
= nclassdef
.parent
.as(AModule).mmodule
.as(not null)
375 if mclassdef
!= null and with_virtual
then
376 var prop
= try_get_mproperty_by_name
(ntype
, mclassdef
, name
).as(nullable MVirtualTypeProp)
378 if not ntype
.n_types
.is_empty
then
379 error
(ntype
, "Type error: formal type {name} cannot have formal parameters.")
381 res
= prop
.mvirtualtype
382 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
388 # Check parameter type
389 if mclassdef
!= null and mclassdef
.parameter_names
.has
(name
) then
390 if not ntype
.n_types
.is_empty
then
391 error
(ntype
, "Type error: formal type {name} cannot have formal parameters.")
393 for i
in [0..mclassdef
.parameter_names
.length
[ do
394 if mclassdef
.parameter_names
[i
] == name
then
395 res
= mclassdef
.mclass
.mclass_type
.arguments
[i
]
396 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
405 var mclass
= try_get_mclass_by_name
(ntype
, mmodule
, name
)
406 if mclass
!= null then
407 var arity
= ntype
.n_types
.length
408 if arity
!= mclass
.arity
then
410 error
(ntype
, "Type error: '{name}' is a generic class.")
411 else if mclass
.arity
== 0 then
412 error
(ntype
, "Type error: '{name}' is not a generic class.")
414 error
(ntype
, "Type error: '{name}' has {mclass.arity} parameters ({arity} are provided).")
419 res
= mclass
.mclass_type
420 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
424 var mtypes
= new Array[MType]
425 for nt
in ntype
.n_types
do
426 var mt
= resolve_mtype_unchecked
(nclassdef
, nt
, with_virtual
)
427 if mt
== null then return null # Forward error
430 res
= mclass
.get_mtype
(mtypes
)
431 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
437 # If everything fail, then give up :(
438 error
(ntype
, "Type error: class {name} not found in module {mmodule}.")
442 # Return the static type associated to the node `ntype`.
443 # `nclassdef` is the context where the call is made (used to understand formal types)
444 # The mmodule used as context is `nclassdef.mmodule`
445 # In case of problem, an error is displayed on `ntype` and null is returned.
446 # FIXME: the name "resolve_mtype" is awful
447 fun resolve_mtype
(nclassdef
: AClassdef, ntype
: AType): nullable MType
449 var mtype
= ntype
.mtype
450 if mtype
== null then mtype
= resolve_mtype_unchecked
(nclassdef
, ntype
, true)
451 if mtype
== null then return null # Forward error
453 if ntype
.checked_mtype
then return mtype
454 if mtype
isa MGenericType then
455 var mmodule
= nclassdef
.parent
.as(AModule).mmodule
.as(not null)
456 var mclassdef
= nclassdef
.mclassdef
457 var mclass
= mtype
.mclass
458 for i
in [0..mclass
.arity
[ do
459 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
460 var nt
= ntype
.n_types
[i
]
461 var mt
= resolve_mtype
(nclassdef
, nt
)
462 if mt
== null then return null # forward error
463 if not mt
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, bound
) then
464 error
(nt
, "Type error: expected {bound}, got {mt}")
469 ntype
.checked_mtype
= true
476 # Flag that indicate if the class building is already completed
477 var build_classes_is_done
: Bool = false
478 # What is the AClassdef associated to a `MClass`?
479 # Used to check multiple definition of a class.
480 var mclass2nclassdef
: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef]
483 redef class AClassdef
484 # The associated MClass once build by a `ModelBuilder`
485 var mclass
: nullable MClass
486 # The associated MClassDef once build by a `ModelBuilder`
487 var mclassdef
: nullable MClassDef
490 redef class AClasskind
491 # The class kind associated with the AST node class
492 private fun mkind
: MClassKind is abstract
494 redef class AConcreteClasskind
495 redef fun mkind
do return concrete_kind
497 redef class AAbstractClasskind
498 redef fun mkind
do return abstract_kind
500 redef class AInterfaceClasskind
501 redef fun mkind
do return interface_kind
503 redef class AEnumClasskind
504 redef fun mkind
do return enum_kind
506 redef class AExternClasskind
507 redef fun mkind
do return extern_kind
510 redef class AFormaldef
511 # The associated parameter type
512 var mtype
: nullable MParameterType = null
514 # The associated bound
515 var bound
: nullable MType = null
519 # The mtype associated to the node
520 var mtype
: nullable MType = null
522 # Is the mtype a valid one?
523 var checked_mtype
: Bool = false