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 then
81 mkind
= interface_kind
83 mvisibility
= public_visibility
84 else if nclassdef
isa AMainClassdef then
89 mvisibility
= public_visibility
94 var mclass
= try_get_mclass_by_name
(nclassdef
, mmodule
, name
)
95 if mclass
== null then
96 if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
!= null then
97 error
(nclassdef
, "Redef error: No imported class {name} to refine.")
101 # Check for conflicting class full-names in the project
102 if mmodule
.mgroup
!= null and mvisibility
>= protected_visibility
then
103 var mclasses
= model
.get_mclasses_by_name
(name
)
104 if mclasses
!= null then for other
in mclasses
do
105 if other
.intro_mmodule
.mgroup
!= null and other
.intro_mmodule
.mgroup
.mproject
== mmodule
.mgroup
.mproject
then
106 error
(nclassdef
, "Error: A class named `{other.full_name}` is already defined in module `{other.intro_mmodule}` at {other.intro.location}.")
112 mclass
= new MClass(mmodule
, name
, names
, mkind
, mvisibility
)
113 #print "new class {mclass}"
114 else if nclassdef
isa AStdClassdef and nmodule
.mclass2nclassdef
.has_key
(mclass
) then
115 error
(nclassdef
, "Error: A class {name} is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.")
117 else if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
== null then
118 error
(nclassdef
, "Redef error: {name} is an imported class. Add the redef keyword to refine it.")
120 else if arity
!= 0 and mclass
.arity
!= arity
then
121 error
(nclassdef
, "Redef error: Formal parameter arity missmatch; got {arity}, expected {mclass.arity}.")
123 else if nkind
!= null and mkind
!= concrete_kind
and mclass
.kind
!= mkind
then
124 error
(nkind
, "Error: refinement changed the kind from a {mclass.kind} to a {mkind}")
125 else if nvisibility
!= null and mvisibility
!= public_visibility
and mclass
.visibility
!= mvisibility
then
126 error
(nvisibility
, "Error: refinement changed the visibility from a {mclass.visibility} to a {mvisibility}")
128 nclassdef
.mclass
= mclass
129 if not nmodule
.mclass2nclassdef
.has_key
(mclass
) then
130 nmodule
.mclass2nclassdef
[mclass
] = nclassdef
131 nclassdef
.all_defs
= [nclassdef
]
133 nmodule
.mclass2nclassdef
[mclass
].all_defs
.add
(nclassdef
)
137 # Visit the AST and create the `MClassDef` objects
138 private fun build_a_mclassdef
(nmodule
: AModule, nclassdef
: AClassdef)
140 var mmodule
= nmodule
.mmodule
.as(not null)
141 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
142 var mclass
= nclassdef
.mclass
143 if mclass
== null then return # Skip error
145 # In case of non-standard AClassdef, try to attach to an already existing mclassdef
146 var other_nclassdef
= nmodule
.mclass2nclassdef
[mclass
]
147 if other_nclassdef
!= nclassdef
then
148 assert not nclassdef
isa AStdClassdef
149 nclassdef
.mclassdef
= other_nclassdef
.mclassdef
153 var bounds
= new Array[MType]
154 if nclassdef
isa AStdClassdef and mclass
.arity
> 0 then
155 # Revolve bound for formal parameters
156 for i
in [0..mclass
.arity
[ do
157 if nclassdef
.n_formaldefs
.is_empty
then
159 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
164 var nfd
= nclassdef
.n_formaldefs
[i
]
165 var pname
= mclass
.mparameters
[i
].name
166 if nfd
.n_id
.text
!= pname
then
167 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}`.")
169 var nfdt
= nfd
.n_type
171 var bound
= resolve_mtype_unchecked
(mmodule
, null, nfdt
, false)
172 if bound
== null then return # Forward error
173 if bound
.need_anchor
then
175 error
(nfd
, "Error: Formal parameter type `{pname}' bounded with a formal parameter type")
180 if bound
isa MClassType and bound
.mclass
.kind
== enum_kind
then
181 warning
(nfdt
, "useless-bound", "Warning: Useless formal parameter type since `{bound}` cannnot have subclasses.")
183 else if mclass
.mclassdefs
.is_empty
then
184 if objectclass
== null then
185 error
(nfd
, "Error: Formal parameter type `{pname}' unbounded but no Object class exist.")
188 # No bound, then implicitely bound by nullable Object
189 var bound
= objectclass
.mclass_type
.as_nullable
194 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
201 var bound_mtype
= mclass
.get_mtype
(bounds
)
202 var mclassdef
= new MClassDef(mmodule
, bound_mtype
, nclassdef
.location
)
203 nclassdef
.mclassdef
= mclassdef
204 self.mclassdef2nclassdef
[mclassdef
] = nclassdef
206 if nclassdef
isa AStdClassdef then
207 var ndoc
= nclassdef
.n_doc
209 var mdoc
= ndoc
.to_mdoc
210 mclassdef
.mdoc
= mdoc
211 mdoc
.original_mentity
= mclassdef
212 else if mclassdef
.is_intro
and mclass
.visibility
>= public_visibility
then
213 advice
(nclassdef
, "missing-doc", "Documentation warning: Undocumented public class `{mclass}`")
217 if mclassdef
.is_intro
then
218 self.toolcontext
.info
("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3)
220 self.toolcontext
.info
("{mclassdef} refine {mclass.kind} {mclass.full_name}", 3)
224 # Visit the AST and set the super-types of the `MClassDef` objects
225 private fun collect_a_mclassdef_inheritance
(nmodule
: AModule, nclassdef
: AClassdef)
227 var mmodule
= nmodule
.mmodule
.as(not null)
228 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
229 var pointerclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Pointer")
230 var mclass
= nclassdef
.mclass
.as(not null)
231 var mclassdef
= nclassdef
.mclassdef
.as(not null)
233 # Do we need to specify Object as a super class?
234 var specobject
= true
236 # Do we need to specify Pointer as a super class? (is only valid
237 # if `nclassdef` is an extern class)
238 var specpointer
= true
240 var supertypes
= new Array[MClassType]
241 if nclassdef
isa AStdClassdef then
242 for nsc
in nclassdef
.n_superclasses
do
244 var ntype
= nsc
.n_type
245 var mtype
= resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, false)
246 if mtype
== null then continue # Skip because of error
247 if not mtype
isa MClassType then
248 error
(ntype
, "Error: supertypes cannot be a formal type")
251 if not mclass
.kind
.can_specialize
(mtype
.mclass
.kind
) then
252 error
(ntype
, "Error: {mclass.kind} {mclass} cannot specialize {mtype.mclass.kind} {mtype.mclass}")
255 #print "new super : {mclass} < {mtype}"
256 if mtype
.mclass
.kind
== extern_kind
then specpointer
= false
260 if mclassdef
.is_intro
and objectclass
!= null then
261 if mclass
.kind
== extern_kind
and mclass
.name
!= "Pointer" then
262 # it is an extern class, but not a Pointer
263 if specpointer
then supertypes
.add pointerclass
.mclass_type
264 else if specobject
and mclass
.name
!= "Object" then
265 # it is a standard class without super class (but is not Object)
266 supertypes
.add objectclass
.mclass_type
270 mclassdef
.set_supertypes
(supertypes
)
271 if not supertypes
.is_empty
then self.toolcontext
.info
("{mclassdef} new super-types: {supertypes.join(", ")}", 3)
274 # Check the validity of the specialization heirarchy
275 private fun check_supertypes
(nmodule
: AModule, nclassdef
: AClassdef)
277 var mmodule
= nmodule
.mmodule
.as(not null)
278 var mclass
= nclassdef
.mclass
.as(not null)
279 var mclassdef
= nclassdef
.mclassdef
.as(not null)
281 for s
in mclassdef
.supertypes
do
282 if s
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, mclassdef
.bound_mtype
) then
283 error
(nclassdef
, "Error: Inheritance loop for class {mclass} with type {s}")
288 # Build the classes of the module `nmodule`.
289 # REQUIRE: classes of imported modules are already build. (let `phase` do the job)
290 private fun build_classes
(nmodule
: AModule)
292 var errcount
= toolcontext
.error_count
293 # Force building recursively
294 if nmodule
.build_classes_is_done
then return
295 nmodule
.build_classes_is_done
= true
296 var mmodule
= nmodule
.mmodule
.as(not null)
297 for imp
in mmodule
.in_importation
.direct_greaters
do
298 var nimp
= mmodule2node
(imp
)
299 if nimp
!= null then build_classes
(nimp
)
302 if errcount
!= toolcontext
.error_count
then return
305 for nclassdef
in nmodule
.n_classdefs
do
306 self.build_a_mclass
(nmodule
, nclassdef
)
309 if errcount
!= toolcontext
.error_count
then return
311 # Create all classdefs
312 for nclassdef
in nmodule
.n_classdefs
do
313 self.build_a_mclassdef
(nmodule
, nclassdef
)
316 if errcount
!= toolcontext
.error_count
then return
318 # Create inheritance on all classdefs
319 for nclassdef
in nmodule
.n_classdefs
do
320 self.collect_a_mclassdef_inheritance
(nmodule
, nclassdef
)
323 if errcount
!= toolcontext
.error_count
then return
325 # Create the mclassdef hierarchy
326 for mclassdef
in mmodule
.mclassdefs
do
327 mclassdef
.add_in_hierarchy
330 if errcount
!= toolcontext
.error_count
then return
333 for nclassdef
in nmodule
.n_classdefs
do
334 self.check_supertypes
(nmodule
, nclassdef
)
337 if errcount
!= toolcontext
.error_count
then return
339 # Check unchecked ntypes
340 for nclassdef
in nmodule
.n_classdefs
do
341 if nclassdef
isa AStdClassdef then
342 var mclassdef
= nclassdef
.mclassdef
343 # check bound of formal parameter
344 for nfd
in nclassdef
.n_formaldefs
do
345 var nfdt
= nfd
.n_type
346 if nfdt
!= null and nfdt
.mtype
!= null then
347 var bound
= resolve_mtype
(mmodule
, mclassdef
, nfdt
)
348 if bound
== null then return # Forward error
351 # check declared super types
352 for nsc
in nclassdef
.n_superclasses
do
353 var ntype
= nsc
.n_type
354 if ntype
.mtype
!= null then
355 var mtype
= resolve_mtype
(mmodule
, mclassdef
, ntype
)
356 if mtype
== null then return # Forward error
362 if errcount
!= toolcontext
.error_count
then return
364 # Check clash of ancestors
365 for nclassdef
in nmodule
.n_classdefs
do
366 var mclassdef
= nclassdef
.mclassdef
.as(not null)
367 var superclasses
= new HashMap[MClass, MClassType]
368 for scd
in mclassdef
.in_hierarchy
.greaters
do
369 for st
in scd
.supertypes
do
370 if not superclasses
.has_key
(st
.mclass
) then
371 superclasses
[st
.mclass
] = st
372 else if superclasses
[st
.mclass
] != st
then
373 var st1
= superclasses
[st
.mclass
].resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
374 var st2
= st
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
376 error
(nclassdef
, "Error: Incompatibles ancestors for {mclassdef.mclass}: {st1}, {st2}")
383 if errcount
!= toolcontext
.error_count
then return
385 # TODO: Check that the super-class is not intrusive
387 # Check that the superclasses are not already known (by transitivity)
388 for nclassdef
in nmodule
.n_classdefs
do
389 if not nclassdef
isa AStdClassdef then continue
390 var mclassdef
= nclassdef
.mclassdef
.as(not null)
392 # Get the direct superclasses
393 # Since we are a mclassdef, just look at the mclassdef hierarchy
394 var parents
= new Array[MClass]
395 for sup
in mclassdef
.in_hierarchy
.direct_greaters
do
396 parents
.add
(sup
.mclass
)
399 # Used to track duplicates of superclasses
400 var seen_parents
= new ArrayMap[MClass, AType]
403 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
405 # Check each declared superclass to see if it belong to the direct superclass
406 for nsc
in nclassdef
.n_superclasses
do
407 var ntype
= nsc
.n_type
408 var mtype
= ntype
.mtype
409 if mtype
== null then continue
410 assert mtype
isa MClassType
411 var sc
= mtype
.mclass
412 if not parents
.has
(sc
) or sc
== objectclass
then
413 # Skip the warning on generated code
414 if ntype
.location
.file
!= null and not ntype
.location
.file
.filename
.is_empty
then
415 warning
(ntype
, "useless-superclass", "Warning: superfluous super-class {mtype} in class {mclassdef.mclass}.")
417 else if not seen_parents
.has_key
(sc
) then
418 seen_parents
[sc
] = ntype
420 warning
(ntype
, "useless-superclass", "Warning: duplicated super-class {mtype} in class {mclassdef.mclass}.")
426 # Registration of the nclassdef associated to each mclassdef
427 private var mclassdef2nclassdef
= new HashMap[MClassDef, AClassdef]
431 # Flag that indicate if the class building is already completed
432 var build_classes_is_done
: Bool = false
433 # What is the AClassdef associated to a `MClass`?
434 # Used to check multiple definition of a class.
435 var mclass2nclassdef
: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef]
438 redef class AClassdef
439 # The associated MClass once build by a `ModelBuilder`
440 var mclass
: nullable MClass
441 # The associated MClassDef once build by a `ModelBuilder`
442 var mclassdef
: nullable MClassDef
443 # All (self and other) definitions for the same mclassdef
444 var all_defs
: nullable Array[AClassdef]
447 redef class AClasskind
448 # The class kind associated with the AST node class
449 private fun mkind
: MClassKind is abstract
451 redef class AConcreteClasskind
452 redef fun mkind
do return concrete_kind
454 redef class AAbstractClasskind
455 redef fun mkind
do return abstract_kind
457 redef class AInterfaceClasskind
458 redef fun mkind
do return interface_kind
460 redef class AEnumClasskind
461 redef fun mkind
do return enum_kind
463 redef class AExternClasskind
464 redef fun mkind
do return extern_kind
467 redef class AFormaldef
468 # The associated parameter type
469 var mtype
: nullable MParameterType = null
471 # The associated bound
472 var bound
: nullable MType = null