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 bound to MEntity.
124 # We introduce a new class so it can be easily refined by tools working
127 super OrderedTree[MEntity]
130 # A MEntityTree borned to MConcern.
132 # TODO remove when nitdoc is fully merged with model_collect
134 super OrderedTree[MConcern]
138 # All the classes introduced in the module
139 var intro_mclasses
= new Array[MClass]
141 # All the class definitions of the module
142 # (introduction and refinement)
143 var mclassdefs
= new Array[MClassDef]
145 # Does the current module has a given class `mclass`?
146 # Return true if the mmodule introduces, refines or imports a class.
147 # Visibility is not considered.
148 fun has_mclass
(mclass
: MClass): Bool
150 return self.in_importation
<= mclass
.intro_mmodule
153 # Full hierarchy of introduced ans imported classes.
155 # Create a new hierarchy got by flattening the classes for the module
156 # and its imported modules.
157 # Visibility is not considered.
159 # Note: this function is expensive and is usually used for the main
160 # module of a program only. Do not use it to do you own subtype
162 fun flatten_mclass_hierarchy
: POSet[MClass]
164 var res
= self.flatten_mclass_hierarchy_cache
165 if res
!= null then return res
166 res
= new POSet[MClass]
167 for m
in self.in_importation
.greaters
do
168 for cd
in m
.mclassdefs
do
171 for s
in cd
.supertypes
do
172 res
.add_edge
(c
, s
.mclass
)
176 self.flatten_mclass_hierarchy_cache
= res
180 # Sort a given array of classes using the linearization order of the module
181 # The most general is first, the most specific is last
182 fun linearize_mclasses
(mclasses
: Array[MClass])
184 self.flatten_mclass_hierarchy
.sort
(mclasses
)
187 # Sort a given array of class definitions using the linearization order of the module
188 # the refinement link is stronger than the specialisation link
189 # The most general is first, the most specific is last
190 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
192 var sorter
= new MClassDefSorter(self)
193 sorter
.sort
(mclassdefs
)
196 # Sort a given array of property 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_mpropdefs
(mpropdefs
: Array[MPropDef])
201 var sorter
= new MPropDefSorter(self)
202 sorter
.sort
(mpropdefs
)
205 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
207 # The primitive type `Object`, the root of the class hierarchy
208 var object_type
: MClassType = self.get_primitive_class
("Object").mclass_type
is lazy
210 # The type `Pointer`, super class to all extern classes
211 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
213 # The primitive type `Bool`
214 var bool_type
: MClassType = self.get_primitive_class
("Bool").mclass_type
is lazy
216 # The primitive type `Int`
217 var int_type
: MClassType = self.get_primitive_class
("Int").mclass_type
is lazy
219 # The primitive type `Byte`
220 var byte_type
: MClassType = self.get_primitive_class
("Byte").mclass_type
is lazy
222 # The primitive type `Int8`
223 var int8_type
: MClassType = self.get_primitive_class
("Int8").mclass_type
is lazy
225 # The primitive type `Int16`
226 var int16_type
: MClassType = self.get_primitive_class
("Int16").mclass_type
is lazy
228 # The primitive type `UInt16`
229 var uint16_type
: MClassType = self.get_primitive_class
("UInt16").mclass_type
is lazy
231 # The primitive type `Int32`
232 var int32_type
: MClassType = self.get_primitive_class
("Int32").mclass_type
is lazy
234 # The primitive type `UInt32`
235 var uint32_type
: MClassType = self.get_primitive_class
("UInt32").mclass_type
is lazy
237 # The primitive type `Char`
238 var char_type
: MClassType = self.get_primitive_class
("Char").mclass_type
is lazy
240 # The primitive type `Float`
241 var float_type
: MClassType = self.get_primitive_class
("Float").mclass_type
is lazy
243 # The primitive type `String`
244 var string_type
: MClassType = self.get_primitive_class
("String").mclass_type
is lazy
246 # The primitive type `NativeString`
247 var native_string_type
: MClassType = self.get_primitive_class
("NativeString").mclass_type
is lazy
249 # A primitive type of `Array`
250 fun array_type
(elt_type
: MType): MClassType do return array_class
.get_mtype
([elt_type
])
252 # The primitive class `Array`
253 var array_class
: MClass = self.get_primitive_class
("Array") is lazy
255 # A primitive type of `NativeArray`
256 fun native_array_type
(elt_type
: MType): MClassType do return native_array_class
.get_mtype
([elt_type
])
258 # The primitive class `NativeArray`
259 var native_array_class
: MClass = self.get_primitive_class
("NativeArray") is lazy
261 # The primitive type `Sys`, the main type of the program, if any
262 fun sys_type
: nullable MClassType
264 var clas
= self.model
.get_mclasses_by_name
("Sys")
265 if clas
== null then return null
266 return get_primitive_class
("Sys").mclass_type
269 # The primitive type `Finalizable`
270 # Used to tag classes that need to be finalized.
271 fun finalizable_type
: nullable MClassType
273 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
274 if clas
== null then return null
275 return get_primitive_class
("Finalizable").mclass_type
278 # Force to get the primitive class named `name` or abort
279 fun get_primitive_class
(name
: String): MClass
281 var cla
= self.model
.get_mclasses_by_name
(name
)
282 # Filter classes by introducing module
283 if cla
!= null then cla
= [for c
in cla
do if self.in_importation
<= c
.intro_mmodule
then c
]
284 if cla
== null or cla
.is_empty
then
285 if name
== "Bool" and self.model
.get_mclasses_by_name
("Object") != null then
286 # Bool is injected because it is needed by engine to code the result
287 # of the implicit casts.
288 var c
= new MClass(self, name
, null, enum_kind
, public_visibility
)
289 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0))
290 cladef
.set_supertypes
([object_type
])
291 cladef
.add_in_hierarchy
294 print
("Fatal Error: no primitive class {name} in {self}")
298 if cla
.length
!= 1 then
299 var msg
= "Fatal Error: more than one primitive class {name} in {self}:"
300 for c
in cla
do msg
+= " {c.full_name}"
307 # Try to get the primitive method named `name` on the type `recv`
308 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
310 var props
= self.model
.get_mproperties_by_name
(name
)
311 if props
== null then return null
312 var res
: nullable MMethod = null
313 var recvtype
= recv
.intro
.bound_mtype
314 for mprop
in props
do
315 assert mprop
isa MMethod
316 if not recvtype
.has_mproperty
(self, mprop
) then continue
319 else if res
!= mprop
then
320 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
328 private class MClassDefSorter
330 redef type COMPARED: MClassDef
332 redef fun compare
(a
, b
)
336 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
337 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
341 private class MPropDefSorter
343 redef type COMPARED: MPropDef
345 redef fun compare
(pa
, pb
)
351 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
352 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
358 # `MClass` are global to the model; it means that a `MClass` is not bound to a
359 # specific `MModule`.
361 # This characteristic helps the reasoning about classes in a program since a
362 # single `MClass` object always denote the same class.
364 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
365 # These do not really have properties nor belong to a hierarchy since the property and the
366 # hierarchy of a class depends of the refinement in the modules.
368 # Most services on classes require the precision of a module, and no one can asks what are
369 # the super-classes of a class nor what are properties of a class without precising what is
370 # the module considered.
372 # For instance, during the typing of a source-file, the module considered is the module of the file.
373 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
374 # *is the method `foo` exists in the class `Bar` in the current module?*
376 # During some global analysis, the module considered may be the main module of the program.
380 # The module that introduce the class
381 # While classes are not bound to a specific module,
382 # the introducing module is used for naming an visibility
383 var intro_mmodule
: MModule
385 # The short name of the class
386 # In Nit, the name of a class cannot evolve in refinements
389 # The canonical name of the class
391 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
392 # Example: `"owner::module::MyClass"`
393 redef var full_name
is lazy
do
394 return "{self.intro_mmodule.namespace_for(visibility)}::{name}"
397 redef var c_name
is lazy
do
398 return "{intro_mmodule.c_namespace_for(visibility)}__{name.to_cmangle}"
401 # The number of generic formal parameters
402 # 0 if the class is not generic
403 var arity
: Int is noinit
405 # Each generic formal parameters in order.
406 # is empty if the class is not generic
407 var mparameters
= new Array[MParameterType]
409 # A string version of the signature a generic class.
411 # eg. `Map[K: nullable Object, V: nullable Object]`
413 # If the class in non generic the name is just given.
416 fun signature_to_s
: String
418 if arity
== 0 then return name
419 var res
= new FlatBuffer
422 for i
in [0..arity
[ do
423 if i
> 0 then res
.append
", "
424 res
.append mparameters
[i
].name
426 res
.append intro
.bound_mtype
.arguments
[i
].to_s
432 # Initialize `mparameters` from their names.
433 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
436 if parameter_names
== null then
439 self.arity
= parameter_names
.length
442 # Create the formal parameter types
444 assert parameter_names
!= null
445 var mparametertypes
= new Array[MParameterType]
446 for i
in [0..arity
[ do
447 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
448 mparametertypes
.add
(mparametertype
)
450 self.mparameters
= mparametertypes
451 var mclass_type
= new MGenericType(self, mparametertypes
)
452 self.mclass_type
= mclass_type
453 self.get_mtype_cache
[mparametertypes
] = mclass_type
455 self.mclass_type
= new MClassType(self)
459 # The kind of the class (interface, abstract class, etc.)
460 # In Nit, the kind of a class cannot evolve in refinements
463 # The visibility of the class
464 # In Nit, the visibility of a class cannot evolve in refinements
465 var visibility
: MVisibility
469 intro_mmodule
.intro_mclasses
.add
(self)
470 var model
= intro_mmodule
.model
471 model
.mclasses_by_name
.add_one
(name
, self)
472 model
.mclasses
.add
(self)
475 redef fun model
do return intro_mmodule
.model
477 # All class definitions (introduction and refinements)
478 var mclassdefs
= new Array[MClassDef]
481 redef fun to_s
do return self.name
483 # The definition that introduces the class.
485 # Warning: such a definition may not exist in the early life of the object.
486 # In this case, the method will abort.
488 # Use `try_intro` instead
489 var intro
: MClassDef is noinit
491 # The definition that introduces the class or null if not yet known.
494 fun try_intro
: nullable MClassDef do
495 if isset _intro
then return _intro
else return null
498 # Return the class `self` in the class hierarchy of the module `mmodule`.
500 # SEE: `MModule::flatten_mclass_hierarchy`
501 # REQUIRE: `mmodule.has_mclass(self)`
502 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
504 return mmodule
.flatten_mclass_hierarchy
[self]
507 # The principal static type of the class.
509 # For non-generic class, mclass_type is the only `MClassType` based
512 # For a generic class, the arguments are the formal parameters.
513 # i.e.: for the class Array[E:Object], the `mclass_type` is Array[E].
514 # If you want Array[Object] the see `MClassDef::bound_mtype`
516 # For generic classes, the mclass_type is also the way to get a formal
517 # generic parameter type.
519 # To get other types based on a generic class, see `get_mtype`.
521 # ENSURE: `mclass_type.mclass == self`
522 var mclass_type
: MClassType is noinit
524 # Return a generic type based on the class
525 # Is the class is not generic, then the result is `mclass_type`
527 # REQUIRE: `mtype_arguments.length == self.arity`
528 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
530 assert mtype_arguments
.length
== self.arity
531 if self.arity
== 0 then return self.mclass_type
532 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
533 if res
!= null then return res
534 res
= new MGenericType(self, mtype_arguments
)
535 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
539 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
541 # Is there a `new` factory to allow the pseudo instantiation?
542 var has_new_factory
= false is writable
544 # Is `self` a standard or abstract class kind?
545 var is_class
: Bool is lazy
do return kind
== concrete_kind
or kind
== abstract_kind
547 # Is `self` an interface kind?
548 var is_interface
: Bool is lazy
do return kind
== interface_kind
550 # Is `self` an enum kind?
551 var is_enum
: Bool is lazy
do return kind
== enum_kind
553 # Is `self` and abstract class?
554 var is_abstract
: Bool is lazy
do return kind
== abstract_kind
558 # A definition (an introduction or a refinement) of a class in a module
560 # A `MClassDef` is associated with an explicit (or almost) definition of a
561 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
562 # a specific class and a specific module, and contains declarations like super-classes
565 # It is the class definitions that are the backbone of most things in the model:
566 # ClassDefs are defined with regard with other classdefs.
567 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
569 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
573 # The module where the definition is
576 # The associated `MClass`
577 var mclass
: MClass is noinit
579 # The bounded type associated to the mclassdef
581 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
585 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
586 # If you want Array[E], then see `mclass.mclass_type`
588 # ENSURE: `bound_mtype.mclass == self.mclass`
589 var bound_mtype
: MClassType
591 # The origin of the definition
592 var location
: Location
594 # Internal name combining the module and the class
595 # Example: "mymodule#MyClass"
596 redef var to_s
is noinit
600 self.mclass
= bound_mtype
.mclass
601 mmodule
.mclassdefs
.add
(self)
602 mclass
.mclassdefs
.add
(self)
603 if mclass
.intro_mmodule
== mmodule
then
604 assert not isset mclass
._intro
607 self.to_s
= "{mmodule}#{mclass}"
610 # Actually the name of the `mclass`
611 redef fun name
do return mclass
.name
613 # The module and class name separated by a '#'.
615 # The short-name of the class is used for introduction.
616 # Example: "my_module#MyClass"
618 # The full-name of the class is used for refinement.
619 # Example: "my_module#intro_module::MyClass"
620 redef var full_name
is lazy
do
623 # private gives 'p::m#A'
624 return "{mmodule.namespace_for(mclass.visibility)}#{mclass.name}"
625 else if mclass
.intro_mmodule
.mpackage
!= mmodule
.mpackage
then
626 # public gives 'q::n#p::A'
627 # private gives 'q::n#p::m::A'
628 return "{mmodule.full_name}#{mclass.full_name}"
629 else if mclass
.visibility
> private_visibility
then
630 # public gives 'p::n#A'
631 return "{mmodule.full_name}#{mclass.name}"
633 # private gives 'p::n#::m::A' (redundant p is omitted)
634 return "{mmodule.full_name}#::{mclass.intro_mmodule.name}::{mclass.name}"
638 redef var c_name
is lazy
do
640 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
641 else if mclass
.intro_mmodule
.mpackage
== mmodule
.mpackage
and mclass
.visibility
> private_visibility
then
642 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
644 return "{mmodule.c_name}___{mclass.c_name}"
648 redef fun model
do return mmodule
.model
650 # All declared super-types
651 # FIXME: quite ugly but not better idea yet
652 var supertypes
= new Array[MClassType]
654 # Register some super-types for the class (ie "super SomeType")
656 # The hierarchy must not already be set
657 # REQUIRE: `self.in_hierarchy == null`
658 fun set_supertypes
(supertypes
: Array[MClassType])
660 assert unique_invocation
: self.in_hierarchy
== null
661 var mmodule
= self.mmodule
662 var model
= mmodule
.model
663 var mtype
= self.bound_mtype
665 for supertype
in supertypes
do
666 self.supertypes
.add
(supertype
)
668 # Register in full_type_specialization_hierarchy
669 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
670 # Register in intro_type_specialization_hierarchy
671 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
672 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
678 # Collect the super-types (set by set_supertypes) to build the hierarchy
680 # This function can only invoked once by class
681 # REQUIRE: `self.in_hierarchy == null`
682 # ENSURE: `self.in_hierarchy != null`
685 assert unique_invocation
: self.in_hierarchy
== null
686 var model
= mmodule
.model
687 var res
= model
.mclassdef_hierarchy
.add_node
(self)
688 self.in_hierarchy
= res
689 var mtype
= self.bound_mtype
691 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
692 # The simpliest way is to attach it to collect_mclassdefs
693 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
694 res
.poset
.add_edge
(self, mclassdef
)
698 # The view of the class definition in `mclassdef_hierarchy`
699 var in_hierarchy
: nullable POSetElement[MClassDef] = null
701 # Is the definition the one that introduced `mclass`?
702 fun is_intro
: Bool do return isset mclass
._intro
and mclass
.intro
== self
704 # All properties introduced by the classdef
705 var intro_mproperties
= new Array[MProperty]
707 # All property definitions in the class (introductions and redefinitions)
708 var mpropdefs
= new Array[MPropDef]
710 # The special autoinit constructor
711 var auto_init
: nullable MMethodDef = null is writable
714 # A global static type
716 # MType are global to the model; it means that a `MType` is not bound to a
717 # specific `MModule`.
718 # This characteristic helps the reasoning about static types in a program
719 # since a single `MType` object always denote the same type.
721 # However, because a `MType` is global, it does not really have properties
722 # nor have subtypes to a hierarchy since the property and the class hierarchy
723 # depends of a module.
724 # Moreover, virtual types an formal generic parameter types also depends on
725 # a receiver to have sense.
727 # Therefore, most method of the types require a module and an anchor.
728 # The module is used to know what are the classes and the specialization
730 # The anchor is used to know what is the bound of the virtual types and formal
731 # generic parameter types.
733 # MType are not directly usable to get properties. See the `anchor_to` method
734 # and the `MClassType` class.
736 # FIXME: the order of the parameters is not the best. We mus pick on from:
737 # * foo(mmodule, anchor, othertype)
738 # * foo(othertype, anchor, mmodule)
739 # * foo(anchor, mmodule, othertype)
740 # * foo(othertype, mmodule, anchor)
744 redef fun name
do return to_s
746 # Return true if `self` is an subtype of `sup`.
747 # The typing is done using the standard typing policy of Nit.
749 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
750 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
751 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
754 if sub
== sup
then return true
756 #print "1.is {sub} a {sup}? ===="
758 if anchor
== null then
759 assert not sub
.need_anchor
760 assert not sup
.need_anchor
762 # First, resolve the formal types to the simplest equivalent forms in the receiver
763 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
764 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
765 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
766 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
769 # Does `sup` accept null or not?
770 # Discard the nullable marker if it exists
771 var sup_accept_null
= false
772 if sup
isa MNullableType then
773 sup_accept_null
= true
775 else if sup
isa MNotNullType then
777 else if sup
isa MNullType then
778 sup_accept_null
= true
781 # Can `sub` provide null or not?
782 # Thus we can match with `sup_accept_null`
783 # Also discard the nullable marker if it exists
784 var sub_reject_null
= false
785 if sub
isa MNullableType then
786 if not sup_accept_null
then return false
788 else if sub
isa MNotNullType then
789 sub_reject_null
= true
791 else if sub
isa MNullType then
792 return sup_accept_null
794 # Now the case of direct null and nullable is over.
796 # If `sub` is a formal type, then it is accepted if its bound is accepted
797 while sub
isa MFormalType do
798 #print "3.is {sub} a {sup}?"
800 # A unfixed formal type can only accept itself
801 if sub
== sup
then return true
803 assert anchor
!= null
804 sub
= sub
.lookup_bound
(mmodule
, anchor
)
805 if sub_reject_null
then sub
= sub
.as_notnull
807 #print "3.is {sub} a {sup}?"
809 # Manage the second layer of null/nullable
810 if sub
isa MNullableType then
811 if not sup_accept_null
and not sub_reject_null
then return false
813 else if sub
isa MNotNullType then
814 sub_reject_null
= true
816 else if sub
isa MNullType then
817 return sup_accept_null
820 #print "4.is {sub} a {sup}? <- no more resolution"
822 if sub
isa MBottomType then
826 assert sub
isa MClassType else print
"{sub} <? {sub}" # It is the only remaining type
828 # Handle sup-type when the sub-type is class-based (other cases must have be identified before).
829 if sup
isa MFormalType or sup
isa MNullType or sup
isa MBottomType then
830 # These types are not super-types of Class-based types.
834 assert sup
isa MClassType else print
"got {sup} {sub.inspect}" # It is the only remaining type
836 # Now both are MClassType, we need to dig
838 if sub
== sup
then return true
840 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
841 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
842 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
843 if res
== false then return false
844 if not sup
isa MGenericType then return true
845 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
846 assert sub2
.mclass
== sup
.mclass
847 for i
in [0..sup
.mclass
.arity
[ do
848 var sub_arg
= sub2
.arguments
[i
]
849 var sup_arg
= sup
.arguments
[i
]
850 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
851 if res
== false then return false
856 # The base class type on which self is based
858 # This base type is used to get property (an internally to perform
859 # unsafe type comparison).
861 # Beware: some types (like null) are not based on a class thus this
864 # Basically, this function transform the virtual types and parameter
865 # types to their bounds.
870 # class B super A end
872 # class Y super X end
881 # Map[T,U] anchor_to H #-> Map[B,Y]
883 # Explanation of the example:
884 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
885 # because "redef type U: Y". Therefore, Map[T, U] is bound to
888 # ENSURE: `not self.need_anchor implies result == self`
889 # ENSURE: `not result.need_anchor`
890 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
892 if not need_anchor
then return self
893 assert not anchor
.need_anchor
894 # Just resolve to the anchor and clear all the virtual types
895 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
896 assert not res
.need_anchor
900 # Does `self` contain a virtual type or a formal generic parameter type?
901 # In order to remove those types, you usually want to use `anchor_to`.
902 fun need_anchor
: Bool do return true
904 # Return the supertype when adapted to a class.
906 # In Nit, for each super-class of a type, there is a equivalent super-type.
912 # class H[V] super G[V, Bool] end
914 # H[Int] supertype_to G #-> G[Int, Bool]
917 # REQUIRE: `super_mclass` is a super-class of `self`
918 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
919 # ENSURE: `result.mclass = super_mclass`
920 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
922 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
923 if self isa MClassType and self.mclass
== super_mclass
then return self
925 if self.need_anchor
then
926 assert anchor
!= null
927 resolved_self
= self.anchor_to
(mmodule
, anchor
)
931 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
932 for supertype
in supertypes
do
933 if supertype
.mclass
== super_mclass
then
934 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
935 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
941 # Replace formals generic types in self with resolved values in `mtype`
942 # If `cleanup_virtual` is true, then virtual types are also replaced
945 # This function returns self if `need_anchor` is false.
951 # class H[F] super G[F] end
955 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
956 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
958 # Explanation of the example:
959 # * Array[E].need_anchor is true because there is a formal generic parameter type E
960 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
961 # * Since "H[F] super G[F]", E is in fact F for H
962 # * More specifically, in H[Int], E is Int
963 # * So, in H[Int], Array[E] is Array[Int]
965 # This function is mainly used to inherit a signature.
966 # Because, unlike `anchor_to`, we do not want a full resolution of
967 # a type but only an adapted version of it.
973 # fun foo(e:E):E is abstract
975 # class B super A[Int] end
978 # The signature on foo is (e: E): E
979 # If we resolve the signature for B, we get (e:Int):Int
985 # fun foo(e:E):E is abstract
989 # fun bar do a.foo(x) # <- x is here
993 # The first question is: is foo available on `a`?
995 # The static type of a is `A[Array[F]]`, that is an open type.
996 # in order to find a method `foo`, whe must look at a resolved type.
998 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
1000 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
1002 # The next question is: what is the accepted types for `x`?
1004 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
1006 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
1008 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
1010 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
1011 # two function instead of one seems also to be a bad idea.
1013 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
1014 # ENSURE: `not self.need_anchor implies result == self`
1015 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
1017 # Resolve formal type to its verbatim bound.
1018 # If the type is not formal, just return self
1020 # The result is returned exactly as declared in the "type" property (verbatim).
1021 # So it could be another formal type.
1023 # In case of conflicts or inconsistencies in the model, the method returns a `MBottomType`.
1024 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1026 # Resolve the formal type to its simplest equivalent form.
1028 # Formal types are either free or fixed.
1029 # When it is fixed, it means that it is equivalent with a simpler type.
1030 # When a formal type is free, it means that it is only equivalent with itself.
1031 # This method return the most simple equivalent type of `self`.
1033 # This method is mainly used for subtype test in order to sanely compare fixed.
1035 # By default, return self.
1036 # See the redefinitions for specific behavior in each kind of type.
1038 # In case of conflicts or inconsistencies in the model, the method returns a `MBottomType`.
1039 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1041 # Can the type be resolved?
1043 # In order to resolve open types, the formal types must make sence.
1053 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
1055 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
1057 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
1058 # # B[E] is a red hearing only the E is important,
1059 # # E make sense in A
1062 # REQUIRE: `anchor != null implies not anchor.need_anchor`
1063 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
1064 # ENSURE: `not self.need_anchor implies result == true`
1065 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
1067 # Return the nullable version of the type
1068 # If the type is already nullable then self is returned
1069 fun as_nullable
: MType
1071 var res
= self.as_nullable_cache
1072 if res
!= null then return res
1073 res
= new MNullableType(self)
1074 self.as_nullable_cache
= res
1078 # Remove the base type of a decorated (proxy) type.
1079 # Is the type is not decorated, then self is returned.
1081 # Most of the time it is used to return the not nullable version of a nullable type.
1082 # In this case, this just remove the `nullable` notation, but the result can still contains null.
1083 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
1084 # If you really want to exclude the `null` value, then use `as_notnull`
1085 fun undecorate
: MType
1090 # Returns the not null version of the type.
1091 # That is `self` minus the `null` value.
1093 # For most types, this return `self`.
1094 # For formal types, this returns a special `MNotNullType`
1095 fun as_notnull
: MType do return self
1097 private var as_nullable_cache
: nullable MType = null
1100 # The depth of the type seen as a tree.
1107 # Formal types have a depth of 1.
1113 # The length of the type seen as a tree.
1120 # Formal types have a length of 1.
1126 # Compute all the classdefs inherited/imported.
1127 # The returned set contains:
1128 # * the class definitions from `mmodule` and its imported modules
1129 # * the class definitions of this type and its super-types
1131 # This function is used mainly internally.
1133 # REQUIRE: `not self.need_anchor`
1134 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1136 # Compute all the super-classes.
1137 # This function is used mainly internally.
1139 # REQUIRE: `not self.need_anchor`
1140 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1142 # Compute all the declared super-types.
1143 # Super-types are returned as declared in the classdefs (verbatim).
1144 # This function is used mainly internally.
1146 # REQUIRE: `not self.need_anchor`
1147 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1149 # Is the property in self for a given module
1150 # This method does not filter visibility or whatever
1152 # REQUIRE: `not self.need_anchor`
1153 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1155 assert not self.need_anchor
1156 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1160 # A type based on a class.
1162 # `MClassType` have properties (see `has_mproperty`).
1166 # The associated class
1169 redef fun model
do return self.mclass
.intro_mmodule
.model
1171 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1173 # The formal arguments of the type
1174 # ENSURE: `result.length == self.mclass.arity`
1175 var arguments
= new Array[MType]
1177 redef fun to_s
do return mclass
.to_s
1179 redef fun full_name
do return mclass
.full_name
1181 redef fun c_name
do return mclass
.c_name
1183 redef fun need_anchor
do return false
1185 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1187 return super.as(MClassType)
1190 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1192 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1194 redef fun collect_mclassdefs
(mmodule
)
1196 assert not self.need_anchor
1197 var cache
= self.collect_mclassdefs_cache
1198 if not cache
.has_key
(mmodule
) then
1199 self.collect_things
(mmodule
)
1201 return cache
[mmodule
]
1204 redef fun collect_mclasses
(mmodule
)
1206 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1207 assert not self.need_anchor
1208 var cache
= self.collect_mclasses_cache
1209 if not cache
.has_key
(mmodule
) then
1210 self.collect_things
(mmodule
)
1212 var res
= cache
[mmodule
]
1213 collect_mclasses_last_module
= mmodule
1214 collect_mclasses_last_module_cache
= res
1218 private var collect_mclasses_last_module
: nullable MModule = null
1219 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1221 redef fun collect_mtypes
(mmodule
)
1223 assert not self.need_anchor
1224 var cache
= self.collect_mtypes_cache
1225 if not cache
.has_key
(mmodule
) then
1226 self.collect_things
(mmodule
)
1228 return cache
[mmodule
]
1231 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1232 private fun collect_things
(mmodule
: MModule)
1234 var res
= new HashSet[MClassDef]
1235 var seen
= new HashSet[MClass]
1236 var types
= new HashSet[MClassType]
1237 seen
.add
(self.mclass
)
1238 var todo
= [self.mclass
]
1239 while not todo
.is_empty
do
1240 var mclass
= todo
.pop
1241 #print "process {mclass}"
1242 for mclassdef
in mclass
.mclassdefs
do
1243 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1244 #print " process {mclassdef}"
1246 for supertype
in mclassdef
.supertypes
do
1247 types
.add
(supertype
)
1248 var superclass
= supertype
.mclass
1249 if seen
.has
(superclass
) then continue
1250 #print " add {superclass}"
1251 seen
.add
(superclass
)
1252 todo
.add
(superclass
)
1256 collect_mclassdefs_cache
[mmodule
] = res
1257 collect_mclasses_cache
[mmodule
] = seen
1258 collect_mtypes_cache
[mmodule
] = types
1261 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1262 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1263 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1267 # A type based on a generic class.
1268 # A generic type a just a class with additional formal generic arguments.
1274 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1278 assert self.mclass
.arity
== arguments
.length
1280 self.need_anchor
= false
1281 for t
in arguments
do
1282 if t
.need_anchor
then
1283 self.need_anchor
= true
1288 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1291 # The short-name of the class, then the full-name of each type arguments within brackets.
1292 # Example: `"Map[String, List[Int]]"`
1293 redef var to_s
is noinit
1295 # The full-name of the class, then the full-name of each type arguments within brackets.
1296 # Example: `"core::Map[core::String, core::List[core::Int]]"`
1297 redef var full_name
is lazy
do
1298 var args
= new Array[String]
1299 for t
in arguments
do
1300 args
.add t
.full_name
1302 return "{mclass.full_name}[{args.join(", ")}]"
1305 redef var c_name
is lazy
do
1306 var res
= mclass
.c_name
1307 # Note: because the arity is known, a prefix notation is enough
1308 for t
in arguments
do
1315 redef var need_anchor
is noinit
1317 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1319 if not need_anchor
then return self
1320 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1321 var types
= new Array[MType]
1322 for t
in arguments
do
1323 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1325 return mclass
.get_mtype
(types
)
1328 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1330 if not need_anchor
then return true
1331 for t
in arguments
do
1332 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1341 for a
in self.arguments
do
1343 if d
> dmax
then dmax
= d
1351 for a
in self.arguments
do
1358 # A formal type (either virtual of parametric).
1360 # The main issue with formal types is that they offer very little information on their own
1361 # and need a context (anchor and mmodule) to be useful.
1362 abstract class MFormalType
1365 redef var as_notnull
= new MNotNullType(self) is lazy
1368 # A virtual formal type.
1372 # The property associated with the type.
1373 # Its the definitions of this property that determine the bound or the virtual type.
1374 var mproperty
: MVirtualTypeProp
1376 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1378 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1380 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
or else new MBottomType(model
)
1383 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1385 assert not resolved_receiver
.need_anchor
1386 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1387 if props
.is_empty
then
1389 else if props
.length
== 1 then
1392 var types
= new ArraySet[MType]
1393 var res
= props
.first
1395 types
.add
(p
.bound
.as(not null))
1396 if not res
.is_fixed
then res
= p
1398 if types
.length
== 1 then
1404 # A VT is fixed when:
1405 # * the VT is (re-)defined with the annotation `is fixed`
1406 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1407 # * the receiver is an enum class since there is no subtype possible
1408 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1410 assert not resolved_receiver
.need_anchor
1411 resolved_receiver
= resolved_receiver
.undecorate
1412 assert resolved_receiver
isa MClassType # It is the only remaining type
1414 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1415 var res
= prop
.bound
1416 if res
== null then return new MBottomType(model
)
1418 # Recursively lookup the fixed result
1419 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1421 # 1. For a fixed VT, return the resolved bound
1422 if prop
.is_fixed
then return res
1424 # 2. For a enum boud, return the bound
1425 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1427 # 3. for a enum receiver return the bound
1428 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1433 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1435 if not cleanup_virtual
then return self
1436 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1437 # self is a virtual type declared (or inherited) in mtype
1438 # The point of the function it to get the bound of the virtual type that make sense for mtype
1439 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1440 #print "{class_name}: {self}/{mtype}/{anchor}?"
1441 var resolved_receiver
1442 if mtype
.need_anchor
then
1443 assert anchor
!= null
1444 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1446 resolved_receiver
= mtype
1448 # Now, we can get the bound
1449 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1450 # The bound is exactly as declared in the "type" property, so we must resolve it again
1451 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1456 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1458 if mtype
.need_anchor
then
1459 assert anchor
!= null
1460 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1462 return mtype
.has_mproperty
(mmodule
, mproperty
)
1465 redef fun to_s
do return self.mproperty
.to_s
1467 redef fun full_name
do return self.mproperty
.full_name
1469 redef fun c_name
do return self.mproperty
.c_name
1472 # The type associated to a formal parameter generic type of a class
1474 # Each parameter type is associated to a specific class.
1475 # It means that all refinements of a same class "share" the parameter type,
1476 # but that a generic subclass has its own parameter types.
1478 # However, in the sense of the meta-model, a parameter type of a class is
1479 # a valid type in a subclass. The "in the sense of the meta-model" is
1480 # important because, in the Nit language, the programmer cannot refers
1481 # directly to the parameter types of the super-classes.
1486 # fun e: E is abstract
1492 # In the class definition B[F], `F` is a valid type but `E` is not.
1493 # However, `self.e` is a valid method call, and the signature of `e` is
1496 # Note that parameter types are shared among class refinements.
1497 # Therefore parameter only have an internal name (see `to_s` for details).
1498 class MParameterType
1501 # The generic class where the parameter belong
1504 redef fun model
do return self.mclass
.intro_mmodule
.model
1506 # The position of the parameter (0 for the first parameter)
1507 # FIXME: is `position` a better name?
1512 redef fun to_s
do return name
1514 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1516 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1518 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1520 assert not resolved_receiver
.need_anchor
1521 resolved_receiver
= resolved_receiver
.undecorate
1522 assert resolved_receiver
isa MClassType # It is the only remaining type
1523 var goalclass
= self.mclass
1524 if resolved_receiver
.mclass
== goalclass
then
1525 return resolved_receiver
.arguments
[self.rank
]
1527 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1528 for t
in supertypes
do
1529 if t
.mclass
== goalclass
then
1530 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1531 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1532 var res
= t
.arguments
[self.rank
]
1539 # A PT is fixed when:
1540 # * Its bound is a enum class (see `enum_kind`).
1541 # The PT is just useless, but it is still a case.
1542 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1543 # so it is necessarily fixed in a `super` clause, either with a normal type
1544 # or with another PT.
1545 # See `resolve_for` for examples about related issues.
1546 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1548 assert not resolved_receiver
.need_anchor
1549 resolved_receiver
= resolved_receiver
.undecorate
1550 assert resolved_receiver
isa MClassType # It is the only remaining type
1551 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1555 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1557 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1558 #print "{class_name}: {self}/{mtype}/{anchor}?"
1560 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1561 var res
= mtype
.arguments
[self.rank
]
1562 if anchor
!= null and res
.need_anchor
then
1563 # Maybe the result can be resolved more if are bound to a final class
1564 var r2
= res
.anchor_to
(mmodule
, anchor
)
1565 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1570 # self is a parameter type of mtype (or of a super-class of mtype)
1571 # The point of the function it to get the bound of the virtual type that make sense for mtype
1572 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1573 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1574 var resolved_receiver
1575 if mtype
.need_anchor
then
1576 assert anchor
!= null
1577 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1579 resolved_receiver
= mtype
1581 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1582 if resolved_receiver
isa MParameterType then
1583 assert anchor
!= null
1584 assert resolved_receiver
.mclass
== anchor
.mclass
1585 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1586 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1588 assert resolved_receiver
isa MClassType # It is the only remaining type
1590 # Eh! The parameter is in the current class.
1591 # So we return the corresponding argument, no mater what!
1592 if resolved_receiver
.mclass
== self.mclass
then
1593 var res
= resolved_receiver
.arguments
[self.rank
]
1594 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1598 if resolved_receiver
.need_anchor
then
1599 assert anchor
!= null
1600 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1602 # Now, we can get the bound
1603 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1604 # The bound is exactly as declared in the "type" property, so we must resolve it again
1605 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1607 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1612 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1614 if mtype
.need_anchor
then
1615 assert anchor
!= null
1616 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1618 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1622 # A type that decorates another type.
1624 # The point of this class is to provide a common implementation of sevices that just forward to the original type.
1625 # Specific decorator are expected to redefine (or to extend) the default implementation as this suit them.
1626 abstract class MProxyType
1631 redef fun model
do return self.mtype
.model
1632 redef fun need_anchor
do return mtype
.need_anchor
1633 redef fun as_nullable
do return mtype
.as_nullable
1634 redef fun as_notnull
do return mtype
.as_notnull
1635 redef fun undecorate
do return mtype
.undecorate
1636 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1638 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1642 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1644 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1647 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1649 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1653 redef fun depth
do return self.mtype
.depth
1655 redef fun length
do return self.mtype
.length
1657 redef fun collect_mclassdefs
(mmodule
)
1659 assert not self.need_anchor
1660 return self.mtype
.collect_mclassdefs
(mmodule
)
1663 redef fun collect_mclasses
(mmodule
)
1665 assert not self.need_anchor
1666 return self.mtype
.collect_mclasses
(mmodule
)
1669 redef fun collect_mtypes
(mmodule
)
1671 assert not self.need_anchor
1672 return self.mtype
.collect_mtypes
(mmodule
)
1676 # A type prefixed with "nullable"
1682 self.to_s
= "nullable {mtype}"
1685 redef var to_s
is noinit
1687 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1689 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1691 redef fun as_nullable
do return self
1692 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1695 return res
.as_nullable
1698 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1699 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1702 if t
== mtype
then return self
1703 return t
.as_nullable
1707 # A non-null version of a formal type.
1709 # When a formal type in bounded to a nullable type, this is the type of the not null version of it.
1713 redef fun to_s
do return "not null {mtype}"
1714 redef var full_name
is lazy
do return "not null {mtype.full_name}"
1715 redef var c_name
is lazy
do return "notnull__{mtype.c_name}"
1717 redef fun as_notnull
do return self
1719 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1722 return res
.as_notnull
1725 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_notnull`
1726 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1729 if t
== mtype
then return self
1734 # The type of the only value null
1736 # The is only one null type per model, see `MModel::null_type`.
1740 redef fun to_s
do return "null"
1741 redef fun full_name
do return "null"
1742 redef fun c_name
do return "null"
1743 redef fun as_nullable
do return self
1745 redef var as_notnull
= new MBottomType(model
) is lazy
1746 redef fun need_anchor
do return false
1747 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1748 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1750 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1752 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1754 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1757 # The special universal most specific type.
1759 # This type is intended to be only used internally for type computation or analysis and should not be exposed to the user.
1760 # The bottom type can de used to denote things that are absurd, dead, or the absence of knowledge.
1762 # Semantically it is the singleton `null.as_notnull`.
1766 redef fun to_s
do return "bottom"
1767 redef fun full_name
do return "bottom"
1768 redef fun c_name
do return "bottom"
1769 redef fun as_nullable
do return model
.null_type
1770 redef fun as_notnull
do return self
1771 redef fun need_anchor
do return false
1772 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1773 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1775 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1777 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1779 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1782 # A signature of a method
1786 # The each parameter (in order)
1787 var mparameters
: Array[MParameter]
1789 # Returns a parameter named `name`, if any.
1790 fun mparameter_by_name
(name
: String): nullable MParameter
1792 for p
in mparameters
do
1793 if p
.name
== name
then return p
1798 # The return type (null for a procedure)
1799 var return_mtype
: nullable MType
1804 var t
= self.return_mtype
1805 if t
!= null then dmax
= t
.depth
1806 for p
in mparameters
do
1807 var d
= p
.mtype
.depth
1808 if d
> dmax
then dmax
= d
1816 var t
= self.return_mtype
1817 if t
!= null then res
+= t
.length
1818 for p
in mparameters
do
1819 res
+= p
.mtype
.length
1824 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1827 var vararg_rank
= -1
1828 for i
in [0..mparameters
.length
[ do
1829 var parameter
= mparameters
[i
]
1830 if parameter
.is_vararg
then
1831 if vararg_rank
>= 0 then
1832 # If there is more than one vararg,
1833 # consider that additional arguments cannot be mapped.
1840 self.vararg_rank
= vararg_rank
1843 # The rank of the main ellipsis (`...`) for vararg (starting from 0).
1844 # value is -1 if there is no vararg.
1845 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1847 # From a model POV, a signature can contain more than one vararg parameter,
1848 # the `vararg_rank` just indicates the one that will receive the additional arguments.
1849 # However, currently, if there is more that one vararg parameter, no one will be the main one,
1850 # and additional arguments will be refused.
1851 var vararg_rank
: Int is noinit
1853 # The number of parameters
1854 fun arity
: Int do return mparameters
.length
1858 var b
= new FlatBuffer
1859 if not mparameters
.is_empty
then
1861 for i
in [0..mparameters
.length
[ do
1862 var mparameter
= mparameters
[i
]
1863 if i
> 0 then b
.append
(", ")
1864 b
.append
(mparameter
.name
)
1866 b
.append
(mparameter
.mtype
.to_s
)
1867 if mparameter
.is_vararg
then
1873 var ret
= self.return_mtype
1881 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1883 var params
= new Array[MParameter]
1884 for p
in self.mparameters
do
1885 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1887 var ret
= self.return_mtype
1889 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1891 var res
= new MSignature(params
, ret
)
1896 # A parameter in a signature
1900 # The name of the parameter
1903 # The static type of the parameter
1906 # Is the parameter a vararg?
1912 return "{name}: {mtype}..."
1914 return "{name}: {mtype}"
1918 # Returns a new parameter with the `mtype` resolved.
1919 # See `MType::resolve_for` for details.
1920 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1922 if not self.mtype
.need_anchor
then return self
1923 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1924 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1928 redef fun model
do return mtype
.model
1931 # A service (global property) that generalize method, attribute, etc.
1933 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1934 # to a specific `MModule` nor a specific `MClass`.
1936 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1937 # and the other in subclasses and in refinements.
1939 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1940 # of any dynamic type).
1941 # For instance, a call site "x.foo" is associated to a `MProperty`.
1942 abstract class MProperty
1945 # The associated MPropDef subclass.
1946 # The two specialization hierarchy are symmetric.
1947 type MPROPDEF: MPropDef
1949 # The classdef that introduce the property
1950 # While a property is not bound to a specific module, or class,
1951 # the introducing mclassdef is used for naming and visibility
1952 var intro_mclassdef
: MClassDef
1954 # The (short) name of the property
1957 # The canonical name of the property.
1959 # It is the short-`name` prefixed by the short-name of the class and the full-name of the module.
1960 # Example: "my_package::my_module::MyClass::my_method"
1961 redef var full_name
is lazy
do
1962 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
1965 redef var c_name
is lazy
do
1966 # FIXME use `namespace_for`
1967 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
1970 # The visibility of the property
1971 var visibility
: MVisibility
1973 # Is the property usable as an initializer?
1974 var is_autoinit
= false is writable
1978 intro_mclassdef
.intro_mproperties
.add
(self)
1979 var model
= intro_mclassdef
.mmodule
.model
1980 model
.mproperties_by_name
.add_one
(name
, self)
1981 model
.mproperties
.add
(self)
1984 # All definitions of the property.
1985 # The first is the introduction,
1986 # The other are redefinitions (in refinements and in subclasses)
1987 var mpropdefs
= new Array[MPROPDEF]
1989 # The definition that introduces the property.
1991 # Warning: such a definition may not exist in the early life of the object.
1992 # In this case, the method will abort.
1993 var intro
: MPROPDEF is noinit
1995 redef fun model
do return intro
.model
1998 redef fun to_s
do return name
2000 # Return the most specific property definitions defined or inherited by a type.
2001 # The selection knows that refinement is stronger than specialization;
2002 # however, in case of conflict more than one property are returned.
2003 # If mtype does not know mproperty then an empty array is returned.
2005 # If you want the really most specific property, then look at `lookup_first_definition`
2007 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2008 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
2009 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2011 assert not mtype
.need_anchor
2012 mtype
= mtype
.undecorate
2014 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
2015 if cache
!= null then return cache
2017 #print "select prop {mproperty} for {mtype} in {self}"
2018 # First, select all candidates
2019 var candidates
= new Array[MPROPDEF]
2020 for mpropdef
in self.mpropdefs
do
2021 # If the definition is not imported by the module, then skip
2022 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2023 # If the definition is not inherited by the type, then skip
2024 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2026 candidates
.add
(mpropdef
)
2028 # Fast track for only one candidate
2029 if candidates
.length
<= 1 then
2030 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
2034 # Second, filter the most specific ones
2035 return select_most_specific
(mmodule
, candidates
)
2038 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2040 # Return the most specific property definitions inherited by a type.
2041 # The selection knows that refinement is stronger than specialization;
2042 # however, in case of conflict more than one property are returned.
2043 # If mtype does not know mproperty then an empty array is returned.
2045 # If you want the really most specific property, then look at `lookup_next_definition`
2047 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2048 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
2049 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2051 assert not mtype
.need_anchor
2052 mtype
= mtype
.undecorate
2054 # First, select all candidates
2055 var candidates
= new Array[MPROPDEF]
2056 for mpropdef
in self.mpropdefs
do
2057 # If the definition is not imported by the module, then skip
2058 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2059 # If the definition is not inherited by the type, then skip
2060 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2061 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
2062 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
2064 candidates
.add
(mpropdef
)
2066 # Fast track for only one candidate
2067 if candidates
.length
<= 1 then return candidates
2069 # Second, filter the most specific ones
2070 return select_most_specific
(mmodule
, candidates
)
2073 # Return an array containing olny the most specific property definitions
2074 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
2075 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
2077 var res
= new Array[MPROPDEF]
2078 for pd1
in candidates
do
2079 var cd1
= pd1
.mclassdef
2082 for pd2
in candidates
do
2083 if pd2
== pd1
then continue # do not compare with self!
2084 var cd2
= pd2
.mclassdef
2086 if c2
.mclass_type
== c1
.mclass_type
then
2087 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
2088 # cd2 refines cd1; therefore we skip pd1
2092 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
2093 # cd2 < cd1; therefore we skip pd1
2102 if res
.is_empty
then
2103 print
"All lost! {candidates.join(", ")}"
2104 # FIXME: should be abort!
2109 # Return the most specific definition in the linearization of `mtype`.
2111 # If you want to know the next properties in the linearization,
2112 # look at `MPropDef::lookup_next_definition`.
2114 # FIXME: the linearization is still unspecified
2116 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2117 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2118 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2120 return lookup_all_definitions
(mmodule
, mtype
).first
2123 # Return all definitions in a linearization order
2124 # Most specific first, most general last
2126 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2127 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2128 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2130 mtype
= mtype
.undecorate
2132 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
2133 if cache
!= null then return cache
2135 assert not mtype
.need_anchor
2136 assert mtype
.has_mproperty
(mmodule
, self)
2138 #print "select prop {mproperty} for {mtype} in {self}"
2139 # First, select all candidates
2140 var candidates
= new Array[MPROPDEF]
2141 for mpropdef
in self.mpropdefs
do
2142 # If the definition is not imported by the module, then skip
2143 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2144 # If the definition is not inherited by the type, then skip
2145 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2147 candidates
.add
(mpropdef
)
2149 # Fast track for only one candidate
2150 if candidates
.length
<= 1 then
2151 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2155 mmodule
.linearize_mpropdefs
(candidates
)
2156 candidates
= candidates
.reversed
2157 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2161 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2168 redef type MPROPDEF: MMethodDef
2170 # Is the property defined at the top_level of the module?
2171 # Currently such a property are stored in `Object`
2172 var is_toplevel
: Bool = false is writable
2174 # Is the property a constructor?
2175 # Warning, this property can be inherited by subclasses with or without being a constructor
2176 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
2177 var is_init
: Bool = false is writable
2179 # The constructor is a (the) root init with empty signature but a set of initializers
2180 var is_root_init
: Bool = false is writable
2182 # Is the property a 'new' constructor?
2183 var is_new
: Bool = false is writable
2185 # Is the property a legal constructor for a given class?
2186 # As usual, visibility is not considered.
2187 # FIXME not implemented
2188 fun is_init_for
(mclass
: MClass): Bool
2193 # A specific method that is safe to call on null.
2194 # Currently, only `==`, `!=` and `is_same_instance` are safe
2195 fun is_null_safe
: Bool do return name
== "==" or name
== "!=" or name
== "is_same_instance"
2198 # A global attribute
2202 redef type MPROPDEF: MAttributeDef
2206 # A global virtual type
2207 class MVirtualTypeProp
2210 redef type MPROPDEF: MVirtualTypeDef
2212 # The formal type associated to the virtual type property
2213 var mvirtualtype
= new MVirtualType(self)
2216 # A definition of a property (local property)
2218 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2219 # specific class definition (which belong to a specific module)
2220 abstract class MPropDef
2223 # The associated `MProperty` subclass.
2224 # the two specialization hierarchy are symmetric
2225 type MPROPERTY: MProperty
2228 type MPROPDEF: MPropDef
2230 # The class definition where the property definition is
2231 var mclassdef
: MClassDef
2233 # The associated global property
2234 var mproperty
: MPROPERTY
2236 # The origin of the definition
2237 var location
: Location
2241 mclassdef
.mpropdefs
.add
(self)
2242 mproperty
.mpropdefs
.add
(self)
2243 if mproperty
.intro_mclassdef
== mclassdef
then
2244 assert not isset mproperty
._intro
2245 mproperty
.intro
= self
2247 self.to_s
= "{mclassdef}#{mproperty}"
2250 # Actually the name of the `mproperty`
2251 redef fun name
do return mproperty
.name
2253 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2255 # Therefore the combination of identifiers is awful,
2256 # the worst case being
2258 # * a property "p::m::A::x"
2259 # * redefined in a refinement of a class "q::n::B"
2260 # * in a module "r::o"
2261 # * so "r::o#q::n::B#p::m::A::x"
2263 # Fortunately, the full-name is simplified when entities are repeated.
2264 # For the previous case, the simplest form is "p#A#x".
2265 redef var full_name
is lazy
do
2266 var res
= new FlatBuffer
2268 # The first part is the mclassdef. Worst case is "r::o#q::n::B"
2269 res
.append mclassdef
.full_name
2273 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2274 # intro are unambiguous in a class
2277 # Just try to simplify each part
2278 if mclassdef
.mmodule
.mpackage
!= mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2279 # precise "p::m" only if "p" != "r"
2280 res
.append mproperty
.intro_mclassdef
.mmodule
.full_name
2282 else if mproperty
.visibility
<= private_visibility
then
2283 # Same package ("p"=="q"), but private visibility,
2284 # does the module part ("::m") need to be displayed
2285 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2287 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2291 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2292 # precise "B" only if not the same class than "A"
2293 res
.append mproperty
.intro_mclassdef
.name
2296 # Always use the property name "x"
2297 res
.append mproperty
.name
2302 redef var c_name
is lazy
do
2303 var res
= new FlatBuffer
2304 res
.append mclassdef
.c_name
2306 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2307 res
.append name
.to_cmangle
2309 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2310 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2313 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2314 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2317 res
.append mproperty
.name
.to_cmangle
2322 redef fun model
do return mclassdef
.model
2324 # Internal name combining the module, the class and the property
2325 # Example: "mymodule#MyClass#mymethod"
2326 redef var to_s
is noinit
2328 # Is self the definition that introduce the property?
2329 fun is_intro
: Bool do return isset mproperty
._intro
and mproperty
.intro
== self
2331 # Return the next definition in linearization of `mtype`.
2333 # This method is used to determine what method is called by a super.
2335 # REQUIRE: `not mtype.need_anchor`
2336 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2338 assert not mtype
.need_anchor
2340 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2341 var i
= mpropdefs
.iterator
2342 while i
.is_ok
and i
.item
!= self do i
.next
2343 assert has_property
: i
.is_ok
2345 assert has_next_property
: i
.is_ok
2350 # A local definition of a method
2354 redef type MPROPERTY: MMethod
2355 redef type MPROPDEF: MMethodDef
2357 # The signature attached to the property definition
2358 var msignature
: nullable MSignature = null is writable
2360 # The signature attached to the `new` call on a root-init
2361 # This is a concatenation of the signatures of the initializers
2363 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2364 var new_msignature
: nullable MSignature = null is writable
2366 # List of initialisers to call in root-inits
2368 # They could be setters or attributes
2370 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2371 var initializers
= new Array[MProperty]
2373 # Is the method definition abstract?
2374 var is_abstract
: Bool = false is writable
2376 # Is the method definition intern?
2377 var is_intern
= false is writable
2379 # Is the method definition extern?
2380 var is_extern
= false is writable
2382 # An optional constant value returned in functions.
2384 # Only some specific primitife value are accepted by engines.
2385 # Is used when there is no better implementation available.
2387 # Currently used only for the implementation of the `--define`
2388 # command-line option.
2389 # SEE: module `mixin`.
2390 var constant_value
: nullable Object = null is writable
2393 # A local definition of an attribute
2397 redef type MPROPERTY: MAttribute
2398 redef type MPROPDEF: MAttributeDef
2400 # The static type of the attribute
2401 var static_mtype
: nullable MType = null is writable
2404 # A local definition of a virtual type
2405 class MVirtualTypeDef
2408 redef type MPROPERTY: MVirtualTypeProp
2409 redef type MPROPDEF: MVirtualTypeDef
2411 # The bound of the virtual type
2412 var bound
: nullable MType = null is writable
2414 # Is the bound fixed?
2415 var is_fixed
= false is writable
2422 # * `interface_kind`
2426 # Note this class is basically an enum.
2427 # FIXME: use a real enum once user-defined enums are available
2431 # Is a constructor required?
2434 # TODO: private init because enumeration.
2436 # Can a class of kind `self` specializes a class of kine `other`?
2437 fun can_specialize
(other
: MClassKind): Bool
2439 if other
== interface_kind
then return true # everybody can specialize interfaces
2440 if self == interface_kind
or self == enum_kind
then
2441 # no other case for interfaces
2443 else if self == extern_kind
then
2444 # only compatible with themselves
2445 return self == other
2446 else if other
== enum_kind
or other
== extern_kind
then
2447 # abstract_kind and concrete_kind are incompatible
2450 # remain only abstract_kind and concrete_kind
2455 # The class kind `abstract`
2456 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2457 # The class kind `concrete`
2458 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2459 # The class kind `interface`
2460 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2461 # The class kind `enum`
2462 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2463 # The class kind `extern`
2464 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)