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 # Object model of the Nit language
19 # This module define the entities of the Nit meta-model like modules,
20 # classes, types and properties
22 # It also provide an API to build and query models.
24 # All model classes starts with the M letter (MModule, MClass, etc.)
28 # TODO: liearization, closures, extern stuff
29 # FIXME: better handling of the types
35 private import more_collections
39 var mclasses
: Array[MClass] = new Array[MClass]
41 # All known properties
42 var mproperties
: Array[MProperty] = new Array[MProperty]
44 # Hierarchy of class definition.
46 # Each classdef is associated with its super-classdefs in regard to
47 # its module of definition.
48 var mclassdef_hierarchy
: POSet[MClassDef] = new POSet[MClassDef]
50 # Class-type hierarchy restricted to the introduction.
52 # The idea is that what is true on introduction is always true whatever
53 # the module considered.
54 # Therefore, this hierarchy is used for a fast positive subtype check.
56 # This poset will evolve in a monotonous way:
57 # * Two non connected nodes will remain unconnected
58 # * New nodes can appear with new edges
59 private var intro_mtype_specialization_hierarchy
: POSet[MClassType] = new POSet[MClassType]
61 # Global overlapped class-type hierarchy.
62 # The hierarchy when all modules are combined.
63 # Therefore, this hierarchy is used for a fast negative subtype check.
65 # This poset will evolve in an anarchic way. Loops can even be created.
67 # FIXME decide what to do on loops
68 private var full_mtype_specialization_hierarchy
: POSet[MClassType] = new POSet[MClassType]
70 # Collections of classes grouped by their short name
71 private var mclasses_by_name
: MultiHashMap[String, MClass] = new MultiHashMap[String, MClass]
73 # Return all class named `name'.
75 # If such a class does not exist, null is returned
76 # (instead of an empty array)
78 # Visibility or modules are not considered
79 fun get_mclasses_by_name
(name
: String): nullable Array[MClass]
81 if mclasses_by_name
.has_key
(name
) then
82 return mclasses_by_name
[name
]
88 # Collections of properties grouped by their short name
89 private var mproperties_by_name
: MultiHashMap[String, MProperty] = new MultiHashMap[String, MProperty]
91 # Return all properties named `name'.
93 # If such a property does not exist, null is returned
94 # (instead of an empty array)
96 # Visibility or modules are not considered
97 fun get_mproperties_by_name
(name
: String): nullable Array[MProperty]
99 if not mproperties_by_name
.has_key
(name
) then
102 return mproperties_by_name
[name
]
107 var null_type
: MNullType = new MNullType(self)
111 # All the classes introduced in the module
112 var intro_mclasses
: Array[MClass] = new Array[MClass]
114 # All the class definitions of the module
115 # (introduction and refinement)
116 var mclassdefs
: Array[MClassDef] = new Array[MClassDef]
118 # Does the current module has a given class `mclass'?
119 # Return true if the mmodule introduces, refines or imports a class.
120 # Visibility is not considered.
121 fun has_mclass
(mclass
: MClass): Bool
123 return self.in_importation
<= mclass
.intro_mmodule
126 # Full hierarchy of introduced ans imported classes.
128 # Create a new hierarchy got by flattening the classes for the module
129 # and its imported modules.
130 # Visibility is not considered.
132 # Note: this function is expensive and is usually used for the main
133 # module of a program only. Do not use it to do you own subtype
135 fun flatten_mclass_hierarchy
: POSet[MClass]
137 var res
= self.flatten_mclass_hierarchy_cache
138 if res
!= null then return res
139 res
= new POSet[MClass]
140 for m
in self.in_importation
.greaters
do
141 for cd
in m
.mclassdefs
do
143 for s
in cd
.supertypes
do
144 res
.add_edge
(c
, s
.mclass
)
148 self.flatten_mclass_hierarchy_cache
= res
152 # Sort a given array of classes using the linerarization order of the module
153 # The most general is first, the most specific is last
154 fun linearize_mclasses
(mclasses
: Array[MClass])
156 self.flatten_mclass_hierarchy
.sort
(mclasses
)
159 # Sort a given array of class definitions using the linerarization order of the module
160 # the refinement link is stronger than the specialisation link
161 # The most general is first, the most specific is last
162 fun linearize_mclassdefs
(mclassdefs
: Array[MClassDef])
164 var sorter
= new MClassDefSorter(self)
165 sorter
.sort
(mclassdefs
)
168 # Sort a given array of property definitions using the linerarization order of the module
169 # the refinement link is stronger than the specialisation link
170 # The most general is first, the most specific is last
171 fun linearize_mpropdefs
(mpropdefs
: Array[MPropDef])
173 var sorter
= new MPropDefSorter(self)
174 sorter
.sort
(mpropdefs
)
177 private var flatten_mclass_hierarchy_cache
: nullable POSet[MClass] = null
179 # The primitive type Object, the root of the class hierarchy
180 fun object_type
: MClassType
182 var res
= self.object_type_cache
183 if res
!= null then return res
184 res
= self.get_primitive_class
("Object").mclass_type
185 self.object_type_cache
= res
189 private var object_type_cache
: nullable MClassType
191 # The primitive type Bool
192 fun bool_type
: MClassType
194 var res
= self.bool_type_cache
195 if res
!= null then return res
196 res
= self.get_primitive_class
("Bool").mclass_type
197 self.bool_type_cache
= res
201 private var bool_type_cache
: nullable MClassType
203 # The primitive type Sys, the main type of the program, if any
204 fun sys_type
: nullable MClassType
206 var clas
= self.model
.get_mclasses_by_name
("Sys")
207 if clas
== null then return null
208 return get_primitive_class
("Sys").mclass_type
211 # Force to get the primitive class named `name' or abort
212 fun get_primitive_class
(name
: String): MClass
214 var cla
= self.model
.get_mclasses_by_name
(name
)
216 if name
== "Bool" then
217 var c
= new MClass(self, name
, 0, enum_kind
, public_visibility
)
218 var cladef
= new MClassDef(self, c
.mclass_type
, new Location(null, 0,0,0,0), new Array[String])
221 print
("Fatal Error: no primitive class {name}")
224 assert cla
.length
== 1 else print cla
.join
(", ")
228 # Try to get the primitive method named `name' on the type `recv'
229 fun try_get_primitive_method
(name
: String, recv
: MType): nullable MMethod
231 var props
= self.model
.get_mproperties_by_name
(name
)
232 if props
== null then return null
233 var res
: nullable MMethod = null
234 for mprop
in props
do
235 assert mprop
isa MMethod
236 if not recv
.has_mproperty
(self, mprop
) then continue
240 print
("Fatal Error: ambigous property name '{name}'; conflict between {mprop.full_name} and {res.full_name}")
248 private class MClassDefSorter
249 super AbstractSorter[MClassDef]
251 redef fun compare
(a
, b
)
255 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
256 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
260 private class MPropDefSorter
261 super AbstractSorter[MPropDef]
263 redef fun compare
(pa
, pb
)
269 if ca
!= cb
then return mmodule
.flatten_mclass_hierarchy
.compare
(ca
, cb
)
270 return mmodule
.model
.mclassdef_hierarchy
.compare
(a
, b
)
276 # MClass are global to the model; it means that a MClass is not bound to a
277 # specific `MModule`.
279 # This characteristic helps the reasoning about classes in a program since a
280 # single MClass object always denote the same class.
281 # However, because a MClass is global, it does not really have properties nor
282 # belong to a hierarchy since the property and the
283 # hierarchy of a class depends of a module.
285 # The module that introduce the class
286 # While classes are not bound to a specific module,
287 # the introducing module is used for naming an visibility
288 var intro_mmodule
: MModule
290 # The short name of the class
291 # In Nit, the name of a class cannot evolve in refinements
294 # The canonical name of the class
295 # Example: "owner::module::MyClass"
296 fun full_name
: String
298 return "{self.intro_mmodule.full_name}::{name}"
301 # The number of generic formal parameters
302 # 0 if the class is not generic
305 # The kind of the class (interface, abstract class, etc.)
306 # In Nit, the kind of a class cannot evolve in refinements
309 # The visibility of the class
310 # In Nit, the visibility of a class cannot evolve in refinements
311 var visibility
: MVisibility
313 init(intro_mmodule
: MModule, name
: String, arity
: Int, kind
: MClassKind, visibility
: MVisibility)
315 self.intro_mmodule
= intro_mmodule
319 self.visibility
= visibility
320 intro_mmodule
.intro_mclasses
.add
(self)
321 var model
= intro_mmodule
.model
322 model
.mclasses_by_name
.add_one
(name
, self)
323 model
.mclasses
.add
(self)
325 # Create the formal parameter types
327 var mparametertypes
= new Array[MParameterType]
328 for i
in [0..arity
[ do
329 var mparametertype
= new MParameterType(self, i
)
330 mparametertypes
.add
(mparametertype
)
332 var mclass_type
= new MGenericType(self, mparametertypes
)
333 self.mclass_type
= mclass_type
334 self.get_mtype_cache
.add
(mclass_type
)
336 self.mclass_type
= new MClassType(self)
340 # All class definitions (introduction and refinements)
341 var mclassdefs
: Array[MClassDef] = new Array[MClassDef]
344 redef fun to_s
do return self.name
346 # The definition that introduced the class
347 # Warning: the introduction is the first `MClassDef' object associated
348 # to self. If self is just created without having any associated
349 # definition, this method will abort
352 assert has_a_first_definition
: not mclassdefs
.is_empty
353 return mclassdefs
.first
356 # Return the class `self' in the class hierarchy of the module `mmodule'.
358 # SEE: MModule::flatten_mclass_hierarchy
359 # REQUIRE: mmodule.has_mclass(self)
360 fun in_hierarchy
(mmodule
: MModule): POSetElement[MClass]
362 return mmodule
.flatten_mclass_hierarchy
[self]
365 # The principal static type of the class.
367 # For non-generic class, mclass_type is the only MClassType based
370 # For a generic class, the arguments are the formal parameters.
371 # i.e.: for the class `Array[E:Object]', the mtype is Array[E].
372 # If you want `Array[Object]' the see `MClassDef::bound_mtype'
374 # For generic classes, the mclass_type is also the way to get a formal
375 # generic parameter type.
377 # To get other types based on a generic class, see `get_mtype'.
379 # ENSURE: mclass_type.mclass == self
380 var mclass_type
: MClassType
382 # Return a generic type based on the class
383 # Is the class is not generic, then the result is `mclass_type'
385 # REQUIRE: type_arguments.length == self.arity
386 fun get_mtype
(mtype_arguments
: Array[MType]): MClassType
388 assert mtype_arguments
.length
== self.arity
389 if self.arity
== 0 then return self.mclass_type
390 for t
in self.get_mtype_cache
do
391 if t
.arguments
== mtype_arguments
then
395 var res
= new MGenericType(self, mtype_arguments
)
396 self.get_mtype_cache
.add res
400 private var get_mtype_cache
: Array[MGenericType] = new Array[MGenericType]
404 # A definition (an introduction or a refinement) of a class in a module
406 # A MClassDef is associated with an explicit (or almost) definition of a
407 # class. Unlike MClass, a MClassDef is a local definition that belong to
410 # The module where the definition is
413 # The associated MClass
416 # The bounded type associated to the mclassdef
418 # For a non-generic class, `bound_mtype' and `mclass.mclass_type'
422 # For the classdef Array[E: Object], the bound_mtype is Array[Object].
423 # If you want Array[E], then see `mclass.mclass_type'
425 # ENSURE: bound_mtype.mclass = self.mclass
426 var bound_mtype
: MClassType
428 # Name of each formal generic parameter (in order of declaration)
429 var parameter_names
: Array[String]
431 # The origin of the definition
432 var location
: Location
434 # Internal name combining the module and the class
435 # Example: "mymodule#MyClass"
436 redef fun to_s
do return "{mmodule}#{mclass}"
438 init(mmodule
: MModule, bound_mtype
: MClassType, location
: Location, parameter_names
: Array[String])
440 assert bound_mtype
.mclass
.arity
== parameter_names
.length
441 self.bound_mtype
= bound_mtype
442 self.mmodule
= mmodule
443 self.mclass
= bound_mtype
.mclass
444 self.location
= location
445 mmodule
.mclassdefs
.add
(self)
446 mclass
.mclassdefs
.add
(self)
447 self.parameter_names
= parameter_names
450 # All declared super-types
451 # FIXME: quite ugly but not better idea yet
452 var supertypes
: Array[MClassType] = new Array[MClassType]
454 # Register some super-types for the class (ie "super SomeType")
456 # The hierarchy must not already be set
457 # REQUIRE: self.in_hierarchy == null
458 fun set_supertypes
(supertypes
: Array[MClassType])
460 assert unique_invocation
: self.in_hierarchy
== null
461 var mmodule
= self.mmodule
462 var model
= mmodule
.model
463 var mtype
= self.bound_mtype
465 for supertype
in supertypes
do
466 self.supertypes
.add
(supertype
)
468 # Register in full_type_specialization_hierarchy
469 model
.full_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
470 # Register in intro_type_specialization_hierarchy
471 if mclass
.intro_mmodule
== mmodule
and supertype
.mclass
.intro_mmodule
== mmodule
then
472 model
.intro_mtype_specialization_hierarchy
.add_edge
(mtype
, supertype
)
478 # Collect the super-types (set by set_supertypes) to build the hierarchy
480 # This function can only invoked once by class
481 # REQUIRE: self.in_hierarchy == null
482 # ENSURE: self.in_hierarchy != null
485 assert unique_invocation
: self.in_hierarchy
== null
486 var model
= mmodule
.model
487 var res
= model
.mclassdef_hierarchy
.add_node
(self)
488 self.in_hierarchy
= res
489 var mtype
= self.bound_mtype
491 # Here we need to connect the mclassdef to its pairs in the mclassdef_hierarchy
492 # The simpliest way is to attach it to collect_mclassdefs
493 for mclassdef
in mtype
.collect_mclassdefs
(mmodule
) do
494 res
.poset
.add_edge
(self, mclassdef
)
498 # The view of the class definition in `mclassdef_hierarchy'
499 var in_hierarchy
: nullable POSetElement[MClassDef] = null
501 # Is the definition the one that introduced `mclass`?
502 fun is_intro
: Bool do return mclass
.intro
== self
504 # All properties introduced by the classdef
505 var intro_mproperties
: Array[MProperty] = new Array[MProperty]
507 # All property definitions in the class (introductions and redefinitions)
508 var mpropdefs
: Array[MPropDef] = new Array[MPropDef]
511 # A global static type
513 # MType are global to the model; it means that a MType is not bound to a
514 # specific `MModule`.
515 # This characteristic helps the reasoning about static types in a program
516 # since a single MType object always denote the same type.
518 # However, because a MType is global, it does not really have properties
519 # nor have subtypes to a hierarchy since the property and the class hierarchy
520 # depends of a module.
521 # Moreover, virtual types an formal generic parameter types also depends on
522 # a receiver to have sense.
524 # Therefore, most method of the types require a module and an anchor.
525 # The module is used to know what are the classes and the specialization
527 # The anchor is used to know what is the bound of the virtual types and formal
528 # generic parameter types.
530 # MType are not directly usable to get properties. See the `anchor_to' method
531 # and the `MClassType' class.
533 # FIXME: the order of the parameters is not the best. We mus pick on from:
534 # * foo(mmodule, anchor, othertype)
535 # * foo(othertype, anchor, mmodule)
536 # * foo(anchor, mmodule, othertype)
537 # * foo(othertype, mmodule, anchor)
539 # FIXME: Add a 'is_valid_anchor' to improve imputability.
540 # Currently, anchors are used "as it" without check thus if the caller gives a
541 # bad anchor, then the method will likely crash (abort) in a bad case
544 # The model of the type
545 fun model
: Model is abstract
547 # Return true if `self' is an subtype of `sup'.
548 # The typing is done using the standard typing policy of Nit.
550 # REQUIRE: anchor == null implies not self.need_anchor and not sup.need_anchor
551 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
554 if sub
== sup
then return true
555 if anchor
== null then
556 assert not sub
.need_anchor
557 assert not sup
.need_anchor
560 # First, resolve the formal types to a common version in the receiver
561 # The trick here is that fixed formal type will be associed to the bound
562 # And unfixed formal types will be associed to a canonical formal type.
563 if sub
isa MParameterType or sub
isa MVirtualType then
564 assert anchor
!= null
565 sub
= sub
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
567 if sup
isa MParameterType or sup
isa MVirtualType then
568 assert anchor
!= null
569 sup
= sup
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
572 # Does `sup` accept null or not?
573 # Discard the nullable marker if it exists
574 var sup_accept_null
= false
575 if sup
isa MNullableType then
576 sup_accept_null
= true
578 else if sup
isa MNullType then
579 sup_accept_null
= true
582 # Can `sub` provide null or not?
583 # Thus we can match with `sup_accept_null`
584 # Also discard the nullable marker if it exists
585 if sub
isa MNullableType then
586 if not sup_accept_null
then return false
588 else if sub
isa MNullType then
589 return sup_accept_null
591 # Now the case of direct null and nullable is over.
593 # A unfixed formal type can only accept itself
594 if sup
isa MParameterType or sup
isa MVirtualType then
598 # If `sub` is a formal type, then it is accepted if its bound is accepted
599 if sub
isa MParameterType or sub
isa MVirtualType then
600 assert anchor
!= null
601 sub
= sub
.anchor_to
(mmodule
, anchor
)
603 # Manage the second layer of null/nullable
604 if sub
isa MNullableType then
605 if not sup_accept_null
then return false
607 else if sub
isa MNullType then
608 return sup_accept_null
612 assert sub
isa MClassType # It is the only remaining type
614 if sup
isa MNullType then
615 # `sup` accepts only null
619 assert sup
isa MClassType # It is the only remaining type
621 # Now both are MClassType, we need to dig
623 if sub
== sup
then return true
625 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
626 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
627 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
628 if res
== false then return false
629 if not sup
isa MGenericType then return true
630 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
631 assert sub2
.mclass
== sup
.mclass
632 for i
in [0..sup
.mclass
.arity
[ do
633 var sub_arg
= sub2
.arguments
[i
]
634 var sup_arg
= sup
.arguments
[i
]
635 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
636 if res
== false then return false
641 # The base class type on which self is based
643 # This base type is used to get property (an internally to perform
644 # unsafe type comparison).
646 # Beware: some types (like null) are not based on a class thus this
649 # Basically, this function transform the virtual types and parameter
650 # types to their bounds.
660 # Map[T,U] anchor_to H #-> Map[C,Y]
662 # Explanation of the example:
663 # In H, T is set to C, because "H super G[C]", and U is bound to Y,
664 # because "redef type U: Y". Therefore, Map[T, U] is bound to
667 # ENSURE: not self.need_anchor implies return == self
668 # ENSURE: not return.need_anchor
669 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
671 if not need_anchor
then return self
672 assert not anchor
.need_anchor
673 # Just resolve to the anchor and clear all the virtual types
674 var res
= self.resolve_for
(anchor
, null, mmodule
, true)
675 assert not res
.need_anchor
679 # Does `self' contain a virtual type or a formal generic parameter type?
680 # In order to remove those types, you usually want to use `anchor_to'.
681 fun need_anchor
: Bool do return true
683 # Return the supertype when adapted to a class.
685 # In Nit, for each super-class of a type, there is a equivalent super-type.
689 # class H[V] super G[V, Bool]
690 # H[Int] supertype_to G #-> G[Int, Bool]
692 # REQUIRE: `super_mclass' is a super-class of `self'
693 # ENSURE: return.mclass = mclass
694 fun supertype_to
(mmodule
: MModule, anchor
: nullable MClassType, super_mclass
: MClass): MClassType
696 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
697 if self isa MClassType and self.mclass
== super_mclass
then return self
699 if self.need_anchor
then
700 assert anchor
!= null
701 resolved_self
= self.anchor_to
(mmodule
, anchor
)
705 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
706 for supertype
in supertypes
do
707 if supertype
.mclass
== super_mclass
then
708 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
709 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
715 # Replace formals generic types in self with resolved values in `mtype'
716 # If `cleanup_virtual' is true, then virtual types are also replaced
719 # This function returns self if `need_anchor' is false.
724 # class H[F] super G[F]
727 # Array[E].resolve_for(H[Int]) #-> Array[Int]
728 # Array[E].resolve_for(G[Z], X[Int]) #-> Array[Z]
730 # Explanation of the example:
731 # * Array[E].need_anchor is true because there is a formal generic
733 # * E makes sense for H[Int] because E is a formal parameter of G
735 # * Since "H[F] super G[F]", E is in fact F for H
736 # * More specifically, in H[Int], E is Int
737 # * So, in H[Int], Array[E] is Array[Int]
739 # This function is mainly used to inherit a signature.
740 # Because, unlike `anchor_to', we do not want a full resolution of
741 # a type but only an adapted version of it.
748 # class B super A[Int] end
750 # The signature on foo is (e: E): E
751 # If we resolve the signature for B, we get (e:Int):Int
756 # fun foo(e:E) is abstract
760 # fun bar do a.foo(x) # <- x is here
763 # The first question is: is foo available on `a`?
765 # The static type of a is `A[Array[F]]`, that is an open type.
766 # in order to find a method `foo`, whe must look at a resolved type.
768 # A[Array[F]].anchor_to(B[nullable Object]) #-> A[Array[nullable Object]]
770 # the method `foo` exists in `A[Array[nullable Object]]`, therefore `foo` exists for `a`.
772 # The next question is: what is the accepted types for `x'?
774 # the signature of `foo` is `foo(e:E)`, thus we must resolve the type E
776 # E.resolve_for(A[Array[F]],B[nullable Object]) #-> Array[F]
778 # TODO: Explain the cleanup_virtual
780 # FIXME: the parameter `cleanup_virtual' is just a bad idea, but having
781 # two function instead of one seems also to be a bad idea.
783 # REQUIRE: can_resolve_for(mtype, anchor, mmodule)
784 # ENSURE: not self.need_anchor implies return == self
785 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
787 # Return the nullable version of the type
788 # If the type is already nullable then self is returned
789 fun as_nullable
: MType
791 var res
= self.as_nullable_cache
792 if res
!= null then return res
793 res
= new MNullableType(self)
794 self.as_nullable_cache
= res
798 private var as_nullable_cache
: nullable MType = null
801 # The deph of the type seen as a tree.
808 # Formal types have a depth of 1.
814 # The length of the type seen as a tree.
821 # Formal types have a length of 1.
827 # Compute all the classdefs inherited/imported.
828 # The returned set contains:
829 # * the class definitions from `mmodule` and its imported modules
830 # * the class definitions of this type and its super-types
832 # This function is used mainly internally.
834 # REQUIRE: not self.need_anchor
835 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
837 # Compute all the super-classes.
838 # This function is used mainly internally.
840 # REQUIRE: not self.need_anchor
841 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
843 # Compute all the declared super-types.
844 # Super-types are returned as declared in the classdefs (verbatim).
845 # This function is used mainly internally.
847 # REQUIRE: not self.need_anchor
848 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
850 # Is the property in self for a given module
851 # This method does not filter visibility or whatever
853 # REQUIRE: not self.need_anchor
854 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
856 assert not self.need_anchor
857 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
861 # A type based on a class.
863 # MClassType have properties (see `has_property').
867 # The associated class
870 redef fun model
do return self.mclass
.intro_mmodule
.model
872 private init(mclass
: MClass)
877 # The formal arguments of the type
878 # ENSURE: return.length == self.mclass.arity
879 var arguments
: Array[MType] = new Array[MType]
881 redef fun to_s
do return mclass
.to_s
883 redef fun need_anchor
do return false
885 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
887 return super.as(MClassType)
890 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
892 redef fun collect_mclassdefs
(mmodule
)
894 assert not self.need_anchor
895 var cache
= self.collect_mclassdefs_cache
896 if not cache
.has_key
(mmodule
) then
897 self.collect_things
(mmodule
)
899 return cache
[mmodule
]
902 redef fun collect_mclasses
(mmodule
)
904 assert not self.need_anchor
905 var cache
= self.collect_mclasses_cache
906 if not cache
.has_key
(mmodule
) then
907 self.collect_things
(mmodule
)
909 return cache
[mmodule
]
912 redef fun collect_mtypes
(mmodule
)
914 assert not self.need_anchor
915 var cache
= self.collect_mtypes_cache
916 if not cache
.has_key
(mmodule
) then
917 self.collect_things
(mmodule
)
919 return cache
[mmodule
]
922 # common implementation for `collect_mclassdefs', `collect_mclasses', and `collect_mtypes'.
923 private fun collect_things
(mmodule
: MModule)
925 var res
= new HashSet[MClassDef]
926 var seen
= new HashSet[MClass]
927 var types
= new HashSet[MClassType]
928 seen
.add
(self.mclass
)
929 var todo
= [self.mclass
]
930 while not todo
.is_empty
do
931 var mclass
= todo
.pop
932 #print "process {mclass}"
933 for mclassdef
in mclass
.mclassdefs
do
934 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
935 #print " process {mclassdef}"
937 for supertype
in mclassdef
.supertypes
do
939 var superclass
= supertype
.mclass
940 if seen
.has
(superclass
) then continue
941 #print " add {superclass}"
947 collect_mclassdefs_cache
[mmodule
] = res
948 collect_mclasses_cache
[mmodule
] = seen
949 collect_mtypes_cache
[mmodule
] = types
952 private var collect_mclassdefs_cache
: HashMap[MModule, Set[MClassDef]] = new HashMap[MModule, Set[MClassDef]]
953 private var collect_mclasses_cache
: HashMap[MModule, Set[MClass]] = new HashMap[MModule, Set[MClass]]
954 private var collect_mtypes_cache
: HashMap[MModule, Set[MClassType]] = new HashMap[MModule, Set[MClassType]]
958 # A type based on a generic class.
959 # A generic type a just a class with additional formal generic arguments.
963 private init(mclass
: MClass, arguments
: Array[MType])
966 assert self.mclass
.arity
== arguments
.length
967 self.arguments
= arguments
969 self.need_anchor
= false
970 for t
in arguments
do
971 if t
.need_anchor
then
972 self.need_anchor
= true
978 # Recursively print the type of the arguments within brackets.
979 # Example: "Map[String, List[Int]]"
982 return "{mclass}[{arguments.join(", ")}]"
985 redef var need_anchor
: Bool
987 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
989 if not need_anchor
then return self
990 var types
= new Array[MType]
991 for t
in arguments
do
992 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
994 return mclass
.get_mtype
(types
)
1000 for a
in self.arguments
do
1002 if d
> dmax
then dmax
= d
1010 for a
in self.arguments
do
1017 # A virtual formal type.
1021 # The property associated with the type.
1022 # Its the definitions of this property that determine the bound or the virtual type.
1023 var mproperty
: MProperty
1025 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
1027 # Lookup the bound for a given resolved_receiver
1028 # The result may be a other virtual type (or a parameter type)
1030 # The result is returned exactly as declared in the "type" property (verbatim).
1032 # In case of conflict, the method aborts.
1033 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1035 assert not resolved_receiver
.need_anchor
1036 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
1037 if props
.is_empty
then
1039 else if props
.length
== 1 then
1040 return props
.first
.as(MVirtualTypeDef).bound
.as(not null)
1042 var types
= new ArraySet[MType]
1044 types
.add
(p
.as(MVirtualTypeDef).bound
.as(not null))
1046 if types
.length
== 1 then
1052 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1054 # self is a virtual type declared (or inherited) in mtype
1055 # The point of the function it to get the bound of the virtual type that make sense for mtype
1056 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1057 #print "{class_name}: {self}/{mtype}/{anchor}?"
1058 var resolved_reciever
1059 if mtype
.need_anchor
then
1060 assert anchor
!= null
1061 resolved_reciever
= mtype
.resolve_for
(anchor
, null, mmodule
, true)
1063 resolved_reciever
= mtype
1065 # Now, we can get the bound
1066 var verbatim_bound
= lookup_bound
(mmodule
, resolved_reciever
)
1067 # The bound is exactly as declared in the "type" property, so we must resolve it again
1068 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1069 #print "{class_name}: {self}/{mtype}/{anchor} -> {self}/{resolved_reciever}/{anchor} -> {verbatim_bound}/{mtype}/{anchor} -> {res}"
1071 # What to return here? There is a bunch a special cases:
1072 # If 'cleanup_virtual' we must return the resolved type, since we cannot return self
1073 if cleanup_virtual
then return res
1074 # If the reciever is a intern class, then the virtual type cannot be redefined since there is no possible subclass. self is just fixed. so simply return the resolution
1075 if resolved_reciever
isa MNullableType then resolved_reciever
= resolved_reciever
.mtype
1076 if resolved_reciever
.as(MClassType).mclass
.kind
== enum_kind
then return res
1077 # If the resolved type isa MVirtualType, it means that self was bound to it, and cannot be unbound. self is just fixed. so return the resolution.
1078 if res
isa MVirtualType then return res
1079 # It the resolved type isa intern class, then there is no possible valid redefinition is any potentiel subclass. self is just fixed. so simply return the resolution
1080 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1081 # TODO: Add 'fixed' virtual type in the specification.
1082 # TODO: What if bound to a MParameterType?
1083 # Note that Nullable types can always be redefined by the non nullable version, so there is no specific case on it.
1085 # If anything apply, then `self' cannot be resolved, so return self
1089 redef fun to_s
do return self.mproperty
.to_s
1091 init(mproperty
: MProperty)
1093 self.mproperty
= mproperty
1097 # The type associated the a formal parameter generic type of a class
1099 # Each parameter type is associated to a specific class.
1100 # It's mean that all refinements of a same class "share" the parameter type,
1101 # but that a generic subclass has its on parameter types.
1103 # However, in the sense of the meta-model, the a parameter type of a class is
1104 # a valid types in a subclass. The "in the sense of the meta-model" is
1105 # important because, in the Nit language, the programmer cannot refers
1106 # directly to the parameter types of the super-classes.
1110 # fun e: E is abstract
1115 # In the class definition B[F], `F' is a valid type but `E' is not.
1116 # However, `self.e' is a valid method call, and the signature of `e' is
1119 # Note that parameter types are shared among class refinements.
1120 # Therefore parameter only have an internal name (see `to_s' for details).
1121 # TODO: Add a 'name_for' to get better messages.
1122 class MParameterType
1125 # The generic class where the parameter belong
1128 redef fun model
do return self.mclass
.intro_mmodule
.model
1130 # The position of the parameter (0 for the first parameter)
1131 # FIXME: is `position' a better name?
1134 # Internal name of the parameter type
1135 # Names of parameter types changes in each class definition
1136 # Therefore, this method return an internal name.
1137 # Example: return "G#1" for the second parameter of the class G
1138 # FIXME: add a way to get the real name in a classdef
1139 redef fun to_s
do return "{mclass}#{rank}"
1141 # Resolve the bound for a given resolved_receiver
1142 # The result may be a other virtual type (or a parameter type)
1143 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1145 assert not resolved_receiver
.need_anchor
1146 var goalclass
= self.mclass
1147 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1148 for t
in supertypes
do
1149 if t
.mclass
== goalclass
then
1150 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1151 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1152 var res
= t
.arguments
[self.rank
]
1159 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1161 #print "{class_name}: {self}/{mtype}/{anchor}?"
1163 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1164 return mtype
.arguments
[self.rank
]
1167 # self is a parameter type of mtype (or of a super-class of mtype)
1168 # The point of the function it to get the bound of the virtual type that make sense for mtype
1169 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1170 # FIXME: What happend here is far from clear. Thus this part must be validated and clarified
1171 var resolved_receiver
1172 if mtype
.need_anchor
then
1173 assert anchor
!= null
1174 resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1176 resolved_receiver
= mtype
1178 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1179 if resolved_receiver
isa MParameterType then
1180 assert resolved_receiver
.mclass
== anchor
.mclass
1181 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1182 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1184 assert resolved_receiver
isa MClassType
1186 # Eh! The parameter is in the current class.
1187 # So we return the corresponding argument, no mater what!
1188 if resolved_receiver
.mclass
== self.mclass
then
1189 var res
= resolved_receiver
.arguments
[self.rank
]
1190 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1194 if resolved_receiver
.need_anchor
then
1195 assert anchor
!= null
1196 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, null, mmodule
, false)
1198 # Now, we can get the bound
1199 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1200 # The bound is exactly as declared in the "type" property, so we must resolve it again
1201 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1203 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1208 init(mclass
: MClass, rank
: Int)
1210 self.mclass
= mclass
1215 # A type prefixed with "nullable"
1219 # The base type of the nullable type
1222 redef fun model
do return self.mtype
.model
1229 redef fun to_s
do return "nullable {mtype}"
1231 redef fun need_anchor
do return mtype
.need_anchor
1232 redef fun as_nullable
do return self
1233 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1235 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1236 return res
.as_nullable
1239 redef fun depth
do return self.mtype
.depth
1241 redef fun length
do return self.mtype
.length
1243 redef fun collect_mclassdefs
(mmodule
)
1245 assert not self.need_anchor
1246 return self.mtype
.collect_mclassdefs
(mmodule
)
1249 redef fun collect_mclasses
(mmodule
)
1251 assert not self.need_anchor
1252 return self.mtype
.collect_mclasses
(mmodule
)
1255 redef fun collect_mtypes
(mmodule
)
1257 assert not self.need_anchor
1258 return self.mtype
.collect_mtypes
(mmodule
)
1262 # The type of the only value null
1264 # The is only one null type per model, see `MModel::null_type'.
1267 redef var model
: Model
1268 protected init(model
: Model)
1272 redef fun to_s
do return "null"
1273 redef fun as_nullable
do return self
1274 redef fun need_anchor
do return false
1275 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1277 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1279 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1281 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1284 # A signature of a method (or a closure)
1288 # The each parameter (in order)
1289 var mparameters
: Array[MParameter]
1291 var mclosures
= new Array[MParameter]
1293 # The return type (null for a procedure)
1294 var return_mtype
: nullable MType
1299 var t
= self.return_mtype
1300 if t
!= null then dmax
= t
.depth
1301 for p
in mparameters
do
1302 var d
= p
.mtype
.depth
1303 if d
> dmax
then dmax
= d
1305 for p
in mclosures
do
1306 var d
= p
.mtype
.depth
1307 if d
> dmax
then dmax
= d
1315 var t
= self.return_mtype
1316 if t
!= null then res
+= t
.length
1317 for p
in mparameters
do
1318 res
+= p
.mtype
.length
1320 for p
in mclosures
do
1321 res
+= p
.mtype
.length
1326 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1327 init(mparameters
: Array[MParameter], return_mtype
: nullable MType)
1329 var vararg_rank
= -1
1330 for i
in [0..mparameters
.length
[ do
1331 var parameter
= mparameters
[i
]
1332 if parameter
.is_vararg
then
1333 assert vararg_rank
== -1
1337 self.mparameters
= mparameters
1338 self.return_mtype
= return_mtype
1339 self.vararg_rank
= vararg_rank
1342 # The rank of the ellipsis (...) for vararg (starting from 0).
1343 # value is -1 if there is no vararg.
1344 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1345 var vararg_rank
: Int
1347 # The number or parameters
1348 fun arity
: Int do return mparameters
.length
1353 if not mparameters
.is_empty
then
1355 for i
in [0..mparameters
.length
[ do
1356 var mparameter
= mparameters
[i
]
1357 if i
> 0 then b
.append
(", ")
1358 b
.append
(mparameter
.name
)
1360 b
.append
(mparameter
.mtype
.to_s
)
1361 if mparameter
.is_vararg
then
1367 var ret
= self.return_mtype
1375 redef fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1377 var params
= new Array[MParameter]
1378 for p
in self.mparameters
do
1379 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1381 var ret
= self.return_mtype
1383 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1385 var res
= new MSignature(params
, ret
)
1386 for p
in self.mclosures
do
1387 res
.mclosures
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1393 # A parameter in a signature
1395 # The name of the parameter
1398 # The static type of the parameter
1401 # Is the parameter a vararg?
1404 fun resolve_for
(mtype
: MType, anchor
: nullable MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1406 if not self.mtype
.need_anchor
then return self
1407 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1408 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1413 # A service (global property) that generalize method, attribute, etc.
1415 # MProperty are global to the model; it means that a MProperty is not bound
1416 # to a specific `MModule` nor a specific `MClass`.
1418 # A MProperty gather definitions (see `mpropdefs') ; one for the introduction
1419 # and the other in subclasses and in refinements.
1421 # A MProperty is used to denotes services in polymorphic way (ie. independent
1422 # of any dynamic type).
1423 # For instance, a call site "x.foo" is associated to a MProperty.
1424 abstract class MProperty
1425 # The associated MPropDef subclass.
1426 # The two specialization hierarchy are symmetric.
1427 type MPROPDEF: MPropDef
1429 # The classdef that introduce the property
1430 # While a property is not bound to a specific module, or class,
1431 # the introducing mclassdef is used for naming and visibility
1432 var intro_mclassdef
: MClassDef
1434 # The (short) name of the property
1437 # The canonical name of the property
1438 # Example: "owner::my_module::MyClass::my_method"
1439 fun full_name
: String
1441 return "{self.intro_mclassdef.mmodule.full_name}::{self.intro_mclassdef.mclass.name}::{name}"
1444 # The visibility of the property
1445 var visibility
: MVisibility
1447 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1449 self.intro_mclassdef
= intro_mclassdef
1451 self.visibility
= visibility
1452 intro_mclassdef
.intro_mproperties
.add
(self)
1453 var model
= intro_mclassdef
.mmodule
.model
1454 model
.mproperties_by_name
.add_one
(name
, self)
1455 model
.mproperties
.add
(self)
1458 # All definitions of the property.
1459 # The first is the introduction,
1460 # The other are redefinitions (in refinements and in subclasses)
1461 var mpropdefs
: Array[MPROPDEF] = new Array[MPROPDEF]
1463 # The definition that introduced the property
1464 # Warning: the introduction is the first `MPropDef' object
1465 # associated to self. If self is just created without having any
1466 # associated definition, this method will abort
1467 fun intro
: MPROPDEF do return mpropdefs
.first
1470 redef fun to_s
do return name
1472 # Return the most specific property definitions defined or inherited by a type.
1473 # The selection knows that refinement is stronger than specialization;
1474 # however, in case of conflict more than one property are returned.
1475 # If mtype does not know mproperty then an empty array is returned.
1477 # If you want the really most specific property, then look at `lookup_first_definition`
1478 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1480 assert not mtype
.need_anchor
1481 if mtype
isa MNullableType then mtype
= mtype
.mtype
1483 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1484 if cache
!= null then return cache
1486 #print "select prop {mproperty} for {mtype} in {self}"
1487 # First, select all candidates
1488 var candidates
= new Array[MPROPDEF]
1489 for mpropdef
in self.mpropdefs
do
1490 # If the definition is not imported by the module, then skip
1491 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1492 # If the definition is not inherited by the type, then skip
1493 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1495 candidates
.add
(mpropdef
)
1497 # Fast track for only one candidate
1498 if candidates
.length
<= 1 then
1499 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1503 # Second, filter the most specific ones
1504 var res
= new Array[MPROPDEF]
1505 for pd1
in candidates
do
1506 var cd1
= pd1
.mclassdef
1509 for pd2
in candidates
do
1510 if pd2
== pd1
then continue # do not compare with self!
1511 var cd2
= pd2
.mclassdef
1513 if c2
.mclass_type
== c1
.mclass_type
then
1514 if cd2
.mmodule
.in_importation
<= cd1
.mmodule
then
1515 # cd2 refines cd1; therefore we skip pd1
1519 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) then
1520 # cd2 < cd1; therefore we skip pd1
1529 if res
.is_empty
then
1530 print
"All lost! {candidates.join(", ")}"
1531 # FIXME: should be abort!
1533 self.lookup_definitions_cache
[mmodule
, mtype
] = res
1537 private var lookup_definitions_cache
: HashMap2[MModule, MType, Array[MPROPDEF]] = new HashMap2[MModule, MType, Array[MPROPDEF]]
1539 # Return the most specific property definitions inherited by a type.
1540 # The selection knows that refinement is stronger than specialization;
1541 # however, in case of conflict more than one property are returned.
1542 # If mtype does not know mproperty then an empty array is returned.
1544 # If you want the really most specific property, then look at `lookup_next_definition`
1546 # FIXME: Move to MPropDef?
1547 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPropDef]
1549 assert not mtype
.need_anchor
1550 if mtype
isa MNullableType then mtype
= mtype
.mtype
1552 # First, select all candidates
1553 var candidates
= new Array[MPropDef]
1554 for mpropdef
in self.mpropdefs
do
1555 # If the definition is not imported by the module, then skip
1556 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1557 # If the definition is not inherited by the type, then skip
1558 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1559 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1560 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1562 candidates
.add
(mpropdef
)
1564 # Fast track for only one candidate
1565 if candidates
.length
<= 1 then return candidates
1567 # Second, filter the most specific ones
1568 var res
= new Array[MPropDef]
1569 for pd1
in candidates
do
1570 var cd1
= pd1
.mclassdef
1573 for pd2
in candidates
do
1574 if pd2
== pd1
then continue # do not compare with self!
1575 var cd2
= pd2
.mclassdef
1577 if c2
.mclass_type
== c1
.mclass_type
then
1578 if cd2
.mmodule
.in_importation
<= cd1
.mmodule
then
1579 # cd2 refines cd1; therefore we skip pd1
1583 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) then
1584 # cd2 < cd1; therefore we skip pd1
1593 if res
.is_empty
then
1594 print
"All lost! {candidates.join(", ")}"
1595 # FIXME: should be abort!
1600 # Return the most specific definition in the linearization of `mtype`.
1602 # If you want to know the next properties in the linearization,
1603 # look at `MPropDef::lookup_next_definition`.
1605 # FIXME: the linearisation is still unspecified
1607 # REQUIRE: not mtype.need_anchor
1608 # REQUIRE: mtype.has_mproperty(mmodule, self)
1609 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1611 return lookup_all_definitions
(mmodule
, mtype
).first
1614 # Return all definitions in a linearisation order
1615 # Most speficic first, most general last
1616 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1618 assert not mtype
.need_anchor
1619 if mtype
isa MNullableType then mtype
= mtype
.mtype
1621 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1622 if cache
!= null then return cache
1624 #print "select prop {mproperty} for {mtype} in {self}"
1625 # First, select all candidates
1626 var candidates
= new Array[MPROPDEF]
1627 for mpropdef
in self.mpropdefs
do
1628 # If the definition is not imported by the module, then skip
1629 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1630 # If the definition is not inherited by the type, then skip
1631 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1633 candidates
.add
(mpropdef
)
1635 # Fast track for only one candidate
1636 if candidates
.length
<= 1 then
1637 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1641 mmodule
.linearize_mpropdefs
(candidates
)
1642 candidates
= candidates
.reversed
1643 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1647 private var lookup_all_definitions_cache
: HashMap2[MModule, MType, Array[MPROPDEF]] = new HashMap2[MModule, MType, Array[MPROPDEF]]
1654 redef type MPROPDEF: MMethodDef
1656 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1661 # Is the property a constructor?
1662 # Warning, this property can be inherited by subclasses with or without being a constructor
1663 # therefore, you should use `is_init_for' the verify if the property is a legal constructor for a given class
1664 var is_init
: Bool writable = false
1666 # The the property a 'new' contructor?
1667 var is_new
: Bool writable = false
1669 # Is the property a legal constructor for a given class?
1670 # As usual, visibility is not considered.
1671 # FIXME not implemented
1672 fun is_init_for
(mclass
: MClass): Bool
1678 # A global attribute
1682 redef type MPROPDEF: MAttributeDef
1684 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1690 # A global virtual type
1691 class MVirtualTypeProp
1694 redef type MPROPDEF: MVirtualTypeDef
1696 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1701 # The formal type associated to the virtual type property
1702 var mvirtualtype
: MVirtualType = new MVirtualType(self)
1705 # A definition of a property (local property)
1707 # Unlike MProperty, a MPropDef is a local definition that belong to a
1708 # specific class definition (which belong to a specific module)
1709 abstract class MPropDef
1711 # The associated MProperty subclass.
1712 # the two specialization hierarchy are symmetric
1713 type MPROPERTY: MProperty
1716 type MPROPDEF: MPropDef
1718 # The origin of the definition
1719 var location
: Location
1721 # The class definition where the property definition is
1722 var mclassdef
: MClassDef
1724 # The associated global property
1725 var mproperty
: MPROPERTY
1727 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1729 self.mclassdef
= mclassdef
1730 self.mproperty
= mproperty
1731 self.location
= location
1732 mclassdef
.mpropdefs
.add
(self)
1733 mproperty
.mpropdefs
.add
(self)
1736 # Internal name combining the module, the class and the property
1737 # Example: "mymodule#MyClass#mymethod"
1740 return "{mclassdef}#{mproperty}"
1743 # Is self the definition that introduce the property?
1744 fun is_intro
: Bool do return mproperty
.intro
== self
1746 # Return the next definition in linearization of `mtype`.
1748 # This method is used to determine what method is called by a super.
1750 # REQUIRE: not mtype.need_anchor
1751 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1753 assert not mtype
.need_anchor
1755 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
1756 var i
= mpropdefs
.iterator
1757 while i
.is_ok
and i
.item
!= self do i
.next
1758 assert has_property
: i
.is_ok
1760 assert has_next_property
: i
.is_ok
1765 # A local definition of a method
1769 redef type MPROPERTY: MMethod
1770 redef type MPROPDEF: MMethodDef
1772 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1777 # The signature attached to the property definition
1778 var msignature
: nullable MSignature writable = null
1781 # A local definition of an attribute
1785 redef type MPROPERTY: MAttribute
1786 redef type MPROPDEF: MAttributeDef
1788 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1793 # The static type of the attribute
1794 var static_mtype
: nullable MType writable = null
1797 # A local definition of a virtual type
1798 class MVirtualTypeDef
1801 redef type MPROPERTY: MVirtualTypeProp
1802 redef type MPROPDEF: MVirtualTypeDef
1804 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1809 # The bound of the virtual type
1810 var bound
: nullable MType writable = null
1821 # Note this class is basically an enum.
1822 # FIXME: use a real enum once user-defined enums are available
1824 redef var to_s
: String
1826 # Is a constructor required?
1828 private init(s
: String, need_init
: Bool)
1831 self.need_init
= need_init
1835 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
1836 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
1837 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
1838 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
1839 fun extern_kind
: MClassKind do return once
new MClassKind("extern", false)