model: intro `MModule::first_real_mmodule` to get the first non-fictive module

[nit.git] / src / model / mmodule.nit

diff --git a/src/model/mmodule.nit b/src/model/mmodule.nit
index c634815..ef548a8 100644 (file)
--- a/src/model/mmodule.nit
+++ b/src/model/mmodule.nit
@@ -76,6 +76,14 @@ class MModule
        # 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
 
@@ -88,10 +96,14 @@ class MModule
        # The view of the module in the `model.mmodule_importation_hierarchy`
        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
@@ -100,6 +112,49 @@ class MModule
                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
        do
@@ -111,12 +166,6 @@ class MModule
                                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 potential owner is the default_mmodule of the parent group
-                               if mgroup.parent != null then direct_owner = mgroup.parent.default_mmodule
-                       end
                end
                self.in_importation = model.mmodule_importation_hierarchy.add_node(self)
        end
@@ -191,5 +240,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