1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2006-2008 Floréal Morandat <morandat@lirmm.fr>
4 # Copyright 2008 Jean Privat <jean@pryen.org>
5 # Copyright 2009 Jean-Sebastien Gelinas <calestar@gmail.com>
7 # Licensed under the Apache License, Version 2.0 (the "License");
8 # you may not use this file except in compliance with the License.
9 # You may obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 # See the License for the specific language governing permissions and
17 # limitations under the License.
19 # This module is used to load a metamodel
28 redef type OTHER: Message
30 readable var _location
: nullable Location
31 readable var _text
: String
33 redef fun <(other
: OTHER): Bool do
34 if location
== null then return true
35 if other
.location
== null then return false
37 return location
.as(not null) < other
.location
.as(not null)
40 redef fun to_s
: String do
50 # Global context for tools
54 readable var _error_count
: Int = 0
57 readable var _warning_count
: Int = 0
59 # Directory where to generate log files
60 readable var _log_directory
: String = "logs"
63 var _messages
: Array[Message] = new Array[Message]
64 var _message_sorter
: ComparableSorter[Message] = new ComparableSorter[Message]
68 if _messages
.length
> 0 then
69 _message_sorter
.sort
(_messages
)
78 if error_count
> 0 then exit
(1)
82 fun error
(l
: nullable Location, s
: String)
84 _messages
.add
(new Message(l
,s
))
85 _error_count
= _error_count
+ 1
88 # Add an error, show errors and quit
89 fun fatal_error
(l
: nullable Location, s
: String)
96 fun warning
(l
: nullable Location, s
: String)
98 if _opt_warn
.value
== 0 then return
99 _messages
.add
(new Message(l
,s
))
100 if _opt_warn
.value
== 1 then
101 _warning_count
= _warning_count
+ 1
103 _error_count
= _error_count
+ 1
108 fun info
(s
: String, level
: Int)
110 if level
<= verbose_level
then
115 # Paths where to locate modules files
116 readable var _paths
: Array[String] = new Array[String]
118 # List of module loaders
119 var _loaders
: Array[ModuleLoader] = new Array[ModuleLoader]
121 # Global OptionContext
122 readable var _option_context
: OptionContext = new OptionContext
125 readable var _opt_warn
: OptionCount = new OptionCount("Show warnings", "-W", "--warn")
128 readable var _opt_path
: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
131 readable var _opt_log
: OptionBool = new OptionBool("Generate various log files", "--log")
134 readable var _opt_log_dir
: OptionString = new OptionString("Directory where to generate log files", "--log-dir")
136 # Option --only-metamodel
137 readable var _opt_only_metamodel
: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel")
139 # Option --only-parse
140 readable var _opt_only_parse
: OptionBool = new OptionBool("Only proceed to parse step of loaders", "--only-parse")
143 readable var _opt_help
: OptionBool = new OptionBool("Show Help (This screen)", "-h", "-?", "--help")
146 readable var _opt_version
: OptionBool = new OptionBool("Show version and exit", "--version")
149 readable var _opt_verbose
: OptionCount = new OptionCount("Verbose", "-v", "--verbose")
152 readable var _verbose_level
: Int = 0
157 option_context
.add_option
(opt_warn
, opt_path
, opt_log
, opt_log_dir
, opt_only_parse
, opt_only_metamodel
, opt_help
, opt_version
, opt_verbose
)
160 # Parse and process the options given on the command line
164 option_context
.parse
(args
)
167 _verbose_level
= opt_verbose
.value
169 # Setup the paths value
170 paths
.append
(opt_path
.value
)
172 var path_env
= once
("NIT_PATH".to_symbol
).environ
173 if not path_env
.is_empty
then
174 paths
.append
(path_env
.split_with
(':'))
177 path_env
= once
("NIT_DIR".to_symbol
).environ
178 if not path_env
.is_empty
then
179 var libname
= "{path_env}/lib"
180 if libname
.file_exists
then paths
.add
(libname
)
183 var libname
= "{sys.program_name.dirname}/../lib"
184 if libname
.file_exists
then paths
.add
(libname
)
186 if opt_log_dir
.value
!= null then _log_directory
= opt_log_dir
.value
.as(not null)
187 if _opt_log
.value
then
188 # Make sure the output directory exists
193 # Load and process a module in a directory (or a parent directory).
194 # If the module is already loaded, just return it without further processing.
195 # If no module is found, just return null without complaining.
196 private fun try_to_load
(module_name
: Symbol, dir
: MMDirectory): nullable MMModule
198 # Look in the module directory
199 for m
in dir
.modules
do
200 if m
.name
== module_name
then return m
203 # print "try to load {module_name} in {dir.name} {_loaders.length}"
206 var dir2
= l
.try_to_load_dir
(module_name
, dir
)
208 var m
= try_to_load
(module_name
, dir2
)
216 if l
.can_handle
(module_name
, dir
) then
217 var full_name
= dir
.full_name_for
(module_name
)
218 if _processing_modules
.has
(full_name
) then
219 # FIXME: Generate better error
220 fatal_error
(null, "Error: Dependency loop for module {full_name}")
222 _processing_modules
.add
(full_name
)
223 var m
= l
.load_and_process_module
(self, module_name
, dir
)
224 _processing_modules
.remove
(full_name
)
225 #if m != null then print "loaded {m.name} in {m.directory.name} -> {m.full_name} ({m.full_name.object_id.to_hex})"
233 # List of module currently processed.
234 # Used to prevent dependence loops.
235 var _processing_modules
: HashSet[Symbol] = new HashSet[Symbol]
237 # Locate, load and analysis a module (and its supermodules) from its file name.
238 # If the module is already loaded, just return it without further processing.
239 # Beware, the files are automatically considered root of their directory.
240 fun get_module_from_filename
(filename
: String): MMModule
242 var path
= filename
.dirname
243 var module_name
= filename
.basename
(".nit").to_symbol
245 var dir
= directory_for
(path
)
247 if module_name
.to_s
== filename
then
248 # It's just a modulename
249 # look for it in the path directory "."
250 var m
= try_to_load
(module_name
, dir
)
251 if m
!= null then return m
253 # Else look for it in the path
254 return get_module
(module_name
, null)
257 if not filename
.file_exists
then
258 fatal_error
(null, "Error: File {filename} not found.")
262 # Try to load the module where mentionned
263 var m
= try_to_load
(module_name
, dir
)
264 if m
!= null then return m
266 fatal_error
(null, "Error: {filename} is not a NIT source module.")
270 # Locate, load and analysis a module (and its supermodules).
271 # If the module is already loaded, just return it without further processing.
272 fun get_module
(module_name
: Symbol, from
: nullable MMModule): MMModule
275 var dir
: nullable MMDirectory = from
.directory
277 var m
= try_to_load
(module_name
, dir
)
278 if m
!= null then return m
284 var m
= try_to_load
(module_name
, directory_for
(p
))
285 if m
!= null then return m
287 # FIXME: Generate better error
288 fatal_error
(null, "Error: No ressource found for module {module_name}.")
292 # Return the module directory associated with a given path
293 private fun directory_for
(path
: String): MMDirectory
295 if _path_dirs
.has_key
(path
) then return _path_dirs
[path
]
296 var dir
= new MMDirectory(path
.to_symbol
, path
, null)
297 _path_dirs
[path
] = dir
301 # Association bwtween plain path and module directories
302 var _path_dirs
: Map[String, MMDirectory] = new HashMap[String, MMDirectory]
304 # Register a new module loader
305 fun register_loader
(ml
: ModuleLoader) do _loaders
.add
(ml
)
308 # A load handler know how to load a specific module type
310 # Type of module loaded by the loader
311 type MODULE: MMModule
313 # Extension that the loadhandler accepts
314 fun file_type
: String is abstract
316 # Try to load a new module directory
317 fun try_to_load_dir
(dirname
: Symbol, parent_dir
: MMDirectory): nullable MMDirectory
319 var fname
= "{parent_dir.path}/{dirname}/"
320 if not fname
.file_exists
then return null
322 var dir
= new MMDirectory(parent_dir
.full_name_for
(dirname
), fname
, parent_dir
)
326 # Can the loadhandler load a given module?
327 # Return the file found
328 fun can_handle
(module_name
: Symbol, dir
: MMDirectory): Bool
330 var fname
= "{dir.path}/{module_name}.{file_type}"
331 if fname
.file_exists
then return true
335 # Load the module and process it
336 # filename is the result of can_handle
337 fun load_and_process_module
(context
: ToolContext, module_name
: Symbol, dir
: MMDirectory): MODULE
339 var filename
= "{dir.path}/{module_name}.{file_type}"
340 var m
= load_module
(context
, module_name
, dir
, filename
)
341 if not context
.opt_only_parse
.value
then process_metamodel
(context
, m
)
345 # Load an parse the module
346 private fun load_module
(context
: ToolContext, module_name
: Symbol, dir
: MMDirectory, filename
: String): MODULE
349 if filename
== "-" then
352 file
= new IFStream.open
(filename
.to_s
)
356 context
.fatal_error
(null, "Error: Problem in opening file {filename}")
358 var m
= parse_file
(context
, file
, filename
, module_name
, dir
)
359 if file
!= stdin
then file
.close
363 # Parse the file to load a module
364 protected fun parse_file
(context
: ToolContext, file
: IFStream, filename
: String, module_name
: Symbol, dir
: MMDirectory): MODULE is abstract
366 # Process a parsed module
367 protected fun process_metamodel
(context
: ToolContext, mod
: MODULE) is abstract
371 # Recurcivelty process an import modules
372 fun import_supers_modules
(names
: Collection[Symbol])
375 assert c
isa ToolContext
376 var supers
= new Array[MMModule]
378 var m
= c
.get_module
(n
, self)
381 c
.add_module
(self,supers
)