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 if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
!= null then
80 error
(nclassdef
, "Redef error: No imported class {name} to refine.")
83 mclass
= new MClass(mmodule
, name
, arity
, mkind
, mvisibility
)
84 #print "new class {mclass}"
85 else if nclassdef
isa AStdClassdef and nmodule
.mclass2nclassdef
.has_key
(mclass
) then
86 error
(nclassdef
, "Error: A class {name} is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.")
88 else if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
== null then
89 error
(nclassdef
, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
91 else if mclass
.arity
!= arity
then
92 error
(nclassdef
, "Redef error: Formal parameter arity missmatch; got {arity}, expected {mclass.arity}.")
94 else if nkind
!= null and mkind
!= concrete_kind
and mclass
.kind
!= mkind
then
95 error
(nkind
, "Error: refinement changed the kind from a {mclass.kind} to a {mkind}")
96 else if nvisibility
!= null and mvisibility
!= public_visibility
and mclass
.visibility
!= mvisibility
then
97 error
(nvisibility
, "Error: refinement changed the visibility from a {mclass.visibility} to a {mvisibility}")
99 nclassdef
.mclass
= mclass
100 nmodule
.mclass2nclassdef
[mclass
] = nclassdef
103 # Visit the AST and create the `MClassDef` objects
104 private fun build_a_mclassdef
(nmodule
: AModule, nclassdef
: AClassdef)
106 var mmodule
= nmodule
.mmodule
.as(not null)
107 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
108 var mclass
= nclassdef
.mclass
109 if mclass
== null then return # Skip error
110 #var mclassdef = nclassdef.mclassdef.as(not null)
112 var names
= new Array[String]
113 var bounds
= new Array[MType]
114 if nclassdef
isa AStdClassdef and mclass
.arity
> 0 then
115 # Collect formal parameter names
116 for i
in [0..mclass
.arity
[ do
117 var nfd
= nclassdef
.n_formaldefs
[i
]
118 var ptname
= nfd
.n_id
.text
119 if names
.has
(ptname
) then
120 error
(nfd
, "Error: A formal parameter type `{ptname}' already exists")
123 for c
in ptname
do if c
>= 'a' and c
<= 'z' then
124 warning
(nfd
, "Warning: lowercase in the formal parameter type {ptname}")
128 nfd
.mtype
= mclass
.mclass_type
.arguments
[i
].as(MParameterType)
131 # Revolve bound for formal parameter names
132 for i
in [0..mclass
.arity
[ do
133 var nfd
= nclassdef
.n_formaldefs
[i
]
134 var nfdt
= nfd
.n_type
136 var bound
= resolve_mtype_unchecked
(nclassdef
, nfdt
, false)
137 if bound
== null then return # Forward error
138 if bound
.need_anchor
then
140 error
(nfd
, "Error: Formal parameter type `{names[i]}' bounded with a formal parameter type")
145 else if mclass
.mclassdefs
.is_empty
then
146 # No bound, then implicitely bound by nullable Object
147 var bound
= objectclass
.mclass_type
.as_nullable
152 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
159 var bound_mtype
= mclass
.get_mtype
(bounds
)
160 var mclassdef
= new MClassDef(mmodule
, bound_mtype
, nclassdef
.location
, names
)
161 nclassdef
.mclassdef
= mclassdef
162 self.mclassdef2nclassdef
[mclassdef
] = nclassdef
164 if mclassdef
.is_intro
then
165 self.toolcontext
.info
("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3)
167 self.toolcontext
.info
("{mclassdef} refine {mclass.kind} {mclass.full_name}", 3)
171 # Visit the AST and set the super-types of the `MClassDef` objects
172 private fun collect_a_mclassdef_inheritance
(nmodule
: AModule, nclassdef
: AClassdef)
174 var mmodule
= nmodule
.mmodule
.as(not null)
175 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
176 var pointerclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Pointer")
177 var mclass
= nclassdef
.mclass
.as(not null)
178 var mclassdef
= nclassdef
.mclassdef
.as(not null)
180 var specobject
= true
181 var supertypes
= new Array[MClassType]
182 if nclassdef
isa AStdClassdef then
183 for nsc
in nclassdef
.n_superclasses
do
185 var ntype
= nsc
.n_type
186 var mtype
= resolve_mtype_unchecked
(nclassdef
, ntype
, false)
187 if mtype
== null then continue # Skip because of error
188 if not mtype
isa MClassType then
189 error
(ntype
, "Error: supertypes cannot be a formal type")
193 #print "new super : {mclass} < {mtype}"
196 if specobject
and mclassdef
.is_intro
then
197 if mclass
.kind
== extern_kind
then
198 if mclass
.name
== "Pointer" then
199 supertypes
.add objectclass
.mclass_type
201 supertypes
.add pointerclass
.mclass_type
203 else if mclass
.name
!= "Object" and objectclass
!= null then
204 supertypes
.add objectclass
.mclass_type
208 mclassdef
.set_supertypes
(supertypes
)
209 if not supertypes
.is_empty
then self.toolcontext
.info
("{mclassdef} new super-types: {supertypes.join(", ")}", 3)
212 # Check the validity of the specialization heirarchy
213 private fun check_supertypes
(nmodule
: AModule, nclassdef
: AClassdef)
215 var mmodule
= nmodule
.mmodule
.as(not null)
216 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
217 var mclass
= nclassdef
.mclass
.as(not null)
218 var mclassdef
= nclassdef
.mclassdef
.as(not null)
220 for s
in mclassdef
.supertypes
do
221 if s
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, mclassdef
.bound_mtype
) then
222 error
(nclassdef
, "Error: Inheritance loop for class {mclass} with type {s}")
227 # Build the classes of the module `nmodule`.
228 # REQUIRE: classes of imported modules are already build. (let `phase` do the job)
229 private fun build_classes
(nmodule
: AModule)
231 var errcount
= toolcontext
.error_count
232 # Force building recursively
233 if nmodule
.build_classes_is_done
then return
234 nmodule
.build_classes_is_done
= true
235 var mmodule
= nmodule
.mmodule
.as(not null)
236 for imp
in mmodule
.in_importation
.direct_greaters
do
238 build_classes
(mmodule2nmodule
[imp
])
241 if errcount
!= toolcontext
.error_count
then return
244 for nclassdef
in nmodule
.n_classdefs
do
245 self.build_a_mclass
(nmodule
, nclassdef
)
248 if errcount
!= toolcontext
.error_count
then return
250 # Create all classdefs
251 for nclassdef
in nmodule
.n_classdefs
do
252 self.build_a_mclassdef
(nmodule
, nclassdef
)
255 if errcount
!= toolcontext
.error_count
then return
257 # Create inheritance on all classdefs
258 for nclassdef
in nmodule
.n_classdefs
do
259 self.collect_a_mclassdef_inheritance
(nmodule
, nclassdef
)
262 if errcount
!= toolcontext
.error_count
then return
264 # Create the mclassdef hierarchy
265 for nclassdef
in nmodule
.n_classdefs
do
266 var mclassdef
= nclassdef
.mclassdef
.as(not null)
267 mclassdef
.add_in_hierarchy
270 if errcount
!= toolcontext
.error_count
then return
273 for nclassdef
in nmodule
.n_classdefs
do
274 self.check_supertypes
(nmodule
, nclassdef
)
277 if errcount
!= toolcontext
.error_count
then return
279 # Check unchecked ntypes
280 for nclassdef
in nmodule
.n_classdefs
do
281 if nclassdef
isa AStdClassdef then
282 # check bound of formal parameter
283 for nfd
in nclassdef
.n_formaldefs
do
284 var nfdt
= nfd
.n_type
285 if nfdt
!= null and nfdt
.mtype
!= null then
286 var bound
= resolve_mtype
(nclassdef
, nfdt
)
287 if bound
== null then return # Forward error
290 # check declared super types
291 for nsc
in nclassdef
.n_superclasses
do
292 var ntype
= nsc
.n_type
293 if ntype
.mtype
!= null then
294 var mtype
= resolve_mtype
(nclassdef
, ntype
)
295 if mtype
== null then return # Forward error
301 if errcount
!= toolcontext
.error_count
then return
303 # Check clash of ancestors
304 for nclassdef
in nmodule
.n_classdefs
do
305 var mclassdef
= nclassdef
.mclassdef
.as(not null)
306 var superclasses
= new HashMap[MClass, MClassType]
307 for scd
in mclassdef
.in_hierarchy
.greaters
do
308 for st
in scd
.supertypes
do
309 if not superclasses
.has_key
(st
.mclass
) then
310 superclasses
[st
.mclass
] = st
311 else if superclasses
[st
.mclass
] != st
then
312 var st1
= superclasses
[st
.mclass
].resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
313 var st2
= st
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
315 error
(nclassdef
, "Error: Incompatibles ancestors for {mclassdef.mclass}: {st1}, {st2}")
322 if errcount
!= toolcontext
.error_count
then return
324 # TODO: Check that the super-class is not intrusive
326 # Check that the superclasses are not already known (by transitivity)
327 for nclassdef
in nmodule
.n_classdefs
do
328 if not nclassdef
isa AStdClassdef then continue
329 var mclassdef
= nclassdef
.mclassdef
.as(not null)
331 # Get the direct superclasses
332 # Since we are a mclassdef, just look at the mclassdef hierarchy
333 var parents
= new Array[MClass]
334 for sup
in mclassdef
.in_hierarchy
.direct_greaters
do
335 parents
.add
(sup
.mclass
)
338 # Used to track duplicates of superclasses
339 var seen_parents
= new ArrayMap[MClass, AType]
342 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
344 # Check each declared superclass to see if it belong to the direct superclass
345 for nsc
in nclassdef
.n_superclasses
do
346 var ntype
= nsc
.n_type
347 var mtype
= ntype
.mtype
348 if mtype
== null then continue
349 assert mtype
isa MClassType
350 var sc
= mtype
.mclass
351 if not parents
.has
(sc
) or sc
== objectclass
then
352 warning
(ntype
, "Warning: superfluous super-class {mtype} in class {mclassdef.mclass}.")
353 else if not seen_parents
.has_key
(sc
) then
354 seen_parents
[sc
] = ntype
356 warning
(ntype
, "Warning: duplicated super-class {mtype} in class {mclassdef.mclass}.")
362 # Register the nclassdef associated to each mclassdef
363 # FIXME: why not refine the `MClassDef` class with a nullable attribute?
364 var mclassdef2nclassdef
: HashMap[MClassDef, AClassdef] = new HashMap[MClassDef, AClassdef]
366 # Return the static type associated to the node `ntype`.
367 # `nclassdef` is the context where the call is made (used to understand formal types)
368 # The mmodule used as context is `nclassdef.mmodule`
369 # In case of problem, an error is displayed on `ntype` and null is returned.
370 # FIXME: the name "resolve_mtype" is awful
371 fun resolve_mtype_unchecked
(nclassdef
: AClassdef, ntype
: AType, with_virtual
: Bool): nullable MType
373 var name
= ntype
.n_id
.text
374 var mclassdef
= nclassdef
.mclassdef
375 var mmodule
= nclassdef
.parent
.as(AModule).mmodule
.as(not null)
379 if mclassdef
!= null and with_virtual
then
380 var prop
= try_get_mproperty_by_name
(ntype
, mclassdef
, name
).as(nullable MVirtualTypeProp)
382 if not ntype
.n_types
.is_empty
then
383 error
(ntype
, "Type error: formal type {name} cannot have formal parameters.")
385 res
= prop
.mvirtualtype
386 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
392 # Check parameter type
393 if mclassdef
!= null and mclassdef
.parameter_names
.has
(name
) then
394 if not ntype
.n_types
.is_empty
then
395 error
(ntype
, "Type error: formal type {name} cannot have formal parameters.")
397 for i
in [0..mclassdef
.parameter_names
.length
[ do
398 if mclassdef
.parameter_names
[i
] == name
then
399 res
= mclassdef
.mclass
.mclass_type
.arguments
[i
]
400 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
409 var mclass
= try_get_mclass_by_name
(ntype
, mmodule
, name
)
410 if mclass
!= null then
411 var arity
= ntype
.n_types
.length
412 if arity
!= mclass
.arity
then
414 error
(ntype
, "Type error: '{name}' is a generic class.")
415 else if mclass
.arity
== 0 then
416 error
(ntype
, "Type error: '{name}' is not a generic class.")
418 error
(ntype
, "Type error: '{name}' has {mclass.arity} parameters ({arity} are provided).")
423 res
= mclass
.mclass_type
424 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
428 var mtypes
= new Array[MType]
429 for nt
in ntype
.n_types
do
430 var mt
= resolve_mtype_unchecked
(nclassdef
, nt
, with_virtual
)
431 if mt
== null then return null # Forward error
434 res
= mclass
.get_mtype
(mtypes
)
435 if ntype
.n_kwnullable
!= null then res
= res
.as_nullable
441 # If everything fail, then give up :(
442 error
(ntype
, "Type error: class {name} not found in module {mmodule}.")
446 # Return the static type associated to the node `ntype`.
447 # `nclassdef` is the context where the call is made (used to understand formal types)
448 # The mmodule used as context is `nclassdef.mmodule`
449 # In case of problem, an error is displayed on `ntype` and null is returned.
450 # FIXME: the name "resolve_mtype" is awful
451 fun resolve_mtype
(nclassdef
: AClassdef, ntype
: AType): nullable MType
453 var mtype
= ntype
.mtype
454 if mtype
== null then mtype
= resolve_mtype_unchecked
(nclassdef
, ntype
, true)
455 if mtype
== null then return null # Forward error
457 if ntype
.checked_mtype
then return mtype
458 if mtype
isa MGenericType then
459 var mmodule
= nclassdef
.parent
.as(AModule).mmodule
.as(not null)
460 var mclassdef
= nclassdef
.mclassdef
461 var mclass
= mtype
.mclass
462 for i
in [0..mclass
.arity
[ do
463 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
464 var nt
= ntype
.n_types
[i
]
465 var mt
= resolve_mtype
(nclassdef
, nt
)
466 if mt
== null then return null # forward error
467 if not mt
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, bound
) then
468 error
(nt
, "Type error: expected {bound}, got {mt}")
473 ntype
.checked_mtype
= true
480 # Flag that indicate if the class building is already completed
481 var build_classes_is_done
: Bool = false
482 # What is the AClassdef associated to a `MClass`?
483 # Used to check multiple definition of a class.
484 var mclass2nclassdef
: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef]
487 redef class AClassdef
488 # The associated MClass once build by a `ModelBuilder`
489 var mclass
: nullable MClass
490 # The associated MClassDef once build by a `ModelBuilder`
491 var mclassdef
: nullable MClassDef
494 redef class AClasskind
495 # The class kind associated with the AST node class
496 private fun mkind
: MClassKind is abstract
498 redef class AConcreteClasskind
499 redef fun mkind
do return concrete_kind
501 redef class AAbstractClasskind
502 redef fun mkind
do return abstract_kind
504 redef class AInterfaceClasskind
505 redef fun mkind
do return interface_kind
507 redef class AEnumClasskind
508 redef fun mkind
do return enum_kind
510 redef class AExternClasskind
511 redef fun mkind
do return extern_kind
514 redef class AFormaldef
515 # The associated parameter type
516 var mtype
: nullable MParameterType = null
518 # The associated bound
519 var bound
: nullable MType = null
523 # The mtype associated to the node
524 var mtype
: nullable MType = null
526 # Is the mtype a valid one?
527 var checked_mtype
: Bool = false