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 package is used to load a metamodel
26 # Global context for tools
30 readable var _error_count
: Int = 0
33 readable var _warning_count
: Int = 0
37 if error_count
> 0 then exit
(1)
44 _error_count
= _error_count
+ 1
48 fun warning
(s
: String)
50 if _opt_warn
.value
== 0 then return
52 if _opt_warn
.value
== 1 then
53 _warning_count
= _warning_count
+ 1
55 _error_count
= _error_count
+ 1
60 meth info
(s
: String, level
: Int)
62 if level
<= verbose_level
then
67 # Paths where to locate modules files
68 readable var _paths
: Array[String] = new Array[String]
70 # List of module loaders
71 var _loaders
: Array[ModuleLoader] = new Array[ModuleLoader]
73 # Global OptionContext
74 readable var _option_context
: OptionContext = new OptionContext
77 readable var _opt_warn
: OptionCount = new OptionCount("Show warnings", "-W", "--warn")
80 readable var _opt_path
: OptionArray = new OptionArray("Set include path for loaders (may be used more than once)", "-I", "--path")
83 readable var _opt_log
: OptionBool = new OptionBool("Generate various log files", "--log")
85 # Option --only-metamodel
86 readable var _opt_only_metamodel
: OptionBool = new OptionBool("Stop after meta-model processing", "--only-metamodel")
89 readable var _opt_only_parse
: OptionBool = new OptionBool("Only proceed to parse step of loaders", "--only-parse")
92 readable var _opt_help
: OptionBool = new OptionBool("Show Help (This screen)", "-h", "-?", "--help")
95 readable var _opt_version
: OptionBool = new OptionBool("Show version and exit", "--version")
98 readable var _opt_verbose
: OptionCount = new OptionCount("Verbose", "-v", "--verbose")
101 readable var _verbose_level
: Int = 0
106 option_context
.add_option
(opt_warn
, opt_path
, opt_log
, opt_only_parse
, opt_only_metamodel
, opt_help
, opt_version
, opt_verbose
)
109 # Parse and process the options given on the command line
113 option_context
.parse
(args
)
116 _verbose_level
= opt_verbose
.value
118 # Setup the paths value
119 paths
.append
(opt_path
.value
)
121 var path_env
= once
("NIT_PATH".to_symbol
).environ
122 if not path_env
.is_empty
then
123 paths
.append
(path_env
.split_with
(':'))
126 path_env
= once
("NIT_DIR".to_symbol
).environ
127 if not path_env
.is_empty
then
128 var libname
= "{path_env}/lib"
129 if libname
.file_exists
then paths
.add
(libname
)
132 var libname
= "{sys.program_name.dirname}/../lib"
133 if libname
.file_exists
then paths
.add
(libname
)
136 # Load and process a module in a directory (or a parent directory).
137 # If the module is already loaded, just return it without further processing.
138 # If no module is found, just return null without complaining.
139 private fun try_to_load
(module_name
: Symbol, dir
: MMDirectory): nullable MMModule
141 # Look in the module directory
142 for m
in dir
.modules
do
143 if m
.name
== module_name
then return m
146 # print "try to load {module_name} in {dir.name} {_loaders.length}"
149 var dir2
= l
.try_to_load_dir
(module_name
, dir
)
151 var m
= try_to_load
(module_name
, dir2
)
159 if l
.can_handle
(module_name
, dir
) then
160 var full_name
= dir
.full_name_for
(module_name
)
161 if _processing_modules
.has
(full_name
) then
162 # FIXME: Generate better error
163 error
("Error: Dependency loop for module {full_name}")
166 _processing_modules
.add
(full_name
)
167 var m
= l
.load_and_process_module
(self, module_name
, dir
)
168 _processing_modules
.remove
(full_name
)
169 #if m != null then print "loaded {m.name} in {m.directory.name} -> {m.full_name} ({m.full_name.object_id.to_hex})"
177 # List of module currently processed.
178 # Used to prevent dependence loops.
179 var _processing_modules
: HashSet[Symbol] = new HashSet[Symbol]
181 # Locate, load and analysis a module (and its supermodules) from its file name.
182 # If the module is already loaded, just return it without further processing.
183 # Beware, the files are automatically considered root of their directory.
184 fun get_module_from_filename
(filename
: String): MMModule
186 var path
= filename
.dirname
187 var module_name
= filename
.basename
(".nit").to_symbol
189 var dir
= directory_for
(path
)
191 if module_name
.to_s
== filename
then
192 # It's just a modulename
193 # look for it in the path directory "."
194 var m
= try_to_load
(module_name
, dir
)
195 if m
!= null then return m
197 # Else look for it in the path
198 return get_module
(module_name
, null)
201 if not filename
.file_exists
then
202 error
("Error: File {filename} not found.")
207 # Try to load the module where mentionned
208 var m
= try_to_load
(module_name
, dir
)
209 if m
!= null then return m
211 error
("Error: {filename} is not a NIT source module.")
216 # Locate, load and analysis a module (and its supermodules).
217 # If the module is already loaded, just return it without further processing.
218 fun get_module
(module_name
: Symbol, from
: nullable MMModule): MMModule
222 var dir
: nullable MMDirectory = from
.directory
224 var m
= try_to_load
(module_name
, dir
)
225 if m
!= null then return m
231 var m
= try_to_load
(module_name
, directory_for
(p
))
232 if m
!= null then return m
234 # FIXME: Generate better error
235 error
("Error: No ressource found for module {module_name}.")
240 # Return the module directory associated with a given path
241 private fun directory_for
(path
: String): MMDirectory
243 if _path_dirs
.has_key
(path
) then return _path_dirs
[path
]
244 var dir
= new MMDirectory(path
.to_symbol
, path
, null)
245 _path_dirs
[path
] = dir
249 # Association bwtween plain path and module directories
250 var _path_dirs
: Map[String, MMDirectory] = new HashMap[String, MMDirectory]
252 # Register a new module loader
253 fun register_loader
(ml
: ModuleLoader) do _loaders
.add
(ml
)
256 # A load handler know how to load a specific module type
258 # Type of module loaded by the loader
259 type MODULE: MMModule
261 # Extension that the loadhandler accepts
262 fun file_type
: String is abstract
264 # Try to load a new module directory
265 fun try_to_load_dir
(dirname
: Symbol, parent_dir
: MMDirectory): nullable MMDirectory
267 var fname
= "{parent_dir.path}/{dirname}/"
268 if not fname
.file_exists
then return null
270 var dir
= new MMDirectory(parent_dir
.full_name_for
(dirname
), fname
, parent_dir
)
274 # Can the loadhandler load a given module?
275 # Return the file found
276 fun can_handle
(module_name
: Symbol, dir
: MMDirectory): Bool
278 var fname
= "{dir.path}/{module_name}.{file_type}"
279 if fname
.file_exists
then return true
283 # Load the module and process it
284 # filename is the result of can_handle
285 fun load_and_process_module
(context
: ToolContext, module_name
: Symbol, dir
: MMDirectory): MODULE
287 var filename
= "{dir.path}/{module_name}.{file_type}"
288 var m
= load_module
(context
, module_name
, dir
, filename
)
289 if not context
.opt_only_parse
.value
then process_metamodel
(context
, m
)
293 # Load an parse the module
294 private fun load_module
(context
: ToolContext, module_name
: Symbol, dir
: MMDirectory, filename
: String): MODULE
297 if filename
== "-" then
300 file
= new IFStream.open
(filename
.to_s
)
304 context
.error
("Error: Problem in opening file {filename}")
307 var m
= parse_file
(context
, file
, filename
, module_name
, dir
)
308 if file
!= stdin
then file
.close
312 # Parse the file to load a module
313 protected fun parse_file
(context
: ToolContext, file
: IFStream, filename
: String, module_name
: Symbol, dir
: MMDirectory): MODULE is abstract
315 # Process a parsed module
316 protected fun process_metamodel
(context
: ToolContext, module: MODULE) is abstract
320 # Recurcivelty process an import modules
321 fun import_supers_modules
(names
: Collection[Symbol])
324 assert c
isa ToolContext
325 var supers
= new Array[MMModule]
327 var m
= c
.get_module
(n
, self)
330 c
.add_module
(self,supers
)