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 # Classes, types and properties
19 # All three concepts are defined in this same module because these are strongly connected:
20 # * types are based on classes
21 # * classes contains properties
22 # * some properties are types (virtual types)
24 # TODO: liearization, extern stuff
25 # FIXME: better handling of the types
31 private import more_collections
35 var mclasses
= new Array[MClass]
37 # All known properties
38 var mproperties
= new Array[MProperty]
40 # Hierarchy of class definition.
42 # Each classdef is associated with its super-classdefs in regard to
43 # its module of definition.
44 var mclassdef_hierarchy
= new POSet[MClassDef]
46 # Class-type hierarchy restricted to the introduction.
48 # The idea is that what is true on introduction is always true whatever
49 # the module considered.
50 # Therefore, this hierarchy is used for a fast positive subtype check.
52 # This poset will evolve in a monotonous way:
53 # * Two non connected nodes will remain unconnected
54 # * New nodes can appear with new edges
55 private var intro_mtype_specialization_hierarchy
= new POSet[MClassType]
57 # Global overlapped class-type hierarchy.
58 # The hierarchy when all modules are combined.
59 # Therefore, this hierarchy is used for a fast negative subtype check.
61 # This poset will evolve in an anarchic way. Loops can even be created.
63 # FIXME decide what to do on loops
64 private var full_mtype_specialization_hierarchy
= new POSet[MClassType]
66 # Collections of classes grouped by their short name
67 private var mclasses_by_name
= new MultiHashMap[String, MClass]
69 # Return all class named `name`.
71 # If such a class does not exist, null is returned
72 # (instead of an empty array)
74 # Visibility or modules are not considered
75 fun get_mclasses_by_name
(name
: String): nullable Array[MClass]
77 if mclasses_by_name
.has_key
(name
) then
78 return mclasses_by_name
[name
]
84 # Collections of properties grouped by their short name
85 private var mproperties_by_name
= new MultiHashMap[String, MProperty]
87 # Return all properties named `name`.
89 # If such a property does not exist, null is returned
90 # (instead of an empty array)
92 # Visibility or modules are not considered
93 fun get_mproperties_by_name
(name
: String): nullable Array[MProperty]
95 if not mproperties_by_name
.has_key
(name
) then
98 return mproperties_by_name
[name
]
103 var null_type
= new MNullType(self)
105 # Build an ordered tree with from `concerns`
106 fun concerns_tree
(mconcerns
: Collection[MConcern]): ConcernsTree do
107 var seen
= new HashSet[MConcern]
108 var res
= new ConcernsTree
110 var todo
= new Array[MConcern]
111 todo
.add_all mconcerns
113 while not todo
.is_empty
do
115 if seen
.has
(c
) then continue
116 var pc
= c
.parent_concern
130 # An OrderedTree that can be easily refined for display purposes
132 super OrderedTree[MConcern]
136 # All the classes introduced in the module
137 var intro_mclasses
= new Array[MClass]
139 # All the class definitions of the module
140 # (introduction and refinement)
141 var mclassdefs
= new Array[MClassDef]
143 # Does the current module has a given class `mclass`?
144 # Return true if the mmodule introduces, refines or imports a class.
145 # Visibility is not considered.
146 fun has_mclass
(mclass
: MClass): Bool
148 return self.in_importation
<= mclass
.intro_mmodule
151 # Full hierarchy of introduced ans imported classes.
153 # Create a new hierarchy got by flattening the classes for the module
154 # and its imported modules.
155 # Visibility is not considered.
157 # Note: this function is expensive and is usually used for the main
158 # module of a program only. Do not use it to do you own subtype
160 fun flatten_mclass_hierarchy
: POSet[MClass]
162 var res
= self.flatten_mclass_hierarchy_cache
163 if res
!= null then return res
164 res
= new POSet[MClass]
165 for m
in self.in_importation
.greaters
do
166 for cd
in m
.mclassdefs
do
169 for s
in cd
.supertypes
do
170 res
.add_edge
(c
, s
.mclass
)
174 self.flatten_mclass_hierarchy_cache
= res
178 # Sort a given array of classes using the linearization order of the module
179 # The most general is first, the most specific is last
180 fun linearize_mclasses
(mclasses
: Array[MClass])
182 self.flatten_mclass_hierarchy
.sort
(mclasses
)
185 # Sort a given array of class definitions using the linearization order of the module
186 # the refinement link is stronger than the specialisation link
187 # The most general is first, the most specific is last
188 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
190 var sorter
= new MClassDefSorter(self)
191 sorter
.sort
(mclassdefs
)
194 # Sort a given array of property definitions using the linearization order of the module
195 # the refinement link is stronger than the specialisation link
196 # The most general is first, the most specific is last
197 fun linearize_mpropdefs
(mpropdefs
: Array[MPropDef])
199 var sorter
= new MPropDefSorter(self)
200 sorter
.sort
(mpropdefs
)
203 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
205 # The primitive type `Object`, the root of the class hierarchy
206 fun object_type
: MClassType
208 var res
= self.object_type_cache
209 if res
!= null then return res
210 res
= self.get_primitive_class
("Object").mclass_type
211 self.object_type_cache
= res
215 private var object_type_cache
: nullable MClassType
217 # The type `Pointer`, super class to all extern classes
218 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
220 # The primitive type `Bool`
221 fun bool_type
: MClassType
223 var res
= self.bool_type_cache
224 if res
!= null then return res
225 res
= self.get_primitive_class
("Bool").mclass_type
226 self.bool_type_cache
= res
230 private var bool_type_cache
: nullable MClassType
232 # The primitive type `Sys`, the main type of the program, if any
233 fun sys_type
: nullable MClassType
235 var clas
= self.model
.get_mclasses_by_name
("Sys")
236 if clas
== null then return null
237 return get_primitive_class
("Sys").mclass_type
240 # The primitive type `Finalizable`
241 # Used to tag classes that need to be finalized.
242 fun finalizable_type
: nullable MClassType
244 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
245 if clas
== null then return null
246 return get_primitive_class
("Finalizable").mclass_type
249 # Force to get the primitive class named `name` or abort
250 fun get_primitive_class
(name
: String): MClass
252 var cla
= self.model
.get_mclasses_by_name
(name
)
254 if name
== "Bool" then
255 var c
= new MClass(self, name
, null, enum_kind
, public_visibility
)
256 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0))
259 print
("Fatal Error: no primitive class {name}")
262 if cla
.length
!= 1 then
263 var msg
= "Fatal Error: more than one primitive class {name}:"
264 for c
in cla
do msg
+= " {c.full_name}"
271 # Try to get the primitive method named `name` on the type `recv`
272 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
274 var props
= self.model
.get_mproperties_by_name
(name
)
275 if props
== null then return null
276 var res
: nullable MMethod = null
277 for mprop
in props
do
278 assert mprop
isa MMethod
279 var intro
= mprop
.intro_mclassdef
280 for mclassdef
in recv
.mclassdefs
do
281 if not self.in_importation
.greaters
.has
(mclassdef
.mmodule
) then continue
282 if not mclassdef
.in_hierarchy
.greaters
.has
(intro
) then continue
285 else if res
!= mprop
then
286 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
295 private class MClassDefSorter
297 redef type COMPARED: MClassDef
299 redef fun compare
(a
, b
)
303 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
304 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
308 private class MPropDefSorter
310 redef type COMPARED: MPropDef
312 redef fun compare
(pa
, pb
)
318 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
319 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
325 # `MClass` are global to the model; it means that a `MClass` is not bound to a
326 # specific `MModule`.
328 # This characteristic helps the reasoning about classes in a program since a
329 # single `MClass` object always denote the same class.
331 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
332 # These do not really have properties nor belong to a hierarchy since the property and the
333 # hierarchy of a class depends of the refinement in the modules.
335 # Most services on classes require the precision of a module, and no one can asks what are
336 # the super-classes of a class nor what are properties of a class without precising what is
337 # the module considered.
339 # For instance, during the typing of a source-file, the module considered is the module of the file.
340 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
341 # *is the method `foo` exists in the class `Bar` in the current module?*
343 # During some global analysis, the module considered may be the main module of the program.
347 # The module that introduce the class
348 # While classes are not bound to a specific module,
349 # the introducing module is used for naming an visibility
350 var intro_mmodule
: MModule
352 # The short name of the class
353 # In Nit, the name of a class cannot evolve in refinements
354 redef var name
: String
356 # The canonical name of the class
357 # Example: `"owner::module::MyClass"`
358 fun full_name
: String
360 return "{self.intro_mmodule.full_name}::{name}"
363 # The number of generic formal parameters
364 # 0 if the class is not generic
365 var arity
: Int is noinit
367 # Each generic formal parameters in order.
368 # is empty if the class is not generic
369 var mparameters
= new Array[MParameterType]
371 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
374 if parameter_names
== null then
377 self.arity
= parameter_names
.length
380 # Create the formal parameter types
382 assert parameter_names
!= null
383 var mparametertypes
= new Array[MParameterType]
384 for i
in [0..arity
[ do
385 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
386 mparametertypes
.add
(mparametertype
)
388 self.mparameters
= mparametertypes
389 var mclass_type
= new MGenericType(self, mparametertypes
)
390 self.mclass_type
= mclass_type
391 self.get_mtype_cache
[mparametertypes
] = mclass_type
393 self.mclass_type
= new MClassType(self)
397 # The kind of the class (interface, abstract class, etc.)
398 # In Nit, the kind of a class cannot evolve in refinements
401 # The visibility of the class
402 # In Nit, the visibility of a class cannot evolve in refinements
403 var visibility
: MVisibility
407 intro_mmodule
.intro_mclasses
.add
(self)
408 var model
= intro_mmodule
.model
409 model
.mclasses_by_name
.add_one
(name
, self)
410 model
.mclasses
.add
(self)
413 redef fun model
do return intro_mmodule
.model
415 # All class definitions (introduction and refinements)
416 var mclassdefs
= new Array[MClassDef]
419 redef fun to_s
do return self.name
421 # The definition that introduces the class.
423 # Warning: such a definition may not exist in the early life of the object.
424 # In this case, the method will abort.
425 var intro
: MClassDef is noinit
427 # Return the class `self` in the class hierarchy of the module `mmodule`.
429 # SEE: `MModule::flatten_mclass_hierarchy`
430 # REQUIRE: `mmodule.has_mclass(self)`
431 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
433 return mmodule
.flatten_mclass_hierarchy
[self]
436 # The principal static type of the class.
438 # For non-generic class, mclass_type is the only `MClassType` based
441 # For a generic class, the arguments are the formal parameters.
442 # i.e.: for the class Array[E:Object], the `mclass_type` is Array[E].
443 # If you want Array[Object] the see `MClassDef::bound_mtype`
445 # For generic classes, the mclass_type is also the way to get a formal
446 # generic parameter type.
448 # To get other types based on a generic class, see `get_mtype`.
450 # ENSURE: `mclass_type.mclass == self`
451 var mclass_type
: MClassType is noinit
453 # Return a generic type based on the class
454 # Is the class is not generic, then the result is `mclass_type`
456 # REQUIRE: `mtype_arguments.length == self.arity`
457 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
459 assert mtype_arguments
.length
== self.arity
460 if self.arity
== 0 then return self.mclass_type
461 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
462 if res
!= null then return res
463 res
= new MGenericType(self, mtype_arguments
)
464 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
468 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
472 # A definition (an introduction or a refinement) of a class in a module
474 # A `MClassDef` is associated with an explicit (or almost) definition of a
475 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
476 # a specific class and a specific module, and contains declarations like super-classes
479 # It is the class definitions that are the backbone of most things in the model:
480 # ClassDefs are defined with regard with other classdefs.
481 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
483 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
487 # The module where the definition is
490 # The associated `MClass`
491 var mclass
: MClass is noinit
493 # The bounded type associated to the mclassdef
495 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
499 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
500 # If you want Array[E], then see `mclass.mclass_type`
502 # ENSURE: `bound_mtype.mclass == self.mclass`
503 var bound_mtype
: MClassType
505 # The origin of the definition
506 var location
: Location
508 # Internal name combining the module and the class
509 # Example: "mymodule#MyClass"
510 redef var to_s
: String is noinit
514 self.mclass
= bound_mtype
.mclass
515 mmodule
.mclassdefs
.add
(self)
516 mclass
.mclassdefs
.add
(self)
517 if mclass
.intro_mmodule
== mmodule
then
518 assert not isset mclass
._intro
521 self.to_s
= "{mmodule}#{mclass}"
524 # Actually the name of the `mclass`
525 redef fun name
do return mclass
.name
527 redef fun model
do return mmodule
.model
529 # All declared super-types
530 # FIXME: quite ugly but not better idea yet
531 var supertypes
= new Array[MClassType]
533 # Register some super-types for the class (ie "super SomeType")
535 # The hierarchy must not already be set
536 # REQUIRE: `self.in_hierarchy == null`
537 fun set_supertypes
(supertypes
: Array[MClassType])
539 assert unique_invocation
: self.in_hierarchy
== null
540 var mmodule
= self.mmodule
541 var model
= mmodule
.model
542 var mtype
= self.bound_mtype
544 for supertype
in supertypes
do
545 self.supertypes
.add
(supertype
)
547 # Register in full_type_specialization_hierarchy
548 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
549 # Register in intro_type_specialization_hierarchy
550 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
551 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
557 # Collect the super-types (set by set_supertypes) to build the hierarchy
559 # This function can only invoked once by class
560 # REQUIRE: `self.in_hierarchy == null`
561 # ENSURE: `self.in_hierarchy != null`
564 assert unique_invocation
: self.in_hierarchy
== null
565 var model
= mmodule
.model
566 var res
= model
.mclassdef_hierarchy
.add_node
(self)
567 self.in_hierarchy
= res
568 var mtype
= self.bound_mtype
570 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
571 # The simpliest way is to attach it to collect_mclassdefs
572 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
573 res
.poset
.add_edge
(self, mclassdef
)
577 # The view of the class definition in `mclassdef_hierarchy`
578 var in_hierarchy
: nullable POSetElement[MClassDef] = null
580 # Is the definition the one that introduced `mclass`?
581 fun is_intro
: Bool do return mclass
.intro
== self
583 # All properties introduced by the classdef
584 var intro_mproperties
= new Array[MProperty]
586 # All property definitions in the class (introductions and redefinitions)
587 var mpropdefs
= new Array[MPropDef]
590 # A global static type
592 # MType are global to the model; it means that a `MType` is not bound to a
593 # specific `MModule`.
594 # This characteristic helps the reasoning about static types in a program
595 # since a single `MType` object always denote the same type.
597 # However, because a `MType` is global, it does not really have properties
598 # nor have subtypes to a hierarchy since the property and the class hierarchy
599 # depends of a module.
600 # Moreover, virtual types an formal generic parameter types also depends on
601 # a receiver to have sense.
603 # Therefore, most method of the types require a module and an anchor.
604 # The module is used to know what are the classes and the specialization
606 # The anchor is used to know what is the bound of the virtual types and formal
607 # generic parameter types.
609 # MType are not directly usable to get properties. See the `anchor_to` method
610 # and the `MClassType` class.
612 # FIXME: the order of the parameters is not the best. We mus pick on from:
613 # * foo(mmodule, anchor, othertype)
614 # * foo(othertype, anchor, mmodule)
615 # * foo(anchor, mmodule, othertype)
616 # * foo(othertype, mmodule, anchor)
620 redef fun name
do return to_s
622 # Return true if `self` is an subtype of `sup`.
623 # The typing is done using the standard typing policy of Nit.
625 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
626 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
627 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
630 if sub
== sup
then return true
631 if anchor
== null then
632 assert not sub
.need_anchor
633 assert not sup
.need_anchor
635 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
636 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
639 # First, resolve the formal types to a common version in the receiver
640 # The trick here is that fixed formal type will be associated to the bound
641 # And unfixed formal types will be associated to a canonical formal type.
642 if sub
isa MParameterType or sub
isa MVirtualType then
643 assert anchor
!= null
644 sub
= sub
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
646 if sup
isa MParameterType or sup
isa MVirtualType then
647 assert anchor
!= null
648 sup
= sup
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
651 # Does `sup` accept null or not?
652 # Discard the nullable marker if it exists
653 var sup_accept_null
= false
654 if sup
isa MNullableType then
655 sup_accept_null
= true
657 else if sup
isa MNullType then
658 sup_accept_null
= true
661 # Can `sub` provide null or not?
662 # Thus we can match with `sup_accept_null`
663 # Also discard the nullable marker if it exists
664 if sub
isa MNullableType then
665 if not sup_accept_null
then return false
667 else if sub
isa MNullType then
668 return sup_accept_null
670 # Now the case of direct null and nullable is over.
672 # A unfixed formal type can only accept itself
673 if sup
isa MParameterType or sup
isa MVirtualType then
677 # If `sub` is a formal type, then it is accepted if its bound is accepted
678 if sub
isa MParameterType or sub
isa MVirtualType then
679 assert anchor
!= null
680 sub
= sub
.anchor_to
(mmodule
, anchor
)
682 # Manage the second layer of null/nullable
683 if sub
isa MNullableType then
684 if not sup_accept_null
then return false
686 else if sub
isa MNullType then
687 return sup_accept_null
691 assert sub
isa MClassType # It is the only remaining type
693 if sup
isa MNullType then
694 # `sup` accepts only null
698 assert sup
isa MClassType # It is the only remaining type
700 # Now both are MClassType, we need to dig
702 if sub
== sup
then return true
704 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
705 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
706 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
707 if res
== false then return false
708 if not sup
isa MGenericType then return true
709 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
710 assert sub2
.mclass
== sup
.mclass
711 for i
in [0..sup
.mclass
.arity
[ do
712 var sub_arg
= sub2
.arguments
[i
]
713 var sup_arg
= sup
.arguments
[i
]
714 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
715 if res
== false then return false
720 # The base class type on which self is based
722 # This base type is used to get property (an internally to perform
723 # unsafe type comparison).
725 # Beware: some types (like null) are not based on a class thus this
728 # Basically, this function transform the virtual types and parameter
729 # types to their bounds.
734 # class B super A end
736 # class Y super X end
745 # Map[T,U] anchor_to H #-> Map[B,Y]
747 # Explanation of the example:
748 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
749 # because "redef type U: Y". Therefore, Map[T, U] is bound to
752 # ENSURE: `not self.need_anchor implies result == self`
753 # ENSURE: `not result.need_anchor`
754 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
756 if not need_anchor
then return self
757 assert not anchor
.need_anchor
758 # Just resolve to the anchor and clear all the virtual types
759 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
760 assert not res
.need_anchor
764 # Does `self` contain a virtual type or a formal generic parameter type?
765 # In order to remove those types, you usually want to use `anchor_to`.
766 fun need_anchor
: Bool do return true
768 # Return the supertype when adapted to a class.
770 # In Nit, for each super-class of a type, there is a equivalent super-type.
776 # class H[V] super G[V, Bool] end
778 # H[Int] supertype_to G #-> G[Int, Bool]
781 # REQUIRE: `super_mclass` is a super-class of `self`
782 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
783 # ENSURE: `result.mclass = super_mclass`
784 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
786 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
787 if self isa MClassType and self.mclass
== super_mclass
then return self
789 if self.need_anchor
then
790 assert anchor
!= null
791 resolved_self
= self.anchor_to
(mmodule
, anchor
)
795 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
796 for supertype
in supertypes
do
797 if supertype
.mclass
== super_mclass
then
798 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
799 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
805 # Replace formals generic types in self with resolved values in `mtype`
806 # If `cleanup_virtual` is true, then virtual types are also replaced
809 # This function returns self if `need_anchor` is false.
815 # class H[F] super G[F] end
819 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
820 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
822 # Explanation of the example:
823 # * Array[E].need_anchor is true because there is a formal generic parameter type E
824 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
825 # * Since "H[F] super G[F]", E is in fact F for H
826 # * More specifically, in H[Int], E is Int
827 # * So, in H[Int], Array[E] is Array[Int]
829 # This function is mainly used to inherit a signature.
830 # Because, unlike `anchor_to`, we do not want a full resolution of
831 # a type but only an adapted version of it.
837 # fun foo(e:E):E is abstract
839 # class B super A[Int] end
842 # The signature on foo is (e: E): E
843 # If we resolve the signature for B, we get (e:Int):Int
849 # fun foo(e:E):E is abstract
853 # fun bar do a.foo(x) # <- x is here
857 # The first question is: is foo available on `a`?
859 # The static type of a is `A[Array[F]]`, that is an open type.
860 # in order to find a method `foo`, whe must look at a resolved type.
862 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
864 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
866 # The next question is: what is the accepted types for `x`?
868 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
870 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
872 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
874 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
875 # two function instead of one seems also to be a bad idea.
877 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
878 # ENSURE: `not self.need_anchor implies result == self`
879 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
881 # Can the type be resolved?
883 # In order to resolve open types, the formal types must make sence.
893 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
895 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
897 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
898 # # B[E] is a red hearing only the E is important,
899 # # E make sense in A
902 # REQUIRE: `anchor != null implies not anchor.need_anchor`
903 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
904 # ENSURE: `not self.need_anchor implies result == true`
905 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
907 # Return the nullable version of the type
908 # If the type is already nullable then self is returned
909 fun as_nullable
: MType
911 var res
= self.as_nullable_cache
912 if res
!= null then return res
913 res
= new MNullableType(self)
914 self.as_nullable_cache
= res
918 # Return the not nullable version of the type
919 # Is the type is already not nullable, then self is returned.
921 # Note: this just remove the `nullable` notation, but the result can still contains null.
922 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
923 fun as_notnullable
: MType
928 private var as_nullable_cache
: nullable MType = null
931 # The depth of the type seen as a tree.
938 # Formal types have a depth of 1.
944 # The length of the type seen as a tree.
951 # Formal types have a length of 1.
957 # Compute all the classdefs inherited/imported.
958 # The returned set contains:
959 # * the class definitions from `mmodule` and its imported modules
960 # * the class definitions of this type and its super-types
962 # This function is used mainly internally.
964 # REQUIRE: `not self.need_anchor`
965 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
967 # Compute all the super-classes.
968 # This function is used mainly internally.
970 # REQUIRE: `not self.need_anchor`
971 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
973 # Compute all the declared super-types.
974 # Super-types are returned as declared in the classdefs (verbatim).
975 # This function is used mainly internally.
977 # REQUIRE: `not self.need_anchor`
978 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
980 # Is the property in self for a given module
981 # This method does not filter visibility or whatever
983 # REQUIRE: `not self.need_anchor`
984 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
986 assert not self.need_anchor
987 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
991 # A type based on a class.
993 # `MClassType` have properties (see `has_mproperty`).
997 # The associated class
1000 redef fun model
do return self.mclass
.intro_mmodule
.model
1002 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1004 # The formal arguments of the type
1005 # ENSURE: `result.length == self.mclass.arity`
1006 var arguments
= new Array[MType]
1008 redef fun to_s
do return mclass
.to_s
1010 redef fun need_anchor
do return false
1012 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1014 return super.as(MClassType)
1017 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1019 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1021 redef fun collect_mclassdefs
(mmodule
)
1023 assert not self.need_anchor
1024 var cache
= self.collect_mclassdefs_cache
1025 if not cache
.has_key
(mmodule
) then
1026 self.collect_things
(mmodule
)
1028 return cache
[mmodule
]
1031 redef fun collect_mclasses
(mmodule
)
1033 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1034 assert not self.need_anchor
1035 var cache
= self.collect_mclasses_cache
1036 if not cache
.has_key
(mmodule
) then
1037 self.collect_things
(mmodule
)
1039 var res
= cache
[mmodule
]
1040 collect_mclasses_last_module
= mmodule
1041 collect_mclasses_last_module_cache
= res
1045 private var collect_mclasses_last_module
: nullable MModule = null
1046 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1048 redef fun collect_mtypes
(mmodule
)
1050 assert not self.need_anchor
1051 var cache
= self.collect_mtypes_cache
1052 if not cache
.has_key
(mmodule
) then
1053 self.collect_things
(mmodule
)
1055 return cache
[mmodule
]
1058 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1059 private fun collect_things
(mmodule
: MModule)
1061 var res
= new HashSet[MClassDef]
1062 var seen
= new HashSet[MClass]
1063 var types
= new HashSet[MClassType]
1064 seen
.add
(self.mclass
)
1065 var todo
= [self.mclass
]
1066 while not todo
.is_empty
do
1067 var mclass
= todo
.pop
1068 #print "process {mclass}"
1069 for mclassdef
in mclass
.mclassdefs
do
1070 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1071 #print " process {mclassdef}"
1073 for supertype
in mclassdef
.supertypes
do
1074 types
.add
(supertype
)
1075 var superclass
= supertype
.mclass
1076 if seen
.has
(superclass
) then continue
1077 #print " add {superclass}"
1078 seen
.add
(superclass
)
1079 todo
.add
(superclass
)
1083 collect_mclassdefs_cache
[mmodule
] = res
1084 collect_mclasses_cache
[mmodule
] = seen
1085 collect_mtypes_cache
[mmodule
] = types
1088 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1089 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1090 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1094 # A type based on a generic class.
1095 # A generic type a just a class with additional formal generic arguments.
1101 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1105 assert self.mclass
.arity
== arguments
.length
1107 self.need_anchor
= false
1108 for t
in arguments
do
1109 if t
.need_anchor
then
1110 self.need_anchor
= true
1115 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1118 # Recursively print the type of the arguments within brackets.
1119 # Example: `"Map[String, List[Int]]"`
1120 redef var to_s
: String is noinit
1122 redef var need_anchor
: Bool is noinit
1124 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1126 if not need_anchor
then return self
1127 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1128 var types
= new Array[MType]
1129 for t
in arguments
do
1130 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1132 return mclass
.get_mtype
(types
)
1135 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1137 if not need_anchor
then return true
1138 for t
in arguments
do
1139 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1148 for a
in self.arguments
do
1150 if d
> dmax
then dmax
= d
1158 for a
in self.arguments
do
1165 # A virtual formal type.
1169 # The property associated with the type.
1170 # Its the definitions of this property that determine the bound or the virtual type.
1171 var mproperty
: MProperty
1173 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1175 # Lookup the bound for a given resolved_receiver
1176 # The result may be a other virtual type (or a parameter type)
1178 # The result is returned exactly as declared in the "type" property (verbatim).
1180 # In case of conflict, the method aborts.
1181 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1183 assert not resolved_receiver
.need_anchor
1184 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1185 if props
.is_empty
then
1187 else if props
.length
== 1 then
1188 return props
.first
.as(MVirtualTypeDef).bound
.as(not null)
1190 var types
= new ArraySet[MType]
1192 types
.add
(p
.as(MVirtualTypeDef).bound
.as(not null))
1194 if types
.length
== 1 then
1200 # Is the virtual type fixed for a given resolved_receiver?
1201 fun is_fixed
(mmodule
: MModule, resolved_receiver
: MType): Bool
1203 assert not resolved_receiver
.need_anchor
1204 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1205 if props
.is_empty
then
1209 if p
.as(MVirtualTypeDef).is_fixed
then return true
1214 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1216 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1217 # self is a virtual type declared (or inherited) in mtype
1218 # The point of the function it to get the bound of the virtual type that make sense for mtype
1219 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1220 #print "{class_name}: {self}/{mtype}/{anchor}?"
1221 var resolved_reciever
1222 if mtype
.need_anchor
then
1223 assert anchor
!= null
1224 resolved_reciever
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1226 resolved_reciever
= mtype
1228 # Now, we can get the bound
1229 var verbatim_bound
= lookup_bound
(mmodule
, resolved_reciever
)
1230 # The bound is exactly as declared in the "type" property, so we must resolve it again
1231 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1232 #print "{class_name}: {self}/{mtype}/{anchor} -> {self}/{resolved_receiver}/{anchor} -> {verbatim_bound}/{mtype}/{anchor} -> {res}"
1234 # What to return here? There is a bunch a special cases:
1235 # If 'cleanup_virtual' we must return the resolved type, since we cannot return self
1236 if cleanup_virtual
then return res
1237 # If the receiver is a intern class, then the virtual type cannot be redefined since there is no possible subclass. self is just fixed. so simply return the resolution
1238 if resolved_reciever
isa MNullableType then resolved_reciever
= resolved_reciever
.mtype
1239 if resolved_reciever
.as(MClassType).mclass
.kind
== enum_kind
then return res
1240 # If the resolved type isa MVirtualType, it means that self was bound to it, and cannot be unbound. self is just fixed. so return the resolution.
1241 if res
isa MVirtualType then return res
1242 # If we are final, just return the resolution
1243 if is_fixed
(mmodule
, resolved_reciever
) then return res
1244 # If the resolved type isa intern class, then there is no possible valid redefinition in any potential subclass. self is just fixed. so simply return the resolution
1245 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1246 # TODO: What if bound to a MParameterType?
1247 # Note that Nullable types can always be redefined by the non nullable version, so there is no specific case on it.
1249 # If anything apply, then `self' cannot be resolved, so return self
1253 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1255 if mtype
.need_anchor
then
1256 assert anchor
!= null
1257 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1259 return mtype
.has_mproperty
(mmodule
, mproperty
)
1262 redef fun to_s
do return self.mproperty
.to_s
1265 # The type associated to a formal parameter generic type of a class
1267 # Each parameter type is associated to a specific class.
1268 # It means that all refinements of a same class "share" the parameter type,
1269 # but that a generic subclass has its own parameter types.
1271 # However, in the sense of the meta-model, a parameter type of a class is
1272 # a valid type in a subclass. The "in the sense of the meta-model" is
1273 # important because, in the Nit language, the programmer cannot refers
1274 # directly to the parameter types of the super-classes.
1279 # fun e: E is abstract
1285 # In the class definition B[F], `F` is a valid type but `E` is not.
1286 # However, `self.e` is a valid method call, and the signature of `e` is
1289 # Note that parameter types are shared among class refinements.
1290 # Therefore parameter only have an internal name (see `to_s` for details).
1291 class MParameterType
1294 # The generic class where the parameter belong
1297 redef fun model
do return self.mclass
.intro_mmodule
.model
1299 # The position of the parameter (0 for the first parameter)
1300 # FIXME: is `position` a better name?
1305 redef fun to_s
do return name
1307 # Resolve the bound for a given resolved_receiver
1308 # The result may be a other virtual type (or a parameter type)
1309 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1311 assert not resolved_receiver
.need_anchor
1312 var goalclass
= self.mclass
1313 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1314 for t
in supertypes
do
1315 if t
.mclass
== goalclass
then
1316 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1317 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1318 var res
= t
.arguments
[self.rank
]
1325 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1327 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1328 #print "{class_name}: {self}/{mtype}/{anchor}?"
1330 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1331 var res
= mtype
.arguments
[self.rank
]
1332 if anchor
!= null and res
.need_anchor
then
1333 # Maybe the result can be resolved more if are bound to a final class
1334 var r2
= res
.anchor_to
(mmodule
, anchor
)
1335 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1340 # self is a parameter type of mtype (or of a super-class of mtype)
1341 # The point of the function it to get the bound of the virtual type that make sense for mtype
1342 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1343 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1344 var resolved_receiver
1345 if mtype
.need_anchor
then
1346 assert anchor
!= null
1347 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1349 resolved_receiver
= mtype
1351 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1352 if resolved_receiver
isa MParameterType then
1353 assert resolved_receiver
.mclass
== anchor
.mclass
1354 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1355 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1357 assert resolved_receiver
isa MClassType
1359 # Eh! The parameter is in the current class.
1360 # So we return the corresponding argument, no mater what!
1361 if resolved_receiver
.mclass
== self.mclass
then
1362 var res
= resolved_receiver
.arguments
[self.rank
]
1363 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1367 if resolved_receiver
.need_anchor
then
1368 assert anchor
!= null
1369 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1371 # Now, we can get the bound
1372 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1373 # The bound is exactly as declared in the "type" property, so we must resolve it again
1374 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1376 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1381 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1383 if mtype
.need_anchor
then
1384 assert anchor
!= null
1385 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1387 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1391 # A type prefixed with "nullable"
1395 # The base type of the nullable type
1398 redef fun model
do return self.mtype
.model
1402 self.to_s
= "nullable {mtype}"
1405 redef var to_s
: String is noinit
1407 redef fun need_anchor
do return mtype
.need_anchor
1408 redef fun as_nullable
do return self
1409 redef fun as_notnullable
do return mtype
1410 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1412 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1413 return res
.as_nullable
1416 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1418 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1421 redef fun depth
do return self.mtype
.depth
1423 redef fun length
do return self.mtype
.length
1425 redef fun collect_mclassdefs
(mmodule
)
1427 assert not self.need_anchor
1428 return self.mtype
.collect_mclassdefs
(mmodule
)
1431 redef fun collect_mclasses
(mmodule
)
1433 assert not self.need_anchor
1434 return self.mtype
.collect_mclasses
(mmodule
)
1437 redef fun collect_mtypes
(mmodule
)
1439 assert not self.need_anchor
1440 return self.mtype
.collect_mtypes
(mmodule
)
1444 # The type of the only value null
1446 # The is only one null type per model, see `MModel::null_type`.
1449 redef var model
: Model
1450 redef fun to_s
do return "null"
1451 redef fun as_nullable
do return self
1452 redef fun need_anchor
do return false
1453 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1454 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1456 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1458 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1460 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1463 # A signature of a method
1467 # The each parameter (in order)
1468 var mparameters
: Array[MParameter]
1470 # The return type (null for a procedure)
1471 var return_mtype
: nullable MType
1476 var t
= self.return_mtype
1477 if t
!= null then dmax
= t
.depth
1478 for p
in mparameters
do
1479 var d
= p
.mtype
.depth
1480 if d
> dmax
then dmax
= d
1488 var t
= self.return_mtype
1489 if t
!= null then res
+= t
.length
1490 for p
in mparameters
do
1491 res
+= p
.mtype
.length
1496 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1499 var vararg_rank
= -1
1500 for i
in [0..mparameters
.length
[ do
1501 var parameter
= mparameters
[i
]
1502 if parameter
.is_vararg
then
1503 assert vararg_rank
== -1
1507 self.vararg_rank
= vararg_rank
1510 # The rank of the ellipsis (`...`) for vararg (starting from 0).
1511 # value is -1 if there is no vararg.
1512 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1513 var vararg_rank
: Int is noinit
1515 # The number or parameters
1516 fun arity
: Int do return mparameters
.length
1520 var b
= new FlatBuffer
1521 if not mparameters
.is_empty
then
1523 for i
in [0..mparameters
.length
[ do
1524 var mparameter
= mparameters
[i
]
1525 if i
> 0 then b
.append
(", ")
1526 b
.append
(mparameter
.name
)
1528 b
.append
(mparameter
.mtype
.to_s
)
1529 if mparameter
.is_vararg
then
1535 var ret
= self.return_mtype
1543 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1545 var params
= new Array[MParameter]
1546 for p
in self.mparameters
do
1547 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1549 var ret
= self.return_mtype
1551 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1553 var res
= new MSignature(params
, ret
)
1558 # A parameter in a signature
1562 # The name of the parameter
1563 redef var name
: String
1565 # The static type of the parameter
1568 # Is the parameter a vararg?
1574 return "{name}: {mtype}..."
1576 return "{name}: {mtype}"
1580 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1582 if not self.mtype
.need_anchor
then return self
1583 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1584 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1588 redef fun model
do return mtype
.model
1591 # A service (global property) that generalize method, attribute, etc.
1593 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1594 # to a specific `MModule` nor a specific `MClass`.
1596 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1597 # and the other in subclasses and in refinements.
1599 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1600 # of any dynamic type).
1601 # For instance, a call site "x.foo" is associated to a `MProperty`.
1602 abstract class MProperty
1605 # The associated MPropDef subclass.
1606 # The two specialization hierarchy are symmetric.
1607 type MPROPDEF: MPropDef
1609 # The classdef that introduce the property
1610 # While a property is not bound to a specific module, or class,
1611 # the introducing mclassdef is used for naming and visibility
1612 var intro_mclassdef
: MClassDef
1614 # The (short) name of the property
1615 redef var name
: String
1617 # The canonical name of the property
1618 # Example: "owner::my_module::MyClass::my_method"
1619 fun full_name
: String
1621 return "{self.intro_mclassdef.mmodule.full_name}::{self.intro_mclassdef.mclass.name}::{name}"
1624 # The visibility of the property
1625 var visibility
: MVisibility
1629 intro_mclassdef
.intro_mproperties
.add
(self)
1630 var model
= intro_mclassdef
.mmodule
.model
1631 model
.mproperties_by_name
.add_one
(name
, self)
1632 model
.mproperties
.add
(self)
1635 # All definitions of the property.
1636 # The first is the introduction,
1637 # The other are redefinitions (in refinements and in subclasses)
1638 var mpropdefs
= new Array[MPROPDEF]
1640 # The definition that introduces the property.
1642 # Warning: such a definition may not exist in the early life of the object.
1643 # In this case, the method will abort.
1644 var intro
: MPROPDEF is noinit
1646 redef fun model
do return intro
.model
1649 redef fun to_s
do return name
1651 # Return the most specific property definitions defined or inherited by a type.
1652 # The selection knows that refinement is stronger than specialization;
1653 # however, in case of conflict more than one property are returned.
1654 # If mtype does not know mproperty then an empty array is returned.
1656 # If you want the really most specific property, then look at `lookup_first_definition`
1657 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1659 assert not mtype
.need_anchor
1660 mtype
= mtype
.as_notnullable
1662 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1663 if cache
!= null then return cache
1665 #print "select prop {mproperty} for {mtype} in {self}"
1666 # First, select all candidates
1667 var candidates
= new Array[MPROPDEF]
1668 for mpropdef
in self.mpropdefs
do
1669 # If the definition is not imported by the module, then skip
1670 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1671 # If the definition is not inherited by the type, then skip
1672 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1674 candidates
.add
(mpropdef
)
1676 # Fast track for only one candidate
1677 if candidates
.length
<= 1 then
1678 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1682 # Second, filter the most specific ones
1683 return select_most_specific
(mmodule
, candidates
)
1686 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1688 # Return the most specific property definitions inherited by a type.
1689 # The selection knows that refinement is stronger than specialization;
1690 # however, in case of conflict more than one property are returned.
1691 # If mtype does not know mproperty then an empty array is returned.
1693 # If you want the really most specific property, then look at `lookup_next_definition`
1695 # FIXME: Move to `MPropDef`?
1696 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1698 assert not mtype
.need_anchor
1699 mtype
= mtype
.as_notnullable
1701 # First, select all candidates
1702 var candidates
= new Array[MPROPDEF]
1703 for mpropdef
in self.mpropdefs
do
1704 # If the definition is not imported by the module, then skip
1705 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1706 # If the definition is not inherited by the type, then skip
1707 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1708 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1709 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1711 candidates
.add
(mpropdef
)
1713 # Fast track for only one candidate
1714 if candidates
.length
<= 1 then return candidates
1716 # Second, filter the most specific ones
1717 return select_most_specific
(mmodule
, candidates
)
1720 # Return an array containing olny the most specific property definitions
1721 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
1722 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
1724 var res
= new Array[MPROPDEF]
1725 for pd1
in candidates
do
1726 var cd1
= pd1
.mclassdef
1729 for pd2
in candidates
do
1730 if pd2
== pd1
then continue # do not compare with self!
1731 var cd2
= pd2
.mclassdef
1733 if c2
.mclass_type
== c1
.mclass_type
then
1734 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
1735 # cd2 refines cd1; therefore we skip pd1
1739 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
1740 # cd2 < cd1; therefore we skip pd1
1749 if res
.is_empty
then
1750 print
"All lost! {candidates.join(", ")}"
1751 # FIXME: should be abort!
1756 # Return the most specific definition in the linearization of `mtype`.
1758 # If you want to know the next properties in the linearization,
1759 # look at `MPropDef::lookup_next_definition`.
1761 # FIXME: the linearization is still unspecified
1763 # REQUIRE: `not mtype.need_anchor`
1764 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1765 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1767 assert mtype
.has_mproperty
(mmodule
, self)
1768 return lookup_all_definitions
(mmodule
, mtype
).first
1771 # Return all definitions in a linearization order
1772 # Most specific first, most general last
1773 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1775 assert not mtype
.need_anchor
1776 mtype
= mtype
.as_notnullable
1778 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1779 if cache
!= null then return cache
1781 #print "select prop {mproperty} for {mtype} in {self}"
1782 # First, select all candidates
1783 var candidates
= new Array[MPROPDEF]
1784 for mpropdef
in self.mpropdefs
do
1785 # If the definition is not imported by the module, then skip
1786 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1787 # If the definition is not inherited by the type, then skip
1788 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1790 candidates
.add
(mpropdef
)
1792 # Fast track for only one candidate
1793 if candidates
.length
<= 1 then
1794 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1798 mmodule
.linearize_mpropdefs
(candidates
)
1799 candidates
= candidates
.reversed
1800 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1804 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1811 redef type MPROPDEF: MMethodDef
1813 # Is the property defined at the top_level of the module?
1814 # Currently such a property are stored in `Object`
1815 var is_toplevel
: Bool = false is writable
1817 # Is the property a constructor?
1818 # Warning, this property can be inherited by subclasses with or without being a constructor
1819 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
1820 var is_init
: Bool = false is writable
1822 # The constructor is a (the) root init with empty signature but a set of initializers
1823 var is_root_init
: Bool = false is writable
1825 # Is the property a 'new' constructor?
1826 var is_new
: Bool = false is writable
1828 # Is the property a legal constructor for a given class?
1829 # As usual, visibility is not considered.
1830 # FIXME not implemented
1831 fun is_init_for
(mclass
: MClass): Bool
1837 # A global attribute
1841 redef type MPROPDEF: MAttributeDef
1845 # A global virtual type
1846 class MVirtualTypeProp
1849 redef type MPROPDEF: MVirtualTypeDef
1851 # The formal type associated to the virtual type property
1852 var mvirtualtype
= new MVirtualType(self)
1855 # A definition of a property (local property)
1857 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
1858 # specific class definition (which belong to a specific module)
1859 abstract class MPropDef
1862 # The associated `MProperty` subclass.
1863 # the two specialization hierarchy are symmetric
1864 type MPROPERTY: MProperty
1867 type MPROPDEF: MPropDef
1869 # The class definition where the property definition is
1870 var mclassdef
: MClassDef
1872 # The associated global property
1873 var mproperty
: MPROPERTY
1875 # The origin of the definition
1876 var location
: Location
1880 mclassdef
.mpropdefs
.add
(self)
1881 mproperty
.mpropdefs
.add
(self)
1882 if mproperty
.intro_mclassdef
== mclassdef
then
1883 assert not isset mproperty
._intro
1884 mproperty
.intro
= self
1886 self.to_s
= "{mclassdef}#{mproperty}"
1889 # Actually the name of the `mproperty`
1890 redef fun name
do return mproperty
.name
1892 redef fun model
do return mclassdef
.model
1894 # Internal name combining the module, the class and the property
1895 # Example: "mymodule#MyClass#mymethod"
1896 redef var to_s
: String is noinit
1898 # Is self the definition that introduce the property?
1899 fun is_intro
: Bool do return mproperty
.intro
== self
1901 # Return the next definition in linearization of `mtype`.
1903 # This method is used to determine what method is called by a super.
1905 # REQUIRE: `not mtype.need_anchor`
1906 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1908 assert not mtype
.need_anchor
1910 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
1911 var i
= mpropdefs
.iterator
1912 while i
.is_ok
and i
.item
!= self do i
.next
1913 assert has_property
: i
.is_ok
1915 assert has_next_property
: i
.is_ok
1920 # A local definition of a method
1924 redef type MPROPERTY: MMethod
1925 redef type MPROPDEF: MMethodDef
1927 # The signature attached to the property definition
1928 var msignature
: nullable MSignature = null is writable
1930 # The signature attached to the `new` call on a root-init
1931 # This is a concatenation of the signatures of the initializers
1933 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
1934 var new_msignature
: nullable MSignature = null is writable
1936 # List of initialisers to call in root-inits
1938 # They could be setters or attributes
1940 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
1941 var initializers
= new Array[MProperty]
1943 # Is the method definition abstract?
1944 var is_abstract
: Bool = false is writable
1946 # Is the method definition intern?
1947 var is_intern
= false is writable
1949 # Is the method definition extern?
1950 var is_extern
= false is writable
1952 # An optional constant value returned in functions.
1954 # Only some specific primitife value are accepted by engines.
1955 # Is used when there is no better implementation available.
1957 # Currently used only for the implementation of the `--define`
1958 # command-line option.
1959 # SEE: module `mixin`.
1960 var constant_value
: nullable Object = null is writable
1963 # A local definition of an attribute
1967 redef type MPROPERTY: MAttribute
1968 redef type MPROPDEF: MAttributeDef
1970 # The static type of the attribute
1971 var static_mtype
: nullable MType = null is writable
1974 # A local definition of a virtual type
1975 class MVirtualTypeDef
1978 redef type MPROPERTY: MVirtualTypeProp
1979 redef type MPROPDEF: MVirtualTypeDef
1981 # The bound of the virtual type
1982 var bound
: nullable MType = null is writable
1984 # Is the bound fixed?
1985 var is_fixed
= false is writable
1992 # * `interface_kind`
1996 # Note this class is basically an enum.
1997 # FIXME: use a real enum once user-defined enums are available
1999 redef var to_s
: String
2001 # Is a constructor required?
2004 # TODO: private init because enumeration.
2006 # Can a class of kind `self` specializes a class of kine `other`?
2007 fun can_specialize
(other
: MClassKind): Bool
2009 if other
== interface_kind
then return true # everybody can specialize interfaces
2010 if self == interface_kind
or self == enum_kind
then
2011 # no other case for interfaces
2013 else if self == extern_kind
then
2014 # only compatible with themselves
2015 return self == other
2016 else if other
== enum_kind
or other
== extern_kind
then
2017 # abstract_kind and concrete_kind are incompatible
2020 # remain only abstract_kind and concrete_kind
2025 # The class kind `abstract`
2026 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2027 # The class kind `concrete`
2028 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2029 # The class kind `interface`
2030 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2031 # The class kind `enum`
2032 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2033 # The class kind `extern`
2034 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)