1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Classes, types and properties
19 # All three concepts are defined in this same module because these are strongly connected:
20 # * types are based on classes
21 # * classes contains properties
22 # * some properties are types (virtual types)
24 # TODO: liearization, extern stuff
25 # FIXME: better handling of the types
31 private import more_collections
34 # The visibility of the MEntity.
36 # MPackages, MGroups and MModules are always public.
37 # The visibility of `MClass` and `MProperty` is defined by the keyword used.
38 # `MClassDef` and `MPropDef` return the visibility of `MClass` and `MProperty`.
39 fun visibility
: MVisibility do return public_visibility
44 var mclasses
= new Array[MClass]
46 # All known properties
47 var mproperties
= new Array[MProperty]
49 # Hierarchy of class definition.
51 # Each classdef is associated with its super-classdefs in regard to
52 # its module of definition.
53 var mclassdef_hierarchy
= new POSet[MClassDef]
55 # Class-type hierarchy restricted to the introduction.
57 # The idea is that what is true on introduction is always true whatever
58 # the module considered.
59 # Therefore, this hierarchy is used for a fast positive subtype check.
61 # This poset will evolve in a monotonous way:
62 # * Two non connected nodes will remain unconnected
63 # * New nodes can appear with new edges
64 private var intro_mtype_specialization_hierarchy
= new POSet[MClassType]
66 # Global overlapped class-type hierarchy.
67 # The hierarchy when all modules are combined.
68 # Therefore, this hierarchy is used for a fast negative subtype check.
70 # This poset will evolve in an anarchic way. Loops can even be created.
72 # FIXME decide what to do on loops
73 private var full_mtype_specialization_hierarchy
= new POSet[MClassType]
75 # Collections of classes grouped by their short name
76 private var mclasses_by_name
= new MultiHashMap[String, MClass]
78 # Return all classes named `name`.
80 # If such a class does not exist, null is returned
81 # (instead of an empty array)
83 # Visibility or modules are not considered
84 fun get_mclasses_by_name
(name
: String): nullable Array[MClass]
86 return mclasses_by_name
.get_or_null
(name
)
89 # Collections of properties grouped by their short name
90 private var mproperties_by_name
= new MultiHashMap[String, MProperty]
92 # Return all properties named `name`.
94 # If such a property does not exist, null is returned
95 # (instead of an empty array)
97 # Visibility or modules are not considered
98 fun get_mproperties_by_name
(name
: String): nullable Array[MProperty]
100 return mproperties_by_name
.get_or_null
(name
)
104 var null_type
= new MNullType(self)
106 # Build an ordered tree with from `concerns`
107 fun concerns_tree
(mconcerns
: Collection[MConcern]): ConcernsTree do
108 var seen
= new HashSet[MConcern]
109 var res
= new ConcernsTree
111 var todo
= new Array[MConcern]
112 todo
.add_all mconcerns
114 while not todo
.is_empty
do
116 if seen
.has
(c
) then continue
117 var pc
= c
.parent_concern
131 # An OrderedTree bound to MEntity.
133 # We introduce a new class so it can be easily refined by tools working
136 super OrderedTree[MEntity]
139 # A MEntityTree borned to MConcern.
141 # TODO remove when nitdoc is fully merged with model_collect
143 super OrderedTree[MConcern]
147 # All the classes introduced in the module
148 var intro_mclasses
= new Array[MClass]
150 # All the class definitions of the module
151 # (introduction and refinement)
152 var mclassdefs
= new Array[MClassDef]
154 # Does the current module has a given class `mclass`?
155 # Return true if the mmodule introduces, refines or imports a class.
156 # Visibility is not considered.
157 fun has_mclass
(mclass
: MClass): Bool
159 return self.in_importation
<= mclass
.intro_mmodule
162 # Full hierarchy of introduced and imported classes.
164 # Create a new hierarchy got by flattening the classes for the module
165 # and its imported modules.
166 # Visibility is not considered.
168 # Note: this function is expensive and is usually used for the main
169 # module of a program only. Do not use it to do you own subtype
171 fun flatten_mclass_hierarchy
: POSet[MClass]
173 var res
= self.flatten_mclass_hierarchy_cache
174 if res
!= null then return res
175 res
= new POSet[MClass]
176 for m
in self.in_importation
.greaters
do
177 for cd
in m
.mclassdefs
do
180 for s
in cd
.supertypes
do
181 res
.add_edge
(c
, s
.mclass
)
185 self.flatten_mclass_hierarchy_cache
= res
189 # Sort a given array of classes using the linearization order of the module
190 # The most general is first, the most specific is last
191 fun linearize_mclasses
(mclasses
: Array[MClass])
193 self.flatten_mclass_hierarchy
.sort
(mclasses
)
196 # Sort a given array of class definitions using the linearization order of the module
197 # the refinement link is stronger than the specialisation link
198 # The most general is first, the most specific is last
199 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
201 var sorter
= new MClassDefSorter(self)
202 sorter
.sort
(mclassdefs
)
205 # Sort a given array of property definitions using the linearization order of the module
206 # the refinement link is stronger than the specialisation link
207 # The most general is first, the most specific is last
208 fun linearize_mpropdefs
(mpropdefs
: Array[MPropDef])
210 var sorter
= new MPropDefSorter(self)
211 sorter
.sort
(mpropdefs
)
214 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
216 # The primitive type `Object`, the root of the class hierarchy
217 var object_type
: MClassType = self.get_primitive_class
("Object").mclass_type
is lazy
219 # The type `Pointer`, super class to all extern classes
220 var pointer_type
: MClassType = self.get_primitive_class
("Pointer").mclass_type
is lazy
222 # The primitive type `Bool`
223 var bool_type
: MClassType = self.get_primitive_class
("Bool").mclass_type
is lazy
225 # The primitive type `Int`
226 var int_type
: MClassType = self.get_primitive_class
("Int").mclass_type
is lazy
228 # The primitive type `Byte`
229 var byte_type
: MClassType = self.get_primitive_class
("Byte").mclass_type
is lazy
231 # The primitive type `Int8`
232 var int8_type
: MClassType = self.get_primitive_class
("Int8").mclass_type
is lazy
234 # The primitive type `Int16`
235 var int16_type
: MClassType = self.get_primitive_class
("Int16").mclass_type
is lazy
237 # The primitive type `UInt16`
238 var uint16_type
: MClassType = self.get_primitive_class
("UInt16").mclass_type
is lazy
240 # The primitive type `Int32`
241 var int32_type
: MClassType = self.get_primitive_class
("Int32").mclass_type
is lazy
243 # The primitive type `UInt32`
244 var uint32_type
: MClassType = self.get_primitive_class
("UInt32").mclass_type
is lazy
246 # The primitive type `Char`
247 var char_type
: MClassType = self.get_primitive_class
("Char").mclass_type
is lazy
249 # The primitive type `Float`
250 var float_type
: MClassType = self.get_primitive_class
("Float").mclass_type
is lazy
252 # The primitive type `String`
253 var string_type
: MClassType = self.get_primitive_class
("String").mclass_type
is lazy
255 # The primitive type `CString`
256 var c_string_type
: MClassType = self.get_primitive_class
("CString").mclass_type
is lazy
258 # A primitive type of `Array`
259 fun array_type
(elt_type
: MType): MClassType do return array_class
.get_mtype
([elt_type
])
261 # The primitive class `Array`
262 var array_class
: MClass = self.get_primitive_class
("Array") is lazy
264 # A primitive type of `NativeArray`
265 fun native_array_type
(elt_type
: MType): MClassType do return native_array_class
.get_mtype
([elt_type
])
267 # The primitive class `NativeArray`
268 var native_array_class
: MClass = self.get_primitive_class
("NativeArray") is lazy
270 # The primitive type `Sys`, the main type of the program, if any
271 fun sys_type
: nullable MClassType
273 var clas
= self.model
.get_mclasses_by_name
("Sys")
274 if clas
== null then return null
275 return get_primitive_class
("Sys").mclass_type
278 # The primitive type `Finalizable`
279 # Used to tag classes that need to be finalized.
280 fun finalizable_type
: nullable MClassType
282 var clas
= self.model
.get_mclasses_by_name
("Finalizable")
283 if clas
== null then return null
284 return get_primitive_class
("Finalizable").mclass_type
287 # Force to get the primitive class named `name` or abort
288 fun get_primitive_class
(name
: String): MClass
290 var cla
= self.model
.get_mclasses_by_name
(name
)
291 # Filter classes by introducing module
292 if cla
!= null then cla
= [for c
in cla
do if self.in_importation
<= c
.intro_mmodule
then c
]
293 if cla
== null or cla
.is_empty
then
294 if name
== "Bool" and self.model
.get_mclasses_by_name
("Object") != null then
295 # Bool is injected because it is needed by engine to code the result
296 # of the implicit casts.
297 var loc
= model
.no_location
298 var c
= new MClass(self, name
, loc
, null, enum_kind
, public_visibility
)
299 var cladef
= new MClassDef(self, c
.mclass_type
, loc
)
300 cladef
.set_supertypes
([object_type
])
301 cladef
.add_in_hierarchy
304 print_error
("Fatal Error: no primitive class {name} in {self}")
308 if cla
.length
!= 1 then
309 var msg
= "Fatal Error: more than one primitive class {name} in {self}:"
310 for c
in cla
do msg
+= " {c.full_name}"
317 # Try to get the primitive method named `name` on the type `recv`
318 fun try_get_primitive_method
(name
: String, recv
: MClass): nullable MMethod
320 var props
= self.model
.get_mproperties_by_name
(name
)
321 if props
== null then return null
322 var res
: nullable MMethod = null
323 var recvtype
= recv
.intro
.bound_mtype
324 for mprop
in props
do
325 assert mprop
isa MMethod
326 if not recvtype
.has_mproperty
(self, mprop
) then continue
329 else if res
!= mprop
then
330 print_error
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
338 private class MClassDefSorter
340 redef type COMPARED: MClassDef
342 redef fun compare
(a
, b
)
346 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
347 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
351 private class MPropDefSorter
353 redef type COMPARED: MPropDef
355 redef fun compare
(pa
, pb
)
361 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
362 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
368 # `MClass` are global to the model; it means that a `MClass` is not bound to a
369 # specific `MModule`.
371 # This characteristic helps the reasoning about classes in a program since a
372 # single `MClass` object always denote the same class.
374 # The drawback is that classes (`MClass`) contain almost nothing by themselves.
375 # These do not really have properties nor belong to a hierarchy since the property and the
376 # hierarchy of a class depends of the refinement in the modules.
378 # Most services on classes require the precision of a module, and no one can asks what are
379 # the super-classes of a class nor what are properties of a class without precising what is
380 # the module considered.
382 # For instance, during the typing of a source-file, the module considered is the module of the file.
383 # eg. the question *is the method `foo` exists in the class `Bar`?* must be reformulated into
384 # *is the method `foo` exists in the class `Bar` in the current module?*
386 # During some global analysis, the module considered may be the main module of the program.
390 # The module that introduce the class
392 # While classes are not bound to a specific module,
393 # the introducing module is used for naming and visibility.
394 var intro_mmodule
: MModule
396 # The short name of the class
397 # In Nit, the name of a class cannot evolve in refinements
402 # The canonical name of the class
404 # It is the name of the class prefixed by the full_name of the `intro_mmodule`
405 # Example: `"owner::module::MyClass"`
406 redef var full_name
is lazy
do
407 return "{self.intro_mmodule.namespace_for(visibility)}::{name}"
410 redef var c_name
is lazy
do
411 return "{intro_mmodule.c_namespace_for(visibility)}__{name.to_cmangle}"
414 # The number of generic formal parameters
415 # 0 if the class is not generic
416 var arity
: Int is noinit
418 # Each generic formal parameters in order.
419 # is empty if the class is not generic
420 var mparameters
= new Array[MParameterType]
422 # A string version of the signature a generic class.
424 # eg. `Map[K: nullable Object, V: nullable Object]`
426 # If the class in non generic the name is just given.
429 fun signature_to_s
: String
431 if arity
== 0 then return name
432 var res
= new FlatBuffer
435 for i
in [0..arity
[ do
436 if i
> 0 then res
.append
", "
437 res
.append mparameters
[i
].name
439 res
.append intro
.bound_mtype
.arguments
[i
].to_s
445 # Initialize `mparameters` from their names.
446 protected fun setup_parameter_names
(parameter_names
: nullable Array[String]) is
449 if parameter_names
== null then
452 self.arity
= parameter_names
.length
455 # Create the formal parameter types
457 assert parameter_names
!= null
458 var mparametertypes
= new Array[MParameterType]
459 for i
in [0..arity
[ do
460 var mparametertype
= new MParameterType(self, i
, parameter_names
[i
])
461 mparametertypes
.add
(mparametertype
)
463 self.mparameters
= mparametertypes
464 var mclass_type
= new MGenericType(self, mparametertypes
)
465 self.mclass_type
= mclass_type
466 self.get_mtype_cache
[mparametertypes
] = mclass_type
468 self.mclass_type
= new MClassType(self)
472 # The kind of the class (interface, abstract class, etc.)
473 # In Nit, the kind of a class cannot evolve in refinements
476 # The visibility of the class
477 # In Nit, the visibility of a class cannot evolve in refinements
482 intro_mmodule
.intro_mclasses
.add
(self)
483 var model
= intro_mmodule
.model
484 model
.mclasses_by_name
.add_one
(name
, self)
485 model
.mclasses
.add
(self)
488 redef fun model
do return intro_mmodule
.model
490 # All class definitions (introduction and refinements)
491 var mclassdefs
= new Array[MClassDef]
494 redef fun to_s
do return self.name
496 # The definition that introduces the class.
498 # Warning: such a definition may not exist in the early life of the object.
499 # In this case, the method will abort.
501 # Use `try_intro` instead
502 var intro
: MClassDef is noinit
504 # The definition that introduces the class or null if not yet known.
507 fun try_intro
: nullable MClassDef do
508 if isset _intro
then return _intro
else return null
511 # Return the class `self` in the class hierarchy of the module `mmodule`.
513 # SEE: `MModule::flatten_mclass_hierarchy`
514 # REQUIRE: `mmodule.has_mclass(self)`
515 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
517 return mmodule
.flatten_mclass_hierarchy
[self]
520 # The principal static type of the class.
522 # For non-generic class, `mclass_type` is the only `MClassType` based
525 # For a generic class, the arguments are the formal parameters.
526 # i.e.: for the class `Array[E:Object]`, the `mclass_type` is `Array[E]`.
527 # If you want `Array[Object]`, see `MClassDef::bound_mtype`.
529 # For generic classes, the mclass_type is also the way to get a formal
530 # generic parameter type.
532 # To get other types based on a generic class, see `get_mtype`.
534 # ENSURE: `mclass_type.mclass == self`
535 var mclass_type
: MClassType is noinit
537 # Return a generic type based on the class
538 # Is the class is not generic, then the result is `mclass_type`
540 # REQUIRE: `mtype_arguments.length == self.arity`
541 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
543 assert mtype_arguments
.length
== self.arity
544 if self.arity
== 0 then return self.mclass_type
545 var res
= get_mtype_cache
.get_or_null
(mtype_arguments
)
546 if res
!= null then return res
547 res
= new MGenericType(self, mtype_arguments
)
548 self.get_mtype_cache
[mtype_arguments
.to_a
] = res
552 private var get_mtype_cache
= new HashMap[Array[MType], MGenericType]
554 # Is there a `new` factory to allow the pseudo instantiation?
555 var has_new_factory
= false is writable
557 # Is `self` a standard or abstract class kind?
558 var is_class
: Bool is lazy
do return kind
== concrete_kind
or kind
== abstract_kind
560 # Is `self` an interface kind?
561 var is_interface
: Bool is lazy
do return kind
== interface_kind
563 # Is `self` an enum kind?
564 var is_enum
: Bool is lazy
do return kind
== enum_kind
566 # Is `self` and abstract class?
567 var is_abstract
: Bool is lazy
do return kind
== abstract_kind
569 redef fun mdoc_or_fallback
do return intro
.mdoc_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
608 redef fun visibility
do return mclass
.visibility
610 # Internal name combining the module and the class
611 # Example: "mymodule$MyClass"
612 redef var to_s
is noinit
616 self.mclass
= bound_mtype
.mclass
617 mmodule
.mclassdefs
.add
(self)
618 mclass
.mclassdefs
.add
(self)
619 if mclass
.intro_mmodule
== mmodule
then
620 assert not isset mclass
._intro
623 self.to_s
= "{mmodule}${mclass}"
626 # Actually the name of the `mclass`
627 redef fun name
do return mclass
.name
629 # The module and class name separated by a '$'.
631 # The short-name of the class is used for introduction.
632 # Example: "my_module$MyClass"
634 # The full-name of the class is used for refinement.
635 # Example: "my_module$intro_module::MyClass"
636 redef var full_name
is lazy
do
639 # private gives 'p::m$A'
640 return "{mmodule.namespace_for(mclass.visibility)}${mclass.name}"
641 else if mclass
.intro_mmodule
.mpackage
!= mmodule
.mpackage
then
642 # public gives 'q::n$p::A'
643 # private gives 'q::n$p::m::A'
644 return "{mmodule.full_name}${mclass.full_name}"
645 else if mclass
.visibility
> private_visibility
then
646 # public gives 'p::n$A'
647 return "{mmodule.full_name}${mclass.name}"
649 # private gives 'p::n$::m::A' (redundant p is omitted)
650 return "{mmodule.full_name}$::{mclass.intro_mmodule.name}::{mclass.name}"
654 redef var c_name
is lazy
do
656 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
657 else if mclass
.intro_mmodule
.mpackage
== mmodule
.mpackage
and mclass
.visibility
> private_visibility
then
658 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
660 return "{mmodule.c_name}___{mclass.c_name}"
664 redef fun model
do return mmodule
.model
666 # All declared super-types
667 # FIXME: quite ugly but not better idea yet
668 var supertypes
= new Array[MClassType]
670 # Register some super-types for the class (ie "super SomeType")
672 # The hierarchy must not already be set
673 # REQUIRE: `self.in_hierarchy == null`
674 fun set_supertypes
(supertypes
: Array[MClassType])
676 assert unique_invocation
: self.in_hierarchy
== null
677 var mmodule
= self.mmodule
678 var model
= mmodule
.model
679 var mtype
= self.bound_mtype
681 for supertype
in supertypes
do
682 self.supertypes
.add
(supertype
)
684 # Register in full_type_specialization_hierarchy
685 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
686 # Register in intro_type_specialization_hierarchy
687 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
688 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
694 # Collect the super-types (set by set_supertypes) to build the hierarchy
696 # This function can only invoked once by class
697 # REQUIRE: `self.in_hierarchy == null`
698 # ENSURE: `self.in_hierarchy != null`
701 assert unique_invocation
: self.in_hierarchy
== null
702 var model
= mmodule
.model
703 var res
= model
.mclassdef_hierarchy
.add_node
(self)
704 self.in_hierarchy
= res
705 var mtype
= self.bound_mtype
707 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
708 # The simpliest way is to attach it to collect_mclassdefs
709 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
710 res
.poset
.add_edge
(self, mclassdef
)
714 # The view of the class definition in `mclassdef_hierarchy`
715 var in_hierarchy
: nullable POSetElement[MClassDef] = null
717 # Is the definition the one that introduced `mclass`?
718 fun is_intro
: Bool do return isset mclass
._intro
and mclass
.intro
== self
720 # All properties introduced by the classdef
721 var intro_mproperties
= new Array[MProperty]
723 # All property introductions and redefinitions in `self` (not inheritance).
724 var mpropdefs
= new Array[MPropDef]
726 # All property introductions and redefinitions (not inheritance) in `self` by its associated property.
727 var mpropdefs_by_property
= new HashMap[MProperty, MPropDef]
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 or sub
isa MErrorType then
842 assert sub
isa MClassType else print_error
"{sub} <? {sup}" # 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 or sup
isa MErrorType then
846 # These types are not super-types of Class-based types.
850 assert sup
isa MClassType else print_error
"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 `MErrorType`.
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 `MErrorType`.
1055 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1057 # Is the type a `MErrorType` or contains an `MErrorType`?
1059 # `MErrorType` are used in result with conflict or inconsistencies.
1061 # See `is_legal_in` to check conformity with generic bounds.
1062 fun is_ok
: Bool do return true
1064 # Is the type legal in a given `mmodule` (with an optional `anchor`)?
1066 # A type is valid if:
1068 # * it does not contain a `MErrorType` (see `is_ok`).
1069 # * its generic formal arguments are within their bounds.
1070 fun is_legal_in
(mmodule
: MModule, anchor
: nullable MClassType): Bool do return is_ok
1072 # Can the type be resolved?
1074 # In order to resolve open types, the formal types must make sence.
1084 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
1086 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
1088 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
1089 # # B[E] is a red hearing only the E is important,
1090 # # E make sense in A
1093 # REQUIRE: `anchor != null implies not anchor.need_anchor`
1094 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
1095 # ENSURE: `not self.need_anchor implies result == true`
1096 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
1098 # Return the nullable version of the type
1099 # If the type is already nullable then self is returned
1100 fun as_nullable
: MType
1102 var res
= self.as_nullable_cache
1103 if res
!= null then return res
1104 res
= new MNullableType(self)
1105 self.as_nullable_cache
= res
1109 # Remove the base type of a decorated (proxy) type.
1110 # Is the type is not decorated, then self is returned.
1112 # Most of the time it is used to return the not nullable version of a nullable type.
1113 # In this case, this just remove the `nullable` notation, but the result can still contains null.
1114 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
1115 # If you really want to exclude the `null` value, then use `as_notnull`
1116 fun undecorate
: MType
1121 # Returns the not null version of the type.
1122 # That is `self` minus the `null` value.
1124 # For most types, this return `self`.
1125 # For formal types, this returns a special `MNotNullType`
1126 fun as_notnull
: MType do return self
1128 private var as_nullable_cache
: nullable MType = null
1131 # The depth of the type seen as a tree.
1138 # Formal types have a depth of 1.
1139 # Only `MClassType` and `MFormalType` nodes are counted.
1145 # The length of the type seen as a tree.
1152 # Formal types have a length of 1.
1153 # Only `MClassType` and `MFormalType` nodes are counted.
1159 # Compute all the classdefs inherited/imported.
1160 # The returned set contains:
1161 # * the class definitions from `mmodule` and its imported modules
1162 # * the class definitions of this type and its super-types
1164 # This function is used mainly internally.
1166 # REQUIRE: `not self.need_anchor`
1167 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1169 # Compute all the super-classes.
1170 # This function is used mainly internally.
1172 # REQUIRE: `not self.need_anchor`
1173 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1175 # Compute all the declared super-types.
1176 # Super-types are returned as declared in the classdefs (verbatim).
1177 # This function is used mainly internally.
1179 # REQUIRE: `not self.need_anchor`
1180 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1182 # Is the property in self for a given module
1183 # This method does not filter visibility or whatever
1185 # REQUIRE: `not self.need_anchor`
1186 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1188 assert not self.need_anchor
1189 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1193 # A type based on a class.
1195 # `MClassType` have properties (see `has_mproperty`).
1199 # The associated class
1202 redef fun model
do return self.mclass
.intro_mmodule
.model
1204 redef fun location
do return mclass
.location
1206 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1208 # The formal arguments of the type
1209 # ENSURE: `result.length == self.mclass.arity`
1210 var arguments
= new Array[MType]
1212 redef fun to_s
do return mclass
.to_s
1214 redef fun full_name
do return mclass
.full_name
1216 redef fun c_name
do return mclass
.c_name
1218 redef fun need_anchor
do return false
1220 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1222 return super.as(MClassType)
1225 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1227 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1229 redef fun collect_mclassdefs
(mmodule
)
1231 assert not self.need_anchor
1232 var cache
= self.collect_mclassdefs_cache
1233 if not cache
.has_key
(mmodule
) then
1234 self.collect_things
(mmodule
)
1236 return cache
[mmodule
]
1239 redef fun collect_mclasses
(mmodule
)
1241 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1242 assert not self.need_anchor
1243 var cache
= self.collect_mclasses_cache
1244 if not cache
.has_key
(mmodule
) then
1245 self.collect_things
(mmodule
)
1247 var res
= cache
[mmodule
]
1248 collect_mclasses_last_module
= mmodule
1249 collect_mclasses_last_module_cache
= res
1253 private var collect_mclasses_last_module
: nullable MModule = null
1254 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1256 redef fun collect_mtypes
(mmodule
)
1258 assert not self.need_anchor
1259 var cache
= self.collect_mtypes_cache
1260 if not cache
.has_key
(mmodule
) then
1261 self.collect_things
(mmodule
)
1263 return cache
[mmodule
]
1266 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1267 private fun collect_things
(mmodule
: MModule)
1269 var res
= new HashSet[MClassDef]
1270 var seen
= new HashSet[MClass]
1271 var types
= new HashSet[MClassType]
1272 seen
.add
(self.mclass
)
1273 var todo
= [self.mclass
]
1274 while not todo
.is_empty
do
1275 var mclass
= todo
.pop
1276 #print "process {mclass}"
1277 for mclassdef
in mclass
.mclassdefs
do
1278 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1279 #print " process {mclassdef}"
1281 for supertype
in mclassdef
.supertypes
do
1282 types
.add
(supertype
)
1283 var superclass
= supertype
.mclass
1284 if seen
.has
(superclass
) then continue
1285 #print " add {superclass}"
1286 seen
.add
(superclass
)
1287 todo
.add
(superclass
)
1291 collect_mclassdefs_cache
[mmodule
] = res
1292 collect_mclasses_cache
[mmodule
] = seen
1293 collect_mtypes_cache
[mmodule
] = types
1296 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1297 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1298 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1302 # A type based on a generic class.
1303 # A generic type a just a class with additional formal generic arguments.
1309 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1313 assert self.mclass
.arity
== arguments
.length
1315 self.need_anchor
= false
1316 for t
in arguments
do
1317 if t
.need_anchor
then
1318 self.need_anchor
= true
1323 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1326 # The short-name of the class, then the full-name of each type arguments within brackets.
1327 # Example: `"Map[String, List[Int]]"`
1328 redef var to_s
is noinit
1330 # The full-name of the class, then the full-name of each type arguments within brackets.
1331 # Example: `"core::Map[core::String, core::List[core::Int]]"`
1332 redef var full_name
is lazy
do
1333 var args
= new Array[String]
1334 for t
in arguments
do
1335 args
.add t
.full_name
1337 return "{mclass.full_name}[{args.join(", ")}]"
1340 redef var c_name
is lazy
do
1341 var res
= mclass
.c_name
1342 # Note: because the arity is known, a prefix notation is enough
1343 for t
in arguments
do
1350 redef var need_anchor
is noinit
1352 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1354 if not need_anchor
then return self
1355 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1356 var types
= new Array[MType]
1357 for t
in arguments
do
1358 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1360 return mclass
.get_mtype
(types
)
1363 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1365 if not need_anchor
then return true
1366 for t
in arguments
do
1367 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1374 for t
in arguments
do if not t
.is_ok
then return false
1378 redef fun is_legal_in
(mmodule
, anchor
)
1382 assert anchor
!= null
1383 mtype
= anchor_to
(mmodule
, anchor
)
1387 if not mtype
.is_ok
then return false
1388 return mtype
.is_subtype
(mmodule
, null, mtype
.mclass
.intro
.bound_mtype
)
1394 for a
in self.arguments
do
1396 if d
> dmax
then dmax
= d
1404 for a
in self.arguments
do
1411 # A formal type (either virtual of parametric).
1413 # The main issue with formal types is that they offer very little information on their own
1414 # and need a context (anchor and mmodule) to be useful.
1415 abstract class MFormalType
1418 redef var as_notnull
= new MNotNullType(self) is lazy
1421 # A virtual formal type.
1425 # The property associated with the type.
1426 # Its the definitions of this property that determine the bound or the virtual type.
1427 var mproperty
: MVirtualTypeProp
1429 redef fun location
do return mproperty
.location
1431 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1433 redef fun lookup_bound
(mmodule
, resolved_receiver
)
1435 # There is two possible invalid cases: the vt does not exists in resolved_receiver or the bound is broken
1436 if not resolved_receiver
.has_mproperty
(mmodule
, mproperty
) then return new MErrorType(model
)
1437 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
or else new MErrorType(model
)
1440 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1442 assert not resolved_receiver
.need_anchor
1443 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1444 if props
.is_empty
then
1446 else if props
.length
== 1 then
1449 var types
= new ArraySet[MType]
1450 var res
= props
.first
1452 types
.add
(p
.bound
.as(not null))
1453 if not res
.is_fixed
then res
= p
1455 if types
.length
== 1 then
1461 # A VT is fixed when:
1462 # * the VT is (re-)defined with the annotation `is fixed`
1463 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1464 # * the receiver is an enum class since there is no subtype possible
1465 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1467 assert not resolved_receiver
.need_anchor
1468 resolved_receiver
= resolved_receiver
.undecorate
1469 assert resolved_receiver
isa MClassType # It is the only remaining type
1471 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1472 var res
= prop
.bound
1473 if res
== null then return new MErrorType(model
)
1475 # Recursively lookup the fixed result
1476 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1478 # 1. For a fixed VT, return the resolved bound
1479 if prop
.is_fixed
then return res
1481 # 2. For a enum boud, return the bound
1482 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1484 # 3. for a enum receiver return the bound
1485 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1490 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1492 if not cleanup_virtual
then return self
1493 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1495 if mproperty
.is_selftype
then return mtype
1497 # self is a virtual type declared (or inherited) in mtype
1498 # The point of the function it to get the bound of the virtual type that make sense for mtype
1499 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1500 #print "{class_name}: {self}/{mtype}/{anchor}?"
1501 var resolved_receiver
1502 if mtype
.need_anchor
then
1503 assert anchor
!= null
1504 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1506 resolved_receiver
= mtype
1508 # Now, we can get the bound
1509 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1510 # The bound is exactly as declared in the "type" property, so we must resolve it again
1511 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1516 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1518 if mtype
.need_anchor
then
1519 assert anchor
!= null
1520 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1522 return mtype
.has_mproperty
(mmodule
, mproperty
)
1525 redef fun to_s
do return self.mproperty
.to_s
1527 redef fun full_name
do return self.mproperty
.full_name
1529 redef fun c_name
do return self.mproperty
.c_name
1532 # The type associated to a formal parameter generic type of a class
1534 # Each parameter type is associated to a specific class.
1535 # It means that all refinements of a same class "share" the parameter type,
1536 # but that a generic subclass has its own parameter types.
1538 # However, in the sense of the meta-model, a parameter type of a class is
1539 # a valid type in a subclass. The "in the sense of the meta-model" is
1540 # important because, in the Nit language, the programmer cannot refers
1541 # directly to the parameter types of the super-classes.
1546 # fun e: E is abstract
1552 # In the class definition B[F], `F` is a valid type but `E` is not.
1553 # However, `self.e` is a valid method call, and the signature of `e` is
1556 # Note that parameter types are shared among class refinements.
1557 # Therefore parameter only have an internal name (see `to_s` for details).
1558 class MParameterType
1561 # The generic class where the parameter belong
1564 redef fun model
do return self.mclass
.intro_mmodule
.model
1566 redef fun location
do return mclass
.location
1568 # The position of the parameter (0 for the first parameter)
1569 # FIXME: is `position` a better name?
1574 redef fun to_s
do return name
1576 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1578 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1580 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1582 assert not resolved_receiver
.need_anchor
1583 resolved_receiver
= resolved_receiver
.undecorate
1584 assert resolved_receiver
isa MClassType # It is the only remaining type
1585 var goalclass
= self.mclass
1586 if resolved_receiver
.mclass
== goalclass
then
1587 return resolved_receiver
.arguments
[self.rank
]
1589 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1590 for t
in supertypes
do
1591 if t
.mclass
== goalclass
then
1592 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1593 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1594 var res
= t
.arguments
[self.rank
]
1598 # Cannot found `self` in `resolved_receiver`
1599 return new MErrorType(model
)
1602 # A PT is fixed when:
1603 # * Its bound is a enum class (see `enum_kind`).
1604 # The PT is just useless, but it is still a case.
1605 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1606 # so it is necessarily fixed in a `super` clause, either with a normal type
1607 # or with another PT.
1608 # See `resolve_for` for examples about related issues.
1609 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1611 assert not resolved_receiver
.need_anchor
1612 resolved_receiver
= resolved_receiver
.undecorate
1613 assert resolved_receiver
isa MClassType # It is the only remaining type
1614 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1618 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1620 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1621 #print "{class_name}: {self}/{mtype}/{anchor}?"
1623 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1624 var res
= mtype
.arguments
[self.rank
]
1625 if anchor
!= null and res
.need_anchor
then
1626 # Maybe the result can be resolved more if are bound to a final class
1627 var r2
= res
.anchor_to
(mmodule
, anchor
)
1628 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1633 # self is a parameter type of mtype (or of a super-class of mtype)
1634 # The point of the function it to get the bound of the virtual type that make sense for mtype
1635 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1636 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1637 var resolved_receiver
1638 if mtype
.need_anchor
then
1639 assert anchor
!= null
1640 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1642 resolved_receiver
= mtype
1644 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1645 if resolved_receiver
isa MParameterType then
1646 assert anchor
!= null
1647 assert resolved_receiver
.mclass
== anchor
.mclass
1648 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1649 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1651 assert resolved_receiver
isa MClassType # It is the only remaining type
1653 # Eh! The parameter is in the current class.
1654 # So we return the corresponding argument, no mater what!
1655 if resolved_receiver
.mclass
== self.mclass
then
1656 var res
= resolved_receiver
.arguments
[self.rank
]
1657 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1661 if resolved_receiver
.need_anchor
then
1662 assert anchor
!= null
1663 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1665 # Now, we can get the bound
1666 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1667 # The bound is exactly as declared in the "type" property, so we must resolve it again
1668 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1670 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1675 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1677 if mtype
.need_anchor
then
1678 assert anchor
!= null
1679 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1681 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1685 # A type that decorates another type.
1687 # The point of this class is to provide a common implementation of sevices that just forward to the original type.
1688 # Specific decorator are expected to redefine (or to extend) the default implementation as this suit them.
1689 abstract class MProxyType
1694 redef fun location
do return mtype
.location
1696 redef fun model
do return self.mtype
.model
1697 redef fun need_anchor
do return mtype
.need_anchor
1698 redef fun as_nullable
do return mtype
.as_nullable
1699 redef fun as_notnull
do return mtype
.as_notnull
1700 redef fun undecorate
do return mtype
.undecorate
1701 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1703 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1707 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1709 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1712 redef fun is_ok
do return mtype
.is_ok
1714 redef fun is_legal_in
(mmodule
, anchor
) do return mtype
.is_legal_in
(mmodule
, anchor
)
1716 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1718 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1722 redef fun depth
do return self.mtype
.depth
1724 redef fun length
do return self.mtype
.length
1726 redef fun collect_mclassdefs
(mmodule
)
1728 assert not self.need_anchor
1729 return self.mtype
.collect_mclassdefs
(mmodule
)
1732 redef fun collect_mclasses
(mmodule
)
1734 assert not self.need_anchor
1735 return self.mtype
.collect_mclasses
(mmodule
)
1738 redef fun collect_mtypes
(mmodule
)
1740 assert not self.need_anchor
1741 return self.mtype
.collect_mtypes
(mmodule
)
1745 # A type prefixed with "nullable"
1751 self.to_s
= "nullable {mtype}"
1754 redef var to_s
is noinit
1756 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1758 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1760 redef fun as_nullable
do return self
1761 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1764 return res
.as_nullable
1767 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1768 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1771 if t
== mtype
then return self
1772 return t
.as_nullable
1776 # A non-null version of a formal type.
1778 # When a formal type in bounded to a nullable type, this is the type of the not null version of it.
1782 redef fun to_s
do return "not null {mtype}"
1783 redef var full_name
is lazy
do return "not null {mtype.full_name}"
1784 redef var c_name
is lazy
do return "notnull__{mtype.c_name}"
1786 redef fun as_notnull
do return self
1788 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1791 return res
.as_notnull
1794 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_notnull`
1795 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1798 if t
== mtype
then return self
1803 # The type of the only value null
1805 # The is only one null type per model, see `MModel::null_type`.
1809 redef fun to_s
do return "null"
1810 redef fun full_name
do return "null"
1811 redef fun c_name
do return "null"
1812 redef fun as_nullable
do return self
1814 redef var as_notnull
= new MBottomType(model
) is lazy
1815 redef fun need_anchor
do return false
1816 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1817 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1819 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1821 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1823 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1826 # The special universal most specific type.
1828 # This type is intended to be only used internally for type computation or analysis and should not be exposed to the user.
1829 # The bottom type can de used to denote things that are dead (no instance).
1831 # Semantically it is the singleton `null.as_notnull`.
1832 # Is also means that `self.as_nullable == null`.
1836 redef fun to_s
do return "bottom"
1837 redef fun full_name
do return "bottom"
1838 redef fun c_name
do return "bottom"
1839 redef fun as_nullable
do return model
.null_type
1840 redef fun as_notnull
do return self
1841 redef fun need_anchor
do return false
1842 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1843 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1845 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1847 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1849 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1852 # A special type used as a silent error marker when building types.
1854 # This type is intended to be only used internally for type operation and should not be exposed to the user.
1855 # The error type can de used to denote things that are conflicting or inconsistent.
1857 # Some methods on types can return a `MErrorType` to denote a broken or a conflicting result.
1858 # Use `is_ok` to check if a type is (or contains) a `MErrorType` .
1862 redef fun to_s
do return "error"
1863 redef fun full_name
do return "error"
1864 redef fun c_name
do return "error"
1865 redef fun need_anchor
do return false
1866 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1867 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1868 redef fun is_ok
do return false
1870 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1872 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1874 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1877 # A signature of a method
1881 # The each parameter (in order)
1882 var mparameters
: Array[MParameter]
1884 # Returns a parameter named `name`, if any.
1885 fun mparameter_by_name
(name
: String): nullable MParameter
1887 for p
in mparameters
do
1888 if p
.name
== name
then return p
1893 # The return type (null for a procedure)
1894 var return_mtype
: nullable MType
1899 var t
= self.return_mtype
1900 if t
!= null then dmax
= t
.depth
1901 for p
in mparameters
do
1902 var d
= p
.mtype
.depth
1903 if d
> dmax
then dmax
= d
1911 var t
= self.return_mtype
1912 if t
!= null then res
+= t
.length
1913 for p
in mparameters
do
1914 res
+= p
.mtype
.length
1919 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1922 var vararg_rank
= -1
1923 for i
in [0..mparameters
.length
[ do
1924 var parameter
= mparameters
[i
]
1925 if parameter
.is_vararg
then
1926 if vararg_rank
>= 0 then
1927 # If there is more than one vararg,
1928 # consider that additional arguments cannot be mapped.
1935 self.vararg_rank
= vararg_rank
1938 # The rank of the main ellipsis (`...`) for vararg (starting from 0).
1939 # value is -1 if there is no vararg.
1940 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1942 # From a model POV, a signature can contain more than one vararg parameter,
1943 # the `vararg_rank` just indicates the one that will receive the additional arguments.
1944 # However, currently, if there is more that one vararg parameter, no one will be the main one,
1945 # and additional arguments will be refused.
1946 var vararg_rank
: Int is noinit
1948 # The number of parameters
1949 fun arity
: Int do return mparameters
.length
1953 var b
= new FlatBuffer
1954 if not mparameters
.is_empty
then
1956 for i
in [0..mparameters
.length
[ do
1957 var mparameter
= mparameters
[i
]
1958 if i
> 0 then b
.append
(", ")
1959 b
.append
(mparameter
.name
)
1961 b
.append
(mparameter
.mtype
.to_s
)
1962 if mparameter
.is_vararg
then
1968 var ret
= self.return_mtype
1976 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1978 var params
= new Array[MParameter]
1979 for p
in self.mparameters
do
1980 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1982 var ret
= self.return_mtype
1984 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1986 var res
= new MSignature(params
, ret
)
1991 # A parameter in a signature
1995 # The name of the parameter
1998 # The static type of the parameter
2001 # Is the parameter a vararg?
2007 return "{name}: {mtype}..."
2009 return "{name}: {mtype}"
2013 # Returns a new parameter with the `mtype` resolved.
2014 # See `MType::resolve_for` for details.
2015 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
2017 if not self.mtype
.need_anchor
then return self
2018 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
2019 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
2023 redef fun model
do return mtype
.model
2026 # A service (global property) that generalize method, attribute, etc.
2028 # `MProperty` are global to the model; it means that a `MProperty` is not bound
2029 # to a specific `MModule` nor a specific `MClass`.
2031 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
2032 # and the other in subclasses and in refinements.
2034 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
2035 # of any dynamic type).
2036 # For instance, a call site "x.foo" is associated to a `MProperty`.
2037 abstract class MProperty
2040 # The associated MPropDef subclass.
2041 # The two specialization hierarchy are symmetric.
2042 type MPROPDEF: MPropDef
2044 # The classdef that introduce the property
2045 # While a property is not bound to a specific module, or class,
2046 # the introducing mclassdef is used for naming and visibility
2047 var intro_mclassdef
: MClassDef
2049 # The (short) name of the property
2054 redef fun mdoc_or_fallback
do return intro
.mdoc_or_fallback
2056 # The canonical name of the property.
2058 # It is currently the short-`name` prefixed by the short-name of the class and the full-name of the module.
2059 # Example: "my_package::my_module::MyClass::my_method"
2061 # The full-name of the module is needed because two distinct modules of the same package can
2062 # still refine the same class and introduce homonym properties.
2064 # For public properties not introduced by refinement, the module name is not used.
2066 # Example: `my_package::MyClass::My_method`
2067 redef var full_name
is lazy
do
2068 if intro_mclassdef
.is_intro
then
2069 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
2071 return "{intro_mclassdef.mmodule.full_name}::{intro_mclassdef.mclass.name}::{name}"
2075 redef var c_name
is lazy
do
2076 # FIXME use `namespace_for`
2077 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
2080 # The visibility of the property
2081 redef var visibility
2083 # Is the property usable as an initializer?
2084 var is_autoinit
= false is writable
2088 intro_mclassdef
.intro_mproperties
.add
(self)
2089 var model
= intro_mclassdef
.mmodule
.model
2090 model
.mproperties_by_name
.add_one
(name
, self)
2091 model
.mproperties
.add
(self)
2094 # All definitions of the property.
2095 # The first is the introduction,
2096 # The other are redefinitions (in refinements and in subclasses)
2097 var mpropdefs
= new Array[MPROPDEF]
2099 # The definition that introduces the property.
2101 # Warning: such a definition may not exist in the early life of the object.
2102 # In this case, the method will abort.
2103 var intro
: MPROPDEF is noinit
2105 redef fun model
do return intro
.model
2108 redef fun to_s
do return name
2110 # Return the most specific property definitions defined or inherited by a type.
2111 # The selection knows that refinement is stronger than specialization;
2112 # however, in case of conflict more than one property are returned.
2113 # If mtype does not know mproperty then an empty array is returned.
2115 # If you want the really most specific property, then look at `lookup_first_definition`
2117 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2118 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
2119 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2121 assert not mtype
.need_anchor
2122 mtype
= mtype
.undecorate
2124 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
2125 if cache
!= null then return cache
2127 #print "select prop {mproperty} for {mtype} in {self}"
2128 # First, select all candidates
2129 var candidates
= new Array[MPROPDEF]
2131 # Here we have two strategies: iterate propdefs or iterate classdefs.
2132 var mpropdefs
= self.mpropdefs
2133 if mpropdefs
.length
<= 1 or mpropdefs
.length
< mtype
.collect_mclassdefs
(mmodule
).length
then
2134 # Iterate on all definitions of `self`, keep only those inherited by `mtype` in `mmodule`
2135 for mpropdef
in mpropdefs
do
2136 # If the definition is not imported by the module, then skip
2137 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2138 # If the definition is not inherited by the type, then skip
2139 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2141 candidates
.add
(mpropdef
)
2144 # Iterate on all super-classdefs of `mtype`, keep only the definitions of `self`, if any.
2145 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
2146 var p
= mclassdef
.mpropdefs_by_property
.get_or_null
(self)
2147 if p
!= null then candidates
.add p
2151 # Fast track for only one candidate
2152 if candidates
.length
<= 1 then
2153 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
2157 # Second, filter the most specific ones
2158 return select_most_specific
(mmodule
, candidates
)
2161 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2163 # Return the most specific property definitions inherited by a type.
2164 # The selection knows that refinement is stronger than specialization;
2165 # however, in case of conflict more than one property are returned.
2166 # If mtype does not know mproperty then an empty array is returned.
2168 # If you want the really most specific property, then look at `lookup_next_definition`
2170 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2171 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
2172 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2174 assert not mtype
.need_anchor
2175 mtype
= mtype
.undecorate
2177 # First, select all candidates
2178 var candidates
= new Array[MPROPDEF]
2179 for mpropdef
in self.mpropdefs
do
2180 # If the definition is not imported by the module, then skip
2181 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2182 # If the definition is not inherited by the type, then skip
2183 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2184 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
2185 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
2187 candidates
.add
(mpropdef
)
2189 # Fast track for only one candidate
2190 if candidates
.length
<= 1 then return candidates
2192 # Second, filter the most specific ones
2193 return select_most_specific
(mmodule
, candidates
)
2196 # Return an array containing olny the most specific property definitions
2197 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
2198 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
2200 var res
= new Array[MPROPDEF]
2201 for pd1
in candidates
do
2202 var cd1
= pd1
.mclassdef
2205 for pd2
in candidates
do
2206 if pd2
== pd1
then continue # do not compare with self!
2207 var cd2
= pd2
.mclassdef
2209 if c2
.mclass_type
== c1
.mclass_type
then
2210 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
2211 # cd2 refines cd1; therefore we skip pd1
2215 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
2216 # cd2 < cd1; therefore we skip pd1
2225 if res
.is_empty
then
2226 print_error
"All lost! {candidates.join(", ")}"
2227 # FIXME: should be abort!
2232 # Return the most specific definition in the linearization of `mtype`.
2234 # If you want to know the next properties in the linearization,
2235 # look at `MPropDef::lookup_next_definition`.
2237 # FIXME: the linearization is still unspecified
2239 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2240 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2241 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2243 return lookup_all_definitions
(mmodule
, mtype
).first
2246 # Return all definitions in a linearization order
2247 # Most specific first, most general last
2249 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2250 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2251 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2253 mtype
= mtype
.undecorate
2255 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
2256 if cache
!= null then return cache
2258 assert not mtype
.need_anchor
2259 assert mtype
.has_mproperty
(mmodule
, self)
2261 #print "select prop {mproperty} for {mtype} in {self}"
2262 # First, select all candidates
2263 var candidates
= new Array[MPROPDEF]
2264 for mpropdef
in self.mpropdefs
do
2265 # If the definition is not imported by the module, then skip
2266 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2267 # If the definition is not inherited by the type, then skip
2268 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2270 candidates
.add
(mpropdef
)
2272 # Fast track for only one candidate
2273 if candidates
.length
<= 1 then
2274 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2278 mmodule
.linearize_mpropdefs
(candidates
)
2279 candidates
= candidates
.reversed
2280 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2284 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2291 redef type MPROPDEF: MMethodDef
2293 # Is the property defined at the top_level of the module?
2294 # Currently such a property are stored in `Object`
2295 var is_toplevel
: Bool = false is writable
2297 # Is the property a constructor?
2298 # Warning, this property can be inherited by subclasses with or without being a constructor
2299 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
2300 var is_init
: Bool = false is writable
2302 # The constructor is a (the) root init with empty signature but a set of initializers
2303 var is_root_init
: Bool = false is writable
2305 # Is the property a 'new' constructor?
2306 var is_new
: Bool = false is writable
2308 # Is the property a legal constructor for a given class?
2309 # As usual, visibility is not considered.
2310 # FIXME not implemented
2311 fun is_init_for
(mclass
: MClass): Bool
2316 # A specific method that is safe to call on null.
2317 # Currently, only `==`, `!=` and `is_same_instance` are safe
2318 fun is_null_safe
: Bool do return name
== "==" or name
== "!=" or name
== "is_same_instance"
2321 # A global attribute
2325 redef type MPROPDEF: MAttributeDef
2329 # A global virtual type
2330 class MVirtualTypeProp
2333 redef type MPROPDEF: MVirtualTypeDef
2335 # The formal type associated to the virtual type property
2336 var mvirtualtype
= new MVirtualType(self)
2338 # Is `self` the special virtual type `SELF`?
2339 var is_selftype
: Bool is lazy
do return name
== "SELF"
2342 # A definition of a property (local property)
2344 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2345 # specific class definition (which belong to a specific module)
2346 abstract class MPropDef
2349 # The associated `MProperty` subclass.
2350 # the two specialization hierarchy are symmetric
2351 type MPROPERTY: MProperty
2354 type MPROPDEF: MPropDef
2356 # The class definition where the property definition is
2357 var mclassdef
: MClassDef
2359 # The associated global property
2360 var mproperty
: MPROPERTY
2362 redef var location
: Location
2364 redef fun visibility
do return mproperty
.visibility
2368 mclassdef
.mpropdefs
.add
(self)
2369 mproperty
.mpropdefs
.add
(self)
2370 mclassdef
.mpropdefs_by_property
[mproperty
] = self
2371 if mproperty
.intro_mclassdef
== mclassdef
then
2372 assert not isset mproperty
._intro
2373 mproperty
.intro
= self
2375 self.to_s
= "{mclassdef}${mproperty}"
2378 # Actually the name of the `mproperty`
2379 redef fun name
do return mproperty
.name
2381 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2383 # Therefore the combination of identifiers is awful,
2384 # the worst case being
2386 # * a property "p::m::A::x"
2387 # * redefined in a refinement of a class "q::n::B"
2388 # * in a module "r::o"
2389 # * so "r::o$q::n::B$p::m::A::x"
2391 # Fortunately, the full-name is simplified when entities are repeated.
2392 # For the previous case, the simplest form is "p$A$x".
2393 redef var full_name
is lazy
do
2394 var res
= new FlatBuffer
2396 # The first part is the mclassdef. Worst case is "r::o$q::n::B"
2397 res
.append mclassdef
.full_name
2401 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2402 # intro are unambiguous in a class
2405 # Just try to simplify each part
2406 if mclassdef
.mmodule
.mpackage
!= mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2407 # precise "p::m" only if "p" != "r"
2408 res
.append mproperty
.intro_mclassdef
.mmodule
.namespace_for
(mproperty
.visibility
)
2410 else if mproperty
.visibility
<= private_visibility
then
2411 # Same package ("p"=="q"), but private visibility,
2412 # does the module part ("::m") need to be displayed
2413 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2415 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2419 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2420 # precise "B" only if not the same class than "A"
2421 res
.append mproperty
.intro_mclassdef
.name
2424 # Always use the property name "x"
2425 res
.append mproperty
.name
2430 redef var c_name
is lazy
do
2431 var res
= new FlatBuffer
2432 res
.append mclassdef
.c_name
2434 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2435 res
.append name
.to_cmangle
2437 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2438 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2441 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2442 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2445 res
.append mproperty
.name
.to_cmangle
2450 redef fun model
do return mclassdef
.model
2452 # Internal name combining the module, the class and the property
2453 # Example: "mymodule$MyClass$mymethod"
2454 redef var to_s
is noinit
2456 # Is self the definition that introduce the property?
2457 fun is_intro
: Bool do return isset mproperty
._intro
and mproperty
.intro
== self
2459 # Return the next definition in linearization of `mtype`.
2461 # This method is used to determine what method is called by a super.
2463 # REQUIRE: `not mtype.need_anchor`
2464 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2466 assert not mtype
.need_anchor
2468 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2469 var i
= mpropdefs
.iterator
2470 while i
.is_ok
and i
.item
!= self do i
.next
2471 assert has_property
: i
.is_ok
2473 assert has_next_property
: i
.is_ok
2478 # A local definition of a method
2482 redef type MPROPERTY: MMethod
2483 redef type MPROPDEF: MMethodDef
2485 # The signature attached to the property definition
2486 var msignature
: nullable MSignature = null is writable
2488 # The signature attached to the `new` call on a root-init
2489 # This is a concatenation of the signatures of the initializers
2491 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2492 var new_msignature
: nullable MSignature = null is writable
2494 # List of initialisers to call in root-inits
2496 # They could be setters or attributes
2498 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2499 var initializers
= new Array[MProperty]
2501 # Is the method definition abstract?
2502 var is_abstract
: Bool = false is writable
2504 # Is the method definition intern?
2505 var is_intern
= false is writable
2507 # Is the method definition extern?
2508 var is_extern
= false is writable
2510 # An optional constant value returned in functions.
2512 # Only some specific primitife value are accepted by engines.
2513 # Is used when there is no better implementation available.
2515 # Currently used only for the implementation of the `--define`
2516 # command-line option.
2517 # SEE: module `mixin`.
2518 var constant_value
: nullable Object = null is writable
2521 # A local definition of an attribute
2525 redef type MPROPERTY: MAttribute
2526 redef type MPROPDEF: MAttributeDef
2528 # The static type of the attribute
2529 var static_mtype
: nullable MType = null is writable
2532 # A local definition of a virtual type
2533 class MVirtualTypeDef
2536 redef type MPROPERTY: MVirtualTypeProp
2537 redef type MPROPDEF: MVirtualTypeDef
2539 # The bound of the virtual type
2540 var bound
: nullable MType = null is writable
2542 # Is the bound fixed?
2543 var is_fixed
= false is writable
2550 # * `interface_kind`
2554 # Note this class is basically an enum.
2555 # FIXME: use a real enum once user-defined enums are available
2559 # Is a constructor required?
2562 # TODO: private init because enumeration.
2564 # Can a class of kind `self` specializes a class of kine `other`?
2565 fun can_specialize
(other
: MClassKind): Bool
2567 if other
== interface_kind
then return true # everybody can specialize interfaces
2568 if self == interface_kind
or self == enum_kind
then
2569 # no other case for interfaces
2571 else if self == extern_kind
then
2572 # only compatible with themselves
2573 return self == other
2574 else if other
== enum_kind
or other
== extern_kind
then
2575 # abstract_kind and concrete_kind are incompatible
2578 # remain only abstract_kind and concrete_kind
2583 # The class kind `abstract`
2584 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2585 # The class kind `concrete`
2586 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2587 # The class kind `interface`
2588 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2589 # The class kind `enum`
2590 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2591 # The class kind `extern`
2592 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)