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 var res
= self.load_module
(path
.filepath
)
276 if res
== null then return null # Forward error
277 # Load imported module
278 build_module_importation
(res
)
282 # Search a module `name` from path `lookpaths`.
283 # If found, the path of the file is returned
284 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
286 var candidate
: nullable String = null
287 for dirname
in lookpaths
do
288 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
289 if try_file
.file_exists
then
290 if candidate
== null then
292 else if candidate
!= try_file
then
293 # try to disambiguate conflicting modules
294 var abs_candidate
= module_absolute_path
(candidate
)
295 var abs_try_file
= module_absolute_path
(try_file
)
296 if abs_candidate
!= abs_try_file
then
297 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
301 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
302 if try_file
.file_exists
then
303 if candidate
== null then
305 else if candidate
!= try_file
then
306 # try to disambiguate conflicting modules
307 var abs_candidate
= module_absolute_path
(candidate
)
308 var abs_try_file
= module_absolute_path
(try_file
)
309 if abs_candidate
!= abs_try_file
then
310 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
314 try_file
= (dirname
+ "/" + name
+ "/src/" + name
+ ".nit").simplify_path
315 if try_file
.file_exists
then
316 if candidate
== null then
318 else if candidate
!= try_file
then
319 # try to disambiguate conflicting modules
320 var abs_candidate
= module_absolute_path
(candidate
)
321 var abs_try_file
= module_absolute_path
(try_file
)
322 if abs_candidate
!= abs_try_file
then
323 toolcontext
.error
(location
, "Error: conflicting module file for `{name}`: `{candidate}` `{try_file}`")
328 if candidate
== null then return null
329 return identify_file
(candidate
)
332 # Cache for `identify_file` by realpath
333 private var identified_files_by_path
= new HashMap[String, nullable ModulePath]
335 # All the currently identified modules.
336 # See `identify_file`.
337 var identified_files
= new Array[ModulePath]
339 # Identify a source file
340 # Load the associated project and groups if required
342 # Silently return `null` if `path` is not a valid module path.
343 fun identify_file
(path
: String): nullable ModulePath
345 # special case for not a nit file
346 if path
.file_extension
!= "nit" then
347 # search dirless files in known -I paths
348 if path
.dirname
== "" then
349 var res
= search_module_in_paths
(null, path
, self.paths
)
350 if res
!= null then return res
353 # Found nothing? maybe it is a group...
355 if path
.file_exists
then
356 var mgroup
= get_mgroup
(path
)
357 if mgroup
!= null then
358 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
359 if owner_path
.file_exists
then candidate
= owner_path
363 if candidate
== null then
369 # Fast track, the path is already known
370 var pn
= path
.basename
(".nit")
371 var rp
= module_absolute_path
(path
)
372 if identified_files_by_path
.has_key
(rp
) then return identified_files_by_path
[rp
]
375 var mgrouppath
= path
.join_path
("..").simplify_path
376 var mgroup
= get_mgroup
(mgrouppath
)
378 if mgroup
== null then
380 var mproject
= new MProject(pn
, model
)
381 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
382 mgroup
.filepath
= path
383 mproject
.root
= mgroup
384 toolcontext
.info
("found project `{pn}` at {path}", 2)
387 var res
= new ModulePath(pn
, path
, mgroup
)
388 mgroup
.module_paths
.add
(res
)
390 identified_files_by_path
[rp
] = res
391 identified_files
.add
(res
)
396 private var mgroups
= new HashMap[String, nullable MGroup]
398 # Return the mgroup associated to a directory path.
399 # If the directory is not a group null is returned.
401 # Note: `paths` is also used to look for mgroups
402 fun get_mgroup
(dirpath
: String): nullable MGroup
404 if not dirpath
.file_exists
then do
406 var try
= p
/ dirpath
407 if try
.file_exists
then
415 var rdp
= module_absolute_path
(dirpath
)
416 if mgroups
.has_key
(rdp
) then
420 # Hack, a group is determined by one of the following:
421 # * the presence of a honomymous nit file
422 # * the fact that the directory is named `src`
423 # * the fact that there is a sub-directory named `src`
424 var pn
= rdp
.basename
(".nit")
425 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
427 # dirpath2 is the root directory
428 # dirpath is the src subdirectory directory, if any, else it is the same that dirpath2
429 var dirpath2
= dirpath
430 if not mp
.file_exists
then
432 # With a src directory, the group name is the name of the parent directory
433 dirpath2
= rdp
.dirname
434 pn
= dirpath2
.basename
("")
436 # Check a `src` subdirectory
437 dirpath
= dirpath2
/ "src"
438 if not dirpath
.file_exists
then
439 # All rules failed, so return null
445 # check parent directory
446 var parentpath
= dirpath2
.join_path
("..").simplify_path
447 var parent
= get_mgroup
(parentpath
)
450 if parent
== null then
451 # no parent, thus new project
452 var mproject
= new MProject(pn
, model
)
453 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
454 mproject
.root
= mgroup
455 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
457 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
458 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
461 # search documentation
462 # in src first so the documentation of the project code can be distinct for the documentation of the project usage
463 var readme
= dirpath
.join_path
("README.md")
464 if not readme
.file_exists
then readme
= dirpath
.join_path
("README")
465 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README.md")
466 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README")
467 if readme
.file_exists
then
468 var mdoc
= load_markdown
(readme
)
470 mdoc
.original_mentity
= mgroup
473 mgroup
.filepath
= dirpath
474 mgroups
[module_absolute_path
(dirpath
)] = mgroup
475 mgroups
[module_absolute_path
(dirpath2
)] = mgroup
479 # Load a markdown file as a documentation object
480 fun load_markdown
(filepath
: String): MDoc
482 var mdoc
= new MDoc(new Location(new SourceFile.from_string
(filepath
, ""),0,0,0,0))
483 var s
= new FileReader.open
(filepath
)
485 mdoc
.content
.add
(s
.read_line
)
490 # Force the identification of all ModulePath of the group and sub-groups.
491 fun visit_group
(mgroup
: MGroup) do
492 var p
= mgroup
.filepath
495 var g
= get_mgroup
(fp
)
496 if g
!= null then visit_group
(g
)
501 # Transform relative paths (starting with '../') into absolute paths
502 private fun module_absolute_path
(path
: String): String do
503 return getcwd
.join_path
(path
).simplify_path
506 # Try to load a module AST using a path.
507 # Display an error if there is a problem (IO / lexer / parser) and return null
508 fun load_module_ast
(filename
: String): nullable AModule
510 if filename
.file_extension
!= "nit" then
511 self.toolcontext
.error
(null, "Error: file `{filename}` is not a valid nit module.")
514 if not filename
.file_exists
then
515 self.toolcontext
.error
(null, "Error: file `{filename}` not found.")
519 self.toolcontext
.info
("load module {filename}", 2)
522 var file
= new FileReader.open
(filename
)
523 var lexer
= new Lexer(new SourceFile(filename
, file
))
524 var parser
= new Parser(lexer
)
525 var tree
= parser
.parse
528 # Handle lexer and parser error
529 var nmodule
= tree
.n_base
530 if nmodule
== null then
531 var neof
= tree
.n_eof
532 assert neof
isa AError
533 error
(neof
, neof
.message
)
540 # Remove Nit source files from a list of arguments.
542 # Items of `args` that can be loaded as a nit file will be removed from `args` and returned.
543 fun filter_nit_source
(args
: Array[String]): Array[String]
545 var keep
= new Array[String]
546 var res
= new Array[String]
548 var l
= identify_file
(a
)
560 # Try to load a module using a path.
561 # Display an error if there is a problem (IO / lexer / parser) and return null.
562 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
564 # The MModule is created however, the importation is not performed,
565 # therefore you should call `build_module_importation`.
566 fun load_module
(filename
: String): nullable AModule
568 # Look for the module
569 var file
= identify_file
(filename
)
571 if filename
.file_exists
then
572 toolcontext
.error
(null, "Error: `{filename}` is not a Nit source file.")
574 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
579 # Already known and loaded? then return it
580 var mmodule
= file
.mmodule
581 if mmodule
!= null then
582 return mmodule2nmodule
[mmodule
]
586 var nmodule
= load_module_ast
(file
.filepath
)
587 if nmodule
== null then return null # forward error
589 # build the mmodule and load imported modules
590 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
592 if mmodule
== null then return null # forward error
594 # Update the file information
595 file
.mmodule
= mmodule
600 # Injection of a new module without source.
601 # Used by the interpreter.
602 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
607 if parent
!= null then mgroup
= parent
.mgroup
608 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
609 nmodule
.mmodule
= mmodule
610 nmodules
.add
(nmodule
)
611 self.mmodule2nmodule
[mmodule
] = nmodule
613 if parent
!= null then
614 var imported_modules
= new Array[MModule]
615 imported_modules
.add
(parent
)
616 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
617 mmodule
.set_imported_mmodules
(imported_modules
)
619 build_module_importation
(nmodule
)
625 # Visit the AST and create the `MModule` object
626 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
628 # Check the module name
629 var decl
= nmodule
.n_moduledecl
631 var decl_name
= decl
.n_name
.n_id
.text
632 if decl_name
!= mod_name
then
633 error
(decl
.n_name
, "Error: module name mismatch; declared {decl_name} file named {mod_name}.")
637 # Check for conflicting module names in the project
638 if mgroup
!= null then
639 var others
= model
.get_mmodules_by_name
(mod_name
)
640 if others
!= null then for other
in others
do
641 if other
.mgroup
!= null and other
.mgroup
.mproject
== mgroup
.mproject
then
643 if decl
== null then node
= nmodule
else node
= decl
.n_name
644 error
(node
, "Error: a module named `{other.full_name}` already exists at {other.location}.")
651 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
652 nmodule
.mmodule
= mmodule
653 nmodules
.add
(nmodule
)
654 self.mmodule2nmodule
[mmodule
] = nmodule
656 var source
= nmodule
.location
.file
657 if source
!= null then
658 assert source
.mmodule
== null
659 source
.mmodule
= mmodule
663 # Extract documentation
664 var ndoc
= decl
.n_doc
666 var mdoc
= ndoc
.to_mdoc
668 mdoc
.original_mentity
= mmodule
670 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
672 # Is the module a test suite?
673 mmodule
.is_test_suite
= not decl
.get_annotations
("test_suite").is_empty
679 # Analyze the module importation and fill the module_importation_hierarchy
681 # Unless you used `load_module`, the importation is already done and this method does a no-op.
682 fun build_module_importation
(nmodule
: AModule)
684 if nmodule
.is_importation_done
then return
685 nmodule
.is_importation_done
= true
686 var mmodule
= nmodule
.mmodule
.as(not null)
688 var imported_modules
= new Array[MModule]
689 for aimport
in nmodule
.n_imports
do
691 if not aimport
isa AStdImport then
694 var mgroup
= mmodule
.mgroup
695 if aimport
.n_name
.n_quad
!= null then mgroup
= null # Start from top level
696 for grp
in aimport
.n_name
.n_path
do
697 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
699 nmodule
.mmodule
= null # invalidate the module
704 var mod_name
= aimport
.n_name
.n_id
.text
705 var sup
= self.get_mmodule_by_name
(aimport
.n_name
, mgroup
, mod_name
)
707 nmodule
.mmodule
= null # invalidate the module
708 continue # Skip error
710 aimport
.mmodule
= sup
711 imported_modules
.add
(sup
)
712 var mvisibility
= aimport
.n_visibility
.mvisibility
713 if mvisibility
== protected_visibility
then
714 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
715 nmodule
.mmodule
= null # invalidate the module
718 if sup
== mmodule
then
719 error
(aimport
.n_name
, "Error: dependency loop in module {mmodule}.")
720 nmodule
.mmodule
= null # invalidate the module
722 if sup
.in_importation
< mmodule
then
723 error
(aimport
.n_name
, "Error: dependency loop between modules {mmodule} and {sup}.")
724 nmodule
.mmodule
= null # invalidate the module
727 mmodule
.set_visibility_for
(sup
, mvisibility
)
730 var mod_name
= "standard"
731 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
733 nmodule
.mmodule
= null # invalidate the module
735 imported_modules
.add
(sup
)
736 mmodule
.set_visibility_for
(sup
, public_visibility
)
739 self.toolcontext
.info
("{mmodule} imports {imported_modules.join(", ")}", 3)
740 mmodule
.set_imported_mmodules
(imported_modules
)
742 # Force standard to be public if imported
743 for sup
in mmodule
.in_importation
.greaters
do
744 if sup
.name
== "standard" then
745 mmodule
.set_visibility_for
(sup
, public_visibility
)
749 # TODO: Correctly check for useless importation
751 var directs
= mmodule
.in_importation
.direct_greaters
752 for nim
in nmodule
.n_imports
do
753 if not nim
isa AStdImport then continue
755 if im
== null then continue
756 if directs
.has
(im
) then continue
757 # This generates so much noise that it is simpler to just comment it
758 #warning(nim, "Warning: possible useless importation of {im}")
762 # All the loaded modules
763 var nmodules
= new Array[AModule]
765 # Register the nmodule associated to each mmodule
767 # Public clients need to use `mmodule2node` to access stuff.
768 private var mmodule2nmodule
= new HashMap[MModule, AModule]
770 # Retrieve the associated AST node of a mmodule.
771 # This method is used to associate model entity with syntactic entities.
773 # If the module is not associated with a node, returns null.
774 fun mmodule2node
(mmodule
: MModule): nullable AModule
776 return mmodule2nmodule
.get_or_null
(mmodule
)
780 # File-system location of a module (file) that is identified but not always loaded.
782 # The name of the module
783 # (it's the basename of the filepath)
786 # The human path of the module
789 # The group (and the project) of the possible module
792 # The loaded module (if any)
793 var mmodule
: nullable MModule = null
795 redef fun to_s
do return filepath
799 # Modules paths associated with the group
800 var module_paths
= new Array[ModulePath]
802 # Is the group interesting for a final user?
804 # Groups are mandatory in the model but for simple projects they are not
805 # always interesting.
807 # A interesting group has, at least, one of the following true:
809 # * it has 2 modules or more
810 # * it has a subgroup
811 # * it has a documentation
812 fun is_interesting
: Bool
814 return module_paths
.length
> 1 or mmodules
.length
> 1 or not in_nesting
.direct_smallers
.is_empty
or mdoc
!= null
819 redef class SourceFile
820 # Associated mmodule, once created
821 var mmodule
: nullable MModule = null
824 redef class AStdImport
825 # The imported module once determined
826 var mmodule
: nullable MModule = null
830 # The associated MModule once build by a `ModelBuilder`
831 var mmodule
: nullable MModule
832 # Flag that indicate if the importation is already completed
833 var is_importation_done
: Bool = false