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 return mclasses_by_name
.get_or_null
(name
)
80 # Collections of properties grouped by their short name
81 private var mproperties_by_name
= new MultiHashMap[String, MProperty]
83 # Return all properties named `name`.
85 # If such a property does not exist, null is returned
86 # (instead of an empty array)
88 # Visibility or modules are not considered
89 fun get_mproperties_by_name
(name
: String): nullable Array[MProperty]
91 return mproperties_by_name
.get_or_null
(name
)
95 var null_type
= new MNullType(self)
97 # Build an ordered tree with from `concerns`
98 fun concerns_tree
(mconcerns
: Collection[MConcern]): ConcernsTree do
99 var seen
= new HashSet[MConcern]
100 var res
= new ConcernsTree
102 var todo
= new Array[MConcern]
103 todo
.add_all mconcerns
105 while not todo
.is_empty
do
107 if seen
.has
(c
) then continue
108 var pc
= c
.parent_concern
122 # An OrderedTree that can be easily refined for display purposes
124 super OrderedTree[MConcern]
128 # All the classes introduced in the module
129 var intro_mclasses
= new Array[MClass]
131 # All the class definitions of the module
132 # (introduction and refinement)
133 var mclassdefs
= new Array[MClassDef]
135 # Does the current module has a given class `mclass`?
136 # Return true if the mmodule introduces, refines or imports a class.
137 # Visibility is not considered.
138 fun has_mclass
(mclass
: MClass): Bool
140 return self.in_importation
<= mclass
.intro_mmodule
143 # Full hierarchy of introduced ans imported classes.
145 # Create a new hierarchy got by flattening the classes for the module
146 # and its imported modules.
147 # Visibility is not considered.
149 # Note: this function is expensive and is usually used for the main
150 # module of a program only. Do not use it to do you own subtype
152 fun flatten_mclass_hierarchy
: POSet[MClass]
154 var res
= self.flatten_mclass_hierarchy_cache
155 if res
!= null then return res
156 res
= new POSet[MClass]
157 for m
in self.in_importation
.greaters
do
158 for cd
in m
.mclassdefs
do
161 for s
in cd
.supertypes
do
162 res
.add_edge
(c
, s
.mclass
)
166 self.flatten_mclass_hierarchy_cache
= res
170 # Sort a given array of classes using the linearization order of the module
171 # The most general is first, the most specific is last
172 fun linearize_mclasses
(mclasses
: Array[MClass])
174 self.flatten_mclass_hierarchy
.sort
(mclasses
)
177 # Sort a given array of class definitions using the linearization order of the module
178 # the refinement link is stronger than the specialisation link
179 # The most general is first, the most specific is last
180 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
182 var sorter
= new MClassDefSorter(self)
183 sorter
.sort
(mclassdefs
)
186 # Sort a given array of property definitions using the linearization order of the module
187 # the refinement link is stronger than the specialisation link
188 # The most general is first, the most specific is last
189 fun linearize_mpropdefs
(mpropdefs
: Array[MPropDef])
191 var sorter
= new MPropDefSorter(self)
192 sorter
.sort
(mpropdefs
)
195 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
197 # The primitive type `Object`, the root of the class hierarchy
198 fun object_type
: MClassType
200 var res
= self.object_type_cache
201 if res
!= null then return res
202 res
= self.get_primitive_class
("Object").mclass_type
203 self.object_type_cache
= res
207 private var object_type_cache
: nullable MClassType
209 # The type `Pointer`, super class to all extern classes
210 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
212 # The primitive type `Bool`
213 fun bool_type
: MClassType
215 var res
= self.bool_type_cache
216 if res
!= null then return res
217 res
= self.get_primitive_class
("Bool").mclass_type
218 self.bool_type_cache
= res
222 private var bool_type_cache
: nullable MClassType
224 # The primitive type `Sys`, the main type of the program, if any
225 fun sys_type
: nullable MClassType
227 var clas
= self.model
.get_mclasses_by_name
("Sys")
228 if clas
== null then return null
229 return get_primitive_class
("Sys").mclass_type
232 # The primitive type `Finalizable`
233 # Used to tag classes that need to be finalized.
234 fun finalizable_type
: nullable MClassType
236 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
237 if clas
== null then return null
238 return get_primitive_class
("Finalizable").mclass_type
241 # Force to get the primitive class named `name` or abort
242 fun get_primitive_class
(name
: String): MClass
244 var cla
= self.model
.get_mclasses_by_name
(name
)
246 if name
== "Bool" and self.model
.get_mclasses_by_name
("Object") != null then
247 # Bool is injected because it is needed by engine to code the result
248 # of the implicit casts.
249 var c
= new MClass(self, name
, null, enum_kind
, public_visibility
)
250 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0))
251 cladef
.set_supertypes
([object_type
])
252 cladef
.add_in_hierarchy
255 print
("Fatal Error: no primitive class {name}")
258 if cla
.length
!= 1 then
259 var msg
= "Fatal Error: more than one primitive class {name}:"
260 for c
in cla
do msg
+= " {c.full_name}"
267 # Try to get the primitive method named `name` on the type `recv`
268 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
270 var props
= self.model
.get_mproperties_by_name
(name
)
271 if props
== null then return null
272 var res
: nullable MMethod = null
273 for mprop
in props
do
274 assert mprop
isa MMethod
275 var intro
= mprop
.intro_mclassdef
276 for mclassdef
in recv
.mclassdefs
do
277 if not self.in_importation
.greaters
.has
(mclassdef
.mmodule
) then continue
278 if not mclassdef
.in_hierarchy
.greaters
.has
(intro
) then continue
281 else if res
!= mprop
then
282 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
291 private class MClassDefSorter
293 redef type COMPARED: MClassDef
295 redef fun compare
(a
, b
)
299 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
300 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
304 private class MPropDefSorter
306 redef type COMPARED: MPropDef
308 redef fun compare
(pa
, pb
)
314 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
315 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
321 # `MClass` are global to the model; it means that a `MClass` is not bound to a
322 # specific `MModule`.
324 # This characteristic helps the reasoning about classes in a program since a
325 # single `MClass` object always denote the same class.
327 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
328 # These do not really have properties nor belong to a hierarchy since the property and the
329 # hierarchy of a class depends of the refinement in the modules.
331 # Most services on classes require the precision of a module, and no one can asks what are
332 # the super-classes of a class nor what are properties of a class without precising what is
333 # the module considered.
335 # For instance, during the typing of a source-file, the module considered is the module of the file.
336 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
337 # *is the method `foo` exists in the class `Bar` in the current module?*
339 # During some global analysis, the module considered may be the main module of the program.
343 # The module that introduce the class
344 # While classes are not bound to a specific module,
345 # the introducing module is used for naming an visibility
346 var intro_mmodule
: MModule
348 # The short name of the class
349 # In Nit, the name of a class cannot evolve in refinements
350 redef var name
: String
352 # The canonical name of the class
354 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
355 # Example: `"owner::module::MyClass"`
356 redef var full_name
is lazy
do
357 return "{self.intro_mmodule.namespace_for(visibility)}::{name}"
360 redef var c_name
is lazy
do
361 return "{intro_mmodule.c_namespace_for(visibility)}__{name.to_cmangle}"
364 # The number of generic formal parameters
365 # 0 if the class is not generic
366 var arity
: Int is noinit
368 # Each generic formal parameters in order.
369 # is empty if the class is not generic
370 var mparameters
= new Array[MParameterType]
372 # Initialize `mparameters` from their names.
373 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
376 if parameter_names
== null then
379 self.arity
= parameter_names
.length
382 # Create the formal parameter types
384 assert parameter_names
!= null
385 var mparametertypes
= new Array[MParameterType]
386 for i
in [0..arity
[ do
387 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
388 mparametertypes
.add
(mparametertype
)
390 self.mparameters
= mparametertypes
391 var mclass_type
= new MGenericType(self, mparametertypes
)
392 self.mclass_type
= mclass_type
393 self.get_mtype_cache
[mparametertypes
] = mclass_type
395 self.mclass_type
= new MClassType(self)
399 # The kind of the class (interface, abstract class, etc.)
400 # In Nit, the kind of a class cannot evolve in refinements
403 # The visibility of the class
404 # In Nit, the visibility of a class cannot evolve in refinements
405 var visibility
: MVisibility
409 intro_mmodule
.intro_mclasses
.add
(self)
410 var model
= intro_mmodule
.model
411 model
.mclasses_by_name
.add_one
(name
, self)
412 model
.mclasses
.add
(self)
415 redef fun model
do return intro_mmodule
.model
417 # All class definitions (introduction and refinements)
418 var mclassdefs
= new Array[MClassDef]
421 redef fun to_s
do return self.name
423 # The definition that introduces the class.
425 # Warning: such a definition may not exist in the early life of the object.
426 # In this case, the method will abort.
427 var intro
: MClassDef is noinit
429 # Return the class `self` in the class hierarchy of the module `mmodule`.
431 # SEE: `MModule::flatten_mclass_hierarchy`
432 # REQUIRE: `mmodule.has_mclass(self)`
433 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
435 return mmodule
.flatten_mclass_hierarchy
[self]
438 # The principal static type of the class.
440 # For non-generic class, mclass_type is the only `MClassType` based
443 # For a generic class, the arguments are the formal parameters.
444 # i.e.: for the class Array[E:Object], the `mclass_type` is Array[E].
445 # If you want Array[Object] the see `MClassDef::bound_mtype`
447 # For generic classes, the mclass_type is also the way to get a formal
448 # generic parameter type.
450 # To get other types based on a generic class, see `get_mtype`.
452 # ENSURE: `mclass_type.mclass == self`
453 var mclass_type
: MClassType is noinit
455 # Return a generic type based on the class
456 # Is the class is not generic, then the result is `mclass_type`
458 # REQUIRE: `mtype_arguments.length == self.arity`
459 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
461 assert mtype_arguments
.length
== self.arity
462 if self.arity
== 0 then return self.mclass_type
463 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
464 if res
!= null then return res
465 res
= new MGenericType(self, mtype_arguments
)
466 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
470 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
472 # Is there a `new` factory to allow the pseudo instantiation?
473 var has_new_factory
= false is writable
477 # A definition (an introduction or a refinement) of a class in a module
479 # A `MClassDef` is associated with an explicit (or almost) definition of a
480 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
481 # a specific class and a specific module, and contains declarations like super-classes
484 # It is the class definitions that are the backbone of most things in the model:
485 # ClassDefs are defined with regard with other classdefs.
486 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
488 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
492 # The module where the definition is
495 # The associated `MClass`
496 var mclass
: MClass is noinit
498 # The bounded type associated to the mclassdef
500 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
504 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
505 # If you want Array[E], then see `mclass.mclass_type`
507 # ENSURE: `bound_mtype.mclass == self.mclass`
508 var bound_mtype
: MClassType
510 # The origin of the definition
511 var location
: Location
513 # Internal name combining the module and the class
514 # Example: "mymodule#MyClass"
515 redef var to_s
: String is noinit
519 self.mclass
= bound_mtype
.mclass
520 mmodule
.mclassdefs
.add
(self)
521 mclass
.mclassdefs
.add
(self)
522 if mclass
.intro_mmodule
== mmodule
then
523 assert not isset mclass
._intro
526 self.to_s
= "{mmodule}#{mclass}"
529 # Actually the name of the `mclass`
530 redef fun name
do return mclass
.name
532 # The module and class name separated by a '#'.
534 # The short-name of the class is used for introduction.
535 # Example: "my_module#MyClass"
537 # The full-name of the class is used for refinement.
538 # Example: "my_module#intro_module::MyClass"
539 redef var full_name
is lazy
do
542 # private gives 'p::m#A'
543 return "{mmodule.namespace_for(mclass.visibility)}#{mclass.name}"
544 else if mclass
.intro_mmodule
.mproject
!= mmodule
.mproject
then
545 # public gives 'q::n#p::A'
546 # private gives 'q::n#p::m::A'
547 return "{mmodule.full_name}#{mclass.full_name}"
548 else if mclass
.visibility
> private_visibility
then
549 # public gives 'p::n#A'
550 return "{mmodule.full_name}#{mclass.name}"
552 # private gives 'p::n#::m::A' (redundant p is omitted)
553 return "{mmodule.full_name}#::{mclass.intro_mmodule.name}::{mclass.name}"
557 redef var c_name
is lazy
do
559 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
560 else if mclass
.intro_mmodule
.mproject
== mmodule
.mproject
and mclass
.visibility
> private_visibility
then
561 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
563 return "{mmodule.c_name}___{mclass.c_name}"
567 redef fun model
do return mmodule
.model
569 # All declared super-types
570 # FIXME: quite ugly but not better idea yet
571 var supertypes
= new Array[MClassType]
573 # Register some super-types for the class (ie "super SomeType")
575 # The hierarchy must not already be set
576 # REQUIRE: `self.in_hierarchy == null`
577 fun set_supertypes
(supertypes
: Array[MClassType])
579 assert unique_invocation
: self.in_hierarchy
== null
580 var mmodule
= self.mmodule
581 var model
= mmodule
.model
582 var mtype
= self.bound_mtype
584 for supertype
in supertypes
do
585 self.supertypes
.add
(supertype
)
587 # Register in full_type_specialization_hierarchy
588 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
589 # Register in intro_type_specialization_hierarchy
590 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
591 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
597 # Collect the super-types (set by set_supertypes) to build the hierarchy
599 # This function can only invoked once by class
600 # REQUIRE: `self.in_hierarchy == null`
601 # ENSURE: `self.in_hierarchy != null`
604 assert unique_invocation
: self.in_hierarchy
== null
605 var model
= mmodule
.model
606 var res
= model
.mclassdef_hierarchy
.add_node
(self)
607 self.in_hierarchy
= res
608 var mtype
= self.bound_mtype
610 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
611 # The simpliest way is to attach it to collect_mclassdefs
612 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
613 res
.poset
.add_edge
(self, mclassdef
)
617 # The view of the class definition in `mclassdef_hierarchy`
618 var in_hierarchy
: nullable POSetElement[MClassDef] = null
620 # Is the definition the one that introduced `mclass`?
621 fun is_intro
: Bool do return mclass
.intro
== self
623 # All properties introduced by the classdef
624 var intro_mproperties
= new Array[MProperty]
626 # All property definitions in the class (introductions and redefinitions)
627 var mpropdefs
= new Array[MPropDef]
630 # A global static type
632 # MType are global to the model; it means that a `MType` is not bound to a
633 # specific `MModule`.
634 # This characteristic helps the reasoning about static types in a program
635 # since a single `MType` object always denote the same type.
637 # However, because a `MType` is global, it does not really have properties
638 # nor have subtypes to a hierarchy since the property and the class hierarchy
639 # depends of a module.
640 # Moreover, virtual types an formal generic parameter types also depends on
641 # a receiver to have sense.
643 # Therefore, most method of the types require a module and an anchor.
644 # The module is used to know what are the classes and the specialization
646 # The anchor is used to know what is the bound of the virtual types and formal
647 # generic parameter types.
649 # MType are not directly usable to get properties. See the `anchor_to` method
650 # and the `MClassType` class.
652 # FIXME: the order of the parameters is not the best. We mus pick on from:
653 # * foo(mmodule, anchor, othertype)
654 # * foo(othertype, anchor, mmodule)
655 # * foo(anchor, mmodule, othertype)
656 # * foo(othertype, mmodule, anchor)
660 redef fun name
do return to_s
662 # Return true if `self` is an subtype of `sup`.
663 # The typing is done using the standard typing policy of Nit.
665 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
666 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
667 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
670 if sub
== sup
then return true
672 #print "1.is {sub} a {sup}? ===="
674 if anchor
== null then
675 assert not sub
.need_anchor
676 assert not sup
.need_anchor
678 # First, resolve the formal types to the simplest equivalent forms in the receiver
679 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
680 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
681 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
682 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
685 # Does `sup` accept null or not?
686 # Discard the nullable marker if it exists
687 var sup_accept_null
= false
688 if sup
isa MNullableType then
689 sup_accept_null
= true
691 else if sup
isa MNullType then
692 sup_accept_null
= true
695 # Can `sub` provide null or not?
696 # Thus we can match with `sup_accept_null`
697 # Also discard the nullable marker if it exists
698 if sub
isa MNullableType then
699 if not sup_accept_null
then return false
701 else if sub
isa MNullType then
702 return sup_accept_null
704 # Now the case of direct null and nullable is over.
706 # If `sub` is a formal type, then it is accepted if its bound is accepted
707 while sub
isa MParameterType or sub
isa MVirtualType do
708 #print "3.is {sub} a {sup}?"
710 # A unfixed formal type can only accept itself
711 if sub
== sup
then return true
713 assert anchor
!= null
714 sub
= sub
.lookup_bound
(mmodule
, anchor
)
716 #print "3.is {sub} a {sup}?"
718 # Manage the second layer of null/nullable
719 if sub
isa MNullableType then
720 if not sup_accept_null
then return false
722 else if sub
isa MNullType then
723 return sup_accept_null
726 #print "4.is {sub} a {sup}? <- no more resolution"
728 assert sub
isa MClassType # It is the only remaining type
730 # A unfixed formal type can only accept itself
731 if sup
isa MParameterType or sup
isa MVirtualType then
735 if sup
isa MNullType then
736 # `sup` accepts only null
740 assert sup
isa MClassType # It is the only remaining type
742 # Now both are MClassType, we need to dig
744 if sub
== sup
then return true
746 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
747 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
748 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
749 if res
== false then return false
750 if not sup
isa MGenericType then return true
751 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
752 assert sub2
.mclass
== sup
.mclass
753 for i
in [0..sup
.mclass
.arity
[ do
754 var sub_arg
= sub2
.arguments
[i
]
755 var sup_arg
= sup
.arguments
[i
]
756 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
757 if res
== false then return false
762 # The base class type on which self is based
764 # This base type is used to get property (an internally to perform
765 # unsafe type comparison).
767 # Beware: some types (like null) are not based on a class thus this
770 # Basically, this function transform the virtual types and parameter
771 # types to their bounds.
776 # class B super A end
778 # class Y super X end
787 # Map[T,U] anchor_to H #-> Map[B,Y]
789 # Explanation of the example:
790 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
791 # because "redef type U: Y". Therefore, Map[T, U] is bound to
794 # ENSURE: `not self.need_anchor implies result == self`
795 # ENSURE: `not result.need_anchor`
796 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
798 if not need_anchor
then return self
799 assert not anchor
.need_anchor
800 # Just resolve to the anchor and clear all the virtual types
801 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
802 assert not res
.need_anchor
806 # Does `self` contain a virtual type or a formal generic parameter type?
807 # In order to remove those types, you usually want to use `anchor_to`.
808 fun need_anchor
: Bool do return true
810 # Return the supertype when adapted to a class.
812 # In Nit, for each super-class of a type, there is a equivalent super-type.
818 # class H[V] super G[V, Bool] end
820 # H[Int] supertype_to G #-> G[Int, Bool]
823 # REQUIRE: `super_mclass` is a super-class of `self`
824 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
825 # ENSURE: `result.mclass = super_mclass`
826 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
828 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
829 if self isa MClassType and self.mclass
== super_mclass
then return self
831 if self.need_anchor
then
832 assert anchor
!= null
833 resolved_self
= self.anchor_to
(mmodule
, anchor
)
837 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
838 for supertype
in supertypes
do
839 if supertype
.mclass
== super_mclass
then
840 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
841 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
847 # Replace formals generic types in self with resolved values in `mtype`
848 # If `cleanup_virtual` is true, then virtual types are also replaced
851 # This function returns self if `need_anchor` is false.
857 # class H[F] super G[F] end
861 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
862 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
864 # Explanation of the example:
865 # * Array[E].need_anchor is true because there is a formal generic parameter type E
866 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
867 # * Since "H[F] super G[F]", E is in fact F for H
868 # * More specifically, in H[Int], E is Int
869 # * So, in H[Int], Array[E] is Array[Int]
871 # This function is mainly used to inherit a signature.
872 # Because, unlike `anchor_to`, we do not want a full resolution of
873 # a type but only an adapted version of it.
879 # fun foo(e:E):E is abstract
881 # class B super A[Int] end
884 # The signature on foo is (e: E): E
885 # If we resolve the signature for B, we get (e:Int):Int
891 # fun foo(e:E):E is abstract
895 # fun bar do a.foo(x) # <- x is here
899 # The first question is: is foo available on `a`?
901 # The static type of a is `A[Array[F]]`, that is an open type.
902 # in order to find a method `foo`, whe must look at a resolved type.
904 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
906 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
908 # The next question is: what is the accepted types for `x`?
910 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
912 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
914 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
916 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
917 # two function instead of one seems also to be a bad idea.
919 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
920 # ENSURE: `not self.need_anchor implies result == self`
921 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
923 # Resolve formal type to its verbatim bound.
924 # If the type is not formal, just return self
926 # The result is returned exactly as declared in the "type" property (verbatim).
927 # So it could be another formal type.
929 # In case of conflict, the method aborts.
930 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
932 # Resolve the formal type to its simplest equivalent form.
934 # Formal types are either free or fixed.
935 # When it is fixed, it means that it is equivalent with a simpler type.
936 # When a formal type is free, it means that it is only equivalent with itself.
937 # This method return the most simple equivalent type of `self`.
939 # This method is mainly used for subtype test in order to sanely compare fixed.
941 # By default, return self.
942 # See the redefinitions for specific behavior in each kind of type.
943 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
945 # Can the type be resolved?
947 # In order to resolve open types, the formal types must make sence.
957 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
959 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
961 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
962 # # B[E] is a red hearing only the E is important,
963 # # E make sense in A
966 # REQUIRE: `anchor != null implies not anchor.need_anchor`
967 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
968 # ENSURE: `not self.need_anchor implies result == true`
969 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
971 # Return the nullable version of the type
972 # If the type is already nullable then self is returned
973 fun as_nullable
: MType
975 var res
= self.as_nullable_cache
976 if res
!= null then return res
977 res
= new MNullableType(self)
978 self.as_nullable_cache
= res
982 # Return the not nullable version of the type
983 # Is the type is already not nullable, then self is returned.
985 # Note: this just remove the `nullable` notation, but the result can still contains null.
986 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
987 fun as_notnullable
: MType
992 private var as_nullable_cache
: nullable MType = null
995 # The depth of the type seen as a tree.
1002 # Formal types have a depth of 1.
1008 # The length of the type seen as a tree.
1015 # Formal types have a length of 1.
1021 # Compute all the classdefs inherited/imported.
1022 # The returned set contains:
1023 # * the class definitions from `mmodule` and its imported modules
1024 # * the class definitions of this type and its super-types
1026 # This function is used mainly internally.
1028 # REQUIRE: `not self.need_anchor`
1029 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1031 # Compute all the super-classes.
1032 # This function is used mainly internally.
1034 # REQUIRE: `not self.need_anchor`
1035 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1037 # Compute all the declared super-types.
1038 # Super-types are returned as declared in the classdefs (verbatim).
1039 # This function is used mainly internally.
1041 # REQUIRE: `not self.need_anchor`
1042 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1044 # Is the property in self for a given module
1045 # This method does not filter visibility or whatever
1047 # REQUIRE: `not self.need_anchor`
1048 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1050 assert not self.need_anchor
1051 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1055 # A type based on a class.
1057 # `MClassType` have properties (see `has_mproperty`).
1061 # The associated class
1064 redef fun model
do return self.mclass
.intro_mmodule
.model
1066 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1068 # The formal arguments of the type
1069 # ENSURE: `result.length == self.mclass.arity`
1070 var arguments
= new Array[MType]
1072 redef fun to_s
do return mclass
.to_s
1074 redef fun full_name
do return mclass
.full_name
1076 redef fun c_name
do return mclass
.c_name
1078 redef fun need_anchor
do return false
1080 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1082 return super.as(MClassType)
1085 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1087 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1089 redef fun collect_mclassdefs
(mmodule
)
1091 assert not self.need_anchor
1092 var cache
= self.collect_mclassdefs_cache
1093 if not cache
.has_key
(mmodule
) then
1094 self.collect_things
(mmodule
)
1096 return cache
[mmodule
]
1099 redef fun collect_mclasses
(mmodule
)
1101 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1102 assert not self.need_anchor
1103 var cache
= self.collect_mclasses_cache
1104 if not cache
.has_key
(mmodule
) then
1105 self.collect_things
(mmodule
)
1107 var res
= cache
[mmodule
]
1108 collect_mclasses_last_module
= mmodule
1109 collect_mclasses_last_module_cache
= res
1113 private var collect_mclasses_last_module
: nullable MModule = null
1114 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1116 redef fun collect_mtypes
(mmodule
)
1118 assert not self.need_anchor
1119 var cache
= self.collect_mtypes_cache
1120 if not cache
.has_key
(mmodule
) then
1121 self.collect_things
(mmodule
)
1123 return cache
[mmodule
]
1126 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1127 private fun collect_things
(mmodule
: MModule)
1129 var res
= new HashSet[MClassDef]
1130 var seen
= new HashSet[MClass]
1131 var types
= new HashSet[MClassType]
1132 seen
.add
(self.mclass
)
1133 var todo
= [self.mclass
]
1134 while not todo
.is_empty
do
1135 var mclass
= todo
.pop
1136 #print "process {mclass}"
1137 for mclassdef
in mclass
.mclassdefs
do
1138 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1139 #print " process {mclassdef}"
1141 for supertype
in mclassdef
.supertypes
do
1142 types
.add
(supertype
)
1143 var superclass
= supertype
.mclass
1144 if seen
.has
(superclass
) then continue
1145 #print " add {superclass}"
1146 seen
.add
(superclass
)
1147 todo
.add
(superclass
)
1151 collect_mclassdefs_cache
[mmodule
] = res
1152 collect_mclasses_cache
[mmodule
] = seen
1153 collect_mtypes_cache
[mmodule
] = types
1156 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1157 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1158 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1162 # A type based on a generic class.
1163 # A generic type a just a class with additional formal generic arguments.
1169 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1173 assert self.mclass
.arity
== arguments
.length
1175 self.need_anchor
= false
1176 for t
in arguments
do
1177 if t
.need_anchor
then
1178 self.need_anchor
= true
1183 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1186 # The short-name of the class, then the full-name of each type arguments within brackets.
1187 # Example: `"Map[String, List[Int]]"`
1188 redef var to_s
: String is noinit
1190 # The full-name of the class, then the full-name of each type arguments within brackets.
1191 # Example: `"standard::Map[standard::String, standard::List[standard::Int]]"`
1192 redef var full_name
is lazy
do
1193 var args
= new Array[String]
1194 for t
in arguments
do
1195 args
.add t
.full_name
1197 return "{mclass.full_name}[{args.join(", ")}]"
1200 redef var c_name
is lazy
do
1201 var res
= mclass
.c_name
1202 # Note: because the arity is known, a prefix notation is enough
1203 for t
in arguments
do
1210 redef var need_anchor
: Bool is noinit
1212 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1214 if not need_anchor
then return self
1215 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1216 var types
= new Array[MType]
1217 for t
in arguments
do
1218 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1220 return mclass
.get_mtype
(types
)
1223 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1225 if not need_anchor
then return true
1226 for t
in arguments
do
1227 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1236 for a
in self.arguments
do
1238 if d
> dmax
then dmax
= d
1246 for a
in self.arguments
do
1253 # A virtual formal type.
1257 # The property associated with the type.
1258 # Its the definitions of this property that determine the bound or the virtual type.
1259 var mproperty
: MVirtualTypeProp
1261 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1263 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1265 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
.as(not null)
1268 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1270 assert not resolved_receiver
.need_anchor
1271 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1272 if props
.is_empty
then
1274 else if props
.length
== 1 then
1277 var types
= new ArraySet[MType]
1278 var res
= props
.first
1280 types
.add
(p
.bound
.as(not null))
1281 if not res
.is_fixed
then res
= p
1283 if types
.length
== 1 then
1289 # A VT is fixed when:
1290 # * the VT is (re-)defined with the annotation `is fixed`
1291 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1292 # * the receiver is an enum class since there is no subtype possible
1293 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1295 assert not resolved_receiver
.need_anchor
1296 resolved_receiver
= resolved_receiver
.as_notnullable
1297 assert resolved_receiver
isa MClassType # It is the only remaining type
1299 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1300 var res
= prop
.bound
.as(not null)
1302 # Recursively lookup the fixed result
1303 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1305 # 1. For a fixed VT, return the resolved bound
1306 if prop
.is_fixed
then return res
1308 # 2. For a enum boud, return the bound
1309 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1311 # 3. for a enum receiver return the bound
1312 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1317 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1319 if not cleanup_virtual
then return self
1320 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1321 # self is a virtual type declared (or inherited) in mtype
1322 # The point of the function it to get the bound of the virtual type that make sense for mtype
1323 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1324 #print "{class_name}: {self}/{mtype}/{anchor}?"
1325 var resolved_receiver
1326 if mtype
.need_anchor
then
1327 assert anchor
!= null
1328 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1330 resolved_receiver
= mtype
1332 # Now, we can get the bound
1333 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1334 # The bound is exactly as declared in the "type" property, so we must resolve it again
1335 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1340 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1342 if mtype
.need_anchor
then
1343 assert anchor
!= null
1344 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1346 return mtype
.has_mproperty
(mmodule
, mproperty
)
1349 redef fun to_s
do return self.mproperty
.to_s
1351 redef fun full_name
do return self.mproperty
.full_name
1353 redef fun c_name
do return self.mproperty
.c_name
1356 # The type associated to a formal parameter generic type of a class
1358 # Each parameter type is associated to a specific class.
1359 # It means that all refinements of a same class "share" the parameter type,
1360 # but that a generic subclass has its own parameter types.
1362 # However, in the sense of the meta-model, a parameter type of a class is
1363 # a valid type in a subclass. The "in the sense of the meta-model" is
1364 # important because, in the Nit language, the programmer cannot refers
1365 # directly to the parameter types of the super-classes.
1370 # fun e: E is abstract
1376 # In the class definition B[F], `F` is a valid type but `E` is not.
1377 # However, `self.e` is a valid method call, and the signature of `e` is
1380 # Note that parameter types are shared among class refinements.
1381 # Therefore parameter only have an internal name (see `to_s` for details).
1382 class MParameterType
1385 # The generic class where the parameter belong
1388 redef fun model
do return self.mclass
.intro_mmodule
.model
1390 # The position of the parameter (0 for the first parameter)
1391 # FIXME: is `position` a better name?
1396 redef fun to_s
do return name
1398 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1400 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1402 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1404 assert not resolved_receiver
.need_anchor
1405 resolved_receiver
= resolved_receiver
.as_notnullable
1406 assert resolved_receiver
isa MClassType # It is the only remaining type
1407 var goalclass
= self.mclass
1408 if resolved_receiver
.mclass
== goalclass
then
1409 return resolved_receiver
.arguments
[self.rank
]
1411 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1412 for t
in supertypes
do
1413 if t
.mclass
== goalclass
then
1414 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1415 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1416 var res
= t
.arguments
[self.rank
]
1423 # A PT is fixed when:
1424 # * Its bound is a enum class (see `enum_kind`).
1425 # The PT is just useless, but it is still a case.
1426 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1427 # so it is necessarily fixed in a `super` clause, either with a normal type
1428 # or with another PT.
1429 # See `resolve_for` for examples about related issues.
1430 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1432 assert not resolved_receiver
.need_anchor
1433 resolved_receiver
= resolved_receiver
.as_notnullable
1434 assert resolved_receiver
isa MClassType # It is the only remaining type
1435 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1439 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1441 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1442 #print "{class_name}: {self}/{mtype}/{anchor}?"
1444 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1445 var res
= mtype
.arguments
[self.rank
]
1446 if anchor
!= null and res
.need_anchor
then
1447 # Maybe the result can be resolved more if are bound to a final class
1448 var r2
= res
.anchor_to
(mmodule
, anchor
)
1449 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1454 # self is a parameter type of mtype (or of a super-class of mtype)
1455 # The point of the function it to get the bound of the virtual type that make sense for mtype
1456 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1457 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1458 var resolved_receiver
1459 if mtype
.need_anchor
then
1460 assert anchor
!= null
1461 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1463 resolved_receiver
= mtype
1465 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1466 if resolved_receiver
isa MParameterType then
1467 assert resolved_receiver
.mclass
== anchor
.mclass
1468 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1469 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1471 assert resolved_receiver
isa MClassType # It is the only remaining type
1473 # Eh! The parameter is in the current class.
1474 # So we return the corresponding argument, no mater what!
1475 if resolved_receiver
.mclass
== self.mclass
then
1476 var res
= resolved_receiver
.arguments
[self.rank
]
1477 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1481 if resolved_receiver
.need_anchor
then
1482 assert anchor
!= null
1483 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1485 # Now, we can get the bound
1486 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1487 # The bound is exactly as declared in the "type" property, so we must resolve it again
1488 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1490 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1495 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1497 if mtype
.need_anchor
then
1498 assert anchor
!= null
1499 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1501 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1505 # A type prefixed with "nullable"
1509 # The base type of the nullable type
1512 redef fun model
do return self.mtype
.model
1516 self.to_s
= "nullable {mtype}"
1519 redef var to_s
: String is noinit
1521 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1523 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1525 redef fun need_anchor
do return mtype
.need_anchor
1526 redef fun as_nullable
do return self
1527 redef fun as_notnullable
do return mtype
1528 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1530 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1531 return res
.as_nullable
1534 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1536 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1539 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1540 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1542 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1543 if t
== mtype
then return self
1544 return t
.as_nullable
1547 redef fun depth
do return self.mtype
.depth
1549 redef fun length
do return self.mtype
.length
1551 redef fun collect_mclassdefs
(mmodule
)
1553 assert not self.need_anchor
1554 return self.mtype
.collect_mclassdefs
(mmodule
)
1557 redef fun collect_mclasses
(mmodule
)
1559 assert not self.need_anchor
1560 return self.mtype
.collect_mclasses
(mmodule
)
1563 redef fun collect_mtypes
(mmodule
)
1565 assert not self.need_anchor
1566 return self.mtype
.collect_mtypes
(mmodule
)
1570 # The type of the only value null
1572 # The is only one null type per model, see `MModel::null_type`.
1575 redef var model
: Model
1576 redef fun to_s
do return "null"
1577 redef fun full_name
do return "null"
1578 redef fun c_name
do return "null"
1579 redef fun as_nullable
do return self
1580 redef fun need_anchor
do return false
1581 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1582 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1584 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1586 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1588 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1591 # A signature of a method
1595 # The each parameter (in order)
1596 var mparameters
: Array[MParameter]
1598 # The return type (null for a procedure)
1599 var return_mtype
: nullable MType
1604 var t
= self.return_mtype
1605 if t
!= null then dmax
= t
.depth
1606 for p
in mparameters
do
1607 var d
= p
.mtype
.depth
1608 if d
> dmax
then dmax
= d
1616 var t
= self.return_mtype
1617 if t
!= null then res
+= t
.length
1618 for p
in mparameters
do
1619 res
+= p
.mtype
.length
1624 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1627 var vararg_rank
= -1
1628 for i
in [0..mparameters
.length
[ do
1629 var parameter
= mparameters
[i
]
1630 if parameter
.is_vararg
then
1631 assert vararg_rank
== -1
1635 self.vararg_rank
= vararg_rank
1638 # The rank of the ellipsis (`...`) for vararg (starting from 0).
1639 # value is -1 if there is no vararg.
1640 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1641 var vararg_rank
: Int is noinit
1643 # The number or parameters
1644 fun arity
: Int do return mparameters
.length
1648 var b
= new FlatBuffer
1649 if not mparameters
.is_empty
then
1651 for i
in [0..mparameters
.length
[ do
1652 var mparameter
= mparameters
[i
]
1653 if i
> 0 then b
.append
(", ")
1654 b
.append
(mparameter
.name
)
1656 b
.append
(mparameter
.mtype
.to_s
)
1657 if mparameter
.is_vararg
then
1663 var ret
= self.return_mtype
1671 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1673 var params
= new Array[MParameter]
1674 for p
in self.mparameters
do
1675 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1677 var ret
= self.return_mtype
1679 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1681 var res
= new MSignature(params
, ret
)
1686 # A parameter in a signature
1690 # The name of the parameter
1691 redef var name
: String
1693 # The static type of the parameter
1696 # Is the parameter a vararg?
1702 return "{name}: {mtype}..."
1704 return "{name}: {mtype}"
1708 # Returns a new parameter with the `mtype` resolved.
1709 # See `MType::resolve_for` for details.
1710 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1712 if not self.mtype
.need_anchor
then return self
1713 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1714 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1718 redef fun model
do return mtype
.model
1721 # A service (global property) that generalize method, attribute, etc.
1723 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1724 # to a specific `MModule` nor a specific `MClass`.
1726 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1727 # and the other in subclasses and in refinements.
1729 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1730 # of any dynamic type).
1731 # For instance, a call site "x.foo" is associated to a `MProperty`.
1732 abstract class MProperty
1735 # The associated MPropDef subclass.
1736 # The two specialization hierarchy are symmetric.
1737 type MPROPDEF: MPropDef
1739 # The classdef that introduce the property
1740 # While a property is not bound to a specific module, or class,
1741 # the introducing mclassdef is used for naming and visibility
1742 var intro_mclassdef
: MClassDef
1744 # The (short) name of the property
1745 redef var name
: String
1747 # The canonical name of the property.
1749 # It is the short-`name` prefixed by the short-name of the class and the full-name of the module.
1750 # Example: "my_project::my_module::MyClass::my_method"
1751 redef var full_name
is lazy
do
1752 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
1755 redef var c_name
is lazy
do
1756 # FIXME use `namespace_for`
1757 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
1760 # The visibility of the property
1761 var visibility
: MVisibility
1763 # Is the property usable as an initializer?
1764 var is_autoinit
= false is writable
1768 intro_mclassdef
.intro_mproperties
.add
(self)
1769 var model
= intro_mclassdef
.mmodule
.model
1770 model
.mproperties_by_name
.add_one
(name
, self)
1771 model
.mproperties
.add
(self)
1774 # All definitions of the property.
1775 # The first is the introduction,
1776 # The other are redefinitions (in refinements and in subclasses)
1777 var mpropdefs
= new Array[MPROPDEF]
1779 # The definition that introduces the property.
1781 # Warning: such a definition may not exist in the early life of the object.
1782 # In this case, the method will abort.
1783 var intro
: MPROPDEF is noinit
1785 redef fun model
do return intro
.model
1788 redef fun to_s
do return name
1790 # Return the most specific property definitions defined or inherited by a type.
1791 # The selection knows that refinement is stronger than specialization;
1792 # however, in case of conflict more than one property are returned.
1793 # If mtype does not know mproperty then an empty array is returned.
1795 # If you want the really most specific property, then look at `lookup_first_definition`
1797 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1798 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
1799 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1801 assert not mtype
.need_anchor
1802 mtype
= mtype
.as_notnullable
1804 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1805 if cache
!= null then return cache
1807 #print "select prop {mproperty} for {mtype} in {self}"
1808 # First, select all candidates
1809 var candidates
= new Array[MPROPDEF]
1810 for mpropdef
in self.mpropdefs
do
1811 # If the definition is not imported by the module, then skip
1812 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1813 # If the definition is not inherited by the type, then skip
1814 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1816 candidates
.add
(mpropdef
)
1818 # Fast track for only one candidate
1819 if candidates
.length
<= 1 then
1820 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1824 # Second, filter the most specific ones
1825 return select_most_specific
(mmodule
, candidates
)
1828 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1830 # Return the most specific property definitions inherited by a type.
1831 # The selection knows that refinement is stronger than specialization;
1832 # however, in case of conflict more than one property are returned.
1833 # If mtype does not know mproperty then an empty array is returned.
1835 # If you want the really most specific property, then look at `lookup_next_definition`
1837 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1838 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
1839 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1841 assert not mtype
.need_anchor
1842 mtype
= mtype
.as_notnullable
1844 # First, select all candidates
1845 var candidates
= new Array[MPROPDEF]
1846 for mpropdef
in self.mpropdefs
do
1847 # If the definition is not imported by the module, then skip
1848 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1849 # If the definition is not inherited by the type, then skip
1850 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1851 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1852 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1854 candidates
.add
(mpropdef
)
1856 # Fast track for only one candidate
1857 if candidates
.length
<= 1 then return candidates
1859 # Second, filter the most specific ones
1860 return select_most_specific
(mmodule
, candidates
)
1863 # Return an array containing olny the most specific property definitions
1864 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
1865 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
1867 var res
= new Array[MPROPDEF]
1868 for pd1
in candidates
do
1869 var cd1
= pd1
.mclassdef
1872 for pd2
in candidates
do
1873 if pd2
== pd1
then continue # do not compare with self!
1874 var cd2
= pd2
.mclassdef
1876 if c2
.mclass_type
== c1
.mclass_type
then
1877 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
1878 # cd2 refines cd1; therefore we skip pd1
1882 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
1883 # cd2 < cd1; therefore we skip pd1
1892 if res
.is_empty
then
1893 print
"All lost! {candidates.join(", ")}"
1894 # FIXME: should be abort!
1899 # Return the most specific definition in the linearization of `mtype`.
1901 # If you want to know the next properties in the linearization,
1902 # look at `MPropDef::lookup_next_definition`.
1904 # FIXME: the linearization is still unspecified
1906 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1907 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1908 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1910 return lookup_all_definitions
(mmodule
, mtype
).first
1913 # Return all definitions in a linearization order
1914 # Most specific first, most general last
1916 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1917 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1918 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1920 mtype
= mtype
.as_notnullable
1922 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1923 if cache
!= null then return cache
1925 assert not mtype
.need_anchor
1926 assert mtype
.has_mproperty
(mmodule
, self)
1928 #print "select prop {mproperty} for {mtype} in {self}"
1929 # First, select all candidates
1930 var candidates
= new Array[MPROPDEF]
1931 for mpropdef
in self.mpropdefs
do
1932 # If the definition is not imported by the module, then skip
1933 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1934 # If the definition is not inherited by the type, then skip
1935 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1937 candidates
.add
(mpropdef
)
1939 # Fast track for only one candidate
1940 if candidates
.length
<= 1 then
1941 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1945 mmodule
.linearize_mpropdefs
(candidates
)
1946 candidates
= candidates
.reversed
1947 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1951 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1958 redef type MPROPDEF: MMethodDef
1960 # Is the property defined at the top_level of the module?
1961 # Currently such a property are stored in `Object`
1962 var is_toplevel
: Bool = false is writable
1964 # Is the property a constructor?
1965 # Warning, this property can be inherited by subclasses with or without being a constructor
1966 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
1967 var is_init
: Bool = false is writable
1969 # The constructor is a (the) root init with empty signature but a set of initializers
1970 var is_root_init
: Bool = false is writable
1972 # Is the property a 'new' constructor?
1973 var is_new
: Bool = false is writable
1975 # Is the property a legal constructor for a given class?
1976 # As usual, visibility is not considered.
1977 # FIXME not implemented
1978 fun is_init_for
(mclass
: MClass): Bool
1984 # A global attribute
1988 redef type MPROPDEF: MAttributeDef
1992 # A global virtual type
1993 class MVirtualTypeProp
1996 redef type MPROPDEF: MVirtualTypeDef
1998 # The formal type associated to the virtual type property
1999 var mvirtualtype
= new MVirtualType(self)
2002 # A definition of a property (local property)
2004 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2005 # specific class definition (which belong to a specific module)
2006 abstract class MPropDef
2009 # The associated `MProperty` subclass.
2010 # the two specialization hierarchy are symmetric
2011 type MPROPERTY: MProperty
2014 type MPROPDEF: MPropDef
2016 # The class definition where the property definition is
2017 var mclassdef
: MClassDef
2019 # The associated global property
2020 var mproperty
: MPROPERTY
2022 # The origin of the definition
2023 var location
: Location
2027 mclassdef
.mpropdefs
.add
(self)
2028 mproperty
.mpropdefs
.add
(self)
2029 if mproperty
.intro_mclassdef
== mclassdef
then
2030 assert not isset mproperty
._intro
2031 mproperty
.intro
= self
2033 self.to_s
= "{mclassdef}#{mproperty}"
2036 # Actually the name of the `mproperty`
2037 redef fun name
do return mproperty
.name
2039 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2041 # Therefore the combination of identifiers is awful,
2042 # the worst case being
2044 # * a property "p::m::A::x"
2045 # * redefined in a refinement of a class "q::n::B"
2046 # * in a module "r::o"
2047 # * so "r::o#q::n::B#p::m::A::x"
2049 # Fortunately, the full-name is simplified when entities are repeated.
2050 # For the previous case, the simplest form is "p#A#x".
2051 redef var full_name
is lazy
do
2052 var res
= new FlatBuffer
2054 # The first part is the mclassdef. Worst case is "r::o#q::n::B"
2055 res
.append mclassdef
.full_name
2059 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2060 # intro are unambiguous in a class
2063 # Just try to simplify each part
2064 if mclassdef
.mmodule
.mproject
!= mproperty
.intro_mclassdef
.mmodule
.mproject
then
2065 # precise "p::m" only if "p" != "r"
2066 res
.append mproperty
.intro_mclassdef
.mmodule
.full_name
2068 else if mproperty
.visibility
<= private_visibility
then
2069 # Same project ("p"=="q"), but private visibility,
2070 # does the module part ("::m") need to be displayed
2071 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mproject
then
2073 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2077 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2078 # precise "B" only if not the same class than "A"
2079 res
.append mproperty
.intro_mclassdef
.name
2082 # Always use the property name "x"
2083 res
.append mproperty
.name
2088 redef var c_name
is lazy
do
2089 var res
= new FlatBuffer
2090 res
.append mclassdef
.c_name
2092 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2093 res
.append name
.to_cmangle
2095 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2096 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2099 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2100 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2103 res
.append mproperty
.name
.to_cmangle
2108 redef fun model
do return mclassdef
.model
2110 # Internal name combining the module, the class and the property
2111 # Example: "mymodule#MyClass#mymethod"
2112 redef var to_s
: String is noinit
2114 # Is self the definition that introduce the property?
2115 fun is_intro
: Bool do return mproperty
.intro
== self
2117 # Return the next definition in linearization of `mtype`.
2119 # This method is used to determine what method is called by a super.
2121 # REQUIRE: `not mtype.need_anchor`
2122 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2124 assert not mtype
.need_anchor
2126 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2127 var i
= mpropdefs
.iterator
2128 while i
.is_ok
and i
.item
!= self do i
.next
2129 assert has_property
: i
.is_ok
2131 assert has_next_property
: i
.is_ok
2136 # A local definition of a method
2140 redef type MPROPERTY: MMethod
2141 redef type MPROPDEF: MMethodDef
2143 # The signature attached to the property definition
2144 var msignature
: nullable MSignature = null is writable
2146 # The signature attached to the `new` call on a root-init
2147 # This is a concatenation of the signatures of the initializers
2149 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2150 var new_msignature
: nullable MSignature = null is writable
2152 # List of initialisers to call in root-inits
2154 # They could be setters or attributes
2156 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2157 var initializers
= new Array[MProperty]
2159 # Is the method definition abstract?
2160 var is_abstract
: Bool = false is writable
2162 # Is the method definition intern?
2163 var is_intern
= false is writable
2165 # Is the method definition extern?
2166 var is_extern
= false is writable
2168 # An optional constant value returned in functions.
2170 # Only some specific primitife value are accepted by engines.
2171 # Is used when there is no better implementation available.
2173 # Currently used only for the implementation of the `--define`
2174 # command-line option.
2175 # SEE: module `mixin`.
2176 var constant_value
: nullable Object = null is writable
2179 # A local definition of an attribute
2183 redef type MPROPERTY: MAttribute
2184 redef type MPROPDEF: MAttributeDef
2186 # The static type of the attribute
2187 var static_mtype
: nullable MType = null is writable
2190 # A local definition of a virtual type
2191 class MVirtualTypeDef
2194 redef type MPROPERTY: MVirtualTypeProp
2195 redef type MPROPDEF: MVirtualTypeDef
2197 # The bound of the virtual type
2198 var bound
: nullable MType = null is writable
2200 # Is the bound fixed?
2201 var is_fixed
= false is writable
2208 # * `interface_kind`
2212 # Note this class is basically an enum.
2213 # FIXME: use a real enum once user-defined enums are available
2215 redef var to_s
: String
2217 # Is a constructor required?
2220 # TODO: private init because enumeration.
2222 # Can a class of kind `self` specializes a class of kine `other`?
2223 fun can_specialize
(other
: MClassKind): Bool
2225 if other
== interface_kind
then return true # everybody can specialize interfaces
2226 if self == interface_kind
or self == enum_kind
then
2227 # no other case for interfaces
2229 else if self == extern_kind
then
2230 # only compatible with themselves
2231 return self == other
2232 else if other
== enum_kind
or other
== extern_kind
then
2233 # abstract_kind and concrete_kind are incompatible
2236 # remain only abstract_kind and concrete_kind
2241 # The class kind `abstract`
2242 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2243 # The class kind `concrete`
2244 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2245 # The class kind `interface`
2246 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2247 # The class kind `enum`
2248 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2249 # The class kind `extern`
2250 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)