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
34 # The visibility of the MEntity.
36 # MPackages, MGroups and MModules are always public.
37 # The visibility of `MClass` and `MProperty` is defined by the keyword used.
38 # `MClassDef` and `MPropDef` return the visibility of `MClass` and `MProperty`.
39 fun visibility
: MVisibility do return public_visibility
44 var mclasses
= new Array[MClass]
46 # All known properties
47 var mproperties
= new Array[MProperty]
49 # Hierarchy of class definition.
51 # Each classdef is associated with its super-classdefs in regard to
52 # its module of definition.
53 var mclassdef_hierarchy
= new POSet[MClassDef]
55 # Class-type hierarchy restricted to the introduction.
57 # The idea is that what is true on introduction is always true whatever
58 # the module considered.
59 # Therefore, this hierarchy is used for a fast positive subtype check.
61 # This poset will evolve in a monotonous way:
62 # * Two non connected nodes will remain unconnected
63 # * New nodes can appear with new edges
64 private var intro_mtype_specialization_hierarchy
= new POSet[MClassType]
66 # Global overlapped class-type hierarchy.
67 # The hierarchy when all modules are combined.
68 # Therefore, this hierarchy is used for a fast negative subtype check.
70 # This poset will evolve in an anarchic way. Loops can even be created.
72 # FIXME decide what to do on loops
73 private var full_mtype_specialization_hierarchy
= new POSet[MClassType]
75 # Collections of classes grouped by their short name
76 private var mclasses_by_name
= new MultiHashMap[String, MClass]
78 # Return all classes named `name`.
80 # If such a class does not exist, null is returned
81 # (instead of an empty array)
83 # Visibility or modules are not considered
84 fun get_mclasses_by_name
(name
: String): nullable Array[MClass]
86 return mclasses_by_name
.get_or_null
(name
)
89 # Collections of properties grouped by their short name
90 private var mproperties_by_name
= new MultiHashMap[String, MProperty]
92 # Return all properties named `name`.
94 # If such a property does not exist, null is returned
95 # (instead of an empty array)
97 # Visibility or modules are not considered
98 fun get_mproperties_by_name
(name
: String): nullable Array[MProperty]
100 return mproperties_by_name
.get_or_null
(name
)
104 var null_type
= new MNullType(self)
106 # Build an ordered tree with from `concerns`
107 fun concerns_tree
(mconcerns
: Collection[MConcern]): ConcernsTree do
108 var seen
= new HashSet[MConcern]
109 var res
= new ConcernsTree
111 var todo
= new Array[MConcern]
112 todo
.add_all mconcerns
114 while not todo
.is_empty
do
116 if seen
.has
(c
) then continue
117 var pc
= c
.parent_concern
131 # An OrderedTree bound to MEntity.
133 # We introduce a new class so it can be easily refined by tools working
136 super OrderedTree[MEntity]
139 # A MEntityTree borned to MConcern.
141 # TODO remove when nitdoc is fully merged with model_collect
143 super OrderedTree[MConcern]
147 # All the classes introduced in the module
148 var intro_mclasses
= new Array[MClass]
150 # All the class definitions of the module
151 # (introduction and refinement)
152 var mclassdefs
= new Array[MClassDef]
154 # Does the current module has a given class `mclass`?
155 # Return true if the mmodule introduces, refines or imports a class.
156 # Visibility is not considered.
157 fun has_mclass
(mclass
: MClass): Bool
159 return self.in_importation
<= mclass
.intro_mmodule
162 # Full hierarchy of introduced and imported classes.
164 # Create a new hierarchy got by flattening the classes for the module
165 # and its imported modules.
166 # Visibility is not considered.
168 # Note: this function is expensive and is usually used for the main
169 # module of a program only. Do not use it to do you own subtype
171 fun flatten_mclass_hierarchy
: POSet[MClass]
173 var res
= self.flatten_mclass_hierarchy_cache
174 if res
!= null then return res
175 res
= new POSet[MClass]
176 for m
in self.in_importation
.greaters
do
177 for cd
in m
.mclassdefs
do
180 for s
in cd
.supertypes
do
181 res
.add_edge
(c
, s
.mclass
)
185 self.flatten_mclass_hierarchy_cache
= res
189 # Sort a given array of classes using the linearization order of the module
190 # The most general is first, the most specific is last
191 fun linearize_mclasses
(mclasses
: Array[MClass])
193 self.flatten_mclass_hierarchy
.sort
(mclasses
)
196 # Sort a given array of class definitions using the linearization order of the module
197 # the refinement link is stronger than the specialisation link
198 # The most general is first, the most specific is last
199 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
201 var sorter
= new MClassDefSorter(self)
202 sorter
.sort
(mclassdefs
)
205 # Sort a given array of property definitions using the linearization order of the module
206 # the refinement link is stronger than the specialisation link
207 # The most general is first, the most specific is last
208 fun linearize_mpropdefs
(mpropdefs
: Array[MPropDef])
210 var sorter
= new MPropDefSorter(self)
211 sorter
.sort
(mpropdefs
)
214 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
216 # The primitive type `Object`, the root of the class hierarchy
217 var object_type
: MClassType = self.get_primitive_class
("Object").mclass_type
is lazy
219 # The type `Pointer`, super class to all extern classes
220 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
222 # The primitive type `Bool`
223 var bool_type
: MClassType = self.get_primitive_class
("Bool").mclass_type
is lazy
225 # The primitive type `Int`
226 var int_type
: MClassType = self.get_primitive_class
("Int").mclass_type
is lazy
228 # The primitive type `Byte`
229 var byte_type
: MClassType = self.get_primitive_class
("Byte").mclass_type
is lazy
231 # The primitive type `Int8`
232 var int8_type
: MClassType = self.get_primitive_class
("Int8").mclass_type
is lazy
234 # The primitive type `Int16`
235 var int16_type
: MClassType = self.get_primitive_class
("Int16").mclass_type
is lazy
237 # The primitive type `UInt16`
238 var uint16_type
: MClassType = self.get_primitive_class
("UInt16").mclass_type
is lazy
240 # The primitive type `Int32`
241 var int32_type
: MClassType = self.get_primitive_class
("Int32").mclass_type
is lazy
243 # The primitive type `UInt32`
244 var uint32_type
: MClassType = self.get_primitive_class
("UInt32").mclass_type
is lazy
246 # The primitive type `Char`
247 var char_type
: MClassType = self.get_primitive_class
("Char").mclass_type
is lazy
249 # The primitive type `Float`
250 var float_type
: MClassType = self.get_primitive_class
("Float").mclass_type
is lazy
252 # The primitive type `String`
253 var string_type
: MClassType = self.get_primitive_class
("String").mclass_type
is lazy
255 # The primitive type `CString`
256 var c_string_type
: MClassType = self.get_primitive_class
("CString").mclass_type
is lazy
258 # A primitive type of `Array`
259 fun array_type
(elt_type
: MType): MClassType do return array_class
.get_mtype
([elt_type
])
261 # The primitive class `Array`
262 var array_class
: MClass = self.get_primitive_class
("Array") is lazy
264 # A primitive type of `NativeArray`
265 fun native_array_type
(elt_type
: MType): MClassType do return native_array_class
.get_mtype
([elt_type
])
267 # The primitive class `NativeArray`
268 var native_array_class
: MClass = self.get_primitive_class
("NativeArray") is lazy
270 # The primitive type `Sys`, the main type of the program, if any
271 fun sys_type
: nullable MClassType
273 var clas
= self.model
.get_mclasses_by_name
("Sys")
274 if clas
== null then return null
275 return get_primitive_class
("Sys").mclass_type
278 # The primitive type `Finalizable`
279 # Used to tag classes that need to be finalized.
280 fun finalizable_type
: nullable MClassType
282 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
283 if clas
== null then return null
284 return get_primitive_class
("Finalizable").mclass_type
287 # Force to get the primitive class named `name` or abort
288 fun get_primitive_class
(name
: String): MClass
290 var cla
= self.model
.get_mclasses_by_name
(name
)
291 # Filter classes by introducing module
292 if cla
!= null then cla
= [for c
in cla
do if self.in_importation
<= c
.intro_mmodule
then c
]
293 if cla
== null or cla
.is_empty
then
294 if name
== "Bool" and self.model
.get_mclasses_by_name
("Object") != null then
295 # Bool is injected because it is needed by engine to code the result
296 # of the implicit casts.
297 var loc
= model
.no_location
298 var c
= new MClass(self, name
, loc
, null, enum_kind
, public_visibility
)
299 var cladef
= new MClassDef(self, c
.mclass_type
, loc
)
300 cladef
.set_supertypes
([object_type
])
301 cladef
.add_in_hierarchy
304 print_error
("Fatal Error: no primitive class {name} in {self}")
308 if cla
.length
!= 1 then
309 var msg
= "Fatal Error: more than one primitive class {name} in {self}:"
310 for c
in cla
do msg
+= " {c.full_name}"
317 # Try to get the primitive method named `name` on the type `recv`
318 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
320 var props
= self.model
.get_mproperties_by_name
(name
)
321 if props
== null then return null
322 var res
: nullable MMethod = null
323 var recvtype
= recv
.intro
.bound_mtype
324 for mprop
in props
do
325 assert mprop
isa MMethod
326 if not recvtype
.has_mproperty
(self, mprop
) then continue
329 else if res
!= mprop
then
330 print_error
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
338 private class MClassDefSorter
340 redef type COMPARED: MClassDef
342 redef fun compare
(a
, b
)
346 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
347 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
351 private class MPropDefSorter
353 redef type COMPARED: MPropDef
355 redef fun compare
(pa
, pb
)
361 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
362 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
368 # `MClass` are global to the model; it means that a `MClass` is not bound to a
369 # specific `MModule`.
371 # This characteristic helps the reasoning about classes in a program since a
372 # single `MClass` object always denote the same class.
374 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
375 # These do not really have properties nor belong to a hierarchy since the property and the
376 # hierarchy of a class depends of the refinement in the modules.
378 # Most services on classes require the precision of a module, and no one can asks what are
379 # the super-classes of a class nor what are properties of a class without precising what is
380 # the module considered.
382 # For instance, during the typing of a source-file, the module considered is the module of the file.
383 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
384 # *is the method `foo` exists in the class `Bar` in the current module?*
386 # During some global analysis, the module considered may be the main module of the program.
390 # The module that introduce the class
392 # While classes are not bound to a specific module,
393 # the introducing module is used for naming and visibility.
394 var intro_mmodule
: MModule
396 # The short name of the class
397 # In Nit, the name of a class cannot evolve in refinements
402 # The canonical name of the class
404 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
405 # Example: `"owner::module::MyClass"`
406 redef var full_name
is lazy
do
407 return "{self.intro_mmodule.namespace_for(visibility)}::{name}"
410 redef var c_name
is lazy
do
411 return "{intro_mmodule.c_namespace_for(visibility)}__{name.to_cmangle}"
414 # The number of generic formal parameters
415 # 0 if the class is not generic
416 var arity
: Int is noinit
418 # Each generic formal parameters in order.
419 # is empty if the class is not generic
420 var mparameters
= new Array[MParameterType]
422 # A string version of the signature a generic class.
424 # eg. `Map[K: nullable Object, V: nullable Object]`
426 # If the class in non generic the name is just given.
429 fun signature_to_s
: String
431 if arity
== 0 then return name
432 var res
= new FlatBuffer
435 for i
in [0..arity
[ do
436 if i
> 0 then res
.append
", "
437 res
.append mparameters
[i
].name
439 res
.append intro
.bound_mtype
.arguments
[i
].to_s
445 # Initialize `mparameters` from their names.
446 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
449 if parameter_names
== null then
452 self.arity
= parameter_names
.length
455 # Create the formal parameter types
457 assert parameter_names
!= null
458 var mparametertypes
= new Array[MParameterType]
459 for i
in [0..arity
[ do
460 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
461 mparametertypes
.add
(mparametertype
)
463 self.mparameters
= mparametertypes
464 var mclass_type
= new MGenericType(self, mparametertypes
)
465 self.mclass_type
= mclass_type
466 self.get_mtype_cache
[mparametertypes
] = mclass_type
468 self.mclass_type
= new MClassType(self)
472 # The kind of the class (interface, abstract class, etc.)
473 # In Nit, the kind of a class cannot evolve in refinements
476 # The visibility of the class
477 # In Nit, the visibility of a class cannot evolve in refinements
482 intro_mmodule
.intro_mclasses
.add
(self)
483 var model
= intro_mmodule
.model
484 model
.mclasses_by_name
.add_one
(name
, self)
485 model
.mclasses
.add
(self)
488 redef fun model
do return intro_mmodule
.model
490 # All class definitions (introduction and refinements)
491 var mclassdefs
= new Array[MClassDef]
494 redef fun to_s
do return self.name
496 # The definition that introduces the class.
498 # Warning: such a definition may not exist in the early life of the object.
499 # In this case, the method will abort.
501 # Use `try_intro` instead
502 var intro
: MClassDef is noinit
504 # The definition that introduces the class or null if not yet known.
507 fun try_intro
: nullable MClassDef do
508 if isset _intro
then return _intro
else return null
511 # Return the class `self` in the class hierarchy of the module `mmodule`.
513 # SEE: `MModule::flatten_mclass_hierarchy`
514 # REQUIRE: `mmodule.has_mclass(self)`
515 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
517 return mmodule
.flatten_mclass_hierarchy
[self]
520 # The principal static type of the class.
522 # For non-generic class, `mclass_type` is the only `MClassType` based
525 # For a generic class, the arguments are the formal parameters.
526 # i.e.: for the class `Array[E:Object]`, the `mclass_type` is `Array[E]`.
527 # If you want `Array[Object]`, see `MClassDef::bound_mtype`.
529 # For generic classes, the mclass_type is also the way to get a formal
530 # generic parameter type.
532 # To get other types based on a generic class, see `get_mtype`.
534 # ENSURE: `mclass_type.mclass == self`
535 var mclass_type
: MClassType is noinit
537 # Return a generic type based on the class
538 # Is the class is not generic, then the result is `mclass_type`
540 # REQUIRE: `mtype_arguments.length == self.arity`
541 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
543 assert mtype_arguments
.length
== self.arity
544 if self.arity
== 0 then return self.mclass_type
545 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
546 if res
!= null then return res
547 res
= new MGenericType(self, mtype_arguments
)
548 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
552 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
554 # Is there a `new` factory to allow the pseudo instantiation?
555 var has_new_factory
= false is writable
557 # Is `self` a standard or abstract class kind?
558 var is_class
: Bool is lazy
do return kind
== concrete_kind
or kind
== abstract_kind
560 # Is `self` an interface kind?
561 var is_interface
: Bool is lazy
do return kind
== interface_kind
563 # Is `self` an enum kind?
564 var is_enum
: Bool is lazy
do return kind
== enum_kind
566 # Is `self` and abstract class?
567 var is_abstract
: Bool is lazy
do return kind
== abstract_kind
569 redef fun mdoc_or_fallback
do return intro
.mdoc
573 # A definition (an introduction or a refinement) of a class in a module
575 # A `MClassDef` is associated with an explicit (or almost) definition of a
576 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
577 # a specific class and a specific module, and contains declarations like super-classes
580 # It is the class definitions that are the backbone of most things in the model:
581 # ClassDefs are defined with regard with other classdefs.
582 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
584 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
588 # The module where the definition is
591 # The associated `MClass`
592 var mclass
: MClass is noinit
594 # The bounded type associated to the mclassdef
596 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
600 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
601 # If you want Array[E], then see `mclass.mclass_type`
603 # ENSURE: `bound_mtype.mclass == self.mclass`
604 var bound_mtype
: MClassType
608 redef fun visibility
do return mclass
.visibility
610 # Internal name combining the module and the class
611 # Example: "mymodule$MyClass"
612 redef var to_s
is noinit
616 self.mclass
= bound_mtype
.mclass
617 mmodule
.mclassdefs
.add
(self)
618 mclass
.mclassdefs
.add
(self)
619 if mclass
.intro_mmodule
== mmodule
then
620 assert not isset mclass
._intro
623 self.to_s
= "{mmodule}${mclass}"
626 # Actually the name of the `mclass`
627 redef fun name
do return mclass
.name
629 # The module and class name separated by a '$'.
631 # The short-name of the class is used for introduction.
632 # Example: "my_module$MyClass"
634 # The full-name of the class is used for refinement.
635 # Example: "my_module$intro_module::MyClass"
636 redef var full_name
is lazy
do
639 # private gives 'p::m$A'
640 return "{mmodule.namespace_for(mclass.visibility)}${mclass.name}"
641 else if mclass
.intro_mmodule
.mpackage
!= mmodule
.mpackage
then
642 # public gives 'q::n$p::A'
643 # private gives 'q::n$p::m::A'
644 return "{mmodule.full_name}${mclass.full_name}"
645 else if mclass
.visibility
> private_visibility
then
646 # public gives 'p::n$A'
647 return "{mmodule.full_name}${mclass.name}"
649 # private gives 'p::n$::m::A' (redundant p is omitted)
650 return "{mmodule.full_name}$::{mclass.intro_mmodule.name}::{mclass.name}"
654 redef var c_name
is lazy
do
656 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
657 else if mclass
.intro_mmodule
.mpackage
== mmodule
.mpackage
and mclass
.visibility
> private_visibility
then
658 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
660 return "{mmodule.c_name}___{mclass.c_name}"
664 redef fun model
do return mmodule
.model
666 # All declared super-types
667 # FIXME: quite ugly but not better idea yet
668 var supertypes
= new Array[MClassType]
670 # Register some super-types for the class (ie "super SomeType")
672 # The hierarchy must not already be set
673 # REQUIRE: `self.in_hierarchy == null`
674 fun set_supertypes
(supertypes
: Array[MClassType])
676 assert unique_invocation
: self.in_hierarchy
== null
677 var mmodule
= self.mmodule
678 var model
= mmodule
.model
679 var mtype
= self.bound_mtype
681 for supertype
in supertypes
do
682 self.supertypes
.add
(supertype
)
684 # Register in full_type_specialization_hierarchy
685 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
686 # Register in intro_type_specialization_hierarchy
687 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
688 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
694 # Collect the super-types (set by set_supertypes) to build the hierarchy
696 # This function can only invoked once by class
697 # REQUIRE: `self.in_hierarchy == null`
698 # ENSURE: `self.in_hierarchy != null`
701 assert unique_invocation
: self.in_hierarchy
== null
702 var model
= mmodule
.model
703 var res
= model
.mclassdef_hierarchy
.add_node
(self)
704 self.in_hierarchy
= res
705 var mtype
= self.bound_mtype
707 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
708 # The simpliest way is to attach it to collect_mclassdefs
709 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
710 res
.poset
.add_edge
(self, mclassdef
)
714 # The view of the class definition in `mclassdef_hierarchy`
715 var in_hierarchy
: nullable POSetElement[MClassDef] = null
717 # Is the definition the one that introduced `mclass`?
718 fun is_intro
: Bool do return isset mclass
._intro
and mclass
.intro
== self
720 # All properties introduced by the classdef
721 var intro_mproperties
= new Array[MProperty]
723 # All property introductions and redefinitions in `self` (not inheritance).
724 var mpropdefs
= new Array[MPropDef]
726 # All property introductions and redefinitions (not inheritance) in `self` by its associated property.
727 var mpropdefs_by_property
= new HashMap[MProperty, MPropDef]
729 redef fun mdoc_or_fallback
do return mdoc
or else mclass
.mdoc_or_fallback
732 # A global static type
734 # MType are global to the model; it means that a `MType` is not bound to a
735 # specific `MModule`.
736 # This characteristic helps the reasoning about static types in a program
737 # since a single `MType` object always denote the same type.
739 # However, because a `MType` is global, it does not really have properties
740 # nor have subtypes to a hierarchy since the property and the class hierarchy
741 # depends of a module.
742 # Moreover, virtual types an formal generic parameter types also depends on
743 # a receiver to have sense.
745 # Therefore, most method of the types require a module and an anchor.
746 # The module is used to know what are the classes and the specialization
748 # The anchor is used to know what is the bound of the virtual types and formal
749 # generic parameter types.
751 # MType are not directly usable to get properties. See the `anchor_to` method
752 # and the `MClassType` class.
754 # FIXME: the order of the parameters is not the best. We mus pick on from:
755 # * foo(mmodule, anchor, othertype)
756 # * foo(othertype, anchor, mmodule)
757 # * foo(anchor, mmodule, othertype)
758 # * foo(othertype, mmodule, anchor)
762 redef fun name
do return to_s
764 # Return true if `self` is an subtype of `sup`.
765 # The typing is done using the standard typing policy of Nit.
767 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
768 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
769 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
772 if sub
== sup
then return true
774 #print "1.is {sub} a {sup}? ===="
776 if anchor
== null then
777 assert not sub
.need_anchor
778 assert not sup
.need_anchor
780 # First, resolve the formal types to the simplest equivalent forms in the receiver
781 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
782 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
783 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
784 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
787 # Does `sup` accept null or not?
788 # Discard the nullable marker if it exists
789 var sup_accept_null
= false
790 if sup
isa MNullableType then
791 sup_accept_null
= true
793 else if sup
isa MNotNullType then
795 else if sup
isa MNullType then
796 sup_accept_null
= true
799 # Can `sub` provide null or not?
800 # Thus we can match with `sup_accept_null`
801 # Also discard the nullable marker if it exists
802 var sub_reject_null
= false
803 if sub
isa MNullableType then
804 if not sup_accept_null
then return false
806 else if sub
isa MNotNullType then
807 sub_reject_null
= true
809 else if sub
isa MNullType then
810 return sup_accept_null
812 # Now the case of direct null and nullable is over.
814 # If `sub` is a formal type, then it is accepted if its bound is accepted
815 while sub
isa MFormalType do
816 #print "3.is {sub} a {sup}?"
818 # A unfixed formal type can only accept itself
819 if sub
== sup
then return true
821 assert anchor
!= null
822 sub
= sub
.lookup_bound
(mmodule
, anchor
)
823 if sub_reject_null
then sub
= sub
.as_notnull
825 #print "3.is {sub} a {sup}?"
827 # Manage the second layer of null/nullable
828 if sub
isa MNullableType then
829 if not sup_accept_null
and not sub_reject_null
then return false
831 else if sub
isa MNotNullType then
832 sub_reject_null
= true
834 else if sub
isa MNullType then
835 return sup_accept_null
838 #print "4.is {sub} a {sup}? <- no more resolution"
840 if sub
isa MBottomType or sub
isa MErrorType then
844 assert sub
isa MClassType else print_error
"{sub} <? {sup}" # It is the only remaining type
846 # Handle sup-type when the sub-type is class-based (other cases must have be identified before).
847 if sup
isa MFormalType or sup
isa MNullType or sup
isa MBottomType or sup
isa MErrorType then
848 # These types are not super-types of Class-based types.
852 assert sup
isa MClassType else print_error
"got {sup} {sub.inspect}" # It is the only remaining type
854 # Now both are MClassType, we need to dig
856 if sub
== sup
then return true
858 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
859 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
860 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
861 if res
== false then return false
862 if not sup
isa MGenericType then return true
863 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
864 assert sub2
.mclass
== sup
.mclass
865 for i
in [0..sup
.mclass
.arity
[ do
866 var sub_arg
= sub2
.arguments
[i
]
867 var sup_arg
= sup
.arguments
[i
]
868 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
869 if res
== false then return false
874 # The base class type on which self is based
876 # This base type is used to get property (an internally to perform
877 # unsafe type comparison).
879 # Beware: some types (like null) are not based on a class thus this
882 # Basically, this function transform the virtual types and parameter
883 # types to their bounds.
888 # class B super A end
890 # class Y super X end
899 # Map[T,U] anchor_to H #-> Map[B,Y]
901 # Explanation of the example:
902 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
903 # because "redef type U: Y". Therefore, Map[T, U] is bound to
906 # ENSURE: `not self.need_anchor implies result == self`
907 # ENSURE: `not result.need_anchor`
908 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
910 if not need_anchor
then return self
911 assert not anchor
.need_anchor
912 # Just resolve to the anchor and clear all the virtual types
913 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
914 assert not res
.need_anchor
918 # Does `self` contain a virtual type or a formal generic parameter type?
919 # In order to remove those types, you usually want to use `anchor_to`.
920 fun need_anchor
: Bool do return true
922 # Return the supertype when adapted to a class.
924 # In Nit, for each super-class of a type, there is a equivalent super-type.
930 # class H[V] super G[V, Bool] end
932 # H[Int] supertype_to G #-> G[Int, Bool]
935 # REQUIRE: `super_mclass` is a super-class of `self`
936 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
937 # ENSURE: `result.mclass = super_mclass`
938 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
940 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
941 if self isa MClassType and self.mclass
== super_mclass
then return self
943 if self.need_anchor
then
944 assert anchor
!= null
945 resolved_self
= self.anchor_to
(mmodule
, anchor
)
949 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
950 for supertype
in supertypes
do
951 if supertype
.mclass
== super_mclass
then
952 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
953 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
959 # Replace formals generic types in self with resolved values in `mtype`
960 # If `cleanup_virtual` is true, then virtual types are also replaced
963 # This function returns self if `need_anchor` is false.
969 # class H[F] super G[F] end
973 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
974 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
976 # Explanation of the example:
977 # * Array[E].need_anchor is true because there is a formal generic parameter type E
978 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
979 # * Since "H[F] super G[F]", E is in fact F for H
980 # * More specifically, in H[Int], E is Int
981 # * So, in H[Int], Array[E] is Array[Int]
983 # This function is mainly used to inherit a signature.
984 # Because, unlike `anchor_to`, we do not want a full resolution of
985 # a type but only an adapted version of it.
991 # fun foo(e:E):E is abstract
993 # class B super A[Int] end
996 # The signature on foo is (e: E): E
997 # If we resolve the signature for B, we get (e:Int):Int
1003 # fun foo(e:E):E is abstract
1006 # var a: A[Array[F]]
1007 # fun bar do a.foo(x) # <- x is here
1011 # The first question is: is foo available on `a`?
1013 # The static type of a is `A[Array[F]]`, that is an open type.
1014 # in order to find a method `foo`, whe must look at a resolved type.
1016 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
1018 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
1020 # The next question is: what is the accepted types for `x`?
1022 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
1024 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
1026 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
1028 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
1029 # two function instead of one seems also to be a bad idea.
1031 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
1032 # ENSURE: `not self.need_anchor implies result == self`
1033 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
1035 # Resolve formal type to its verbatim bound.
1036 # If the type is not formal, just return self
1038 # The result is returned exactly as declared in the "type" property (verbatim).
1039 # So it could be another formal type.
1041 # In case of conflicts or inconsistencies in the model, the method returns a `MErrorType`.
1042 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1044 # Resolve the formal type to its simplest equivalent form.
1046 # Formal types are either free or fixed.
1047 # When it is fixed, it means that it is equivalent with a simpler type.
1048 # When a formal type is free, it means that it is only equivalent with itself.
1049 # This method return the most simple equivalent type of `self`.
1051 # This method is mainly used for subtype test in order to sanely compare fixed.
1053 # By default, return self.
1054 # See the redefinitions for specific behavior in each kind of type.
1056 # In case of conflicts or inconsistencies in the model, the method returns a `MErrorType`.
1057 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1059 # Is the type a `MErrorType` or contains an `MErrorType`?
1061 # `MErrorType` are used in result with conflict or inconsistencies.
1063 # See `is_legal_in` to check conformity with generic bounds.
1064 fun is_ok
: Bool do return true
1066 # Is the type legal in a given `mmodule` (with an optional `anchor`)?
1068 # A type is valid if:
1070 # * it does not contain a `MErrorType` (see `is_ok`).
1071 # * its generic formal arguments are within their bounds.
1072 fun is_legal_in
(mmodule
: MModule, anchor
: nullable MClassType): Bool do return is_ok
1074 # Can the type be resolved?
1076 # In order to resolve open types, the formal types must make sence.
1086 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
1088 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
1090 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
1091 # # B[E] is a red hearing only the E is important,
1092 # # E make sense in A
1095 # REQUIRE: `anchor != null implies not anchor.need_anchor`
1096 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
1097 # ENSURE: `not self.need_anchor implies result == true`
1098 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
1100 # Return the nullable version of the type
1101 # If the type is already nullable then self is returned
1102 fun as_nullable
: MType
1104 var res
= self.as_nullable_cache
1105 if res
!= null then return res
1106 res
= new MNullableType(self)
1107 self.as_nullable_cache
= res
1111 # Remove the base type of a decorated (proxy) type.
1112 # Is the type is not decorated, then self is returned.
1114 # Most of the time it is used to return the not nullable version of a nullable type.
1115 # In this case, this just remove the `nullable` notation, but the result can still contains null.
1116 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
1117 # If you really want to exclude the `null` value, then use `as_notnull`
1118 fun undecorate
: MType
1123 # Returns the not null version of the type.
1124 # That is `self` minus the `null` value.
1126 # For most types, this return `self`.
1127 # For formal types, this returns a special `MNotNullType`
1128 fun as_notnull
: MType do return self
1130 private var as_nullable_cache
: nullable MType = null
1133 # The depth of the type seen as a tree.
1140 # Formal types have a depth of 1.
1146 # The length of the type seen as a tree.
1153 # Formal types have a length of 1.
1159 # Compute all the classdefs inherited/imported.
1160 # The returned set contains:
1161 # * the class definitions from `mmodule` and its imported modules
1162 # * the class definitions of this type and its super-types
1164 # This function is used mainly internally.
1166 # REQUIRE: `not self.need_anchor`
1167 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1169 # Compute all the super-classes.
1170 # This function is used mainly internally.
1172 # REQUIRE: `not self.need_anchor`
1173 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1175 # Compute all the declared super-types.
1176 # Super-types are returned as declared in the classdefs (verbatim).
1177 # This function is used mainly internally.
1179 # REQUIRE: `not self.need_anchor`
1180 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1182 # Is the property in self for a given module
1183 # This method does not filter visibility or whatever
1185 # REQUIRE: `not self.need_anchor`
1186 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1188 assert not self.need_anchor
1189 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1193 # A type based on a class.
1195 # `MClassType` have properties (see `has_mproperty`).
1199 # The associated class
1202 redef fun model
do return self.mclass
.intro_mmodule
.model
1204 redef fun location
do return mclass
.location
1206 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1208 # The formal arguments of the type
1209 # ENSURE: `result.length == self.mclass.arity`
1210 var arguments
= new Array[MType]
1212 redef fun to_s
do return mclass
.to_s
1214 redef fun full_name
do return mclass
.full_name
1216 redef fun c_name
do return mclass
.c_name
1218 redef fun need_anchor
do return false
1220 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1222 return super.as(MClassType)
1225 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1227 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1229 redef fun collect_mclassdefs
(mmodule
)
1231 assert not self.need_anchor
1232 var cache
= self.collect_mclassdefs_cache
1233 if not cache
.has_key
(mmodule
) then
1234 self.collect_things
(mmodule
)
1236 return cache
[mmodule
]
1239 redef fun collect_mclasses
(mmodule
)
1241 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1242 assert not self.need_anchor
1243 var cache
= self.collect_mclasses_cache
1244 if not cache
.has_key
(mmodule
) then
1245 self.collect_things
(mmodule
)
1247 var res
= cache
[mmodule
]
1248 collect_mclasses_last_module
= mmodule
1249 collect_mclasses_last_module_cache
= res
1253 private var collect_mclasses_last_module
: nullable MModule = null
1254 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1256 redef fun collect_mtypes
(mmodule
)
1258 assert not self.need_anchor
1259 var cache
= self.collect_mtypes_cache
1260 if not cache
.has_key
(mmodule
) then
1261 self.collect_things
(mmodule
)
1263 return cache
[mmodule
]
1266 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1267 private fun collect_things
(mmodule
: MModule)
1269 var res
= new HashSet[MClassDef]
1270 var seen
= new HashSet[MClass]
1271 var types
= new HashSet[MClassType]
1272 seen
.add
(self.mclass
)
1273 var todo
= [self.mclass
]
1274 while not todo
.is_empty
do
1275 var mclass
= todo
.pop
1276 #print "process {mclass}"
1277 for mclassdef
in mclass
.mclassdefs
do
1278 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1279 #print " process {mclassdef}"
1281 for supertype
in mclassdef
.supertypes
do
1282 types
.add
(supertype
)
1283 var superclass
= supertype
.mclass
1284 if seen
.has
(superclass
) then continue
1285 #print " add {superclass}"
1286 seen
.add
(superclass
)
1287 todo
.add
(superclass
)
1291 collect_mclassdefs_cache
[mmodule
] = res
1292 collect_mclasses_cache
[mmodule
] = seen
1293 collect_mtypes_cache
[mmodule
] = types
1296 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1297 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1298 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1300 redef fun mdoc_or_fallback
do return mclass
.mdoc_or_fallback
1303 # A type based on a generic class.
1304 # A generic type a just a class with additional formal generic arguments.
1310 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1314 assert self.mclass
.arity
== arguments
.length
1316 self.need_anchor
= false
1317 for t
in arguments
do
1318 if t
.need_anchor
then
1319 self.need_anchor
= true
1324 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1327 # The short-name of the class, then the full-name of each type arguments within brackets.
1328 # Example: `"Map[String, List[Int]]"`
1329 redef var to_s
is noinit
1331 # The full-name of the class, then the full-name of each type arguments within brackets.
1332 # Example: `"core::Map[core::String, core::List[core::Int]]"`
1333 redef var full_name
is lazy
do
1334 var args
= new Array[String]
1335 for t
in arguments
do
1336 args
.add t
.full_name
1338 return "{mclass.full_name}[{args.join(", ")}]"
1341 redef var c_name
is lazy
do
1342 var res
= mclass
.c_name
1343 # Note: because the arity is known, a prefix notation is enough
1344 for t
in arguments
do
1351 redef var need_anchor
is noinit
1353 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1355 if not need_anchor
then return self
1356 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1357 var types
= new Array[MType]
1358 for t
in arguments
do
1359 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1361 return mclass
.get_mtype
(types
)
1364 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1366 if not need_anchor
then return true
1367 for t
in arguments
do
1368 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1375 for t
in arguments
do if not t
.is_ok
then return false
1379 redef fun is_legal_in
(mmodule
, anchor
)
1383 assert anchor
!= null
1384 mtype
= anchor_to
(mmodule
, anchor
)
1388 if not mtype
.is_ok
then return false
1389 return mtype
.is_subtype
(mmodule
, null, mtype
.mclass
.intro
.bound_mtype
)
1395 for a
in self.arguments
do
1397 if d
> dmax
then dmax
= d
1405 for a
in self.arguments
do
1412 # A formal type (either virtual of parametric).
1414 # The main issue with formal types is that they offer very little information on their own
1415 # and need a context (anchor and mmodule) to be useful.
1416 abstract class MFormalType
1419 redef var as_notnull
= new MNotNullType(self) is lazy
1422 # A virtual formal type.
1426 # The property associated with the type.
1427 # Its the definitions of this property that determine the bound or the virtual type.
1428 var mproperty
: MVirtualTypeProp
1430 redef fun location
do return mproperty
.location
1432 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1434 redef fun lookup_bound
(mmodule
, resolved_receiver
)
1436 # There is two possible invalid cases: the vt does not exists in resolved_receiver or the bound is broken
1437 if not resolved_receiver
.has_mproperty
(mmodule
, mproperty
) then return new MErrorType(model
)
1438 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
or else new MErrorType(model
)
1441 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1443 assert not resolved_receiver
.need_anchor
1444 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1445 if props
.is_empty
then
1447 else if props
.length
== 1 then
1450 var types
= new ArraySet[MType]
1451 var res
= props
.first
1453 types
.add
(p
.bound
.as(not null))
1454 if not res
.is_fixed
then res
= p
1456 if types
.length
== 1 then
1462 # A VT is fixed when:
1463 # * the VT is (re-)defined with the annotation `is fixed`
1464 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1465 # * the receiver is an enum class since there is no subtype possible
1466 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1468 assert not resolved_receiver
.need_anchor
1469 resolved_receiver
= resolved_receiver
.undecorate
1470 assert resolved_receiver
isa MClassType # It is the only remaining type
1472 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1473 var res
= prop
.bound
1474 if res
== null then return new MErrorType(model
)
1476 # Recursively lookup the fixed result
1477 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1479 # 1. For a fixed VT, return the resolved bound
1480 if prop
.is_fixed
then return res
1482 # 2. For a enum boud, return the bound
1483 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1485 # 3. for a enum receiver return the bound
1486 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1491 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1493 if not cleanup_virtual
then return self
1494 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1496 if mproperty
.is_selftype
then return mtype
1498 # self is a virtual type declared (or inherited) in mtype
1499 # The point of the function it to get the bound of the virtual type that make sense for mtype
1500 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1501 #print "{class_name}: {self}/{mtype}/{anchor}?"
1502 var resolved_receiver
1503 if mtype
.need_anchor
then
1504 assert anchor
!= null
1505 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1507 resolved_receiver
= mtype
1509 # Now, we can get the bound
1510 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1511 # The bound is exactly as declared in the "type" property, so we must resolve it again
1512 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1517 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1519 if mtype
.need_anchor
then
1520 assert anchor
!= null
1521 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1523 return mtype
.has_mproperty
(mmodule
, mproperty
)
1526 redef fun to_s
do return self.mproperty
.to_s
1528 redef fun full_name
do return self.mproperty
.full_name
1530 redef fun c_name
do return self.mproperty
.c_name
1532 redef fun mdoc_or_fallback
do return mproperty
.mdoc_or_fallback
1535 # The type associated to a formal parameter generic type of a class
1537 # Each parameter type is associated to a specific class.
1538 # It means that all refinements of a same class "share" the parameter type,
1539 # but that a generic subclass has its own parameter types.
1541 # However, in the sense of the meta-model, a parameter type of a class is
1542 # a valid type in a subclass. The "in the sense of the meta-model" is
1543 # important because, in the Nit language, the programmer cannot refers
1544 # directly to the parameter types of the super-classes.
1549 # fun e: E is abstract
1555 # In the class definition B[F], `F` is a valid type but `E` is not.
1556 # However, `self.e` is a valid method call, and the signature of `e` is
1559 # Note that parameter types are shared among class refinements.
1560 # Therefore parameter only have an internal name (see `to_s` for details).
1561 class MParameterType
1564 # The generic class where the parameter belong
1567 redef fun model
do return self.mclass
.intro_mmodule
.model
1569 redef fun location
do return mclass
.location
1571 # The position of the parameter (0 for the first parameter)
1572 # FIXME: is `position` a better name?
1577 redef fun to_s
do return name
1579 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1581 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1583 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1585 assert not resolved_receiver
.need_anchor
1586 resolved_receiver
= resolved_receiver
.undecorate
1587 assert resolved_receiver
isa MClassType # It is the only remaining type
1588 var goalclass
= self.mclass
1589 if resolved_receiver
.mclass
== goalclass
then
1590 return resolved_receiver
.arguments
[self.rank
]
1592 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1593 for t
in supertypes
do
1594 if t
.mclass
== goalclass
then
1595 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1596 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1597 var res
= t
.arguments
[self.rank
]
1601 # Cannot found `self` in `resolved_receiver`
1602 return new MErrorType(model
)
1605 # A PT is fixed when:
1606 # * Its bound is a enum class (see `enum_kind`).
1607 # The PT is just useless, but it is still a case.
1608 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1609 # so it is necessarily fixed in a `super` clause, either with a normal type
1610 # or with another PT.
1611 # See `resolve_for` for examples about related issues.
1612 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1614 assert not resolved_receiver
.need_anchor
1615 resolved_receiver
= resolved_receiver
.undecorate
1616 assert resolved_receiver
isa MClassType # It is the only remaining type
1617 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1621 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1623 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1624 #print "{class_name}: {self}/{mtype}/{anchor}?"
1626 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1627 var res
= mtype
.arguments
[self.rank
]
1628 if anchor
!= null and res
.need_anchor
then
1629 # Maybe the result can be resolved more if are bound to a final class
1630 var r2
= res
.anchor_to
(mmodule
, anchor
)
1631 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1636 # self is a parameter type of mtype (or of a super-class of mtype)
1637 # The point of the function it to get the bound of the virtual type that make sense for mtype
1638 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1639 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1640 var resolved_receiver
1641 if mtype
.need_anchor
then
1642 assert anchor
!= null
1643 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1645 resolved_receiver
= mtype
1647 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1648 if resolved_receiver
isa MParameterType then
1649 assert anchor
!= null
1650 assert resolved_receiver
.mclass
== anchor
.mclass
1651 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1652 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1654 assert resolved_receiver
isa MClassType # It is the only remaining type
1656 # Eh! The parameter is in the current class.
1657 # So we return the corresponding argument, no mater what!
1658 if resolved_receiver
.mclass
== self.mclass
then
1659 var res
= resolved_receiver
.arguments
[self.rank
]
1660 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1664 if resolved_receiver
.need_anchor
then
1665 assert anchor
!= null
1666 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1668 # Now, we can get the bound
1669 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1670 # The bound is exactly as declared in the "type" property, so we must resolve it again
1671 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1673 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1678 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1680 if mtype
.need_anchor
then
1681 assert anchor
!= null
1682 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1684 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1688 # A type that decorates another type.
1690 # The point of this class is to provide a common implementation of sevices that just forward to the original type.
1691 # Specific decorator are expected to redefine (or to extend) the default implementation as this suit them.
1692 abstract class MProxyType
1697 redef fun location
do return mtype
.location
1699 redef fun model
do return self.mtype
.model
1700 redef fun need_anchor
do return mtype
.need_anchor
1701 redef fun as_nullable
do return mtype
.as_nullable
1702 redef fun as_notnull
do return mtype
.as_notnull
1703 redef fun undecorate
do return mtype
.undecorate
1704 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1706 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1710 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1712 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1715 redef fun is_ok
do return mtype
.is_ok
1717 redef fun is_legal_in
(mmodule
, anchor
) do return mtype
.is_legal_in
(mmodule
, anchor
)
1719 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1721 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1725 redef fun depth
do return self.mtype
.depth
1727 redef fun length
do return self.mtype
.length
1729 redef fun collect_mclassdefs
(mmodule
)
1731 assert not self.need_anchor
1732 return self.mtype
.collect_mclassdefs
(mmodule
)
1735 redef fun collect_mclasses
(mmodule
)
1737 assert not self.need_anchor
1738 return self.mtype
.collect_mclasses
(mmodule
)
1741 redef fun collect_mtypes
(mmodule
)
1743 assert not self.need_anchor
1744 return self.mtype
.collect_mtypes
(mmodule
)
1748 # A type prefixed with "nullable"
1754 self.to_s
= "nullable {mtype}"
1757 redef var to_s
is noinit
1759 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1761 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1763 redef fun as_nullable
do return self
1764 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1767 return res
.as_nullable
1770 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1771 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1774 if t
== mtype
then return self
1775 return t
.as_nullable
1779 # A non-null version of a formal type.
1781 # When a formal type in bounded to a nullable type, this is the type of the not null version of it.
1785 redef fun to_s
do return "not null {mtype}"
1786 redef var full_name
is lazy
do return "not null {mtype.full_name}"
1787 redef var c_name
is lazy
do return "notnull__{mtype.c_name}"
1789 redef fun as_notnull
do return self
1791 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1794 return res
.as_notnull
1797 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_notnull`
1798 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1801 if t
== mtype
then return self
1806 # The type of the only value null
1808 # The is only one null type per model, see `MModel::null_type`.
1812 redef fun to_s
do return "null"
1813 redef fun full_name
do return "null"
1814 redef fun c_name
do return "null"
1815 redef fun as_nullable
do return self
1817 redef var as_notnull
= new MBottomType(model
) is lazy
1818 redef fun need_anchor
do return false
1819 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1820 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1822 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1824 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1826 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1829 # The special universal most specific type.
1831 # This type is intended to be only used internally for type computation or analysis and should not be exposed to the user.
1832 # The bottom type can de used to denote things that are dead (no instance).
1834 # Semantically it is the singleton `null.as_notnull`.
1835 # Is also means that `self.as_nullable == null`.
1839 redef fun to_s
do return "bottom"
1840 redef fun full_name
do return "bottom"
1841 redef fun c_name
do return "bottom"
1842 redef fun as_nullable
do return model
.null_type
1843 redef fun as_notnull
do return self
1844 redef fun need_anchor
do return false
1845 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1846 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1848 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1850 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1852 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1855 # A special type used as a silent error marker when building types.
1857 # This type is intended to be only used internally for type operation and should not be exposed to the user.
1858 # The error type can de used to denote things that are conflicting or inconsistent.
1860 # Some methods on types can return a `MErrorType` to denote a broken or a conflicting result.
1861 # Use `is_ok` to check if a type is (or contains) a `MErrorType` .
1865 redef fun to_s
do return "error"
1866 redef fun full_name
do return "error"
1867 redef fun c_name
do return "error"
1868 redef fun need_anchor
do return false
1869 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1870 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1871 redef fun is_ok
do return false
1873 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1875 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1877 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1880 # A signature of a method
1884 # The each parameter (in order)
1885 var mparameters
: Array[MParameter]
1887 # Returns a parameter named `name`, if any.
1888 fun mparameter_by_name
(name
: String): nullable MParameter
1890 for p
in mparameters
do
1891 if p
.name
== name
then return p
1896 # The return type (null for a procedure)
1897 var return_mtype
: nullable MType
1902 var t
= self.return_mtype
1903 if t
!= null then dmax
= t
.depth
1904 for p
in mparameters
do
1905 var d
= p
.mtype
.depth
1906 if d
> dmax
then dmax
= d
1914 var t
= self.return_mtype
1915 if t
!= null then res
+= t
.length
1916 for p
in mparameters
do
1917 res
+= p
.mtype
.length
1922 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1925 var vararg_rank
= -1
1926 for i
in [0..mparameters
.length
[ do
1927 var parameter
= mparameters
[i
]
1928 if parameter
.is_vararg
then
1929 if vararg_rank
>= 0 then
1930 # If there is more than one vararg,
1931 # consider that additional arguments cannot be mapped.
1938 self.vararg_rank
= vararg_rank
1941 # The rank of the main ellipsis (`...`) for vararg (starting from 0).
1942 # value is -1 if there is no vararg.
1943 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1945 # From a model POV, a signature can contain more than one vararg parameter,
1946 # the `vararg_rank` just indicates the one that will receive the additional arguments.
1947 # However, currently, if there is more that one vararg parameter, no one will be the main one,
1948 # and additional arguments will be refused.
1949 var vararg_rank
: Int is noinit
1951 # The number of parameters
1952 fun arity
: Int do return mparameters
.length
1956 var b
= new FlatBuffer
1957 if not mparameters
.is_empty
then
1959 for i
in [0..mparameters
.length
[ do
1960 var mparameter
= mparameters
[i
]
1961 if i
> 0 then b
.append
(", ")
1962 b
.append
(mparameter
.name
)
1964 b
.append
(mparameter
.mtype
.to_s
)
1965 if mparameter
.is_vararg
then
1971 var ret
= self.return_mtype
1979 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1981 var params
= new Array[MParameter]
1982 for p
in self.mparameters
do
1983 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1985 var ret
= self.return_mtype
1987 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1989 var res
= new MSignature(params
, ret
)
1994 # A parameter in a signature
1998 # The name of the parameter
2001 # The static type of the parameter
2004 # Is the parameter a vararg?
2010 return "{name}: {mtype}..."
2012 return "{name}: {mtype}"
2016 # Returns a new parameter with the `mtype` resolved.
2017 # See `MType::resolve_for` for details.
2018 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
2020 if not self.mtype
.need_anchor
then return self
2021 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
2022 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
2026 redef fun model
do return mtype
.model
2029 # A service (global property) that generalize method, attribute, etc.
2031 # `MProperty` are global to the model; it means that a `MProperty` is not bound
2032 # to a specific `MModule` nor a specific `MClass`.
2034 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
2035 # and the other in subclasses and in refinements.
2037 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
2038 # of any dynamic type).
2039 # For instance, a call site "x.foo" is associated to a `MProperty`.
2040 abstract class MProperty
2043 # The associated MPropDef subclass.
2044 # The two specialization hierarchy are symmetric.
2045 type MPROPDEF: MPropDef
2047 # The classdef that introduce the property
2048 # While a property is not bound to a specific module, or class,
2049 # the introducing mclassdef is used for naming and visibility
2050 var intro_mclassdef
: MClassDef
2052 # The (short) name of the property
2057 redef fun mdoc_or_fallback
do return intro
.mdoc
2059 # The canonical name of the property.
2061 # It is currently the short-`name` prefixed by the short-name of the class and the full-name of the module.
2062 # Example: "my_package::my_module::MyClass::my_method"
2064 # The full-name of the module is needed because two distinct modules of the same package can
2065 # still refine the same class and introduce homonym properties.
2067 # For public properties not introduced by refinement, the module name is not used.
2069 # Example: `my_package::MyClass::My_method`
2070 redef var full_name
is lazy
do
2071 if intro_mclassdef
.is_intro
then
2072 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
2074 return "{intro_mclassdef.mmodule.full_name}::{intro_mclassdef.mclass.name}::{name}"
2078 redef var c_name
is lazy
do
2079 # FIXME use `namespace_for`
2080 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
2083 # The visibility of the property
2084 redef var visibility
2086 # Is the property usable as an initializer?
2087 var is_autoinit
= false is writable
2091 intro_mclassdef
.intro_mproperties
.add
(self)
2092 var model
= intro_mclassdef
.mmodule
.model
2093 model
.mproperties_by_name
.add_one
(name
, self)
2094 model
.mproperties
.add
(self)
2097 # All definitions of the property.
2098 # The first is the introduction,
2099 # The other are redefinitions (in refinements and in subclasses)
2100 var mpropdefs
= new Array[MPROPDEF]
2102 # The definition that introduces the property.
2104 # Warning: such a definition may not exist in the early life of the object.
2105 # In this case, the method will abort.
2106 var intro
: MPROPDEF is noinit
2108 redef fun model
do return intro
.model
2111 redef fun to_s
do return name
2113 # Return the most specific property definitions defined or inherited by a type.
2114 # The selection knows that refinement is stronger than specialization;
2115 # however, in case of conflict more than one property are returned.
2116 # If mtype does not know mproperty then an empty array is returned.
2118 # If you want the really most specific property, then look at `lookup_first_definition`
2120 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2121 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
2122 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2124 assert not mtype
.need_anchor
2125 mtype
= mtype
.undecorate
2127 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
2128 if cache
!= null then return cache
2130 #print "select prop {mproperty} for {mtype} in {self}"
2131 # First, select all candidates
2132 var candidates
= new Array[MPROPDEF]
2134 # Here we have two strategies: iterate propdefs or iterate classdefs.
2135 var mpropdefs
= self.mpropdefs
2136 if mpropdefs
.length
<= 1 or mpropdefs
.length
< mtype
.collect_mclassdefs
(mmodule
).length
then
2137 # Iterate on all definitions of `self`, keep only those inherited by `mtype` in `mmodule`
2138 for mpropdef
in mpropdefs
do
2139 # If the definition is not imported by the module, then skip
2140 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2141 # If the definition is not inherited by the type, then skip
2142 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2144 candidates
.add
(mpropdef
)
2147 # Iterate on all super-classdefs of `mtype`, keep only the definitions of `self`, if any.
2148 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
2149 var p
= mclassdef
.mpropdefs_by_property
.get_or_null
(self)
2150 if p
!= null then candidates
.add p
2154 # Fast track for only one candidate
2155 if candidates
.length
<= 1 then
2156 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
2160 # Second, filter the most specific ones
2161 return select_most_specific
(mmodule
, candidates
)
2164 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2166 # Return the most specific property definitions inherited by a type.
2167 # The selection knows that refinement is stronger than specialization;
2168 # however, in case of conflict more than one property are returned.
2169 # If mtype does not know mproperty then an empty array is returned.
2171 # If you want the really most specific property, then look at `lookup_next_definition`
2173 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2174 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
2175 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2177 assert not mtype
.need_anchor
2178 mtype
= mtype
.undecorate
2180 # First, select all candidates
2181 var candidates
= new Array[MPROPDEF]
2182 for mpropdef
in self.mpropdefs
do
2183 # If the definition is not imported by the module, then skip
2184 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2185 # If the definition is not inherited by the type, then skip
2186 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2187 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
2188 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
2190 candidates
.add
(mpropdef
)
2192 # Fast track for only one candidate
2193 if candidates
.length
<= 1 then return candidates
2195 # Second, filter the most specific ones
2196 return select_most_specific
(mmodule
, candidates
)
2199 # Return an array containing olny the most specific property definitions
2200 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
2201 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
2203 var res
= new Array[MPROPDEF]
2204 for pd1
in candidates
do
2205 var cd1
= pd1
.mclassdef
2208 for pd2
in candidates
do
2209 if pd2
== pd1
then continue # do not compare with self!
2210 var cd2
= pd2
.mclassdef
2212 if c2
.mclass_type
== c1
.mclass_type
then
2213 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
2214 # cd2 refines cd1; therefore we skip pd1
2218 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
2219 # cd2 < cd1; therefore we skip pd1
2228 if res
.is_empty
then
2229 print_error
"All lost! {candidates.join(", ")}"
2230 # FIXME: should be abort!
2235 # Return the most specific definition in the linearization of `mtype`.
2237 # If you want to know the next properties in the linearization,
2238 # look at `MPropDef::lookup_next_definition`.
2240 # FIXME: the linearization is still unspecified
2242 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2243 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2244 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2246 return lookup_all_definitions
(mmodule
, mtype
).first
2249 # Return all definitions in a linearization order
2250 # Most specific first, most general last
2252 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2253 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2254 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2256 mtype
= mtype
.undecorate
2258 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
2259 if cache
!= null then return cache
2261 assert not mtype
.need_anchor
2262 assert mtype
.has_mproperty
(mmodule
, self)
2264 #print "select prop {mproperty} for {mtype} in {self}"
2265 # First, select all candidates
2266 var candidates
= new Array[MPROPDEF]
2267 for mpropdef
in self.mpropdefs
do
2268 # If the definition is not imported by the module, then skip
2269 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2270 # If the definition is not inherited by the type, then skip
2271 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2273 candidates
.add
(mpropdef
)
2275 # Fast track for only one candidate
2276 if candidates
.length
<= 1 then
2277 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2281 mmodule
.linearize_mpropdefs
(candidates
)
2282 candidates
= candidates
.reversed
2283 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2287 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2294 redef type MPROPDEF: MMethodDef
2296 # Is the property defined at the top_level of the module?
2297 # Currently such a property are stored in `Object`
2298 var is_toplevel
: Bool = false is writable
2300 # Is the property a constructor?
2301 # Warning, this property can be inherited by subclasses with or without being a constructor
2302 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
2303 var is_init
: Bool = false is writable
2305 # The constructor is a (the) root init with empty signature but a set of initializers
2306 var is_root_init
: Bool = false is writable
2308 # Is the property a 'new' constructor?
2309 var is_new
: Bool = false is writable
2311 # Is the property a legal constructor for a given class?
2312 # As usual, visibility is not considered.
2313 # FIXME not implemented
2314 fun is_init_for
(mclass
: MClass): Bool
2319 # A specific method that is safe to call on null.
2320 # Currently, only `==`, `!=` and `is_same_instance` are safe
2321 fun is_null_safe
: Bool do return name
== "==" or name
== "!=" or name
== "is_same_instance"
2324 # A global attribute
2328 redef type MPROPDEF: MAttributeDef
2332 # A global virtual type
2333 class MVirtualTypeProp
2336 redef type MPROPDEF: MVirtualTypeDef
2338 # The formal type associated to the virtual type property
2339 var mvirtualtype
= new MVirtualType(self)
2341 # Is `self` the special virtual type `SELF`?
2342 var is_selftype
: Bool is lazy
do return name
== "SELF"
2345 # A definition of a property (local property)
2347 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2348 # specific class definition (which belong to a specific module)
2349 abstract class MPropDef
2352 # The associated `MProperty` subclass.
2353 # the two specialization hierarchy are symmetric
2354 type MPROPERTY: MProperty
2357 type MPROPDEF: MPropDef
2359 # The class definition where the property definition is
2360 var mclassdef
: MClassDef
2362 # The associated global property
2363 var mproperty
: MPROPERTY
2365 redef var location
: Location
2367 redef fun visibility
do return mproperty
.visibility
2371 mclassdef
.mpropdefs
.add
(self)
2372 mproperty
.mpropdefs
.add
(self)
2373 mclassdef
.mpropdefs_by_property
[mproperty
] = self
2374 if mproperty
.intro_mclassdef
== mclassdef
then
2375 assert not isset mproperty
._intro
2376 mproperty
.intro
= self
2378 self.to_s
= "{mclassdef}${mproperty}"
2381 # Actually the name of the `mproperty`
2382 redef fun name
do return mproperty
.name
2384 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2386 # Therefore the combination of identifiers is awful,
2387 # the worst case being
2389 # * a property "p::m::A::x"
2390 # * redefined in a refinement of a class "q::n::B"
2391 # * in a module "r::o"
2392 # * so "r::o$q::n::B$p::m::A::x"
2394 # Fortunately, the full-name is simplified when entities are repeated.
2395 # For the previous case, the simplest form is "p$A$x".
2396 redef var full_name
is lazy
do
2397 var res
= new FlatBuffer
2399 # The first part is the mclassdef. Worst case is "r::o$q::n::B"
2400 res
.append mclassdef
.full_name
2404 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2405 # intro are unambiguous in a class
2408 # Just try to simplify each part
2409 if mclassdef
.mmodule
.mpackage
!= mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2410 # precise "p::m" only if "p" != "r"
2411 res
.append mproperty
.intro_mclassdef
.mmodule
.namespace_for
(mproperty
.visibility
)
2413 else if mproperty
.visibility
<= private_visibility
then
2414 # Same package ("p"=="q"), but private visibility,
2415 # does the module part ("::m") need to be displayed
2416 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2418 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2422 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2423 # precise "B" only if not the same class than "A"
2424 res
.append mproperty
.intro_mclassdef
.name
2427 # Always use the property name "x"
2428 res
.append mproperty
.name
2433 redef var c_name
is lazy
do
2434 var res
= new FlatBuffer
2435 res
.append mclassdef
.c_name
2437 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2438 res
.append name
.to_cmangle
2440 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2441 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2444 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2445 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2448 res
.append mproperty
.name
.to_cmangle
2453 redef fun model
do return mclassdef
.model
2455 # Internal name combining the module, the class and the property
2456 # Example: "mymodule$MyClass$mymethod"
2457 redef var to_s
is noinit
2459 # Is self the definition that introduce the property?
2460 fun is_intro
: Bool do return isset mproperty
._intro
and mproperty
.intro
== self
2462 # Return the next definition in linearization of `mtype`.
2464 # This method is used to determine what method is called by a super.
2466 # REQUIRE: `not mtype.need_anchor`
2467 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2469 assert not mtype
.need_anchor
2471 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2472 var i
= mpropdefs
.iterator
2473 while i
.is_ok
and i
.item
!= self do i
.next
2474 assert has_property
: i
.is_ok
2476 assert has_next_property
: i
.is_ok
2480 redef fun mdoc_or_fallback
do return mdoc
or else mproperty
.mdoc_or_fallback
2483 # A local definition of a method
2487 redef type MPROPERTY: MMethod
2488 redef type MPROPDEF: MMethodDef
2490 # The signature attached to the property definition
2491 var msignature
: nullable MSignature = null is writable
2493 # The signature attached to the `new` call on a root-init
2494 # This is a concatenation of the signatures of the initializers
2496 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2497 var new_msignature
: nullable MSignature = null is writable
2499 # List of initialisers to call in root-inits
2501 # They could be setters or attributes
2503 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2504 var initializers
= new Array[MProperty]
2506 # Is the method definition abstract?
2507 var is_abstract
: Bool = false is writable
2509 # Is the method definition intern?
2510 var is_intern
= false is writable
2512 # Is the method definition extern?
2513 var is_extern
= false is writable
2515 # An optional constant value returned in functions.
2517 # Only some specific primitife value are accepted by engines.
2518 # Is used when there is no better implementation available.
2520 # Currently used only for the implementation of the `--define`
2521 # command-line option.
2522 # SEE: module `mixin`.
2523 var constant_value
: nullable Object = null is writable
2526 # A local definition of an attribute
2530 redef type MPROPERTY: MAttribute
2531 redef type MPROPDEF: MAttributeDef
2533 # The static type of the attribute
2534 var static_mtype
: nullable MType = null is writable
2537 # A local definition of a virtual type
2538 class MVirtualTypeDef
2541 redef type MPROPERTY: MVirtualTypeProp
2542 redef type MPROPDEF: MVirtualTypeDef
2544 # The bound of the virtual type
2545 var bound
: nullable MType = null is writable
2547 # Is the bound fixed?
2548 var is_fixed
= false is writable
2555 # * `interface_kind`
2559 # Note this class is basically an enum.
2560 # FIXME: use a real enum once user-defined enums are available
2564 # Is a constructor required?
2567 # TODO: private init because enumeration.
2569 # Can a class of kind `self` specializes a class of kine `other`?
2570 fun can_specialize
(other
: MClassKind): Bool
2572 if other
== interface_kind
then return true # everybody can specialize interfaces
2573 if self == interface_kind
or self == enum_kind
then
2574 # no other case for interfaces
2576 else if self == extern_kind
then
2577 # only compatible with themselves
2578 return self == other
2579 else if other
== enum_kind
or other
== extern_kind
then
2580 # abstract_kind and concrete_kind are incompatible
2583 # remain only abstract_kind and concrete_kind
2588 # The class kind `abstract`
2589 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2590 # The class kind `concrete`
2591 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2592 # The class kind `interface`
2593 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2594 # The class kind `enum`
2595 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2596 # The class kind `extern`
2597 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)