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 # 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
= get_mgroup
(dirname
/name
)
304 # Cache for `identify_file` by realpath
305 private var identified_files_by_path
= new HashMap[String, nullable ModulePath]
307 # All the currently identified modules.
308 # See `identify_file`.
309 var identified_files
= new Array[ModulePath]
311 # Identify a source file and load the associated project and groups if required.
313 # This method does what the user expects when giving an argument to a Nit tool.
315 # * If `path` is an existing Nit source file (with the `.nit` extension),
316 # then the associated ModulePath is returned
317 # * If `path` is a directory (with a `/`),
318 # then the ModulePath of its default module is returned (if any)
319 # * If `path` is a simple identifier (eg. `digraph`),
320 # then the main module of the project `digraph` is searched in `paths` and returned.
322 # Silently return `null` if `path` does not exists or cannot be identified.
323 fun identify_file
(path
: String): nullable ModulePath
325 # special case for not a nit file
326 if path
.file_extension
!= "nit" then
327 # search dirless files in known -I paths
328 if not path
.chars
.has
('/') then
329 var res
= search_module_in_paths
(null, path
, self.paths
)
330 if res
!= null then return res
333 # Found nothing? maybe it is a group...
335 if path
.file_exists
then
336 var mgroup
= get_mgroup
(path
)
337 if mgroup
!= null then
338 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
339 if owner_path
.file_exists
then candidate
= owner_path
343 if candidate
== null then
349 # Does the file exists?
350 if not path
.file_exists
then
354 # Fast track, the path is already known
355 var pn
= path
.basename
(".nit")
356 var rp
= module_absolute_path
(path
)
357 if identified_files_by_path
.has_key
(rp
) then return identified_files_by_path
[rp
]
360 var mgrouppath
= path
.join_path
("..").simplify_path
361 var mgroup
= get_mgroup
(mgrouppath
)
363 if mgroup
== null then
365 var mproject
= new MProject(pn
, model
)
366 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
367 mgroup
.filepath
= path
368 mproject
.root
= mgroup
369 toolcontext
.info
("found singleton project `{pn}` at {path}", 2)
372 var res
= new ModulePath(pn
, path
, mgroup
)
373 mgroup
.module_paths
.add
(res
)
375 identified_files_by_path
[rp
] = res
376 identified_files
.add
(res
)
381 private var mgroups
= new HashMap[String, nullable MGroup]
383 # Return the mgroup associated to a directory path.
384 # If the directory is not a group null is returned.
386 # Note: `paths` is also used to look for mgroups
387 fun get_mgroup
(dirpath
: String): nullable MGroup
389 if not dirpath
.file_exists
then do
391 var try
= p
/ dirpath
392 if try
.file_exists
then
400 var rdp
= module_absolute_path
(dirpath
)
401 if mgroups
.has_key
(rdp
) then
405 # Filter out non-directories
406 var stat
= dirpath
.file_stat
407 if stat
== null or not stat
.is_dir
then
412 # By default, the name of the project or group is the base_name of the directory
413 var pn
= rdp
.basename
(".nit")
415 # Check `project.ini` that indicate a project
418 var inipath
= dirpath
/ "project.ini"
419 if inipath
.file_exists
then
420 ini
= new ConfigTree(inipath
)
424 # No ini, multiple course of action
426 # The root of the directory hierarchy in the file system.
432 # Special stopper `projects.ini`
433 if (dirpath
/"projects.ini").file_exists
then
434 # dirpath cannot be a project since it is a project directory
439 # check the parent directory (if it does not contain the stopper file)
440 var parentpath
= dirpath
.join_path
("..").simplify_path
441 var stopper
= parentpath
/ "projects.ini"
442 if not stopper
.file_exists
then
443 # Recursively get the parent group
444 parent
= get_mgroup
(parentpath
)
445 if parent
== null then
446 # Parent is not a group, thus we are not a group either
454 if parent
== null then
455 # no parent, thus new project
456 if ini
!= null and ini
.has_key
("name") then pn
= ini
["name"]
457 var mproject
= new MProject(pn
, model
)
458 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
459 mproject
.root
= mgroup
460 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
463 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
464 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
467 # search documentation
468 # in src first so the documentation of the project code can be distinct for the documentation of the project usage
469 var readme
= dirpath
.join_path
("README.md")
470 if not readme
.file_exists
then readme
= dirpath
.join_path
("README")
471 if readme
.file_exists
then
472 var mdoc
= load_markdown
(readme
)
474 mdoc
.original_mentity
= mgroup
477 mgroup
.filepath
= dirpath
478 mgroups
[rdp
] = mgroup
482 # Load a markdown file as a documentation object
483 fun load_markdown
(filepath
: String): MDoc
485 var s
= new FileReader.open
(filepath
)
486 var lines
= new Array[String]
487 var line_starts
= new Array[Int]
490 var line
= s
.read_line
493 len
+= line
.length
+ 1
496 var source
= new SourceFile.from_string
(filepath
, lines
.join
("\n"))
497 source
.line_starts
.add_all line_starts
498 var mdoc
= new MDoc(new Location(source
, 1, lines
.length
, 0, 0))
499 mdoc
.content
.add_all
(lines
)
503 # Force the identification of all ModulePath of the group and sub-groups in the file system.
505 # When a group is scanned, its sub-groups hierarchy is filled (see `MGroup::in_nesting`)
506 # and the potential modules (and nested modules) are identified (see `MGroup::module_paths`).
508 # Basically, this recursively call `get_mgroup` and `identify_file` on each directory entry.
510 # No-op if the group was already scanned (see `MGroup::scanned`).
511 fun scan_group
(mgroup
: MGroup) do
512 if mgroup
.scanned
then return
513 mgroup
.scanned
= true
514 var p
= mgroup
.filepath
515 # a virtual group has nothing to scan
516 if p
== null then return
519 var g
= get_mgroup
(fp
)
520 # Recursively scan for groups of the same project
521 if g
!= null and g
.mproject
== mgroup
.mproject
then
528 # Transform relative paths (starting with '../') into absolute paths
529 private fun module_absolute_path
(path
: String): String do
530 return getcwd
.join_path
(path
).simplify_path
533 # Try to load a module AST using a path.
534 # Display an error if there is a problem (IO / lexer / parser) and return null
535 fun load_module_ast
(filename
: String): nullable AModule
537 if filename
.file_extension
!= "nit" then
538 self.toolcontext
.error
(null, "Error: file `{filename}` is not a valid nit module.")
541 if not filename
.file_exists
then
542 self.toolcontext
.error
(null, "Error: file `{filename}` not found.")
546 self.toolcontext
.info
("load module {filename}", 2)
549 var file
= new FileReader.open
(filename
)
550 var lexer
= new Lexer(new SourceFile(filename
, file
))
551 var parser
= new Parser(lexer
)
552 var tree
= parser
.parse
555 # Handle lexer and parser error
556 var nmodule
= tree
.n_base
557 if nmodule
== null then
558 var neof
= tree
.n_eof
559 assert neof
isa AError
560 error
(neof
, neof
.message
)
567 # Remove Nit source files from a list of arguments.
569 # Items of `args` that can be loaded as a nit file will be removed from `args` and returned.
570 fun filter_nit_source
(args
: Array[String]): Array[String]
572 var keep
= new Array[String]
573 var res
= new Array[String]
575 var l
= identify_file
(a
)
587 # Try to load a module using a path.
588 # Display an error if there is a problem (IO / lexer / parser) and return null.
589 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
591 # The MModule is created however, the importation is not performed,
592 # therefore you should call `build_module_importation`.
593 fun load_module
(filename
: String): nullable AModule
595 # Look for the module
596 var file
= identify_file
(filename
)
598 if filename
.file_exists
then
599 toolcontext
.error
(null, "Error: `{filename}` is not a Nit source file.")
601 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
606 # Already known and loaded? then return it
607 var mmodule
= file
.mmodule
608 if mmodule
!= null then
609 return mmodule2nmodule
[mmodule
]
613 var nmodule
= load_module_ast
(file
.filepath
)
614 if nmodule
== null then return null # forward error
616 # build the mmodule and load imported modules
617 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
619 if mmodule
== null then return null # forward error
621 # Update the file information
622 file
.mmodule
= mmodule
627 # Injection of a new module without source.
628 # Used by the interpreter.
629 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
634 if parent
!= null then mgroup
= parent
.mgroup
635 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
636 nmodule
.mmodule
= mmodule
637 nmodules
.add
(nmodule
)
638 self.mmodule2nmodule
[mmodule
] = nmodule
640 if parent
!= null then
641 var imported_modules
= new Array[MModule]
642 imported_modules
.add
(parent
)
643 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
644 mmodule
.set_imported_mmodules
(imported_modules
)
646 build_module_importation
(nmodule
)
652 # Visit the AST and create the `MModule` object
653 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
655 # Check the module name
656 var decl
= nmodule
.n_moduledecl
658 var decl_name
= decl
.n_name
.n_id
.text
659 if decl_name
!= mod_name
then
660 error
(decl
.n_name
, "Error: module name mismatch; declared {decl_name} file named {mod_name}.")
664 # Check for conflicting module names in the project
665 if mgroup
!= null then
666 var others
= model
.get_mmodules_by_name
(mod_name
)
667 if others
!= null then for other
in others
do
668 if other
.mgroup
!= null and other
.mgroup
.mproject
== mgroup
.mproject
then
670 if decl
== null then node
= nmodule
else node
= decl
.n_name
671 error
(node
, "Error: a module named `{other.full_name}` already exists at {other.location}.")
678 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
679 nmodule
.mmodule
= mmodule
680 nmodules
.add
(nmodule
)
681 self.mmodule2nmodule
[mmodule
] = nmodule
683 var source
= nmodule
.location
.file
684 if source
!= null then
685 assert source
.mmodule
== null
686 source
.mmodule
= mmodule
690 # Extract documentation
691 var ndoc
= decl
.n_doc
693 var mdoc
= ndoc
.to_mdoc
695 mdoc
.original_mentity
= mmodule
697 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
699 # Is the module a test suite?
700 mmodule
.is_test_suite
= not decl
.get_annotations
("test_suite").is_empty
706 # Resolve the module identification for a given `AModuleName`.
708 # This method handles qualified names as used in `AModuleName`.
709 fun seach_module_by_amodule_name
(n_name
: AModuleName, mgroup
: nullable MGroup): nullable ModulePath
711 var mod_name
= n_name
.n_id
.text
713 # If a quad is given, we ignore the starting group (go from path)
714 if n_name
.n_quad
!= null then mgroup
= null
716 # If name not qualified, just search the name
717 if n_name
.n_path
.is_empty
then
718 # Fast search if no n_path
719 return search_mmodule_by_name
(n_name
, mgroup
, mod_name
)
722 # If qualified and in a group
723 if mgroup
!= null then
724 # First search in the project
725 var r
= mgroup
.mproject
.root
728 # Get all modules with the final name
729 var res
= r
.mmodule_paths_by_name
(mod_name
)
730 # Filter out the name that does not match the qualifiers
731 res
= [for x
in res
do if match_amodulename
(n_name
, x
) then x
]
732 if res
.not_empty
then
733 if res
.length
> 1 then
734 error
(n_name
, "Error: conflicting module files for `{mod_name}`: `{res.join(",")}`")
740 # If no module yet, then assume that the first element of the path
741 # Is to be searched in the path.
742 var root_name
= n_name
.n_path
.first
.text
743 var roots
= search_group_in_paths
(root_name
, paths
)
744 if roots
.is_empty
then
745 error
(n_name
, "Error: cannot find `{root_name}`. Tried: {paths.join(", ")}.")
749 var res
= new ArraySet[ModulePath]
751 # Then, for each root, collect modules that matches the qualifiers
753 var root_res
= r
.mmodule_paths_by_name
(mod_name
)
754 for x
in root_res
do if match_amodulename
(n_name
, x
) then res
.add x
756 if res
.not_empty
then
757 if res
.length
> 1 then
758 error
(n_name
, "Error: conflicting module files for `{mod_name}`: `{res.join(",")}`")
762 # If still nothing, just call a basic search that will fail and will produce an error message
763 error
(n_name
, "Error: cannot find module `{mod_name}` from `{root_name}`. Tried: {paths.join(", ")}.")
767 # Is elements of `n_name` correspond to the group nesting of `m`?
769 # Basically it check that `bar::foo` matches `bar/foo.nit` and `bar/baz/foo.nit`
770 # but not `baz/foo.nit` nor `foo/bar.nit`
772 # Is used by `seach_module_by_amodule_name` to validate qualified names.
773 private fun match_amodulename
(n_name
: AModuleName, m
: ModulePath): Bool
775 var g
: nullable MGroup = m
.mgroup
776 for grp
in n_name
.n_path
.reverse_iterator
do
777 while g
!= null and grp
.text
!= g
.name
do
784 # Analyze the module importation and fill the module_importation_hierarchy
786 # Unless you used `load_module`, the importation is already done and this method does a no-op.
787 fun build_module_importation
(nmodule
: AModule)
789 if nmodule
.is_importation_done
then return
790 nmodule
.is_importation_done
= true
791 var mmodule
= nmodule
.mmodule
.as(not null)
793 var imported_modules
= new Array[MModule]
794 for aimport
in nmodule
.n_imports
do
795 # Do not imports conditional
796 var atconditionals
= aimport
.get_annotations
("conditional")
797 if atconditionals
.not_empty
then continue
800 if not aimport
isa AStdImport then
804 # Load the imported module
805 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
806 if suppath
== null then
807 nmodule
.mmodule
= null # invalidate the module
808 continue # Skip error
810 var sup
= load_module_path
(suppath
)
812 nmodule
.mmodule
= null # invalidate the module
813 continue # Skip error
816 aimport
.mmodule
= sup
817 imported_modules
.add
(sup
)
818 var mvisibility
= aimport
.n_visibility
.mvisibility
819 if mvisibility
== protected_visibility
then
820 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
821 nmodule
.mmodule
= null # invalidate the module
824 if sup
== mmodule
then
825 error
(aimport
.n_name
, "Error: dependency loop in module {mmodule}.")
826 nmodule
.mmodule
= null # invalidate the module
828 if sup
.in_importation
< mmodule
then
829 error
(aimport
.n_name
, "Error: dependency loop between modules {mmodule} and {sup}.")
830 nmodule
.mmodule
= null # invalidate the module
833 mmodule
.set_visibility_for
(sup
, mvisibility
)
836 var mod_name
= "standard"
837 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
839 nmodule
.mmodule
= null # invalidate the module
841 imported_modules
.add
(sup
)
842 mmodule
.set_visibility_for
(sup
, public_visibility
)
846 # Declare conditional importation
847 for aimport
in nmodule
.n_imports
do
848 if not aimport
isa AStdImport then continue
849 var atconditionals
= aimport
.get_annotations
("conditional")
850 if atconditionals
.is_empty
then continue
852 var suppath
= seach_module_by_amodule_name
(aimport
.n_name
, mmodule
.mgroup
)
853 if suppath
== null then continue # skip error
855 for atconditional
in atconditionals
do
856 var nargs
= atconditional
.n_args
857 if nargs
.is_empty
then
858 error
(atconditional
, "Syntax Error: `conditional` expects module identifiers as arguments.")
863 var rule
= new Array[Object]
865 # First element is the goal, thus
868 # Second element is the first condition, that is to be a client of the current module
871 # Other condition are to be also a client of each modules indicated as arguments of the annotation
875 error
(narg
, "Syntax Error: `conditional` expects module identifier as arguments.")
879 var mp
= search_mmodule_by_name
(narg
, mmodule
.mgroup
, id
)
880 if mp
== null then continue
885 conditional_importations
.add rule
889 mmodule
.set_imported_mmodules
(imported_modules
)
891 apply_conditional_importations
(mmodule
)
893 self.toolcontext
.info
("{mmodule} imports {mmodule.in_importation.direct_greaters.join(", ")}", 3)
895 # Force standard to be public if imported
896 for sup
in mmodule
.in_importation
.greaters
do
897 if sup
.name
== "standard" then
898 mmodule
.set_visibility_for
(sup
, public_visibility
)
902 # TODO: Correctly check for useless importation
904 var directs
= mmodule
.in_importation
.direct_greaters
905 for nim
in nmodule
.n_imports
do
906 if not nim
isa AStdImport then continue
908 if im
== null then continue
909 if directs
.has
(im
) then continue
910 # This generates so much noise that it is simpler to just comment it
911 #warning(nim, "Warning: possible useless importation of {im}")
915 # Global list of conditional importation rules.
917 # Each rule is a "Horn clause"-like sequence of modules.
918 # It means that the first module is the module to automatically import.
919 # The remaining modules are the conditions of the rule.
921 # Each module is either represented by a MModule (if the module is already loaded)
922 # or by a ModulePath (if the module is not yet loaded).
924 # Rules are declared by `build_module_importation` and are applied by `apply_conditional_importations`
925 # (and `build_module_importation` that calls it).
927 # TODO (when the loader will be rewritten): use a better representation and move up rules in the model.
928 private var conditional_importations
= new Array[SequenceRead[Object]]
930 # Extends the current importations according to imported rules about conditional importation
931 fun apply_conditional_importations
(mmodule
: MModule)
933 # Because a conditional importation may cause additional conditional importation, use a fixed point
934 # The rules are checked naively because we assume that it does not worth to be optimized
935 var check_conditional_importations
= true
936 while check_conditional_importations
do
937 check_conditional_importations
= false
939 for ci
in conditional_importations
do
941 for i
in [1..ci
.length
[ do
942 var rule_element
= ci
[i
]
943 # An element of a rule is either a MModule or a ModulePath
944 # We need the mmodule to resonate on the importation
946 if rule_element
isa MModule then
948 else if rule_element
isa ModulePath then
949 m
= rule_element
.mmodule
951 if m
== null then continue label
956 if not mmodule
.in_importation
.greaters
.has
(m
) then continue label
958 # Still here? It means that all conditions modules are loaded and imported
960 # Identify the module to automatically import
961 var suppath
= ci
.first
.as(ModulePath)
962 var sup
= load_module_path
(suppath
)
963 if sup
== null then continue
965 # Do nothing if already imported
966 if mmodule
.in_importation
.greaters
.has
(sup
) then continue label
969 self.toolcontext
.info
("{mmodule} conditionally imports {sup}", 3)
970 # TODO visibility rules (currently always public)
971 mmodule
.set_visibility_for
(sup
, public_visibility
)
972 # TODO linearization rules (currently added at the end in the order of the rules)
973 mmodule
.set_imported_mmodules
([sup
])
975 # Prepare to reapply the rules
976 check_conditional_importations
= true
981 # All the loaded modules
982 var nmodules
= new Array[AModule]
984 # Register the nmodule associated to each mmodule
986 # Public clients need to use `mmodule2node` to access stuff.
987 private var mmodule2nmodule
= new HashMap[MModule, AModule]
989 # Retrieve the associated AST node of a mmodule.
990 # This method is used to associate model entity with syntactic entities.
992 # If the module is not associated with a node, returns null.
993 fun mmodule2node
(mmodule
: MModule): nullable AModule
995 return mmodule2nmodule
.get_or_null
(mmodule
)
999 # File-system location of a module (file) that is identified but not always loaded.
1001 # The name of the module
1002 # (it's the basename of the filepath)
1005 # The human path of the module
1006 var filepath
: String
1008 # The group (and the project) of the possible module
1011 # The loaded module (if any)
1012 var mmodule
: nullable MModule = null
1014 redef fun to_s
do return filepath
1017 redef class MProject
1018 # The associated `.ini` file, if any
1020 # The `ini` file is given as is and might contain invalid or missing information.
1022 # Some projects, like stand-alone projects or virtual projects have no `ini` file associated.
1023 var ini
: nullable ConfigTree = null
1027 # Modules paths associated with the group
1028 var module_paths
= new Array[ModulePath]
1030 # Is the group interesting for a final user?
1032 # Groups are mandatory in the model but for simple projects they are not
1033 # always interesting.
1035 # A interesting group has, at least, one of the following true:
1037 # * it has 2 modules or more
1038 # * it has a subgroup
1039 # * it has a documentation
1040 fun is_interesting
: Bool
1042 return module_paths
.length
> 1 or
1043 mmodules
.length
> 1 or
1044 not in_nesting
.direct_smallers
.is_empty
or
1046 (mmodules
.length
== 1 and default_mmodule
== null)
1049 # Are files and directories in self scanned?
1051 # See `ModelBuilder::scan_group`.
1054 # Return the modules in self and subgroups named `name`.
1056 # If `self` is not scanned (see `ModelBuilder::scan_group`) the
1057 # results might be partial.
1058 fun mmodule_paths_by_name
(name
: String): Array[ModulePath]
1060 var res
= new Array[ModulePath]
1061 for g
in in_nesting
.smallers
do
1062 for mp
in g
.module_paths
do
1063 if mp
.name
== name
then
1072 redef class SourceFile
1073 # Associated mmodule, once created
1074 var mmodule
: nullable MModule = null
1077 redef class AStdImport
1078 # The imported module once determined
1079 var mmodule
: nullable MModule = null
1083 # The associated MModule once build by a `ModelBuilder`
1084 var mmodule
: nullable MModule
1085 # Flag that indicate if the importation is already completed
1086 var is_importation_done
: Bool = false