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 # Run `AModule::build_classes` on each module
24 var modelize_class_phase
: Phase = new ModelizeClassPhase(self, null)
27 private class ModelizeClassPhase
30 redef fun process_nmodule
(nmodule
)
32 toolcontext
.modelbuilder
.build_classes
(nmodule
)
36 redef class ModelBuilder
37 # Visit the AST and create the `MClass` objects
38 private fun build_a_mclass
(nmodule
: AModule, nclassdef
: AClassdef)
40 var mmodule
= nmodule
.mmodule
.as(not null)
43 var nkind
: nullable AClasskind
45 var nvisibility
: nullable AVisibility
46 var mvisibility
: nullable MVisibility
48 var names
= new Array[String]
49 if nclassdef
isa AStdClassdef then
50 name
= nclassdef
.n_id
.text
51 nkind
= nclassdef
.n_classkind
53 nvisibility
= nclassdef
.n_visibility
54 mvisibility
= nvisibility
.mvisibility
55 arity
= nclassdef
.n_formaldefs
.length
56 if mvisibility
== protected_visibility
then
57 error
(nvisibility
, "Error: only properties can be protected.")
59 else if mvisibility
== intrude_visibility
then
60 error
(nvisibility
, "Error: intrude is not a legal visibility for classes.")
63 # Collect formal parameter names
64 for i
in [0..arity
[ do
65 var nfd
= nclassdef
.n_formaldefs
[i
]
66 var ptname
= nfd
.n_id
.text
67 if names
.has
(ptname
) then
68 error
(nfd
, "Error: a formal parameter type `{ptname}` already exists.")
71 for c
in ptname
.chars
do if c
>= 'a' and c
<= 'z' then
72 warning
(nfd
, "formal-type-name", "Warning: lowercase in the formal parameter type `{ptname}`.")
78 else if nclassdef
isa ATopClassdef and nclassdef
.n_propdefs
.first
.as(AMethPropdef).n_methid
.collect_text
== "sys" then
79 # Special case to keep `sys` in object.
80 # Needed to keep working bootstrap and a working java FFI together.
81 # TODO: remove once safe to remove
84 mkind
= interface_kind
86 mvisibility
= public_visibility
92 mvisibility
= public_visibility
95 var mclass
= try_get_mclass_by_name
(nclassdef
, mmodule
, name
)
96 if mclass
== null then
97 if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
!= null then
98 error
(nclassdef
, "Redef Error: no imported class `{name}` to refine.")
102 # Check for conflicting class full-names in the package
103 if mmodule
.mgroup
!= null and mvisibility
>= protected_visibility
then
104 var mclasses
= model
.get_mclasses_by_name
(name
)
105 if mclasses
!= null then for other
in mclasses
do
106 if other
.intro_mmodule
.mgroup
!= null and other
.intro_mmodule
.mgroup
.mpackage
== mmodule
.mgroup
.mpackage
then
107 # Skip classes that are buggy
108 if other
.try_intro
== null then continue
109 warning
(nclassdef
, "full-name-conflict", "Error: a class named `{other.full_name}` is already defined in module `{other.intro_mmodule}` at {other.intro.location}.")
115 mclass
= new MClass(mmodule
, name
, names
, mkind
, mvisibility
)
116 #print "new class {mclass}"
117 else if nclassdef
isa AStdClassdef and nmodule
.mclass2nclassdef
.has_key
(mclass
) then
118 error
(nclassdef
, "Error: a class `{name}` is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.")
120 else if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
== null then
121 error
(nclassdef
, "Redef Error: `{name}` is an imported class. Add the `redef` keyword to refine it.")
123 else if arity
!= 0 and mclass
.arity
!= arity
then
124 error
(nclassdef
, "Redef Error: expected {mclass.arity} formal parameter(s) for {mclass.signature_to_s}; got {arity}.")
126 else if nkind
!= null and mkind
!= concrete_kind
and mclass
.kind
!= mkind
then
127 error
(nkind
, "Redef Error: refinement changed the kind from `{mclass.kind}` to `{mkind}`.")
128 else if nvisibility
!= null and mvisibility
!= public_visibility
and mclass
.visibility
!= mvisibility
then
129 error
(nvisibility
, "Redef Error: refinement changed the visibility from `{mclass.visibility}` to `{mvisibility}`")
131 nclassdef
.mclass
= mclass
132 if not nmodule
.mclass2nclassdef
.has_key
(mclass
) then
133 nmodule
.mclass2nclassdef
[mclass
] = nclassdef
134 nclassdef
.all_defs
= [nclassdef
]
136 nmodule
.mclass2nclassdef
[mclass
].all_defs
.add
(nclassdef
)
140 # Visit the AST and create the `MClassDef` objects
141 private fun build_a_mclassdef
(nmodule
: AModule, nclassdef
: AClassdef)
143 var mmodule
= nmodule
.mmodule
.as(not null)
144 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
145 var mclass
= nclassdef
.mclass
146 if mclass
== null then return # Skip error
148 # In case of non-standard AClassdef, try to attach to an already existing mclassdef
149 var other_nclassdef
= nmodule
.mclass2nclassdef
[mclass
]
150 if other_nclassdef
!= nclassdef
then
151 assert not nclassdef
isa AStdClassdef
152 nclassdef
.mclassdef
= other_nclassdef
.mclassdef
156 var bounds
= new Array[MType]
157 if nclassdef
isa AStdClassdef and mclass
.arity
> 0 then
158 # Revolve bound for formal parameters
159 for i
in [0..mclass
.arity
[ do
160 if nclassdef
.n_formaldefs
.is_empty
then
162 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
167 var nfd
= nclassdef
.n_formaldefs
[i
]
168 var pname
= mclass
.mparameters
[i
].name
169 if nfd
.n_id
.text
!= pname
then
170 error
(nfd
.n_id
, "Error: formal parameter type #{i} `{nfd.n_id.text}` must be named `{pname}` as in the original definition in module `{mclass.intro.mmodule}`.")
172 var nfdt
= nfd
.n_type
174 var bound
= resolve_mtype_unchecked
(mmodule
, null, nfdt
, false)
175 if bound
== null then return # Forward error
176 if bound
.need_anchor
then
178 error
(nfd
, "Error: formal parameter type `{pname}` bounded with a formal parameter type.")
183 if bound
isa MClassType and bound
.mclass
.kind
== enum_kind
then
184 warning
(nfdt
, "useless-bound", "Warning: useless formal parameter type since `{bound}` cannot have subclasses.")
186 else if mclass
.mclassdefs
.is_empty
then
187 if objectclass
== null then
188 error
(nfd
, "Error: formal parameter type `{pname}` unbounded but no `Object` class exists.")
191 # No bound, then implicitely bound by nullable Object
192 var bound
= objectclass
.mclass_type
.as_nullable
197 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
204 var bound_mtype
= mclass
.get_mtype
(bounds
)
205 var mclassdef
= new MClassDef(mmodule
, bound_mtype
, nclassdef
.location
)
206 nclassdef
.mclassdef
= mclassdef
207 self.mclassdef2nclassdef
[mclassdef
] = nclassdef
209 if nclassdef
isa AStdClassdef then
210 var ndoc
= nclassdef
.n_doc
212 var mdoc
= ndoc
.to_mdoc
213 mclassdef
.mdoc
= mdoc
214 mdoc
.original_mentity
= mclassdef
215 else if mclassdef
.is_intro
and mclass
.visibility
>= public_visibility
then
216 advice
(nclassdef
, "missing-doc", "Documentation warning: Undocumented public class `{mclass}`")
220 if mclassdef
.is_intro
then
221 self.toolcontext
.info
("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3)
223 self.toolcontext
.info
("{mclassdef} refine {mclass.kind} {mclass.full_name}", 3)
227 # Visit the AST and set the super-types of the `MClassDef` objects
228 private fun collect_a_mclassdef_inheritance
(nmodule
: AModule, nclassdef
: AClassdef)
230 var mmodule
= nmodule
.mmodule
231 if mmodule
== null then return
232 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
233 var pointerclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Pointer")
234 var mclass
= nclassdef
.mclass
235 if mclass
== null then return
236 var mclassdef
= nclassdef
.mclassdef
237 if mclassdef
== null then return
239 # Do we need to specify Object as a super class?
240 var specobject
= true
242 # Do we need to specify Pointer as a super class? (is only valid
243 # if `nclassdef` is an extern class)
244 var specpointer
= true
246 var supertypes
= new Array[MClassType]
247 if nclassdef
isa AStdClassdef then
248 for nsc
in nclassdef
.n_superclasses
do
250 var ntype
= nsc
.n_type
251 var mtype
= resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, false)
252 if mtype
== null then continue # Skip because of error
253 if not mtype
isa MClassType then
254 error
(ntype
, "Error: supertypes cannot be a formal type.")
257 if not mclass
.kind
.can_specialize
(mtype
.mclass
.kind
) then
258 error
(ntype
, "Error: {mclass.kind} `{mclass}` cannot specialize {mtype.mclass.kind} `{mtype.mclass}`.")
261 #print "new super : {mclass} < {mtype}"
262 if mtype
.mclass
.kind
== extern_kind
then specpointer
= false
266 if mclassdef
.is_intro
and objectclass
!= null then
267 if mclass
.kind
== extern_kind
and mclass
.name
!= "Pointer" then
268 # it is an extern class, but not a Pointer
269 if specpointer
then supertypes
.add pointerclass
.mclass_type
270 else if specobject
and mclass
.name
!= "Object" then
271 # it is a standard class without super class (but is not Object)
272 supertypes
.add objectclass
.mclass_type
276 mclassdef
.set_supertypes
(supertypes
)
277 if not supertypes
.is_empty
then self.toolcontext
.info
("{mclassdef} new super-types: {supertypes.join(", ")}", 3)
280 # Check the validity of the specialization heirarchy
281 private fun check_supertypes
(nmodule
: AModule, nclassdef
: AClassdef)
283 var mmodule
= nmodule
.mmodule
284 if mmodule
== null then return
285 var mclass
= nclassdef
.mclass
286 if mclass
== null then return
287 var mclassdef
= nclassdef
.mclassdef
288 if mclassdef
== null then return
290 for s
in mclassdef
.supertypes
do
291 if s
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, mclassdef
.bound_mtype
) then
292 error
(nclassdef
, "Error: inheritance loop for class `{mclass}` with type `{s}`.")
297 # Build the classes of the module `nmodule`.
298 # REQUIRE: classes of imported modules are already build. (let `phase` do the job)
299 private fun build_classes
(nmodule
: AModule)
301 var errcount
= toolcontext
.error_count
302 # Force building recursively
303 if nmodule
.build_classes_is_done
then return
304 nmodule
.build_classes_is_done
= true
305 var mmodule
= nmodule
.mmodule
306 if mmodule
== null then return
307 for imp
in mmodule
.in_importation
.direct_greaters
do
308 var nimp
= mmodule2node
(imp
)
309 if nimp
!= null then build_classes
(nimp
)
312 if errcount
!= toolcontext
.error_count
then return
315 # process AStdClassdef before so that non-AStdClassdef classes can be attached to existing ones, if any
316 for nclassdef
in nmodule
.n_classdefs
do
317 if not nclassdef
isa AStdClassdef then continue
318 self.build_a_mclass
(nmodule
, nclassdef
)
320 for nclassdef
in nmodule
.n_classdefs
do
321 if nclassdef
isa AStdClassdef then continue
322 self.build_a_mclass
(nmodule
, nclassdef
)
325 if errcount
!= toolcontext
.error_count
then return
327 # Create all classdefs
328 for nclassdef
in nmodule
.n_classdefs
do
329 if not nclassdef
isa AStdClassdef then continue
330 self.build_a_mclassdef
(nmodule
, nclassdef
)
332 for nclassdef
in nmodule
.n_classdefs
do
333 if nclassdef
isa AStdClassdef then continue
334 self.build_a_mclassdef
(nmodule
, nclassdef
)
337 if errcount
!= toolcontext
.error_count
then return
339 # Create inheritance on all classdefs
340 for nclassdef
in nmodule
.n_classdefs
do
341 self.collect_a_mclassdef_inheritance
(nmodule
, nclassdef
)
344 if errcount
!= toolcontext
.error_count
then return
346 # Create the mclassdef hierarchy
347 for mclassdef
in mmodule
.mclassdefs
do
348 mclassdef
.add_in_hierarchy
351 if errcount
!= toolcontext
.error_count
then return
354 for nclassdef
in nmodule
.n_classdefs
do
355 self.check_supertypes
(nmodule
, nclassdef
)
358 if errcount
!= toolcontext
.error_count
then return
360 # Check unchecked ntypes
361 for nclassdef
in nmodule
.n_classdefs
do
362 if nclassdef
isa AStdClassdef then
363 var mclassdef
= nclassdef
.mclassdef
364 # check bound of formal parameter
365 for nfd
in nclassdef
.n_formaldefs
do
366 var nfdt
= nfd
.n_type
367 if nfdt
!= null and nfdt
.mtype
!= null then
368 var bound
= resolve_mtype
(mmodule
, mclassdef
, nfdt
)
369 if bound
== null then return # Forward error
372 # check declared super types
373 for nsc
in nclassdef
.n_superclasses
do
374 var ntype
= nsc
.n_type
375 if ntype
.mtype
!= null then
376 var mtype
= resolve_mtype
(mmodule
, mclassdef
, ntype
)
377 if mtype
== null then return # Forward error
383 if errcount
!= toolcontext
.error_count
then return
385 # Check clash of ancestors
386 for nclassdef
in nmodule
.n_classdefs
do
387 var mclassdef
= nclassdef
.mclassdef
388 if mclassdef
== null then continue
389 var superclasses
= new HashMap[MClass, MClassType]
390 for scd
in mclassdef
.in_hierarchy
.greaters
do
391 for st
in scd
.supertypes
do
392 if not superclasses
.has_key
(st
.mclass
) then
393 superclasses
[st
.mclass
] = st
394 else if superclasses
[st
.mclass
] != st
then
395 var st1
= superclasses
[st
.mclass
].resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
396 var st2
= st
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
398 error
(nclassdef
, "Error: incompatible ancestors for `{mclassdef.mclass}`; conflict: `{st1}` and `{st2}`")
405 if errcount
!= toolcontext
.error_count
then return
407 # TODO: Check that the super-class is not intrusive
409 # Check that the superclasses are not already known (by transitivity)
410 for nclassdef
in nmodule
.n_classdefs
do
411 if not nclassdef
isa AStdClassdef then continue
412 var mclassdef
= nclassdef
.mclassdef
413 if mclassdef
== null then continue
415 # Get the direct superclasses
416 # Since we are a mclassdef, just look at the mclassdef hierarchy
417 var parents
= new Array[MClass]
418 for sup
in mclassdef
.in_hierarchy
.direct_greaters
do
419 parents
.add
(sup
.mclass
)
422 # Used to track duplicates of superclasses
423 var seen_parents
= new ArrayMap[MClass, AType]
426 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
428 # Check each declared superclass to see if it belong to the direct superclass
429 for nsc
in nclassdef
.n_superclasses
do
430 var ntype
= nsc
.n_type
431 var mtype
= ntype
.mtype
432 if mtype
== null then continue
433 assert mtype
isa MClassType
434 var sc
= mtype
.mclass
435 if not parents
.has
(sc
) or sc
== objectclass
then
436 # Skip the warning on generated code
437 if ntype
.location
.file
!= null and not ntype
.location
.file
.filename
.is_empty
then
438 warning
(ntype
, "useless-superclass", "Warning: superfluous super-class `{mtype}` in class `{mclassdef.mclass}`.")
440 else if not seen_parents
.has_key
(sc
) then
441 seen_parents
[sc
] = ntype
443 warning
(ntype
, "useless-superclass", "Warning: duplicated super-class `{mtype}` in class `{mclassdef.mclass}`.")
449 # Registration of the nclassdef associated to each mclassdef
450 private var mclassdef2nclassdef
= new HashMap[MClassDef, AClassdef]
452 # Retrieve the associated AST node of a mclassdef.
454 # This method is used to associate model entity with syntactic entities.
455 # If the class definition is not associated with a node, returns `null`.
456 fun mclassdef2node
(mclassdef
: MClassDef): nullable AClassdef do
457 return mclassdef2nclassdef
.get_or_null
(mclassdef
)
462 # Flag that indicate if the class building is already completed
463 var build_classes_is_done
: Bool = false
464 # What is the AClassdef associated to a `MClass`?
465 # Used to check multiple definition of a class.
466 var mclass2nclassdef
: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef]
469 redef class AClassdef
470 # The associated MClass once build by a `ModelBuilder`
471 var mclass
: nullable MClass
472 # The associated MClassDef once build by a `ModelBuilder`
473 var mclassdef
: nullable MClassDef
474 # All (self and other) definitions for the same mclassdef
475 var all_defs
: nullable Array[AClassdef]
478 redef class AClasskind
479 # The class kind associated with the AST node class
480 private fun mkind
: MClassKind is abstract
482 redef class AConcreteClasskind
483 redef fun mkind
do return concrete_kind
485 redef class AAbstractClasskind
486 redef fun mkind
do return abstract_kind
488 redef class AInterfaceClasskind
489 redef fun mkind
do return interface_kind
491 redef class AEnumClasskind
492 redef fun mkind
do return enum_kind
494 redef class AExternClasskind
495 redef fun mkind
do return extern_kind
498 redef class AFormaldef
499 # The associated parameter type
500 var mtype
: nullable MParameterType = null
502 # The associated bound
503 var bound
: nullable MType = null