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 class 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 ans 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 `NativeString`
256 var native_string_type
: MClassType = self.get_primitive_class
("NativeString").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
("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
("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_or_fallback
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
606 redef var location
: Location
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 definitions in the class (introductions and redefinitions)
724 var mpropdefs
= new Array[MPropDef]
726 # The special autoinit constructor
727 var auto_init
: nullable MMethodDef = null is writable
730 # A global static type
732 # MType are global to the model; it means that a `MType` is not bound to a
733 # specific `MModule`.
734 # This characteristic helps the reasoning about static types in a program
735 # since a single `MType` object always denote the same type.
737 # However, because a `MType` is global, it does not really have properties
738 # nor have subtypes to a hierarchy since the property and the class hierarchy
739 # depends of a module.
740 # Moreover, virtual types an formal generic parameter types also depends on
741 # a receiver to have sense.
743 # Therefore, most method of the types require a module and an anchor.
744 # The module is used to know what are the classes and the specialization
746 # The anchor is used to know what is the bound of the virtual types and formal
747 # generic parameter types.
749 # MType are not directly usable to get properties. See the `anchor_to` method
750 # and the `MClassType` class.
752 # FIXME: the order of the parameters is not the best. We mus pick on from:
753 # * foo(mmodule, anchor, othertype)
754 # * foo(othertype, anchor, mmodule)
755 # * foo(anchor, mmodule, othertype)
756 # * foo(othertype, mmodule, anchor)
760 redef fun name
do return to_s
762 # Return true if `self` is an subtype of `sup`.
763 # The typing is done using the standard typing policy of Nit.
765 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
766 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
767 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
770 if sub
== sup
then return true
772 #print "1.is {sub} a {sup}? ===="
774 if anchor
== null then
775 assert not sub
.need_anchor
776 assert not sup
.need_anchor
778 # First, resolve the formal types to the simplest equivalent forms in the receiver
779 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
780 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
781 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
782 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
785 # Does `sup` accept null or not?
786 # Discard the nullable marker if it exists
787 var sup_accept_null
= false
788 if sup
isa MNullableType then
789 sup_accept_null
= true
791 else if sup
isa MNotNullType then
793 else if sup
isa MNullType then
794 sup_accept_null
= true
797 # Can `sub` provide null or not?
798 # Thus we can match with `sup_accept_null`
799 # Also discard the nullable marker if it exists
800 var sub_reject_null
= false
801 if sub
isa MNullableType then
802 if not sup_accept_null
then return false
804 else if sub
isa MNotNullType then
805 sub_reject_null
= true
807 else if sub
isa MNullType then
808 return sup_accept_null
810 # Now the case of direct null and nullable is over.
812 # If `sub` is a formal type, then it is accepted if its bound is accepted
813 while sub
isa MFormalType do
814 #print "3.is {sub} a {sup}?"
816 # A unfixed formal type can only accept itself
817 if sub
== sup
then return true
819 assert anchor
!= null
820 sub
= sub
.lookup_bound
(mmodule
, anchor
)
821 if sub_reject_null
then sub
= sub
.as_notnull
823 #print "3.is {sub} a {sup}?"
825 # Manage the second layer of null/nullable
826 if sub
isa MNullableType then
827 if not sup_accept_null
and not sub_reject_null
then return false
829 else if sub
isa MNotNullType then
830 sub_reject_null
= true
832 else if sub
isa MNullType then
833 return sup_accept_null
836 #print "4.is {sub} a {sup}? <- no more resolution"
838 if sub
isa MBottomType then
842 assert sub
isa MClassType else print
"{sub} <? {sub}" # It is the only remaining type
844 # Handle sup-type when the sub-type is class-based (other cases must have be identified before).
845 if sup
isa MFormalType or sup
isa MNullType or sup
isa MBottomType then
846 # These types are not super-types of Class-based types.
850 assert sup
isa MClassType else print
"got {sup} {sub.inspect}" # It is the only remaining type
852 # Now both are MClassType, we need to dig
854 if sub
== sup
then return true
856 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
857 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
858 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
859 if res
== false then return false
860 if not sup
isa MGenericType then return true
861 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
862 assert sub2
.mclass
== sup
.mclass
863 for i
in [0..sup
.mclass
.arity
[ do
864 var sub_arg
= sub2
.arguments
[i
]
865 var sup_arg
= sup
.arguments
[i
]
866 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
867 if res
== false then return false
872 # The base class type on which self is based
874 # This base type is used to get property (an internally to perform
875 # unsafe type comparison).
877 # Beware: some types (like null) are not based on a class thus this
880 # Basically, this function transform the virtual types and parameter
881 # types to their bounds.
886 # class B super A end
888 # class Y super X end
897 # Map[T,U] anchor_to H #-> Map[B,Y]
899 # Explanation of the example:
900 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
901 # because "redef type U: Y". Therefore, Map[T, U] is bound to
904 # ENSURE: `not self.need_anchor implies result == self`
905 # ENSURE: `not result.need_anchor`
906 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
908 if not need_anchor
then return self
909 assert not anchor
.need_anchor
910 # Just resolve to the anchor and clear all the virtual types
911 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
912 assert not res
.need_anchor
916 # Does `self` contain a virtual type or a formal generic parameter type?
917 # In order to remove those types, you usually want to use `anchor_to`.
918 fun need_anchor
: Bool do return true
920 # Return the supertype when adapted to a class.
922 # In Nit, for each super-class of a type, there is a equivalent super-type.
928 # class H[V] super G[V, Bool] end
930 # H[Int] supertype_to G #-> G[Int, Bool]
933 # REQUIRE: `super_mclass` is a super-class of `self`
934 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
935 # ENSURE: `result.mclass = super_mclass`
936 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
938 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
939 if self isa MClassType and self.mclass
== super_mclass
then return self
941 if self.need_anchor
then
942 assert anchor
!= null
943 resolved_self
= self.anchor_to
(mmodule
, anchor
)
947 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
948 for supertype
in supertypes
do
949 if supertype
.mclass
== super_mclass
then
950 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
951 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
957 # Replace formals generic types in self with resolved values in `mtype`
958 # If `cleanup_virtual` is true, then virtual types are also replaced
961 # This function returns self if `need_anchor` is false.
967 # class H[F] super G[F] end
971 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
972 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
974 # Explanation of the example:
975 # * Array[E].need_anchor is true because there is a formal generic parameter type E
976 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
977 # * Since "H[F] super G[F]", E is in fact F for H
978 # * More specifically, in H[Int], E is Int
979 # * So, in H[Int], Array[E] is Array[Int]
981 # This function is mainly used to inherit a signature.
982 # Because, unlike `anchor_to`, we do not want a full resolution of
983 # a type but only an adapted version of it.
989 # fun foo(e:E):E is abstract
991 # class B super A[Int] end
994 # The signature on foo is (e: E): E
995 # If we resolve the signature for B, we get (e:Int):Int
1001 # fun foo(e:E):E is abstract
1004 # var a: A[Array[F]]
1005 # fun bar do a.foo(x) # <- x is here
1009 # The first question is: is foo available on `a`?
1011 # The static type of a is `A[Array[F]]`, that is an open type.
1012 # in order to find a method `foo`, whe must look at a resolved type.
1014 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
1016 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
1018 # The next question is: what is the accepted types for `x`?
1020 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
1022 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
1024 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
1026 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
1027 # two function instead of one seems also to be a bad idea.
1029 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
1030 # ENSURE: `not self.need_anchor implies result == self`
1031 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
1033 # Resolve formal type to its verbatim bound.
1034 # If the type is not formal, just return self
1036 # The result is returned exactly as declared in the "type" property (verbatim).
1037 # So it could be another formal type.
1039 # In case of conflicts or inconsistencies in the model, the method returns a `MBottomType`.
1040 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1042 # Resolve the formal type to its simplest equivalent form.
1044 # Formal types are either free or fixed.
1045 # When it is fixed, it means that it is equivalent with a simpler type.
1046 # When a formal type is free, it means that it is only equivalent with itself.
1047 # This method return the most simple equivalent type of `self`.
1049 # This method is mainly used for subtype test in order to sanely compare fixed.
1051 # By default, return self.
1052 # See the redefinitions for specific behavior in each kind of type.
1054 # In case of conflicts or inconsistencies in the model, the method returns a `MBottomType`.
1055 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1057 # Can the type be resolved?
1059 # In order to resolve open types, the formal types must make sence.
1069 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
1071 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
1073 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
1074 # # B[E] is a red hearing only the E is important,
1075 # # E make sense in A
1078 # REQUIRE: `anchor != null implies not anchor.need_anchor`
1079 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
1080 # ENSURE: `not self.need_anchor implies result == true`
1081 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
1083 # Return the nullable version of the type
1084 # If the type is already nullable then self is returned
1085 fun as_nullable
: MType
1087 var res
= self.as_nullable_cache
1088 if res
!= null then return res
1089 res
= new MNullableType(self)
1090 self.as_nullable_cache
= res
1094 # Remove the base type of a decorated (proxy) type.
1095 # Is the type is not decorated, then self is returned.
1097 # Most of the time it is used to return the not nullable version of a nullable type.
1098 # In this case, this just remove the `nullable` notation, but the result can still contains null.
1099 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
1100 # If you really want to exclude the `null` value, then use `as_notnull`
1101 fun undecorate
: MType
1106 # Returns the not null version of the type.
1107 # That is `self` minus the `null` value.
1109 # For most types, this return `self`.
1110 # For formal types, this returns a special `MNotNullType`
1111 fun as_notnull
: MType do return self
1113 private var as_nullable_cache
: nullable MType = null
1116 # The depth of the type seen as a tree.
1123 # Formal types have a depth of 1.
1129 # The length of the type seen as a tree.
1136 # Formal types have a length of 1.
1142 # Compute all the classdefs inherited/imported.
1143 # The returned set contains:
1144 # * the class definitions from `mmodule` and its imported modules
1145 # * the class definitions of this type and its super-types
1147 # This function is used mainly internally.
1149 # REQUIRE: `not self.need_anchor`
1150 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1152 # Compute all the super-classes.
1153 # This function is used mainly internally.
1155 # REQUIRE: `not self.need_anchor`
1156 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1158 # Compute all the declared super-types.
1159 # Super-types are returned as declared in the classdefs (verbatim).
1160 # This function is used mainly internally.
1162 # REQUIRE: `not self.need_anchor`
1163 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1165 # Is the property in self for a given module
1166 # This method does not filter visibility or whatever
1168 # REQUIRE: `not self.need_anchor`
1169 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1171 assert not self.need_anchor
1172 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1176 # A type based on a class.
1178 # `MClassType` have properties (see `has_mproperty`).
1182 # The associated class
1185 redef fun model
do return self.mclass
.intro_mmodule
.model
1187 redef fun location
do return mclass
.location
1189 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1191 # The formal arguments of the type
1192 # ENSURE: `result.length == self.mclass.arity`
1193 var arguments
= new Array[MType]
1195 redef fun to_s
do return mclass
.to_s
1197 redef fun full_name
do return mclass
.full_name
1199 redef fun c_name
do return mclass
.c_name
1201 redef fun need_anchor
do return false
1203 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1205 return super.as(MClassType)
1208 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1210 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1212 redef fun collect_mclassdefs
(mmodule
)
1214 assert not self.need_anchor
1215 var cache
= self.collect_mclassdefs_cache
1216 if not cache
.has_key
(mmodule
) then
1217 self.collect_things
(mmodule
)
1219 return cache
[mmodule
]
1222 redef fun collect_mclasses
(mmodule
)
1224 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1225 assert not self.need_anchor
1226 var cache
= self.collect_mclasses_cache
1227 if not cache
.has_key
(mmodule
) then
1228 self.collect_things
(mmodule
)
1230 var res
= cache
[mmodule
]
1231 collect_mclasses_last_module
= mmodule
1232 collect_mclasses_last_module_cache
= res
1236 private var collect_mclasses_last_module
: nullable MModule = null
1237 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1239 redef fun collect_mtypes
(mmodule
)
1241 assert not self.need_anchor
1242 var cache
= self.collect_mtypes_cache
1243 if not cache
.has_key
(mmodule
) then
1244 self.collect_things
(mmodule
)
1246 return cache
[mmodule
]
1249 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1250 private fun collect_things
(mmodule
: MModule)
1252 var res
= new HashSet[MClassDef]
1253 var seen
= new HashSet[MClass]
1254 var types
= new HashSet[MClassType]
1255 seen
.add
(self.mclass
)
1256 var todo
= [self.mclass
]
1257 while not todo
.is_empty
do
1258 var mclass
= todo
.pop
1259 #print "process {mclass}"
1260 for mclassdef
in mclass
.mclassdefs
do
1261 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1262 #print " process {mclassdef}"
1264 for supertype
in mclassdef
.supertypes
do
1265 types
.add
(supertype
)
1266 var superclass
= supertype
.mclass
1267 if seen
.has
(superclass
) then continue
1268 #print " add {superclass}"
1269 seen
.add
(superclass
)
1270 todo
.add
(superclass
)
1274 collect_mclassdefs_cache
[mmodule
] = res
1275 collect_mclasses_cache
[mmodule
] = seen
1276 collect_mtypes_cache
[mmodule
] = types
1279 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1280 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1281 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1285 # A type based on a generic class.
1286 # A generic type a just a class with additional formal generic arguments.
1292 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1296 assert self.mclass
.arity
== arguments
.length
1298 self.need_anchor
= false
1299 for t
in arguments
do
1300 if t
.need_anchor
then
1301 self.need_anchor
= true
1306 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1309 # The short-name of the class, then the full-name of each type arguments within brackets.
1310 # Example: `"Map[String, List[Int]]"`
1311 redef var to_s
is noinit
1313 # The full-name of the class, then the full-name of each type arguments within brackets.
1314 # Example: `"core::Map[core::String, core::List[core::Int]]"`
1315 redef var full_name
is lazy
do
1316 var args
= new Array[String]
1317 for t
in arguments
do
1318 args
.add t
.full_name
1320 return "{mclass.full_name}[{args.join(", ")}]"
1323 redef var c_name
is lazy
do
1324 var res
= mclass
.c_name
1325 # Note: because the arity is known, a prefix notation is enough
1326 for t
in arguments
do
1333 redef var need_anchor
is noinit
1335 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1337 if not need_anchor
then return self
1338 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1339 var types
= new Array[MType]
1340 for t
in arguments
do
1341 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1343 return mclass
.get_mtype
(types
)
1346 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1348 if not need_anchor
then return true
1349 for t
in arguments
do
1350 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1359 for a
in self.arguments
do
1361 if d
> dmax
then dmax
= d
1369 for a
in self.arguments
do
1376 # A formal type (either virtual of parametric).
1378 # The main issue with formal types is that they offer very little information on their own
1379 # and need a context (anchor and mmodule) to be useful.
1380 abstract class MFormalType
1383 redef var as_notnull
= new MNotNullType(self) is lazy
1386 # A virtual formal type.
1390 # The property associated with the type.
1391 # Its the definitions of this property that determine the bound or the virtual type.
1392 var mproperty
: MVirtualTypeProp
1394 redef fun location
do return mproperty
.location
1396 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1398 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1400 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
or else new MBottomType(model
)
1403 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1405 assert not resolved_receiver
.need_anchor
1406 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1407 if props
.is_empty
then
1409 else if props
.length
== 1 then
1412 var types
= new ArraySet[MType]
1413 var res
= props
.first
1415 types
.add
(p
.bound
.as(not null))
1416 if not res
.is_fixed
then res
= p
1418 if types
.length
== 1 then
1424 # A VT is fixed when:
1425 # * the VT is (re-)defined with the annotation `is fixed`
1426 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1427 # * the receiver is an enum class since there is no subtype possible
1428 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1430 assert not resolved_receiver
.need_anchor
1431 resolved_receiver
= resolved_receiver
.undecorate
1432 assert resolved_receiver
isa MClassType # It is the only remaining type
1434 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1435 var res
= prop
.bound
1436 if res
== null then return new MBottomType(model
)
1438 # Recursively lookup the fixed result
1439 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1441 # 1. For a fixed VT, return the resolved bound
1442 if prop
.is_fixed
then return res
1444 # 2. For a enum boud, return the bound
1445 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1447 # 3. for a enum receiver return the bound
1448 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1453 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1455 if not cleanup_virtual
then return self
1456 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1457 # self is a virtual type declared (or inherited) in mtype
1458 # The point of the function it to get the bound of the virtual type that make sense for mtype
1459 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1460 #print "{class_name}: {self}/{mtype}/{anchor}?"
1461 var resolved_receiver
1462 if mtype
.need_anchor
then
1463 assert anchor
!= null
1464 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1466 resolved_receiver
= mtype
1468 # Now, we can get the bound
1469 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1470 # The bound is exactly as declared in the "type" property, so we must resolve it again
1471 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1476 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1478 if mtype
.need_anchor
then
1479 assert anchor
!= null
1480 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1482 return mtype
.has_mproperty
(mmodule
, mproperty
)
1485 redef fun to_s
do return self.mproperty
.to_s
1487 redef fun full_name
do return self.mproperty
.full_name
1489 redef fun c_name
do return self.mproperty
.c_name
1492 # The type associated to a formal parameter generic type of a class
1494 # Each parameter type is associated to a specific class.
1495 # It means that all refinements of a same class "share" the parameter type,
1496 # but that a generic subclass has its own parameter types.
1498 # However, in the sense of the meta-model, a parameter type of a class is
1499 # a valid type in a subclass. The "in the sense of the meta-model" is
1500 # important because, in the Nit language, the programmer cannot refers
1501 # directly to the parameter types of the super-classes.
1506 # fun e: E is abstract
1512 # In the class definition B[F], `F` is a valid type but `E` is not.
1513 # However, `self.e` is a valid method call, and the signature of `e` is
1516 # Note that parameter types are shared among class refinements.
1517 # Therefore parameter only have an internal name (see `to_s` for details).
1518 class MParameterType
1521 # The generic class where the parameter belong
1524 redef fun model
do return self.mclass
.intro_mmodule
.model
1526 redef fun location
do return mclass
.location
1528 # The position of the parameter (0 for the first parameter)
1529 # FIXME: is `position` a better name?
1534 redef fun to_s
do return name
1536 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1538 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1540 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1542 assert not resolved_receiver
.need_anchor
1543 resolved_receiver
= resolved_receiver
.undecorate
1544 assert resolved_receiver
isa MClassType # It is the only remaining type
1545 var goalclass
= self.mclass
1546 if resolved_receiver
.mclass
== goalclass
then
1547 return resolved_receiver
.arguments
[self.rank
]
1549 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1550 for t
in supertypes
do
1551 if t
.mclass
== goalclass
then
1552 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1553 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1554 var res
= t
.arguments
[self.rank
]
1561 # A PT is fixed when:
1562 # * Its bound is a enum class (see `enum_kind`).
1563 # The PT is just useless, but it is still a case.
1564 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1565 # so it is necessarily fixed in a `super` clause, either with a normal type
1566 # or with another PT.
1567 # See `resolve_for` for examples about related issues.
1568 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1570 assert not resolved_receiver
.need_anchor
1571 resolved_receiver
= resolved_receiver
.undecorate
1572 assert resolved_receiver
isa MClassType # It is the only remaining type
1573 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1577 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1579 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1580 #print "{class_name}: {self}/{mtype}/{anchor}?"
1582 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1583 var res
= mtype
.arguments
[self.rank
]
1584 if anchor
!= null and res
.need_anchor
then
1585 # Maybe the result can be resolved more if are bound to a final class
1586 var r2
= res
.anchor_to
(mmodule
, anchor
)
1587 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1592 # self is a parameter type of mtype (or of a super-class of mtype)
1593 # The point of the function it to get the bound of the virtual type that make sense for mtype
1594 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1595 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1596 var resolved_receiver
1597 if mtype
.need_anchor
then
1598 assert anchor
!= null
1599 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1601 resolved_receiver
= mtype
1603 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1604 if resolved_receiver
isa MParameterType then
1605 assert anchor
!= null
1606 assert resolved_receiver
.mclass
== anchor
.mclass
1607 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1608 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1610 assert resolved_receiver
isa MClassType # It is the only remaining type
1612 # Eh! The parameter is in the current class.
1613 # So we return the corresponding argument, no mater what!
1614 if resolved_receiver
.mclass
== self.mclass
then
1615 var res
= resolved_receiver
.arguments
[self.rank
]
1616 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1620 if resolved_receiver
.need_anchor
then
1621 assert anchor
!= null
1622 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1624 # Now, we can get the bound
1625 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1626 # The bound is exactly as declared in the "type" property, so we must resolve it again
1627 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1629 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1634 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1636 if mtype
.need_anchor
then
1637 assert anchor
!= null
1638 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1640 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1644 # A type that decorates another type.
1646 # The point of this class is to provide a common implementation of sevices that just forward to the original type.
1647 # Specific decorator are expected to redefine (or to extend) the default implementation as this suit them.
1648 abstract class MProxyType
1653 redef fun location
do return mtype
.location
1655 redef fun model
do return self.mtype
.model
1656 redef fun need_anchor
do return mtype
.need_anchor
1657 redef fun as_nullable
do return mtype
.as_nullable
1658 redef fun as_notnull
do return mtype
.as_notnull
1659 redef fun undecorate
do return mtype
.undecorate
1660 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1662 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1666 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1668 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1671 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1673 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1677 redef fun depth
do return self.mtype
.depth
1679 redef fun length
do return self.mtype
.length
1681 redef fun collect_mclassdefs
(mmodule
)
1683 assert not self.need_anchor
1684 return self.mtype
.collect_mclassdefs
(mmodule
)
1687 redef fun collect_mclasses
(mmodule
)
1689 assert not self.need_anchor
1690 return self.mtype
.collect_mclasses
(mmodule
)
1693 redef fun collect_mtypes
(mmodule
)
1695 assert not self.need_anchor
1696 return self.mtype
.collect_mtypes
(mmodule
)
1700 # A type prefixed with "nullable"
1706 self.to_s
= "nullable {mtype}"
1709 redef var to_s
is noinit
1711 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1713 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1715 redef fun as_nullable
do return self
1716 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1719 return res
.as_nullable
1722 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1723 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1726 if t
== mtype
then return self
1727 return t
.as_nullable
1731 # A non-null version of a formal type.
1733 # When a formal type in bounded to a nullable type, this is the type of the not null version of it.
1737 redef fun to_s
do return "not null {mtype}"
1738 redef var full_name
is lazy
do return "not null {mtype.full_name}"
1739 redef var c_name
is lazy
do return "notnull__{mtype.c_name}"
1741 redef fun as_notnull
do return self
1743 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1746 return res
.as_notnull
1749 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_notnull`
1750 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1753 if t
== mtype
then return self
1758 # The type of the only value null
1760 # The is only one null type per model, see `MModel::null_type`.
1764 redef fun to_s
do return "null"
1765 redef fun full_name
do return "null"
1766 redef fun c_name
do return "null"
1767 redef fun as_nullable
do return self
1769 redef var as_notnull
= new MBottomType(model
) is lazy
1770 redef fun need_anchor
do return false
1771 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1772 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1774 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1776 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1778 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1781 # The special universal most specific type.
1783 # This type is intended to be only used internally for type computation or analysis and should not be exposed to the user.
1784 # The bottom type can de used to denote things that are absurd, dead, or the absence of knowledge.
1786 # Semantically it is the singleton `null.as_notnull`.
1790 redef fun to_s
do return "bottom"
1791 redef fun full_name
do return "bottom"
1792 redef fun c_name
do return "bottom"
1793 redef fun as_nullable
do return model
.null_type
1794 redef fun as_notnull
do return self
1795 redef fun need_anchor
do return false
1796 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1797 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1799 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1801 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1803 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1806 # A signature of a method
1810 # The each parameter (in order)
1811 var mparameters
: Array[MParameter]
1813 # Returns a parameter named `name`, if any.
1814 fun mparameter_by_name
(name
: String): nullable MParameter
1816 for p
in mparameters
do
1817 if p
.name
== name
then return p
1822 # The return type (null for a procedure)
1823 var return_mtype
: nullable MType
1828 var t
= self.return_mtype
1829 if t
!= null then dmax
= t
.depth
1830 for p
in mparameters
do
1831 var d
= p
.mtype
.depth
1832 if d
> dmax
then dmax
= d
1840 var t
= self.return_mtype
1841 if t
!= null then res
+= t
.length
1842 for p
in mparameters
do
1843 res
+= p
.mtype
.length
1848 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1851 var vararg_rank
= -1
1852 for i
in [0..mparameters
.length
[ do
1853 var parameter
= mparameters
[i
]
1854 if parameter
.is_vararg
then
1855 if vararg_rank
>= 0 then
1856 # If there is more than one vararg,
1857 # consider that additional arguments cannot be mapped.
1864 self.vararg_rank
= vararg_rank
1867 # The rank of the main ellipsis (`...`) for vararg (starting from 0).
1868 # value is -1 if there is no vararg.
1869 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1871 # From a model POV, a signature can contain more than one vararg parameter,
1872 # the `vararg_rank` just indicates the one that will receive the additional arguments.
1873 # However, currently, if there is more that one vararg parameter, no one will be the main one,
1874 # and additional arguments will be refused.
1875 var vararg_rank
: Int is noinit
1877 # The number of parameters
1878 fun arity
: Int do return mparameters
.length
1882 var b
= new FlatBuffer
1883 if not mparameters
.is_empty
then
1885 for i
in [0..mparameters
.length
[ do
1886 var mparameter
= mparameters
[i
]
1887 if i
> 0 then b
.append
(", ")
1888 b
.append
(mparameter
.name
)
1890 b
.append
(mparameter
.mtype
.to_s
)
1891 if mparameter
.is_vararg
then
1897 var ret
= self.return_mtype
1905 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1907 var params
= new Array[MParameter]
1908 for p
in self.mparameters
do
1909 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1911 var ret
= self.return_mtype
1913 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1915 var res
= new MSignature(params
, ret
)
1920 # A parameter in a signature
1924 # The name of the parameter
1927 # The static type of the parameter
1930 # Is the parameter a vararg?
1936 return "{name}: {mtype}..."
1938 return "{name}: {mtype}"
1942 # Returns a new parameter with the `mtype` resolved.
1943 # See `MType::resolve_for` for details.
1944 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1946 if not self.mtype
.need_anchor
then return self
1947 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1948 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1952 redef fun model
do return mtype
.model
1955 # A service (global property) that generalize method, attribute, etc.
1957 # `MProperty` are global to the model; it means that a `MProperty` is not bound
1958 # to a specific `MModule` nor a specific `MClass`.
1960 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
1961 # and the other in subclasses and in refinements.
1963 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
1964 # of any dynamic type).
1965 # For instance, a call site "x.foo" is associated to a `MProperty`.
1966 abstract class MProperty
1969 # The associated MPropDef subclass.
1970 # The two specialization hierarchy are symmetric.
1971 type MPROPDEF: MPropDef
1973 # The classdef that introduce the property
1974 # While a property is not bound to a specific module, or class,
1975 # the introducing mclassdef is used for naming and visibility
1976 var intro_mclassdef
: MClassDef
1978 # The (short) name of the property
1983 redef fun mdoc_or_fallback
do return intro
.mdoc_or_fallback
1985 # The canonical name of the property.
1987 # It is currently the short-`name` prefixed by the short-name of the class and the full-name of the module.
1988 # Example: "my_package::my_module::MyClass::my_method"
1990 # The full-name of the module is needed because two distinct modules of the same package can
1991 # still refine the same class and introduce homonym properties.
1993 # For public properties not introduced by refinement, the module name is not used.
1995 # Example: `my_package::MyClass::My_method`
1996 redef var full_name
is lazy
do
1997 if intro_mclassdef
.is_intro
then
1998 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
2000 return "{intro_mclassdef.mmodule.full_name}::{intro_mclassdef.mclass.name}::{name}"
2004 redef var c_name
is lazy
do
2005 # FIXME use `namespace_for`
2006 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
2009 # The visibility of the property
2010 redef var visibility
2012 # Is the property usable as an initializer?
2013 var is_autoinit
= false is writable
2017 intro_mclassdef
.intro_mproperties
.add
(self)
2018 var model
= intro_mclassdef
.mmodule
.model
2019 model
.mproperties_by_name
.add_one
(name
, self)
2020 model
.mproperties
.add
(self)
2023 # All definitions of the property.
2024 # The first is the introduction,
2025 # The other are redefinitions (in refinements and in subclasses)
2026 var mpropdefs
= new Array[MPROPDEF]
2028 # The definition that introduces the property.
2030 # Warning: such a definition may not exist in the early life of the object.
2031 # In this case, the method will abort.
2032 var intro
: MPROPDEF is noinit
2034 redef fun model
do return intro
.model
2037 redef fun to_s
do return name
2039 # Return the most specific property definitions defined or inherited by a type.
2040 # The selection knows that refinement is stronger than specialization;
2041 # however, in case of conflict more than one property are returned.
2042 # If mtype does not know mproperty then an empty array is returned.
2044 # If you want the really most specific property, then look at `lookup_first_definition`
2046 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2047 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
2048 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2050 assert not mtype
.need_anchor
2051 mtype
= mtype
.undecorate
2053 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
2054 if cache
!= null then return cache
2056 #print "select prop {mproperty} for {mtype} in {self}"
2057 # First, select all candidates
2058 var candidates
= new Array[MPROPDEF]
2059 for mpropdef
in self.mpropdefs
do
2060 # If the definition is not imported by the module, then skip
2061 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2062 # If the definition is not inherited by the type, then skip
2063 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2065 candidates
.add
(mpropdef
)
2067 # Fast track for only one candidate
2068 if candidates
.length
<= 1 then
2069 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
2073 # Second, filter the most specific ones
2074 return select_most_specific
(mmodule
, candidates
)
2077 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2079 # Return the most specific property definitions inherited by a type.
2080 # The selection knows that refinement is stronger than specialization;
2081 # however, in case of conflict more than one property are returned.
2082 # If mtype does not know mproperty then an empty array is returned.
2084 # If you want the really most specific property, then look at `lookup_next_definition`
2086 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2087 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
2088 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2090 assert not mtype
.need_anchor
2091 mtype
= mtype
.undecorate
2093 # First, select all candidates
2094 var candidates
= new Array[MPROPDEF]
2095 for mpropdef
in self.mpropdefs
do
2096 # If the definition is not imported by the module, then skip
2097 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2098 # If the definition is not inherited by the type, then skip
2099 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2100 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
2101 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
2103 candidates
.add
(mpropdef
)
2105 # Fast track for only one candidate
2106 if candidates
.length
<= 1 then return candidates
2108 # Second, filter the most specific ones
2109 return select_most_specific
(mmodule
, candidates
)
2112 # Return an array containing olny the most specific property definitions
2113 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
2114 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
2116 var res
= new Array[MPROPDEF]
2117 for pd1
in candidates
do
2118 var cd1
= pd1
.mclassdef
2121 for pd2
in candidates
do
2122 if pd2
== pd1
then continue # do not compare with self!
2123 var cd2
= pd2
.mclassdef
2125 if c2
.mclass_type
== c1
.mclass_type
then
2126 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
2127 # cd2 refines cd1; therefore we skip pd1
2131 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
2132 # cd2 < cd1; therefore we skip pd1
2141 if res
.is_empty
then
2142 print
"All lost! {candidates.join(", ")}"
2143 # FIXME: should be abort!
2148 # Return the most specific definition in the linearization of `mtype`.
2150 # If you want to know the next properties in the linearization,
2151 # look at `MPropDef::lookup_next_definition`.
2153 # FIXME: the linearization is still unspecified
2155 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2156 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2157 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2159 return lookup_all_definitions
(mmodule
, mtype
).first
2162 # Return all definitions in a linearization order
2163 # Most specific first, most general last
2165 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2166 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2167 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2169 mtype
= mtype
.undecorate
2171 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
2172 if cache
!= null then return cache
2174 assert not mtype
.need_anchor
2175 assert mtype
.has_mproperty
(mmodule
, self)
2177 #print "select prop {mproperty} for {mtype} in {self}"
2178 # First, select all candidates
2179 var candidates
= new Array[MPROPDEF]
2180 for mpropdef
in self.mpropdefs
do
2181 # If the definition is not imported by the module, then skip
2182 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2183 # If the definition is not inherited by the type, then skip
2184 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2186 candidates
.add
(mpropdef
)
2188 # Fast track for only one candidate
2189 if candidates
.length
<= 1 then
2190 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2194 mmodule
.linearize_mpropdefs
(candidates
)
2195 candidates
= candidates
.reversed
2196 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2200 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2207 redef type MPROPDEF: MMethodDef
2209 # Is the property defined at the top_level of the module?
2210 # Currently such a property are stored in `Object`
2211 var is_toplevel
: Bool = false is writable
2213 # Is the property a constructor?
2214 # Warning, this property can be inherited by subclasses with or without being a constructor
2215 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
2216 var is_init
: Bool = false is writable
2218 # The constructor is a (the) root init with empty signature but a set of initializers
2219 var is_root_init
: Bool = false is writable
2221 # Is the property a 'new' constructor?
2222 var is_new
: Bool = false is writable
2224 # Is the property a legal constructor for a given class?
2225 # As usual, visibility is not considered.
2226 # FIXME not implemented
2227 fun is_init_for
(mclass
: MClass): Bool
2232 # A specific method that is safe to call on null.
2233 # Currently, only `==`, `!=` and `is_same_instance` are safe
2234 fun is_null_safe
: Bool do return name
== "==" or name
== "!=" or name
== "is_same_instance"
2237 # A global attribute
2241 redef type MPROPDEF: MAttributeDef
2245 # A global virtual type
2246 class MVirtualTypeProp
2249 redef type MPROPDEF: MVirtualTypeDef
2251 # The formal type associated to the virtual type property
2252 var mvirtualtype
= new MVirtualType(self)
2255 # A definition of a property (local property)
2257 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2258 # specific class definition (which belong to a specific module)
2259 abstract class MPropDef
2262 # The associated `MProperty` subclass.
2263 # the two specialization hierarchy are symmetric
2264 type MPROPERTY: MProperty
2267 type MPROPDEF: MPropDef
2269 # The class definition where the property definition is
2270 var mclassdef
: MClassDef
2272 # The associated global property
2273 var mproperty
: MPROPERTY
2275 redef var location
: Location
2277 redef fun visibility
do return mproperty
.visibility
2281 mclassdef
.mpropdefs
.add
(self)
2282 mproperty
.mpropdefs
.add
(self)
2283 if mproperty
.intro_mclassdef
== mclassdef
then
2284 assert not isset mproperty
._intro
2285 mproperty
.intro
= self
2287 self.to_s
= "{mclassdef}${mproperty}"
2290 # Actually the name of the `mproperty`
2291 redef fun name
do return mproperty
.name
2293 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2295 # Therefore the combination of identifiers is awful,
2296 # the worst case being
2298 # * a property "p::m::A::x"
2299 # * redefined in a refinement of a class "q::n::B"
2300 # * in a module "r::o"
2301 # * so "r::o$q::n::B$p::m::A::x"
2303 # Fortunately, the full-name is simplified when entities are repeated.
2304 # For the previous case, the simplest form is "p$A$x".
2305 redef var full_name
is lazy
do
2306 var res
= new FlatBuffer
2308 # The first part is the mclassdef. Worst case is "r::o$q::n::B"
2309 res
.append mclassdef
.full_name
2313 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2314 # intro are unambiguous in a class
2317 # Just try to simplify each part
2318 if mclassdef
.mmodule
.mpackage
!= mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2319 # precise "p::m" only if "p" != "r"
2320 res
.append mproperty
.intro_mclassdef
.mmodule
.namespace_for
(mproperty
.visibility
)
2322 else if mproperty
.visibility
<= private_visibility
then
2323 # Same package ("p"=="q"), but private visibility,
2324 # does the module part ("::m") need to be displayed
2325 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2327 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2331 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2332 # precise "B" only if not the same class than "A"
2333 res
.append mproperty
.intro_mclassdef
.name
2336 # Always use the property name "x"
2337 res
.append mproperty
.name
2342 redef var c_name
is lazy
do
2343 var res
= new FlatBuffer
2344 res
.append mclassdef
.c_name
2346 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2347 res
.append name
.to_cmangle
2349 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2350 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2353 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2354 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2357 res
.append mproperty
.name
.to_cmangle
2362 redef fun model
do return mclassdef
.model
2364 # Internal name combining the module, the class and the property
2365 # Example: "mymodule$MyClass$mymethod"
2366 redef var to_s
is noinit
2368 # Is self the definition that introduce the property?
2369 fun is_intro
: Bool do return isset mproperty
._intro
and mproperty
.intro
== self
2371 # Return the next definition in linearization of `mtype`.
2373 # This method is used to determine what method is called by a super.
2375 # REQUIRE: `not mtype.need_anchor`
2376 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2378 assert not mtype
.need_anchor
2380 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2381 var i
= mpropdefs
.iterator
2382 while i
.is_ok
and i
.item
!= self do i
.next
2383 assert has_property
: i
.is_ok
2385 assert has_next_property
: i
.is_ok
2390 # A local definition of a method
2394 redef type MPROPERTY: MMethod
2395 redef type MPROPDEF: MMethodDef
2397 # The signature attached to the property definition
2398 var msignature
: nullable MSignature = null is writable
2400 # List of initialisers to call in root-inits
2402 # They could be setters or attributes
2403 var initializers
= new Array[MProperty]
2405 # Does the method take the responsibility to call `init`?
2407 # If the method is used as an initializer, then
2408 # using this information prevents to call `init` twice.
2409 var is_calling_init
= false is writable
2411 # Is the method definition abstract?
2412 var is_abstract
: Bool = false is writable
2414 # Is the method definition intern?
2415 var is_intern
= false is writable
2417 # Is the method definition extern?
2418 var is_extern
= false is writable
2420 # An optional constant value returned in functions.
2422 # Only some specific primitife value are accepted by engines.
2423 # Is used when there is no better implementation available.
2425 # Currently used only for the implementation of the `--define`
2426 # command-line option.
2427 # SEE: module `mixin`.
2428 var constant_value
: nullable Object = null is writable
2431 # A local definition of an attribute
2435 redef type MPROPERTY: MAttribute
2436 redef type MPROPDEF: MAttributeDef
2438 # The static type of the attribute
2439 var static_mtype
: nullable MType = null is writable
2442 # A local definition of a virtual type
2443 class MVirtualTypeDef
2446 redef type MPROPERTY: MVirtualTypeProp
2447 redef type MPROPDEF: MVirtualTypeDef
2449 # The bound of the virtual type
2450 var bound
: nullable MType = null is writable
2452 # Is the bound fixed?
2453 var is_fixed
= false is writable
2460 # * `interface_kind`
2464 # Note this class is basically an enum.
2465 # FIXME: use a real enum once user-defined enums are available
2469 # Is a constructor required?
2472 # TODO: private init because enumeration.
2474 # Can a class of kind `self` specializes a class of kine `other`?
2475 fun can_specialize
(other
: MClassKind): Bool
2477 if other
== interface_kind
then return true # everybody can specialize interfaces
2478 if self == interface_kind
or self == enum_kind
then
2479 # no other case for interfaces
2481 else if self == extern_kind
then
2482 # only compatible with themselves
2483 return self == other
2484 else if other
== enum_kind
or other
== extern_kind
then
2485 # abstract_kind and concrete_kind are incompatible
2488 # remain only abstract_kind and concrete_kind
2493 # The class kind `abstract`
2494 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2495 # The class kind `concrete`
2496 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2497 # The class kind `interface`
2498 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2499 # The class kind `enum`
2500 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2501 # The class kind `extern`
2502 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)