# All known modules
var mmodules = new Array[MModule]
- # placebo for old module nesting hierarchy.
- # where mainmodule < mainmodule::nestedmodule
- #
- # TODO REMOVE, rely on mgroup instead
- var mmodule_nesting_hierarchy = new POSet[MModule]
-
# Full module importation hierarchy including private or nested links.
var mmodule_importation_hierarchy = new POSet[MModule]
# Return `null` if the group has no default module or if the default
# module is not loaded.
var default_mmodule: nullable MModule = null
+
+ redef fun mdoc_or_fallback
+ do
+ if mdoc != null then return mdoc
+ if default_mmodule == null then return null
+ return default_mmodule.mdoc_or_fallback
+ end
end
# A Nit module is usually associated with a Nit source file.
# The group of module in the project if any
var mgroup: nullable MGroup
+ # The project of the module if any
+ # Safe alias for `mgroup.mproject`
+ fun mproject: nullable MProject
+ do
+ var g = mgroup
+ if g == null then return null else return g.mproject
+ end
+
# The short name of the module
redef var name: String
# Alias for `name`
redef fun to_s do return self.name
- # placebo for old module nesting hierarchy
- # The view of the module in the `model.mmodule_nesting_hierarchy`
- #
- # TODO REMOVE, rely on mgroup instead
- var in_nesting: POSetElement[MModule]
-
# The view of the module in the `model.mmodule_importation_hierarchy`
- var in_importation: POSetElement[MModule]
+ var in_importation: POSetElement[MModule] is noinit
- # The canonical name of the module
+ # The canonical name of the module.
+ #
+ # It is usually the `name` prefixed by the project's name.
# Example: `"project::name"`
- fun full_name: String
- do
+ #
+ # If both names are the same (of if the module is project-less), then
+ # the short-name is used alone.
+ redef var full_name is lazy do
var mgroup = self.mgroup
if mgroup == null or mgroup.mproject.name == self.name then
return self.name
end
end
+ # The namespace used for entities according to their visibility `v`.
+ #
+ # Public entities use only the project as a namespace.
+ # Private entities use the `full_name` (i.e. "project::module")
+ #
+ # This method is used by entities to implement their `full_name`.
+ fun namespace_for(v: MVisibility): String do
+ if v <= private_visibility then return full_name
+ var mgroup = self.mgroup
+ if mgroup == null then
+ return full_name
+ else
+ return mgroup.mproject.full_name
+ end
+ end
+
+ # Return the name of the global C identifier associated to `self`.
+ # This name is used to prefix files and other C identifiers associated with `self`.
+ redef var c_name: String is lazy do
+ var g = mgroup
+ var res
+ if g != null and g.mproject.name != name then
+ res = g.mproject.name.to_cmangle + "__" + name.to_cmangle
+ else
+ res = name.to_cmangle
+ end
+ return res
+ end
+
+ # C identifier version of `namespace_for`.
+ # See `c_name`
+ #
+ # This method is used by entities to implement their `c_name`.
+ fun c_namespace_for(v: MVisibility): String do
+ if v <= private_visibility then return c_name
+ var mgroup = self.mgroup
+ if mgroup == null then
+ return c_name
+ else
+ return mgroup.mproject.c_name
+ end
+ end
+
# Create a new empty module and register it to a model
- init(model: Model, mgroup: nullable MGroup, name: String, location: Location)
+ init
do
- self.model = model
- self.name = name
- self.location = location
model.mmodules_by_name.add_one(name, self)
model.mmodules.add(self)
- self.in_nesting = model.mmodule_nesting_hierarchy.add_node(self)
- self.mgroup = mgroup
if mgroup != null then
mgroup.mmodules.add(self)
if mgroup.name == name then
assert mgroup.default_mmodule == null
mgroup.default_mmodule = self
end
- # placebo for old module nesting hierarchy
- var direct_owner = mgroup.default_mmodule
- if direct_owner == self then
- # The module is the new owner of its own group, thus adopt the other modules
- for m in mgroup.mmodules do
- if m == self then continue
- model.mmodule_nesting_hierarchy.add_edge(self, m)
- end
- # The potential owner is the default_mmodule of the parent group
- if mgroup.parent != null then direct_owner = mgroup.parent.default_mmodule
- end
- if direct_owner != self and direct_owner != null then
- model.mmodule_nesting_hierarchy.add_edge(direct_owner, self)
- end
end
self.in_importation = model.mmodule_importation_hierarchy.add_node(self)
end
# exposed to the final user.
var is_fictive: Bool = false is writable
+ # Is `self` a unit test module used by `nitunit`?
+ var is_test_suite: Bool = false is writable
+
+ # Get the first non `is_fictive` module greater than self
+ fun first_real_mmodule: MModule
+ do
+ var mmodule = self
+ while mmodule.is_fictive do
+ mmodule = mmodule.in_importation.direct_greaters.first
+ end
+ return mmodule
+ end
+
redef fun parent_concern do return mgroup
end
nitlanguage / nit.git / blobdiff