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 # Load nit source files and build the associated model
21 # FIXME split this module into submodules
22 # FIXME add missing error checks
32 private import more_collections
36 redef class ToolContext
38 var opt_path
: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
40 # Option --only-metamodel
41 var opt_only_metamodel
: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel")
44 var opt_only_parse
: OptionBool = new OptionBool("Only proceed to parse step of loaders", "--only-parse")
49 option_context
.add_option
(opt_path
, opt_only_parse
, opt_only_metamodel
)
52 fun modelbuilder
: ModelBuilder do return modelbuilder_real
.as(not null)
53 private var modelbuilder_real
: nullable ModelBuilder = null
55 fun run_global_phases
(mainmodule
: MModule)
57 for phase
in phases_list
do
58 phase
.process_mainmodule
(mainmodule
)
64 # Specific action to execute on the whole program
65 # Called by the `ToolContext::run_global_phases`
67 fun process_mainmodule
(mainmodule
: MModule) do end
71 # A model builder knows how to load nit source files and build the associated model
73 # The model where new modules, classes and properties are added
76 # The toolcontext used to control the interaction with the user (getting options and displaying messages)
77 var toolcontext
: ToolContext
79 # Run phases on all loaded modules
82 var mmodules
= model
.mmodules
.to_a
83 model
.mmodule_importation_hierarchy
.sort
(mmodules
)
84 var nmodules
= new Array[AModule]
86 nmodules
.add
(mmodule2nmodule
[mm
])
88 toolcontext
.run_phases
(nmodules
)
90 if toolcontext
.opt_only_metamodel
.value
then
91 self.toolcontext
.info
("*** ONLY METAMODEL", 1)
96 # Instantiate a modelbuilder for a model and a toolcontext
97 # Important, the options of the toolcontext must be correctly set (parse_option already called)
98 init(model
: Model, toolcontext
: ToolContext)
101 self.toolcontext
= toolcontext
102 assert toolcontext
.modelbuilder_real
== null
103 toolcontext
.modelbuilder_real
= self
105 # Setup the paths value
106 paths
.append
(toolcontext
.opt_path
.value
)
108 var path_env
= "NIT_PATH".environ
109 if not path_env
.is_empty
then
110 paths
.append
(path_env
.split_with
(':'))
113 path_env
= "NIT_DIR".environ
114 if not path_env
.is_empty
then
115 var libname
= "{path_env}/lib"
116 if libname
.file_exists
then paths
.add
(libname
)
119 var libname
= "{sys.program_name.dirname}/../lib"
120 if libname
.file_exists
then paths
.add
(libname
.simplify_path
)
123 # Load a bunch of modules.
124 # `modules` can contains filenames or module names.
125 # Imported modules are automatically loaded and modelized.
126 # The result is the corresponding model elements.
127 # Errors and warnings are printed with the toolcontext.
129 # Note: class and property model element are not analysed.
130 fun parse
(modules
: Sequence[String]): Array[MModule]
133 # Parse and recursively load
134 self.toolcontext
.info
("*** PARSE ***", 1)
135 var mmodules
= new ArraySet[MModule]
137 var nmodule
= self.load_module
(a
)
138 if nmodule
== null then continue # Skip error
139 mmodules
.add
(nmodule
.mmodule
.as(not null))
142 self.toolcontext
.info
("*** END PARSE: {time1-time0} ***", 2)
144 self.toolcontext
.check_errors
146 if toolcontext
.opt_only_parse
.value
then
147 self.toolcontext
.info
("*** ONLY PARSE...", 1)
154 # Return a class named `name` visible by the module `mmodule`.
155 # Visibility in modules is correctly handled.
156 # If no such a class exists, then null is returned.
157 # If more than one class exists, then an error on `anode` is displayed and null is returned.
158 # FIXME: add a way to handle class name conflict
159 fun try_get_mclass_by_name
(anode
: ANode, mmodule
: MModule, name
: String): nullable MClass
161 var classes
= model
.get_mclasses_by_name
(name
)
162 if classes
== null then
166 var res
: nullable MClass = null
167 for mclass
in classes
do
168 if not mmodule
.in_importation
<= mclass
.intro_mmodule
then continue
169 if not mmodule
.is_visible
(mclass
.intro_mmodule
, mclass
.visibility
) then continue
173 error
(anode
, "Ambigous class name '{name}'; conflict between {mclass.full_name} and {res.full_name}")
180 # Return a property named `name` on the type `mtype` visible in the module `mmodule`.
181 # Visibility in modules is correctly handled.
182 # Protected properties are returned (it is up to the caller to check and reject protected properties).
183 # If no such a property exists, then null is returned.
184 # If more than one property exists, then an error on `anode` is displayed and null is returned.
185 # FIXME: add a way to handle property name conflict
186 fun try_get_mproperty_by_name2
(anode
: ANode, mmodule
: MModule, mtype
: MType, name
: String): nullable MProperty
188 var props
= self.model
.get_mproperties_by_name
(name
)
189 if props
== null then
193 var cache
= self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
]
194 if cache
!= null then return cache
196 var res
: nullable MProperty = null
197 var ress
: nullable Array[MProperty] = null
198 for mprop
in props
do
199 if not mtype
.has_mproperty
(mmodule
, mprop
) then continue
200 if not mmodule
.is_visible
(mprop
.intro_mclassdef
.mmodule
, mprop
.visibility
) then continue
204 var restype
= res
.intro_mclassdef
.bound_mtype
205 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
206 if restype
.is_subtype
(mmodule
, null, mproptype
) then
208 else if mproptype
.is_subtype
(mmodule
, null, restype
) then
211 if ress
== null then ress
= new Array[MProperty]
217 var restype
= res
.intro_mclassdef
.bound_mtype
219 var mproptype
= mprop
.intro_mclassdef
.bound_mtype
220 if not restype
.is_subtype
(mmodule
, null, mproptype
) then
221 self.error
(anode
, "Ambigous property name '{name}' for {mtype}; conflict between {mprop.full_name} and {res.full_name}")
227 self.try_get_mproperty_by_name2_cache
[mmodule
, mtype
, name
] = res
231 private var try_get_mproperty_by_name2_cache
: HashMap3[MModule, MType, String, nullable MProperty] = new HashMap3[MModule, MType, String, nullable MProperty]
234 # Alias for try_get_mproperty_by_name2(anode, mclassdef.mmodule, mclassdef.mtype, name)
235 fun try_get_mproperty_by_name
(anode
: ANode, mclassdef
: MClassDef, name
: String): nullable MProperty
237 return try_get_mproperty_by_name2
(anode
, mclassdef
.mmodule
, mclassdef
.bound_mtype
, name
)
240 # The list of directories to search for top level modules
241 # The list is initially set with :
242 # * the toolcontext --path option
243 # * the NIT_PATH environment variable
244 # * some heuristics including the NIT_DIR environment variable and the progname of the process
245 # Path can be added (or removed) by the client
246 var paths
: Array[String] = new Array[String]
248 # Get a module by its short name; if required, the module is loaded, parsed and its hierarchies computed.
249 # If `mmodule` is set, then the module search starts from it up to the top level (see `paths`);
250 # if `mmodule` is null then the module is searched in the top level only.
251 # If no module exists or there is a name conflict, then an error on `anode` is displayed and null is returned.
252 # FIXME: add a way to handle module name conflict
253 fun get_mmodule_by_name
(anode
: ANode, mmodule
: nullable MModule, name
: String): nullable MModule
255 # First, look in groups of the module
256 if mmodule
!= null then
257 var mgroup
= mmodule
.mgroup
258 while mgroup
!= null do
259 var dirname
= mgroup
.filepath
260 if dirname
== null then break # virtual group
261 if dirname
.has_suffix
(".nit") then break # singleton project
263 # Second, try the directory to find a file
264 var try_file
= dirname
+ "/" + name
+ ".nit"
265 if try_file
.file_exists
then
266 var res
= self.load_module
(try_file
.simplify_path
)
267 if res
== null then return null # Forward error
268 return res
.mmodule
.as(not null)
271 # Third, try if the requested module is itself a group
272 try_file
= dirname
+ "/" + name
+ "/" + name
+ ".nit"
273 if try_file
.file_exists
then
274 mgroup
= get_mgroup
(dirname
+ "/" + name
)
275 var res
= self.load_module
(try_file
.simplify_path
)
276 if res
== null then return null # Forward error
277 return res
.mmodule
.as(not null)
280 mgroup
= mgroup
.parent
284 # Look at some known directories
285 var lookpaths
= self.paths
287 # Look in the directory of module project also (even if not explicitely in the path)
288 if mmodule
!= null and mmodule
.mgroup
!= null then
289 # path of the root group
290 var dirname
= mmodule
.mgroup
.mproject
.root
.filepath
291 if dirname
!= null then
292 dirname
= dirname
.join_path
("..").simplify_path
293 if not lookpaths
.has
(dirname
) and dirname
.file_exists
then
294 lookpaths
= lookpaths
.to_a
295 lookpaths
.add
(dirname
)
300 var candidate
= search_module_in_paths
(anode
.hot_location
, name
, lookpaths
)
302 if candidate
== null then
303 if mmodule
!= null then
304 error
(anode
, "Error: cannot find module {name} from {mmodule}. tried {lookpaths.join(", ")}")
306 error
(anode
, "Error: cannot find module {name}. tried {lookpaths.join(", ")}")
310 var res
= self.load_module
(candidate
)
311 if res
== null then return null # Forward error
312 return res
.mmodule
.as(not null)
315 # Search a module `name` from path `lookpaths`.
316 # If found, the path of the file is returned
317 private fun search_module_in_paths
(location
: nullable Location, name
: String, lookpaths
: Collection[String]): nullable String
319 var candidate
: nullable String = null
320 for dirname
in lookpaths
do
321 var try_file
= (dirname
+ "/" + name
+ ".nit").simplify_path
322 if try_file
.file_exists
then
323 if candidate
== null then
325 else if candidate
!= try_file
then
326 # try to disambiguate conflicting modules
327 var abs_candidate
= module_absolute_path
(candidate
)
328 var abs_try_file
= module_absolute_path
(try_file
)
329 if abs_candidate
!= abs_try_file
then
330 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
334 try_file
= (dirname
+ "/" + name
+ "/" + name
+ ".nit").simplify_path
335 if try_file
.file_exists
then
336 if candidate
== null then
338 else if candidate
!= try_file
then
339 # try to disambiguate conflicting modules
340 var abs_candidate
= module_absolute_path
(candidate
)
341 var abs_try_file
= module_absolute_path
(try_file
)
342 if abs_candidate
!= abs_try_file
then
343 toolcontext
.error
(location
, "Error: conflicting module file for {name}: {candidate} {try_file}")
351 # cache for `identify_file` by realpath
352 private var identified_files
= new HashMap[String, nullable ModulePath]
354 # Identify a source file
355 # Load the associated project and groups if required
356 private fun identify_file
(path
: String): nullable ModulePath
358 if not path
.file_exists
then
359 toolcontext
.error
(null, "Error: `{path}` does not exists")
363 # Fast track, the path is already known
364 var pn
= path
.basename
(".nit")
365 var rp
= module_absolute_path
(path
)
366 if identified_files
.has_key
(rp
) then return identified_files
[rp
]
369 var mgrouppath
= path
.join_path
("..").simplify_path
370 var mgroup
= get_mgroup
(mgrouppath
)
372 if mgroup
== null then
374 var mproject
= new MProject(pn
, model
)
375 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
376 mgroup
.filepath
= path
377 mproject
.root
= mgroup
378 toolcontext
.info
("found project `{pn}` at {path}", 2)
381 var res
= new ModulePath(pn
, path
, mgroup
)
383 identified_files
[rp
] = res
388 private var mgroups
= new HashMap[String, nullable MGroup]
390 # return the mgroup associated to a directory path
391 # if the directory is not a group null is returned
392 private fun get_mgroup
(dirpath
: String): nullable MGroup
394 var rdp
= module_absolute_path
(dirpath
)
395 if mgroups
.has_key
(rdp
) then
399 # Hack, a dir is determined by the presence of a honomymous nit file
400 var pn
= rdp
.basename
(".nit")
401 var mp
= dirpath
.join_path
(pn
+ ".nit").simplify_path
403 if not mp
.file_exists
then return null
405 # check parent directory
406 var parentpath
= dirpath
.join_path
("..").simplify_path
407 var parent
= get_mgroup
(parentpath
)
410 if parent
== null then
411 # no parent, thus new project
412 var mproject
= new MProject(pn
, model
)
413 mgroup
= new MGroup(pn
, mproject
, null) # same name for the root group
414 mproject
.root
= mgroup
415 toolcontext
.info
("found project `{mproject}` at {dirpath}", 2)
417 mgroup
= new MGroup(pn
, parent
.mproject
, parent
)
418 toolcontext
.info
("found sub group `{mgroup.full_name}` at {dirpath}", 2)
420 mgroup
.filepath
= dirpath
421 mgroups
[rdp
] = mgroup
425 # Transform relative paths (starting with '../') into absolute paths
426 private fun module_absolute_path
(path
: String): String do
427 return getcwd
.join_path
(path
).simplify_path
430 # Try to load a module AST using a path.
431 # Display an error if there is a problem (IO / lexer / parser) and return null
432 fun load_module_ast
(filename
: String): nullable AModule
434 if filename
.file_extension
!= "nit" then
435 self.toolcontext
.error
(null, "Error: file {filename} is not a valid nit module.")
438 if not filename
.file_exists
then
439 self.toolcontext
.error
(null, "Error: file {filename} not found.")
443 self.toolcontext
.info
("load module {filename}", 2)
446 var file
= new IFStream.open
(filename
)
447 var lexer
= new Lexer(new SourceFile(filename
, file
))
448 var parser
= new Parser(lexer
)
449 var tree
= parser
.parse
451 var mod_name
= filename
.basename
(".nit")
453 # Handle lexer and parser error
454 var nmodule
= tree
.n_base
455 if nmodule
== null then
456 var neof
= tree
.n_eof
457 assert neof
isa AError
458 error
(neof
, neof
.message
)
465 # Try to load a module and its imported modules using a path.
466 # Display an error if there is a problem (IO / lexer / parser / importation) and return null
467 # Note: usually, you do not need this method, use `get_mmodule_by_name` instead.
468 fun load_module
(filename
: String): nullable AModule
470 # Look for the module
471 var file
= identify_file
(filename
)
472 if file
== null then return null # forward error
474 # Already known and loaded? then return it
475 var mmodule
= file
.mmodule
476 if mmodule
!= null then
477 return mmodule2nmodule
[mmodule
]
481 var nmodule
= load_module_ast
(filename
)
482 if nmodule
== null then return null # forward error
484 # build the mmodule and load imported modules
485 mmodule
= build_a_mmodule
(file
.mgroup
, file
.name
, nmodule
)
487 if mmodule
== null then return null # forward error
489 # Update the file information
490 file
.mmodule
= mmodule
492 # Load imported module
493 build_module_importation
(nmodule
)
498 fun load_rt_module
(parent
: MModule, nmodule
: AModule, mod_name
: String): nullable AModule
501 var mmodule
= new MModule(model
, parent
.mgroup
, mod_name
, nmodule
.location
)
502 nmodule
.mmodule
= mmodule
503 nmodules
.add
(nmodule
)
504 self.mmodule2nmodule
[mmodule
] = nmodule
506 var imported_modules
= new Array[MModule]
508 imported_modules
.add
(parent
)
509 mmodule
.set_visibility_for
(parent
, intrude_visibility
)
511 mmodule
.set_imported_mmodules
(imported_modules
)
516 # Visit the AST and create the `MModule` object
517 private fun build_a_mmodule
(mgroup
: nullable MGroup, mod_name
: String, nmodule
: AModule): nullable MModule
519 # Check the module name
520 var decl
= nmodule
.n_moduledecl
522 #warning(nmodule, "Warning: Missing 'module' keyword") #FIXME: NOT YET FOR COMPATIBILITY
524 var decl_name
= decl
.n_name
.n_id
.text
525 if decl_name
!= mod_name
then
526 error
(decl
.n_name
, "Error: module name missmatch; declared {decl_name} file named {mod_name}")
531 var mmodule
= new MModule(model
, mgroup
, mod_name
, nmodule
.location
)
532 nmodule
.mmodule
= mmodule
533 nmodules
.add
(nmodule
)
534 self.mmodule2nmodule
[mmodule
] = nmodule
539 # Analysis the module importation and fill the module_importation_hierarchy
540 private fun build_module_importation
(nmodule
: AModule)
542 if nmodule
.is_importation_done
then return
543 nmodule
.is_importation_done
= true
544 var mmodule
= nmodule
.mmodule
.as(not null)
546 var imported_modules
= new Array[MModule]
547 for aimport
in nmodule
.n_imports
do
549 if not aimport
isa AStdImport then
552 var mod_name
= aimport
.n_name
.n_id
.text
553 var sup
= self.get_mmodule_by_name
(aimport
.n_name
, mmodule
, mod_name
)
554 if sup
== null then continue # Skip error
555 aimport
.mmodule
= sup
556 imported_modules
.add
(sup
)
557 var mvisibility
= aimport
.n_visibility
.mvisibility
558 if mvisibility
== protected_visibility
then
559 error
(aimport
.n_visibility
, "Error: only properties can be protected.")
562 if sup
== mmodule
then
563 error
(aimport
.n_name
, "Error: Dependency loop in module {mmodule}.")
565 if sup
.in_importation
< mmodule
then
566 error
(aimport
.n_name
, "Error: Dependency loop between modules {mmodule} and {sup}.")
569 mmodule
.set_visibility_for
(sup
, mvisibility
)
572 var mod_name
= "standard"
573 var sup
= self.get_mmodule_by_name
(nmodule
, null, mod_name
)
574 if sup
!= null then # Skip error
575 imported_modules
.add
(sup
)
576 mmodule
.set_visibility_for
(sup
, public_visibility
)
579 self.toolcontext
.info
("{mmodule} imports {imported_modules.join(", ")}", 3)
580 mmodule
.set_imported_mmodules
(imported_modules
)
583 # All the loaded modules
584 var nmodules
: Array[AModule] = new Array[AModule]
586 # Register the nmodule associated to each mmodule
587 # FIXME: why not refine the `MModule` class with a nullable attribute?
588 var mmodule2nmodule
: HashMap[MModule, AModule] = new HashMap[MModule, AModule]
590 # Helper function to display an error on a node.
591 # Alias for `self.toolcontext.error(n.hot_location, text)`
592 fun error
(n
: ANode, text
: String)
594 self.toolcontext
.error
(n
.hot_location
, text
)
597 # Helper function to display a warning on a node.
598 # Alias for: `self.toolcontext.warning(n.hot_location, text)`
599 fun warning
(n
: ANode, text
: String)
601 self.toolcontext
.warning
(n
.hot_location
, text
)
604 # Force to get the primitive method named `name` on the type `recv` or do a fatal error on `n`
605 fun force_get_primitive_method
(n
: ANode, name
: String, recv
: MClass, mmodule
: MModule): MMethod
607 var res
= mmodule
.try_get_primitive_method
(name
, recv
)
609 self.toolcontext
.fatal_error
(n
.hot_location
, "Fatal Error: {recv} must have a property named {name}.")
616 # placeholder to a module file identified but not always loaded in a project
617 private class ModulePath
618 # The name of the module
619 # (it's the basename of the filepath)
622 # The human path of the module
625 # The group (and the project) of the possible module
628 # The loaded module (if any)
629 var mmodule
: nullable MModule = null
631 redef fun to_s
do return filepath
635 redef class AStdImport
636 # The imported module once determined
637 var mmodule
: nullable MModule = null
641 # The associated MModule once build by a `ModelBuilder`
642 var mmodule
: nullable MModule
643 # Flag that indicate if the importation is already completed
644 var is_importation_done
: Bool = false
647 redef class AVisibility
648 # The visibility level associated with the AST node class
649 fun mvisibility
: MVisibility is abstract
651 redef class AIntrudeVisibility
652 redef fun mvisibility
do return intrude_visibility
654 redef class APublicVisibility
655 redef fun mvisibility
do return public_visibility
657 redef class AProtectedVisibility
658 redef fun mvisibility
do return protected_visibility
660 redef class APrivateVisibility
661 redef fun mvisibility
do return private_visibility