1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2006-2008 Floréal Morandat <morandat@lirmm.fr>
4 # Copyright 2008-2012 Jean Privat <jean@pryen.org>
5 # Copyright 2009 Jean-Sebastien Gelinas <calestar@gmail.com>
6 # Copyright 2014 Alexandre Terrasa <alexandre@moz-code.org>
8 # Licensed under the Apache License, Version 2.0 (the "License");
9 # you may not use this file except in compliance with the License.
10 # You may obtain a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 # See the License for the specific language governing permissions and
18 # limitations under the License.
20 # Common command-line tool infractructure than handle options and error messages
30 redef type OTHER: Message
32 var location
: nullable Location
35 # Comparisons are made on message locations.
36 redef fun <(other
: OTHER): Bool do
37 if location
== null then return true
38 if other
.location
== null then return false
40 return location
.as(not null) < other
.location
.as(not null)
43 redef fun to_s
: String
53 fun to_color_string
: String
56 var red
= "{esc}[0;31m"
57 var bred
= "{esc}[1;31m"
58 var green
= "{esc}[0;32m"
59 var yellow
= "{esc}[0;33m"
65 else if l
.file
== null then
66 return "{yellow}{l}{def}: {text}"
68 return "{yellow}{l}{def}: {text}\n{l.colored_line("1;31")}"
73 # Global context for tools
76 var error_count
: Int = 0
79 var warning_count
: Int = 0
81 # Directory where to generate log files
82 var log_directory
: String = "logs"
85 private var messages
: Array[Message] = new Array[Message]
86 private var message_sorter
: ComparableSorter[Message] = new ComparableSorter[Message]
90 if messages
.length
> 0 then
91 message_sorter
.sort
(messages
)
94 if opt_no_color
.value
then
95 sys
.stderr
.write
("{m}\n")
97 sys
.stderr
.write
("{m.to_color_string}\n")
104 if error_count
> 0 then exit
(1)
108 fun error
(l
: nullable Location, s
: String)
110 messages
.add
(new Message(l
,s
))
111 error_count
= error_count
+ 1
112 if opt_stop_on_first_error
.value
then check_errors
115 # Add an error, show errors and quit
116 fun fatal_error
(l
: nullable Location, s
: String)
123 fun warning
(l
: nullable Location, s
: String)
125 if opt_warn
.value
== 0 then return
126 messages
.add
(new Message(l
,s
))
127 warning_count
= warning_count
+ 1
128 if opt_stop_on_first_error
.value
then check_errors
132 fun info
(s
: String, level
: Int)
134 if level
<= verbose_level
then
139 # Executes a program while checking if it's available and if the execution ended correctly
141 # Stops execution and prints errors if the program isn't available or didn't end correctly
142 fun exec_and_check
(args
: Array[String], error
: String)
144 var prog
= args
.first
147 # Is the wanted program available?
148 var proc_which
= new IProcess.from_a
("which", [prog
])
150 var res
= proc_which
.status
152 print
"{error}: executable \"{prog}\
" not found"
156 # Execute the wanted program
157 var proc
= new Process.from_a
(prog
, args
)
161 print
"{error}: execution of \"{prog} {args.join(" ")}\
" failed"
166 # Global OptionContext
167 var option_context
: OptionContext = new OptionContext
170 var opt_warn
: OptionCount = new OptionCount("Show warnings", "-W", "--warn")
173 var opt_quiet
: OptionBool = new OptionBool("Do not show warnings", "-q", "--quiet")
176 var opt_log
: OptionBool = new OptionBool("Generate various log files", "--log")
179 var opt_log_dir
: OptionString = new OptionString("Directory where to generate log files", "--log-dir")
182 var opt_help
: OptionBool = new OptionBool("Show Help (This screen)", "-h", "-?", "--help")
185 var opt_version
: OptionBool = new OptionBool("Show version and exit", "--version")
187 # Option --set-dummy-tool
188 var opt_set_dummy_tool
: OptionBool = new OptionBool("Set toolname and version to DUMMY. Useful for testing", "--set-dummy-tool")
191 var opt_verbose
: OptionCount = new OptionCount("Verbose", "-v", "--verbose")
193 # Option --stop-on-first-error
194 var opt_stop_on_first_error
: OptionBool = new OptionBool("Stop on first error", "--stop-on-first-error")
197 var opt_no_color
: OptionBool = new OptionBool("Do not use color to display errors and warnings", "--no-color")
199 # Option --bash-completion
200 var opt_bash_completion
: OptionBool = new OptionBool("Generate bash_completion file for this program", "--bash-completion")
203 var verbose_level
: Int = 0
205 # Bash completion behavior in command line
206 # see `BashCompletion`
207 var bash_completion
: BashCompletion
211 bash_completion
= new BashCompletion(self)
212 option_context
.add_option
(opt_warn
, opt_quiet
, opt_stop_on_first_error
, opt_no_color
, opt_log
, opt_log_dir
, opt_help
, opt_version
, opt_set_dummy_tool
, opt_verbose
, opt_bash_completion
)
215 # Name, usage and synopsis of the tool.
216 # It is mainly used in `usage`.
217 # Should be correctly set by the client before calling `process_options`
218 # A multi-line string is recommmended.
220 # eg. `"Usage: tool [OPTION]... [FILE]...\nDo some things."`
221 var tooldescription
: String writable = "Usage: [OPTION]... [ARG]..."
223 # Does `process_options` should accept an empty sequence of arguments.
224 # ie. nothing except options.
225 # Is `false` by default.
227 # If required, if should be set by the client before calling `process_options`
228 var accept_no_arguments
writable = false
230 # print the full usage of the tool.
231 # Is called by `process_option` on `--help`.
232 # It also could be called by the client.
235 print tooldescription
239 # Parse and process the options given on the command line
240 fun process_options
(args
: Sequence[String])
242 self.opt_warn
.value
= 1
245 option_context
.parse
(args
)
247 if opt_help
.value
then
252 if opt_version
.value
then
257 if opt_bash_completion
.value
then
258 print bash_completion
.write_to_string
259 bash_completion
.write_to_file
("{sys.program_name}.bash")
263 var errors
= option_context
.get_errors
264 if not errors
.is_empty
then
265 for e
in errors
do print
"Error: {e}"
266 print tooldescription
267 print
"Use --help for help"
271 if option_context
.rest
.is_empty
and not accept_no_arguments
then
272 print tooldescription
273 print
"Use --help for help"
278 verbose_level
= opt_verbose
.value
280 if self.opt_quiet
.value
then self.opt_warn
.value
= 0
282 if opt_log_dir
.value
!= null then log_directory
= opt_log_dir
.value
.as(not null)
283 if opt_log
.value
then
284 # Make sure the output directory exists
288 nit_dir
= compute_nit_dir
291 # Get the current `nit_version` or "DUMMY_VERSION" if `--set-dummy-tool` is set.
292 fun version
: String do
293 if opt_set_dummy_tool
.value
then
294 return "DUMMY_VERSION"
299 # Get the name of the tool or "DUMMY_TOOL" id `--set-dummy-tool` is set.
300 fun toolname
: String do
301 if opt_set_dummy_tool
.value
then
304 return sys
.program_name
.basename
("")
307 # The identified root directory of the Nit project
308 var nit_dir
: nullable String
310 private fun compute_nit_dir
: nullable String
312 # a environ variable has precedence
313 var res
= "NIT_DIR".environ
314 if not res
.is_empty
then return res
316 # find the runpath of the program from argv[0]
317 res
= "{sys.program_name.dirname}/.."
318 if res
.file_exists
and "{res}/src/nit.nit".file_exists
then return res
.simplify_path
320 # find the runpath of the process from /proc
321 var exe
= "/proc/self/exe"
322 if exe
.file_exists
then
324 res
= res
.dirname
.join_path
("..")
325 if res
.file_exists
and "{res}/src/nit.nit".file_exists
then return res
.simplify_path
332 # This class generates a compatible `bash_completion` script file.
334 # On some Linux systems `bash_completion` allow the program to control command line behaviour.
337 # file1.nit file2.nit file3.nit
339 # $ nitls --[TAB][TAB]
340 # --bash-toolname --keep --path --tree
341 # --depends --log --project --verbose
342 # --disable-phase --log-dir --quiet --version
343 # --gen-bash-completion --no-color --recursive --warn
344 # --help --only-metamodel --source
345 # --ignore-visibility --only-parse --stop-on-first-error
347 # Generated file must be placed in system bash_completion directory `/etc/bash_completion.d/`
348 # or in the user directory `~/.bash_completion`.
352 var toolcontext
: ToolContext
354 init(toolcontext
: ToolContext) do
355 self.toolcontext
= toolcontext
358 private fun extract_options_names
: Array[String] do
359 var names
= new Array[String]
360 for option
in toolcontext
.option_context
.options
do
361 for name
in option
.names
do
362 if name
.has_prefix
("--") then names
.add name
368 redef fun rendering
do
369 var name
= toolcontext
.toolname
370 var option_names
= extract_options_names
371 addn
"# generated bash completion file for {name} {toolcontext.version}"
374 addn
" local cur prev opts"
376 addn
" cur=\"$\
{COMP_WORDS[COMP_CWORD]\}\
""
377 addn
" prev=\"$\
{COMP_WORDS[COMP_CWORD-1]\}\
""
378 if option_names
!= null then
379 addn
" opts=\"{option_names.join(" ")}\
""
380 addn
" if [[ $\{cur\} == -* ]] ; then"
381 addn
" COMPREPLY=( $(compgen -W \"$\
{opts\}\
" -- $\{cur\}) )"
387 addn
"complete -F _{name} {name}"