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]
50 if nclassdef
isa AStdClassdef then
51 var qid
= nclassdef
.n_qid
54 nkind
= nclassdef
.n_classkind
56 nvisibility
= nclassdef
.n_visibility
57 mvisibility
= nvisibility
.mvisibility
58 arity
= nclassdef
.n_formaldefs
.length
59 if mvisibility
== protected_visibility
then
60 error
(nvisibility
, "Error: only properties can be protected.")
62 else if mvisibility
== intrude_visibility
then
63 error
(nvisibility
, "Error: intrude is not a legal visibility for classes.")
66 # Collect formal parameter names
67 for i
in [0..arity
[ do
68 var nfd
= nclassdef
.n_formaldefs
[i
]
69 var ptname
= nfd
.n_id
.text
70 if names
.has
(ptname
) then
71 error
(nfd
, "Error: a formal parameter type `{ptname}` already exists.")
74 for c
in ptname
.chars
do if c
>= 'a' and c
<= 'z' then
75 warning
(nfd
, "formal-type-name", "Warning: lowercase in the formal parameter type `{ptname}`.")
80 mclass
= try_get_mclass_by_qid
(qid
, mmodule
)
81 if mclass
== null and (qid
.n_qualified
!= null or nclassdef
.n_kwredef
!= null) then
82 class_not_found
(qid
, mmodule
)
83 nclassdef
.is_broken
= true
87 else if nclassdef
isa ATopClassdef and nclassdef
.n_propdefs
.first
.as(AMethPropdef).n_methid
.collect_text
== "sys" then
88 # Special case to keep `sys` in object.
89 # Needed to keep working bootstrap and a working java FFI together.
90 # TODO: remove once safe to remove
93 mkind
= interface_kind
95 mvisibility
= public_visibility
96 mclass
= try_get_mclass_by_name
(nclassdef
, mmodule
, name
)
100 mkind
= concrete_kind
102 mvisibility
= public_visibility
103 mclass
= try_get_mclass_by_name
(nclassdef
, mmodule
, name
)
106 if mclass
== null then
107 # Check for conflicting class full-names in the package
108 if mmodule
.mgroup
!= null and mvisibility
>= protected_visibility
then
109 var mclasses
= model
.get_mclasses_by_name
(name
)
110 if mclasses
!= null then for other
in mclasses
do
111 if other
.intro_mmodule
.mgroup
!= null and other
.intro_mmodule
.mgroup
.mpackage
== mmodule
.mgroup
.mpackage
then
112 # Skip classes that are buggy
113 if other
.try_intro
== null then continue
114 warning
(nclassdef
, "full-name-conflict", "Error: a class named `{other.full_name}` is already defined in module `{other.intro_mmodule}` at {other.intro.location}.")
120 mclass
= new MClass(mmodule
, name
, nclassdef
.location
, names
, mkind
, mvisibility
)
121 #print "new class {mclass}"
122 else if nclassdef
isa AStdClassdef and nmodule
.mclass2nclassdef
.has_key
(mclass
) then
123 error
(nclassdef
, "Error: a class `{name}` is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.")
124 mclass
.is_broken
= true
126 else if nclassdef
isa AStdClassdef and nclassdef
.n_kwredef
== null then
127 error
(nclassdef
, "Redef Error: `{name}` is an imported class. Add the `redef` keyword to refine it.")
128 mclass
.is_broken
= true
130 else if arity
!= 0 and mclass
.arity
!= arity
then
131 error
(nclassdef
, "Redef Error: expected {mclass.arity} formal parameter(s) for {mclass.signature_to_s}; got {arity}.")
132 mclass
.is_broken
= true
134 else if nkind
!= null and mkind
!= concrete_kind
and mclass
.kind
!= mkind
then
135 error
(nkind
, "Redef Error: refinement changed the kind from `{mclass.kind}` to `{mkind}`.")
136 else if nvisibility
!= null and mvisibility
!= public_visibility
and mclass
.visibility
!= mvisibility
then
137 error
(nvisibility
, "Redef Error: refinement changed the visibility from `{mclass.visibility}` to `{mvisibility}`")
139 nclassdef
.mclass
= mclass
140 if not nmodule
.mclass2nclassdef
.has_key
(mclass
) then
141 nmodule
.mclass2nclassdef
[mclass
] = nclassdef
142 nclassdef
.all_defs
= [nclassdef
]
144 nmodule
.mclass2nclassdef
[mclass
].all_defs
.add
(nclassdef
)
148 # Visit the AST and create the `MClassDef` objects
149 private fun build_a_mclassdef
(nmodule
: AModule, nclassdef
: AClassdef)
151 var mmodule
= nmodule
.mmodule
.as(not null)
152 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
153 var mclass
= nclassdef
.mclass
154 if mclass
== null then return # Skip error
156 # In case of non-standard AClassdef, try to attach to an already existing mclassdef
157 var other_nclassdef
= nmodule
.mclass2nclassdef
[mclass
]
158 if other_nclassdef
!= nclassdef
then
159 assert not nclassdef
isa AStdClassdef
160 nclassdef
.mclassdef
= other_nclassdef
.mclassdef
164 var bounds
= new Array[MType]
165 if nclassdef
isa AStdClassdef and mclass
.arity
> 0 then
166 # Revolve bound for formal parameters
167 for i
in [0..mclass
.arity
[ do
168 if nclassdef
.n_formaldefs
.is_empty
then
170 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
175 var nfd
= nclassdef
.n_formaldefs
[i
]
176 var pname
= mclass
.mparameters
[i
].name
177 if nfd
.n_id
.text
!= pname
then
178 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}`.")
180 var nfdt
= nfd
.n_type
182 var bound
= resolve_mtype_unchecked
(mmodule
, null, nfdt
, false)
183 if bound
== null then return # Forward error
184 if bound
.need_anchor
then
186 error
(nfd
, "Error: formal parameter type `{pname}` bounded with a formal parameter type.")
191 if bound
isa MClassType and bound
.mclass
.kind
== enum_kind
then
192 warning
(nfdt
, "useless-bound", "Warning: useless formal parameter type since `{bound}` cannot have subclasses.")
194 else if mclass
.mclassdefs
.is_empty
then
195 if objectclass
== null then
196 error
(nfd
, "Error: formal parameter type `{pname}` unbounded but no `Object` class exists.")
199 # No bound, then implicitely bound by nullable Object
200 var bound
= objectclass
.mclass_type
.as_nullable
205 var bound
= mclass
.intro
.bound_mtype
.arguments
[i
]
212 var bound_mtype
= mclass
.get_mtype
(bounds
)
213 var mclassdef
= new MClassDef(mmodule
, bound_mtype
, nclassdef
.location
)
214 nclassdef
.mclassdef
= mclassdef
215 self.mclassdef2nclassdef
[mclassdef
] = nclassdef
217 if nclassdef
isa AStdClassdef then
218 var ndoc
= nclassdef
.n_doc
220 var mdoc
= ndoc
.to_mdoc
221 mclassdef
.mdoc
= mdoc
222 mdoc
.original_mentity
= mclassdef
223 else if mclassdef
.is_intro
and mclass
.visibility
>= public_visibility
then
224 advice
(nclassdef
, "missing-doc", "Documentation warning: Undocumented public class `{mclass}`")
228 if mclassdef
.is_intro
then
229 self.toolcontext
.info
("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3)
231 self.toolcontext
.info
("{mclassdef} refines {mclass.kind} {mclass.full_name}", 3)
235 # Visit the AST and set the super-types of the `MClassDef` objects
236 private fun collect_a_mclassdef_inheritance
(nmodule
: AModule, nclassdef
: AClassdef)
238 var mmodule
= nmodule
.mmodule
239 if mmodule
== null then return
240 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
241 var pointerclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Pointer")
242 var mclass
= nclassdef
.mclass
243 if mclass
== null then return
244 var mclassdef
= nclassdef
.mclassdef
245 if mclassdef
== null then return
247 # Do we need to specify Object as a super class?
248 var specobject
= true
250 # Do we need to specify Pointer as a super class? (is only valid
251 # if `nclassdef` is an extern class)
252 var specpointer
= true
254 var supertypes
= new Array[MClassType]
255 if nclassdef
isa AStdClassdef then
256 for nsc
in nclassdef
.n_superclasses
do
258 var ntype
= nsc
.n_type
259 var mtype
= resolve_mtype_unchecked
(mmodule
, mclassdef
, ntype
, false)
260 if mtype
== null then continue # Skip because of error
261 if not mtype
isa MClassType then
262 error
(ntype
, "Error: supertypes cannot be a formal type.")
265 if not mclass
.kind
.can_specialize
(mtype
.mclass
.kind
) then
266 error
(ntype
, "Error: {mclass.kind} `{mclass}` cannot specialize {mtype.mclass.kind} `{mtype.mclass}`.")
269 #print "new super : {mclass} < {mtype}"
270 if mtype
.mclass
.kind
== extern_kind
then specpointer
= false
274 if mclassdef
.is_intro
and objectclass
!= null then
275 if mclass
.kind
== extern_kind
and mclass
.name
!= "Pointer" then
276 # it is an extern class, but not a Pointer
277 if pointerclass
== null then
278 error
(nclassdef
, "Error: `Pointer` must be defined first.")
281 if specpointer
then supertypes
.add pointerclass
.mclass_type
282 else if specobject
then
283 if mclass
.name
!= "Object" then
284 # it is a standard class without super class (but is not Object)
285 supertypes
.add objectclass
.mclass_type
286 else if mclass
.kind
!= interface_kind
then
287 error
(nclassdef
, "Error: `Object` must be an {interface_kind}.")
293 mclassdef
.set_supertypes
(supertypes
)
294 if not supertypes
.is_empty
then self.toolcontext
.info
("{mclassdef} new super-types: {supertypes.join(", ")}", 3)
297 # Check the validity of the specialization heirarchy
298 private fun check_supertypes
(nmodule
: AModule, nclassdef
: AClassdef)
300 var mmodule
= nmodule
.mmodule
301 if mmodule
== null then return
302 var mclass
= nclassdef
.mclass
303 if mclass
== null then return
304 var mclassdef
= nclassdef
.mclassdef
305 if mclassdef
== null then return
307 for s
in mclassdef
.supertypes
do
308 if s
.is_subtype
(mmodule
, mclassdef
.bound_mtype
, mclassdef
.bound_mtype
) then
309 error
(nclassdef
, "Error: inheritance loop for class `{mclass}` with type `{s}`.")
314 # Build the classes of the module `nmodule`.
315 private fun build_classes
(nmodule
: AModule)
317 # Force building recursively
318 if nmodule
.build_classes_is_done
then return
319 nmodule
.build_classes_is_done
= true
320 var mmodule
= nmodule
.mmodule
321 if mmodule
== null then return
322 for imp
in mmodule
.in_importation
.direct_greaters
do
323 var nimp
= mmodule2node
(imp
)
324 if nimp
!= null then build_classes
(nimp
)
328 # process AStdClassdef before so that non-AStdClassdef classes can be attached to existing ones, if any
329 for nclassdef
in nmodule
.n_classdefs
do
330 if not nclassdef
isa AStdClassdef then continue
331 self.build_a_mclass
(nmodule
, nclassdef
)
333 for nclassdef
in nmodule
.n_classdefs
do
334 if nclassdef
isa AStdClassdef then continue
335 self.build_a_mclass
(nmodule
, nclassdef
)
338 # Create all classdefs
339 for nclassdef
in nmodule
.n_classdefs
do
340 if not nclassdef
isa AStdClassdef then continue
341 self.build_a_mclassdef
(nmodule
, nclassdef
)
343 for nclassdef
in nmodule
.n_classdefs
do
344 if nclassdef
isa AStdClassdef then continue
345 self.build_a_mclassdef
(nmodule
, nclassdef
)
348 # Create inheritance on all classdefs
349 for nclassdef
in nmodule
.n_classdefs
do
350 self.collect_a_mclassdef_inheritance
(nmodule
, nclassdef
)
353 # Create the mclassdef hierarchy
354 for mclassdef
in mmodule
.mclassdefs
do
355 mclassdef
.add_in_hierarchy
359 for nclassdef
in nmodule
.n_classdefs
do
360 self.check_supertypes
(nmodule
, nclassdef
)
363 # Check unchecked ntypes
364 for nclassdef
in nmodule
.n_classdefs
do
365 if nclassdef
isa AStdClassdef then
366 var mclassdef
= nclassdef
.mclassdef
367 # check bound of formal parameter
368 for nfd
in nclassdef
.n_formaldefs
do
369 var nfdt
= nfd
.n_type
370 if nfdt
!= null and nfdt
.mtype
!= null then
371 var bound
= resolve_mtype
(mmodule
, mclassdef
, nfdt
)
372 if bound
== null then return # Forward error
375 # check declared super types
376 for nsc
in nclassdef
.n_superclasses
do
377 var ntype
= nsc
.n_type
378 if ntype
.mtype
!= null then
379 var mtype
= resolve_mtype
(mmodule
, mclassdef
, ntype
)
380 if mtype
== null then return # Forward error
386 # Check clash of ancestors
387 for nclassdef
in nmodule
.n_classdefs
do
388 var mclassdef
= nclassdef
.mclassdef
389 if mclassdef
== null then continue
390 var superclasses
= new HashMap[MClass, MClassType]
391 for scd
in mclassdef
.in_hierarchy
.greaters
do
392 for st
in scd
.supertypes
do
393 if not superclasses
.has_key
(st
.mclass
) then
394 superclasses
[st
.mclass
] = st
395 else if superclasses
[st
.mclass
] != st
then
396 var st1
= superclasses
[st
.mclass
].resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
397 var st2
= st
.resolve_for
(mclassdef
.mclass
.mclass_type
, mclassdef
.bound_mtype
, mmodule
, false)
399 error
(nclassdef
, "Error: incompatible ancestors for `{mclassdef.mclass}`; conflict: `{st1}` and `{st2}`")
406 # TODO: Check that the super-class is not intrusive
408 # Check that the superclasses are not already known (by transitivity)
409 for nclassdef
in nmodule
.n_classdefs
do
410 if not nclassdef
isa AStdClassdef or nclassdef
.is_broken
then continue
411 var mclassdef
= nclassdef
.mclassdef
412 if mclassdef
== null then continue
414 # Get the direct superclasses
415 # Since we are a mclassdef, just look at the mclassdef hierarchy
416 var parents
= new Array[MClass]
417 for sup
in mclassdef
.in_hierarchy
.direct_greaters
do
418 parents
.add
(sup
.mclass
)
421 # Used to track duplicates of superclasses
422 var seen_parents
= new ArrayMap[MClass, AType]
425 var objectclass
= try_get_mclass_by_name
(nmodule
, mmodule
, "Object")
427 # Check each declared superclass to see if it belong to the direct superclass
428 for nsc
in nclassdef
.n_superclasses
do
429 var ntype
= nsc
.n_type
430 var mtype
= ntype
.mtype
431 if mtype
== null then continue
432 assert mtype
isa MClassType
433 var sc
= mtype
.mclass
434 if not parents
.has
(sc
) or sc
== objectclass
then
435 # Skip the warning on generated code
436 if ntype
.location
.file
!= null and not ntype
.location
.file
.filename
.is_empty
then
437 warning
(ntype
, "useless-superclass", "Warning: superfluous super-class `{mtype}` in class `{mclassdef.mclass}`.")
439 else if not seen_parents
.has_key
(sc
) then
440 seen_parents
[sc
] = ntype
442 warning
(ntype
, "useless-superclass", "Warning: duplicated super-class `{mtype}` in class `{mclassdef.mclass}`.")
448 # Registration of the nclassdef associated to each mclassdef
449 private var mclassdef2nclassdef
= new HashMap[MClassDef, AClassdef]
451 # Retrieve the associated AST node of a mclassdef.
453 # This method is used to associate model entity with syntactic entities.
454 # If the class definition is not associated with a node, returns `null`.
455 fun mclassdef2node
(mclassdef
: MClassDef): nullable AClassdef do
456 return mclassdef2nclassdef
.get_or_null
(mclassdef
)
461 # Flag that indicate if the class building is already completed
462 var build_classes_is_done
: Bool = false
463 # What is the AClassdef associated to a `MClass`?
464 # Used to check multiple definition of a class.
465 var mclass2nclassdef
: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef]
468 redef class AClassdef
469 # The associated MClass once build by a `ModelBuilder`
470 var mclass
: nullable MClass
471 # The associated MClassDef once build by a `ModelBuilder`
472 var mclassdef
: nullable MClassDef
473 # All (self and other) definitions for the same mclassdef
474 var all_defs
: nullable Array[AClassdef]
477 redef class AClasskind
478 # The class kind associated with the AST node class
479 private fun mkind
: MClassKind is abstract
481 redef class AConcreteClasskind
482 redef fun mkind
do return concrete_kind
484 redef class AAbstractClasskind
485 redef fun mkind
do return abstract_kind
487 redef class AInterfaceClasskind
488 redef fun mkind
do return interface_kind
490 redef class AEnumClasskind
491 redef fun mkind
do return enum_kind
493 redef class AExternClasskind
494 redef fun mkind
do return extern_kind
497 redef class AFormaldef
498 # The associated parameter type
499 var mtype
: nullable MParameterType = null
501 # The associated bound
502 var bound
: nullable MType = null