Serializable::inspect
to show more useful information
more_collections :: more_collections
Highly specific, but useful, collections-related classes.serialization :: serialization_core
Abstract services to serialize Nit objects to different formatscore :: union_find
union–find algorithm using an efficient disjoint-set data structurenitc :: actors_generation_phase
Generate a support module for each module that contain a class annotated withis actor
nitc :: actors_injection_phase
Injects model for the classes annotated with "is actor" sonitc :: api_metrics
nitc :: astbuilder
Instantiation and transformation of semantic nodes in the AST of expressions and statementscflags
and ldflags
to specify
nitc :: commands_ini
nitc :: detect_variance_constraints
Collect metrics about detected variances constraints on formal types.extra_java_files
to compile extra java files
nitc :: i18n_phase
Basic support of internationalization through the generation of id-to-string tablesnitc :: light_only
Compiler support for the light FFI only, detects unsupported usage of callbacksnitc
.
nitc :: modelbuilder
nitc :: nitmetrics
A program that collects various metrics on nit programs and librariesnitc :: nitrestful
Tool generating boilerplate code linking RESTful actions to Nit methodsthreaded
annotation
nitc :: separate_erasure_compiler
Separate compilation of a Nit program with generic type erasurenitc :: serialization_code_gen_phase
Phase generating methods (code) to serialize Nit objectsnitc :: serialization_model_phase
Phase generating methods (model-only) to serialize Nit objectsclone
method of the astbuilder tool
nitc :: uml_module
Services for generation of a UML package diagram based on aModel
# modules and module hierarchies in the metamodel
module mmodule
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]
# Full module importation hierarchy including private or nested links.
var mmodule_importation_hierarchy = new POSet[MModule]
# Collections of modules grouped by their short names
private var mmodules_by_name = new MultiHashMap[String, MModule]
# Return all module named `name`
# If such a module does not exist, null is returned (instead of an empty array)
#
# Visibility or modules are not considered
fun get_mmodules_by_name(name: String): nullable Array[MModule]
do
if mmodules_by_name.has_key(name) then
return mmodules_by_name[name]
else
return null
end
end
end
redef class MGroup
# The loaded modules of this group
var mmodules = new Array[MModule]
# The default module of a group (if any, and if loaded)
#
# The default module of a group is the one that has the same name.
# 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
var default_mmodule = self.default_mmodule
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.
class MModule
super MConcern
# The model considered
redef var model
# The group of module in the package if any
var mgroup: nullable MGroup
# The path of the module source, if any
#
# safe alias to `location.file.filepath`
fun filepath: nullable String do
var res = self.location.file
if res == null then return null
return res.filename
end
# 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
redef var location is writable
# Alias for `name`
redef fun to_s do return self.name
# The view of the module in the `model.mmodule_importation_hierarchy`
var in_importation: POSetElement[MModule] is noinit
# The canonical name of the module.
#
# It is usually the `name` prefixed by the package's name.
# Example: `"package::name"`
#
# Default modules use a doubled name to distinguish them from the package name.
# E.g.: `"core::core"`
#
# 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 then
return self.name
else
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 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
# Create a new empty module and register it to a model
init
do
model.mmodules_by_name.add_one(name, self)
model.mmodules.add(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
end
self.in_importation = model.mmodule_importation_hierarchy.add_node(self)
end
# Register the imported modules (ie "import some_module") and packages importation graph
# In the same time it register the imported package
# The visibility must be set with `set_visibility_for`.
fun set_imported_mmodules(imported_mmodules: Array[MModule])
do
for m in imported_mmodules do
self.model.mmodule_importation_hierarchy.add_edge(self, m)
var actual_mpackage = self.mpackage
var imported_mpackage = m.mpackage
if actual_mpackage != null and imported_mpackage != null then
# Register the imported package
self.model.mpackage_importation_graph.add_arc(actual_mpackage, imported_mpackage)
end
end
end
private var intrude_mmodules = new HashSet[MModule]
private var public_mmodules = new HashSet[MModule]
private var private_mmodules = new HashSet[MModule]
# Return the visibility level of an imported module `m`
fun visibility_for(m: MModule): MVisibility
do
if m == self then return intrude_visibility
if self.intrude_mmodules.has(m) then return intrude_visibility
if self.public_mmodules.has(m) then return public_visibility
if self.private_mmodules.has(m) then return private_visibility
return none_visibility
end
# Set the visibility of an imported module
# REQUIRE: the visibility of the modules imported by `m` are already set for `m`
fun set_visibility_for(m: MModule, v: MVisibility)
do
if v == intrude_visibility then
self.intrude_mmodules.add(m)
self.intrude_mmodules.add_all(m.intrude_mmodules)
self.public_mmodules.add_all(m.public_mmodules)
self.private_mmodules.add_all(m.private_mmodules)
else if v == public_visibility then
self.public_mmodules.add(m)
self.public_mmodules.add_all(m.intrude_mmodules)
self.public_mmodules.add_all(m.public_mmodules)
else if v == private_visibility then
self.private_mmodules.add(m)
self.private_mmodules.add_all(m.intrude_mmodules)
self.private_mmodules.add_all(m.public_mmodules)
else
print "{self} visibility for {m} = {v}"
abort # invalid visibility
end
end
# Return true if a class or a property introduced in `intro_mmodule` with a visibility of `visibility` is visible in self.
fun is_visible(intro_mmodule: MModule, visibility: MVisibility): Bool
do
var v = visibility_for(intro_mmodule)
if v == intrude_visibility then
return visibility >= private_visibility
else if v == public_visibility then
return visibility > private_visibility
else if v == private_visibility then
return visibility > private_visibility
else if v == none_visibility then
return false
else
abort
end
end
# Is `self` a module generated by a tool?
#
# This flag has no effect on the semantic.
# It is only intended on software engineering software to discriminate computer-generated modules from human-written ones.
var is_generated: Bool = false is writable
# Get the non-`is_fictive` module on which `self` is based on.
#
# On non-fictive module, this returns `self`.
# On fictive modules, this is used to refer the module which `self` is based on.
#
# This attribute should be set when a fictive module is created. See `is_fictive`.
var first_real_mmodule: MModule = self is writable
redef fun parent_concern do return mgroup
end
src/model/mmodule.nit:17,1--273,3