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
65 # Does `self` have a source file?
66 fun has_source
: Bool do return location
.file
!= null
69 fun package_path
: nullable String do
70 if not has_source
then return null
71 return location
.file
.as(not null).filename
74 # Is `self` in its own directory?
75 fun is_expanded
: Bool do
76 var path
= package_path
77 if path
== null then return false
78 return not path
.has_suffix
(".nit")
81 # The path to `self` ini file
82 fun ini_path
: nullable String do
83 var path
= package_path
84 if path
== null then return null
85 if is_expanded
then return path
/ "package.ini"
86 return path
.dirname
/ "{name}.ini"
89 # Does `self` have a ini file?
91 var ini_path
= self.ini_path
92 if ini_path
== null then return false
93 return ini_path
.file_exists
96 # The path to `self` README.md
97 fun readme_path
: nullable String do
98 var path
= package_path
99 if path
== null then return null
100 if not is_expanded
then return null
101 return path
/ "README.md"
104 # Does `self` have a README.md file?
105 fun has_readme
: Bool do
106 var readme_path
= self.readme_path
107 if readme_path
== null then return false
108 return readme_path
.file_exists
112 # A group of modules in a package
116 # The name of the group
117 # empty name for a default group in a single-module package
122 # The enclosing package
123 var mpackage
: MPackage
125 # The parent group if any
126 # see `in_nesting` for more
127 var parent
: nullable MGroup
129 # Fully qualified name.
130 # It includes each parent group separated by `>`.
131 # The full_name is terminated by `>` to avoid collision with other entities.
133 # E.g. `core>` and `core>collection>`
137 if p
== null then return "{name}>"
138 return "{p.full_name}{name}>"
141 # The group is the group tree on the package (`mpackage.mgroups`)
142 # nested groups (children) are smaller
143 # nesting group (see `parent`) is bigger
144 var in_nesting
: POSetElement[MGroup] is noinit
146 # Is `self` the root of its package?
147 fun is_root
: Bool do return mpackage
.root
== self
149 # The filepath (usually a directory) of the group, if any
151 # safe alias to `location.file.filename`
152 fun filepath
: nullable String do
154 res
= self.location
.file
155 if res
== null then return null
161 var tree
= mpackage
.mgroups
162 self.in_nesting
= tree
.add_node
(self)
163 var parent
= self.parent
164 if parent
!= null then
165 tree
.add_edge
(self, parent
)
169 redef fun model
do return mpackage
.model
171 redef fun parent_concern
do
172 if not is_root
then return parent
176 redef fun to_s
do return name
180 # packages of the model
181 var mpackages
= new Array[MPackage]
183 # Collections of package grouped by their names
184 private var mpackage_by_name
= new MultiHashMap[String, MPackage]
186 # Return all package named `name`
187 # If such a package is not yet loaded, null is returned (instead of an empty array)
188 fun get_mpackages_by_name
(name
: String): nullable Array[MPackage]
190 if mpackage_by_name
.has_key
(name
) then
191 return mpackage_by_name
[name
]