1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2008 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 # Model exploration and traversing facilities
23 # Get the list of mclasses refined in 'self'.
24 fun redef_mclasses
: Set[MClass] do
25 var mclasses
= new HashSet[MClass]
26 for c
in mclassdefs
do
27 if not c
.is_intro
then mclasses
.add
(c
.mclass
)
32 # Get the list of all mclasses imported by 'self'.
33 fun imported_mclasses
: Set[MClass] do
34 var mclasses
= new HashSet[MClass]
35 for m
in in_importation
.greaters
do
36 if m
== self then continue
37 for c
in m
.mclassdefs
do mclasses
.add
(c
.mclass
)
45 # Get the public owner of 'self'.
46 fun public_owner
: MModule do
47 var public_owner
= self.intro_mmodule
.public_owner
48 if public_owner
== null then
49 return self.intro_mmodule
55 # Get direct parents of 'self'.
56 fun parents
: Set[MClass] do
57 var ret
= new HashSet[MClass]
58 for mclassdef
in mclassdefs
do
59 for mclasstype
in mclassdef
.supertypes
do
60 ret
.add
(mclasstype
.mclass
)
66 # Get all ancestors of 'self'.
67 fun ancestors
: Set[MClass] do
68 var lst
= new HashSet[MClass]
69 for mclassdef
in self.mclassdefs
do
70 for super_mclassdef
in mclassdef
.in_hierarchy
.greaters
do
71 if super_mclassdef
== mclassdef
then continue # skip self
72 lst
.add
(super_mclassdef
.mclass
)
78 # Get direct children of 'self'.
79 fun children
: Set[MClass] do
80 var lst
= new HashSet[MClass]
81 for mclassdef
in self.mclassdefs
do
82 for sub_mclassdef
in mclassdef
.in_hierarchy
.direct_smallers
do
83 if sub_mclassdef
== mclassdef
then continue # skip self
84 lst
.add
(sub_mclassdef
.mclass
)
90 # Get all children of 'self'.
91 fun descendants
: Set[MClass] do
92 var lst
= new HashSet[MClass]
93 for mclassdef
in self.mclassdefs
do
94 for sub_mclassdef
in mclassdef
.in_hierarchy
.smallers
do
95 if sub_mclassdef
== mclassdef
then continue # skip self
96 lst
.add
(sub_mclassdef
.mclass
)
102 # Get the list of constructors available for 'self'.
103 fun constructors
: Set[MMethod] do
104 var res
= new HashSet[MMethod]
105 for mclassdef
in mclassdefs
do
106 for mpropdef
in mclassdef
.mpropdefs
do
107 if mpropdef
isa MMethodDef then
108 if mpropdef
.mproperty
.is_init
then res
.add
(mpropdef
.mproperty
)
115 # Get the list of methods introduced in 'self'.
116 fun intro_methods
: Set[MMethod] do
117 var res
= new HashSet[MMethod]
118 for mclassdef
in mclassdefs
do
119 for mpropdef
in mclassdef
.mpropdefs
do
120 if mpropdef
isa MMethodDef then
121 if mpropdef
.is_intro
and not mpropdef
.mproperty
.is_init
then res
.add
(mpropdef
.mproperty
)
128 # the set of properties introduced in 'self'.
129 fun intro_mproperties
(min_visibility
: MVisibility): Set[MProperty] do
130 var set
= new HashSet[MProperty]
131 for mclassdef
in mclassdefs
do
132 for mprop
in mclassdef
.intro_mproperties
do
133 if mprop
.visibility
< min_visibility
then continue
140 # the set of locally refined properties in 'self'.
141 fun redef_mproperties
(min_visibility
: MVisibility): Set[MProperty] do
142 var set
= new HashSet[MProperty]
143 for mclassdef
in mclassdefs
do
144 for mpropdef
in mclassdef
.mpropdefs
do
145 if mpropdef
.mproperty
.visibility
< min_visibility
then continue
146 if mpropdef
.mproperty
.intro_mclassdef
.mclass
!= self then set
.add
(mpropdef
.mproperty
)
152 # the set of methods inherited by 'self'.
153 fun inherited_mproperties
(mainmodule
: MModule, min_visibility
: MVisibility): Set[MProperty] do
154 var set
= new HashSet[MProperty]
155 for parent
in in_hierarchy
(mainmodule
).direct_greaters
do
156 set
.add_all
(parent
.intro_mproperties
(min_visibility
))
157 set
.add_all
(parent
.inherited_mproperties
(mainmodule
, min_visibility
))
162 # the set of introduced and redefined mproperties
163 fun local_mproperties
(min_visibility
: MVisibility): Set[MProperty] do
164 var set
= new HashSet[MProperty]
165 set
.add_all
(intro_mproperties
(min_visibility
))
166 set
.add_all
(redef_mproperties
(min_visibility
))
170 # the set of all accessible mproperties for this class
171 fun all_mproperties
(mainmodule
: MModule, min_visibility
: MVisibility): Set[MProperty] do
172 var set
= new HashSet[MProperty]
173 set
.add_all
(local_mproperties
(min_visibility
))
174 set
.add_all
(inherited_mproperties
(mainmodule
, min_visibility
))
178 # the set of all accessible mattributes for this class
179 fun all_mattributes
(mainmodule
: MModule, min_visibility
: MVisibility): Set[MAttribute] do
180 var set
= new HashSet[MAttribute]
181 for mprop
in all_mproperties
(mainmodule
, min_visibility
) do
182 if mprop
isa MAttribute then set
.add
(mprop
)
187 # Get the list of locally refined methods in 'self'.
188 fun redef_methods
: Set[MMethod] do
189 var res
= new HashSet[MMethod]
190 for mclassdef
in mclassdefs
do
191 for mpropdef
in mclassdef
.mpropdefs
do
192 if mpropdef
isa MMethodDef then
193 if not mpropdef
.is_intro
and not mpropdef
.mproperty
.is_init
then res
.add
(mpropdef
.mproperty
)
200 fun inherited_methods
: Set[MMethod] do
201 var res
= new HashSet[MMethod]
202 for s
in ancestors
do
203 for m
in s
.intro_methods
do
204 if not self.intro_methods
.has
(m
) and not self.redef_methods
.has
(m
) then res
.add
(m
)
210 # Get the list of all virtual types available in 'self'.
211 fun virtual_types
: Set[MVirtualTypeProp] do
212 var res
= new HashSet[MVirtualTypeProp]
213 for mclassdef
in mclassdefs
do
214 for mpropdef
in mclassdef
.mpropdefs
do
215 if mpropdef
isa MVirtualTypeDef then
216 res
.add
(mpropdef
.mproperty
)
220 for ancestor
in ancestors
do
221 for mclassdef
in ancestor
.mclassdefs
do
222 for mpropdef
in mclassdef
.mpropdefs
do
223 if mpropdef
isa MVirtualTypeDef then
224 res
.add
(mpropdef
.mproperty
)
232 # Get the list of all parameter types in 'self'.
233 fun parameter_types
: Map[String, MType] do
234 var res
= new HashMap[String, MType]
235 for i
in [0..intro
.parameter_names
.length
[ do
236 res
[intro
.parameter_names
[i
]] = intro
.bound_mtype
.arguments
[i
]
241 fun is_class
: Bool do
242 return self.kind
== concrete_kind
or self.kind
== abstract_kind
245 fun is_interface
: Bool do
246 return self.kind
== interface_kind
250 return self.kind
== enum_kind
253 fun is_abstract
: Bool do
254 return self.kind
== abstract_kind
258 redef class MAttribute
259 # Is this attribute nullable for sure?
261 # This mean that its introduction is declarred with a nullable static type
262 # since attributes are invariant this will work on most cases
263 # attributes with static type anchored with a virtual type are not "nullable for-sure"
264 # because this type can be redefined in subclasses
265 fun is_nullable
: Bool do return intro
.static_mtype
isa MNullableType
270 # Sort mmodules by their name
271 class MModuleNameSorter
272 super AbstractSorter[MModule]
273 redef fun compare
(a
, b
) do return a
.name
<=> b
.name
277 # Sort mclasses by their name
278 class MClassNameSorter
279 super AbstractSorter[MClass]
280 redef fun compare
(a
, b
) do return a
.name
<=> b
.name
284 # Sort mclassdefs by their name
285 class MClassDefNameSorter
286 super AbstractSorter[MClassDef]
287 redef fun compare
(a
, b
) do return a
.mclass
.name
<=> b
.mclass
.name
291 # Sort mproperties by their name
292 class MPropertyNameSorter
293 super AbstractSorter[MProperty]
294 redef fun compare
(a
, b
) do return a
.name
<=> b
.name
298 # Sort mpropdefs by their name
299 class MPropDefNameSorter
300 super AbstractSorter[MPropDef]
301 redef fun compare
(a
, b
) do return a
.mproperty
.name
<=> b
.mproperty
.name