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
28 redef var name
: String
30 redef fun full_name
do return name
32 redef var c_name
= name
.to_cmangle
is lazy
34 # The model of the package
35 redef var model
: Model
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
58 if mdoc
!= null then return mdoc
59 return root
.mdoc_or_fallback
63 # A group of modules in a package
67 # The name of the group
68 # empty name for a default group in a single-module package
69 redef var name
: String
73 # The enclosing package
74 var mpackage
: MPackage
76 # The parent group if any
77 # see `in_nesting` for more
78 var parent
: nullable MGroup
80 # Fully qualified name.
81 # It includes each parent group separated by `>`.
82 # The full_name is terminated by `>` to avoid collision with other entities.
84 # E.g. `core>` and `core>collection>`
88 if p
== null then return "{name}>"
89 return "{p.full_name}{name}>"
92 # The group is the group tree on the package (`mpackage.mgroups`)
93 # nested groups (children) are smaller
94 # nesting group (see `parent`) is bigger
95 var in_nesting
: POSetElement[MGroup] is noinit
97 # Is `self` the root of its package?
98 fun is_root
: Bool do return mpackage
.root
== self
100 # The filepath (usually a directory) of the group, if any
102 # safe alias to `location.file.filename`
103 fun filepath
: nullable String do
105 res
= self.location
.file
106 if res
== null then return null
112 var tree
= mpackage
.mgroups
113 self.in_nesting
= tree
.add_node
(self)
114 var parent
= self.parent
115 if parent
!= null then
116 tree
.add_edge
(self, parent
)
120 redef fun model
do return mpackage
.model
122 redef fun parent_concern
do
123 if not is_root
then return parent
127 redef fun to_s
do return name
131 # packages of the model
132 var mpackages
= new Array[MPackage]
134 # Collections of package grouped by their names
135 private var mpackage_by_name
= new MultiHashMap[String, MPackage]
137 # Return all package named `name`
138 # If such a package is not yet loaded, null is returned (instead of an empty array)
139 fun get_mpackages_by_name
(name
: String): nullable Array[MPackage]
141 if mpackage_by_name
.has_key
(name
) then
142 return mpackage_by_name
[name
]