X-Git-Url: http://nitlanguage.org diff --git a/src/model/mmodule.nit b/src/model/mmodule.nit index a92d065..c637c41 100644 --- a/src/model/mmodule.nit +++ b/src/model/mmodule.nit @@ -18,21 +18,19 @@ module mmodule import location -import mproject +import mpackage private import more_collections # The container class of a Nit object-oriented model. +# # A model knows modules, classes and properties and can retrieve them. +# +# However, a model is not a program or a library as it can contains modules +# found by the system (including broken ones) but not used. redef class Model # 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] @@ -67,6 +65,7 @@ redef class MGroup redef fun mdoc_or_fallback do if mdoc != null then return mdoc + var default_mmodule = self.default_mmodule if default_mmodule == null then return null return default_mmodule.mdoc_or_fallback end @@ -79,9 +78,17 @@ class MModule # The model considered redef var model: Model - # The group of module in the project if any + # The group of module in the package if any var mgroup: nullable MGroup + # The package of the module if any + # Safe alias for `mgroup.mpackage` + fun mpackage: nullable MPackage + do + var g = mgroup + if g == null then return null else return g.mpackage + end + # The short name of the module redef var name: String @@ -91,24 +98,65 @@ class MModule # 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] is noinit - # The view of the module in the `model.mmodule_importation_hierarchy` var in_importation: POSetElement[MModule] is noinit - # The canonical name of the module - # Example: `"project::name"` - fun full_name: String - do + # The canonical name of the module. + # + # It is usually the `name` prefixed by the package's name. + # Example: `"package::name"` + # + # If both names are the same (of if the module is package-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 + if mgroup == null or mgroup.mpackage.name == self.name then return self.name else - return "{mgroup.mproject.name}::{self.name}" + return "{mgroup.mpackage.name}::{self.name}" + end + end + + # The namespace used for entities according to their visibility `v`. + # + # Public entities use only the package as a namespace. + # Private entities use the `full_name` (i.e. "package::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.mpackage.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.mpackage.name != name then + res = g.mpackage.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.mpackage.c_name end end @@ -117,37 +165,21 @@ class MModule do model.mmodules_by_name.add_one(name, self) model.mmodules.add(self) - self.in_nesting = model.mmodule_nesting_hierarchy.add_node(self) + var mgroup = self.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 # Register the imported modules (ie "import some_module") - # This function can only invoked once by mmodule. # The visibility must be set with `set_visibility_for`. fun set_imported_mmodules(imported_mmodules: Array[MModule]) do - assert unique_invocation: self.in_importation.direct_greaters.is_empty for m in imported_mmodules do self.model.mmodule_importation_hierarchy.add_edge(self, m) end @@ -212,5 +244,18 @@ class MModule # 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