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
23 redef class ToolContext
25 var opt_path
= new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
27 # Option --only-metamodel
28 var opt_only_metamodel
= new OptionBool("Stop after meta-model processing", "--only-metamodel")
31 var opt_only_parse
= new OptionBool("Only proceed to parse step of loaders", "--only-parse")
36 option_context
.add_option
(opt_path
, opt_only_parse
, opt_only_metamodel
)
40 redef class ModelBuilder
45 # Setup the paths value
46 paths
.append
(toolcontext
.opt_path
.value
)
48 var path_env
= "NIT_PATH".environ
49 if not path_env
.is_empty
then
50 paths
.append
(path_env
.split_with
(':'))
53 var nit_dir
= toolcontext
.nit_dir
54 var libname
= nit_dir
/"lib"
55 if libname
.file_exists
then paths
.add
(libname
)
56 libname
= nit_dir
/"contrib"
57 if libname
.file_exists
then paths
.add
(libname
)
60 # Load a bunch of modules.
61 # `modules` can contains filenames or module names.
62 # Imported modules are automatically loaded and modelized.
63 # The result is the corresponding model elements.
64 # Errors and warnings are printed with the toolcontext.
66 # Note: class and property model elements are not analysed.
67 fun parse
(modules
: Sequence[String]): Array[MModule]
70 # Parse and recursively load
71 self.toolcontext
.info
("*** PARSE ***", 1)
72 var mmodules
= new ArraySet[MModule]
74 var nmodule
= self.load_module
(a
)
75 if nmodule
== null then continue # Skip error
76 # Load imported module
77 build_module_importation
(nmodule
)
78 var mmodule
= nmodule
.mmodule
79 if mmodule
== null then continue # skip error
83 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
85 self.toolcontext
.check_errors
87 if toolcontext
.opt_only_parse
.value
then
88 self.toolcontext
.info
("*** ONLY PARSE...", 1)
95 # Load recursively all modules of the group `mgroup`.
96 # See `parse` for details.
97 fun parse_group
(mgroup
: MGroup): Array[MModule]
99 var res
= new Array[MModule]
101 for mg
in mgroup
.in_nesting
.smallers
do
102 for mp
in mg
.module_paths
do
103 var nmodule
= self.load_module
(mp
.filepath
)
104 if nmodule
== null then continue # Skip error
105 # Load imported module
106 build_module_importation
(nmodule
)
107 var mmodule
= nmodule
.mmodule
108 if mmodule
== null then continue # Skip error
115 # Load a bunch of modules and groups.
119 # * a path to a module, a group or a directory of projects.
120 # * a short name of a module or a group that are looked in the `paths` (-I)
122 # Then, for each entry, if it is:
124 # * a module, then is it parser and returned.
125 # * a group then recursively all its modules are parsed.
126 # * a directory of projects then all the modules of all projects are parsed.
127 # * else an error is displayed.
129 # See `parse` for details.
130 fun parse_full
(names
: Sequence[String]): Array[MModule]
133 # Parse and recursively load
134 self.toolcontext
.info
("*** PARSE ***", 1)
135 var mmodules
= new ArraySet[MModule]
138 var mgroup
= self.get_mgroup
(a
)
139 if mgroup
!= null then
140 mmodules
.add_all parse_group
(mgroup
)
144 # Case of a directory that is not a group
145 var stat
= a
.to_path
.stat
146 if stat
!= null and stat
.is_dir
then
147 self.toolcontext
.info
("look in directory {a}", 2)
149 # Try each entry as a group or a module
152 mgroup
= get_mgroup
(af
)
153 if mgroup
!= null then
154 mmodules
.add_all parse_group
(mgroup
)
157 var mp
= identify_file
(af
)
159 var nmodule
= self.load_module
(af
)
160 if nmodule
== null then continue # Skip error
161 build_module_importation
(nmodule
)
162 var mmodule
= nmodule
.mmodule
163 if mmodule
== null then continue # Skip error
166 self.toolcontext
.info
("ignore file {af}", 2)
172 var nmodule
= self.load_module
(a
)
173 if nmodule
== null then continue # Skip error
174 # Load imported module
175 build_module_importation
(nmodule
)
176 var mmodule
= nmodule
.mmodule
177 if mmodule
== null then continue # Skip error
181 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
183 self.toolcontext
.check_errors
185 if toolcontext
.opt_only_parse
.value
then
186 self.toolcontext
.info
("*** ONLY PARSE...", 1)
193 # The list of directories to search for top level modules
194 # The list is initially set with:
196 # * the toolcontext --path option
197 # * the NIT_PATH environment variable
198 # * `toolcontext.nit_dir`
199 # Path can be added (or removed) by the client
200 var paths
= new Array[String]
202 # Like (and used by) `get_mmodule_by_name` but just return the ModulePath
203 fun search_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable ModulePath
205 # First, look in groups
208 var r
= c
.mproject
.root
211 var res
= r
.mmodule_paths_by_name
(name
)
212 if res
.not_empty
then return res
.first
215 # Look at some known directories
216 var lookpaths
= self.paths
218 # Look in the directory of the group project also (even if not explicitly in the path)
219 if mgroup
!= null then
220 # path of the root group
221 var dirname
= mgroup
.mproject
.root
.filepath
222 if dirname
!= null then
223 dirname
= dirname
.join_path
("..").simplify_path
224 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
225 lookpaths
= lookpaths
.to_a
226 lookpaths
.add
(dirname
)
231 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
233 if candidate
== null then
234 if mgroup
!= null then
235 error
(anode
, "Error: cannot find module `{name}` from `{mgroup.name}`. Tried: {lookpaths.join(", ")}.")
237 error
(anode
, "Error: cannot find module `{name}`. Tried: {lookpaths.join(", ")}.")
244 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
245 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
246 # if `mgroup` is null then the module is searched in the top level only.
247 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
248 fun get_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
250 var path
= search_mmodule_by_name
(anode
, mgroup
, name
)
251 if path
== null then return null # Forward error
252 return load_module_path
(path
)
255 # Load and process importation of a given ModulePath.
257 # Basically chains `load_module` and `build_module_importation`.
258 fun load_module_path
(path
: ModulePath): nullable MModule
260 var res
= self.load_module
(path
.filepath
)
261 if res
== null then return null # Forward error
262 # Load imported module
263 build_module_importation
(res
)
267 # Search a module `name` from path `lookpaths`.
268 # If found, the path of the file is returned
269 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
271 var res
= new ArraySet[ModulePath]
272 for dirname
in lookpaths
do
273 # Try a single module file
274 var mp
= identify_file
((dirname
/"{name}.nit").simplify_path
)
275 if mp
!= null then res
.add mp
276 # Try the default module of a group
277 var g
= get_mgroup
((dirname
/name
).simplify_path
)
280 res
.add_all g
.mmodule_paths_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}`: `{res.join(",")}`")
290 # Cache for `identify_file` by realpath
291 private var identified_files_by_path
= new HashMap[String, nullable ModulePath]
293 # All the currently identified modules.
294 # See `identify_file`.
295 var identified_files
= new Array[ModulePath]
297 # Identify a source file and load the associated project and groups if required.
299 # This method does what the user expects when giving an argument to a Nit tool.
301 # * If `path` is an existing Nit source file (with the `.nit` extension),
302 # then the associated ModulePath is returned
303 # * If `path` is a directory (with a `/`),
304 # then the ModulePath of its default module is returned (if any)
305 # * If `path` is a simple identifier (eg. `digraph`),
306 # then the main module of the project `digraph` is searched in `paths` and returned.
308 # Silently return `null` if `path` does not exists or cannot be identified.
309 fun identify_file
(path
: String): nullable ModulePath
311 # special case for not a nit file
312 if path
.file_extension
!= "nit" then
313 # search dirless files in known -I paths
314 if not path
.chars
.has
('/') then
315 var res
= search_module_in_paths
(null, path
, self.paths
)
316 if res
!= null then return res
319 # Found nothing? maybe it is a group...
321 if path
.file_exists
then
322 var mgroup
= get_mgroup
(path
)
323 if mgroup
!= null then
324 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
325 if owner_path
.file_exists
then candidate
= owner_path
329 if candidate
== null then
335 # Does the file exists?
336 if not path
.file_exists
then
340 # Fast track, the path is already known
341 var pn
= path
.basename
(".nit")
342 var rp
= module_absolute_path
(path
)
343 if identified_files_by_path
.has_key
(rp
) then return identified_files_by_path
[rp
]
346 var mgrouppath
= path
.join_path
("..").simplify_path
347 var mgroup
= get_mgroup
(mgrouppath
)
349 if mgroup
== null then
351 var mproject
= new MProject(pn
, model
)
352 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
353 mgroup
.filepath
= path
354 mproject
.root
= mgroup
355 toolcontext
.info
("found singleton project `{pn}` at {path}", 2)
357 # Attach homonymous `ini` file to the project
358 var inipath
= path
.dirname
/ "{pn}.ini"
359 if inipath
.file_exists
then
360 var ini
= new ConfigTree(inipath
)
365 var res
= new ModulePath(pn
, path
, mgroup
)
366 mgroup
.module_paths
.add
(res
)
368 identified_files_by_path
[rp
] = res
369 identified_files
.add
(res
)
374 private var mgroups
= new HashMap[String, nullable MGroup]
376 # Return the mgroup associated to a directory path.
377 # If the directory is not a group null is returned.
379 # Note: `paths` is also used to look for mgroups
380 fun get_mgroup
(dirpath
: String): nullable MGroup
382 if not dirpath
.file_exists
then do
384 var try
= p
/ dirpath
385 if try
.file_exists
then
393 var rdp
= module_absolute_path
(dirpath
)
394 if mgroups
.has_key
(rdp
) then
398 # Filter out non-directories
399 var stat
= dirpath
.file_stat
400 if stat
== null or not stat
.is_dir
then
405 # By default, the name of the project or group is the base_name of the directory
406 var pn
= rdp
.basename
(".nit")
408 # Check `project.ini` that indicate a project
411 var inipath
= dirpath
/ "project.ini"
412 if inipath
.file_exists
then
413 ini
= new ConfigTree(inipath
)
417 # No ini, multiple course of action
419 # The root of the directory hierarchy in the file system.
425 # Special stopper `projects.ini`
426 if (dirpath
/"projects.ini").file_exists
then
427 # dirpath cannot be a project since it is a project directory
432 # check the parent directory (if it does not contain the stopper file)
433 var parentpath
= dirpath
.join_path
("..").simplify_path
434 var stopper
= parentpath
/ "projects.ini"
435 if not stopper
.file_exists
then
436 # Recursively get the parent group
437 parent
= get_mgroup
(parentpath
)
438 if parent
== null then
439 # Parent is not a group, thus we are not a group either
447 if parent
== null then
448 # no parent, thus new project
449 if ini
!= null then pn
= ini
["project.name"] or else pn
450 var mproject
= new MProject(pn
, model
)
451 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
452 mproject
.root
= mgroup
453 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
456 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
457 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
460 # search documentation
461 # in src first so the documentation of the project code can be distinct for the documentation of the project usage
462 var readme
= dirpath
.join_path
("README.md")
463 if not readme
.file_exists
then readme
= dirpath
.join_path
("README")
464 if readme
.file_exists
then
465 var mdoc
= load_markdown
(readme
)
467 mdoc
.original_mentity
= mgroup
470 mgroup
.filepath
= dirpath
471 mgroups
[rdp
] = mgroup
475 # Load a markdown file as a documentation object
476 fun load_markdown
(filepath
: String): MDoc
478 var s
= new FileReader.open
(filepath
)
479 var lines
= new Array[String]
480 var line_starts
= new Array[Int]
483 var line
= s
.read_line
486 len
+= line
.length
+ 1
489 var source
= new SourceFile.from_string
(filepath
, lines
.join
("\n"))
490 source
.line_starts
.add_all line_starts
491 var mdoc
= new MDoc(new Location(source
, 1, lines
.length
, 0, 0))
492 mdoc
.content
.add_all
(lines
)
496 # Force the identification of all ModulePath of the group and sub-groups in the file system.
498 # When a group is scanned, its sub-groups hierarchy is filled (see `MGroup::in_nesting`)
499 # and the potential modules (and nested modules) are identified (see `MGroup::module_paths`).
501 # Basically, this recursively call `get_mgroup` and `identify_file` on each directory entry.
503 # No-op if the group was already scanned (see `MGroup::scanned`).
504 fun scan_group
(mgroup
: MGroup) do
505 if mgroup
.scanned
then return
506 mgroup
.scanned
= true
507 var p
= mgroup
.filepath
508 # a virtual group has nothing to scan
509 if p
== null then return
512 var g
= get_mgroup
(fp
)
513 # Recursively scan for groups of the same project
514 if g
!= null and g
.mproject
== mgroup
.mproject
then
521 # Transform relative paths (starting with '../') into absolute paths
522 private fun module_absolute_path
(path
: String): String do
523 return getcwd
.join_path
(path
).simplify_path
526 # Try to load a module AST using a path.
527 # Display an error if there is a problem (IO / lexer / parser) and return null
528 fun load_module_ast
(filename
: String): nullable AModule
530 if filename
.file_extension
!= "nit" then
531 self.toolcontext
.error
(null, "Error: file `{filename}` is not a valid nit module.")
534 if not filename
.file_exists
then
535 self.toolcontext
.error
(null, "Error: file `{filename}` not found.")
539 self.toolcontext
.info
("load module {filename}", 2)
542 var file
= new FileReader.open
(filename
)
543 var lexer
= new Lexer(new SourceFile(filename
, file
))
544 var parser
= new Parser(lexer
)
545 var tree
= parser
.parse
548 # Handle lexer and parser error
549 var nmodule
= tree
.n_base
550 if nmodule
== null then
551 var neof
= tree
.n_eof
552 assert neof
isa AError
553 error
(neof
, neof
.message
)
560 # Remove Nit source files from a list of arguments.
562 # Items of `args` that can be loaded as a nit file will be removed from `args` and returned.
563 fun filter_nit_source
(args
: Array[String]): Array[String]
565 var keep
= new Array[String]
566 var res
= new Array[String]
568 var l
= identify_file
(a
)
580 # Try to load a module using a path.
581 # Display an error if there is a problem (IO / lexer / parser) and return null.
582 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
584 # The MModule is created however, the importation is not performed,
585 # therefore you should call `build_module_importation`.
586 fun load_module
(filename
: String): nullable AModule
588 # Look for the module
589 var file
= identify_file
(filename
)
591 if filename
.file_exists
then
592 toolcontext
.error
(null, "Error: `{filename}` is not a Nit source file.")
594 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
599 # Already known and loaded? then return it
600 var mmodule
= file
.mmodule
601 if mmodule
!= null then
602 return mmodule2nmodule
[mmodule
]
606 var nmodule
= load_module_ast
(file
.filepath
)
607 if nmodule
== null then return null # forward error
609 # build the mmodule and load imported modules
610 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
612 if mmodule
== null then return null # forward error
614 # Update the file information
615 file
.mmodule
= mmodule
620 # Injection of a new module without source.
621 # Used by the interpreter.
622 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
627 if parent
!= null then mgroup
= parent
.mgroup
628 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
629 nmodule
.mmodule
= mmodule
630 nmodules
.add
(nmodule
)
631 self.mmodule2nmodule
[mmodule
] = nmodule
633 if parent
!= null then
634 var imported_modules
= new Array[MModule]
635 imported_modules
.add
(parent
)
636 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
637 mmodule
.set_imported_mmodules
(imported_modules
)
639 build_module_importation
(nmodule
)
645 # Visit the AST and create the `MModule` object
646 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
648 # Check the module name
649 var decl
= nmodule
.n_moduledecl
651 var decl_name
= decl
.n_name
.n_id
.text
652 if decl_name
!= mod_name
then
653 error
(decl
.n_name
, "Error: module name mismatch; declared {decl_name} file named {mod_name}.")
657 # Check for conflicting module names in the project
658 if mgroup
!= null then
659 var others
= model
.get_mmodules_by_name
(mod_name
)
660 if others
!= null then for other
in others
do
661 if other
.mgroup
!= null and other
.mgroup
.mproject
== mgroup
.mproject
then
663 if decl
== null then node
= nmodule
else node
= decl
.n_name
664 error
(node
, "Error: a module named `{other.full_name}` already exists at {other.location}.")
671 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
672 nmodule
.mmodule
= mmodule
673 nmodules
.add
(nmodule
)
674 self.mmodule2nmodule
[mmodule
] = nmodule
676 var source
= nmodule
.location
.file
677 if source
!= null then
678 assert source
.mmodule
== null
679 source
.mmodule
= mmodule
683 # Extract documentation
684 var ndoc
= decl
.n_doc
686 var mdoc
= ndoc
.to_mdoc
688 mdoc
.original_mentity
= mmodule
690 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
692 # Is the module a test suite?
693 mmodule
.is_test_suite
= not decl
.get_annotations
("test_suite").is_empty
699 # Resolve the module identification for a given `AModuleName`.
701 # This method handles qualified names as used in `AModuleName`.
702 fun seach_module_by_amodule_name
(n_name
: AModuleName, mgroup
: nullable MGroup): nullable ModulePath
704 if n_name
.n_quad
!= null then mgroup
= null # Start from top level
705 for grp
in n_name
.n_path
do
706 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
707 if path
== null then return null # Forward error
710 var mod_name
= n_name
.n_id
.text
711 return search_mmodule_by_name
(n_name
, mgroup
, mod_name
)
714 # Analyze the module importation and fill the module_importation_hierarchy
716 # Unless you used `load_module`, the importation is already done and this method does a no-op.
717 fun build_module_importation
(nmodule
: AModule)
719 if nmodule
.is_importation_done
then return
720 nmodule
.is_importation_done
= true
721 var mmodule
= nmodule
.mmodule
.as(not null)
723 var imported_modules
= new Array[MModule]
724 for aimport
in nmodule
.n_imports
do
725 # Do not imports conditional
726 var atconditionals
= aimport
.get_annotations
("conditional")
727 if atconditionals
.not_empty
then continue
730 if not aimport
isa AStdImport then
734 # Load the imported module
735 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
736 if suppath
== null then
737 nmodule
.mmodule
= null # invalidate the module
738 continue # Skip error
740 var sup
= load_module_path
(suppath
)
742 nmodule
.mmodule
= null # invalidate the module
743 continue # Skip error
746 aimport
.mmodule
= sup
747 imported_modules
.add
(sup
)
748 var mvisibility
= aimport
.n_visibility
.mvisibility
749 if mvisibility
== protected_visibility
then
750 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
751 nmodule
.mmodule
= null # invalidate the module
754 if sup
== mmodule
then
755 error
(aimport
.n_name
, "Error: dependency loop in module {mmodule}.")
756 nmodule
.mmodule
= null # invalidate the module
758 if sup
.in_importation
< mmodule
then
759 error
(aimport
.n_name
, "Error: dependency loop between modules {mmodule} and {sup}.")
760 nmodule
.mmodule
= null # invalidate the module
763 mmodule
.set_visibility_for
(sup
, mvisibility
)
766 var mod_name
= "core"
767 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
769 nmodule
.mmodule
= null # invalidate the module
771 imported_modules
.add
(sup
)
772 mmodule
.set_visibility_for
(sup
, public_visibility
)
776 # Declare conditional importation
777 for aimport
in nmodule
.n_imports
do
778 if not aimport
isa AStdImport then continue
779 var atconditionals
= aimport
.get_annotations
("conditional")
780 if atconditionals
.is_empty
then continue
782 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
783 if suppath
== null then continue # skip error
785 for atconditional
in atconditionals
do
786 var nargs
= atconditional
.n_args
787 if nargs
.is_empty
then
788 error
(atconditional
, "Syntax Error: `conditional` expects module identifiers as arguments.")
793 var rule
= new Array[Object]
795 # First element is the goal, thus
798 # Second element is the first condition, that is to be a client of the current module
801 # Other condition are to be also a client of each modules indicated as arguments of the annotation
805 error
(narg
, "Syntax Error: `conditional` expects module identifier as arguments.")
809 var mp
= search_mmodule_by_name
(narg
, mmodule
.mgroup
, id
)
810 if mp
== null then continue
815 conditional_importations
.add rule
819 mmodule
.set_imported_mmodules
(imported_modules
)
821 apply_conditional_importations
(mmodule
)
823 self.toolcontext
.info
("{mmodule} imports {mmodule.in_importation.direct_greaters.join(", ")}", 3)
825 # Force `core` to be public if imported
826 for sup
in mmodule
.in_importation
.greaters
do
827 if sup
.name
== "core" then
828 mmodule
.set_visibility_for
(sup
, public_visibility
)
832 # TODO: Correctly check for useless importation
834 var directs
= mmodule
.in_importation
.direct_greaters
835 for nim
in nmodule
.n_imports
do
836 if not nim
isa AStdImport then continue
838 if im
== null then continue
839 if directs
.has
(im
) then continue
840 # This generates so much noise that it is simpler to just comment it
841 #warning(nim, "Warning: possible useless importation of {im}")
845 # Global list of conditional importation rules.
847 # Each rule is a "Horn clause"-like sequence of modules.
848 # It means that the first module is the module to automatically import.
849 # The remaining modules are the conditions of the rule.
851 # Each module is either represented by a MModule (if the module is already loaded)
852 # or by a ModulePath (if the module is not yet loaded).
854 # Rules are declared by `build_module_importation` and are applied by `apply_conditional_importations`
855 # (and `build_module_importation` that calls it).
857 # TODO (when the loader will be rewritten): use a better representation and move up rules in the model.
858 private var conditional_importations
= new Array[SequenceRead[Object]]
860 # Extends the current importations according to imported rules about conditional importation
861 fun apply_conditional_importations
(mmodule
: MModule)
863 # Because a conditional importation may cause additional conditional importation, use a fixed point
864 # The rules are checked naively because we assume that it does not worth to be optimized
865 var check_conditional_importations
= true
866 while check_conditional_importations
do
867 check_conditional_importations
= false
869 for ci
in conditional_importations
do
871 for i
in [1..ci
.length
[ do
872 var rule_element
= ci
[i
]
873 # An element of a rule is either a MModule or a ModulePath
874 # We need the mmodule to resonate on the importation
876 if rule_element
isa MModule then
878 else if rule_element
isa ModulePath then
879 m
= rule_element
.mmodule
881 if m
== null then continue label
886 if not mmodule
.in_importation
.greaters
.has
(m
) then continue label
888 # Still here? It means that all conditions modules are loaded and imported
890 # Identify the module to automatically import
891 var suppath
= ci
.first
.as(ModulePath)
892 var sup
= load_module_path
(suppath
)
893 if sup
== null then continue
895 # Do nothing if already imported
896 if mmodule
.in_importation
.greaters
.has
(sup
) then continue label
899 self.toolcontext
.info
("{mmodule} conditionally imports {sup}", 3)
900 # TODO visibility rules (currently always public)
901 mmodule
.set_visibility_for
(sup
, public_visibility
)
902 # TODO linearization rules (currently added at the end in the order of the rules)
903 mmodule
.set_imported_mmodules
([sup
])
905 # Prepare to reapply the rules
906 check_conditional_importations
= true
911 # All the loaded modules
912 var nmodules
= new Array[AModule]
914 # Register the nmodule associated to each mmodule
916 # Public clients need to use `mmodule2node` to access stuff.
917 private var mmodule2nmodule
= new HashMap[MModule, AModule]
919 # Retrieve the associated AST node of a mmodule.
920 # This method is used to associate model entity with syntactic entities.
922 # If the module is not associated with a node, returns null.
923 fun mmodule2node
(mmodule
: MModule): nullable AModule
925 return mmodule2nmodule
.get_or_null
(mmodule
)
929 # File-system location of a module (file) that is identified but not always loaded.
931 # The name of the module
932 # (it's the basename of the filepath)
935 # The human path of the module
938 # The group (and the project) of the possible module
941 # The loaded module (if any)
942 var mmodule
: nullable MModule = null
944 redef fun to_s
do return filepath
948 # The associated `.ini` file, if any
950 # The `ini` file is given as is and might contain invalid or missing information.
952 # Some projects, like stand-alone projects or virtual projects have no `ini` file associated.
953 var ini
: nullable ConfigTree = null
957 # Modules paths associated with the group
958 var module_paths
= new Array[ModulePath]
960 # Is the group interesting for a final user?
962 # Groups are mandatory in the model but for simple projects they are not
963 # always interesting.
965 # A interesting group has, at least, one of the following true:
967 # * it has 2 modules or more
968 # * it has a subgroup
969 # * it has a documentation
970 fun is_interesting
: Bool
972 return module_paths
.length
> 1 or
973 mmodules
.length
> 1 or
974 not in_nesting
.direct_smallers
.is_empty
or
976 (mmodules
.length
== 1 and default_mmodule
== null)
979 # Are files and directories in self scanned?
981 # See `ModelBuilder::scan_group`.
984 # Return the modules in self and subgroups named `name`.
986 # If `self` is not scanned (see `ModelBuilder::scan_group`) the
987 # results might be partial.
988 fun mmodule_paths_by_name
(name
: String): Array[ModulePath]
990 var res
= new Array[ModulePath]
991 for g
in in_nesting
.smallers
do
992 for mp
in g
.module_paths
do
993 if mp
.name
== name
then
1002 redef class SourceFile
1003 # Associated mmodule, once created
1004 var mmodule
: nullable MModule = null
1007 redef class AStdImport
1008 # The imported module once determined
1009 var mmodule
: nullable MModule = null
1013 # The associated MModule once build by a `ModelBuilder`
1014 var mmodule
: nullable MModule
1015 # Flag that indicate if the importation is already completed
1016 var is_importation_done
: Bool = false