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
20 import modelbuilder_base
22 redef class ToolContext
24 var opt_path
= new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
26 # Option --only-metamodel
27 var opt_only_metamodel
= new OptionBool("Stop after meta-model processing", "--only-metamodel")
30 var opt_only_parse
= new OptionBool("Only proceed to parse step of loaders", "--only-parse")
35 option_context
.add_option
(opt_path
, opt_only_parse
, opt_only_metamodel
)
39 redef class ModelBuilder
44 # Setup the paths value
45 paths
.append
(toolcontext
.opt_path
.value
)
47 var path_env
= "NIT_PATH".environ
48 if not path_env
.is_empty
then
49 paths
.append
(path_env
.split_with
(':'))
52 var nit_dir
= toolcontext
.nit_dir
53 var libname
= nit_dir
/"lib"
54 if libname
.file_exists
then paths
.add
(libname
)
55 libname
= nit_dir
/"contrib"
56 if libname
.file_exists
then paths
.add
(libname
)
59 # Load a bunch of modules.
60 # `modules` can contains filenames or module names.
61 # Imported modules are automatically loaded and modelized.
62 # The result is the corresponding model elements.
63 # Errors and warnings are printed with the toolcontext.
65 # Note: class and property model elements are not analysed.
66 fun parse
(modules
: Sequence[String]): Array[MModule]
69 # Parse and recursively load
70 self.toolcontext
.info
("*** PARSE ***", 1)
71 var mmodules
= new ArraySet[MModule]
73 var nmodule
= self.load_module
(a
)
74 if nmodule
== null then continue # Skip error
75 # Load imported module
76 build_module_importation
(nmodule
)
77 var mmodule
= nmodule
.mmodule
78 if mmodule
== null then continue # skip error
82 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
84 self.toolcontext
.check_errors
86 if toolcontext
.opt_only_parse
.value
then
87 self.toolcontext
.info
("*** ONLY PARSE...", 1)
94 # Load recursively all modules of the group `mgroup`.
95 # See `parse` for details.
96 fun parse_group
(mgroup
: MGroup): Array[MModule]
98 var res
= new Array[MModule]
100 for mg
in mgroup
.in_nesting
.smallers
do
101 for mp
in mg
.module_paths
do
102 var nmodule
= self.load_module
(mp
.filepath
)
103 if nmodule
== null then continue # Skip error
104 # Load imported module
105 build_module_importation
(nmodule
)
106 var mmodule
= nmodule
.mmodule
107 if mmodule
== null then continue # Skip error
114 # Load a bunch of modules and groups.
118 # * a path to a module, a group or a directory of projects.
119 # * a short name of a module or a group that are looked in the `paths` (-I)
121 # Then, for each entry, if it is:
123 # * a module, then is it parser and returned.
124 # * a group then recursively all its modules are parsed.
125 # * a directory of projects then all the modules of all projects are parsed.
126 # * else an error is displayed.
128 # See `parse` for details.
129 fun parse_full
(names
: Sequence[String]): Array[MModule]
132 # Parse and recursively load
133 self.toolcontext
.info
("*** PARSE ***", 1)
134 var mmodules
= new ArraySet[MModule]
137 var mgroup
= self.get_mgroup
(a
)
138 if mgroup
!= null then
139 mmodules
.add_all parse_group
(mgroup
)
143 # Case of a directory that is not a group
144 var stat
= a
.to_path
.stat
145 if stat
!= null and stat
.is_dir
then
146 self.toolcontext
.info
("look in directory {a}", 2)
148 # Try each entry as a group or a module
151 mgroup
= get_mgroup
(af
)
152 if mgroup
!= null then
153 mmodules
.add_all parse_group
(mgroup
)
156 var mp
= identify_file
(af
)
158 var nmodule
= self.load_module
(af
)
159 if nmodule
== null then continue # Skip error
160 build_module_importation
(nmodule
)
161 var mmodule
= nmodule
.mmodule
162 if mmodule
== null then continue # Skip error
165 self.toolcontext
.info
("ignore file {af}", 2)
171 var nmodule
= self.load_module
(a
)
172 if nmodule
== null then continue # Skip error
173 # Load imported module
174 build_module_importation
(nmodule
)
175 var mmodule
= nmodule
.mmodule
176 if mmodule
== null then continue # Skip error
180 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
182 self.toolcontext
.check_errors
184 if toolcontext
.opt_only_parse
.value
then
185 self.toolcontext
.info
("*** ONLY PARSE...", 1)
192 # The list of directories to search for top level modules
193 # The list is initially set with:
195 # * the toolcontext --path option
196 # * the NIT_PATH environment variable
197 # * `toolcontext.nit_dir`
198 # Path can be added (or removed) by the client
199 var paths
= new Array[String]
201 # Like (and used by) `get_mmodule_by_name` but just return the ModulePath
202 fun search_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable ModulePath
204 # First, look in groups
207 var dirname
= c
.filepath
208 if dirname
== null then break # virtual group
209 if dirname
.has_suffix
(".nit") then break # singleton project
211 # Second, try the directory to find a file
212 var try_file
= dirname
+ "/" + name
+ ".nit"
213 if try_file
.file_exists
then
214 var res
= self.identify_file
(try_file
.simplify_path
)
219 # Third, try if the requested module is itself a group
220 try_file
= dirname
+ "/" + name
+ "/" + name
+ ".nit"
221 if try_file
.file_exists
then
222 var res
= self.identify_file
(try_file
.simplify_path
)
227 # Fourth, try if the requested module is itself a group with a src
228 try_file
= dirname
+ "/" + name
+ "/src/" + name
+ ".nit"
229 if try_file
.file_exists
then
230 var res
= self.identify_file
(try_file
.simplify_path
)
238 # Look at some known directories
239 var lookpaths
= self.paths
241 # Look in the directory of the group project also (even if not explicitly in the path)
242 if mgroup
!= null then
243 # path of the root group
244 var dirname
= mgroup
.mproject
.root
.filepath
245 if dirname
!= null then
246 dirname
= dirname
.join_path
("..").simplify_path
247 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
248 lookpaths
= lookpaths
.to_a
249 lookpaths
.add
(dirname
)
254 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
256 if candidate
== null then
257 if mgroup
!= null then
258 error
(anode
, "Error: cannot find module `{name}` from `{mgroup.name}`. Tried: {lookpaths.join(", ")}.")
260 error
(anode
, "Error: cannot find module `{name}`. Tried: {lookpaths.join(", ")}.")
267 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
268 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
269 # if `mgroup` is null then the module is searched in the top level only.
270 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
271 fun get_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
273 var path
= search_mmodule_by_name
(anode
, mgroup
, name
)
274 if path
== null then return null # Forward error
275 return load_module_path
(path
)
278 # Load and process importation of a given ModulePath.
280 # Basically chains `load_module` and `build_module_importation`.
281 fun load_module_path
(path
: ModulePath): nullable MModule
283 var res
= self.load_module
(path
.filepath
)
284 if res
== null then return null # Forward error
285 # Load imported module
286 build_module_importation
(res
)
290 # Search a module `name` from path `lookpaths`.
291 # If found, the path of the file is returned
292 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
294 var candidate
: nullable String = null
295 for dirname
in lookpaths
do
296 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
297 if try_file
.file_exists
then
298 if candidate
== null then
300 else if candidate
!= try_file
then
301 # try to disambiguate conflicting modules
302 var abs_candidate
= module_absolute_path
(candidate
)
303 var abs_try_file
= module_absolute_path
(try_file
)
304 if abs_candidate
!= abs_try_file
then
305 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
309 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
310 if try_file
.file_exists
then
311 if candidate
== null then
313 else if candidate
!= try_file
then
314 # try to disambiguate conflicting modules
315 var abs_candidate
= module_absolute_path
(candidate
)
316 var abs_try_file
= module_absolute_path
(try_file
)
317 if abs_candidate
!= abs_try_file
then
318 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
322 try_file
= (dirname
+ "/" + name
+ "/src/" + name
+ ".nit").simplify_path
323 if try_file
.file_exists
then
324 if candidate
== null then
326 else if candidate
!= try_file
then
327 # try to disambiguate conflicting modules
328 var abs_candidate
= module_absolute_path
(candidate
)
329 var abs_try_file
= module_absolute_path
(try_file
)
330 if abs_candidate
!= abs_try_file
then
331 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
336 if candidate
== null then return null
337 return identify_file
(candidate
)
340 # Cache for `identify_file` by realpath
341 private var identified_files_by_path
= new HashMap[String, nullable ModulePath]
343 # All the currently identified modules.
344 # See `identify_file`.
345 var identified_files
= new Array[ModulePath]
347 # Identify a source file
348 # Load the associated project and groups if required
350 # Silently return `null` if `path` is not a valid module path.
351 fun identify_file
(path
: String): nullable ModulePath
353 # special case for not a nit file
354 if path
.file_extension
!= "nit" then
355 # search dirless files in known -I paths
356 if path
.dirname
== "." then
357 var res
= search_module_in_paths
(null, path
, self.paths
)
358 if res
!= null then return res
361 # Found nothing? maybe it is a group...
363 if path
.file_exists
then
364 var mgroup
= get_mgroup
(path
)
365 if mgroup
!= null then
366 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
367 if owner_path
.file_exists
then candidate
= owner_path
371 if candidate
== null then
377 # Fast track, the path is already known
378 var pn
= path
.basename
(".nit")
379 var rp
= module_absolute_path
(path
)
380 if identified_files_by_path
.has_key
(rp
) then return identified_files_by_path
[rp
]
383 var mgrouppath
= path
.join_path
("..").simplify_path
384 var mgroup
= get_mgroup
(mgrouppath
)
386 if mgroup
== null then
388 var mproject
= new MProject(pn
, model
)
389 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
390 mgroup
.filepath
= path
391 mproject
.root
= mgroup
392 toolcontext
.info
("found project `{pn}` at {path}", 2)
395 var res
= new ModulePath(pn
, path
, mgroup
)
396 mgroup
.module_paths
.add
(res
)
398 identified_files_by_path
[rp
] = res
399 identified_files
.add
(res
)
404 private var mgroups
= new HashMap[String, nullable MGroup]
406 # Return the mgroup associated to a directory path.
407 # If the directory is not a group null is returned.
409 # Note: `paths` is also used to look for mgroups
410 fun get_mgroup
(dirpath
: String): nullable MGroup
412 if not dirpath
.file_exists
then do
414 var try
= p
/ dirpath
415 if try
.file_exists
then
423 var rdp
= module_absolute_path
(dirpath
)
424 if mgroups
.has_key
(rdp
) then
428 # Hack, a group is determined by one of the following:
429 # * the presence of a honomymous nit file
430 # * the fact that the directory is named `src`
431 # * the fact that there is a sub-directory named `src`
432 var pn
= rdp
.basename
(".nit")
433 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
435 # dirpath2 is the root directory
436 # dirpath is the src subdirectory directory, if any, else it is the same that dirpath2
437 var dirpath2
= dirpath
438 if not mp
.file_exists
then
440 # With a src directory, the group name is the name of the parent directory
441 dirpath2
= rdp
.dirname
442 pn
= dirpath2
.basename
444 # Check a `src` subdirectory
445 dirpath
= dirpath2
/ "src"
446 if not dirpath
.file_exists
then
447 # All rules failed, so return null
453 # check parent directory
454 var parentpath
= dirpath2
.join_path
("..").simplify_path
455 var parent
= get_mgroup
(parentpath
)
458 if parent
== null then
459 # no parent, thus new project
460 var mproject
= new MProject(pn
, model
)
461 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
462 mproject
.root
= mgroup
463 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
465 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
466 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
469 # search documentation
470 # in src first so the documentation of the project code can be distinct for the documentation of the project usage
471 var readme
= dirpath
.join_path
("README.md")
472 if not readme
.file_exists
then readme
= dirpath
.join_path
("README")
473 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README.md")
474 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README")
475 if readme
.file_exists
then
476 var mdoc
= load_markdown
(readme
)
478 mdoc
.original_mentity
= mgroup
481 mgroup
.filepath
= dirpath
482 mgroups
[module_absolute_path
(dirpath
)] = mgroup
483 mgroups
[module_absolute_path
(dirpath2
)] = mgroup
487 # Load a markdown file as a documentation object
488 fun load_markdown
(filepath
: String): MDoc
490 var s
= new FileReader.open
(filepath
)
491 var lines
= new Array[String]
492 var line_starts
= new Array[Int]
495 var line
= s
.read_line
498 len
+= line
.length
+ 1
501 var source
= new SourceFile.from_string
(filepath
, lines
.join
("\n"))
502 source
.line_starts
.add_all line_starts
503 var mdoc
= new MDoc(new Location(source
, 1, lines
.length
, 0, 0))
504 mdoc
.content
.add_all
(lines
)
508 # Force the identification of all ModulePath of the group and sub-groups.
509 fun visit_group
(mgroup
: MGroup) do
510 var p
= mgroup
.filepath
513 var g
= get_mgroup
(fp
)
514 if g
!= null then visit_group
(g
)
519 # Transform relative paths (starting with '../') into absolute paths
520 private fun module_absolute_path
(path
: String): String do
521 return getcwd
.join_path
(path
).simplify_path
524 # Try to load a module AST using a path.
525 # Display an error if there is a problem (IO / lexer / parser) and return null
526 fun load_module_ast
(filename
: String): nullable AModule
528 if filename
.file_extension
!= "nit" then
529 self.toolcontext
.error
(null, "Error: file `{filename}` is not a valid nit module.")
532 if not filename
.file_exists
then
533 self.toolcontext
.error
(null, "Error: file `{filename}` not found.")
537 self.toolcontext
.info
("load module {filename}", 2)
540 var file
= new FileReader.open
(filename
)
541 var lexer
= new Lexer(new SourceFile(filename
, file
))
542 var parser
= new Parser(lexer
)
543 var tree
= parser
.parse
546 # Handle lexer and parser error
547 var nmodule
= tree
.n_base
548 if nmodule
== null then
549 var neof
= tree
.n_eof
550 assert neof
isa AError
551 error
(neof
, neof
.message
)
558 # Remove Nit source files from a list of arguments.
560 # Items of `args` that can be loaded as a nit file will be removed from `args` and returned.
561 fun filter_nit_source
(args
: Array[String]): Array[String]
563 var keep
= new Array[String]
564 var res
= new Array[String]
566 var l
= identify_file
(a
)
578 # Try to load a module using a path.
579 # Display an error if there is a problem (IO / lexer / parser) and return null.
580 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
582 # The MModule is created however, the importation is not performed,
583 # therefore you should call `build_module_importation`.
584 fun load_module
(filename
: String): nullable AModule
586 # Look for the module
587 var file
= identify_file
(filename
)
589 if filename
.file_exists
then
590 toolcontext
.error
(null, "Error: `{filename}` is not a Nit source file.")
592 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
597 # Already known and loaded? then return it
598 var mmodule
= file
.mmodule
599 if mmodule
!= null then
600 return mmodule2nmodule
[mmodule
]
604 var nmodule
= load_module_ast
(file
.filepath
)
605 if nmodule
== null then return null # forward error
607 # build the mmodule and load imported modules
608 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
610 if mmodule
== null then return null # forward error
612 # Update the file information
613 file
.mmodule
= mmodule
618 # Injection of a new module without source.
619 # Used by the interpreter.
620 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
625 if parent
!= null then mgroup
= parent
.mgroup
626 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
627 nmodule
.mmodule
= mmodule
628 nmodules
.add
(nmodule
)
629 self.mmodule2nmodule
[mmodule
] = nmodule
631 if parent
!= null then
632 var imported_modules
= new Array[MModule]
633 imported_modules
.add
(parent
)
634 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
635 mmodule
.set_imported_mmodules
(imported_modules
)
637 build_module_importation
(nmodule
)
643 # Visit the AST and create the `MModule` object
644 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
646 # Check the module name
647 var decl
= nmodule
.n_moduledecl
649 var decl_name
= decl
.n_name
.n_id
.text
650 if decl_name
!= mod_name
then
651 error
(decl
.n_name
, "Error: module name mismatch; declared {decl_name} file named {mod_name}.")
655 # Check for conflicting module names in the project
656 if mgroup
!= null then
657 var others
= model
.get_mmodules_by_name
(mod_name
)
658 if others
!= null then for other
in others
do
659 if other
.mgroup
!= null and other
.mgroup
.mproject
== mgroup
.mproject
then
661 if decl
== null then node
= nmodule
else node
= decl
.n_name
662 error
(node
, "Error: a module named `{other.full_name}` already exists at {other.location}.")
669 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
670 nmodule
.mmodule
= mmodule
671 nmodules
.add
(nmodule
)
672 self.mmodule2nmodule
[mmodule
] = nmodule
674 var source
= nmodule
.location
.file
675 if source
!= null then
676 assert source
.mmodule
== null
677 source
.mmodule
= mmodule
681 # Extract documentation
682 var ndoc
= decl
.n_doc
684 var mdoc
= ndoc
.to_mdoc
686 mdoc
.original_mentity
= mmodule
688 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
690 # Is the module a test suite?
691 mmodule
.is_test_suite
= not decl
.get_annotations
("test_suite").is_empty
697 # Resolve the module identification for a given `AModuleName`.
699 # This method handles qualified names as used in `AModuleName`.
700 fun seach_module_by_amodule_name
(n_name
: AModuleName, mgroup
: nullable MGroup): nullable ModulePath
702 if n_name
.n_quad
!= null then mgroup
= null # Start from top level
703 for grp
in n_name
.n_path
do
704 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
705 if path
== null then return null # Forward error
708 var mod_name
= n_name
.n_id
.text
709 return search_mmodule_by_name
(n_name
, mgroup
, mod_name
)
712 # Analyze the module importation and fill the module_importation_hierarchy
714 # Unless you used `load_module`, the importation is already done and this method does a no-op.
715 fun build_module_importation
(nmodule
: AModule)
717 if nmodule
.is_importation_done
then return
718 nmodule
.is_importation_done
= true
719 var mmodule
= nmodule
.mmodule
.as(not null)
721 var imported_modules
= new Array[MModule]
722 for aimport
in nmodule
.n_imports
do
723 # Do not imports conditional
724 var atconditionals
= aimport
.get_annotations
("conditional")
725 if atconditionals
.not_empty
then continue
728 if not aimport
isa AStdImport then
732 # Load the imported module
733 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
734 if suppath
== null then
735 nmodule
.mmodule
= null # invalidate the module
736 continue # Skip error
738 var sup
= load_module_path
(suppath
)
740 nmodule
.mmodule
= null # invalidate the module
741 continue # Skip error
744 aimport
.mmodule
= sup
745 imported_modules
.add
(sup
)
746 var mvisibility
= aimport
.n_visibility
.mvisibility
747 if mvisibility
== protected_visibility
then
748 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
749 nmodule
.mmodule
= null # invalidate the module
752 if sup
== mmodule
then
753 error
(aimport
.n_name
, "Error: dependency loop in module {mmodule}.")
754 nmodule
.mmodule
= null # invalidate the module
756 if sup
.in_importation
< mmodule
then
757 error
(aimport
.n_name
, "Error: dependency loop between modules {mmodule} and {sup}.")
758 nmodule
.mmodule
= null # invalidate the module
761 mmodule
.set_visibility_for
(sup
, mvisibility
)
764 var mod_name
= "standard"
765 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
767 nmodule
.mmodule
= null # invalidate the module
769 imported_modules
.add
(sup
)
770 mmodule
.set_visibility_for
(sup
, public_visibility
)
774 # Declare conditional importation
775 for aimport
in nmodule
.n_imports
do
776 if not aimport
isa AStdImport then continue
777 var atconditionals
= aimport
.get_annotations
("conditional")
778 if atconditionals
.is_empty
then continue
780 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
781 if suppath
== null then continue # skip error
783 for atconditional
in atconditionals
do
784 var nargs
= atconditional
.n_args
785 if nargs
.is_empty
then
786 error
(atconditional
, "Syntax Error: `conditional` expects module identifiers as arguments.")
791 var rule
= new Array[Object]
793 # First element is the goal, thus
796 # Second element is the first condition, that is to be a client of the current module
799 # Other condition are to be also a client of each modules indicated as arguments of the annotation
803 error
(narg
, "Syntax Error: `conditional` expects module identifier as arguments.")
807 var mp
= search_mmodule_by_name
(narg
, mmodule
.mgroup
, id
)
808 if mp
== null then continue
813 conditional_importations
.add rule
817 mmodule
.set_imported_mmodules
(imported_modules
)
819 apply_conditional_importations
(mmodule
)
821 self.toolcontext
.info
("{mmodule} imports {mmodule.in_importation.direct_greaters.join(", ")}", 3)
823 # Force standard to be public if imported
824 for sup
in mmodule
.in_importation
.greaters
do
825 if sup
.name
== "standard" then
826 mmodule
.set_visibility_for
(sup
, public_visibility
)
830 # TODO: Correctly check for useless importation
832 var directs
= mmodule
.in_importation
.direct_greaters
833 for nim
in nmodule
.n_imports
do
834 if not nim
isa AStdImport then continue
836 if im
== null then continue
837 if directs
.has
(im
) then continue
838 # This generates so much noise that it is simpler to just comment it
839 #warning(nim, "Warning: possible useless importation of {im}")
843 # Global list of conditional importation rules.
845 # Each rule is a "Horn clause"-like sequence of modules.
846 # It means that the first module is the module to automatically import.
847 # The remaining modules are the conditions of the rule.
849 # Each module is either represented by a MModule (if the module is already loaded)
850 # or by a ModulePath (if the module is not yet loaded).
852 # Rules are declared by `build_module_importation` and are applied by `apply_conditional_importations`
853 # (and `build_module_importation` that calls it).
855 # TODO (when the loader will be rewritten): use a better representation and move up rules in the model.
856 private var conditional_importations
= new Array[SequenceRead[Object]]
858 # Extends the current importations according to imported rules about conditional importation
859 fun apply_conditional_importations
(mmodule
: MModule)
861 # Because a conditional importation may cause additional conditional importation, use a fixed point
862 # The rules are checked naively because we assume that it does not worth to be optimized
863 var check_conditional_importations
= true
864 while check_conditional_importations
do
865 check_conditional_importations
= false
867 for ci
in conditional_importations
do
869 for i
in [1..ci
.length
[ do
870 var rule_element
= ci
[i
]
871 # An element of a rule is either a MModule or a ModulePath
872 # We need the mmodule to resonate on the importation
874 if rule_element
isa MModule then
876 else if rule_element
isa ModulePath then
877 m
= rule_element
.mmodule
879 if m
== null then continue label
884 if not mmodule
.in_importation
.greaters
.has
(m
) then continue label
886 # Still here? It means that all conditions modules are loaded and imported
888 # Identify the module to automatically import
889 var suppath
= ci
.first
.as(ModulePath)
890 var sup
= load_module_path
(suppath
)
891 if sup
== null then continue
893 # Do nothing if already imported
894 if mmodule
.in_importation
.greaters
.has
(sup
) then continue label
897 self.toolcontext
.info
("{mmodule} conditionally imports {sup}", 3)
898 # TODO visibility rules (currently always public)
899 mmodule
.set_visibility_for
(sup
, public_visibility
)
900 # TODO linearization rules (currently added at the end in the order of the rules)
901 mmodule
.set_imported_mmodules
([sup
])
903 # Prepare to reapply the rules
904 check_conditional_importations
= true
909 # All the loaded modules
910 var nmodules
= new Array[AModule]
912 # Register the nmodule associated to each mmodule
914 # Public clients need to use `mmodule2node` to access stuff.
915 private var mmodule2nmodule
= new HashMap[MModule, AModule]
917 # Retrieve the associated AST node of a mmodule.
918 # This method is used to associate model entity with syntactic entities.
920 # If the module is not associated with a node, returns null.
921 fun mmodule2node
(mmodule
: MModule): nullable AModule
923 return mmodule2nmodule
.get_or_null
(mmodule
)
927 # File-system location of a module (file) that is identified but not always loaded.
929 # The name of the module
930 # (it's the basename of the filepath)
933 # The human path of the module
936 # The group (and the project) of the possible module
939 # The loaded module (if any)
940 var mmodule
: nullable MModule = null
942 redef fun to_s
do return filepath
946 # Modules paths associated with the group
947 var module_paths
= new Array[ModulePath]
949 # Is the group interesting for a final user?
951 # Groups are mandatory in the model but for simple projects they are not
952 # always interesting.
954 # A interesting group has, at least, one of the following true:
956 # * it has 2 modules or more
957 # * it has a subgroup
958 # * it has a documentation
959 fun is_interesting
: Bool
961 return module_paths
.length
> 1 or mmodules
.length
> 1 or not in_nesting
.direct_smallers
.is_empty
or mdoc
!= null
966 redef class SourceFile
967 # Associated mmodule, once created
968 var mmodule
: nullable MModule = null
971 redef class AStdImport
972 # The imported module once determined
973 var mmodule
: nullable MModule = null
977 # The associated MModule once build by a `ModelBuilder`
978 var mmodule
: nullable MModule
979 # Flag that indicate if the importation is already completed
980 var is_importation_done
: Bool = false