X-Git-Url: http://nitlanguage.org diff --git a/src/modelbuilder.nit b/src/modelbuilder.nit index 6e43604..23f7d49 100644 --- a/src/modelbuilder.nit +++ b/src/modelbuilder.nit @@ -14,19 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Load nit source files and build the associated model -# -# FIXME better doc -# -# FIXME split this module into submodules -# FIXME add missing error checks module modelbuilder -import parser -import model -import poset -import opts -import toolcontext +import loader import phase private import more_collections @@ -34,48 +24,66 @@ private import more_collections ### redef class ToolContext - # Option --path - var opt_path: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path") - - # Option --only-metamodel - var opt_only_metamodel: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel") - - # Option --only-parse - var opt_only_parse: OptionBool = new OptionBool("Only proceed to parse step of loaders", "--only-parse") + # Option --ignore-visibility + var opt_ignore_visibility = new OptionBool("Do not check, and produce errors, on visibility issues.", "--ignore-visibility") redef init do super - option_context.add_option(opt_path, opt_only_parse, opt_only_metamodel) + option_context.add_option(opt_ignore_visibility) end - fun modelbuilder: ModelBuilder do return modelbuilder_real.as(not null) - private var modelbuilder_real: nullable ModelBuilder = null + # Combine module to make a single one if required. + fun make_main_module(mmodules: Array[MModule]): MModule + do + assert not mmodules.is_empty + var mainmodule + if mmodules.length == 1 then + mainmodule = mmodules.first + else + # We need a main module, so we build it by importing all modules + mainmodule = new MModule(modelbuilder.model, null, mmodules.first.name + "-m", new Location(mmodules.first.location.file, 0, 0, 0, 0)) + mainmodule.is_fictive = true + mainmodule.set_imported_mmodules(mmodules) + end + return mainmodule + end - fun run_global_phases(mainmodule: MModule) + # Run `process_mainmodule` on all phases + fun run_global_phases(mmodules: Array[MModule]) do - for phase in phases_list do - phase.process_mainmodule(mainmodule) + if not mmodules.is_empty then + var mainmodule = make_main_module(mmodules) + for phase in phases_list do + if phase.disabled then continue + phase.process_mainmodule(mainmodule, mmodules) + end end + + check_errors + errors_info end end redef class Phase - # Specific action to execute on the whole program - # Called by the `ToolContext::run_global_phases` + # Specific action to execute on the whole program. + # Called by the `ToolContext::run_global_phases`. + # + # `mainmodule` is the main module of the program. + # It could be an implicit module (called like the first given_mmodules). + # + # `given_modules` is the list of explicitely requested modules. + # from the command-line for instance. + # + # REQUIRE: `not given_modules.is_empty` + # REQUIRE: `(given_modules.length == 1) == (mainmodule == given_modules.first)` + # # @toimplement - fun process_mainmodule(mainmodule: MModule) do end + fun process_mainmodule(mainmodule: MModule, given_mmodules: SequenceRead[MModule]) do end end -# A model builder knows how to load nit source files and build the associated model -class ModelBuilder - # The model where new modules, classes and properties are added - var model: Model - - # The toolcontext used to control the interaction with the user (getting options and displaying messages) - var toolcontext: ToolContext - +redef class ModelBuilder # Run phases on all loaded modules fun run_phases do @@ -83,7 +91,7 @@ class ModelBuilder model.mmodule_importation_hierarchy.sort(mmodules) var nmodules = new Array[AModule] for mm in mmodules do - nmodules.add(mmodule2nmodule[mm]) + nmodules.add(mmodule2node(mm).as(not null)) end toolcontext.run_phases(nmodules) @@ -93,487 +101,4 @@ class ModelBuilder end end - # Instantiate a modelbuilder for a model and a toolcontext - # Important, the options of the toolcontext must be correctly set (parse_option already called) - init(model: Model, toolcontext: ToolContext) - do - self.model = model - self.toolcontext = toolcontext - assert toolcontext.modelbuilder_real == null - toolcontext.modelbuilder_real = self - - # Setup the paths value - paths.append(toolcontext.opt_path.value) - - var path_env = "NIT_PATH".environ - if not path_env.is_empty then - paths.append(path_env.split_with(':')) - end - - path_env = "NIT_DIR".environ - if not path_env.is_empty then - var libname = "{path_env}/lib" - if libname.file_exists then paths.add(libname) - end - - var libname = "{sys.program_name.dirname}/../lib" - if libname.file_exists then paths.add(libname.simplify_path) - end - - # Load a bunch of modules. - # `modules` can contains filenames or module names. - # Imported modules are automatically loaded and modelized. - # The result is the corresponding model elements. - # Errors and warnings are printed with the toolcontext. - # - # Note: class and property model element are not analysed. - fun parse(modules: Sequence[String]): Array[MModule] - do - var time0 = get_time - # Parse and recursively load - self.toolcontext.info("*** PARSE ***", 1) - var mmodules = new ArraySet[MModule] - for a in modules do - var nmodule = self.load_module(null, a) - if nmodule == null then continue # Skip error - mmodules.add(nmodule.mmodule.as(not null)) - end - var time1 = get_time - self.toolcontext.info("*** END PARSE: {time1-time0} ***", 2) - - self.toolcontext.check_errors - - if toolcontext.opt_only_parse.value then - self.toolcontext.info("*** ONLY PARSE...", 1) - exit(0) - end - - return mmodules.to_a - end - - # Return a class named `name` visible by the module `mmodule`. - # Visibility in modules is correctly handled. - # If no such a class exists, then null is returned. - # If more than one class exists, then an error on `anode` is displayed and null is returned. - # FIXME: add a way to handle class name conflict - fun try_get_mclass_by_name(anode: ANode, mmodule: MModule, name: String): nullable MClass - do - var classes = model.get_mclasses_by_name(name) - if classes == null then - return null - end - - var res: nullable MClass = null - for mclass in classes do - if not mmodule.in_importation <= mclass.intro_mmodule then continue - if not mmodule.is_visible(mclass.intro_mmodule, mclass.visibility) then continue - if res == null then - res = mclass - else - error(anode, "Ambigous class name '{name}'; conflict between {mclass.full_name} and {res.full_name}") - return null - end - end - return res - end - - # Return a property named `name` on the type `mtype` visible in the module `mmodule`. - # Visibility in modules is correctly handled. - # Protected properties are returned (it is up to the caller to check and reject protected properties). - # If no such a property exists, then null is returned. - # If more than one property exists, then an error on `anode` is displayed and null is returned. - # FIXME: add a way to handle property name conflict - fun try_get_mproperty_by_name2(anode: ANode, mmodule: MModule, mtype: MType, name: String): nullable MProperty - do - var props = self.model.get_mproperties_by_name(name) - if props == null then - return null - end - - var cache = self.try_get_mproperty_by_name2_cache[mmodule, mtype, name] - if cache != null then return cache - - var res: nullable MProperty = null - var ress: nullable Array[MProperty] = null - for mprop in props do - if not mtype.has_mproperty(mmodule, mprop) then continue - if not mmodule.is_visible(mprop.intro_mclassdef.mmodule, mprop.visibility) then continue - if res == null then - res = mprop - else - var restype = res.intro_mclassdef.bound_mtype - var mproptype = mprop.intro_mclassdef.bound_mtype - if restype.is_subtype(mmodule, null, mproptype) then - # we keep res - else if mproptype.is_subtype(mmodule, null, restype) then - res = mprop - else - if ress == null then ress = new Array[MProperty] - ress.add(mprop) - end - end - end - if ress != null then - var restype = res.intro_mclassdef.bound_mtype - for mprop in ress do - var mproptype = mprop.intro_mclassdef.bound_mtype - if not restype.is_subtype(mmodule, null, mproptype) then - self.error(anode, "Ambigous property name '{name}' for {mtype}; conflict between {mprop.full_name} and {res.full_name}") - return null - end - end - end - - self.try_get_mproperty_by_name2_cache[mmodule, mtype, name] = res - return res - end - - private var try_get_mproperty_by_name2_cache: HashMap3[MModule, MType, String, nullable MProperty] = new HashMap3[MModule, MType, String, nullable MProperty] - - - # Alias for try_get_mproperty_by_name2(anode, mclassdef.mmodule, mclassdef.mtype, name) - fun try_get_mproperty_by_name(anode: ANode, mclassdef: MClassDef, name: String): nullable MProperty - do - return try_get_mproperty_by_name2(anode, mclassdef.mmodule, mclassdef.bound_mtype, name) - end - - # The list of directories to search for top level modules - # The list is initially set with : - # * the toolcontext --path option - # * the NIT_PATH environment variable - # * some heuristics including the NIT_DIR environment variable and the progname of the process - # Path can be added (or removed) by the client - var paths: Array[String] = new Array[String] - - # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed. - # If `mmodule` is set, then the module search starts from it up to the top level (see `paths`); - # if `mmodule` is null then the module is searched in the top level only. - # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned. - # FIXME: add a way to handle module name conflict - fun get_mmodule_by_name(anode: ANode, mmodule: nullable MModule, name: String): nullable MModule - do - var origmmodule = mmodule - var modules = model.get_mmodules_by_name(name) - - var tries = new Array[String] - - var lastmodule = mmodule - while mmodule != null do - var dirname = mmodule.location.file.filename.dirname - - # Determine the owner - var owner: nullable MModule - if dirname.basename("") != mmodule.name then - owner = mmodule.direct_owner - else - owner = mmodule - end - - # First, try the already known nested modules - if modules != null then - for candidate in modules do - if candidate.direct_owner == owner then - return candidate - end - end - end - - # Second, try the directory to find a file - var try_file = dirname + "/" + name + ".nit" - tries.add try_file - if try_file.file_exists then - var res = self.load_module(owner, try_file.simplify_path) - if res == null then return null # Forward error - return res.mmodule.as(not null) - end - - # Third, try if the requested module is itself an owner - try_file = dirname + "/" + name + "/" + name + ".nit" - if try_file.file_exists then - var res = self.load_module(owner, try_file.simplify_path) - if res == null then return null # Forward error - return res.mmodule.as(not null) - end - - lastmodule = mmodule - mmodule = mmodule.direct_owner - end - - if modules != null then - for candidate in modules do - if candidate.direct_owner == null then - return candidate - end - end - end - - # Look at some known directories - var lookpaths = self.paths - - # Look in the directory of the last module also (event if not in the path) - if lastmodule != null then - var dirname = lastmodule.location.file.filename.dirname - if dirname.basename("") == lastmodule.name then - dirname = dirname.dirname - end - if not lookpaths.has(dirname) then - lookpaths = lookpaths.to_a - lookpaths.add(dirname) - end - end - - var candidate: nullable String = null - for dirname in lookpaths do - var try_file = (dirname + "/" + name + ".nit").simplify_path - tries.add try_file - if try_file.file_exists then - if candidate == null then - candidate = try_file - else if candidate != try_file then - # try to disambiguate conflicting modules - var abs_candidate = module_absolute_path(candidate) - var abs_try_file = module_absolute_path(try_file) - if abs_candidate != abs_try_file then - error(anode, "Error: conflicting module file for {name}: {candidate} {try_file}") - end - end - end - try_file = (dirname + "/" + name + "/" + name + ".nit").simplify_path - if try_file.file_exists then - if candidate == null then - candidate = try_file - else if candidate != try_file then - # try to disambiguate conflicting modules - var abs_candidate = module_absolute_path(candidate) - var abs_try_file = module_absolute_path(try_file) - if abs_candidate != abs_try_file then - error(anode, "Error: conflicting module file for {name}: {candidate} {try_file}") - end - end - end - end - if candidate == null then - if origmmodule != null then - error(anode, "Error: cannot find module {name} from {origmmodule}. tried {tries.join(", ")}") - else - error(anode, "Error: cannot find module {name}. tried {tries.join(", ")}") - end - return null - end - var res = self.load_module(mmodule, candidate) - if res == null then return null # Forward error - return res.mmodule.as(not null) - end - - # Transform relative paths (starting with '../') into absolute paths - private fun module_absolute_path(path: String): String do - if path.has_prefix("..") then - return getcwd.join_path(path).simplify_path - end - return path - end - - # loaded module by absolute path - private var loaded_nmodules = new HashMap[String, AModule] - - # Try to load a module AST using a path. - # Display an error if there is a problem (IO / lexer / parser) and return null - fun load_module_ast(filename: String): nullable AModule - do - if filename.file_extension != "nit" then - self.toolcontext.error(null, "Error: file {filename} is not a valid nit module.") - return null - end - if not filename.file_exists then - self.toolcontext.error(null, "Error: file {filename} not found.") - return null - end - - var module_path = module_absolute_path(filename) - if loaded_nmodules.keys.has(module_path) then - return loaded_nmodules[module_path] - end - - self.toolcontext.info("load module {filename}", 2) - - # Load the file - var file = new IFStream.open(filename) - var lexer = new Lexer(new SourceFile(filename, file)) - var parser = new Parser(lexer) - var tree = parser.parse - file.close - var mod_name = filename.basename(".nit") - - # Handle lexer and parser error - var nmodule = tree.n_base - if nmodule == null then - var neof = tree.n_eof - assert neof isa AError - error(neof, neof.message) - return null - end - - loaded_nmodules[module_path] = nmodule - return nmodule - end - - # Try to load a module and its imported modules using a path. - # Display an error if there is a problem (IO / lexer / parser / importation) and return null - # Note: usually, you do not need this method, use `get_mmodule_by_name` instead. - fun load_module(owner: nullable MModule, filename: String): nullable AModule - do - var nmodule = load_module_ast(filename) - if nmodule == null then return null # forward error - - var mmodule = nmodule.mmodule - if mmodule != null then return nmodule - - var mod_name = filename.basename(".nit") - mmodule = build_a_mmodule(owner, mod_name, nmodule) - if mmodule == null then return null - - return nmodule - end - - fun load_rt_module(owner: MModule, nmodule: AModule, mod_name: String): nullable AModule - do - # Create the module - var mmodule = new MModule(model, owner, mod_name, nmodule.location) - nmodule.mmodule = mmodule - nmodules.add(nmodule) - self.mmodule2nmodule[mmodule] = nmodule - - var imported_modules = new Array[MModule] - - imported_modules.add(owner) - mmodule.set_visibility_for(owner, intrude_visibility) - - mmodule.set_imported_mmodules(imported_modules) - - return nmodule - end - - # Visit the AST and create the `MModule` object - # Then, recursively load imported modules - private fun build_a_mmodule(owner: nullable MModule, mod_name: String, nmodule: AModule): nullable MModule - do - # Check the module name - var decl = nmodule.n_moduledecl - if decl == null then - #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY - else - var decl_name = decl.n_name.n_id.text - if decl_name != mod_name then - error(decl.n_name, "Error: module name missmatch; declared {decl_name} file named {mod_name}") - end - end - - # Create the module - var mmodule = new MModule(model, owner, mod_name, nmodule.location) - nmodule.mmodule = mmodule - nmodules.add(nmodule) - self.mmodule2nmodule[mmodule] = nmodule - - build_module_importation(nmodule) - - return mmodule - end - - # Analysis the module importation and fill the module_importation_hierarchy - private fun build_module_importation(nmodule: AModule) - do - if nmodule.is_importation_done then return - nmodule.is_importation_done = true - var mmodule = nmodule.mmodule.as(not null) - var stdimport = true - var imported_modules = new Array[MModule] - for aimport in nmodule.n_imports do - stdimport = false - if not aimport isa AStdImport then - continue - end - var mod_name = aimport.n_name.n_id.text - var sup = self.get_mmodule_by_name(aimport.n_name, mmodule, mod_name) - if sup == null then continue # Skip error - aimport.mmodule = sup - imported_modules.add(sup) - var mvisibility = aimport.n_visibility.mvisibility - if mvisibility == protected_visibility then - error(aimport.n_visibility, "Error: only properties can be protected.") - return - end - mmodule.set_visibility_for(sup, mvisibility) - end - if stdimport then - var mod_name = "standard" - var sup = self.get_mmodule_by_name(nmodule, null, mod_name) - if sup != null then # Skip error - imported_modules.add(sup) - mmodule.set_visibility_for(sup, public_visibility) - end - end - self.toolcontext.info("{mmodule} imports {imported_modules.join(", ")}", 3) - mmodule.set_imported_mmodules(imported_modules) - end - - # All the loaded modules - var nmodules: Array[AModule] = new Array[AModule] - - # Register the nmodule associated to each mmodule - # FIXME: why not refine the `MModule` class with a nullable attribute? - var mmodule2nmodule: HashMap[MModule, AModule] = new HashMap[MModule, AModule] - - # Helper function to display an error on a node. - # Alias for `self.toolcontext.error(n.hot_location, text)` - fun error(n: ANode, text: String) - do - self.toolcontext.error(n.hot_location, text) - end - - # Helper function to display a warning on a node. - # Alias for: `self.toolcontext.warning(n.hot_location, text)` - fun warning(n: ANode, text: String) - do - self.toolcontext.warning(n.hot_location, text) - end - - # Force to get the primitive method named `name` on the type `recv` or do a fatal error on `n` - fun force_get_primitive_method(n: ANode, name: String, recv: MClass, mmodule: MModule): MMethod - do - var res = mmodule.try_get_primitive_method(name, recv) - if res == null then - self.toolcontext.fatal_error(n.hot_location, "Fatal Error: {recv} must have a property named {name}.") - abort - end - return res - end -end - -redef class AStdImport - # The imported module once determined - var mmodule: nullable MModule = null -end - -redef class AModule - # The associated MModule once build by a `ModelBuilder` - var mmodule: nullable MModule - # Flag that indicate if the importation is already completed - var is_importation_done: Bool = false -end - -redef class AVisibility - # The visibility level associated with the AST node class - fun mvisibility: MVisibility is abstract -end -redef class AIntrudeVisibility - redef fun mvisibility do return intrude_visibility -end -redef class APublicVisibility - redef fun mvisibility do return public_visibility -end -redef class AProtectedVisibility - redef fun mvisibility do return protected_visibility -end -redef class APrivateVisibility - redef fun mvisibility do return private_visibility end