X-Git-Url: http://nitlanguage.org diff --git a/src/modelbuilder.nit b/src/modelbuilder.nit index 84b89e6..9492734 100644 --- a/src/modelbuilder.nit +++ b/src/modelbuilder.nit @@ -29,39 +29,69 @@ import opts import toolcontext import phase +private import more_collections + ### redef class ToolContext # Option --path - readable var _opt_path: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path") + var opt_path: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path") # Option --only-metamodel - readable var _opt_only_metamodel: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel") + var opt_only_metamodel: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel") # Option --only-parse - readable var _opt_only_parse: OptionBool = new OptionBool("Only proceed to parse step of loaders", "--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: OptionBool = 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_path, opt_only_parse, opt_only_metamodel, opt_ignore_visibility) end fun modelbuilder: ModelBuilder do return modelbuilder_real.as(not null) private var modelbuilder_real: nullable ModelBuilder = null - var modelize_class_phase: Phase = new ModelizeClassPhase(self, null) -end - -private class ModelizeClassPhase - super Phase - - redef fun process_nmodule(nmodule) + # Run `process_mainmodule` on all phases + fun run_global_phases(mmodules: Array[MModule]) do - toolcontext.modelbuilder.build_classes(nmodule) + 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, "
", new Location(null, 0, 0, 0, 0)) + mainmodule.set_imported_mmodules(mmodules) + end + for phase in phases_list do + if phase.disabled then continue + phase.process_mainmodule(mainmodule, mmodules) + end end end +redef class Phase + # 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 "
"). + # + # `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, 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 @@ -80,6 +110,11 @@ class ModelBuilder nmodules.add(mmodule2nmodule[mm]) end toolcontext.run_phases(nmodules) + + if toolcontext.opt_only_metamodel.value then + self.toolcontext.info("*** ONLY METAMODEL", 1) + exit(0) + end end # Instantiate a modelbuilder for a model and a toolcontext @@ -110,7 +145,7 @@ class ModelBuilder end # Load a bunch of modules. - # `modules' can contains filenames or module names. + # `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. @@ -121,9 +156,9 @@ class ModelBuilder var time0 = get_time # Parse and recursively load self.toolcontext.info("*** PARSE ***", 1) - var mmodules = new Array[MModule] + var mmodules = new ArraySet[MModule] for a in modules do - var nmodule = self.load_module(null, a) + var nmodule = self.load_module(a) if nmodule == null then continue # Skip error mmodules.add(nmodule.mmodule.as(not null)) end @@ -131,13 +166,19 @@ class ModelBuilder self.toolcontext.info("*** END PARSE: {time1-time0} ***", 2) self.toolcontext.check_errors - return mmodules + + 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'. + # 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. + # 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 @@ -160,11 +201,11 @@ class ModelBuilder return res end - # Return a property named `name' on the type `mtype' visible in the module `mmodule'. + # 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. + # 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 @@ -183,28 +224,55 @@ class ModelBuilder if not mmodule.is_visible(mprop.intro_mclassdef.mmodule, mprop.visibility) then continue if res == null then res = mprop - else + continue + end + + # Two global properties? + # First, special case for init, keep the most specific ones + if res isa MMethod and mprop isa MMethod and res.is_init and mprop.is_init then 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 + if mproptype.is_subtype(mmodule, null, restype) then + # found a most specific constructor, so keep it res = mprop - else - if ress == null then ress = new Array[MProperty] - ress.add(mprop) + continue end end + + # Ok, just keep all prop in the ress table + if ress == null then + ress = new Array[MProperty] + ress.add(res) + end + ress.add(mprop) end - if ress != null then + + # There is conflict? + if ress != null and res isa MMethod and res.is_init then + # special case forinit again var restype = res.intro_mclassdef.bound_mtype + var ress2 = new Array[MProperty] 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 + ress2.add(mprop) + else if not mprop isa MMethod or not mprop.is_init then + ress2.add(mprop) end end + if ress2.is_empty then + ress = null + else + ress = ress2 + ress.add(res) + end + end + + if ress != null then + assert ress.length > 1 + var s = new Array[String] + for mprop in ress do s.add mprop.full_name + self.error(anode, "Ambigous property name '{name}' for {mtype}; conflict between {s.join(" and ")}") end self.try_get_mproperty_by_name2_cache[mmodule, mtype, name] = res @@ -228,92 +296,94 @@ class ModelBuilder # 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 + # Like (an used by) `get_mmodule_by_name` but just return the ModulePath + private fun search_mmodule_by_name(anode: ANode, mgroup: nullable MGroup, name: String): nullable ModulePath 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 + # First, look in groups + var c = mgroup + while c != null do + var dirname = c.filepath + if dirname == null then break # virtual group + if dirname.has_suffix(".nit") then break # singleton project # 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) + var res = self.identify_file(try_file.simplify_path) + assert res != null + return res end - # Third, try if the requested module is itself an owner + # Third, try if the requested module is itself a group 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) + var res = self.identify_file(try_file.simplify_path) + assert res != null + return res end - lastmodule = mmodule - mmodule = mmodule.direct_owner + c = c.parent end - if modules != null then - for candidate in modules do - if candidate.direct_owner == null then - return candidate + # Look at some known directories + var lookpaths = self.paths + + # Look in the directory of the group project also (even if not explicitely in the path) + if mgroup != null then + # path of the root group + var dirname = mgroup.mproject.root.filepath + if dirname != null then + dirname = dirname.join_path("..").simplify_path + if not lookpaths.has(dirname) and dirname.file_exists then + lookpaths = lookpaths.to_a + lookpaths.add(dirname) end end end - # Look at some known directories - var lookpaths = self.paths + var candidate = search_module_in_paths(anode.hot_location, name, lookpaths) - # 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) + if candidate == null then + if mgroup != null then + error(anode, "Error: cannot find module {name} from {mgroup.name}. tried {lookpaths.join(", ")}") + else + error(anode, "Error: cannot find module {name}. tried {lookpaths.join(", ")}") end + return null end + return candidate + end + + # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed. + # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`); + # if `mgroup` 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. + fun get_mmodule_by_name(anode: ANode, mgroup: nullable MGroup, name: String): nullable MModule + do + var path = search_mmodule_by_name(anode, mgroup, name) + if path == null then return null # Forward error + var res = self.load_module(path.filepath) + if res == null then return null # Forward error + return res.mmodule.as(not null) + end + # Search a module `name` from path `lookpaths`. + # If found, the path of the file is returned + private fun search_module_in_paths(location: nullable Location, name: String, lookpaths: Collection[String]): nullable ModulePath + do 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 - error(anode, "Error: conflicting module file for {name}: {candidate} {try_file}") + # 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 + toolcontext.error(location, "Error: conflicting module file for {name}: {candidate} {try_file}") + end end end try_file = (dirname + "/" + name + "/" + name + ".nit").simplify_path @@ -321,35 +391,131 @@ class ModelBuilder if candidate == null then candidate = try_file else if candidate != try_file then - error(anode, "Error: conflicting module file for {name}: {candidate} {try_file}") + # 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 + toolcontext.error(location, "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(", ")}") + if candidate == null then return null + return identify_file(candidate) + end + + # cache for `identify_file` by realpath + private var identified_files = new HashMap[String, nullable ModulePath] + + # Identify a source file + # Load the associated project and groups if required + private fun identify_file(path: String): nullable ModulePath + do + # special case for not a nit file + if path.file_extension != "nit" then + # search in known -I paths + var res = search_module_in_paths(null, path, self.paths) + if res != null then return res + + # Found nothins? maybe it is a group... + var candidate = null + if path.file_exists then + var mgroup = get_mgroup(path) + if mgroup != null then + var owner_path = mgroup.filepath.join_path(mgroup.name + ".nit") + if owner_path.file_exists then candidate = owner_path + end end - return null + + if candidate == null then + toolcontext.error(null, "Error: cannot find module `{path}`.") + return null + end + path = candidate end - var res = self.load_module(mmodule, candidate) - if res == null then return null # Forward error - return res.mmodule.as(not null) + + # Fast track, the path is already known + var pn = path.basename(".nit") + var rp = module_absolute_path(path) + if identified_files.has_key(rp) then return identified_files[rp] + + # Search for a group + var mgrouppath = path.join_path("..").simplify_path + var mgroup = get_mgroup(mgrouppath) + + if mgroup == null then + # singleton project + var mproject = new MProject(pn, model) + mgroup = new MGroup(pn, mproject, null) # same name for the root group + mgroup.filepath = path + mproject.root = mgroup + toolcontext.info("found project `{pn}` at {path}", 2) + end + + var res = new ModulePath(pn, path, mgroup) + mgroup.module_paths.add(res) + + identified_files[rp] = res + return res + end + + # groups by path + private var mgroups = new HashMap[String, nullable MGroup] + + # return the mgroup associated to a directory path + # if the directory is not a group null is returned + private fun get_mgroup(dirpath: String): nullable MGroup + do + var rdp = module_absolute_path(dirpath) + if mgroups.has_key(rdp) then + return mgroups[rdp] + end + + # Hack, a dir is determined by the presence of a honomymous nit file + var pn = rdp.basename(".nit") + var mp = dirpath.join_path(pn + ".nit").simplify_path + + if not mp.file_exists then return null + + # check parent directory + var parentpath = dirpath.join_path("..").simplify_path + var parent = get_mgroup(parentpath) + + var mgroup + if parent == null then + # no parent, thus new project + var mproject = new MProject(pn, model) + mgroup = new MGroup(pn, mproject, null) # same name for the root group + mproject.root = mgroup + toolcontext.info("found project `{mproject}` at {dirpath}", 2) + else + mgroup = new MGroup(pn, parent.mproject, parent) + toolcontext.info("found sub group `{mgroup.full_name}` at {dirpath}", 2) + end + mgroup.filepath = dirpath + mgroups[rdp] = mgroup + return mgroup end - # Try to load a module using a path. + # Transform relative paths (starting with '../') into absolute paths + private fun module_absolute_path(path: String): String do + return getcwd.join_path(path).simplify_path + end + + # Try to load a module AST using a path. # Display an error if there is a problem (IO / lexer / parser) 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 + 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 x = if owner != null then owner.to_s else "." - self.toolcontext.info("load module {filename} in {x}", 2) + self.toolcontext.info("load module {filename}", 2) # Load the file var file = new IFStream.open(filename) @@ -357,6 +523,7 @@ class ModelBuilder 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 @@ -367,8 +534,64 @@ class ModelBuilder return null end + 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(filename: String): nullable AModule + do + # Look for the module + var file = identify_file(filename) + if file == null then return null # forward error + + # Already known and loaded? then return it + var mmodule = file.mmodule + if mmodule != null then + return mmodule2nmodule[mmodule] + end + + # Load it manually + var nmodule = load_module_ast(file.filepath) + if nmodule == null then return null # forward error + + # build the mmodule and load imported modules + mmodule = build_a_mmodule(file.mgroup, file.name, nmodule) + + if mmodule == null then return null # forward error + + # Update the file information + file.mmodule = mmodule + + # Load imported module + build_module_importation(nmodule) + + return nmodule + end + + fun load_rt_module(parent: MModule, nmodule: AModule, mod_name: String): nullable AModule + do + # Create the module + var mmodule = new MModule(model, parent.mgroup, mod_name, nmodule.location) + nmodule.mmodule = mmodule + nmodules.add(nmodule) + self.mmodule2nmodule[mmodule] = nmodule + + var imported_modules = new Array[MModule] + + imported_modules.add(parent) + mmodule.set_visibility_for(parent, intrude_visibility) + + mmodule.set_imported_mmodules(imported_modules) + + return nmodule + end + + # Visit the AST and create the `MModule` object + private fun build_a_mmodule(mgroup: nullable MGroup, mod_name: String, nmodule: AModule): nullable MModule + do # Check the module name - var mod_name = filename.basename(".nit") var decl = nmodule.n_moduledecl if decl == null then #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY @@ -380,14 +603,17 @@ class ModelBuilder end # Create the module - var mmodule = new MModule(model, owner, mod_name, nmodule.location) + var mmodule = new MModule(model, mgroup, mod_name, nmodule.location) nmodule.mmodule = mmodule nmodules.add(nmodule) self.mmodule2nmodule[mmodule] = nmodule - build_module_importation(nmodule) + if decl != null then + var ndoc = decl.n_doc + if ndoc != null then mmodule.mdoc = ndoc.to_mdoc + end - return nmodule + return mmodule end # Analysis the module importation and fill the module_importation_hierarchy @@ -403,11 +629,30 @@ class ModelBuilder if not aimport isa AStdImport then continue end + var mgroup = mmodule.mgroup + if aimport.n_name.n_quad != null then mgroup = null # Start from top level + for grp in aimport.n_name.n_path do + var path = search_mmodule_by_name(grp, mgroup, grp.text) + if path == null then return # Skip error + mgroup = path.mgroup + end var mod_name = aimport.n_name.n_id.text - var sup = self.get_mmodule_by_name(aimport.n_name, mmodule, mod_name) + var sup = self.get_mmodule_by_name(aimport.n_name, mgroup, 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 + if sup == mmodule then + error(aimport.n_name, "Error: Dependency loop in module {mmodule}.") + end + if sup.in_importation < mmodule then + error(aimport.n_name, "Error: Dependency loop between modules {mmodule} and {sup}.") + return + end mmodule.set_visibility_for(sup, mvisibility) end if stdimport then @@ -425,372 +670,26 @@ class ModelBuilder # All the loaded modules var nmodules: Array[AModule] = new Array[AModule] - # Visit the AST and create the MClass objects - private fun build_a_mclass(nmodule: AModule, nclassdef: AClassdef) - do - var mmodule = nmodule.mmodule.as(not null) - - var name: String - var nkind: nullable AClasskind - var mkind: MClassKind - var nvisibility: nullable AVisibility - var mvisibility: nullable MVisibility - var arity = 0 - if nclassdef isa AStdClassdef then - name = nclassdef.n_id.text - nkind = nclassdef.n_classkind - mkind = nkind.mkind - nvisibility = nclassdef.n_visibility - mvisibility = nvisibility.mvisibility - arity = nclassdef.n_formaldefs.length - else if nclassdef isa ATopClassdef then - name = "Object" - nkind = null - mkind = interface_kind - nvisibility = null - mvisibility = public_visibility - else if nclassdef isa AMainClassdef then - name = "Sys" - nkind = null - mkind = concrete_kind - nvisibility = null - mvisibility = public_visibility - else - abort - end - - var mclass = try_get_mclass_by_name(nclassdef, mmodule, name) - if mclass == null then - mclass = new MClass(mmodule, name, arity, mkind, mvisibility) - #print "new class {mclass}" - else if nclassdef isa AStdClassdef and nmodule.mclass2nclassdef.has_key(mclass) then - error(nclassdef, "Error: A class {name} is already defined at line {nmodule.mclass2nclassdef[mclass].location.line_start}.") - return - else if nclassdef isa AStdClassdef and nclassdef.n_kwredef == null then - error(nclassdef, "Redef error: {name} is an imported class. Add the redef keyword to refine it.") - return - else if mclass.arity != arity then - error(nclassdef, "Redef error: Formal parameter arity missmatch; got {arity}, expected {mclass.arity}.") - return - else if nkind != null and mkind != concrete_kind and mclass.kind != mkind then - error(nkind, "Error: refinement changed the kind from a {mclass.kind} to a {mkind}") - else if nvisibility != null and mvisibility != public_visibility and mclass.visibility != mvisibility then - error(nvisibility, "Error: refinement changed the visibility from a {mclass.visibility} to a {mvisibility}") - end - nclassdef.mclass = mclass - nmodule.mclass2nclassdef[mclass] = nclassdef - end - - # Visit the AST and create the MClassDef objects - private fun build_a_mclassdef(nmodule: AModule, nclassdef: AClassdef) - do - var mmodule = nmodule.mmodule.as(not null) - var objectclass = try_get_mclass_by_name(nmodule, mmodule, "Object") - var mclass = nclassdef.mclass - if mclass == null then return # Skip error - #var mclassdef = nclassdef.mclassdef.as(not null) - - var names = new Array[String] - var bounds = new Array[MType] - if nclassdef isa AStdClassdef and mclass.arity > 0 then - # Collect formal parameter names - for i in [0..mclass.arity[ do - var nfd = nclassdef.n_formaldefs[i] - var ptname = nfd.n_id.text - if names.has(ptname) then - error(nfd, "Error: A formal parameter type `{ptname}' already exists") - return - end - names.add(ptname) - end - - # Revolve bound for formal parameter names - for i in [0..mclass.arity[ do - var nfd = nclassdef.n_formaldefs[i] - var nfdt = nfd.n_type - if nfdt != null then - var bound = resolve_mtype_unchecked(nclassdef, nfdt, false) - if bound == null then return # Forward error - if bound.need_anchor then - # No F-bounds! - error(nfd, "Error: Formal parameter type `{names[i]}' bounded with a formal parameter type") - else - bounds.add(bound) - end - else if mclass.mclassdefs.is_empty then - # No bound, then implicitely bound by nullable Object - bounds.add(objectclass.mclass_type.as_nullable) - else - # Inherit the bound - bounds.add(mclass.intro.bound_mtype.arguments[i]) - end - end - end - - var bound_mtype = mclass.get_mtype(bounds) - var mclassdef = new MClassDef(mmodule, bound_mtype, nclassdef.location, names) - nclassdef.mclassdef = mclassdef - self.mclassdef2nclassdef[mclassdef] = nclassdef - - if mclassdef.is_intro then - self.toolcontext.info("{mclassdef} introduces new {mclass.kind} {mclass.full_name}", 3) - else - self.toolcontext.info("{mclassdef} refine {mclass.kind} {mclass.full_name}", 3) - end - end - - # Visit the AST and set the super-types of the MClassdef objects - private fun collect_a_mclassdef_inheritance(nmodule: AModule, nclassdef: AClassdef) - do - var mmodule = nmodule.mmodule.as(not null) - var objectclass = try_get_mclass_by_name(nmodule, mmodule, "Object") - var mclass = nclassdef.mclass.as(not null) - var mclassdef = nclassdef.mclassdef.as(not null) - - var specobject = true - var supertypes = new Array[MClassType] - if nclassdef isa AStdClassdef then - for nsc in nclassdef.n_superclasses do - specobject = false - var ntype = nsc.n_type - var mtype = resolve_mtype_unchecked(nclassdef, ntype, false) - if mtype == null then continue # Skip because of error - if not mtype isa MClassType then - error(ntype, "Error: supertypes cannot be a formal type") - return - end - supertypes.add mtype - #print "new super : {mclass} < {mtype}" - end - end - if specobject and mclass.name != "Object" and objectclass != null and mclassdef.is_intro then - supertypes.add objectclass.mclass_type - end - - mclassdef.set_supertypes(supertypes) - if not supertypes.is_empty then self.toolcontext.info("{mclassdef} new super-types: {supertypes.join(", ")}", 3) - end - - # Check the validity of the specialization heirarchy - private fun check_supertypes(nmodule: AModule, nclassdef: AClassdef) - do - var mmodule = nmodule.mmodule.as(not null) - var objectclass = try_get_mclass_by_name(nmodule, mmodule, "Object") - var mclass = nclassdef.mclass.as(not null) - var mclassdef = nclassdef.mclassdef.as(not null) - - for s in mclassdef.supertypes do - if s.is_subtype(mmodule, mclassdef.bound_mtype, mclassdef.bound_mtype) then - error(nclassdef, "Error: Inheritance loop for class {mclass} with type {s}") - end - end - end - - # Build the classes of the module `nmodule'. - # REQUIRE: classes of imported modules are already build. (let `phase' do the job) - private fun build_classes(nmodule: AModule) - do - # Force building recursively - if nmodule.build_classes_is_done then return - nmodule.build_classes_is_done = true - var mmodule = nmodule.mmodule.as(not null) - for imp in mmodule.in_importation.direct_greaters do - - build_classes(mmodule2nmodule[imp]) - end - - # Create all classes - for nclassdef in nmodule.n_classdefs do - self.build_a_mclass(nmodule, nclassdef) - end - - # Create all classdefs - for nclassdef in nmodule.n_classdefs do - self.build_a_mclassdef(nmodule, nclassdef) - end - - for nclassdef in nmodule.n_classdefs do - if nclassdef.mclassdef == null then return # forward error - end - - # Create inheritance on all classdefs - for nclassdef in nmodule.n_classdefs do - self.collect_a_mclassdef_inheritance(nmodule, nclassdef) - end - - # Create the mclassdef hierarchy - for nclassdef in nmodule.n_classdefs do - var mclassdef = nclassdef.mclassdef.as(not null) - mclassdef.add_in_hierarchy - end - - # Check inheritance - for nclassdef in nmodule.n_classdefs do - self.check_supertypes(nmodule, nclassdef) - end - - # Check unchecked ntypes - for nclassdef in nmodule.n_classdefs do - if nclassdef isa AStdClassdef then - # check bound of formal parameter - for nfd in nclassdef.n_formaldefs do - var nfdt = nfd.n_type - if nfdt != null and nfdt.mtype != null then - var bound = resolve_mtype(nclassdef, nfdt) - if bound == null then return # Forward error - end - end - # check declared super types - for nsc in nclassdef.n_superclasses do - var ntype = nsc.n_type - if ntype.mtype != null then - var mtype = resolve_mtype(nclassdef, ntype) - if mtype == null then return # Forward error - end - end - end - - end - - # TODO: Check that the super-class is not intrusive - - # TODO: Check that the super-class is not already known (by transitivity) - end - # Register the nmodule associated to each mmodule - # FIXME: why not refine the MModule class with a nullable attribute? + # FIXME: why not refine the `MModule` class with a nullable attribute? var mmodule2nmodule: HashMap[MModule, AModule] = new HashMap[MModule, AModule] - # Register the nclassdef associated to each mclassdef - # FIXME: why not refine the MClassDef class with a nullable attribute? - var mclassdef2nclassdef: HashMap[MClassDef, AClassdef] = new HashMap[MClassDef, AClassdef] - - # Return the static type associated to the node `ntype'. - # `classdef' is the context where the call is made (used to understand formal types) - # The mmodule used as context is `nclassdef.mmodule' - # In case of problem, an error is displayed on `ntype' and null is returned. - # FIXME: the name "resolve_mtype" is awful - fun resolve_mtype_unchecked(nclassdef: AClassdef, ntype: AType, with_virtual: Bool): nullable MType - do - var name = ntype.n_id.text - var mclassdef = nclassdef.mclassdef - var mmodule = nclassdef.parent.as(AModule).mmodule.as(not null) - var res: MType - - # Check virtual type - if mclassdef != null and with_virtual then - var prop = try_get_mproperty_by_name(ntype, mclassdef, name).as(nullable MVirtualTypeProp) - if prop != null then - if not ntype.n_types.is_empty then - error(ntype, "Type error: formal type {name} cannot have formal parameters.") - end - res = prop.mvirtualtype - if ntype.n_kwnullable != null then res = res.as_nullable - ntype.mtype = res - return res - end - end - - # Check parameter type - if mclassdef != null and mclassdef.parameter_names.has(name) then - if not ntype.n_types.is_empty then - error(ntype, "Type error: formal type {name} cannot have formal parameters.") - end - for i in [0..mclassdef.parameter_names.length[ do - if mclassdef.parameter_names[i] == name then - res = mclassdef.mclass.mclass_type.arguments[i] - if ntype.n_kwnullable != null then res = res.as_nullable - ntype.mtype = res - return res - end - end - abort - end - - # Check class - var mclass = try_get_mclass_by_name(ntype, mmodule, name) - if mclass != null then - var arity = ntype.n_types.length - if arity != mclass.arity then - if arity == 0 then - error(ntype, "Type error: '{name}' is a generic class.") - else if mclass.arity == 0 then - error(ntype, "Type error: '{name}' is not a generic class.") - else - error(ntype, "Type error: '{name}' has {mclass.arity} parameters ({arity} are provided).") - end - return null - end - if arity == 0 then - res = mclass.mclass_type - if ntype.n_kwnullable != null then res = res.as_nullable - ntype.mtype = res - return res - else - var mtypes = new Array[MType] - for nt in ntype.n_types do - var mt = resolve_mtype_unchecked(nclassdef, nt, with_virtual) - if mt == null then return null # Forward error - mtypes.add(mt) - end - res = mclass.get_mtype(mtypes) - if ntype.n_kwnullable != null then res = res.as_nullable - ntype.mtype = res - return res - end - end - - # If everything fail, then give up :( - error(ntype, "Type error: class {name} not found in module {mmodule}.") - return null - end - - # Return the static type associated to the node `ntype'. - # `classdef' is the context where the call is made (used to understand formal types) - # The mmodule used as context is `nclassdef.mmodule' - # In case of problem, an error is displayed on `ntype' and null is returned. - # FIXME: the name "resolve_mtype" is awful - fun resolve_mtype(nclassdef: AClassdef, ntype: AType): nullable MType - do - var mtype = ntype.mtype - if mtype == null then mtype = resolve_mtype_unchecked(nclassdef, ntype, true) - if mtype == null then return null # Forward error - - if ntype.checked_mtype then return mtype - if mtype isa MGenericType then - var mmodule = nclassdef.parent.as(AModule).mmodule.as(not null) - var mclassdef = nclassdef.mclassdef - var mclass = mtype.mclass - for i in [0..mclass.arity[ do - var bound = mclass.intro.bound_mtype.arguments[i] - var nt = ntype.n_types[i] - var mt = resolve_mtype(nclassdef, nt) - if mt == null then return null # forward error - if not mt.is_subtype(mmodule, mclassdef.bound_mtype, bound) then - error(nt, "Type error: expected {bound}, got {mt}") - return null - end - end - end - ntype.checked_mtype = true - return mtype - end # Helper function to display an error on a node. - # Alias for `self.toolcontext.error(n.hot_location, text)' + # 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)' + # 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: MType, mmodule: MModule): MMethod + # 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 @@ -801,44 +700,39 @@ class ModelBuilder end 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 - # Flag that indicate if the class and prop building is already completed - var build_classes_is_done: Bool = false - # What is the AClassdef associated to a MClass? - # Used to check multiple definition of a class. - var mclass2nclassdef: Map[MClass, AClassdef] = new HashMap[MClass, AClassdef] +# placeholder to a module file identified but not always loaded in a project +private class ModulePath + # The name of the module + # (it's the basename of the filepath) + var name: String -end + # The human path of the module + var filepath: String -redef class AClassdef - # The associated MClass once build by a `ModelBuilder' - var mclass: nullable MClass - # The associated MClassDef once build by a `ModelBuilder' - var mclassdef: nullable MClassDef -end + # The group (and the project) of the possible module + var mgroup: MGroup -redef class AClasskind - # The class kind associated with the AST node class - private fun mkind: MClassKind is abstract -end -redef class AConcreteClasskind - redef fun mkind do return concrete_kind -end -redef class AAbstractClasskind - redef fun mkind do return abstract_kind + # The loaded module (if any) + var mmodule: nullable MModule = null + + redef fun to_s do return filepath end -redef class AInterfaceClasskind - redef fun mkind do return interface_kind + +redef class MGroup + # modules paths associated with the group + private var module_paths = new Array[ModulePath] end -redef class AEnumClasskind - redef fun mkind do return enum_kind + +redef class AStdImport + # The imported module once determined + var mmodule: nullable MModule = null end -redef class AExternClasskind - redef fun mkind do return extern_kind + +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 @@ -858,10 +752,29 @@ redef class APrivateVisibility redef fun mvisibility do return private_visibility end -redef class AType - # The mtype associated to the node - var mtype: nullable MType = null - - # Is the mtype a valid one? - var checked_mtype: Bool = false -end \ No newline at end of file +redef class ADoc + private var mdoc_cache: nullable MDoc + fun to_mdoc: MDoc + do + var res = mdoc_cache + if res != null then return res + res = new MDoc + for c in n_comment do + var text = c.text + if text.length < 2 then + res.content.add "" + continue + end + assert text.chars[0] == '#' + if text.chars[1] == ' ' then + text = text.substring_from(2) # eat starting `#` and space + else + text = text.substring_from(1) # eat atarting `#` only + end + if text.chars.last == '\n' then text = text.substring(0, text.length-1) # drop \n + res.content.add(text) + end + mdoc_cache = res + return res + end +end