1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Loading of Nit source files
19 # The loader takes care of looking for module and projects in the file system, and the associated case of errors.
20 # The loading requires several steps:
22 # Identify: create an empty model entity associated to a name or a file path.
23 # Identification is used for instance when names are given in the command line.
24 # See `identify_module` and `identify_group`.
26 # Scan: visit directories and identify their contents.
27 # Scanning is done to enable the searching of modules in projects.
28 # See `scan_group` and `scan_full`.
30 # Parse: load the AST and associate it with the model entity.
31 # See `MModule::parse`.
33 # Import: means recursively load modules imported by a module.
34 # See `build_module_importation`.
36 # Load: means doing the full sequence: identify, parse and import.
37 # See `ModelBuilder::parse`, `ModelBuilder::parse_full`, `MModule::load` `ModelBuilder::load_module.
40 import modelbuilder_base
43 redef class ToolContext
45 var opt_path
= new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
47 # Option --only-metamodel
48 var opt_only_metamodel
= new OptionBool("Stop after meta-model processing", "--only-metamodel")
51 var opt_only_parse
= new OptionBool("Only proceed to parse step of loaders", "--only-parse")
56 option_context
.add_option
(opt_path
, opt_only_parse
, opt_only_metamodel
)
60 redef class ModelBuilder
65 # Setup the paths value
66 paths
.append
(toolcontext
.opt_path
.value
)
68 var path_env
= "NIT_PATH".environ
69 if not path_env
.is_empty
then
70 paths
.append
(path_env
.split_with
(':'))
73 var nit_dir
= toolcontext
.nit_dir
74 var libname
= nit_dir
/"lib"
75 if libname
.file_exists
then paths
.add
(libname
)
76 libname
= nit_dir
/"contrib"
77 if libname
.file_exists
then paths
.add
(libname
)
80 # Load a bunch of modules.
81 # `modules` can contains filenames or module names.
82 # Imported modules are automatically loaded and modelized.
83 # The result is the corresponding model elements.
84 # Errors and warnings are printed with the toolcontext.
86 # Note: class and property model elements are not analysed.
87 fun parse
(modules
: Sequence[String]): Array[MModule]
90 # Parse and recursively load
91 self.toolcontext
.info
("*** PARSE ***", 1)
92 var mmodules
= new ArraySet[MModule]
94 var nmodule
= self.load_module
(a
)
95 if nmodule
== null then continue # Skip error
96 var mmodule
= nmodule
.mmodule
97 if mmodule
== null then continue # skip error
101 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
103 self.toolcontext
.check_errors
105 if toolcontext
.opt_only_parse
.value
then
106 self.toolcontext
.info
("*** ONLY PARSE...", 1)
113 # Identify a bunch of modules and groups.
115 # This does the same as `parse_full` but does only the identification (cf. `identify_module`)
116 fun scan_full
(names
: Sequence[String]): Array[MModule]
118 var mmodules
= new Array[MModule]
120 # Case of a group (root or sub-directory)
121 var mgroup
= self.identify_group
(a
)
122 if mgroup
!= null then
124 for mg
in mgroup
.in_nesting
.smallers
do mmodules
.add_all mg
.mmodules
128 # Case of a directory that is not a group
129 var stat
= a
.to_path
.stat
130 if stat
!= null and stat
.is_dir
then
131 self.toolcontext
.info
("look in directory {a}", 2)
133 alpha_comparator
.sort
(fs
)
134 # Try each entry as a group or a module
137 mgroup
= identify_group
(af
)
138 if mgroup
!= null then
140 for mg
in mgroup
.in_nesting
.smallers
do mmodules
.add_all mg
.mmodules
143 var mmodule
= identify_module
(af
)
144 if mmodule
!= null then
147 self.toolcontext
.info
("ignore file {af}", 2)
153 var mmodule
= identify_module
(a
)
154 if mmodule
== null then
163 # Load a bunch of modules and groups.
167 # * a path to a module, a group or a directory of packages.
168 # * a short name of a module or a group that are looked in the `paths` (-I)
170 # Then, for each entry, if it is:
172 # * a module, then is it parsed and returned.
173 # * a group then recursively all its modules are parsed.
174 # * a directory of packages then all the modules of all packages are parsed.
175 # * else an error is displayed.
177 # See `parse` for details.
178 fun parse_full
(names
: Sequence[String]): Array[MModule]
181 # Parse and recursively load
182 self.toolcontext
.info
("*** PARSE ***", 1)
183 var mmodules
= new ArraySet[MModule]
184 var scans
= scan_full
(names
)
185 for mmodule
in scans
do
186 var ast
= mmodule
.load
(self)
187 if ast
== null then continue # Skip error
191 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
193 self.toolcontext
.check_errors
195 if toolcontext
.opt_only_parse
.value
then
196 self.toolcontext
.info
("*** ONLY PARSE...", 1)
203 # The list of directories to search for top level modules
204 # The list is initially set with:
206 # * the toolcontext --path option
207 # * the NIT_PATH environment variable
208 # * `toolcontext.nit_dir`
209 # Path can be added (or removed) by the client
210 var paths
= new Array[String]
212 # Like (and used by) `get_mmodule_by_name` but does not force the parsing of the MModule (cf. `identify_module`)
213 fun search_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
215 # First, look in groups
218 var r
= c
.mpackage
.root
221 var res
= r
.mmodules_by_name
(name
)
222 if res
.not_empty
then return res
.first
225 # Look at some known directories
226 var lookpaths
= self.paths
228 # Look in the directory of the group package also (even if not explicitly in the path)
229 if mgroup
!= null then
230 # path of the root group
231 var dirname
= mgroup
.mpackage
.root
.filepath
232 if dirname
!= null then
233 dirname
= dirname
.join_path
("..").simplify_path
234 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
235 lookpaths
= lookpaths
.to_a
236 lookpaths
.add
(dirname
)
241 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
243 if candidate
== null then
244 if mgroup
!= null then
245 error
(anode
, "Error: cannot find module `{name}` from `{mgroup.name}`. Tried: {lookpaths.join(", ")}.")
247 error
(anode
, "Error: cannot find module `{name}`. Tried: {lookpaths.join(", ")}.")
254 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
255 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
256 # if `mgroup` is null then the module is searched in the top level only.
257 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
258 fun get_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
260 var mmodule
= search_mmodule_by_name
(anode
, mgroup
, name
)
261 if mmodule
== null then return null # Forward error
262 var ast
= mmodule
.load
(self)
263 if ast
== null then return null # Forward error
267 # Search a module `name` from path `lookpaths`.
268 # If found, the module is returned.
269 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable MModule
271 var res
= new ArraySet[MModule]
272 for dirname
in lookpaths
do
273 # Try a single module file
274 var mp
= identify_module
((dirname
/"{name}.nit").simplify_path
)
275 if mp
!= null then res
.add mp
276 # Try the default module of a group
277 var g
= identify_group
((dirname
/name
).simplify_path
)
280 res
.add_all g
.mmodules_by_name
(name
)
283 if res
.is_empty
then return null
284 if res
.length
> 1 then
285 toolcontext
.error
(location
, "Error: conflicting module files for `{name}`: `{[for x in res do x.filepath or else x.full_name].join("`, `")}`")
290 # Search groups named `name` from paths `lookpaths`.
291 private fun search_group_in_paths
(name
: String, lookpaths
: Collection[String]): ArraySet[MGroup]
293 var res
= new ArraySet[MGroup]
294 for dirname
in lookpaths
do
295 # try a single group directory
296 var mg
= identify_group
(dirname
/name
)
304 # Cache for `identify_module` by relative and real paths
305 private var identified_modules_by_path
= new HashMap[String, nullable MModule]
307 # All the currently identified modules.
308 # See `identify_module`.
310 # An identified module exists in the model but might be not yet parsed (no AST), or not yet analysed (no importation).
311 var identified_modules
= new Array[MModule]
313 # All the currently parsed modules.
315 # A parsed module exists in the model but might be not yet analysed (no importation).
316 var parsed_modules
= new Array[MModule]
318 # Identify a source file and load the associated package and groups if required.
320 # This method does what the user expects when giving an argument to a Nit tool.
322 # * If `path` is an existing Nit source file (with the `.nit` extension),
323 # then the associated MModule is returned
324 # * If `path` is a directory (with a `/`),
325 # then the MModule of its default module is returned (if any)
326 # * If `path` is a simple identifier (eg. `digraph`),
327 # then the main module of the package `digraph` is searched in `paths` and returned.
329 # Silently return `null` if `path` does not exists or cannot be identified.
331 # On success, it returns a module that is possibly not yet parsed (no AST), or not yet analysed (no importation).
332 # If the module was already identified, or loaded, it is returned.
333 fun identify_module
(path
: String): nullable MModule
335 # special case for not a nit file
336 if not path
.has_suffix
(".nit") then
337 # search dirless files in known -I paths
338 if not path
.chars
.has
('/') then
339 var res
= search_module_in_paths
(null, path
, self.paths
)
340 if res
!= null then return res
343 # Found nothing? maybe it is a group...
345 if path
.file_exists
then
346 var mgroup
= identify_group
(path
)
347 if mgroup
!= null then
348 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
349 if owner_path
.file_exists
then candidate
= owner_path
353 if candidate
== null then
359 # Does the file exists?
360 if not path
.file_exists
then
364 # Fast track, the path is already known
365 if identified_modules_by_path
.has_key
(path
) then return identified_modules_by_path
[path
]
366 var rp
= module_absolute_path
(path
)
367 if identified_modules_by_path
.has_key
(rp
) then return identified_modules_by_path
[rp
]
369 var pn
= path
.basename
(".nit")
372 var mgrouppath
= path
.join_path
("..").simplify_path
373 var mgroup
= identify_group
(mgrouppath
)
375 if mgroup
== null then
377 var mpackage
= new MPackage(pn
, model
)
378 mgroup
= new MGroup(pn
, mpackage
, null) # same name for the root group
379 mgroup
.filepath
= path
380 mpackage
.root
= mgroup
381 toolcontext
.info
("found singleton package `{pn}` at {path}", 2)
383 # Attach homonymous `ini` file to the package
384 var inipath
= path
.dirname
/ "{pn}.ini"
385 if inipath
.file_exists
then
386 var ini
= new ConfigTree(inipath
)
391 var src
= new SourceFile.from_string
(path
, "")
392 var loc
= new Location(src
, 0, 0, 0, 0)
393 var res
= new MModule(model
, mgroup
, pn
, loc
)
396 identified_modules_by_path
[rp
] = res
397 identified_modules_by_path
[path
] = res
398 identified_modules
.add
(res
)
403 private var mgroups
= new HashMap[String, nullable MGroup]
405 # Return the mgroup associated to a directory path.
406 # If the directory is not a group null is returned.
408 # Note: `paths` is also used to look for mgroups
409 fun identify_group
(dirpath
: String): nullable MGroup
411 var stat
= dirpath
.file_stat
413 if stat
== null then do
414 # search dirless directories in known -I paths
415 if dirpath
.chars
.has
('/') then return null
417 var try
= p
/ dirpath
427 # Filter out non-directories
428 if not stat
.is_dir
then
432 # Fast track, the path is already known
433 var rdp
= module_absolute_path
(dirpath
)
434 if mgroups
.has_key
(rdp
) then
438 # By default, the name of the package or group is the base_name of the directory
439 var pn
= rdp
.basename
441 # Check `package.ini` that indicate a package
444 var inipath
= dirpath
/ "package.ini"
445 if inipath
.file_exists
then
446 ini
= new ConfigTree(inipath
)
450 # No ini, multiple course of action
452 # The root of the directory hierarchy in the file system.
458 # Special stopper `packages.ini`
459 if (dirpath
/"packages.ini").file_exists
then
460 # dirpath cannot be a package since it is a package directory
465 # check the parent directory (if it does not contain the stopper file)
466 var parentpath
= dirpath
.join_path
("..").simplify_path
467 var stopper
= parentpath
/ "packages.ini"
468 if not stopper
.file_exists
then
469 # Recursively get the parent group
470 parent
= identify_group
(parentpath
)
471 if parent
== null then
472 # Parent is not a group, thus we are not a group either
480 if parent
== null then
481 # no parent, thus new package
482 if ini
!= null then pn
= ini
["package.name"] or else pn
483 var mpackage
= new MPackage(pn
, model
)
484 mgroup
= new MGroup(pn
, mpackage
, null) # same name for the root group
485 mpackage
.root
= mgroup
486 toolcontext
.info
("found package `{mpackage}` at {dirpath}", 2)
489 mgroup
= new MGroup(pn
, parent
.mpackage
, parent
)
490 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
493 # search documentation
494 # in src first so the documentation of the package code can be distinct for the documentation of the package usage
495 var readme
= dirpath
.join_path
("README.md")
496 if not readme
.file_exists
then readme
= dirpath
.join_path
("README")
497 if readme
.file_exists
then
498 var mdoc
= load_markdown
(readme
)
500 mdoc
.original_mentity
= mgroup
503 mgroup
.filepath
= dirpath
504 mgroups
[rdp
] = mgroup
508 # Load a markdown file as a documentation object
509 fun load_markdown
(filepath
: String): MDoc
511 var s
= new FileReader.open
(filepath
)
512 var lines
= new Array[String]
513 var line_starts
= new Array[Int]
516 var line
= s
.read_line
519 len
+= line
.length
+ 1
522 var source
= new SourceFile.from_string
(filepath
, lines
.join
("\n"))
523 source
.line_starts
.add_all line_starts
524 var mdoc
= new MDoc(new Location(source
, 1, lines
.length
, 0, 0))
525 mdoc
.content
.add_all
(lines
)
529 # Force the identification of all MModule of the group and sub-groups in the file system.
531 # When a group is scanned, its sub-groups hierarchy is filled (see `MGroup::in_nesting`)
532 # and the potential modules (and nested modules) are identified (see `MGroup::modules`).
534 # Basically, this recursively call `identify_group` and `identify_module` on each directory entry.
536 # No-op if the group was already scanned (see `MGroup::scanned`).
537 fun scan_group
(mgroup
: MGroup) do
538 if mgroup
.scanned
then return
539 mgroup
.scanned
= true
540 var p
= mgroup
.filepath
541 # a virtual group has nothing to scan
542 if p
== null then return
544 alpha_comparator
.sort
(files
)
547 var g
= identify_group
(fp
)
548 # Recursively scan for groups of the same package
551 else if g
.mpackage
== mgroup
.mpackage
then
557 # Transform relative paths (starting with '../') into absolute paths
558 private fun module_absolute_path
(path
: String): String do
562 # Try to load a module AST using a path.
563 # Display an error if there is a problem (IO / lexer / parser) and return null
565 # The AST is loaded as is total independence of the model and its entities.
567 # AST are not cached or reused thus a new AST is returned on success.
568 fun load_module_ast
(filename
: String): nullable AModule
570 if not filename
.has_suffix
(".nit") then
571 self.toolcontext
.error
(null, "Error: file `{filename}` is not a valid nit module.")
574 if not filename
.file_exists
then
575 self.toolcontext
.error
(null, "Error: file `{filename}` not found.")
579 self.toolcontext
.info
("load module {filename}", 2)
582 var file
= new FileReader.open
(filename
)
583 var lexer
= new Lexer(new SourceFile(filename
, file
))
584 var parser
= new Parser(lexer
)
585 var tree
= parser
.parse
588 # Handle lexer and parser error
589 var nmodule
= tree
.n_base
590 if nmodule
== null then
591 var neof
= tree
.n_eof
592 assert neof
isa AError
593 error
(neof
, neof
.message
)
600 # Remove Nit source files from a list of arguments.
602 # Items of `args` that can be loaded as a nit file will be removed from `args` and returned.
603 fun filter_nit_source
(args
: Array[String]): Array[String]
605 var keep
= new Array[String]
606 var res
= new Array[String]
608 var l
= identify_module
(a
)
620 # Try to load a module using a path.
621 # Display an error if there is a problem (IO / lexer / parser) and return null.
622 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
624 # The MModule is located, created, parsed and the importation is performed.
625 fun load_module
(filename
: String): nullable AModule
627 # Look for the module
628 var mmodule
= identify_module
(filename
)
629 if mmodule
== null then
630 if filename
.file_exists
then
631 toolcontext
.error
(null, "Error: `{filename}` is not a Nit source file.")
633 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
639 return mmodule
.load
(self)
642 # Injection of a new module without source.
643 # Used by the interpreter.
644 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
649 if parent
!= null then mgroup
= parent
.mgroup
650 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
651 nmodule
.mmodule
= mmodule
652 nmodules
.add
(nmodule
)
653 self.mmodule2nmodule
[mmodule
] = nmodule
655 if parent
!= null then
656 var imported_modules
= new Array[MModule]
657 imported_modules
.add
(parent
)
658 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
659 mmodule
.set_imported_mmodules
(imported_modules
)
661 build_module_importation
(nmodule
)
667 # Visit the AST and create the `MModule` object
668 private fun build_a_mmodule
(mgroup
: nullable MGroup, nmodule
: AModule)
670 var mmodule
= nmodule
.mmodule
671 assert mmodule
!= null
673 # Check the module name
674 var decl
= nmodule
.n_moduledecl
676 var decl_name
= decl
.n_name
.n_id
.text
677 if decl_name
!= mmodule
.name
then
678 error
(decl
.n_name
, "Error: module name mismatch; declared {decl_name} file named {mmodule.name}.")
682 # Check for conflicting module names in the package
683 if mgroup
!= null then
684 var others
= model
.get_mmodules_by_name
(mmodule
.name
)
685 if others
!= null then for other
in others
do
686 if other
!= mmodule
and mmodule2nmodule
.has_key
(mmodule
) and other
.mgroup
!= null and other
.mgroup
.mpackage
== mgroup
.mpackage
then
688 if decl
== null then node
= nmodule
else node
= decl
.n_name
689 error
(node
, "Error: a module named `{other.full_name}` already exists at {other.location}.")
695 nmodules
.add
(nmodule
)
696 self.mmodule2nmodule
[mmodule
] = nmodule
698 var source
= nmodule
.location
.file
699 if source
!= null then
700 assert source
.mmodule
== null
701 source
.mmodule
= mmodule
705 # Extract documentation
706 var ndoc
= decl
.n_doc
708 var mdoc
= ndoc
.to_mdoc
710 mdoc
.original_mentity
= mmodule
712 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
714 # Is the module a test suite?
715 mmodule
.is_test_suite
= not decl
.get_annotations
("test_suite").is_empty
719 # Resolve the module identification for a given `AModuleName`.
721 # This method handles qualified names as used in `AModuleName`.
722 fun seach_module_by_amodule_name
(n_name
: AModuleName, mgroup
: nullable MGroup): nullable MModule
724 var mod_name
= n_name
.n_id
.text
726 # If a quad is given, we ignore the starting group (go from path)
727 if n_name
.n_quad
!= null then mgroup
= null
729 # If name not qualified, just search the name
730 if n_name
.n_path
.is_empty
then
731 # Fast search if no n_path
732 return search_mmodule_by_name
(n_name
, mgroup
, mod_name
)
735 # If qualified and in a group
736 if mgroup
!= null then
737 # First search in the package
738 var r
= mgroup
.mpackage
.root
741 # Get all modules with the final name
742 var res
= r
.mmodules_by_name
(mod_name
)
743 # Filter out the name that does not match the qualifiers
744 res
= [for x
in res
do if match_amodulename
(n_name
, x
) then x
]
745 if res
.not_empty
then
746 if res
.length
> 1 then
747 error
(n_name
, "Error: conflicting module files for `{mod_name}`: `{[for x in res do x.filepath or else x.full_name].join("`, `")}`")
753 # If no module yet, then assume that the first element of the path
754 # Is to be searched in the path.
755 var root_name
= n_name
.n_path
.first
.text
756 var roots
= search_group_in_paths
(root_name
, paths
)
757 if roots
.is_empty
then
758 error
(n_name
, "Error: cannot find `{root_name}`. Tried: {paths.join(", ")}.")
762 var res
= new ArraySet[MModule]
764 # Then, for each root, collect modules that matches the qualifiers
766 var root_res
= r
.mmodules_by_name
(mod_name
)
767 for x
in root_res
do if match_amodulename
(n_name
, x
) then res
.add x
769 if res
.not_empty
then
770 if res
.length
> 1 then
771 error
(n_name
, "Error: conflicting module files for `{mod_name}`: `{[for x in res do x.filepath or else x.full_name].join("`, `")}`")
775 # If still nothing, just call a basic search that will fail and will produce an error message
776 error
(n_name
, "Error: cannot find module `{mod_name}` from `{root_name}`. Tried: {paths.join(", ")}.")
780 # Is elements of `n_name` correspond to the group nesting of `m`?
782 # Basically it check that `bar::foo` matches `bar/foo.nit` and `bar/baz/foo.nit`
783 # but not `baz/foo.nit` nor `foo/bar.nit`
785 # Is used by `seach_module_by_amodule_name` to validate qualified names.
786 private fun match_amodulename
(n_name
: AModuleName, m
: MModule): Bool
788 var g
: nullable MGroup = m
.mgroup
789 for grp
in n_name
.n_path
.reverse_iterator
do
790 while g
!= null and grp
.text
!= g
.name
do
797 # Analyze the module importation and fill the module_importation_hierarchy
799 # If the importation was already done (`nmodule.is_importation_done`), this method does a no-op.
801 # REQUIRE `nmodule.mmodule != null`
802 # ENSURE `nmodule.is_importation_done`
803 fun build_module_importation
(nmodule
: AModule)
805 if nmodule
.is_importation_done
then return
806 nmodule
.is_importation_done
= true
807 var mmodule
= nmodule
.mmodule
.as(not null)
809 var imported_modules
= new Array[MModule]
810 for aimport
in nmodule
.n_imports
do
811 # Do not imports conditional
812 var atconditionals
= aimport
.get_annotations
("conditional")
813 if atconditionals
.not_empty
then continue
816 if not aimport
isa AStdImport then
820 # Load the imported module
821 var sup
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
823 mmodule
.is_broken
= true
824 nmodule
.mmodule
= null # invalidate the module
825 continue # Skip error
827 var ast
= sup
.load
(self)
829 mmodule
.is_broken
= true
830 nmodule
.mmodule
= null # invalidate the module
831 continue # Skip error
834 aimport
.mmodule
= sup
835 imported_modules
.add
(sup
)
836 var mvisibility
= aimport
.n_visibility
.mvisibility
837 if mvisibility
== protected_visibility
then
838 mmodule
.is_broken
= true
839 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
840 mmodule
.is_broken
= true
841 nmodule
.mmodule
= null # invalidate the module
844 if sup
== mmodule
then
845 error
(aimport
.n_name
, "Error: dependency loop in module {mmodule}.")
846 mmodule
.is_broken
= true
847 nmodule
.mmodule
= null # invalidate the module
849 if sup
.in_importation
< mmodule
then
850 error
(aimport
.n_name
, "Error: dependency loop between modules {mmodule} and {sup}.")
851 mmodule
.is_broken
= true
852 nmodule
.mmodule
= null # invalidate the module
855 mmodule
.set_visibility_for
(sup
, mvisibility
)
858 var mod_name
= "core"
859 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
861 mmodule
.is_broken
= true
862 nmodule
.mmodule
= null # invalidate the module
864 imported_modules
.add
(sup
)
865 mmodule
.set_visibility_for
(sup
, public_visibility
)
869 # Declare conditional importation
870 for aimport
in nmodule
.n_imports
do
871 if not aimport
isa AStdImport then continue
872 var atconditionals
= aimport
.get_annotations
("conditional")
873 if atconditionals
.is_empty
then continue
875 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
876 if suppath
== null then continue # skip error
878 for atconditional
in atconditionals
do
879 var nargs
= atconditional
.n_args
880 if nargs
.is_empty
then
881 error
(atconditional
, "Syntax Error: `conditional` expects module identifiers as arguments.")
886 var rule
= new Array[MModule]
888 # First element is the goal, thus
891 # Second element is the first condition, that is to be a client of the current module
894 # Other condition are to be also a client of each modules indicated as arguments of the annotation
898 error
(narg
, "Syntax Error: `conditional` expects module identifier as arguments.")
902 var mp
= search_mmodule_by_name
(narg
, mmodule
.mgroup
, id
)
903 if mp
== null then continue
908 conditional_importations
.add rule
912 mmodule
.set_imported_mmodules
(imported_modules
)
914 apply_conditional_importations
(mmodule
)
916 self.toolcontext
.info
("{mmodule} imports {mmodule.in_importation.direct_greaters.join(", ")}", 3)
918 # Force `core` to be public if imported
919 for sup
in mmodule
.in_importation
.greaters
do
920 if sup
.name
== "core" then
921 mmodule
.set_visibility_for
(sup
, public_visibility
)
925 # TODO: Correctly check for useless importation
927 var directs
= mmodule
.in_importation
.direct_greaters
928 for nim
in nmodule
.n_imports
do
929 if not nim
isa AStdImport then continue
931 if im
== null then continue
932 if directs
.has
(im
) then continue
933 # This generates so much noise that it is simpler to just comment it
934 #warning(nim, "Warning: possible useless importation of {im}")
938 # Global list of conditional importation rules.
940 # Each rule is a "Horn clause"-like sequence of modules.
941 # It means that the first module is the module to automatically import.
942 # The remaining modules are the conditions of the rule.
944 # Rules are declared by `build_module_importation` and are applied by `apply_conditional_importations`
945 # (and `build_module_importation` that calls it).
947 # TODO (when the loader will be rewritten): use a better representation and move up rules in the model.
948 private var conditional_importations
= new Array[SequenceRead[MModule]]
950 # Extends the current importations according to imported rules about conditional importation
951 fun apply_conditional_importations
(mmodule
: MModule)
953 # Because a conditional importation may cause additional conditional importation, use a fixed point
954 # The rules are checked naively because we assume that it does not worth to be optimized
955 var check_conditional_importations
= true
956 while check_conditional_importations
do
957 check_conditional_importations
= false
959 for ci
in conditional_importations
do
961 for i
in [1..ci
.length
[ do
964 if not mmodule
.in_importation
.greaters
.has
(m
) then continue label
966 # Still here? It means that all conditions modules are loaded and imported
968 # Identify the module to automatically import
970 var ast
= sup
.load
(self)
971 if ast
== null then continue
973 # Do nothing if already imported
974 if mmodule
.in_importation
.greaters
.has
(sup
) then continue label
977 self.toolcontext
.info
("{mmodule} conditionally imports {sup}", 3)
978 # TODO visibility rules (currently always public)
979 mmodule
.set_visibility_for
(sup
, public_visibility
)
980 # TODO linearization rules (currently added at the end in the order of the rules)
981 mmodule
.set_imported_mmodules
([sup
])
983 # Prepare to reapply the rules
984 check_conditional_importations
= true
989 # All the loaded modules
990 var nmodules
= new Array[AModule]
992 # Register the nmodule associated to each mmodule
994 # Public clients need to use `mmodule2node` to access stuff.
995 private var mmodule2nmodule
= new HashMap[MModule, AModule]
997 # Retrieve the associated AST node of a mmodule.
998 # This method is used to associate model entity with syntactic entities.
1000 # If the module is not associated with a node, returns null.
1001 fun mmodule2node
(mmodule
: MModule): nullable AModule
1003 return mmodule2nmodule
.get_or_null
(mmodule
)
1008 # The path of the module source
1009 var filepath
: nullable String = null
1011 # Force the parsing of the module using `modelbuilder`.
1013 # If the module was already parsed, the existing ASI is returned.
1014 # Else the source file is loaded, and parsed and some
1016 # The importation is not done by this
1018 # REQUIRE: `filepath != null`
1019 # ENSURE: `modelbuilder.parsed_modules.has(self)`
1020 fun parse
(modelbuilder
: ModelBuilder): nullable AModule
1022 # Already known and loaded? then return it
1023 var nmodule
= modelbuilder
.mmodule2nmodule
.get_or_null
(self)
1024 if nmodule
!= null then return nmodule
1026 var filepath
= self.filepath
1027 assert filepath
!= null
1029 nmodule
= modelbuilder
.load_module_ast
(filepath
)
1030 if nmodule
== null then return null # forward error
1033 nmodule
.mmodule
= self
1034 modelbuilder
.build_a_mmodule
(mgroup
, nmodule
)
1036 modelbuilder
.parsed_modules
.add
self
1040 # Parse and process importation of a given MModule.
1042 # Basically chains `parse` and `build_module_importation`.
1043 fun load
(modelbuilder
: ModelBuilder): nullable AModule
1045 var nmodule
= parse
(modelbuilder
)
1046 if nmodule
== null then return null
1048 modelbuilder
.build_module_importation
(nmodule
)
1053 redef class MPackage
1054 # The associated `.ini` file, if any
1056 # The `ini` file is given as is and might contain invalid or missing information.
1058 # Some packages, like stand-alone packages or virtual packages have no `ini` file associated.
1059 var ini
: nullable ConfigTree = null
1063 # Is the group interesting for a final user?
1065 # Groups are mandatory in the model but for simple packages they are not
1066 # always interesting.
1068 # A interesting group has, at least, one of the following true:
1070 # * it has 2 modules or more
1071 # * it has a subgroup
1072 # * it has a documentation
1073 fun is_interesting
: Bool
1075 return mmodules
.length
> 1 or
1076 not in_nesting
.direct_smallers
.is_empty
or
1078 (mmodules
.length
== 1 and default_mmodule
== null)
1081 # Are files and directories in self scanned?
1083 # See `ModelBuilder::scan_group`.
1086 # Return the modules in self and subgroups named `name`.
1088 # If `self` is not scanned (see `ModelBuilder::scan_group`) the
1089 # results might be partial.
1090 fun mmodules_by_name
(name
: String): Array[MModule]
1092 var res
= new Array[MModule]
1093 for g
in in_nesting
.smallers
do
1094 for mp
in g
.mmodules
do
1095 if mp
.name
== name
then
1104 redef class SourceFile
1105 # Associated mmodule, once created
1106 var mmodule
: nullable MModule = null
1109 redef class AStdImport
1110 # The imported module once determined
1111 var mmodule
: nullable MModule = null
1115 # The associated MModule once build by a `ModelBuilder`
1116 var mmodule
: nullable MModule = null
1118 # Flag that indicate if the importation is already completed
1119 var is_importation_done
: Bool = false