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
571 # Don’t use `intro.mdoc_or_fallback` because it would create an infinite
578 # A definition (an introduction or a refinement) of a class in a module
580 # A `MClassDef` is associated with an explicit (or almost) definition of a
581 # class. Unlike `MClass`, a `MClassDef` is a local definition that belong to
582 # a specific class and a specific module, and contains declarations like super-classes
585 # It is the class definitions that are the backbone of most things in the model:
586 # ClassDefs are defined with regard with other classdefs.
587 # Refinement and specialization are combined to produce a big poset called the `Model::mclassdef_hierarchy`.
589 # Moreover, the extension and the intention of types is defined by looking at the MClassDefs.
593 # The module where the definition is
596 # The associated `MClass`
597 var mclass
: MClass is noinit
599 # The bounded type associated to the mclassdef
601 # For a non-generic class, `bound_mtype` and `mclass.mclass_type`
605 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
606 # If you want Array[E], then see `mclass.mclass_type`
608 # ENSURE: `bound_mtype.mclass == self.mclass`
609 var bound_mtype
: MClassType
613 redef fun visibility
do return mclass
.visibility
615 # Internal name combining the module and the class
616 # Example: "mymodule$MyClass"
617 redef var to_s
is noinit
621 self.mclass
= bound_mtype
.mclass
622 mmodule
.mclassdefs
.add
(self)
623 mclass
.mclassdefs
.add
(self)
624 if mclass
.intro_mmodule
== mmodule
then
625 assert not isset mclass
._intro
628 self.to_s
= "{mmodule}${mclass}"
631 # Actually the name of the `mclass`
632 redef fun name
do return mclass
.name
634 # The module and class name separated by a '$'.
636 # The short-name of the class is used for introduction.
637 # Example: "my_module$MyClass"
639 # The full-name of the class is used for refinement.
640 # Example: "my_module$intro_module::MyClass"
641 redef var full_name
is lazy
do
644 # private gives 'p::m$A'
645 return "{mmodule.namespace_for(mclass.visibility)}${mclass.name}"
646 else if mclass
.intro_mmodule
.mpackage
!= mmodule
.mpackage
then
647 # public gives 'q::n$p::A'
648 # private gives 'q::n$p::m::A'
649 return "{mmodule.full_name}${mclass.full_name}"
650 else if mclass
.visibility
> private_visibility
then
651 # public gives 'p::n$A'
652 return "{mmodule.full_name}${mclass.name}"
654 # private gives 'p::n$::m::A' (redundant p is omitted)
655 return "{mmodule.full_name}$::{mclass.intro_mmodule.name}::{mclass.name}"
659 redef var c_name
is lazy
do
661 return "{mmodule.c_namespace_for(mclass.visibility)}___{mclass.c_name}"
662 else if mclass
.intro_mmodule
.mpackage
== mmodule
.mpackage
and mclass
.visibility
> private_visibility
then
663 return "{mmodule.c_name}___{mclass.name.to_cmangle}"
665 return "{mmodule.c_name}___{mclass.c_name}"
669 redef fun model
do return mmodule
.model
671 # All declared super-types
672 # FIXME: quite ugly but not better idea yet
673 var supertypes
= new Array[MClassType]
675 # Register some super-types for the class (ie "super SomeType")
677 # The hierarchy must not already be set
678 # REQUIRE: `self.in_hierarchy == null`
679 fun set_supertypes
(supertypes
: Array[MClassType])
681 assert unique_invocation
: self.in_hierarchy
== null
682 var mmodule
= self.mmodule
683 var model
= mmodule
.model
684 var mtype
= self.bound_mtype
686 for supertype
in supertypes
do
687 self.supertypes
.add
(supertype
)
689 # Register in full_type_specialization_hierarchy
690 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
691 # Register in intro_type_specialization_hierarchy
692 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
693 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
699 # Collect the super-types (set by set_supertypes) to build the hierarchy
701 # This function can only invoked once by class
702 # REQUIRE: `self.in_hierarchy == null`
703 # ENSURE: `self.in_hierarchy != null`
706 assert unique_invocation
: self.in_hierarchy
== null
707 var model
= mmodule
.model
708 var res
= model
.mclassdef_hierarchy
.add_node
(self)
709 self.in_hierarchy
= res
710 var mtype
= self.bound_mtype
712 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
713 # The simpliest way is to attach it to collect_mclassdefs
714 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
715 res
.poset
.add_edge
(self, mclassdef
)
719 # The view of the class definition in `mclassdef_hierarchy`
720 var in_hierarchy
: nullable POSetElement[MClassDef] = null
722 # Is the definition the one that introduced `mclass`?
723 fun is_intro
: Bool do return isset mclass
._intro
and mclass
.intro
== self
725 # All properties introduced by the classdef
726 var intro_mproperties
= new Array[MProperty]
728 # All property introductions and redefinitions in `self` (not inheritance).
729 var mpropdefs
= new Array[MPropDef]
731 # All property introductions and redefinitions (not inheritance) in `self` by its associated property.
732 var mpropdefs_by_property
= new HashMap[MProperty, MPropDef]
734 redef fun mdoc_or_fallback
do return mdoc
or else mclass
.mdoc_or_fallback
737 # A global static type
739 # MType are global to the model; it means that a `MType` is not bound to a
740 # specific `MModule`.
741 # This characteristic helps the reasoning about static types in a program
742 # since a single `MType` object always denote the same type.
744 # However, because a `MType` is global, it does not really have properties
745 # nor have subtypes to a hierarchy since the property and the class hierarchy
746 # depends of a module.
747 # Moreover, virtual types an formal generic parameter types also depends on
748 # a receiver to have sense.
750 # Therefore, most method of the types require a module and an anchor.
751 # The module is used to know what are the classes and the specialization
753 # The anchor is used to know what is the bound of the virtual types and formal
754 # generic parameter types.
756 # MType are not directly usable to get properties. See the `anchor_to` method
757 # and the `MClassType` class.
759 # FIXME: the order of the parameters is not the best. We mus pick on from:
760 # * foo(mmodule, anchor, othertype)
761 # * foo(othertype, anchor, mmodule)
762 # * foo(anchor, mmodule, othertype)
763 # * foo(othertype, mmodule, anchor)
767 redef fun name
do return to_s
769 # Return true if `self` is an subtype of `sup`.
770 # The typing is done using the standard typing policy of Nit.
772 # REQUIRE: `anchor == null implies not self.need_anchor and not sup.need_anchor`
773 # REQUIRE: `anchor != null implies self.can_resolve_for(anchor, null, mmodule) and sup.can_resolve_for(anchor, null, mmodule)`
774 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
777 if sub
== sup
then return true
779 #print "1.is {sub} a {sup}? ===="
781 if anchor
== null then
782 assert not sub
.need_anchor
783 assert not sup
.need_anchor
785 # First, resolve the formal types to the simplest equivalent forms in the receiver
786 assert sub
.can_resolve_for
(anchor
, null, mmodule
)
787 sub
= sub
.lookup_fixed
(mmodule
, anchor
)
788 assert sup
.can_resolve_for
(anchor
, null, mmodule
)
789 sup
= sup
.lookup_fixed
(mmodule
, anchor
)
792 # Does `sup` accept null or not?
793 # Discard the nullable marker if it exists
794 var sup_accept_null
= false
795 if sup
isa MNullableType then
796 sup_accept_null
= true
798 else if sup
isa MNotNullType then
800 else if sup
isa MNullType then
801 sup_accept_null
= true
804 # Can `sub` provide null or not?
805 # Thus we can match with `sup_accept_null`
806 # Also discard the nullable marker if it exists
807 var sub_reject_null
= false
808 if sub
isa MNullableType then
809 if not sup_accept_null
then return false
811 else if sub
isa MNotNullType then
812 sub_reject_null
= true
814 else if sub
isa MNullType then
815 return sup_accept_null
817 # Now the case of direct null and nullable is over.
819 # If `sub` is a formal type, then it is accepted if its bound is accepted
820 while sub
isa MFormalType do
821 #print "3.is {sub} a {sup}?"
823 # A unfixed formal type can only accept itself
824 if sub
== sup
then return true
826 assert anchor
!= null
827 sub
= sub
.lookup_bound
(mmodule
, anchor
)
828 if sub_reject_null
then sub
= sub
.as_notnull
830 #print "3.is {sub} a {sup}?"
832 # Manage the second layer of null/nullable
833 if sub
isa MNullableType then
834 if not sup_accept_null
and not sub_reject_null
then return false
836 else if sub
isa MNotNullType then
837 sub_reject_null
= true
839 else if sub
isa MNullType then
840 return sup_accept_null
843 #print "4.is {sub} a {sup}? <- no more resolution"
845 if sub
isa MBottomType or sub
isa MErrorType then
849 assert sub
isa MClassType else print_error
"{sub} <? {sup}" # It is the only remaining type
851 # Handle sup-type when the sub-type is class-based (other cases must have be identified before).
852 if sup
isa MFormalType or sup
isa MNullType or sup
isa MBottomType or sup
isa MErrorType then
853 # These types are not super-types of Class-based types.
857 assert sup
isa MClassType else print_error
"got {sup} {sub.inspect}" # It is the only remaining type
859 # Now both are MClassType, we need to dig
861 if sub
== sup
then return true
863 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
864 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
865 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
866 if res
== false then return false
867 if not sup
isa MGenericType then return true
868 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
869 assert sub2
.mclass
== sup
.mclass
870 for i
in [0..sup
.mclass
.arity
[ do
871 var sub_arg
= sub2
.arguments
[i
]
872 var sup_arg
= sup
.arguments
[i
]
873 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
874 if res
== false then return false
879 # The base class type on which self is based
881 # This base type is used to get property (an internally to perform
882 # unsafe type comparison).
884 # Beware: some types (like null) are not based on a class thus this
887 # Basically, this function transform the virtual types and parameter
888 # types to their bounds.
893 # class B super A end
895 # class Y super X end
904 # Map[T,U] anchor_to H #-> Map[B,Y]
906 # Explanation of the example:
907 # In H, T is set to B, because "H super G[B]", and U is bound to Y,
908 # because "redef type U: Y". Therefore, Map[T, U] is bound to
911 # ENSURE: `not self.need_anchor implies result == self`
912 # ENSURE: `not result.need_anchor`
913 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
915 if not need_anchor
then return self
916 assert not anchor
.need_anchor
917 # Just resolve to the anchor and clear all the virtual types
918 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
919 assert not res
.need_anchor
923 # Does `self` contain a virtual type or a formal generic parameter type?
924 # In order to remove those types, you usually want to use `anchor_to`.
925 fun need_anchor
: Bool do return true
927 # Return the supertype when adapted to a class.
929 # In Nit, for each super-class of a type, there is a equivalent super-type.
935 # class H[V] super G[V, Bool] end
937 # H[Int] supertype_to G #-> G[Int, Bool]
940 # REQUIRE: `super_mclass` is a super-class of `self`
941 # REQUIRE: `self.need_anchor implies anchor != null and self.can_resolve_for(anchor, null, mmodule)`
942 # ENSURE: `result.mclass = super_mclass`
943 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
945 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
946 if self isa MClassType and self.mclass
== super_mclass
then return self
948 if self.need_anchor
then
949 assert anchor
!= null
950 resolved_self
= self.anchor_to
(mmodule
, anchor
)
954 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
955 for supertype
in supertypes
do
956 if supertype
.mclass
== super_mclass
then
957 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
958 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
964 # Replace formals generic types in self with resolved values in `mtype`
965 # If `cleanup_virtual` is true, then virtual types are also replaced
968 # This function returns self if `need_anchor` is false.
974 # class H[F] super G[F] end
978 # * Array[E].resolve_for(H[Int]) #-> Array[Int]
979 # * Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
981 # Explanation of the example:
982 # * Array[E].need_anchor is true because there is a formal generic parameter type E
983 # * E makes sense for H[Int] because E is a formal parameter of G and H specialize G
984 # * Since "H[F] super G[F]", E is in fact F for H
985 # * More specifically, in H[Int], E is Int
986 # * So, in H[Int], Array[E] is Array[Int]
988 # This function is mainly used to inherit a signature.
989 # Because, unlike `anchor_to`, we do not want a full resolution of
990 # a type but only an adapted version of it.
996 # fun foo(e:E):E is abstract
998 # class B super A[Int] end
1001 # The signature on foo is (e: E): E
1002 # If we resolve the signature for B, we get (e:Int):Int
1008 # fun foo(e:E):E is abstract
1011 # var a: A[Array[F]]
1012 # fun bar do a.foo(x) # <- x is here
1016 # The first question is: is foo available on `a`?
1018 # The static type of a is `A[Array[F]]`, that is an open type.
1019 # in order to find a method `foo`, whe must look at a resolved type.
1021 # A[Array[F]].anchor_to(C[nullable Object]) #-> A[Array[nullable Object]]
1023 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
1025 # The next question is: what is the accepted types for `x`?
1027 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
1029 # E.resolve_for(A[Array[F]],C[nullable Object]) #-> Array[F]
1031 # The resolution can be done because `E` make sense for the class A (see `can_resolve_for`)
1033 # FIXME: the parameter `cleanup_virtual` is just a bad idea, but having
1034 # two function instead of one seems also to be a bad idea.
1036 # REQUIRE: `can_resolve_for(mtype, anchor, mmodule)`
1037 # ENSURE: `not self.need_anchor implies result == self`
1038 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
1040 # Resolve formal type to its verbatim bound.
1041 # If the type is not formal, just return self
1043 # The result is returned exactly as declared in the "type" property (verbatim).
1044 # So it could be another formal type.
1046 # In case of conflicts or inconsistencies in the model, the method returns a `MErrorType`.
1047 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1049 # Resolve the formal type to its simplest equivalent form.
1051 # Formal types are either free or fixed.
1052 # When it is fixed, it means that it is equivalent with a simpler type.
1053 # When a formal type is free, it means that it is only equivalent with itself.
1054 # This method return the most simple equivalent type of `self`.
1056 # This method is mainly used for subtype test in order to sanely compare fixed.
1058 # By default, return self.
1059 # See the redefinitions for specific behavior in each kind of type.
1061 # In case of conflicts or inconsistencies in the model, the method returns a `MErrorType`.
1062 fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType do return self
1064 # Is the type a `MErrorType` or contains an `MErrorType`?
1066 # `MErrorType` are used in result with conflict or inconsistencies.
1068 # See `is_legal_in` to check conformity with generic bounds.
1069 fun is_ok
: Bool do return true
1071 # Is the type legal in a given `mmodule` (with an optional `anchor`)?
1073 # A type is valid if:
1075 # * it does not contain a `MErrorType` (see `is_ok`).
1076 # * its generic formal arguments are within their bounds.
1077 fun is_legal_in
(mmodule
: MModule, anchor
: nullable MClassType): Bool do return is_ok
1079 # Can the type be resolved?
1081 # In order to resolve open types, the formal types must make sence.
1091 # E.can_resolve_for(A[Int]) #-> true, E make sense in A
1093 # E.can_resolve_for(B[Int]) #-> false, E does not make sense in B
1095 # B[E].can_resolve_for(A[F], B[Object]) #-> true,
1096 # # B[E] is a red hearing only the E is important,
1097 # # E make sense in A
1100 # REQUIRE: `anchor != null implies not anchor.need_anchor`
1101 # REQUIRE: `mtype.need_anchor implies anchor != null and mtype.can_resolve_for(anchor, null, mmodule)`
1102 # ENSURE: `not self.need_anchor implies result == true`
1103 fun can_resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule): Bool is abstract
1105 # Return the nullable version of the type
1106 # If the type is already nullable then self is returned
1107 fun as_nullable
: MType
1109 var res
= self.as_nullable_cache
1110 if res
!= null then return res
1111 res
= new MNullableType(self)
1112 self.as_nullable_cache
= res
1116 # Remove the base type of a decorated (proxy) type.
1117 # Is the type is not decorated, then self is returned.
1119 # Most of the time it is used to return the not nullable version of a nullable type.
1120 # In this case, this just remove the `nullable` notation, but the result can still contains null.
1121 # For instance if `self isa MNullType` or self is a formal type bounded by a nullable type.
1122 # If you really want to exclude the `null` value, then use `as_notnull`
1123 fun undecorate
: MType
1128 # Returns the not null version of the type.
1129 # That is `self` minus the `null` value.
1131 # For most types, this return `self`.
1132 # For formal types, this returns a special `MNotNullType`
1133 fun as_notnull
: MType do return self
1135 private var as_nullable_cache
: nullable MType = null
1138 # The depth of the type seen as a tree.
1145 # Formal types have a depth of 1.
1151 # The length of the type seen as a tree.
1158 # Formal types have a length of 1.
1164 # Compute all the classdefs inherited/imported.
1165 # The returned set contains:
1166 # * the class definitions from `mmodule` and its imported modules
1167 # * the class definitions of this type and its super-types
1169 # This function is used mainly internally.
1171 # REQUIRE: `not self.need_anchor`
1172 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
1174 # Compute all the super-classes.
1175 # This function is used mainly internally.
1177 # REQUIRE: `not self.need_anchor`
1178 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
1180 # Compute all the declared super-types.
1181 # Super-types are returned as declared in the classdefs (verbatim).
1182 # This function is used mainly internally.
1184 # REQUIRE: `not self.need_anchor`
1185 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
1187 # Is the property in self for a given module
1188 # This method does not filter visibility or whatever
1190 # REQUIRE: `not self.need_anchor`
1191 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
1193 assert not self.need_anchor
1194 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
1198 # A type based on a class.
1200 # `MClassType` have properties (see `has_mproperty`).
1204 # The associated class
1207 redef fun model
do return self.mclass
.intro_mmodule
.model
1209 redef fun location
do return mclass
.location
1211 # TODO: private init because strongly bounded to its mclass. see `mclass.mclass_type`
1213 # The formal arguments of the type
1214 # ENSURE: `result.length == self.mclass.arity`
1215 var arguments
= new Array[MType]
1217 redef fun to_s
do return mclass
.to_s
1219 redef fun full_name
do return mclass
.full_name
1221 redef fun c_name
do return mclass
.c_name
1223 redef fun need_anchor
do return false
1225 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
1227 return super.as(MClassType)
1230 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
1232 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1234 redef fun collect_mclassdefs
(mmodule
)
1236 assert not self.need_anchor
1237 var cache
= self.collect_mclassdefs_cache
1238 if not cache
.has_key
(mmodule
) then
1239 self.collect_things
(mmodule
)
1241 return cache
[mmodule
]
1244 redef fun collect_mclasses
(mmodule
)
1246 if collect_mclasses_last_module
== mmodule
then return collect_mclasses_last_module_cache
1247 assert not self.need_anchor
1248 var cache
= self.collect_mclasses_cache
1249 if not cache
.has_key
(mmodule
) then
1250 self.collect_things
(mmodule
)
1252 var res
= cache
[mmodule
]
1253 collect_mclasses_last_module
= mmodule
1254 collect_mclasses_last_module_cache
= res
1258 private var collect_mclasses_last_module
: nullable MModule = null
1259 private var collect_mclasses_last_module_cache
: Set[MClass] is noinit
1261 redef fun collect_mtypes
(mmodule
)
1263 assert not self.need_anchor
1264 var cache
= self.collect_mtypes_cache
1265 if not cache
.has_key
(mmodule
) then
1266 self.collect_things
(mmodule
)
1268 return cache
[mmodule
]
1271 # common implementation for `collect_mclassdefs`, `collect_mclasses`, and `collect_mtypes`.
1272 private fun collect_things
(mmodule
: MModule)
1274 var res
= new HashSet[MClassDef]
1275 var seen
= new HashSet[MClass]
1276 var types
= new HashSet[MClassType]
1277 seen
.add
(self.mclass
)
1278 var todo
= [self.mclass
]
1279 while not todo
.is_empty
do
1280 var mclass
= todo
.pop
1281 #print "process {mclass}"
1282 for mclassdef
in mclass
.mclassdefs
do
1283 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
1284 #print " process {mclassdef}"
1286 for supertype
in mclassdef
.supertypes
do
1287 types
.add
(supertype
)
1288 var superclass
= supertype
.mclass
1289 if seen
.has
(superclass
) then continue
1290 #print " add {superclass}"
1291 seen
.add
(superclass
)
1292 todo
.add
(superclass
)
1296 collect_mclassdefs_cache
[mmodule
] = res
1297 collect_mclasses_cache
[mmodule
] = seen
1298 collect_mtypes_cache
[mmodule
] = types
1301 private var collect_mclassdefs_cache
= new HashMap[MModule, Set[MClassDef]]
1302 private var collect_mclasses_cache
= new HashMap[MModule, Set[MClass]]
1303 private var collect_mtypes_cache
= new HashMap[MModule, Set[MClassType]]
1305 redef fun mdoc_or_fallback
do return mclass
.mdoc_or_fallback
1308 # A type based on a generic class.
1309 # A generic type a just a class with additional formal generic arguments.
1315 # TODO: private init because strongly bounded to its mclass. see `mclass.get_mtype`
1319 assert self.mclass
.arity
== arguments
.length
1321 self.need_anchor
= false
1322 for t
in arguments
do
1323 if t
.need_anchor
then
1324 self.need_anchor
= true
1329 self.to_s
= "{mclass}[{arguments.join(", ")}]"
1332 # The short-name of the class, then the full-name of each type arguments within brackets.
1333 # Example: `"Map[String, List[Int]]"`
1334 redef var to_s
is noinit
1336 # The full-name of the class, then the full-name of each type arguments within brackets.
1337 # Example: `"core::Map[core::String, core::List[core::Int]]"`
1338 redef var full_name
is lazy
do
1339 var args
= new Array[String]
1340 for t
in arguments
do
1341 args
.add t
.full_name
1343 return "{mclass.full_name}[{args.join(", ")}]"
1346 redef var c_name
is lazy
do
1347 var res
= mclass
.c_name
1348 # Note: because the arity is known, a prefix notation is enough
1349 for t
in arguments
do
1356 redef var need_anchor
is noinit
1358 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1360 if not need_anchor
then return self
1361 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1362 var types
= new Array[MType]
1363 for t
in arguments
do
1364 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1366 return mclass
.get_mtype
(types
)
1369 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1371 if not need_anchor
then return true
1372 for t
in arguments
do
1373 if not t
.can_resolve_for
(mtype
, anchor
, mmodule
) then return false
1380 for t
in arguments
do if not t
.is_ok
then return false
1384 redef fun is_legal_in
(mmodule
, anchor
)
1388 assert anchor
!= null
1389 mtype
= anchor_to
(mmodule
, anchor
)
1393 if not mtype
.is_ok
then return false
1394 return mtype
.is_subtype
(mmodule
, null, mtype
.mclass
.intro
.bound_mtype
)
1400 for a
in self.arguments
do
1402 if d
> dmax
then dmax
= d
1410 for a
in self.arguments
do
1417 # A formal type (either virtual of parametric).
1419 # The main issue with formal types is that they offer very little information on their own
1420 # and need a context (anchor and mmodule) to be useful.
1421 abstract class MFormalType
1424 redef var as_notnull
= new MNotNullType(self) is lazy
1427 # A virtual formal type.
1431 # The property associated with the type.
1432 # Its the definitions of this property that determine the bound or the virtual type.
1433 var mproperty
: MVirtualTypeProp
1435 redef fun location
do return mproperty
.location
1437 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1439 redef fun lookup_bound
(mmodule
, resolved_receiver
)
1441 # There is two possible invalid cases: the vt does not exists in resolved_receiver or the bound is broken
1442 if not resolved_receiver
.has_mproperty
(mmodule
, mproperty
) then return new MErrorType(model
)
1443 return lookup_single_definition
(mmodule
, resolved_receiver
).bound
or else new MErrorType(model
)
1446 private fun lookup_single_definition
(mmodule
: MModule, resolved_receiver
: MType): MVirtualTypeDef
1448 assert not resolved_receiver
.need_anchor
1449 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1450 if props
.is_empty
then
1452 else if props
.length
== 1 then
1455 var types
= new ArraySet[MType]
1456 var res
= props
.first
1458 types
.add
(p
.bound
.as(not null))
1459 if not res
.is_fixed
then res
= p
1461 if types
.length
== 1 then
1467 # A VT is fixed when:
1468 # * the VT is (re-)defined with the annotation `is fixed`
1469 # * the VT is (indirectly) bound to an enum class (see `enum_kind`) since there is no subtype possible
1470 # * the receiver is an enum class since there is no subtype possible
1471 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1473 assert not resolved_receiver
.need_anchor
1474 resolved_receiver
= resolved_receiver
.undecorate
1475 assert resolved_receiver
isa MClassType # It is the only remaining type
1477 var prop
= lookup_single_definition
(mmodule
, resolved_receiver
)
1478 var res
= prop
.bound
1479 if res
== null then return new MErrorType(model
)
1481 # Recursively lookup the fixed result
1482 res
= res
.lookup_fixed
(mmodule
, resolved_receiver
)
1484 # 1. For a fixed VT, return the resolved bound
1485 if prop
.is_fixed
then return res
1487 # 2. For a enum boud, return the bound
1488 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1490 # 3. for a enum receiver return the bound
1491 if resolved_receiver
.mclass
.kind
== enum_kind
then return res
1496 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1498 if not cleanup_virtual
then return self
1499 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1501 if mproperty
.is_selftype
then return mtype
1503 # self is a virtual type declared (or inherited) in mtype
1504 # The point of the function it to get the bound of the virtual type that make sense for mtype
1505 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1506 #print "{class_name}: {self}/{mtype}/{anchor}?"
1507 var resolved_receiver
1508 if mtype
.need_anchor
then
1509 assert anchor
!= null
1510 resolved_receiver
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1512 resolved_receiver
= mtype
1514 # Now, we can get the bound
1515 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1516 # The bound is exactly as declared in the "type" property, so we must resolve it again
1517 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1522 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1524 if mtype
.need_anchor
then
1525 assert anchor
!= null
1526 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1528 return mtype
.has_mproperty
(mmodule
, mproperty
)
1531 redef fun to_s
do return self.mproperty
.to_s
1533 redef fun full_name
do return self.mproperty
.full_name
1535 redef fun c_name
do return self.mproperty
.c_name
1537 redef fun mdoc_or_fallback
do return mproperty
.mdoc_or_fallback
1540 # The type associated to a formal parameter generic type of a class
1542 # Each parameter type is associated to a specific class.
1543 # It means that all refinements of a same class "share" the parameter type,
1544 # but that a generic subclass has its own parameter types.
1546 # However, in the sense of the meta-model, a parameter type of a class is
1547 # a valid type in a subclass. The "in the sense of the meta-model" is
1548 # important because, in the Nit language, the programmer cannot refers
1549 # directly to the parameter types of the super-classes.
1554 # fun e: E is abstract
1560 # In the class definition B[F], `F` is a valid type but `E` is not.
1561 # However, `self.e` is a valid method call, and the signature of `e` is
1564 # Note that parameter types are shared among class refinements.
1565 # Therefore parameter only have an internal name (see `to_s` for details).
1566 class MParameterType
1569 # The generic class where the parameter belong
1572 redef fun model
do return self.mclass
.intro_mmodule
.model
1574 redef fun location
do return mclass
.location
1576 # The position of the parameter (0 for the first parameter)
1577 # FIXME: is `position` a better name?
1582 redef fun to_s
do return name
1584 redef var full_name
is lazy
do return "{mclass.full_name}::{name}"
1586 redef var c_name
is lazy
do return mclass
.c_name
+ "__" + "#{name}".to_cmangle
1588 redef fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1590 assert not resolved_receiver
.need_anchor
1591 resolved_receiver
= resolved_receiver
.undecorate
1592 assert resolved_receiver
isa MClassType # It is the only remaining type
1593 var goalclass
= self.mclass
1594 if resolved_receiver
.mclass
== goalclass
then
1595 return resolved_receiver
.arguments
[self.rank
]
1597 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1598 for t
in supertypes
do
1599 if t
.mclass
== goalclass
then
1600 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1601 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1602 var res
= t
.arguments
[self.rank
]
1606 # Cannot found `self` in `resolved_receiver`
1607 return new MErrorType(model
)
1610 # A PT is fixed when:
1611 # * Its bound is a enum class (see `enum_kind`).
1612 # The PT is just useless, but it is still a case.
1613 # * More usually, the `resolved_receiver` is a subclass of `self.mclass`,
1614 # so it is necessarily fixed in a `super` clause, either with a normal type
1615 # or with another PT.
1616 # See `resolve_for` for examples about related issues.
1617 redef fun lookup_fixed
(mmodule
: MModule, resolved_receiver
: MType): MType
1619 assert not resolved_receiver
.need_anchor
1620 resolved_receiver
= resolved_receiver
.undecorate
1621 assert resolved_receiver
isa MClassType # It is the only remaining type
1622 var res
= self.resolve_for
(resolved_receiver
.mclass
.mclass_type
, resolved_receiver
, mmodule
, false)
1626 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1628 assert can_resolve_for
(mtype
, anchor
, mmodule
)
1629 #print "{class_name}: {self}/{mtype}/{anchor}?"
1631 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1632 var res
= mtype
.arguments
[self.rank
]
1633 if anchor
!= null and res
.need_anchor
then
1634 # Maybe the result can be resolved more if are bound to a final class
1635 var r2
= res
.anchor_to
(mmodule
, anchor
)
1636 if r2
isa MClassType and r2
.mclass
.kind
== enum_kind
then return r2
1641 # self is a parameter type of mtype (or of a super-class of mtype)
1642 # The point of the function it to get the bound of the virtual type that make sense for mtype
1643 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1644 # FIXME: What happens here is far from clear. Thus this part must be validated and clarified
1645 var resolved_receiver
1646 if mtype
.need_anchor
then
1647 assert anchor
!= null
1648 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1650 resolved_receiver
= mtype
1652 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1653 if resolved_receiver
isa MParameterType then
1654 assert anchor
!= null
1655 assert resolved_receiver
.mclass
== anchor
.mclass
1656 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1657 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1659 assert resolved_receiver
isa MClassType # It is the only remaining type
1661 # Eh! The parameter is in the current class.
1662 # So we return the corresponding argument, no mater what!
1663 if resolved_receiver
.mclass
== self.mclass
then
1664 var res
= resolved_receiver
.arguments
[self.rank
]
1665 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1669 if resolved_receiver
.need_anchor
then
1670 assert anchor
!= null
1671 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1673 # Now, we can get the bound
1674 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1675 # The bound is exactly as declared in the "type" property, so we must resolve it again
1676 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1678 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1683 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1685 if mtype
.need_anchor
then
1686 assert anchor
!= null
1687 mtype
= mtype
.anchor_to
(mmodule
, anchor
)
1689 return mtype
.collect_mclassdefs
(mmodule
).has
(mclass
.intro
)
1693 # A type that decorates another type.
1695 # The point of this class is to provide a common implementation of sevices that just forward to the original type.
1696 # Specific decorator are expected to redefine (or to extend) the default implementation as this suit them.
1697 abstract class MProxyType
1702 redef fun location
do return mtype
.location
1704 redef fun model
do return self.mtype
.model
1705 redef fun need_anchor
do return mtype
.need_anchor
1706 redef fun as_nullable
do return mtype
.as_nullable
1707 redef fun as_notnull
do return mtype
.as_notnull
1708 redef fun undecorate
do return mtype
.undecorate
1709 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1711 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1715 redef fun can_resolve_for
(mtype
, anchor
, mmodule
)
1717 return self.mtype
.can_resolve_for
(mtype
, anchor
, mmodule
)
1720 redef fun is_ok
do return mtype
.is_ok
1722 redef fun is_legal_in
(mmodule
, anchor
) do return mtype
.is_legal_in
(mmodule
, anchor
)
1724 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1726 var t
= mtype
.lookup_fixed
(mmodule
, resolved_receiver
)
1730 redef fun depth
do return self.mtype
.depth
1732 redef fun length
do return self.mtype
.length
1734 redef fun collect_mclassdefs
(mmodule
)
1736 assert not self.need_anchor
1737 return self.mtype
.collect_mclassdefs
(mmodule
)
1740 redef fun collect_mclasses
(mmodule
)
1742 assert not self.need_anchor
1743 return self.mtype
.collect_mclasses
(mmodule
)
1746 redef fun collect_mtypes
(mmodule
)
1748 assert not self.need_anchor
1749 return self.mtype
.collect_mtypes
(mmodule
)
1753 # A type prefixed with "nullable"
1759 self.to_s
= "nullable {mtype}"
1762 redef var to_s
is noinit
1764 redef var full_name
is lazy
do return "nullable {mtype.full_name}"
1766 redef var c_name
is lazy
do return "nullable__{mtype.c_name}"
1768 redef fun as_nullable
do return self
1769 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1772 return res
.as_nullable
1775 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_nullable`
1776 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1779 if t
== mtype
then return self
1780 return t
.as_nullable
1784 # A non-null version of a formal type.
1786 # When a formal type in bounded to a nullable type, this is the type of the not null version of it.
1790 redef fun to_s
do return "not null {mtype}"
1791 redef var full_name
is lazy
do return "not null {mtype.full_name}"
1792 redef var c_name
is lazy
do return "notnull__{mtype.c_name}"
1794 redef fun as_notnull
do return self
1796 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1799 return res
.as_notnull
1802 # Efficiently returns `mtype.lookup_fixed(mmodule, resolved_receiver).as_notnull`
1803 redef fun lookup_fixed
(mmodule
, resolved_receiver
)
1806 if t
== mtype
then return self
1811 # The type of the only value null
1813 # The is only one null type per model, see `MModel::null_type`.
1817 redef fun to_s
do return "null"
1818 redef fun full_name
do return "null"
1819 redef fun c_name
do return "null"
1820 redef fun as_nullable
do return self
1822 redef var as_notnull
= new MBottomType(model
) is lazy
1823 redef fun need_anchor
do return false
1824 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1825 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1827 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1829 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1831 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1834 # The special universal most specific type.
1836 # This type is intended to be only used internally for type computation or analysis and should not be exposed to the user.
1837 # The bottom type can de used to denote things that are dead (no instance).
1839 # Semantically it is the singleton `null.as_notnull`.
1840 # Is also means that `self.as_nullable == null`.
1844 redef fun to_s
do return "bottom"
1845 redef fun full_name
do return "bottom"
1846 redef fun c_name
do return "bottom"
1847 redef fun as_nullable
do return model
.null_type
1848 redef fun as_notnull
do return self
1849 redef fun need_anchor
do return false
1850 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1851 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1853 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1855 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1857 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1860 # A special type used as a silent error marker when building types.
1862 # This type is intended to be only used internally for type operation and should not be exposed to the user.
1863 # The error type can de used to denote things that are conflicting or inconsistent.
1865 # Some methods on types can return a `MErrorType` to denote a broken or a conflicting result.
1866 # Use `is_ok` to check if a type is (or contains) a `MErrorType` .
1870 redef fun to_s
do return "error"
1871 redef fun full_name
do return "error"
1872 redef fun c_name
do return "error"
1873 redef fun need_anchor
do return false
1874 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1875 redef fun can_resolve_for
(mtype
, anchor
, mmodule
) do return true
1876 redef fun is_ok
do return false
1878 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1880 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1882 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1885 # A signature of a method
1889 # The each parameter (in order)
1890 var mparameters
: Array[MParameter]
1892 # Returns a parameter named `name`, if any.
1893 fun mparameter_by_name
(name
: String): nullable MParameter
1895 for p
in mparameters
do
1896 if p
.name
== name
then return p
1901 # The return type (null for a procedure)
1902 var return_mtype
: nullable MType
1907 var t
= self.return_mtype
1908 if t
!= null then dmax
= t
.depth
1909 for p
in mparameters
do
1910 var d
= p
.mtype
.depth
1911 if d
> dmax
then dmax
= d
1919 var t
= self.return_mtype
1920 if t
!= null then res
+= t
.length
1921 for p
in mparameters
do
1922 res
+= p
.mtype
.length
1927 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1930 var vararg_rank
= -1
1931 for i
in [0..mparameters
.length
[ do
1932 var parameter
= mparameters
[i
]
1933 if parameter
.is_vararg
then
1934 if vararg_rank
>= 0 then
1935 # If there is more than one vararg,
1936 # consider that additional arguments cannot be mapped.
1943 self.vararg_rank
= vararg_rank
1946 # The rank of the main ellipsis (`...`) for vararg (starting from 0).
1947 # value is -1 if there is no vararg.
1948 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1950 # From a model POV, a signature can contain more than one vararg parameter,
1951 # the `vararg_rank` just indicates the one that will receive the additional arguments.
1952 # However, currently, if there is more that one vararg parameter, no one will be the main one,
1953 # and additional arguments will be refused.
1954 var vararg_rank
: Int is noinit
1956 # The number of parameters
1957 fun arity
: Int do return mparameters
.length
1961 var b
= new FlatBuffer
1962 if not mparameters
.is_empty
then
1964 for i
in [0..mparameters
.length
[ do
1965 var mparameter
= mparameters
[i
]
1966 if i
> 0 then b
.append
(", ")
1967 b
.append
(mparameter
.name
)
1969 b
.append
(mparameter
.mtype
.to_s
)
1970 if mparameter
.is_vararg
then
1976 var ret
= self.return_mtype
1984 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1986 var params
= new Array[MParameter]
1987 for p
in self.mparameters
do
1988 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1990 var ret
= self.return_mtype
1992 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1994 var res
= new MSignature(params
, ret
)
1999 # A parameter in a signature
2003 # The name of the parameter
2006 # The static type of the parameter
2009 # Is the parameter a vararg?
2015 return "{name}: {mtype}..."
2017 return "{name}: {mtype}"
2021 # Returns a new parameter with the `mtype` resolved.
2022 # See `MType::resolve_for` for details.
2023 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
2025 if not self.mtype
.need_anchor
then return self
2026 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
2027 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
2031 redef fun model
do return mtype
.model
2034 # A service (global property) that generalize method, attribute, etc.
2036 # `MProperty` are global to the model; it means that a `MProperty` is not bound
2037 # to a specific `MModule` nor a specific `MClass`.
2039 # A MProperty gather definitions (see `mpropdefs`) ; one for the introduction
2040 # and the other in subclasses and in refinements.
2042 # A `MProperty` is used to denotes services in polymorphic way (ie. independent
2043 # of any dynamic type).
2044 # For instance, a call site "x.foo" is associated to a `MProperty`.
2045 abstract class MProperty
2048 # The associated MPropDef subclass.
2049 # The two specialization hierarchy are symmetric.
2050 type MPROPDEF: MPropDef
2052 # The classdef that introduce the property
2053 # While a property is not bound to a specific module, or class,
2054 # the introducing mclassdef is used for naming and visibility
2055 var intro_mclassdef
: MClassDef
2057 # The (short) name of the property
2062 redef fun mdoc_or_fallback
2064 # Don’t use `intro.mdoc_or_fallback` because it would create an infinite
2069 # The canonical name of the property.
2071 # It is currently the short-`name` prefixed by the short-name of the class and the full-name of the module.
2072 # Example: "my_package::my_module::MyClass::my_method"
2074 # The full-name of the module is needed because two distinct modules of the same package can
2075 # still refine the same class and introduce homonym properties.
2077 # For public properties not introduced by refinement, the module name is not used.
2079 # Example: `my_package::MyClass::My_method`
2080 redef var full_name
is lazy
do
2081 if intro_mclassdef
.is_intro
then
2082 return "{intro_mclassdef.mmodule.namespace_for(visibility)}::{intro_mclassdef.mclass.name}::{name}"
2084 return "{intro_mclassdef.mmodule.full_name}::{intro_mclassdef.mclass.name}::{name}"
2088 redef var c_name
is lazy
do
2089 # FIXME use `namespace_for`
2090 return "{intro_mclassdef.mmodule.c_name}__{intro_mclassdef.mclass.name.to_cmangle}__{name.to_cmangle}"
2093 # The visibility of the property
2094 redef var visibility
2096 # Is the property usable as an initializer?
2097 var is_autoinit
= false is writable
2101 intro_mclassdef
.intro_mproperties
.add
(self)
2102 var model
= intro_mclassdef
.mmodule
.model
2103 model
.mproperties_by_name
.add_one
(name
, self)
2104 model
.mproperties
.add
(self)
2107 # All definitions of the property.
2108 # The first is the introduction,
2109 # The other are redefinitions (in refinements and in subclasses)
2110 var mpropdefs
= new Array[MPROPDEF]
2112 # The definition that introduces the property.
2114 # Warning: such a definition may not exist in the early life of the object.
2115 # In this case, the method will abort.
2116 var intro
: MPROPDEF is noinit
2118 redef fun model
do return intro
.model
2121 redef fun to_s
do return name
2123 # Return the most specific property definitions defined or inherited by a type.
2124 # The selection knows that refinement is stronger than specialization;
2125 # however, in case of conflict more than one property are returned.
2126 # If mtype does not know mproperty then an empty array is returned.
2128 # If you want the really most specific property, then look at `lookup_first_definition`
2130 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2131 # ENSURE: `not mtype.has_mproperty(mmodule, self) == result.is_empty`
2132 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2134 assert not mtype
.need_anchor
2135 mtype
= mtype
.undecorate
2137 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
2138 if cache
!= null then return cache
2140 #print "select prop {mproperty} for {mtype} in {self}"
2141 # First, select all candidates
2142 var candidates
= new Array[MPROPDEF]
2144 # Here we have two strategies: iterate propdefs or iterate classdefs.
2145 var mpropdefs
= self.mpropdefs
2146 if mpropdefs
.length
<= 1 or mpropdefs
.length
< mtype
.collect_mclassdefs
(mmodule
).length
then
2147 # Iterate on all definitions of `self`, keep only those inherited by `mtype` in `mmodule`
2148 for mpropdef
in mpropdefs
do
2149 # If the definition is not imported by the module, then skip
2150 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2151 # If the definition is not inherited by the type, then skip
2152 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2154 candidates
.add
(mpropdef
)
2157 # Iterate on all super-classdefs of `mtype`, keep only the definitions of `self`, if any.
2158 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
2159 var p
= mclassdef
.mpropdefs_by_property
.get_or_null
(self)
2160 if p
!= null then candidates
.add p
2164 # Fast track for only one candidate
2165 if candidates
.length
<= 1 then
2166 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
2170 # Second, filter the most specific ones
2171 return select_most_specific
(mmodule
, candidates
)
2174 private var lookup_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2176 # Return the most specific property definitions inherited by a type.
2177 # The selection knows that refinement is stronger than specialization;
2178 # however, in case of conflict more than one property are returned.
2179 # If mtype does not know mproperty then an empty array is returned.
2181 # If you want the really most specific property, then look at `lookup_next_definition`
2183 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2184 # ENSURE: `not mtype.has_mproperty(mmodule, self) implies result.is_empty`
2185 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2187 assert not mtype
.need_anchor
2188 mtype
= mtype
.undecorate
2190 # First, select all candidates
2191 var candidates
= new Array[MPROPDEF]
2192 for mpropdef
in self.mpropdefs
do
2193 # If the definition is not imported by the module, then skip
2194 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2195 # If the definition is not inherited by the type, then skip
2196 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2197 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
2198 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
2200 candidates
.add
(mpropdef
)
2202 # Fast track for only one candidate
2203 if candidates
.length
<= 1 then return candidates
2205 # Second, filter the most specific ones
2206 return select_most_specific
(mmodule
, candidates
)
2209 # Return an array containing olny the most specific property definitions
2210 # This is an helper function for `lookup_definitions` and `lookup_super_definitions`
2211 private fun select_most_specific
(mmodule
: MModule, candidates
: Array[MPROPDEF]): Array[MPROPDEF]
2213 var res
= new Array[MPROPDEF]
2214 for pd1
in candidates
do
2215 var cd1
= pd1
.mclassdef
2218 for pd2
in candidates
do
2219 if pd2
== pd1
then continue # do not compare with self!
2220 var cd2
= pd2
.mclassdef
2222 if c2
.mclass_type
== c1
.mclass_type
then
2223 if cd2
.mmodule
.in_importation
< cd1
.mmodule
then
2224 # cd2 refines cd1; therefore we skip pd1
2228 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) and cd2
.bound_mtype
!= cd1
.bound_mtype
then
2229 # cd2 < cd1; therefore we skip pd1
2238 if res
.is_empty
then
2239 print_error
"All lost! {candidates.join(", ")}"
2240 # FIXME: should be abort!
2245 # Return the most specific definition in the linearization of `mtype`.
2247 # If you want to know the next properties in the linearization,
2248 # look at `MPropDef::lookup_next_definition`.
2250 # FIXME: the linearization is still unspecified
2252 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2253 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2254 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2256 return lookup_all_definitions
(mmodule
, mtype
).first
2259 # Return all definitions in a linearization order
2260 # Most specific first, most general last
2262 # REQUIRE: `not mtype.need_anchor` to simplify the API (no `anchor` parameter)
2263 # REQUIRE: `mtype.has_mproperty(mmodule, self)`
2264 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
2266 mtype
= mtype
.undecorate
2268 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
2269 if cache
!= null then return cache
2271 assert not mtype
.need_anchor
2272 assert mtype
.has_mproperty
(mmodule
, self)
2274 #print "select prop {mproperty} for {mtype} in {self}"
2275 # First, select all candidates
2276 var candidates
= new Array[MPROPDEF]
2277 for mpropdef
in self.mpropdefs
do
2278 # If the definition is not imported by the module, then skip
2279 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
2280 # If the definition is not inherited by the type, then skip
2281 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
2283 candidates
.add
(mpropdef
)
2285 # Fast track for only one candidate
2286 if candidates
.length
<= 1 then
2287 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2291 mmodule
.linearize_mpropdefs
(candidates
)
2292 candidates
= candidates
.reversed
2293 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
2297 private var lookup_all_definitions_cache
= new HashMap2[MModule, MType, Array[MPROPDEF]]
2304 redef type MPROPDEF: MMethodDef
2306 # Is the property defined at the top_level of the module?
2307 # Currently such a property are stored in `Object`
2308 var is_toplevel
: Bool = false is writable
2310 # Is the property a constructor?
2311 # Warning, this property can be inherited by subclasses with or without being a constructor
2312 # therefore, you should use `is_init_for` the verify if the property is a legal constructor for a given class
2313 var is_init
: Bool = false is writable
2315 # The constructor is a (the) root init with empty signature but a set of initializers
2316 var is_root_init
: Bool = false is writable
2318 # Is the property a 'new' constructor?
2319 var is_new
: Bool = false is writable
2321 # Is the property a legal constructor for a given class?
2322 # As usual, visibility is not considered.
2323 # FIXME not implemented
2324 fun is_init_for
(mclass
: MClass): Bool
2329 # A specific method that is safe to call on null.
2330 # Currently, only `==`, `!=` and `is_same_instance` are safe
2331 fun is_null_safe
: Bool do return name
== "==" or name
== "!=" or name
== "is_same_instance"
2334 # A global attribute
2338 redef type MPROPDEF: MAttributeDef
2342 # A global virtual type
2343 class MVirtualTypeProp
2346 redef type MPROPDEF: MVirtualTypeDef
2348 # The formal type associated to the virtual type property
2349 var mvirtualtype
= new MVirtualType(self)
2351 # Is `self` the special virtual type `SELF`?
2352 var is_selftype
: Bool is lazy
do return name
== "SELF"
2355 # A definition of a property (local property)
2357 # Unlike `MProperty`, a `MPropDef` is a local definition that belong to a
2358 # specific class definition (which belong to a specific module)
2359 abstract class MPropDef
2362 # The associated `MProperty` subclass.
2363 # the two specialization hierarchy are symmetric
2364 type MPROPERTY: MProperty
2367 type MPROPDEF: MPropDef
2369 # The class definition where the property definition is
2370 var mclassdef
: MClassDef
2372 # The associated global property
2373 var mproperty
: MPROPERTY
2375 redef var location
: Location
2377 redef fun visibility
do return mproperty
.visibility
2381 mclassdef
.mpropdefs
.add
(self)
2382 mproperty
.mpropdefs
.add
(self)
2383 mclassdef
.mpropdefs_by_property
[mproperty
] = self
2384 if mproperty
.intro_mclassdef
== mclassdef
then
2385 assert not isset mproperty
._intro
2386 mproperty
.intro
= self
2388 self.to_s
= "{mclassdef}${mproperty}"
2391 # Actually the name of the `mproperty`
2392 redef fun name
do return mproperty
.name
2394 # The full-name of mpropdefs combine the information about the `classdef` and the `mproperty`.
2396 # Therefore the combination of identifiers is awful,
2397 # the worst case being
2399 # * a property "p::m::A::x"
2400 # * redefined in a refinement of a class "q::n::B"
2401 # * in a module "r::o"
2402 # * so "r::o$q::n::B$p::m::A::x"
2404 # Fortunately, the full-name is simplified when entities are repeated.
2405 # For the previous case, the simplest form is "p$A$x".
2406 redef var full_name
is lazy
do
2407 var res
= new FlatBuffer
2409 # The first part is the mclassdef. Worst case is "r::o$q::n::B"
2410 res
.append mclassdef
.full_name
2414 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2415 # intro are unambiguous in a class
2418 # Just try to simplify each part
2419 if mclassdef
.mmodule
.mpackage
!= mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2420 # precise "p::m" only if "p" != "r"
2421 res
.append mproperty
.intro_mclassdef
.mmodule
.namespace_for
(mproperty
.visibility
)
2423 else if mproperty
.visibility
<= private_visibility
then
2424 # Same package ("p"=="q"), but private visibility,
2425 # does the module part ("::m") need to be displayed
2426 if mclassdef
.mmodule
.namespace_for
(mclassdef
.mclass
.visibility
) != mproperty
.intro_mclassdef
.mmodule
.mpackage
then
2428 res
.append mproperty
.intro_mclassdef
.mmodule
.name
2432 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2433 # precise "B" only if not the same class than "A"
2434 res
.append mproperty
.intro_mclassdef
.name
2437 # Always use the property name "x"
2438 res
.append mproperty
.name
2443 redef var c_name
is lazy
do
2444 var res
= new FlatBuffer
2445 res
.append mclassdef
.c_name
2447 if mclassdef
.mclass
== mproperty
.intro_mclassdef
.mclass
then
2448 res
.append name
.to_cmangle
2450 if mclassdef
.mmodule
!= mproperty
.intro_mclassdef
.mmodule
then
2451 res
.append mproperty
.intro_mclassdef
.mmodule
.c_name
2454 if mclassdef
.mclass
!= mproperty
.intro_mclassdef
.mclass
then
2455 res
.append mproperty
.intro_mclassdef
.name
.to_cmangle
2458 res
.append mproperty
.name
.to_cmangle
2463 redef fun model
do return mclassdef
.model
2465 # Internal name combining the module, the class and the property
2466 # Example: "mymodule$MyClass$mymethod"
2467 redef var to_s
is noinit
2469 # Is self the definition that introduce the property?
2470 fun is_intro
: Bool do return isset mproperty
._intro
and mproperty
.intro
== self
2472 # Return the next definition in linearization of `mtype`.
2474 # This method is used to determine what method is called by a super.
2476 # REQUIRE: `not mtype.need_anchor`
2477 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
2479 assert not mtype
.need_anchor
2481 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
2482 var i
= mpropdefs
.iterator
2483 while i
.is_ok
and i
.item
!= self do i
.next
2484 assert has_property
: i
.is_ok
2486 assert has_next_property
: i
.is_ok
2490 redef fun mdoc_or_fallback
do return mdoc
or else mproperty
.mdoc_or_fallback
2493 # A local definition of a method
2497 redef type MPROPERTY: MMethod
2498 redef type MPROPDEF: MMethodDef
2500 # The signature attached to the property definition
2501 var msignature
: nullable MSignature = null is writable
2503 # The signature attached to the `new` call on a root-init
2504 # This is a concatenation of the signatures of the initializers
2506 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2507 var new_msignature
: nullable MSignature = null is writable
2509 # List of initialisers to call in root-inits
2511 # They could be setters or attributes
2513 # REQUIRE `mproperty.is_root_init == (new_msignature != null)`
2514 var initializers
= new Array[MProperty]
2516 # Is the method definition abstract?
2517 var is_abstract
: Bool = false is writable
2519 # Is the method definition intern?
2520 var is_intern
= false is writable
2522 # Is the method definition extern?
2523 var is_extern
= false is writable
2525 # An optional constant value returned in functions.
2527 # Only some specific primitife value are accepted by engines.
2528 # Is used when there is no better implementation available.
2530 # Currently used only for the implementation of the `--define`
2531 # command-line option.
2532 # SEE: module `mixin`.
2533 var constant_value
: nullable Object = null is writable
2536 # A local definition of an attribute
2540 redef type MPROPERTY: MAttribute
2541 redef type MPROPDEF: MAttributeDef
2543 # The static type of the attribute
2544 var static_mtype
: nullable MType = null is writable
2547 # A local definition of a virtual type
2548 class MVirtualTypeDef
2551 redef type MPROPERTY: MVirtualTypeProp
2552 redef type MPROPDEF: MVirtualTypeDef
2554 # The bound of the virtual type
2555 var bound
: nullable MType = null is writable
2557 # Is the bound fixed?
2558 var is_fixed
= false is writable
2565 # * `interface_kind`
2569 # Note this class is basically an enum.
2570 # FIXME: use a real enum once user-defined enums are available
2574 # Is a constructor required?
2577 # TODO: private init because enumeration.
2579 # Can a class of kind `self` specializes a class of kine `other`?
2580 fun can_specialize
(other
: MClassKind): Bool
2582 if other
== interface_kind
then return true # everybody can specialize interfaces
2583 if self == interface_kind
or self == enum_kind
then
2584 # no other case for interfaces
2586 else if self == extern_kind
then
2587 # only compatible with themselves
2588 return self == other
2589 else if other
== enum_kind
or other
== extern_kind
then
2590 # abstract_kind and concrete_kind are incompatible
2593 # remain only abstract_kind and concrete_kind
2598 # The class kind `abstract`
2599 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
2600 # The class kind `concrete`
2601 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
2602 # The class kind `interface`
2603 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
2604 # The class kind `enum`
2605 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
2606 # The class kind `extern`
2607 fun extern_kind
: MClassKind do return once
new MClassKind("extern class", false)