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 var object_type
: MClassType = self.get_primitive_class
("Object").mclass_type
is lazy
200 # The type `Pointer`, super class to all extern classes
201 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
203 # The primitive type `Bool`
204 var bool_type
: MClassType = self.get_primitive_class
("Bool").mclass_type
is lazy
206 # The primitive type `Int`
207 var int_type
: MClassType = self.get_primitive_class
("Int").mclass_type
is lazy
209 # The primitive type `Char`
210 var char_type
: MClassType = self.get_primitive_class
("Char").mclass_type
is lazy
212 # The primitive type `Float`
213 var float_type
: MClassType = self.get_primitive_class
("Float").mclass_type
is lazy
215 # The primitive type `String`
216 var string_type
: MClassType = self.get_primitive_class
("String").mclass_type
is lazy
218 # The primitive type `NativeString`
219 var native_string_type
: MClassType = self.get_primitive_class
("NativeString").mclass_type
is lazy
221 # A primitive type of `Array`
222 fun array_type
(elt_type
: MType): MClassType do return array_class
.get_mtype
([elt_type
])
224 # The primitive class `Array`
225 var array_class
: MClass = self.get_primitive_class
("Array") is lazy
227 # A primitive type of `NativeArray`
228 fun native_array_type
(elt_type
: MType): MClassType do return native_array_class
.get_mtype
([elt_type
])
230 # The primitive class `NativeArray`
231 var native_array_class
: MClass = self.get_primitive_class
("NativeArray") is lazy
233 # The primitive type `Sys`, the main type of the program, if any
234 fun sys_type
: nullable MClassType
236 var clas
= self.model
.get_mclasses_by_name
("Sys")
237 if clas
== null then return null
238 return get_primitive_class
("Sys").mclass_type
241 # The primitive type `Finalizable`
242 # Used to tag classes that need to be finalized.
243 fun finalizable_type
: nullable MClassType
245 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
246 if clas
== null then return null
247 return get_primitive_class
("Finalizable").mclass_type
250 # Force to get the primitive class named `name` or abort
251 fun get_primitive_class
(name
: String): MClass
253 var cla
= self.model
.get_mclasses_by_name
(name
)
255 if name
== "Bool" and self.model
.get_mclasses_by_name
("Object") != null then
256 # Bool is injected because it is needed by engine to code the result
257 # of the implicit casts.
258 var c
= new MClass(self, name
, null, enum_kind
, public_visibility
)
259 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0))
260 cladef
.set_supertypes
([object_type
])
261 cladef
.add_in_hierarchy
264 print
("Fatal Error: no primitive class {name}")
267 if cla
.length
!= 1 then
268 var msg
= "Fatal Error: more than one primitive class {name}:"
269 for c
in cla
do msg
+= " {c.full_name}"
276 # Try to get the primitive method named `name` on the type `recv`
277 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
279 var props
= self.model
.get_mproperties_by_name
(name
)
280 if props
== null then return null
281 var res
: nullable MMethod = null
282 for mprop
in props
do
283 assert mprop
isa MMethod
284 var intro
= mprop
.intro_mclassdef
285 for mclassdef
in recv
.mclassdefs
do
286 if not self.in_importation
.greaters
.has
(mclassdef
.mmodule
) then continue
287 if not mclassdef
.in_hierarchy
.greaters
.has
(intro
) then continue
290 else if res
!= mprop
then
291 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
300 private class MClassDefSorter
302 redef type COMPARED: MClassDef
304 redef fun compare
(a
, b
)
308 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
309 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
313 private class MPropDefSorter
315 redef type COMPARED: MPropDef
317 redef fun compare
(pa
, pb
)
323 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
324 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
330 # `MClass` are global to the model; it means that a `MClass` is not bound to a
331 # specific `MModule`.
333 # This characteristic helps the reasoning about classes in a program since a
334 # single `MClass` object always denote the same class.
336 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
337 # These do not really have properties nor belong to a hierarchy since the property and the
338 # hierarchy of a class depends of the refinement in the modules.
340 # Most services on classes require the precision of a module, and no one can asks what are
341 # the super-classes of a class nor what are properties of a class without precising what is
342 # the module considered.
344 # For instance, during the typing of a source-file, the module considered is the module of the file.
345 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
346 # *is the method `foo` exists in the class `Bar` in the current module?*
348 # During some global analysis, the module considered may be the main module of the program.
352 # The module that introduce the class
353 # While classes are not bound to a specific module,
354 # the introducing module is used for naming an visibility
355 var intro_mmodule
: MModule
357 # The short name of the class
358 # In Nit, the name of a class cannot evolve in refinements
359 redef var name
: String
361 # The canonical name of the class
363 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
364 # Example: `"owner::module::MyClass"`
365 redef var full_name
is lazy
do
366 return "{self.intro_mmodule.namespace_for(visibility)}::{name}"
369 redef var c_name
is lazy
do
370 return "{intro_mmodule.c_namespace_for(visibility)}__{name.to_cmangle}"
373 # The number of generic formal parameters
374 # 0 if the class is not generic
375 var arity
: Int is noinit
377 # Each generic formal parameters in order.
378 # is empty if the class is not generic
379 var mparameters
= new Array[MParameterType]
381 # Initialize `mparameters` from their names.
382 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
385 if parameter_names
== null then
388 self.arity
= parameter_names
.length
391 # Create the formal parameter types
393 assert parameter_names
!= null
394 var mparametertypes
= new Array[MParameterType]
395 for i
in [0..arity
[ do
396 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
397 mparametertypes
.add
(mparametertype
)
399 self.mparameters
= mparametertypes
400 var mclass_type
= new MGenericType(self, mparametertypes
)
401 self.mclass_type
= mclass_type
402 self.get_mtype_cache
[mparametertypes
] = mclass_type
404 self.mclass_type
= new MClassType(self)
408 # The kind of the class (interface, abstract class, etc.)
409 # In Nit, the kind of a class cannot evolve in refinements
412 # The visibility of the class
413 # In Nit, the visibility of a class cannot evolve in refinements
414 var visibility
: MVisibility
418 intro_mmodule
.intro_mclasses
.add
(self)
419 var model
= intro_mmodule
.model
420 model
.mclasses_by_name
.add_one
(name
, self)
421 model
.mclasses
.add
(self)
424 redef fun model
do return intro_mmodule
.model
426 # All class definitions (introduction and refinements)
427 var mclassdefs
= new Array[MClassDef]
430 redef fun to_s
do return self.name
432 # The definition that introduces the class.
434 # Warning: such a definition may not exist in the early life of the object.
435 # In this case, the method will abort.
436 var intro
: MClassDef is noinit
438 # Return the class `self` in the class hierarchy of the module `mmodule`.
440 # SEE: `MModule::flatten_mclass_hierarchy`
441 # REQUIRE: `mmodule.has_mclass(self)`
442 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
444 return mmodule
.flatten_mclass_hierarchy
[self]
447 # The principal static type of the class.
449 # For non-generic class, mclass_type is the only `MClassType` based
452 # For a generic class, the arguments are the formal parameters.
453 # i.e.: for the class Array[E:Object], the `mclass_type` is Array[E].
454 # If you want Array[Object] the see `MClassDef::bound_mtype`
456 # For generic classes, the mclass_type is also the way to get a formal
457 # generic parameter type.
459 # To get other types based on a generic class, see `get_mtype`.
461 # ENSURE: `mclass_type.mclass == self`
462 var mclass_type
: MClassType is noinit
464 # Return a generic type based on the class
465 # Is the class is not generic, then the result is `mclass_type`
467 # REQUIRE: `mtype_arguments.length == self.arity`
468 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
470 assert mtype_arguments
.length
== self.arity
471 if self.arity
== 0 then return self.mclass_type
472 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
473 if res
!= null then return res
474 res
= new MGenericType(self, mtype_arguments
)
475 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
479 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
483 # A definition (an introduction or a refinement) of a class in a module
485 # A `MClassDef` is associated with an explicit (or almost) definition of a
486 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
487 # a specific class and a specific module, and contains declarations like super-classes
490 # It is the class definitions that are the backbone of most things in the model:
491 # ClassDefs are defined with regard with other classdefs.
492 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
494 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
498 # The module where the definition is
501 # The associated `MClass`
502 var mclass
: MClass is noinit
504 # The bounded type associated to the mclassdef
506 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
510 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
511 # If you want Array[E], then see `mclass.mclass_type`
513 # ENSURE: `bound_mtype.mclass == self.mclass`
514 var bound_mtype
: MClassType
516 # The origin of the definition
517 var location
: Location
519 # Internal name combining the module and the class
520 # Example: "mymodule#MyClass"
521 redef var to_s
: String is noinit
525 self.mclass
= bound_mtype
.mclass
526 mmodule
.mclassdefs
.add
(self)
527 mclass
.mclassdefs
.add
(self)
528 if mclass
.intro_mmodule
== mmodule
then
529 assert not isset mclass
._intro
532 self.to_s
= "{mmodule}#{mclass}"
535 # Actually the name of the `mclass`
536 redef fun name
do return mclass
.name
538 # The module and class name separated by a '#'.
540 # The short-name of the class is used for introduction.
541 # Example: "my_module#MyClass"
543 # The full-name of the class is used for refinement.
544 # Example: "my_module#intro_module::MyClass"
545 redef var full_name
is lazy
do
548 # private gives 'p::m#A'
549 return "{mmodule.namespace_for(mclass.visibility)}#{mclass.name}"
550 else if mclass
.intro_mmodule
.mproject
!= mmodule
.mproject
then
551 # public gives 'q::n#p::A'
552 # private gives 'q::n#p::m::A'
553 return "{mmodule.full_name}#{mclass.full_name}"
554 else if mclass
.visibility
> private_visibility
then
555 # public gives 'p::n#A'
556 return "{mmodule.full_name}#{mclass.name}"
558 # private gives 'p::n#::m::A' (redundant p is omitted)
559 return "{mmodule.full_name}#::{mclass.intro_mmodule.name}::{mclass.name}"
563 redef var c_name
is lazy
do
565 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
566 else if mclass
.intro_mmodule
.mproject
== mmodule
.mproject
and mclass
.visibility
> private_visibility
then
567 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
569 return "{mmodule.c_name}___{mclass.c_name}"
573 redef fun model
do return mmodule
.model
575 # All declared super-types
576 # FIXME: quite ugly but not better idea yet
577 var supertypes
= new Array[MClassType]
579 # Register some super-types for the class (ie "super SomeType")
581 # The hierarchy must not already be set
582 # REQUIRE: `self.in_hierarchy == null`
583 fun set_supertypes
(supertypes
: Array[MClassType])
585 assert unique_invocation
: self.in_hierarchy
== null
586 var mmodule
= self.mmodule
587 var model
= mmodule
.model
588 var mtype
= self.bound_mtype
590 for supertype
in supertypes
do
591 self.supertypes
.add
(supertype
)
593 # Register in full_type_specialization_hierarchy
594 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
595 # Register in intro_type_specialization_hierarchy
596 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
597 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
603 # Collect the super-types (set by set_supertypes) to build the hierarchy
605 # This function can only invoked once by class
606 # REQUIRE: `self.in_hierarchy == null`
607 # ENSURE: `self.in_hierarchy != null`
610 assert unique_invocation
: self.in_hierarchy
== null
611 var model
= mmodule
.model
612 var res
= model
.mclassdef_hierarchy
.add_node
(self)
613 self.in_hierarchy
= res
614 var mtype
= self.bound_mtype
616 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
617 # The simpliest way is to attach it to collect_mclassdefs
618 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
619 res
.poset
.add_edge
(self, mclassdef
)
623 # The view of the class definition in `mclassdef_hierarchy`
624 var in_hierarchy
: nullable POSetElement[MClassDef] = null
626 # Is the definition the one that introduced `mclass`?
627 fun is_intro
: Bool do return mclass
.intro
== self
629 # All properties introduced by the classdef
630 var intro_mproperties
= new Array[MProperty]
632 # All property definitions in the class (introductions and redefinitions)
633 var mpropdefs
= new Array[MPropDef]
636 # A global static type
638 # MType are global to the model; it means that a `MType` is not bound to a
639 # specific `MModule`.
640 # This characteristic helps the reasoning about static types in a program
641 # since a single `MType` object always denote the same type.
643 # However, because a `MType` is global, it does not really have properties
644 # nor have subtypes to a hierarchy since the property and the class hierarchy
645 # depends of a module.
646 # Moreover, virtual types an formal generic parameter types also depends on
647 # a receiver to have sense.
649 # Therefore, most method of the types require a module and an anchor.
650 # The module is used to know what are the classes and the specialization
652 # The anchor is used to know what is the bound of the virtual types and formal
653 # generic parameter types.
655 # MType are not directly usable to get properties. See the `anchor_to` method
656 # and the `MClassType` class.
658 # FIXME: the order of the parameters is not the best. We mus pick on from:
659 # * foo(mmodule, anchor, othertype)
660 # * foo(othertype, anchor, mmodule)
661 # * foo(anchor, mmodule, othertype)
662 # * foo(othertype, mmodule, anchor)
666 redef fun name
do return to_s
668 # Return true if `self` is an subtype of `sup`.
669 # The typing is done using the standard typing policy of Nit.
671 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
672 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
673 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
676 if sub
== sup
then return true
678 #print "1.is {sub} a {sup}? ===="
680 if anchor
== null then
681 assert not sub
.need_anchor
682 assert not sup
.need_anchor
684 # First, resolve the formal types to the simplest equivalent forms in the receiver
685 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
686 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
687 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
688 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
691 # Does `sup` accept null or not?
692 # Discard the nullable marker if it exists
693 var sup_accept_null
= false
694 if sup
isa MNullableType then
695 sup_accept_null
= true
697 else if sup
isa MNullType then
698 sup_accept_null
= true
701 # Can `sub` provide null or not?
702 # Thus we can match with `sup_accept_null`
703 # Also discard the nullable marker if it exists
704 if sub
isa MNullableType then
705 if not sup_accept_null
then return false
707 else if sub
isa MNullType then
708 return sup_accept_null
710 # Now the case of direct null and nullable is over.
712 # If `sub` is a formal type, then it is accepted if its bound is accepted
713 while sub
isa MParameterType or sub
isa MVirtualType do
714 #print "3.is {sub} a {sup}?"
716 # A unfixed formal type can only accept itself
717 if sub
== sup
then return true
719 assert anchor
!= null
720 sub
= sub
.lookup_bound
(mmodule
, anchor
)
722 #print "3.is {sub} a {sup}?"
724 # Manage the second layer of null/nullable
725 if sub
isa MNullableType then
726 if not sup_accept_null
then return false
728 else if sub
isa MNullType then
729 return sup_accept_null
732 #print "4.is {sub} a {sup}? <- no more resolution"
734 assert sub
isa MClassType # It is the only remaining type
736 # A unfixed formal type can only accept itself
737 if sup
isa MParameterType or sup
isa MVirtualType then
741 if sup
isa MNullType then
742 # `sup` accepts only null
746 assert sup
isa MClassType # It is the only remaining type
748 # Now both are MClassType, we need to dig
750 if sub
== sup
then return true
752 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
753 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
754 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
755 if res
== false then return false
756 if not sup
isa MGenericType then return true
757 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
758 assert sub2
.mclass
== sup
.mclass
759 for i
in [0..sup
.mclass
.arity
[ do
760 var sub_arg
= sub2
.arguments
[i
]
761 var sup_arg
= sup
.arguments
[i
]
762 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
763 if res
== false then return false
768 # The base class type on which self is based
770 # This base type is used to get property (an internally to perform
771 # unsafe type comparison).
773 # Beware: some types (like null) are not based on a class thus this
776 # Basically, this function transform the virtual types and parameter
777 # types to their bounds.
782 # class B super A end
784 # class Y super X end
793 # Map[T,U] anchor_to H #-> Map[B,Y]
795 # Explanation of the example:
796 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
797 # because "redef type U: Y". Therefore, Map[T, U] is bound to
800 # ENSURE: `not self.need_anchor implies result == self`
801 # ENSURE: `not result.need_anchor`
802 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
804 if not need_anchor
then return self
805 assert not anchor
.need_anchor
806 # Just resolve to the anchor and clear all the virtual types
807 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
808 assert not res
.need_anchor
812 # Does `self` contain a virtual type or a formal generic parameter type?
813 # In order to remove those types, you usually want to use `anchor_to`.
814 fun need_anchor
: Bool do return true
816 # Return the supertype when adapted to a class.
818 # In Nit, for each super-class of a type, there is a equivalent super-type.
824 # class H[V] super G[V, Bool] end
826 # H[Int] supertype_to G #-> G[Int, Bool]
829 # REQUIRE: `super_mclass` is a super-class of `self`
830 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
831 # ENSURE: `result.mclass = super_mclass`
832 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
834 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
835 if self isa MClassType and self.mclass
== super_mclass
then return self
837 if self.need_anchor
then
838 assert anchor
!= null
839 resolved_self
= self.anchor_to
(mmodule
, anchor
)
843 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
844 for supertype
in supertypes
do
845 if supertype
.mclass
== super_mclass
then
846 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
847 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
853 # Replace formals generic types in self with resolved values in `mtype`
854 # If `cleanup_virtual` is true, then virtual types are also replaced
857 # This function returns self if `need_anchor` is false.
863 # class H[F] super G[F] end
867 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
868 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
870 # Explanation of the example:
871 # * Array[E].need_anchor is true because there is a formal generic parameter type E
872 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
873 # * Since "H[F] super G[F]", E is in fact F for H
874 # * More specifically, in H[Int], E is Int
875 # * So, in H[Int], Array[E] is Array[Int]
877 # This function is mainly used to inherit a signature.
878 # Because, unlike `anchor_to`, we do not want a full resolution of
879 # a type but only an adapted version of it.
885 # fun foo(e:E):E is abstract
887 # class B super A[Int] end
890 # The signature on foo is (e: E): E
891 # If we resolve the signature for B, we get (e:Int):Int
897 # fun foo(e:E):E is abstract
901 # fun bar do a.foo(x) # <- x is here
905 # The first question is: is foo available on `a`?
907 # The static type of a is `A[Array[F]]`, that is an open type.
908 # in order to find a method `foo`, whe must look at a resolved type.
910 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
912 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
914 # The next question is: what is the accepted types for `x`?
916 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
918 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
920 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
922 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
923 # two function instead of one seems also to be a bad idea.
925 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
926 # ENSURE: `not self.need_anchor implies result == self`
927 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
929 # Resolve formal type to its verbatim bound.
930 # If the type is not formal, just return self
932 # The result is returned exactly as declared in the "type" property (verbatim).
933 # So it could be another formal type.
935 # In case of conflict, the method aborts.
936 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
938 # Resolve the formal type to its simplest equivalent form.
940 # Formal types are either free or fixed.
941 # When it is fixed, it means that it is equivalent with a simpler type.
942 # When a formal type is free, it means that it is only equivalent with itself.
943 # This method return the most simple equivalent type of `self`.
945 # This method is mainly used for subtype test in order to sanely compare fixed.
947 # By default, return self.
948 # See the redefinitions for specific behavior in each kind of type.
949 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
951 # Can the type be resolved?
953 # In order to resolve open types, the formal types must make sence.
963 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
965 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
967 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
968 # # B[E] is a red hearing only the E is important,
969 # # E make sense in A
972 # REQUIRE: `anchor != null implies not anchor.need_anchor`
973 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
974 # ENSURE: `not self.need_anchor implies result == true`
975 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
977 # Return the nullable version of the type
978 # If the type is already nullable then self is returned
979 fun as_nullable
: MType
981 var res
= self.as_nullable_cache
982 if res
!= null then return res
983 res
= new MNullableType(self)
984 self.as_nullable_cache
= res
988 # Return the not nullable version of the type
989 # Is the type is already not nullable, then self is returned.
991 # Note: this just remove the `nullable` notation, but the result can still contains null.
992 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
993 fun as_notnullable
: MType
998 private var as_nullable_cache
: nullable MType = null
1001 # The depth of the type seen as a tree.
1008 # Formal types have a depth of 1.
1014 # The length of the type seen as a tree.
1021 # Formal types have a length of 1.
1027 # Compute all the classdefs inherited/imported.
1028 # The returned set contains:
1029 # * the class definitions from `mmodule` and its imported modules
1030 # * the class definitions of this type and its super-types
1032 # This function is used mainly internally.
1034 # REQUIRE: `not self.need_anchor`
1035 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1037 # Compute all the super-classes.
1038 # This function is used mainly internally.
1040 # REQUIRE: `not self.need_anchor`
1041 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1043 # Compute all the declared super-types.
1044 # Super-types are returned as declared in the classdefs (verbatim).
1045 # This function is used mainly internally.
1047 # REQUIRE: `not self.need_anchor`
1048 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1050 # Is the property in self for a given module
1051 # This method does not filter visibility or whatever
1053 # REQUIRE: `not self.need_anchor`
1054 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1056 assert not self.need_anchor
1057 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1061 # A type based on a class.
1063 # `MClassType` have properties (see `has_mproperty`).
1067 # The associated class
1070 redef fun model
do return self.mclass
.intro_mmodule
.model
1072 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1074 # The formal arguments of the type
1075 # ENSURE: `result.length == self.mclass.arity`
1076 var arguments
= new Array[MType]
1078 redef fun to_s
do return mclass
.to_s
1080 redef fun full_name
do return mclass
.full_name
1082 redef fun c_name
do return mclass
.c_name
1084 redef fun need_anchor
do return false
1086 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1088 return super.as(MClassType)
1091 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1093 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1095 redef fun collect_mclassdefs
(mmodule
)
1097 assert not self.need_anchor
1098 var cache
= self.collect_mclassdefs_cache
1099 if not cache
.has_key
(mmodule
) then
1100 self.collect_things
(mmodule
)
1102 return cache
[mmodule
]
1105 redef fun collect_mclasses
(mmodule
)
1107 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1108 assert not self.need_anchor
1109 var cache
= self.collect_mclasses_cache
1110 if not cache
.has_key
(mmodule
) then
1111 self.collect_things
(mmodule
)
1113 var res
= cache
[mmodule
]
1114 collect_mclasses_last_module
= mmodule
1115 collect_mclasses_last_module_cache
= res
1119 private var collect_mclasses_last_module
: nullable MModule = null
1120 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1122 redef fun collect_mtypes
(mmodule
)
1124 assert not self.need_anchor
1125 var cache
= self.collect_mtypes_cache
1126 if not cache
.has_key
(mmodule
) then
1127 self.collect_things
(mmodule
)
1129 return cache
[mmodule
]
1132 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1133 private fun collect_things
(mmodule
: MModule)
1135 var res
= new HashSet[MClassDef]
1136 var seen
= new HashSet[MClass]
1137 var types
= new HashSet[MClassType]
1138 seen
.add
(self.mclass
)
1139 var todo
= [self.mclass
]
1140 while not todo
.is_empty
do
1141 var mclass
= todo
.pop
1142 #print "process {mclass}"
1143 for mclassdef
in mclass
.mclassdefs
do
1144 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1145 #print " process {mclassdef}"
1147 for supertype
in mclassdef
.supertypes
do
1148 types
.add
(supertype
)
1149 var superclass
= supertype
.mclass
1150 if seen
.has
(superclass
) then continue
1151 #print " add {superclass}"
1152 seen
.add
(superclass
)
1153 todo
.add
(superclass
)
1157 collect_mclassdefs_cache
[mmodule
] = res
1158 collect_mclasses_cache
[mmodule
] = seen
1159 collect_mtypes_cache
[mmodule
] = types
1162 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1163 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1164 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1168 # A type based on a generic class.
1169 # A generic type a just a class with additional formal generic arguments.
1175 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1179 assert self.mclass
.arity
== arguments
.length
1181 self.need_anchor
= false
1182 for t
in arguments
do
1183 if t
.need_anchor
then
1184 self.need_anchor
= true
1189 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1192 # The short-name of the class, then the full-name of each type arguments within brackets.
1193 # Example: `"Map[String, List[Int]]"`
1194 redef var to_s
: String is noinit
1196 # The full-name of the class, then the full-name of each type arguments within brackets.
1197 # Example: `"standard::Map[standard::String, standard::List[standard::Int]]"`
1198 redef var full_name
is lazy
do
1199 var args
= new Array[String]
1200 for t
in arguments
do
1201 args
.add t
.full_name
1203 return "{mclass.full_name}[{args.join(", ")}]"
1206 redef var c_name
is lazy
do
1207 var res
= mclass
.c_name
1208 # Note: because the arity is known, a prefix notation is enough
1209 for t
in arguments
do
1216 redef var need_anchor
: Bool is noinit
1218 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1220 if not need_anchor
then return self
1221 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1222 var types
= new Array[MType]
1223 for t
in arguments
do
1224 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1226 return mclass
.get_mtype
(types
)
1229 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1231 if not need_anchor
then return true
1232 for t
in arguments
do
1233 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1242 for a
in self.arguments
do
1244 if d
> dmax
then dmax
= d
1252 for a
in self.arguments
do
1259 # A virtual formal type.
1263 # The property associated with the type.
1264 # Its the definitions of this property that determine the bound or the virtual type.
1265 var mproperty
: MVirtualTypeProp
1267 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1269 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1271 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
.as(not null)
1274 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1276 assert not resolved_receiver
.need_anchor
1277 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1278 if props
.is_empty
then
1280 else if props
.length
== 1 then
1283 var types
= new ArraySet[MType]
1284 var res
= props
.first
1286 types
.add
(p
.bound
.as(not null))
1287 if not res
.is_fixed
then res
= p
1289 if types
.length
== 1 then
1295 # A VT is fixed when:
1296 # * the VT is (re-)defined with the annotation `is fixed`
1297 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1298 # * the receiver is an enum class since there is no subtype possible
1299 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1301 assert not resolved_receiver
.need_anchor
1302 resolved_receiver
= resolved_receiver
.as_notnullable
1303 assert resolved_receiver
isa MClassType # It is the only remaining type
1305 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1306 var res
= prop
.bound
.as(not null)
1308 # Recursively lookup the fixed result
1309 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1311 # 1. For a fixed VT, return the resolved bound
1312 if prop
.is_fixed
then return res
1314 # 2. For a enum boud, return the bound
1315 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1317 # 3. for a enum receiver return the bound
1318 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1323 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1325 if not cleanup_virtual
then return self
1326 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1327 # self is a virtual type declared (or inherited) in mtype
1328 # The point of the function it to get the bound of the virtual type that make sense for mtype
1329 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1330 #print "{class_name}: {self}/{mtype}/{anchor}?"
1331 var resolved_receiver
1332 if mtype
.need_anchor
then
1333 assert anchor
!= null
1334 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1336 resolved_receiver
= mtype
1338 # Now, we can get the bound
1339 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1340 # The bound is exactly as declared in the "type" property, so we must resolve it again
1341 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1346 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1348 if mtype
.need_anchor
then
1349 assert anchor
!= null
1350 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1352 return mtype
.has_mproperty
(mmodule
, mproperty
)
1355 redef fun to_s
do return self.mproperty
.to_s
1357 redef fun full_name
do return self.mproperty
.full_name
1359 redef fun c_name
do return self.mproperty
.c_name
1362 # The type associated to a formal parameter generic type of a class
1364 # Each parameter type is associated to a specific class.
1365 # It means that all refinements of a same class "share" the parameter type,
1366 # but that a generic subclass has its own parameter types.
1368 # However, in the sense of the meta-model, a parameter type of a class is
1369 # a valid type in a subclass. The "in the sense of the meta-model" is
1370 # important because, in the Nit language, the programmer cannot refers
1371 # directly to the parameter types of the super-classes.
1376 # fun e: E is abstract
1382 # In the class definition B[F], `F` is a valid type but `E` is not.
1383 # However, `self.e` is a valid method call, and the signature of `e` is
1386 # Note that parameter types are shared among class refinements.
1387 # Therefore parameter only have an internal name (see `to_s` for details).
1388 class MParameterType
1391 # The generic class where the parameter belong
1394 redef fun model
do return self.mclass
.intro_mmodule
.model
1396 # The position of the parameter (0 for the first parameter)
1397 # FIXME: is `position` a better name?
1402 redef fun to_s
do return name
1404 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1406 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1408 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1410 assert not resolved_receiver
.need_anchor
1411 resolved_receiver
= resolved_receiver
.as_notnullable
1412 assert resolved_receiver
isa MClassType # It is the only remaining type
1413 var goalclass
= self.mclass
1414 if resolved_receiver
.mclass
== goalclass
then
1415 return resolved_receiver
.arguments
[self.rank
]
1417 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1418 for t
in supertypes
do
1419 if t
.mclass
== goalclass
then
1420 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1421 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1422 var res
= t
.arguments
[self.rank
]
1429 # A PT is fixed when:
1430 # * Its bound is a enum class (see `enum_kind`).
1431 # The PT is just useless, but it is still a case.
1432 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1433 # so it is necessarily fixed in a `super` clause, either with a normal type
1434 # or with another PT.
1435 # See `resolve_for` for examples about related issues.
1436 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1438 assert not resolved_receiver
.need_anchor
1439 resolved_receiver
= resolved_receiver
.as_notnullable
1440 assert resolved_receiver
isa MClassType # It is the only remaining type
1441 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1445 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1447 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1448 #print "{class_name}: {self}/{mtype}/{anchor}?"
1450 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1451 var res
= mtype
.arguments
[self.rank
]
1452 if anchor
!= null and res
.need_anchor
then
1453 # Maybe the result can be resolved more if are bound to a final class
1454 var r2
= res
.anchor_to
(mmodule
, anchor
)
1455 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1460 # self is a parameter type of mtype (or of a super-class of mtype)
1461 # The point of the function it to get the bound of the virtual type that make sense for mtype
1462 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1463 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1464 var resolved_receiver
1465 if mtype
.need_anchor
then
1466 assert anchor
!= null
1467 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1469 resolved_receiver
= mtype
1471 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1472 if resolved_receiver
isa MParameterType then
1473 assert resolved_receiver
.mclass
== anchor
.mclass
1474 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1475 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1477 assert resolved_receiver
isa MClassType # It is the only remaining type
1479 # Eh! The parameter is in the current class.
1480 # So we return the corresponding argument, no mater what!
1481 if resolved_receiver
.mclass
== self.mclass
then
1482 var res
= resolved_receiver
.arguments
[self.rank
]
1483 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1487 if resolved_receiver
.need_anchor
then
1488 assert anchor
!= null
1489 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1491 # Now, we can get the bound
1492 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1493 # The bound is exactly as declared in the "type" property, so we must resolve it again
1494 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1496 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1501 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1503 if mtype
.need_anchor
then
1504 assert anchor
!= null
1505 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1507 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1511 # A type prefixed with "nullable"
1515 # The base type of the nullable type
1518 redef fun model
do return self.mtype
.model
1522 self.to_s
= "nullable {mtype}"
1525 redef var to_s
: String is noinit
1527 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1529 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1531 redef fun need_anchor
do return mtype
.need_anchor
1532 redef fun as_nullable
do return self
1533 redef fun as_notnullable
do return mtype
1534 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1536 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1537 return res
.as_nullable
1540 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1542 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1545 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1546 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1548 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1549 if t
== mtype
then return self
1550 return t
.as_nullable
1553 redef fun depth
do return self.mtype
.depth
1555 redef fun length
do return self.mtype
.length
1557 redef fun collect_mclassdefs
(mmodule
)
1559 assert not self.need_anchor
1560 return self.mtype
.collect_mclassdefs
(mmodule
)
1563 redef fun collect_mclasses
(mmodule
)
1565 assert not self.need_anchor
1566 return self.mtype
.collect_mclasses
(mmodule
)
1569 redef fun collect_mtypes
(mmodule
)
1571 assert not self.need_anchor
1572 return self.mtype
.collect_mtypes
(mmodule
)
1576 # The type of the only value null
1578 # The is only one null type per model, see `MModel::null_type`.
1581 redef var model
: Model
1582 redef fun to_s
do return "null"
1583 redef fun full_name
do return "null"
1584 redef fun c_name
do return "null"
1585 redef fun as_nullable
do return self
1586 redef fun need_anchor
do return false
1587 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1588 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1590 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1592 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1594 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1597 # A signature of a method
1601 # The each parameter (in order)
1602 var mparameters
: Array[MParameter]
1604 # The return type (null for a procedure)
1605 var return_mtype
: nullable MType
1610 var t
= self.return_mtype
1611 if t
!= null then dmax
= t
.depth
1612 for p
in mparameters
do
1613 var d
= p
.mtype
.depth
1614 if d
> dmax
then dmax
= d
1622 var t
= self.return_mtype
1623 if t
!= null then res
+= t
.length
1624 for p
in mparameters
do
1625 res
+= p
.mtype
.length
1630 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1633 var vararg_rank
= -1
1634 for i
in [0..mparameters
.length
[ do
1635 var parameter
= mparameters
[i
]
1636 if parameter
.is_vararg
then
1637 assert vararg_rank
== -1
1641 self.vararg_rank
= vararg_rank
1644 # The rank of the ellipsis (`...`) for vararg (starting from 0).
1645 # value is -1 if there is no vararg.
1646 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1647 var vararg_rank
: Int is noinit
1649 # The number or parameters
1650 fun arity
: Int do return mparameters
.length
1654 var b
= new FlatBuffer
1655 if not mparameters
.is_empty
then
1657 for i
in [0..mparameters
.length
[ do
1658 var mparameter
= mparameters
[i
]
1659 if i
> 0 then b
.append
(", ")
1660 b
.append
(mparameter
.name
)
1662 b
.append
(mparameter
.mtype
.to_s
)
1663 if mparameter
.is_vararg
then
1669 var ret
= self.return_mtype
1677 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1679 var params
= new Array[MParameter]
1680 for p
in self.mparameters
do
1681 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1683 var ret
= self.return_mtype
1685 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1687 var res
= new MSignature(params
, ret
)
1692 # A parameter in a signature
1696 # The name of the parameter
1697 redef var name
: String
1699 # The static type of the parameter
1702 # Is the parameter a vararg?
1708 return "{name}: {mtype}..."
1710 return "{name}: {mtype}"
1714 # Returns a new parameter with the `mtype` resolved.
1715 # See `MType::resolve_for` for details.
1716 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1718 if not self.mtype
.need_anchor
then return self
1719 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1720 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1724 redef fun model
do return mtype
.model
1727 # A service (global property) that generalize method, attribute, etc.
1729 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1730 # to a specific `MModule` nor a specific `MClass`.
1732 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1733 # and the other in subclasses and in refinements.
1735 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1736 # of any dynamic type).
1737 # For instance, a call site "x.foo" is associated to a `MProperty`.
1738 abstract class MProperty
1741 # The associated MPropDef subclass.
1742 # The two specialization hierarchy are symmetric.
1743 type MPROPDEF: MPropDef
1745 # The classdef that introduce the property
1746 # While a property is not bound to a specific module, or class,
1747 # the introducing mclassdef is used for naming and visibility
1748 var intro_mclassdef
: MClassDef
1750 # The (short) name of the property
1751 redef var name
: String
1753 # The canonical name of the property.
1755 # It is the short-`name` prefixed by the short-name of the class and the full-name of the module.
1756 # Example: "my_project::my_module::MyClass::my_method"
1757 redef var full_name
is lazy
do
1758 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
1761 redef var c_name
is lazy
do
1762 # FIXME use `namespace_for`
1763 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
1766 # The visibility of the property
1767 var visibility
: MVisibility
1769 # Is the property usable as an initializer?
1770 var is_autoinit
= false is writable
1774 intro_mclassdef
.intro_mproperties
.add
(self)
1775 var model
= intro_mclassdef
.mmodule
.model
1776 model
.mproperties_by_name
.add_one
(name
, self)
1777 model
.mproperties
.add
(self)
1780 # All definitions of the property.
1781 # The first is the introduction,
1782 # The other are redefinitions (in refinements and in subclasses)
1783 var mpropdefs
= new Array[MPROPDEF]
1785 # The definition that introduces the property.
1787 # Warning: such a definition may not exist in the early life of the object.
1788 # In this case, the method will abort.
1789 var intro
: MPROPDEF is noinit
1791 redef fun model
do return intro
.model
1794 redef fun to_s
do return name
1796 # Return the most specific property definitions defined or inherited by a type.
1797 # The selection knows that refinement is stronger than specialization;
1798 # however, in case of conflict more than one property are returned.
1799 # If mtype does not know mproperty then an empty array is returned.
1801 # If you want the really most specific property, then look at `lookup_first_definition`
1803 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1804 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
1805 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1807 assert not mtype
.need_anchor
1808 mtype
= mtype
.as_notnullable
1810 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1811 if cache
!= null then return cache
1813 #print "select prop {mproperty} for {mtype} in {self}"
1814 # First, select all candidates
1815 var candidates
= new Array[MPROPDEF]
1816 for mpropdef
in self.mpropdefs
do
1817 # If the definition is not imported by the module, then skip
1818 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1819 # If the definition is not inherited by the type, then skip
1820 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1822 candidates
.add
(mpropdef
)
1824 # Fast track for only one candidate
1825 if candidates
.length
<= 1 then
1826 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1830 # Second, filter the most specific ones
1831 return select_most_specific
(mmodule
, candidates
)
1834 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1836 # Return the most specific property definitions inherited by a type.
1837 # The selection knows that refinement is stronger than specialization;
1838 # however, in case of conflict more than one property are returned.
1839 # If mtype does not know mproperty then an empty array is returned.
1841 # If you want the really most specific property, then look at `lookup_next_definition`
1843 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1844 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
1845 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1847 assert not mtype
.need_anchor
1848 mtype
= mtype
.as_notnullable
1850 # First, select all candidates
1851 var candidates
= new Array[MPROPDEF]
1852 for mpropdef
in self.mpropdefs
do
1853 # If the definition is not imported by the module, then skip
1854 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1855 # If the definition is not inherited by the type, then skip
1856 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1857 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1858 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1860 candidates
.add
(mpropdef
)
1862 # Fast track for only one candidate
1863 if candidates
.length
<= 1 then return candidates
1865 # Second, filter the most specific ones
1866 return select_most_specific
(mmodule
, candidates
)
1869 # Return an array containing olny the most specific property definitions
1870 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
1871 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
1873 var res
= new Array[MPROPDEF]
1874 for pd1
in candidates
do
1875 var cd1
= pd1
.mclassdef
1878 for pd2
in candidates
do
1879 if pd2
== pd1
then continue # do not compare with self!
1880 var cd2
= pd2
.mclassdef
1882 if c2
.mclass_type
== c1
.mclass_type
then
1883 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
1884 # cd2 refines cd1; therefore we skip pd1
1888 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
1889 # cd2 < cd1; therefore we skip pd1
1898 if res
.is_empty
then
1899 print
"All lost! {candidates.join(", ")}"
1900 # FIXME: should be abort!
1905 # Return the most specific definition in the linearization of `mtype`.
1907 # If you want to know the next properties in the linearization,
1908 # look at `MPropDef::lookup_next_definition`.
1910 # FIXME: the linearization is still unspecified
1912 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1913 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1914 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1916 return lookup_all_definitions
(mmodule
, mtype
).first
1919 # Return all definitions in a linearization order
1920 # Most specific first, most general last
1922 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
1923 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
1924 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1926 mtype
= mtype
.as_notnullable
1928 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1929 if cache
!= null then return cache
1931 assert not mtype
.need_anchor
1932 assert mtype
.has_mproperty
(mmodule
, self)
1934 #print "select prop {mproperty} for {mtype} in {self}"
1935 # First, select all candidates
1936 var candidates
= new Array[MPROPDEF]
1937 for mpropdef
in self.mpropdefs
do
1938 # If the definition is not imported by the module, then skip
1939 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1940 # If the definition is not inherited by the type, then skip
1941 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1943 candidates
.add
(mpropdef
)
1945 # Fast track for only one candidate
1946 if candidates
.length
<= 1 then
1947 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1951 mmodule
.linearize_mpropdefs
(candidates
)
1952 candidates
= candidates
.reversed
1953 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1957 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
1964 redef type MPROPDEF: MMethodDef
1966 # Is the property defined at the top_level of the module?
1967 # Currently such a property are stored in `Object`
1968 var is_toplevel
: Bool = false is writable
1970 # Is the property a constructor?
1971 # Warning, this property can be inherited by subclasses with or without being a constructor
1972 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
1973 var is_init
: Bool = false is writable
1975 # The constructor is a (the) root init with empty signature but a set of initializers
1976 var is_root_init
: Bool = false is writable
1978 # Is the property a 'new' constructor?
1979 var is_new
: Bool = false is writable
1981 # Is the property a legal constructor for a given class?
1982 # As usual, visibility is not considered.
1983 # FIXME not implemented
1984 fun is_init_for
(mclass
: MClass): Bool
1990 # A global attribute
1994 redef type MPROPDEF: MAttributeDef
1998 # A global virtual type
1999 class MVirtualTypeProp
2002 redef type MPROPDEF: MVirtualTypeDef
2004 # The formal type associated to the virtual type property
2005 var mvirtualtype
= new MVirtualType(self)
2008 # A definition of a property (local property)
2010 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2011 # specific class definition (which belong to a specific module)
2012 abstract class MPropDef
2015 # The associated `MProperty` subclass.
2016 # the two specialization hierarchy are symmetric
2017 type MPROPERTY: MProperty
2020 type MPROPDEF: MPropDef
2022 # The class definition where the property definition is
2023 var mclassdef
: MClassDef
2025 # The associated global property
2026 var mproperty
: MPROPERTY
2028 # The origin of the definition
2029 var location
: Location
2033 mclassdef
.mpropdefs
.add
(self)
2034 mproperty
.mpropdefs
.add
(self)
2035 if mproperty
.intro_mclassdef
== mclassdef
then
2036 assert not isset mproperty
._intro
2037 mproperty
.intro
= self
2039 self.to_s
= "{mclassdef}#{mproperty}"
2042 # Actually the name of the `mproperty`
2043 redef fun name
do return mproperty
.name
2045 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2047 # Therefore the combination of identifiers is awful,
2048 # the worst case being
2050 # * a property "p::m::A::x"
2051 # * redefined in a refinement of a class "q::n::B"
2052 # * in a module "r::o"
2053 # * so "r::o#q::n::B#p::m::A::x"
2055 # Fortunately, the full-name is simplified when entities are repeated.
2056 # For the previous case, the simplest form is "p#A#x".
2057 redef var full_name
is lazy
do
2058 var res
= new FlatBuffer
2060 # The first part is the mclassdef. Worst case is "r::o#q::n::B"
2061 res
.append mclassdef
.full_name
2065 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2066 # intro are unambiguous in a class
2069 # Just try to simplify each part
2070 if mclassdef
.mmodule
.mproject
!= mproperty
.intro_mclassdef
.mmodule
.mproject
then
2071 # precise "p::m" only if "p" != "r"
2072 res
.append mproperty
.intro_mclassdef
.mmodule
.full_name
2074 else if mproperty
.visibility
<= private_visibility
then
2075 # Same project ("p"=="q"), but private visibility,
2076 # does the module part ("::m") need to be displayed
2077 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mproject
then
2079 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2083 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2084 # precise "B" only if not the same class than "A"
2085 res
.append mproperty
.intro_mclassdef
.name
2088 # Always use the property name "x"
2089 res
.append mproperty
.name
2094 redef var c_name
is lazy
do
2095 var res
= new FlatBuffer
2096 res
.append mclassdef
.c_name
2098 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2099 res
.append name
.to_cmangle
2101 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2102 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2105 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2106 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2109 res
.append mproperty
.name
.to_cmangle
2114 redef fun model
do return mclassdef
.model
2116 # Internal name combining the module, the class and the property
2117 # Example: "mymodule#MyClass#mymethod"
2118 redef var to_s
: String is noinit
2120 # Is self the definition that introduce the property?
2121 fun is_intro
: Bool do return mproperty
.intro
== self
2123 # Return the next definition in linearization of `mtype`.
2125 # This method is used to determine what method is called by a super.
2127 # REQUIRE: `not mtype.need_anchor`
2128 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2130 assert not mtype
.need_anchor
2132 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2133 var i
= mpropdefs
.iterator
2134 while i
.is_ok
and i
.item
!= self do i
.next
2135 assert has_property
: i
.is_ok
2137 assert has_next_property
: i
.is_ok
2142 # A local definition of a method
2146 redef type MPROPERTY: MMethod
2147 redef type MPROPDEF: MMethodDef
2149 # The signature attached to the property definition
2150 var msignature
: nullable MSignature = null is writable
2152 # The signature attached to the `new` call on a root-init
2153 # This is a concatenation of the signatures of the initializers
2155 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2156 var new_msignature
: nullable MSignature = null is writable
2158 # List of initialisers to call in root-inits
2160 # They could be setters or attributes
2162 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2163 var initializers
= new Array[MProperty]
2165 # Is the method definition abstract?
2166 var is_abstract
: Bool = false is writable
2168 # Is the method definition intern?
2169 var is_intern
= false is writable
2171 # Is the method definition extern?
2172 var is_extern
= false is writable
2174 # An optional constant value returned in functions.
2176 # Only some specific primitife value are accepted by engines.
2177 # Is used when there is no better implementation available.
2179 # Currently used only for the implementation of the `--define`
2180 # command-line option.
2181 # SEE: module `mixin`.
2182 var constant_value
: nullable Object = null is writable
2185 # A local definition of an attribute
2189 redef type MPROPERTY: MAttribute
2190 redef type MPROPDEF: MAttributeDef
2192 # The static type of the attribute
2193 var static_mtype
: nullable MType = null is writable
2196 # A local definition of a virtual type
2197 class MVirtualTypeDef
2200 redef type MPROPERTY: MVirtualTypeProp
2201 redef type MPROPDEF: MVirtualTypeDef
2203 # The bound of the virtual type
2204 var bound
: nullable MType = null is writable
2206 # Is the bound fixed?
2207 var is_fixed
= false is writable
2214 # * `interface_kind`
2218 # Note this class is basically an enum.
2219 # FIXME: use a real enum once user-defined enums are available
2221 redef var to_s
: String
2223 # Is a constructor required?
2226 # TODO: private init because enumeration.
2228 # Can a class of kind `self` specializes a class of kine `other`?
2229 fun can_specialize
(other
: MClassKind): Bool
2231 if other
== interface_kind
then return true # everybody can specialize interfaces
2232 if self == interface_kind
or self == enum_kind
then
2233 # no other case for interfaces
2235 else if self == extern_kind
then
2236 # only compatible with themselves
2237 return self == other
2238 else if other
== enum_kind
or other
== extern_kind
then
2239 # abstract_kind and concrete_kind are incompatible
2242 # remain only abstract_kind and concrete_kind
2247 # The class kind `abstract`
2248 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2249 # The class kind `concrete`
2250 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2251 # The class kind `interface`
2252 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2253 # The class kind `enum`
2254 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2255 # The class kind `extern`
2256 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)