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
543 # FIXME: maybe allways add an anchor with a nullable type (as in is_subtype)
546 # The model of the type
547 fun model
: Model is abstract
549 # Return true if `self' is an subtype of `sup'.
550 # The typing is done using the standard typing policy of Nit.
552 # REQUIRE: anchor == null implies not self.need_anchor and not sup.need_anchor
553 fun is_subtype
(mmodule
: MModule, anchor
: nullable MClassType, sup
: MType): Bool
556 if sub
== sup
then return true
557 if anchor
== null then
558 assert not sub
.need_anchor
559 assert not sup
.need_anchor
562 # First, resolve the formal types to a common version in the receiver
563 # The trick here is that fixed formal type will be associed to the bound
564 # And unfixed formal types will be associed to a canonical formal type.
565 if sub
isa MParameterType or sub
isa MVirtualType then
566 assert anchor
!= null
567 sub
= sub
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
569 if sup
isa MParameterType or sup
isa MVirtualType then
570 assert anchor
!= null
571 sup
= sup
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, false)
574 # Does `sup` accept null or not?
575 # Discard the nullable marker if it exists
576 var sup_accept_null
= false
577 if sup
isa MNullableType then
578 sup_accept_null
= true
580 else if sup
isa MNullType then
581 sup_accept_null
= true
584 # Can `sub` provide null or not?
585 # Thus we can match with `sup_accept_null`
586 # Also discard the nullable marker if it exists
587 if sub
isa MNullableType then
588 if not sup_accept_null
then return false
590 else if sub
isa MNullType then
591 return sup_accept_null
593 # Now the case of direct null and nullable is over.
595 # A unfixed formal type can only accept itself
596 if sup
isa MParameterType or sup
isa MVirtualType then
600 # If `sub` is a formal type, then it is accepted if its bound is accepted
601 if sub
isa MParameterType or sub
isa MVirtualType then
602 assert anchor
!= null
603 sub
= sub
.anchor_to
(mmodule
, anchor
)
605 # Manage the second layer of null/nullable
606 if sub
isa MNullableType then
607 if not sup_accept_null
then return false
609 else if sub
isa MNullType then
610 return sup_accept_null
614 assert sub
isa MClassType # It is the only remaining type
616 if sup
isa MNullType then
617 # `sup` accepts only null
621 assert sup
isa MClassType # It is the only remaining type
623 # Now both are MClassType, we need to dig
625 if sub
== sup
then return true
627 if anchor
== null then anchor
= sub
# UGLY: any anchor will work
628 var resolved_sub
= sub
.anchor_to
(mmodule
, anchor
)
629 var res
= resolved_sub
.collect_mclasses
(mmodule
).has
(sup
.mclass
)
630 if res
== false then return false
631 if not sup
isa MGenericType then return true
632 var sub2
= sub
.supertype_to
(mmodule
, anchor
, sup
.mclass
)
633 assert sub2
.mclass
== sup
.mclass
634 for i
in [0..sup
.mclass
.arity
[ do
635 var sub_arg
= sub2
.arguments
[i
]
636 var sup_arg
= sup
.arguments
[i
]
637 res
= sub_arg
.is_subtype
(mmodule
, anchor
, sup_arg
)
638 if res
== false then return false
643 # The base class type on which self is based
645 # This base type is used to get property (an internally to perform
646 # unsafe type comparison).
648 # Beware: some types (like null) are not based on a class thus this
651 # Basically, this function transform the virtual types and parameter
652 # types to their bounds.
662 # Map[T,U] anchor_to H #-> Map[C,Y]
664 # Explanation of the example:
665 # In H, T is set to C, because "H super G[C]", and U is bound to Y,
666 # because "redef type U: Y". Therefore, Map[T, U] is bound to
669 # ENSURE: not self.need_anchor implies return == self
670 # ENSURE: not return.need_anchor
671 fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MType
673 if not need_anchor
then return self
674 assert not anchor
.need_anchor
675 # Just resolve to the anchor and clear all the virtual types
676 var res
= self.resolve_for
(anchor
, anchor
, mmodule
, true)
677 assert not res
.need_anchor
681 # Does `self' contain a virtual type or a formal generic parameter type?
682 # In order to remove those types, you usually want to use `anchor_to'.
683 fun need_anchor
: Bool do return true
685 # Return the supertype when adapted to a class.
687 # In Nit, for each super-class of a type, there is a equivalent super-type.
691 # class H[V] super G[V, Bool]
692 # H[Int] supertype_to G #-> G[Int, Bool]
694 # REQUIRE: `super_mclass' is a super-class of `self'
695 # ENSURE: return.mclass = mclass
696 fun supertype_to
(mmodule
: MModule, anchor
: MClassType, super_mclass
: MClass): MClassType
698 if super_mclass
.arity
== 0 then return super_mclass
.mclass_type
699 if self isa MClassType and self.mclass
== super_mclass
then return self
700 var resolved_self
= self.anchor_to
(mmodule
, anchor
)
701 var supertypes
= resolved_self
.collect_mtypes
(mmodule
)
702 for supertype
in supertypes
do
703 if supertype
.mclass
== super_mclass
then
704 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
705 return supertype
.resolve_for
(self, anchor
, mmodule
, false)
711 # Replace formals generic types in self with resolved values in `mtype'
712 # If `cleanup_virtual' is true, then virtual types are also replaced
715 # This function returns self if `need_anchor' is false.
719 # class H[F] super G[F]
720 # Array[E] resolve_for H[Int] #-> Array[Int]
722 # Explanation of the example:
723 # * Array[E].need_anchor is true because there is a formal generic
725 # * E makes sense for H[Int] because E is a formal parameter of G
727 # * Since "H[F] super G[F]", E is in fact F for H
728 # * More specifically, in H[Int], E is Int
729 # * So, in H[Int], Array[E] is Array[Int]
731 # This function is mainly used to inherit a signature.
732 # Because, unlike `anchor_type', we do not want a full resolution of
733 # a type but only an adapted version of it.
739 # class B super A[Int] end
741 # The signature on foo is (e: E): E
742 # If we resolve the signature for B, we get (e:Int):Int
744 # TODO: Explain the cleanup_virtual
746 # FIXME: the parameter `cleanup_virtual' is just a bad idea, but having
747 # two function instead of one seems also to be a bad idea.
749 # ENSURE: not self.need_anchor implies return == self
750 fun resolve_for
(mtype
: MType, anchor
: MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MType is abstract
752 # Return the nullable version of the type
753 # If the type is already nullable then self is returned
755 # FIXME: DO NOT WORK YET
756 fun as_nullable
: MType
758 var res
= self.as_nullable_cache
759 if res
!= null then return res
760 res
= new MNullableType(self)
761 self.as_nullable_cache
= res
765 private var as_nullable_cache
: nullable MType = null
768 # The deph of the type seen as a tree.
775 # Formal types have a depth of 1.
781 # Compute all the classdefs inherited/imported.
782 # The returned set contains:
783 # * the class definitions from `mmodule` and its imported modules
784 # * the class definitions of this type and its super-types
786 # This function is used mainly internally.
788 # REQUIRE: not self.need_anchor
789 fun collect_mclassdefs
(mmodule
: MModule): Set[MClassDef] is abstract
791 # Compute all the super-classes.
792 # This function is used mainly internally.
794 # REQUIRE: not self.need_anchor
795 fun collect_mclasses
(mmodule
: MModule): Set[MClass] is abstract
797 # Compute all the declared super-types.
798 # Super-types are returned as declared in the classdefs (verbatim).
799 # This function is used mainly internally.
801 # REQUIRE: not self.need_anchor
802 fun collect_mtypes
(mmodule
: MModule): Set[MClassType] is abstract
804 # Is the property in self for a given module
805 # This method does not filter visibility or whatever
807 # REQUIRE: not self.need_anchor
808 fun has_mproperty
(mmodule
: MModule, mproperty
: MProperty): Bool
810 assert not self.need_anchor
811 return self.collect_mclassdefs
(mmodule
).has
(mproperty
.intro_mclassdef
)
815 # A type based on a class.
817 # MClassType have properties (see `has_property').
821 # The associated class
824 redef fun model
do return self.mclass
.intro_mmodule
.model
826 private init(mclass
: MClass)
831 # The formal arguments of the type
832 # ENSURE: return.length == self.mclass.arity
833 var arguments
: Array[MType] = new Array[MType]
835 redef fun to_s
do return mclass
.to_s
837 redef fun need_anchor
do return false
839 redef fun anchor_to
(mmodule
: MModule, anchor
: MClassType): MClassType
841 return super.as(MClassType)
844 redef fun resolve_for
(mtype
: MType, anchor
: MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MClassType do return self
846 redef fun collect_mclassdefs
(mmodule
)
848 assert not self.need_anchor
849 var cache
= self.collect_mclassdefs_cache
850 if not cache
.has_key
(mmodule
) then
851 self.collect_things
(mmodule
)
853 return cache
[mmodule
]
856 redef fun collect_mclasses
(mmodule
)
858 assert not self.need_anchor
859 var cache
= self.collect_mclasses_cache
860 if not cache
.has_key
(mmodule
) then
861 self.collect_things
(mmodule
)
863 return cache
[mmodule
]
866 redef fun collect_mtypes
(mmodule
)
868 assert not self.need_anchor
869 var cache
= self.collect_mtypes_cache
870 if not cache
.has_key
(mmodule
) then
871 self.collect_things
(mmodule
)
873 return cache
[mmodule
]
876 # common implementation for `collect_mclassdefs', `collect_mclasses', and `collect_mtypes'.
877 private fun collect_things
(mmodule
: MModule)
879 var res
= new HashSet[MClassDef]
880 var seen
= new HashSet[MClass]
881 var types
= new HashSet[MClassType]
882 seen
.add
(self.mclass
)
883 var todo
= [self.mclass
]
884 while not todo
.is_empty
do
885 var mclass
= todo
.pop
886 #print "process {mclass}"
887 for mclassdef
in mclass
.mclassdefs
do
888 if not mmodule
.in_importation
<= mclassdef
.mmodule
then continue
889 #print " process {mclassdef}"
891 for supertype
in mclassdef
.supertypes
do
893 var superclass
= supertype
.mclass
894 if seen
.has
(superclass
) then continue
895 #print " add {superclass}"
901 collect_mclassdefs_cache
[mmodule
] = res
902 collect_mclasses_cache
[mmodule
] = seen
903 collect_mtypes_cache
[mmodule
] = types
906 private var collect_mclassdefs_cache
: HashMap[MModule, Set[MClassDef]] = new HashMap[MModule, Set[MClassDef]]
907 private var collect_mclasses_cache
: HashMap[MModule, Set[MClass]] = new HashMap[MModule, Set[MClass]]
908 private var collect_mtypes_cache
: HashMap[MModule, Set[MClassType]] = new HashMap[MModule, Set[MClassType]]
912 # A type based on a generic class.
913 # A generic type a just a class with additional formal generic arguments.
917 private init(mclass
: MClass, arguments
: Array[MType])
920 assert self.mclass
.arity
== arguments
.length
921 self.arguments
= arguments
923 self.need_anchor
= false
924 for t
in arguments
do
925 if t
.need_anchor
then
926 self.need_anchor
= true
932 # Recursively print the type of the arguments within brackets.
933 # Example: "Map[String, List[Int]]"
936 return "{mclass}[{arguments.join(", ")}]"
939 redef var need_anchor
: Bool
941 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
943 if not need_anchor
then return self
944 var types
= new Array[MType]
945 for t
in arguments
do
946 types
.add
(t
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
948 return mclass
.get_mtype
(types
)
954 for a
in self.arguments
do
956 if d
> dmax
then dmax
= d
962 # A virtual formal type.
966 # The property associated with the type.
967 # Its the definitions of this property that determine the bound or the virtual type.
968 var mproperty
: MProperty
970 redef fun model
do return self.mproperty
.intro_mclassdef
.mmodule
.model
972 # Lookup the bound for a given resolved_receiver
973 # The result may be a other virtual type (or a parameter type)
975 # The result is returned exactly as declared in the "type" property (verbatim).
977 # In case of conflict, the method aborts.
978 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
980 assert not resolved_receiver
.need_anchor
981 var props
= self.mproperty
.lookup_definitions
(mmodule
, resolved_receiver
)
982 if props
.is_empty
then
984 else if props
.length
== 1 then
985 return props
.first
.as(MVirtualTypeDef).bound
.as(not null)
987 var types
= new ArraySet[MType]
989 types
.add
(p
.as(MVirtualTypeDef).bound
.as(not null))
991 if types
.length
== 1 then
997 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
999 # self is a virtual type declared (or inherited) in mtype
1000 # The point of the function it to get the bound of the virtual type that make sense for mtype
1001 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1002 #print "{class_name}: {self}/{mtype}/{anchor}?"
1003 var resolved_reciever
= mtype
.resolve_for
(anchor
, anchor
, mmodule
, true)
1004 # Now, we can get the bound
1005 var verbatim_bound
= lookup_bound
(mmodule
, resolved_reciever
)
1006 # The bound is exactly as declared in the "type" property, so we must resolve it again
1007 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1008 #print "{class_name}: {self}/{mtype}/{anchor} -> {self}/{resolved_reciever}/{anchor} -> {verbatim_bound}/{mtype}/{anchor} -> {res}"
1010 # What to return here? There is a bunch a special cases:
1011 # If 'cleanup_virtual' we must return the resolved type, since we cannot return self
1012 if cleanup_virtual
then return res
1013 # 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
1014 if resolved_reciever
isa MNullableType then resolved_reciever
= resolved_reciever
.mtype
1015 if resolved_reciever
.as(MClassType).mclass
.kind
== enum_kind
then return res
1016 # 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.
1017 if res
isa MVirtualType then return res
1018 # 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
1019 if res
isa MClassType and res
.mclass
.kind
== enum_kind
then return res
1020 # TODO: Add 'fixed' virtual type in the specification.
1021 # TODO: What if bound to a MParameterType?
1022 # Note that Nullable types can always be redefined by the non nullable version, so there is no specific case on it.
1024 # If anything apply, then `self' cannot be resolved, so return self
1028 redef fun to_s
do return self.mproperty
.to_s
1030 init(mproperty
: MProperty)
1032 self.mproperty
= mproperty
1036 # The type associated the a formal parameter generic type of a class
1038 # Each parameter type is associated to a specific class.
1039 # It's mean that all refinements of a same class "share" the parameter type,
1040 # but that a generic subclass has its on parameter types.
1042 # However, in the sense of the meta-model, the a parameter type of a class is
1043 # a valid types in a subclass. The "in the sense of the meta-model" is
1044 # important because, in the Nit language, the programmer cannot refers
1045 # directly to the parameter types of the super-classes.
1049 # fun e: E is abstract
1054 # In the class definition B[F], `F' is a valid type but `E' is not.
1055 # However, `self.e' is a valid method call, and the signature of `e' is
1058 # Note that parameter types are shared among class refinements.
1059 # Therefore parameter only have an internal name (see `to_s' for details).
1060 # TODO: Add a 'name_for' to get better messages.
1061 class MParameterType
1064 # The generic class where the parameter belong
1067 redef fun model
do return self.mclass
.intro_mmodule
.model
1069 # The position of the parameter (0 for the first parameter)
1070 # FIXME: is `position' a better name?
1073 # Internal name of the parameter type
1074 # Names of parameter types changes in each class definition
1075 # Therefore, this method return an internal name.
1076 # Example: return "G#1" for the second parameter of the class G
1077 # FIXME: add a way to get the real name in a classdef
1078 redef fun to_s
do return "{mclass}#{rank}"
1080 # Resolve the bound for a given resolved_receiver
1081 # The result may be a other virtual type (or a parameter type)
1082 fun lookup_bound
(mmodule
: MModule, resolved_receiver
: MType): MType
1084 assert not resolved_receiver
.need_anchor
1085 var goalclass
= self.mclass
1086 var supertypes
= resolved_receiver
.collect_mtypes
(mmodule
)
1087 for t
in supertypes
do
1088 if t
.mclass
== goalclass
then
1089 # Yeah! c specialize goalclass with a "super `t'". So the question is what is the argument of f
1090 # FIXME: Here, we stop on the first goal. Should we check others and detect inconsistencies?
1091 var res
= t
.arguments
[self.rank
]
1098 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1100 #print "{class_name}: {self}/{mtype}/{anchor}?"
1102 if mtype
isa MGenericType and mtype
.mclass
== self.mclass
then
1103 return mtype
.arguments
[self.rank
]
1106 # self is a parameter type of mtype (or of a super-class of mtype)
1107 # The point of the function it to get the bound of the virtual type that make sense for mtype
1108 # But because mtype is maybe a virtual/formal type, we need to get a real receiver first
1109 # FIXME: What happend here is far from clear. Thus this part must be validated and clarified
1110 var resolved_receiver
= mtype
.resolve_for
(anchor
.mclass
.mclass_type
, anchor
, mmodule
, true)
1111 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1112 if resolved_receiver
isa MParameterType then
1113 assert resolved_receiver
.mclass
== anchor
.mclass
1114 resolved_receiver
= anchor
.arguments
[resolved_receiver
.rank
]
1115 if resolved_receiver
isa MNullableType then resolved_receiver
= resolved_receiver
.mtype
1117 assert resolved_receiver
isa MClassType else print
"{class_name}: {self}/{mtype}/{anchor}? {resolved_receiver}"
1119 # Eh! The parameter is in the current class.
1120 # So we return the corresponding argument, no mater what!
1121 if resolved_receiver
.mclass
== self.mclass
then
1122 var res
= resolved_receiver
.arguments
[self.rank
]
1123 #print "{class_name}: {self}/{mtype}/{anchor} -> direct {res}"
1127 resolved_receiver
= resolved_receiver
.resolve_for
(anchor
, anchor
, mmodule
, false)
1128 # Now, we can get the bound
1129 var verbatim_bound
= lookup_bound
(mmodule
, resolved_receiver
)
1130 # The bound is exactly as declared in the "type" property, so we must resolve it again
1131 var res
= verbatim_bound
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1133 #print "{class_name}: {self}/{mtype}/{anchor} -> indirect {res}"
1138 init(mclass
: MClass, rank
: Int)
1140 self.mclass
= mclass
1145 # A type prefixed with "nullable"
1146 # FIXME Stub implementation
1150 # The base type of the nullable type
1153 redef fun model
do return self.mtype
.model
1160 redef fun to_s
do return "nullable {mtype}"
1162 redef fun need_anchor
do return mtype
.need_anchor
1163 redef fun as_nullable
do return self
1164 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1166 var res
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1167 return res
.as_nullable
1170 redef fun depth
do return self.mtype
.depth
1172 redef fun collect_mclassdefs
(mmodule
)
1174 assert not self.need_anchor
1175 return self.mtype
.collect_mclassdefs
(mmodule
)
1178 redef fun collect_mclasses
(mmodule
)
1180 assert not self.need_anchor
1181 return self.mtype
.collect_mclasses
(mmodule
)
1184 redef fun collect_mtypes
(mmodule
)
1186 assert not self.need_anchor
1187 return self.mtype
.collect_mtypes
(mmodule
)
1191 # The type of the only value null
1193 # The is only one null type per model, see `MModel::null_type'.
1196 redef var model
: Model
1197 protected init(model
: Model)
1201 redef fun to_s
do return "null"
1202 redef fun as_nullable
do return self
1203 redef fun need_anchor
do return false
1204 redef fun resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
) do return self
1206 redef fun collect_mclassdefs
(mmodule
) do return new HashSet[MClassDef]
1208 redef fun collect_mclasses
(mmodule
) do return new HashSet[MClass]
1210 redef fun collect_mtypes
(mmodule
) do return new HashSet[MClassType]
1213 # A signature of a method (or a closure)
1217 # The each parameter (in order)
1218 var mparameters
: Array[MParameter]
1220 var mclosures
= new Array[MParameter]
1222 # The return type (null for a procedure)
1223 var return_mtype
: nullable MType
1228 var t
= self.return_mtype
1229 if t
!= null then dmax
= t
.depth
1230 for p
in mparameters
do
1231 var d
= p
.mtype
.depth
1232 if d
> dmax
then dmax
= d
1234 for p
in mclosures
do
1235 var d
= p
.mtype
.depth
1236 if d
> dmax
then dmax
= d
1241 # REQUIRE: 1 <= mparameters.count p -> p.is_vararg
1242 init(mparameters
: Array[MParameter], return_mtype
: nullable MType)
1244 var vararg_rank
= -1
1245 for i
in [0..mparameters
.length
[ do
1246 var parameter
= mparameters
[i
]
1247 if parameter
.is_vararg
then
1248 assert vararg_rank
== -1
1252 self.mparameters
= mparameters
1253 self.return_mtype
= return_mtype
1254 self.vararg_rank
= vararg_rank
1257 # The rank of the ellipsis (...) for vararg (starting from 0).
1258 # value is -1 if there is no vararg.
1259 # Example: for "(a: Int, b: Bool..., c: Char)" #-> vararg_rank=1
1260 var vararg_rank
: Int
1262 # The number or parameters
1263 fun arity
: Int do return mparameters
.length
1268 if not mparameters
.is_empty
then
1270 for i
in [0..mparameters
.length
[ do
1271 var mparameter
= mparameters
[i
]
1272 if i
> 0 then b
.append
(", ")
1273 b
.append
(mparameter
.name
)
1275 b
.append
(mparameter
.mtype
.to_s
)
1276 if mparameter
.is_vararg
then
1282 var ret
= self.return_mtype
1290 redef fun resolve_for
(mtype
: MType, anchor
: MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MSignature
1292 var params
= new Array[MParameter]
1293 for p
in self.mparameters
do
1294 params
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1296 var ret
= self.return_mtype
1298 ret
= ret
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1300 var res
= new MSignature(params
, ret
)
1301 for p
in self.mclosures
do
1302 res
.mclosures
.add
(p
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
))
1308 # A parameter in a signature
1310 # The name of the parameter
1313 # The static type of the parameter
1316 # Is the parameter a vararg?
1319 fun resolve_for
(mtype
: MType, anchor
: MClassType, mmodule
: MModule, cleanup_virtual
: Bool): MParameter
1321 if not self.mtype
.need_anchor
then return self
1322 var newtype
= self.mtype
.resolve_for
(mtype
, anchor
, mmodule
, cleanup_virtual
)
1323 var res
= new MParameter(self.name
, newtype
, self.is_vararg
)
1328 # A service (global property) that generalize method, attribute, etc.
1330 # MProperty are global to the model; it means that a MProperty is not bound
1331 # to a specific `MModule` nor a specific `MClass`.
1333 # A MProperty gather definitions (see `mpropdefs') ; one for the introduction
1334 # and the other in subclasses and in refinements.
1336 # A MProperty is used to denotes services in polymorphic way (ie. independent
1337 # of any dynamic type).
1338 # For instance, a call site "x.foo" is associated to a MProperty.
1339 abstract class MProperty
1340 # The associated MPropDef subclass.
1341 # The two specialization hierarchy are symmetric.
1342 type MPROPDEF: MPropDef
1344 # The classdef that introduce the property
1345 # While a property is not bound to a specific module, or class,
1346 # the introducing mclassdef is used for naming and visibility
1347 var intro_mclassdef
: MClassDef
1349 # The (short) name of the property
1352 # The canonical name of the property
1353 # Example: "owner::my_module::MyClass::my_method"
1354 fun full_name
: String
1356 return "{self.intro_mclassdef.mmodule.full_name}::{self.intro_mclassdef.mclass.name}::{name}"
1359 # The visibility of the property
1360 var visibility
: MVisibility
1362 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1364 self.intro_mclassdef
= intro_mclassdef
1366 self.visibility
= visibility
1367 intro_mclassdef
.intro_mproperties
.add
(self)
1368 var model
= intro_mclassdef
.mmodule
.model
1369 model
.mproperties_by_name
.add_one
(name
, self)
1370 model
.mproperties
.add
(self)
1373 # All definitions of the property.
1374 # The first is the introduction,
1375 # The other are redefinitions (in refinements and in subclasses)
1376 var mpropdefs
: Array[MPROPDEF] = new Array[MPROPDEF]
1378 # The definition that introduced the property
1379 # Warning: the introduction is the first `MPropDef' object
1380 # associated to self. If self is just created without having any
1381 # associated definition, this method will abort
1382 fun intro
: MPROPDEF do return mpropdefs
.first
1385 redef fun to_s
do return name
1387 # Return the most specific property definitions defined or inherited by a type.
1388 # The selection knows that refinement is stronger than specialization;
1389 # however, in case of conflict more than one property are returned.
1390 # If mtype does not know mproperty then an empty array is returned.
1392 # If you want the really most specific property, then look at `lookup_first_definition`
1393 fun lookup_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1395 assert not mtype
.need_anchor
1396 if mtype
isa MNullableType then mtype
= mtype
.mtype
1398 var cache
= self.lookup_definitions_cache
[mmodule
, mtype
]
1399 if cache
!= null then return cache
1401 #print "select prop {mproperty} for {mtype} in {self}"
1402 # First, select all candidates
1403 var candidates
= new Array[MPROPDEF]
1404 for mpropdef
in self.mpropdefs
do
1405 # If the definition is not imported by the module, then skip
1406 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1407 # If the definition is not inherited by the type, then skip
1408 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1410 candidates
.add
(mpropdef
)
1412 # Fast track for only one candidate
1413 if candidates
.length
<= 1 then
1414 self.lookup_definitions_cache
[mmodule
, mtype
] = candidates
1418 # Second, filter the most specific ones
1419 var res
= new Array[MPROPDEF]
1420 for pd1
in candidates
do
1421 var cd1
= pd1
.mclassdef
1424 for pd2
in candidates
do
1425 if pd2
== pd1
then continue # do not compare with self!
1426 var cd2
= pd2
.mclassdef
1428 if c2
.mclass_type
== c1
.mclass_type
then
1429 if cd2
.mmodule
.in_importation
<= cd1
.mmodule
then
1430 # cd2 refines cd1; therefore we skip pd1
1434 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) then
1435 # cd2 < cd1; therefore we skip pd1
1444 if res
.is_empty
then
1445 print
"All lost! {candidates.join(", ")}"
1446 # FIXME: should be abort!
1448 self.lookup_definitions_cache
[mmodule
, mtype
] = res
1452 private var lookup_definitions_cache
: HashMap2[MModule, MType, Array[MPROPDEF]] = new HashMap2[MModule, MType, Array[MPROPDEF]]
1454 # Return the most specific property definitions inherited by a type.
1455 # The selection knows that refinement is stronger than specialization;
1456 # however, in case of conflict more than one property are returned.
1457 # If mtype does not know mproperty then an empty array is returned.
1459 # If you want the really most specific property, then look at `lookup_next_definition`
1461 # FIXME: Move to MPropDef?
1462 fun lookup_super_definitions
(mmodule
: MModule, mtype
: MType): Array[MPropDef]
1464 assert not mtype
.need_anchor
1465 if mtype
isa MNullableType then mtype
= mtype
.mtype
1467 # First, select all candidates
1468 var candidates
= new Array[MPropDef]
1469 for mpropdef
in self.mpropdefs
do
1470 # If the definition is not imported by the module, then skip
1471 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1472 # If the definition is not inherited by the type, then skip
1473 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1474 # If the definition is defined by the type, then skip (we want the super, so e skip the current)
1475 if mtype
== mpropdef
.mclassdef
.bound_mtype
and mmodule
== mpropdef
.mclassdef
.mmodule
then continue
1477 candidates
.add
(mpropdef
)
1479 # Fast track for only one candidate
1480 if candidates
.length
<= 1 then return candidates
1482 # Second, filter the most specific ones
1483 var res
= new Array[MPropDef]
1484 for pd1
in candidates
do
1485 var cd1
= pd1
.mclassdef
1488 for pd2
in candidates
do
1489 if pd2
== pd1
then continue # do not compare with self!
1490 var cd2
= pd2
.mclassdef
1492 if c2
.mclass_type
== c1
.mclass_type
then
1493 if cd2
.mmodule
.in_importation
<= cd1
.mmodule
then
1494 # cd2 refines cd1; therefore we skip pd1
1498 else if cd2
.bound_mtype
.is_subtype
(mmodule
, null, cd1
.bound_mtype
) then
1499 # cd2 < cd1; therefore we skip pd1
1508 if res
.is_empty
then
1509 print
"All lost! {candidates.join(", ")}"
1510 # FIXME: should be abort!
1515 # Return the most specific definition in the linearization of `mtype`.
1517 # If you want to know the next properties in the linearization,
1518 # look at `MPropDef::lookup_next_definition`.
1520 # FIXME: the linearisation is still unspecified
1522 # REQUIRE: not mtype.need_anchor
1523 # REQUIRE: mtype.has_mproperty(mmodule, self)
1524 fun lookup_first_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1526 return lookup_all_definitions
(mmodule
, mtype
).first
1529 # Return all definitions in a linearisation order
1530 # Most speficic first, most general last
1531 fun lookup_all_definitions
(mmodule
: MModule, mtype
: MType): Array[MPROPDEF]
1533 assert not mtype
.need_anchor
1534 if mtype
isa MNullableType then mtype
= mtype
.mtype
1536 var cache
= self.lookup_all_definitions_cache
[mmodule
, mtype
]
1537 if cache
!= null then return cache
1539 #print "select prop {mproperty} for {mtype} in {self}"
1540 # First, select all candidates
1541 var candidates
= new Array[MPROPDEF]
1542 for mpropdef
in self.mpropdefs
do
1543 # If the definition is not imported by the module, then skip
1544 if not mmodule
.in_importation
<= mpropdef
.mclassdef
.mmodule
then continue
1545 # If the definition is not inherited by the type, then skip
1546 if not mtype
.is_subtype
(mmodule
, null, mpropdef
.mclassdef
.bound_mtype
) then continue
1548 candidates
.add
(mpropdef
)
1550 # Fast track for only one candidate
1551 if candidates
.length
<= 1 then
1552 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1556 mmodule
.linearize_mpropdefs
(candidates
)
1557 candidates
= candidates
.reversed
1558 self.lookup_all_definitions_cache
[mmodule
, mtype
] = candidates
1562 private var lookup_all_definitions_cache
: HashMap2[MModule, MType, Array[MPROPDEF]] = new HashMap2[MModule, MType, Array[MPROPDEF]]
1569 redef type MPROPDEF: MMethodDef
1571 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1576 # Is the property a constructor?
1577 # Warning, this property can be inherited by subclasses with or without being a constructor
1578 # therefore, you should use `is_init_for' the verify if the property is a legal constructor for a given class
1579 var is_init
: Bool writable = false
1581 # The the property a 'new' contructor?
1582 var is_new
: Bool writable = false
1584 # Is the property a legal constructor for a given class?
1585 # As usual, visibility is not considered.
1586 # FIXME not implemented
1587 fun is_init_for
(mclass
: MClass): Bool
1593 # A global attribute
1597 redef type MPROPDEF: MAttributeDef
1599 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1605 # A global virtual type
1606 class MVirtualTypeProp
1609 redef type MPROPDEF: MVirtualTypeDef
1611 init(intro_mclassdef
: MClassDef, name
: String, visibility
: MVisibility)
1616 # The formal type associated to the virtual type property
1617 var mvirtualtype
: MVirtualType = new MVirtualType(self)
1620 # A definition of a property (local property)
1622 # Unlike MProperty, a MPropDef is a local definition that belong to a
1623 # specific class definition (which belong to a specific module)
1624 abstract class MPropDef
1626 # The associated MProperty subclass.
1627 # the two specialization hierarchy are symmetric
1628 type MPROPERTY: MProperty
1631 type MPROPDEF: MPropDef
1633 # The origin of the definition
1634 var location
: Location
1636 # The class definition where the property definition is
1637 var mclassdef
: MClassDef
1639 # The associated global property
1640 var mproperty
: MPROPERTY
1642 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1644 self.mclassdef
= mclassdef
1645 self.mproperty
= mproperty
1646 self.location
= location
1647 mclassdef
.mpropdefs
.add
(self)
1648 mproperty
.mpropdefs
.add
(self)
1651 # Internal name combining the module, the class and the property
1652 # Example: "mymodule#MyClass#mymethod"
1655 return "{mclassdef}#{mproperty}"
1658 # Is self the definition that introduce the property?
1659 fun is_intro
: Bool do return mproperty
.intro
== self
1661 # Return the next definition in linearization of `mtype`.
1663 # This method is used to determine what method is called by a super.
1665 # FIXME: IMPLEMENTED AS A static designation, it is ugly
1667 # REQUIRE: not mtype.need_anchor
1668 fun lookup_next_definition
(mmodule
: MModule, mtype
: MType): MPROPDEF
1670 assert not mtype
.need_anchor
1672 var mpropdefs
= self.mproperty
.lookup_all_definitions
(mmodule
, mtype
)
1673 var i
= mpropdefs
.iterator
1674 while i
.is_ok
and i
.item
!= self do i
.next
1675 assert has_property
: i
.is_ok
1677 assert has_next_property
: i
.is_ok
1682 # A local definition of a method
1686 redef type MPROPERTY: MMethod
1687 redef type MPROPDEF: MMethodDef
1689 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1694 # The signature attached to the property definition
1695 var msignature
: nullable MSignature writable = null
1698 # A local definition of an attribute
1702 redef type MPROPERTY: MAttribute
1703 redef type MPROPDEF: MAttributeDef
1705 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1710 # The static type of the attribute
1711 var static_mtype
: nullable MType writable = null
1714 # A local definition of a virtual type
1715 class MVirtualTypeDef
1718 redef type MPROPERTY: MVirtualTypeProp
1719 redef type MPROPDEF: MVirtualTypeDef
1721 init(mclassdef
: MClassDef, mproperty
: MPROPERTY, location
: Location)
1726 # The bound of the virtual type
1727 var bound
: nullable MType writable = null
1738 # Note this class is basically an enum.
1739 # FIXME: use a real enum once user-defined enums are available
1741 redef var to_s
: String
1743 # Is a constructor required?
1745 private init(s
: String, need_init
: Bool)
1748 self.need_init
= need_init
1752 fun abstract_kind
: MClassKind do return once
new MClassKind("abstract class", true)
1753 fun concrete_kind
: MClassKind do return once
new MClassKind("class", true)
1754 fun interface_kind
: MClassKind do return once
new MClassKind("interface", false)
1755 fun enum_kind
: MClassKind do return once
new MClassKind("enum", false)
1756 fun extern_kind
: MClassKind do return once
new MClassKind("extern", false)