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" and self.model
.get_mclasses_by_name
("Object") != null then
255 # Bool is injected because it is needed by engine to code the result
256 # of the implicit casts.
257 var c
= new MClass(self, name
, null, enum_kind
, public_visibility
)
258 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0))
259 cladef
.set_supertypes
([object_type
])
260 cladef
.add_in_hierarchy
263 print
("Fatal Error: no primitive class {name}")
266 if cla
.length
!= 1 then
267 var msg
= "Fatal Error: more than one primitive class {name}:"
268 for c
in cla
do msg
+= " {c.full_name}"
275 # Try to get the primitive method named `name` on the type `recv`
276 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
278 var props
= self.model
.get_mproperties_by_name
(name
)
279 if props
== null then return null
280 var res
: nullable MMethod = null
281 for mprop
in props
do
282 assert mprop
isa MMethod
283 var intro
= mprop
.intro_mclassdef
284 for mclassdef
in recv
.mclassdefs
do
285 if not self.in_importation
.greaters
.has
(mclassdef
.mmodule
) then continue
286 if not mclassdef
.in_hierarchy
.greaters
.has
(intro
) then continue
289 else if res
!= mprop
then
290 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
299 private class MClassDefSorter
301 redef type COMPARED: MClassDef
303 redef fun compare
(a
, b
)
307 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
308 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
312 private class MPropDefSorter
314 redef type COMPARED: MPropDef
316 redef fun compare
(pa
, pb
)
322 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
323 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
329 # `MClass` are global to the model; it means that a `MClass` is not bound to a
330 # specific `MModule`.
332 # This characteristic helps the reasoning about classes in a program since a
333 # single `MClass` object always denote the same class.
335 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
336 # These do not really have properties nor belong to a hierarchy since the property and the
337 # hierarchy of a class depends of the refinement in the modules.
339 # Most services on classes require the precision of a module, and no one can asks what are
340 # the super-classes of a class nor what are properties of a class without precising what is
341 # the module considered.
343 # For instance, during the typing of a source-file, the module considered is the module of the file.
344 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
345 # *is the method `foo` exists in the class `Bar` in the current module?*
347 # During some global analysis, the module considered may be the main module of the program.
351 # The module that introduce the class
352 # While classes are not bound to a specific module,
353 # the introducing module is used for naming an visibility
354 var intro_mmodule
: MModule
356 # The short name of the class
357 # In Nit, the name of a class cannot evolve in refinements
358 redef var name
: String
360 # The canonical name of the class
362 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
363 # Example: `"owner::module::MyClass"`
364 redef var full_name
is lazy
do return "{self.intro_mmodule.full_name}::{name}"
366 redef var c_name
is lazy
do return "{intro_mmodule.c_name}__{name.to_cmangle}"
368 # The number of generic formal parameters
369 # 0 if the class is not generic
370 var arity
: Int is noinit
372 # Each generic formal parameters in order.
373 # is empty if the class is not generic
374 var mparameters
= new Array[MParameterType]
376 # Initialize `mparameters` from their names.
377 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
380 if parameter_names
== null then
383 self.arity
= parameter_names
.length
386 # Create the formal parameter types
388 assert parameter_names
!= null
389 var mparametertypes
= new Array[MParameterType]
390 for i
in [0..arity
[ do
391 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
392 mparametertypes
.add
(mparametertype
)
394 self.mparameters
= mparametertypes
395 var mclass_type
= new MGenericType(self, mparametertypes
)
396 self.mclass_type
= mclass_type
397 self.get_mtype_cache
[mparametertypes
] = mclass_type
399 self.mclass_type
= new MClassType(self)
403 # The kind of the class (interface, abstract class, etc.)
404 # In Nit, the kind of a class cannot evolve in refinements
407 # The visibility of the class
408 # In Nit, the visibility of a class cannot evolve in refinements
409 var visibility
: MVisibility
413 intro_mmodule
.intro_mclasses
.add
(self)
414 var model
= intro_mmodule
.model
415 model
.mclasses_by_name
.add_one
(name
, self)
416 model
.mclasses
.add
(self)
419 redef fun model
do return intro_mmodule
.model
421 # All class definitions (introduction and refinements)
422 var mclassdefs
= new Array[MClassDef]
425 redef fun to_s
do return self.name
427 # The definition that introduces the class.
429 # Warning: such a definition may not exist in the early life of the object.
430 # In this case, the method will abort.
431 var intro
: MClassDef is noinit
433 # Return the class `self` in the class hierarchy of the module `mmodule`.
435 # SEE: `MModule::flatten_mclass_hierarchy`
436 # REQUIRE: `mmodule.has_mclass(self)`
437 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
439 return mmodule
.flatten_mclass_hierarchy
[self]
442 # The principal static type of the class.
444 # For non-generic class, mclass_type is the only `MClassType` based
447 # For a generic class, the arguments are the formal parameters.
448 # i.e.: for the class Array[E:Object], the `mclass_type` is Array[E].
449 # If you want Array[Object] the see `MClassDef::bound_mtype`
451 # For generic classes, the mclass_type is also the way to get a formal
452 # generic parameter type.
454 # To get other types based on a generic class, see `get_mtype`.
456 # ENSURE: `mclass_type.mclass == self`
457 var mclass_type
: MClassType is noinit
459 # Return a generic type based on the class
460 # Is the class is not generic, then the result is `mclass_type`
462 # REQUIRE: `mtype_arguments.length == self.arity`
463 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
465 assert mtype_arguments
.length
== self.arity
466 if self.arity
== 0 then return self.mclass_type
467 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
468 if res
!= null then return res
469 res
= new MGenericType(self, mtype_arguments
)
470 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
474 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
478 # A definition (an introduction or a refinement) of a class in a module
480 # A `MClassDef` is associated with an explicit (or almost) definition of a
481 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
482 # a specific class and a specific module, and contains declarations like super-classes
485 # It is the class definitions that are the backbone of most things in the model:
486 # ClassDefs are defined with regard with other classdefs.
487 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
489 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
493 # The module where the definition is
496 # The associated `MClass`
497 var mclass
: MClass is noinit
499 # The bounded type associated to the mclassdef
501 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
505 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
506 # If you want Array[E], then see `mclass.mclass_type`
508 # ENSURE: `bound_mtype.mclass == self.mclass`
509 var bound_mtype
: MClassType
511 # The origin of the definition
512 var location
: Location
514 # Internal name combining the module and the class
515 # Example: "mymodule#MyClass"
516 redef var to_s
: String is noinit
520 self.mclass
= bound_mtype
.mclass
521 mmodule
.mclassdefs
.add
(self)
522 mclass
.mclassdefs
.add
(self)
523 if mclass
.intro_mmodule
== mmodule
then
524 assert not isset mclass
._intro
527 self.to_s
= "{mmodule}#{mclass}"
530 # Actually the name of the `mclass`
531 redef fun name
do return mclass
.name
533 # The module and class name separated by a '#'.
535 # The short-name of the class is used for introduction.
536 # Example: "my_module#MyClass"
538 # The full-name of the class is used for refinement.
539 # Example: "my_module#intro_module::MyClass"
540 redef var full_name
is lazy
do
542 return "{mmodule.full_name}#{mclass.name}"
544 return "{mmodule.full_name}#{mclass.full_name}"
548 redef var c_name
is lazy
do
552 return "{mmodule.c_name}__{mclass.c_name.to_cmangle}"
556 redef fun model
do return mmodule
.model
558 # All declared super-types
559 # FIXME: quite ugly but not better idea yet
560 var supertypes
= new Array[MClassType]
562 # Register some super-types for the class (ie "super SomeType")
564 # The hierarchy must not already be set
565 # REQUIRE: `self.in_hierarchy == null`
566 fun set_supertypes
(supertypes
: Array[MClassType])
568 assert unique_invocation
: self.in_hierarchy
== null
569 var mmodule
= self.mmodule
570 var model
= mmodule
.model
571 var mtype
= self.bound_mtype
573 for supertype
in supertypes
do
574 self.supertypes
.add
(supertype
)
576 # Register in full_type_specialization_hierarchy
577 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
578 # Register in intro_type_specialization_hierarchy
579 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
580 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
586 # Collect the super-types (set by set_supertypes) to build the hierarchy
588 # This function can only invoked once by class
589 # REQUIRE: `self.in_hierarchy == null`
590 # ENSURE: `self.in_hierarchy != null`
593 assert unique_invocation
: self.in_hierarchy
== null
594 var model
= mmodule
.model
595 var res
= model
.mclassdef_hierarchy
.add_node
(self)
596 self.in_hierarchy
= res
597 var mtype
= self.bound_mtype
599 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
600 # The simpliest way is to attach it to collect_mclassdefs
601 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
602 res
.poset
.add_edge
(self, mclassdef
)
606 # The view of the class definition in `mclassdef_hierarchy`
607 var in_hierarchy
: nullable POSetElement[MClassDef] = null
609 # Is the definition the one that introduced `mclass`?
610 fun is_intro
: Bool do return mclass
.intro
== self
612 # All properties introduced by the classdef
613 var intro_mproperties
= new Array[MProperty]
615 # All property definitions in the class (introductions and redefinitions)
616 var mpropdefs
= new Array[MPropDef]
619 # A global static type
621 # MType are global to the model; it means that a `MType` is not bound to a
622 # specific `MModule`.
623 # This characteristic helps the reasoning about static types in a program
624 # since a single `MType` object always denote the same type.
626 # However, because a `MType` is global, it does not really have properties
627 # nor have subtypes to a hierarchy since the property and the class hierarchy
628 # depends of a module.
629 # Moreover, virtual types an formal generic parameter types also depends on
630 # a receiver to have sense.
632 # Therefore, most method of the types require a module and an anchor.
633 # The module is used to know what are the classes and the specialization
635 # The anchor is used to know what is the bound of the virtual types and formal
636 # generic parameter types.
638 # MType are not directly usable to get properties. See the `anchor_to` method
639 # and the `MClassType` class.
641 # FIXME: the order of the parameters is not the best. We mus pick on from:
642 # * foo(mmodule, anchor, othertype)
643 # * foo(othertype, anchor, mmodule)
644 # * foo(anchor, mmodule, othertype)
645 # * foo(othertype, mmodule, anchor)
649 redef fun name
do return to_s
651 # Return true if `self` is an subtype of `sup`.
652 # The typing is done using the standard typing policy of Nit.
654 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
655 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
656 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
659 if sub
== sup
then return true
661 #print "1.is {sub} a {sup}? ===="
663 if anchor
== null then
664 assert not sub
.need_anchor
665 assert not sup
.need_anchor
667 # First, resolve the formal types to the simplest equivalent forms in the receiver
668 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
669 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
670 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
671 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
674 # Does `sup` accept null or not?
675 # Discard the nullable marker if it exists
676 var sup_accept_null
= false
677 if sup
isa MNullableType then
678 sup_accept_null
= true
680 else if sup
isa MNullType then
681 sup_accept_null
= true
684 # Can `sub` provide null or not?
685 # Thus we can match with `sup_accept_null`
686 # Also discard the nullable marker if it exists
687 if sub
isa MNullableType then
688 if not sup_accept_null
then return false
690 else if sub
isa MNullType then
691 return sup_accept_null
693 # Now the case of direct null and nullable is over.
695 # If `sub` is a formal type, then it is accepted if its bound is accepted
696 while sub
isa MParameterType or sub
isa MVirtualType do
697 #print "3.is {sub} a {sup}?"
699 # A unfixed formal type can only accept itself
700 if sub
== sup
then return true
702 assert anchor
!= null
703 sub
= sub
.lookup_bound
(mmodule
, anchor
)
705 #print "3.is {sub} a {sup}?"
707 # Manage the second layer of null/nullable
708 if sub
isa MNullableType then
709 if not sup_accept_null
then return false
711 else if sub
isa MNullType then
712 return sup_accept_null
715 #print "4.is {sub} a {sup}? <- no more resolution"
717 assert sub
isa MClassType # It is the only remaining type
719 # A unfixed formal type can only accept itself
720 if sup
isa MParameterType or sup
isa MVirtualType then
724 if sup
isa MNullType then
725 # `sup` accepts only null
729 assert sup
isa MClassType # It is the only remaining type
731 # Now both are MClassType, we need to dig
733 if sub
== sup
then return true
735 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
736 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
737 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
738 if res
== false then return false
739 if not sup
isa MGenericType then return true
740 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
741 assert sub2
.mclass
== sup
.mclass
742 for i
in [0..sup
.mclass
.arity
[ do
743 var sub_arg
= sub2
.arguments
[i
]
744 var sup_arg
= sup
.arguments
[i
]
745 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
746 if res
== false then return false
751 # The base class type on which self is based
753 # This base type is used to get property (an internally to perform
754 # unsafe type comparison).
756 # Beware: some types (like null) are not based on a class thus this
759 # Basically, this function transform the virtual types and parameter
760 # types to their bounds.
765 # class B super A end
767 # class Y super X end
776 # Map[T,U] anchor_to H #-> Map[B,Y]
778 # Explanation of the example:
779 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
780 # because "redef type U: Y". Therefore, Map[T, U] is bound to
783 # ENSURE: `not self.need_anchor implies result == self`
784 # ENSURE: `not result.need_anchor`
785 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
787 if not need_anchor
then return self
788 assert not anchor
.need_anchor
789 # Just resolve to the anchor and clear all the virtual types
790 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
791 assert not res
.need_anchor
795 # Does `self` contain a virtual type or a formal generic parameter type?
796 # In order to remove those types, you usually want to use `anchor_to`.
797 fun need_anchor
: Bool do return true
799 # Return the supertype when adapted to a class.
801 # In Nit, for each super-class of a type, there is a equivalent super-type.
807 # class H[V] super G[V, Bool] end
809 # H[Int] supertype_to G #-> G[Int, Bool]
812 # REQUIRE: `super_mclass` is a super-class of `self`
813 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
814 # ENSURE: `result.mclass = super_mclass`
815 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
817 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
818 if self isa MClassType and self.mclass
== super_mclass
then return self
820 if self.need_anchor
then
821 assert anchor
!= null
822 resolved_self
= self.anchor_to
(mmodule
, anchor
)
826 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
827 for supertype
in supertypes
do
828 if supertype
.mclass
== super_mclass
then
829 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
830 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
836 # Replace formals generic types in self with resolved values in `mtype`
837 # If `cleanup_virtual` is true, then virtual types are also replaced
840 # This function returns self if `need_anchor` is false.
846 # class H[F] super G[F] end
850 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
851 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
853 # Explanation of the example:
854 # * Array[E].need_anchor is true because there is a formal generic parameter type E
855 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
856 # * Since "H[F] super G[F]", E is in fact F for H
857 # * More specifically, in H[Int], E is Int
858 # * So, in H[Int], Array[E] is Array[Int]
860 # This function is mainly used to inherit a signature.
861 # Because, unlike `anchor_to`, we do not want a full resolution of
862 # a type but only an adapted version of it.
868 # fun foo(e:E):E is abstract
870 # class B super A[Int] end
873 # The signature on foo is (e: E): E
874 # If we resolve the signature for B, we get (e:Int):Int
880 # fun foo(e:E):E is abstract
884 # fun bar do a.foo(x) # <- x is here
888 # The first question is: is foo available on `a`?
890 # The static type of a is `A[Array[F]]`, that is an open type.
891 # in order to find a method `foo`, whe must look at a resolved type.
893 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
895 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
897 # The next question is: what is the accepted types for `x`?
899 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
901 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
903 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
905 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
906 # two function instead of one seems also to be a bad idea.
908 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
909 # ENSURE: `not self.need_anchor implies result == self`
910 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
912 # Resolve formal type to its verbatim bound.
913 # If the type is not formal, just return self
915 # The result is returned exactly as declared in the "type" property (verbatim).
916 # So it could be another formal type.
918 # In case of conflict, the method aborts.
919 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
921 # Resolve the formal type to its simplest equivalent form.
923 # Formal types are either free or fixed.
924 # When it is fixed, it means that it is equivalent with a simpler type.
925 # When a formal type is free, it means that it is only equivalent with itself.
926 # This method return the most simple equivalent type of `self`.
928 # This method is mainly used for subtype test in order to sanely compare fixed.
930 # By default, return self.
931 # See the redefinitions for specific behavior in each kind of type.
932 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
934 # Can the type be resolved?
936 # In order to resolve open types, the formal types must make sence.
946 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
948 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
950 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
951 # # B[E] is a red hearing only the E is important,
952 # # E make sense in A
955 # REQUIRE: `anchor != null implies not anchor.need_anchor`
956 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
957 # ENSURE: `not self.need_anchor implies result == true`
958 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
960 # Return the nullable version of the type
961 # If the type is already nullable then self is returned
962 fun as_nullable
: MType
964 var res
= self.as_nullable_cache
965 if res
!= null then return res
966 res
= new MNullableType(self)
967 self.as_nullable_cache
= res
971 # Return the not nullable version of the type
972 # Is the type is already not nullable, then self is returned.
974 # Note: this just remove the `nullable` notation, but the result can still contains null.
975 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
976 fun as_notnullable
: MType
981 private var as_nullable_cache
: nullable MType = null
984 # The depth of the type seen as a tree.
991 # Formal types have a depth of 1.
997 # The length of the type seen as a tree.
1004 # Formal types have a length of 1.
1010 # Compute all the classdefs inherited/imported.
1011 # The returned set contains:
1012 # * the class definitions from `mmodule` and its imported modules
1013 # * the class definitions of this type and its super-types
1015 # This function is used mainly internally.
1017 # REQUIRE: `not self.need_anchor`
1018 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1020 # Compute all the super-classes.
1021 # This function is used mainly internally.
1023 # REQUIRE: `not self.need_anchor`
1024 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1026 # Compute all the declared super-types.
1027 # Super-types are returned as declared in the classdefs (verbatim).
1028 # This function is used mainly internally.
1030 # REQUIRE: `not self.need_anchor`
1031 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1033 # Is the property in self for a given module
1034 # This method does not filter visibility or whatever
1036 # REQUIRE: `not self.need_anchor`
1037 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1039 assert not self.need_anchor
1040 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1044 # A type based on a class.
1046 # `MClassType` have properties (see `has_mproperty`).
1050 # The associated class
1053 redef fun model
do return self.mclass
.intro_mmodule
.model
1055 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1057 # The formal arguments of the type
1058 # ENSURE: `result.length == self.mclass.arity`
1059 var arguments
= new Array[MType]
1061 redef fun to_s
do return mclass
.to_s
1063 redef fun full_name
do return mclass
.full_name
1065 redef fun c_name
do return mclass
.c_name
1067 redef fun need_anchor
do return false
1069 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1071 return super.as(MClassType)
1074 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1076 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1078 redef fun collect_mclassdefs
(mmodule
)
1080 assert not self.need_anchor
1081 var cache
= self.collect_mclassdefs_cache
1082 if not cache
.has_key
(mmodule
) then
1083 self.collect_things
(mmodule
)
1085 return cache
[mmodule
]
1088 redef fun collect_mclasses
(mmodule
)
1090 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1091 assert not self.need_anchor
1092 var cache
= self.collect_mclasses_cache
1093 if not cache
.has_key
(mmodule
) then
1094 self.collect_things
(mmodule
)
1096 var res
= cache
[mmodule
]
1097 collect_mclasses_last_module
= mmodule
1098 collect_mclasses_last_module_cache
= res
1102 private var collect_mclasses_last_module
: nullable MModule = null
1103 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1105 redef fun collect_mtypes
(mmodule
)
1107 assert not self.need_anchor
1108 var cache
= self.collect_mtypes_cache
1109 if not cache
.has_key
(mmodule
) then
1110 self.collect_things
(mmodule
)
1112 return cache
[mmodule
]
1115 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1116 private fun collect_things
(mmodule
: MModule)
1118 var res
= new HashSet[MClassDef]
1119 var seen
= new HashSet[MClass]
1120 var types
= new HashSet[MClassType]
1121 seen
.add
(self.mclass
)
1122 var todo
= [self.mclass
]
1123 while not todo
.is_empty
do
1124 var mclass
= todo
.pop
1125 #print "process {mclass}"
1126 for mclassdef
in mclass
.mclassdefs
do
1127 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1128 #print " process {mclassdef}"
1130 for supertype
in mclassdef
.supertypes
do
1131 types
.add
(supertype
)
1132 var superclass
= supertype
.mclass
1133 if seen
.has
(superclass
) then continue
1134 #print " add {superclass}"
1135 seen
.add
(superclass
)
1136 todo
.add
(superclass
)
1140 collect_mclassdefs_cache
[mmodule
] = res
1141 collect_mclasses_cache
[mmodule
] = seen
1142 collect_mtypes_cache
[mmodule
] = types
1145 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1146 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1147 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1151 # A type based on a generic class.
1152 # A generic type a just a class with additional formal generic arguments.
1158 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1162 assert self.mclass
.arity
== arguments
.length
1164 self.need_anchor
= false
1165 for t
in arguments
do
1166 if t
.need_anchor
then
1167 self.need_anchor
= true
1172 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1175 # The short-name of the class, then the full-name of each type arguments within brackets.
1176 # Example: `"Map[String, List[Int]]"`
1177 redef var to_s
: String is noinit
1179 # The full-name of the class, then the full-name of each type arguments within brackets.
1180 # Example: `"standard::Map[standard::String, standard::List[standard::Int]]"`
1181 redef var full_name
is lazy
do
1182 var args
= new Array[String]
1183 for t
in arguments
do
1184 args
.add t
.full_name
1186 return "{mclass.full_name}[{args.join(", ")}]}"
1189 redef var c_name
is lazy
do
1190 var res
= mclass
.c_name
1191 # Note: because the arity is known, a prefix notation is enough
1192 for t
in arguments
do
1199 redef var need_anchor
: Bool is noinit
1201 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1203 if not need_anchor
then return self
1204 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1205 var types
= new Array[MType]
1206 for t
in arguments
do
1207 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1209 return mclass
.get_mtype
(types
)
1212 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1214 if not need_anchor
then return true
1215 for t
in arguments
do
1216 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1225 for a
in self.arguments
do
1227 if d
> dmax
then dmax
= d
1235 for a
in self.arguments
do
1242 # A virtual formal type.
1246 # The property associated with the type.
1247 # Its the definitions of this property that determine the bound or the virtual type.
1248 var mproperty
: MVirtualTypeProp
1250 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1252 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1254 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
.as(not null)
1257 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1259 assert not resolved_receiver
.need_anchor
1260 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1261 if props
.is_empty
then
1263 else if props
.length
== 1 then
1266 var types
= new ArraySet[MType]
1267 var res
= props
.first
1269 types
.add
(p
.bound
.as(not null))
1270 if not res
.is_fixed
then res
= p
1272 if types
.length
== 1 then
1278 # A VT is fixed when:
1279 # * the VT is (re-)defined with the annotation `is fixed`
1280 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1281 # * the receiver is an enum class since there is no subtype possible
1282 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1284 assert not resolved_receiver
.need_anchor
1285 resolved_receiver
= resolved_receiver
.as_notnullable
1286 assert resolved_receiver
isa MClassType # It is the only remaining type
1288 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1289 var res
= prop
.bound
.as(not null)
1291 # Recursively lookup the fixed result
1292 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1294 # 1. For a fixed VT, return the resolved bound
1295 if prop
.is_fixed
then return res
1297 # 2. For a enum boud, return the bound
1298 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1300 # 3. for a enum receiver return the bound
1301 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1306 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1308 if not cleanup_virtual
then return self
1309 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1310 # self is a virtual type declared (or inherited) in mtype
1311 # The point of the function it to get the bound of the virtual type that make sense for mtype
1312 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1313 #print "{class_name}: {self}/{mtype}/{anchor}?"
1314 var resolved_receiver
1315 if mtype
.need_anchor
then
1316 assert anchor
!= null
1317 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1319 resolved_receiver
= mtype
1321 # Now, we can get the bound
1322 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1323 # The bound is exactly as declared in the "type" property, so we must resolve it again
1324 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1329 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1331 if mtype
.need_anchor
then
1332 assert anchor
!= null
1333 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1335 return mtype
.has_mproperty
(mmodule
, mproperty
)
1338 redef fun to_s
do return self.mproperty
.to_s
1340 redef fun full_name
do return self.mproperty
.full_name
1342 redef fun c_name
do return self.mproperty
.c_name
1345 # The type associated to a formal parameter generic type of a class
1347 # Each parameter type is associated to a specific class.
1348 # It means that all refinements of a same class "share" the parameter type,
1349 # but that a generic subclass has its own parameter types.
1351 # However, in the sense of the meta-model, a parameter type of a class is
1352 # a valid type in a subclass. The "in the sense of the meta-model" is
1353 # important because, in the Nit language, the programmer cannot refers
1354 # directly to the parameter types of the super-classes.
1359 # fun e: E is abstract
1365 # In the class definition B[F], `F` is a valid type but `E` is not.
1366 # However, `self.e` is a valid method call, and the signature of `e` is
1369 # Note that parameter types are shared among class refinements.
1370 # Therefore parameter only have an internal name (see `to_s` for details).
1371 class MParameterType
1374 # The generic class where the parameter belong
1377 redef fun model
do return self.mclass
.intro_mmodule
.model
1379 # The position of the parameter (0 for the first parameter)
1380 # FIXME: is `position` a better name?
1385 redef fun to_s
do return name
1387 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1389 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1391 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1393 assert not resolved_receiver
.need_anchor
1394 resolved_receiver
= resolved_receiver
.as_notnullable
1395 assert resolved_receiver
isa MClassType # It is the only remaining type
1396 var goalclass
= self.mclass
1397 if resolved_receiver
.mclass
== goalclass
then
1398 return resolved_receiver
.arguments
[self.rank
]
1400 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1401 for t
in supertypes
do
1402 if t
.mclass
== goalclass
then
1403 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1404 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1405 var res
= t
.arguments
[self.rank
]
1412 # A PT is fixed when:
1413 # * Its bound is a enum class (see `enum_kind`).
1414 # The PT is just useless, but it is still a case.
1415 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1416 # so it is necessarily fixed in a `super` clause, either with a normal type
1417 # or with another PT.
1418 # See `resolve_for` for examples about related issues.
1419 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1421 assert not resolved_receiver
.need_anchor
1422 resolved_receiver
= resolved_receiver
.as_notnullable
1423 assert resolved_receiver
isa MClassType # It is the only remaining type
1424 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1428 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1430 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1431 #print "{class_name}: {self}/{mtype}/{anchor}?"
1433 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1434 var res
= mtype
.arguments
[self.rank
]
1435 if anchor
!= null and res
.need_anchor
then
1436 # Maybe the result can be resolved more if are bound to a final class
1437 var r2
= res
.anchor_to
(mmodule
, anchor
)
1438 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1443 # self is a parameter type of mtype (or of a super-class of mtype)
1444 # The point of the function it to get the bound of the virtual type that make sense for mtype
1445 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1446 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1447 var resolved_receiver
1448 if mtype
.need_anchor
then
1449 assert anchor
!= null
1450 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1452 resolved_receiver
= mtype
1454 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1455 if resolved_receiver
isa MParameterType then
1456 assert resolved_receiver
.mclass
== anchor
.mclass
1457 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1458 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1460 assert resolved_receiver
isa MClassType # It is the only remaining type
1462 # Eh! The parameter is in the current class.
1463 # So we return the corresponding argument, no mater what!
1464 if resolved_receiver
.mclass
== self.mclass
then
1465 var res
= resolved_receiver
.arguments
[self.rank
]
1466 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1470 if resolved_receiver
.need_anchor
then
1471 assert anchor
!= null
1472 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1474 # Now, we can get the bound
1475 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1476 # The bound is exactly as declared in the "type" property, so we must resolve it again
1477 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1479 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1484 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1486 if mtype
.need_anchor
then
1487 assert anchor
!= null
1488 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1490 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1494 # A type prefixed with "nullable"
1498 # The base type of the nullable type
1501 redef fun model
do return self.mtype
.model
1505 self.to_s
= "nullable {mtype}"
1508 redef var to_s
: String is noinit
1510 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1512 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1514 redef fun need_anchor
do return mtype
.need_anchor
1515 redef fun as_nullable
do return self
1516 redef fun as_notnullable
do return mtype
1517 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1519 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1520 return res
.as_nullable
1523 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1525 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1528 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1529 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1531 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1532 if t
== mtype
then return self
1533 return t
.as_nullable
1536 redef fun depth
do return self.mtype
.depth
1538 redef fun length
do return self.mtype
.length
1540 redef fun collect_mclassdefs
(mmodule
)
1542 assert not self.need_anchor
1543 return self.mtype
.collect_mclassdefs
(mmodule
)
1546 redef fun collect_mclasses
(mmodule
)
1548 assert not self.need_anchor
1549 return self.mtype
.collect_mclasses
(mmodule
)
1552 redef fun collect_mtypes
(mmodule
)
1554 assert not self.need_anchor
1555 return self.mtype
.collect_mtypes
(mmodule
)
1559 # The type of the only value null
1561 # The is only one null type per model, see `MModel::null_type`.
1564 redef var model
: Model
1565 redef fun to_s
do return "null"
1566 redef fun full_name
do return "null"
1567 redef fun c_name
do return "null"
1568 redef fun as_nullable
do return self
1569 redef fun need_anchor
do return false
1570 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1571 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1573 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1575 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1577 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1580 # A signature of a method
1584 # The each parameter (in order)
1585 var mparameters
: Array[MParameter]
1587 # The return type (null for a procedure)
1588 var return_mtype
: nullable MType
1593 var t
= self.return_mtype
1594 if t
!= null then dmax
= t
.depth
1595 for p
in mparameters
do
1596 var d
= p
.mtype
.depth
1597 if d
> dmax
then dmax
= d
1605 var t
= self.return_mtype
1606 if t
!= null then res
+= t
.length
1607 for p
in mparameters
do
1608 res
+= p
.mtype
.length
1613 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1616 var vararg_rank
= -1
1617 for i
in [0..mparameters
.length
[ do
1618 var parameter
= mparameters
[i
]
1619 if parameter
.is_vararg
then
1620 assert vararg_rank
== -1
1624 self.vararg_rank
= vararg_rank
1627 # The rank of the ellipsis (`...`) for vararg (starting from 0).
1628 # value is -1 if there is no vararg.
1629 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1630 var vararg_rank
: Int is noinit
1632 # The number or parameters
1633 fun arity
: Int do return mparameters
.length
1637 var b
= new FlatBuffer
1638 if not mparameters
.is_empty
then
1640 for i
in [0..mparameters
.length
[ do
1641 var mparameter
= mparameters
[i
]
1642 if i
> 0 then b
.append
(", ")
1643 b
.append
(mparameter
.name
)
1645 b
.append
(mparameter
.mtype
.to_s
)
1646 if mparameter
.is_vararg
then
1652 var ret
= self.return_mtype
1660 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1662 var params
= new Array[MParameter]
1663 for p
in self.mparameters
do
1664 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1666 var ret
= self.return_mtype
1668 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1670 var res
= new MSignature(params
, ret
)
1675 # A parameter in a signature
1679 # The name of the parameter
1680 redef var name
: String
1682 # The static type of the parameter
1685 # Is the parameter a vararg?
1691 return "{name}: {mtype}..."
1693 return "{name}: {mtype}"
1697 # Returns a new parameter with the `mtype` resolved.
1698 # See `MType::resolve_for` for details.
1699 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1701 if not self.mtype
.need_anchor
then return self
1702 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1703 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1707 redef fun model
do return mtype
.model
1710 # A service (global property) that generalize method, attribute, etc.
1712 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1713 # to a specific `MModule` nor a specific `MClass`.
1715 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1716 # and the other in subclasses and in refinements.
1718 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1719 # of any dynamic type).
1720 # For instance, a call site "x.foo" is associated to a `MProperty`.
1721 abstract class MProperty
1724 # The associated MPropDef subclass.
1725 # The two specialization hierarchy are symmetric.
1726 type MPROPDEF: MPropDef
1728 # The classdef that introduce the property
1729 # While a property is not bound to a specific module, or class,
1730 # the introducing mclassdef is used for naming and visibility
1731 var intro_mclassdef
: MClassDef
1733 # The (short) name of the property
1734 redef var name
: String
1736 # The canonical name of the property.
1738 # It is the short-`name` prefixed by the short-name of the class and the full-name of the module.
1739 # Example: "my_project::my_module::MyClass::my_method"
1740 redef var full_name
is lazy
do
1741 return "{intro_mclassdef.mmodule.full_name}::{intro_mclassdef.mclass.name}::{name}"
1744 redef var c_name
is lazy
do
1745 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.c_name}__{name.to_cmangle}"
1748 # The visibility of the property
1749 var visibility
: MVisibility
1753 intro_mclassdef
.intro_mproperties
.add
(self)
1754 var model
= intro_mclassdef
.mmodule
.model
1755 model
.mproperties_by_name
.add_one
(name
, self)
1756 model
.mproperties
.add
(self)
1759 # All definitions of the property.
1760 # The first is the introduction,
1761 # The other are redefinitions (in refinements and in subclasses)
1762 var mpropdefs
= new Array[MPROPDEF]
1764 # The definition that introduces the property.
1766 # Warning: such a definition may not exist in the early life of the object.
1767 # In this case, the method will abort.
1768 var intro
: MPROPDEF is noinit
1770 redef fun model
do return intro
.model
1773 redef fun to_s
do return name
1775 # Return the most specific property definitions defined or inherited by a type.
1776 # The selection knows that refinement is stronger than specialization;
1777 # however, in case of conflict more than one property are returned.
1778 # If mtype does not know mproperty then an empty array is returned.
1780 # If you want the really most specific property, then look at `lookup_first_definition`
1781 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1783 assert not mtype
.need_anchor
1784 mtype
= mtype
.as_notnullable
1786 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1787 if cache
!= null then return cache
1789 #print "select prop {mproperty} for {mtype} in {self}"
1790 # First, select all candidates
1791 var candidates
= new Array[MPROPDEF]
1792 for mpropdef
in self.mpropdefs
do
1793 # If the definition is not imported by the module, then skip
1794 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1795 # If the definition is not inherited by the type, then skip
1796 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1798 candidates
.add
(mpropdef
)
1800 # Fast track for only one candidate
1801 if candidates
.length
<= 1 then
1802 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1806 # Second, filter the most specific ones
1807 return select_most_specific
(mmodule
, candidates
)
1810 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1812 # Return the most specific property definitions inherited by a type.
1813 # The selection knows that refinement is stronger than specialization;
1814 # however, in case of conflict more than one property are returned.
1815 # If mtype does not know mproperty then an empty array is returned.
1817 # If you want the really most specific property, then look at `lookup_next_definition`
1819 # FIXME: Move to `MPropDef`?
1820 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1822 assert not mtype
.need_anchor
1823 mtype
= mtype
.as_notnullable
1825 # First, select all candidates
1826 var candidates
= new Array[MPROPDEF]
1827 for mpropdef
in self.mpropdefs
do
1828 # If the definition is not imported by the module, then skip
1829 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1830 # If the definition is not inherited by the type, then skip
1831 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1832 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1833 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1835 candidates
.add
(mpropdef
)
1837 # Fast track for only one candidate
1838 if candidates
.length
<= 1 then return candidates
1840 # Second, filter the most specific ones
1841 return select_most_specific
(mmodule
, candidates
)
1844 # Return an array containing olny the most specific property definitions
1845 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
1846 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
1848 var res
= new Array[MPROPDEF]
1849 for pd1
in candidates
do
1850 var cd1
= pd1
.mclassdef
1853 for pd2
in candidates
do
1854 if pd2
== pd1
then continue # do not compare with self!
1855 var cd2
= pd2
.mclassdef
1857 if c2
.mclass_type
== c1
.mclass_type
then
1858 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
1859 # cd2 refines cd1; therefore we skip pd1
1863 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
1864 # cd2 < cd1; therefore we skip pd1
1873 if res
.is_empty
then
1874 print
"All lost! {candidates.join(", ")}"
1875 # FIXME: should be abort!
1880 # Return the most specific definition in the linearization of `mtype`.
1882 # If you want to know the next properties in the linearization,
1883 # look at `MPropDef::lookup_next_definition`.
1885 # FIXME: the linearization is still unspecified
1887 # REQUIRE: `not mtype.need_anchor`
1888 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1889 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1891 assert mtype
.has_mproperty
(mmodule
, self)
1892 return lookup_all_definitions
(mmodule
, mtype
).first
1895 # Return all definitions in a linearization order
1896 # Most specific first, most general last
1897 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1899 assert not mtype
.need_anchor
1900 mtype
= mtype
.as_notnullable
1902 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1903 if cache
!= null then return cache
1905 #print "select prop {mproperty} for {mtype} in {self}"
1906 # First, select all candidates
1907 var candidates
= new Array[MPROPDEF]
1908 for mpropdef
in self.mpropdefs
do
1909 # If the definition is not imported by the module, then skip
1910 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1911 # If the definition is not inherited by the type, then skip
1912 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1914 candidates
.add
(mpropdef
)
1916 # Fast track for only one candidate
1917 if candidates
.length
<= 1 then
1918 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1922 mmodule
.linearize_mpropdefs
(candidates
)
1923 candidates
= candidates
.reversed
1924 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1928 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1935 redef type MPROPDEF: MMethodDef
1937 # Is the property defined at the top_level of the module?
1938 # Currently such a property are stored in `Object`
1939 var is_toplevel
: Bool = false is writable
1941 # Is the property a constructor?
1942 # Warning, this property can be inherited by subclasses with or without being a constructor
1943 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
1944 var is_init
: Bool = false is writable
1946 # The constructor is a (the) root init with empty signature but a set of initializers
1947 var is_root_init
: Bool = false is writable
1949 # Is the property a 'new' constructor?
1950 var is_new
: Bool = false is writable
1952 # Is the property a legal constructor for a given class?
1953 # As usual, visibility is not considered.
1954 # FIXME not implemented
1955 fun is_init_for
(mclass
: MClass): Bool
1961 # A global attribute
1965 redef type MPROPDEF: MAttributeDef
1969 # A global virtual type
1970 class MVirtualTypeProp
1973 redef type MPROPDEF: MVirtualTypeDef
1975 # The formal type associated to the virtual type property
1976 var mvirtualtype
= new MVirtualType(self)
1979 # A definition of a property (local property)
1981 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
1982 # specific class definition (which belong to a specific module)
1983 abstract class MPropDef
1986 # The associated `MProperty` subclass.
1987 # the two specialization hierarchy are symmetric
1988 type MPROPERTY: MProperty
1991 type MPROPDEF: MPropDef
1993 # The class definition where the property definition is
1994 var mclassdef
: MClassDef
1996 # The associated global property
1997 var mproperty
: MPROPERTY
1999 # The origin of the definition
2000 var location
: Location
2004 mclassdef
.mpropdefs
.add
(self)
2005 mproperty
.mpropdefs
.add
(self)
2006 if mproperty
.intro_mclassdef
== mclassdef
then
2007 assert not isset mproperty
._intro
2008 mproperty
.intro
= self
2010 self.to_s
= "{mclassdef}#{mproperty}"
2013 # Actually the name of the `mproperty`
2014 redef fun name
do return mproperty
.name
2016 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2018 # Therefore the combination of identifiers is awful,
2019 # the worst case being
2022 # "{mclassdef.mmodule.full_name}#{mclassdef.mclass.intro_mmodule.full_name}::{mclassdef.name}#{mproperty.intro_mclassdef.mmodule.full_name}::{mproperty.intro_mclassdef.name}::{name}"
2025 # Fortunately, the full-name is simplified when entities are repeated.
2026 # The simplest form is "my_module#MyClass#my_property".
2027 redef var full_name
is lazy
do
2028 var res
= new FlatBuffer
2029 res
.append mclassdef
.mmodule
.full_name
2031 if not mclassdef
.is_intro
then
2032 res
.append mclassdef
.mclass
.intro_mmodule
.full_name
2035 res
.append mclassdef
.name
2037 if mproperty
.intro_mclassdef
.mmodule
!= mclassdef
.mmodule
then
2038 res
.append mproperty
.intro_mclassdef
.mmodule
.full_name
2041 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2042 res
.append mproperty
.intro_mclassdef
.mclass
.name
2049 redef var c_name
is lazy
do
2050 var res
= new FlatBuffer
2051 res
.append mclassdef
.c_name
2054 res
.append name
.to_cmangle
2056 res
.append mproperty
.c_name
.to_cmangle
2061 redef fun model
do return mclassdef
.model
2063 # Internal name combining the module, the class and the property
2064 # Example: "mymodule#MyClass#mymethod"
2065 redef var to_s
: String is noinit
2067 # Is self the definition that introduce the property?
2068 fun is_intro
: Bool do return mproperty
.intro
== self
2070 # Return the next definition in linearization of `mtype`.
2072 # This method is used to determine what method is called by a super.
2074 # REQUIRE: `not mtype.need_anchor`
2075 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2077 assert not mtype
.need_anchor
2079 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2080 var i
= mpropdefs
.iterator
2081 while i
.is_ok
and i
.item
!= self do i
.next
2082 assert has_property
: i
.is_ok
2084 assert has_next_property
: i
.is_ok
2089 # A local definition of a method
2093 redef type MPROPERTY: MMethod
2094 redef type MPROPDEF: MMethodDef
2096 # The signature attached to the property definition
2097 var msignature
: nullable MSignature = null is writable
2099 # The signature attached to the `new` call on a root-init
2100 # This is a concatenation of the signatures of the initializers
2102 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2103 var new_msignature
: nullable MSignature = null is writable
2105 # List of initialisers to call in root-inits
2107 # They could be setters or attributes
2109 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2110 var initializers
= new Array[MProperty]
2112 # Is the method definition abstract?
2113 var is_abstract
: Bool = false is writable
2115 # Is the method definition intern?
2116 var is_intern
= false is writable
2118 # Is the method definition extern?
2119 var is_extern
= false is writable
2121 # An optional constant value returned in functions.
2123 # Only some specific primitife value are accepted by engines.
2124 # Is used when there is no better implementation available.
2126 # Currently used only for the implementation of the `--define`
2127 # command-line option.
2128 # SEE: module `mixin`.
2129 var constant_value
: nullable Object = null is writable
2132 # A local definition of an attribute
2136 redef type MPROPERTY: MAttribute
2137 redef type MPROPDEF: MAttributeDef
2139 # The static type of the attribute
2140 var static_mtype
: nullable MType = null is writable
2143 # A local definition of a virtual type
2144 class MVirtualTypeDef
2147 redef type MPROPERTY: MVirtualTypeProp
2148 redef type MPROPDEF: MVirtualTypeDef
2150 # The bound of the virtual type
2151 var bound
: nullable MType = null is writable
2153 # Is the bound fixed?
2154 var is_fixed
= false is writable
2161 # * `interface_kind`
2165 # Note this class is basically an enum.
2166 # FIXME: use a real enum once user-defined enums are available
2168 redef var to_s
: String
2170 # Is a constructor required?
2173 # TODO: private init because enumeration.
2175 # Can a class of kind `self` specializes a class of kine `other`?
2176 fun can_specialize
(other
: MClassKind): Bool
2178 if other
== interface_kind
then return true # everybody can specialize interfaces
2179 if self == interface_kind
or self == enum_kind
then
2180 # no other case for interfaces
2182 else if self == extern_kind
then
2183 # only compatible with themselves
2184 return self == other
2185 else if other
== enum_kind
or other
== extern_kind
then
2186 # abstract_kind and concrete_kind are incompatible
2189 # remain only abstract_kind and concrete_kind
2194 # The class kind `abstract`
2195 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2196 # The class kind `concrete`
2197 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2198 # The class kind `interface`
2199 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2200 # The class kind `enum`
2201 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2202 # The class kind `extern`
2203 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)