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
)
57 # Load a bunch of modules.
58 # `modules` can contains filenames or module names.
59 # Imported modules are automatically loaded and modelized.
60 # The result is the corresponding model elements.
61 # Errors and warnings are printed with the toolcontext.
63 # Note: class and property model elements are not analysed.
64 fun parse
(modules
: Sequence[String]): Array[MModule]
67 # Parse and recursively load
68 self.toolcontext
.info
("*** PARSE ***", 1)
69 var mmodules
= new ArraySet[MModule]
71 var nmodule
= self.load_module
(a
)
72 if nmodule
== null then continue # Skip error
73 # Load imported module
74 build_module_importation
(nmodule
)
76 mmodules
.add
(nmodule
.mmodule
.as(not null))
79 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
81 self.toolcontext
.check_errors
83 if toolcontext
.opt_only_parse
.value
then
84 self.toolcontext
.info
("*** ONLY PARSE...", 1)
91 # The list of directories to search for top level modules
92 # The list is initially set with:
94 # * the toolcontext --path option
95 # * the NIT_PATH environment variable
96 # * `toolcontext.nit_dir`
97 # Path can be added (or removed) by the client
98 var paths
= new Array[String]
100 # Like (and used by) `get_mmodule_by_name` but just return the ModulePath
101 fun search_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable ModulePath
103 # First, look in groups
106 var dirname
= c
.filepath
107 if dirname
== null then break # virtual group
108 if dirname
.has_suffix
(".nit") then break # singleton project
110 # Second, try the directory to find a file
111 var try_file
= dirname
+ "/" + name
+ ".nit"
112 if try_file
.file_exists
then
113 var res
= self.identify_file
(try_file
.simplify_path
)
118 # Third, try if the requested module is itself a group
119 try_file
= dirname
+ "/" + name
+ "/" + name
+ ".nit"
120 if try_file
.file_exists
then
121 var res
= self.identify_file
(try_file
.simplify_path
)
129 # Look at some known directories
130 var lookpaths
= self.paths
132 # Look in the directory of the group project also (even if not explicitly in the path)
133 if mgroup
!= null then
134 # path of the root group
135 var dirname
= mgroup
.mproject
.root
.filepath
136 if dirname
!= null then
137 dirname
= dirname
.join_path
("..").simplify_path
138 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
139 lookpaths
= lookpaths
.to_a
140 lookpaths
.add
(dirname
)
145 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
147 if candidate
== null then
148 if mgroup
!= null then
149 error
(anode
, "Error: cannot find module {name} from {mgroup.name}. tried {lookpaths.join(", ")}")
151 error
(anode
, "Error: cannot find module {name}. tried {lookpaths.join(", ")}")
158 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
159 # If `mgroup` is set, then the module search starts from it up to the top level (see `paths`);
160 # if `mgroup` is null then the module is searched in the top level only.
161 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
162 fun get_mmodule_by_name
(anode
: nullable ANode, mgroup
: nullable MGroup, name
: String): nullable MModule
164 var path
= search_mmodule_by_name
(anode
, mgroup
, name
)
165 if path
== null then return null # Forward error
166 var res
= self.load_module
(path
.filepath
)
167 if res
== null then return null # Forward error
168 # Load imported module
169 build_module_importation
(res
)
170 return res
.mmodule
.as(not null)
173 # Search a module `name` from path `lookpaths`.
174 # If found, the path of the file is returned
175 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable ModulePath
177 var candidate
: nullable String = null
178 for dirname
in lookpaths
do
179 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
180 if try_file
.file_exists
then
181 if candidate
== null then
183 else if candidate
!= try_file
then
184 # try to disambiguate conflicting modules
185 var abs_candidate
= module_absolute_path
(candidate
)
186 var abs_try_file
= module_absolute_path
(try_file
)
187 if abs_candidate
!= abs_try_file
then
188 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
192 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
193 if try_file
.file_exists
then
194 if candidate
== null then
196 else if candidate
!= try_file
then
197 # try to disambiguate conflicting modules
198 var abs_candidate
= module_absolute_path
(candidate
)
199 var abs_try_file
= module_absolute_path
(try_file
)
200 if abs_candidate
!= abs_try_file
then
201 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
206 if candidate
== null then return null
207 return identify_file
(candidate
)
210 # Cache for `identify_file` by realpath
211 private var identified_files_by_path
= new HashMap[String, nullable ModulePath]
213 # All the currently identified modules.
214 # See `identify_file`.
215 var identified_files
= new Array[ModulePath]
217 # Identify a source file
218 # Load the associated project and groups if required
220 # Silently return `null` if `path` is not a valid module path.
221 fun identify_file
(path
: String): nullable ModulePath
223 # special case for not a nit file
224 if path
.file_extension
!= "nit" then
225 # search dirless files in known -I paths
226 if path
.dirname
== "" then
227 var res
= search_module_in_paths
(null, path
, self.paths
)
228 if res
!= null then return res
231 # Found nothing? maybe it is a group...
233 if path
.file_exists
then
234 var mgroup
= get_mgroup
(path
)
235 if mgroup
!= null then
236 var owner_path
= mgroup
.filepath
.join_path
(mgroup
.name
+ ".nit")
237 if owner_path
.file_exists
then candidate
= owner_path
241 if candidate
== null then
247 # Fast track, the path is already known
248 var pn
= path
.basename
(".nit")
249 var rp
= module_absolute_path
(path
)
250 if identified_files_by_path
.has_key
(rp
) then return identified_files_by_path
[rp
]
253 var mgrouppath
= path
.join_path
("..").simplify_path
254 var mgroup
= get_mgroup
(mgrouppath
)
256 if mgroup
== null then
258 var mproject
= new MProject(pn
, model
)
259 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
260 mgroup
.filepath
= path
261 mproject
.root
= mgroup
262 toolcontext
.info
("found project `{pn}` at {path}", 2)
265 var res
= new ModulePath(pn
, path
, mgroup
)
266 mgroup
.module_paths
.add
(res
)
268 identified_files_by_path
[rp
] = res
269 identified_files
.add
(res
)
274 private var mgroups
= new HashMap[String, nullable MGroup]
276 # Return the mgroup associated to a directory path.
277 # If the directory is not a group null is returned.
278 fun get_mgroup
(dirpath
: String): nullable MGroup
280 var rdp
= module_absolute_path
(dirpath
)
281 if mgroups
.has_key
(rdp
) then
285 # Hack, a group is determined by:
286 # * the presence of a honomymous nit file
287 # * the fact that the directory is named `src`
288 var pn
= rdp
.basename
(".nit")
289 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
291 var dirpath2
= dirpath
292 if not mp
.file_exists
then
294 # With a src directory, the group name is the name of the parent directory
295 dirpath2
= rdp
.dirname
296 pn
= dirpath2
.basename
("")
302 # check parent directory
303 var parentpath
= dirpath
.join_path
("..").simplify_path
304 var parent
= get_mgroup
(parentpath
)
307 if parent
== null then
308 # no parent, thus new project
309 var mproject
= new MProject(pn
, model
)
310 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
311 mproject
.root
= mgroup
312 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
314 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
315 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
317 var readme
= dirpath2
.join_path
("README.md")
318 if not readme
.file_exists
then readme
= dirpath2
.join_path
("README")
319 if readme
.file_exists
then
321 var s
= new IFStream.open
(readme
)
323 mdoc
.content
.add
(s
.read_line
)
326 mdoc
.original_mentity
= mgroup
328 mgroup
.filepath
= dirpath
329 mgroups
[rdp
] = mgroup
333 # Force the identification of all ModulePath of the group and sub-groups.
334 fun visit_group
(mgroup
: MGroup) do
335 var p
= mgroup
.filepath
338 var g
= get_mgroup
(fp
)
339 if g
!= null then visit_group
(g
)
344 # Transform relative paths (starting with '../') into absolute paths
345 private fun module_absolute_path
(path
: String): String do
346 return getcwd
.join_path
(path
).simplify_path
349 # Try to load a module AST using a path.
350 # Display an error if there is a problem (IO / lexer / parser) and return null
351 fun load_module_ast
(filename
: String): nullable AModule
353 if filename
.file_extension
!= "nit" then
354 self.toolcontext
.error
(null, "Error: file {filename} is not a valid nit module.")
357 if not filename
.file_exists
then
358 self.toolcontext
.error
(null, "Error: file {filename} not found.")
362 self.toolcontext
.info
("load module {filename}", 2)
365 var file
= new IFStream.open
(filename
)
366 var lexer
= new Lexer(new SourceFile(filename
, file
))
367 var parser
= new Parser(lexer
)
368 var tree
= parser
.parse
371 # Handle lexer and parser error
372 var nmodule
= tree
.n_base
373 if nmodule
== null then
374 var neof
= tree
.n_eof
375 assert neof
isa AError
376 error
(neof
, neof
.message
)
383 # Try to load a module using a path.
384 # Display an error if there is a problem (IO / lexer / parser) and return null.
385 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
387 # The MModule is created however, the importation is not performed,
388 # therefore you should call `build_module_importation`.
389 fun load_module
(filename
: String): nullable AModule
391 # Look for the module
392 var file
= identify_file
(filename
)
394 toolcontext
.error
(null, "Error: cannot find module `{filename}`.")
398 # Already known and loaded? then return it
399 var mmodule
= file
.mmodule
400 if mmodule
!= null then
401 return mmodule2nmodule
[mmodule
]
405 var nmodule
= load_module_ast
(file
.filepath
)
406 if nmodule
== null then return null # forward error
408 # build the mmodule and load imported modules
409 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
411 if mmodule
== null then return null # forward error
413 # Update the file information
414 file
.mmodule
= mmodule
419 # Injection of a new module without source.
420 # Used by the interpreter.
421 fun load_rt_module
(parent
: nullable MModule, nmodule
: AModule, mod_name
: String): nullable AModule
426 if parent
!= null then mgroup
= parent
.mgroup
427 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
428 nmodule
.mmodule
= mmodule
429 nmodules
.add
(nmodule
)
430 self.mmodule2nmodule
[mmodule
] = nmodule
432 if parent
!= null then
433 var imported_modules
= new Array[MModule]
434 imported_modules
.add
(parent
)
435 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
436 mmodule
.set_imported_mmodules
(imported_modules
)
438 build_module_importation
(nmodule
)
444 # Visit the AST and create the `MModule` object
445 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
447 # Check the module name
448 var decl
= nmodule
.n_moduledecl
450 #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY
452 var decl_name
= decl
.n_name
.n_id
.text
453 if decl_name
!= mod_name
then
454 error
(decl
.n_name
, "Error: module name missmatch; declared {decl_name} file named {mod_name}")
459 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
460 nmodule
.mmodule
= mmodule
461 nmodules
.add
(nmodule
)
462 self.mmodule2nmodule
[mmodule
] = nmodule
465 var ndoc
= decl
.n_doc
467 var mdoc
= ndoc
.to_mdoc
469 mdoc
.original_mentity
= mmodule
471 advice
(decl
, "missing-doc", "Documentation warning: Undocumented module `{mmodule}`")
478 # Analyze the module importation and fill the module_importation_hierarchy
480 # Unless you used `load_module`, the importation is already done and this method does a no-op.
481 fun build_module_importation
(nmodule
: AModule)
483 if nmodule
.is_importation_done
then return
484 nmodule
.is_importation_done
= true
485 var mmodule
= nmodule
.mmodule
.as(not null)
487 var imported_modules
= new Array[MModule]
488 for aimport
in nmodule
.n_imports
do
490 if not aimport
isa AStdImport then
493 var mgroup
= mmodule
.mgroup
494 if aimport
.n_name
.n_quad
!= null then mgroup
= null # Start from top level
495 for grp
in aimport
.n_name
.n_path
do
496 var path
= search_mmodule_by_name
(grp
, mgroup
, grp
.text
)
497 if path
== null then return # Skip error
500 var mod_name
= aimport
.n_name
.n_id
.text
501 var sup
= self.get_mmodule_by_name
(aimport
.n_name
, mgroup
, mod_name
)
502 if sup
== null then continue # Skip error
503 aimport
.mmodule
= sup
504 imported_modules
.add
(sup
)
505 var mvisibility
= aimport
.n_visibility
.mvisibility
506 if mvisibility
== protected_visibility
then
507 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
510 if sup
== mmodule
then
511 error
(aimport
.n_name
, "Error: Dependency loop in module {mmodule}.")
513 if sup
.in_importation
< mmodule
then
514 error
(aimport
.n_name
, "Error: Dependency loop between modules {mmodule} and {sup}.")
517 mmodule
.set_visibility_for
(sup
, mvisibility
)
520 var mod_name
= "standard"
521 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
522 if sup
!= null then # Skip error
523 imported_modules
.add
(sup
)
524 mmodule
.set_visibility_for
(sup
, public_visibility
)
527 self.toolcontext
.info
("{mmodule} imports {imported_modules.join(", ")}", 3)
528 mmodule
.set_imported_mmodules
(imported_modules
)
530 # Force standard to be public if imported
531 for sup
in mmodule
.in_importation
.greaters
do
532 if sup
.name
== "standard" then
533 mmodule
.set_visibility_for
(sup
, public_visibility
)
537 # TODO: Correctly check for useless importation
539 var directs
= mmodule
.in_importation
.direct_greaters
540 for nim
in nmodule
.n_imports
do
541 if not nim
isa AStdImport then continue
543 if im
== null then continue
544 if directs
.has
(im
) then continue
545 # This generates so much noise that it is simpler to just comment it
546 #warning(nim, "Warning: possible useless importation of {im}")
550 # All the loaded modules
551 var nmodules
= new Array[AModule]
553 # Register the nmodule associated to each mmodule
554 # FIXME: why not refine the `MModule` class with a nullable attribute?
555 var mmodule2nmodule
= new HashMap[MModule, AModule]
558 # File-system location of a module (file) that is identified but not always loaded.
560 # The name of the module
561 # (it's the basename of the filepath)
564 # The human path of the module
567 # The group (and the project) of the possible module
570 # The loaded module (if any)
571 var mmodule
: nullable MModule = null
573 redef fun to_s
do return filepath
577 # Modules paths associated with the group
578 var module_paths
= new Array[ModulePath]
580 # Is the group interesting for a final user?
582 # Groups are mandatory in the model but for simple projects they are not
583 # always interesting.
585 # A interesting group has, at least, one of the following true:
587 # * it has 2 modules or more
588 # * it has a subgroup
589 # * it has a documentation
590 fun is_interesting
: Bool
592 return module_paths
.length
> 1 or mmodules
.length
> 1 or not in_nesting
.direct_smallers
.is_empty
or mdoc
!= null
597 redef class AStdImport
598 # The imported module once determined
599 var mmodule
: nullable MModule = null
603 # The associated MModule once build by a `ModelBuilder`
604 var mmodule
: nullable MModule
605 # Flag that indicate if the importation is already completed
606 var is_importation_done
: Bool = false