1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Modelisation of a Nit package
19 private import more_collections
23 # A Nit package, that encompass a product
27 # The name of the package
30 redef fun full_name
do return name
32 redef var c_name
= name
.to_cmangle
is lazy
34 # The model of the package
39 # The root of the group tree
40 var root
: nullable MGroup = null is writable
42 # The group tree, as a POSet
43 var mgroups
= new POSet[MGroup]
45 redef fun to_s
do return name
49 model
.mpackages
.add
(self)
50 model
.mpackage_by_name
.add_one
(name
, self)
53 # MPackage are always roots of the concerns hierarchy
54 redef fun parent_concern
do return null
56 redef fun mdoc_or_fallback
59 if mdoc
!= null then return mdoc
61 if root
!= null then return root
.mdoc_or_fallback
66 # A group of modules in a package
70 # The name of the group
71 # empty name for a default group in a single-module package
76 # The enclosing package
77 var mpackage
: MPackage
79 # The parent group if any
80 # see `in_nesting` for more
81 var parent
: nullable MGroup
83 # Fully qualified name.
84 # It includes each parent group separated by `>`.
85 # The full_name is terminated by `>` to avoid collision with other entities.
87 # E.g. `core>` and `core>collection>`
91 if p
== null then return "{name}>"
92 return "{p.full_name}{name}>"
95 # The group is the group tree on the package (`mpackage.mgroups`)
96 # nested groups (children) are smaller
97 # nesting group (see `parent`) is bigger
98 var in_nesting
: POSetElement[MGroup] is noinit
100 # Is `self` the root of its package?
101 fun is_root
: Bool do return mpackage
.root
== self
103 # The filepath (usually a directory) of the group, if any
105 # safe alias to `location.file.filename`
106 fun filepath
: nullable String do
108 res
= self.location
.file
109 if res
== null then return null
115 var tree
= mpackage
.mgroups
116 self.in_nesting
= tree
.add_node
(self)
117 var parent
= self.parent
118 if parent
!= null then
119 tree
.add_edge
(self, parent
)
123 redef fun model
do return mpackage
.model
125 redef fun parent_concern
do
126 if not is_root
then return parent
130 redef fun to_s
do return name
134 # packages of the model
135 var mpackages
= new Array[MPackage]
137 # Collections of package grouped by their names
138 private var mpackage_by_name
= new MultiHashMap[String, MPackage]
140 # Return all package named `name`
141 # If such a package is not yet loaded, null is returned (instead of an empty array)
142 fun get_mpackages_by_name
(name
: String): nullable Array[MPackage]
144 if mpackage_by_name
.has_key
(name
) then
145 return mpackage_by_name
[name
]