-% NIT(1)
-
# NAME
nit - interprets and debugs Nit programs.
## COMMAND
-`-e`
-: Specifies the program from command-line.
+### `-e`
+Specifies the program from command-line.
- The `-e` option runs a program written on the command line.
- Like with ruby, perl, bash and other script language.
+The `-e` option runs a program written on the command line.
+Like with ruby, perl, bash and other script language.
- $ nit -e 'print 5+5'
- 10
+ $ nit -e 'print 5+5'
+ 10
-`-n`
-: Repeatedly run the program for each line in file-name arguments.
+### `-n`
+Repeatedly run the program for each line in file-name arguments.
- If no arguments are given, then `nit` iterates over the lines of the standard input (stdin).
+If no arguments are given, then `nit` iterates over the lines of the standard input (stdin).
- $ echo "hello world" | nit -n -e 'print sys.line.capitalized'
- Hello World
+ $ echo "hello world" | nit -n -e 'print sys.line.capitalized'
+ Hello World
- If some arguments are given, then `nit` considers that each argument is a filepath then it iterates on their lines.
+If some arguments are given, then `nit` considers that each argument is a filepath then it iterates on their lines.
## INTERPRETATION OPTIONS
-`--discover-call-trace`
-: Trace calls of the first invocation of methods.
+### `--discover-call-trace`
+Trace calls of the first invocation of methods.
- Each time a method is invoked for the first time, its information is printed on the standard output for error (`stderr`).
+Each time a method is invoked for the first time, its information is printed on the standard output for error (`stderr`).
- This option helps the user to have a simplified but humanly readable overview of the behavior of a particular program execution.
+This option helps the user to have a simplified but humanly readable overview of the behavior of a particular program execution.
## DEBUGGER OPTIONS
-`-d`
-: Launches the target program with the debugger attached to it
+### `-d`
+Launches the target program with the debugger attached to it
-`-c`
-: Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned
+### `-c`
+Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned
-`--socket`
-: Launches the target program with raw output on the network via sockets
+### `--socket`
+Launches the target program with raw output on the network via sockets
-`--websocket`
-: Launches the target program with output on the network via websockets
+### `--websocket`
+Launches the target program with output on the network via websockets
-`--port`
-: Sets the debug port (Defaults to 22125) - Must be contained between 0 and 65535
+### `--port`
+Sets the debug port (Defaults to 22125) - Must be contained between 0 and 65535
## OTHER OPTIONS
-`--vm`
-: Run the virtual machine instead of the naive interpreter (experimental)
+### `--vm`
+Run the virtual machine instead of the naive interpreter (experimental)
The virtual machine is currently under heavy development and, unless you are developing the vm, there is no reason to use this option yet.
-`-o`
-: Does nothing. Used for compatibility.
+### `-o`
+Does nothing. Used for compatibility.
# DEBUGGER
## DEBUGGER COMMANDS
-`n`
-: Proceeds to the next instruction (step-over)
+### `n`
+Proceeds to the next instruction (step-over)
-`s`
-: Steps in an instruction
+### `s`
+Steps in an instruction
-`finish`
-: Steps out of an instruction
+### `finish`
+Steps out of an instruction
-`c`
-: Continues the execution until a breakpoint is encountered or until an error/end of program
+### `c`
+Continues the execution until a breakpoint is encountered or until an error/end of program
-`b/break line_number`
-: Adds a breakpoint on line *line_number* for the current file
+### `b/break line_number`
+Adds a breakpoint on line *line_number* for the current file
-`b/break file line_number`
-: Adds a breakpoint on line *line_number* for the file *file* (Don't forget to add the .nit extension to the command)
+### `b/break file line_number`
+Adds a breakpoint on line *line_number* for the file *file* (Don't forget to add the .nit extension to the command)
-`d/delete line_number`
-: Removes a breakpoint on line *line_number* for the current file
+### `d/delete line_number`
+Removes a breakpoint on line *line_number* for the current file
-`d/delete file line_number`
-: Removes a breakpoint on line *line_number* for the file *file*
+### `d/delete file line_number`
+Removes a breakpoint on line *line_number* for the file *file*
-`kill`
-: Kills the current program (produces a stack trace)
+### `kill`
+Kills the current program (produces a stack trace)
-`variable = value`
-: Sets the value of *variable* to *value* (Only supports primitive types for now : Bool, Char, Int, Float)
+### `variable = value`
+Sets the value of *variable* to *value* (Only supports primitive types for now : Bool, Char, Int, Float)
-`p/print variable_name`
-: Prints the value of the variable *variable_name*
+### `p/print variable_name`
+Prints the value of the variable *variable_name*
-`p/print stack`
-: Prints a stack trace starting with the current frame
+### `p/print stack`
+Prints a stack trace starting with the current frame
-`p/print variable_name[index]`
-: Prints the value of the variable contained at the index *index* of variable *variable_name* (*variable_name* must be a subtype of SequenceRead)
+### `p/print variable_name[index]`
+Prints the value of the variable contained at the index *index* of variable *variable_name* (*variable_name* must be a subtype of SequenceRead)
-`p/print variable_name[index_from..index_to]`
-: Prints the values of all the variables contained from index *index_from* up to *index_to* in the variable *variable_name*
+### `p/print variable_name[index_from..index_to]`
+Prints the values of all the variables contained from index *index_from* up to *index_to* in the variable *variable_name*
All the print commands also work on any dimension SequenceRead collection.
-`variable_name as alias`
-: Sets an alias *alias* for the variable *variable_name*
+### `variable_name as alias`
+Sets an alias *alias* for the variable *variable_name*
-`trace variable_name [break/print]`
-: Traces the uses of the variable you chose to trace by printing the statement it appears in or by breaking on each use. (The [break/print] part is not mandatory, by default, the print option will be used)
+### `trace variable_name [break/print]`
+Traces the uses of the variable you chose to trace by printing the statement it appears in or by breaking on each use. (The [break/print] part is not mandatory, by default, the print option will be used)
-`untrace variable_name`
-: Removes the trace on the variable you chose to trace earlier in the program
+### `untrace variable_name`
+Removes the trace on the variable you chose to trace earlier in the program
# SEE ALSO
-% NITC(1)
-
# NAME
nitc - compiles Nit programs.
## MESSAGES
-`-W`, `--warn`
-: Show additional warnings (advices).
+### `-W`, `--warn`
+
+Show additional warnings (advices).
+
+By default, only important warnings are displayed.
+May be overridden by `-w`.
- By default, only important warnings are displayed.
- May be overridden by `-w`.
+Important warnings are displayed by default. A warning is considered important when:
- Important warnings are displayed by default. A warning is considered important when:
+* There is a simple correction.
+* There is no reason to let the code this way.
+* There is always a real issue (no false positive).
- * There is a simple correction.
- * There is no reason to let the code this way.
- * There is always a real issue (no false positive).
+Other warnings, called advices, are not displayed by default to avoid filling the terminal with
+unwanted information.
+A warning is considered an advice when:
- Other warnings, called advices, are not displayed by default to avoid filling the terminal with
- unwanted information.
- A warning is considered an advice when:
+* The correction could be complex. e.g. require a refactorisation or an API change.
+* The correction cannot be done. e.g. Code that use a deprecated API for some compatibility reason.
+* There is not a real issue (false positive). Note that this should be unlikely.
+* Transitional: While a real important warning, it fires a lot in current code, so a transition is needed
+in order to let people fix them before promoting the advice to an important warning.
- * The correction could be complex. e.g. require a refactorisation or an API change.
- * The correction cannot be done. e.g. Code that use a deprecated API for some compatibility reason.
- * There is not a real issue (false positive). Note that this should be unlikely.
- * Transitional: While a real important warning, it fires a lot in current code, so a transition is needed
- in order to let people fix them before promoting the advice to an important warning.
+### `-w`, `--warning`
-`-w`, `--warning`
-: Show/hide a specific warning.
+Show/hide a specific warning.
- Each type of warning can be individually displayed or hidden.
- The `-w` option takes the name of a warning (displayed at the end of the warning message, between parentheses) to activate it;
- and "no-{name}" to disable it.
- It has precedence over -q and -W.
- Multiple `-w` can be given.
+Each type of warning can be individually displayed or hidden.
+The `-w` option takes the name of a warning (displayed at the end of the warning message, between parentheses) to activate it;
+and "no-{name}" to disable it.
+It has precedence over -q and -W.
+Multiple `-w` can be given.
- To show only `missing-doc` warnings in standard"
+To show only `missing-doc` warnings in standard"
- $ nitc -q -w missing-doc standard
+ $ nitc -q -w missing-doc standard
- To show all warnings and advices, except `missing-doc`:
+To show all warnings and advices, except `missing-doc`:
- $ nitc -W -w no-missing-doc standard
+ $ nitc -W -w no-missing-doc standard
- To show important warnings except `useless-type-test`, but not advice except `missing-doc`:
+To show important warnings except `useless-type-test`, but not advice except `missing-doc`:
- $ nitc -w missing-doc -w no-useless-type-test standard
+ $ nitc -w missing-doc -w no-useless-type-test standard
-`-q`, `--quiet`
-: Do not show warnings.
- May be overridden by `-w`
+### `-q`, `--quiet`
+Do not show warnings.
+May be overridden by `-w`
-`--stop-on-first-error`
-: Just display the first encountered error then stop.
+### `--stop-on-first-error`
+Just display the first encountered error then stop.
- By default, nitc tries to detect and display more than one error before aborting the compilation.
+By default, nitc tries to detect and display more than one error before aborting the compilation.
-`--no-color`
-: Do not use color to display errors and warnings.
+### `--no-color`
+Do not use color to display errors and warnings.
- Also, do not echo the line.
- This options is mainly used by scripts and tools that need parsable error messages.
+Also, do not echo the line.
+This options is mainly used by scripts and tools that need parsable error messages.
-`-v`, `--verbose`
-: Additional messages from the tool.
- Multiple `-v` can be given to improve the verbosity.
+### `-v`, `--verbose`
+Additional messages from the tool.
+Multiple `-v` can be given to improve the verbosity.
- With one `-v`, there is constant number of lines.
- With two `-v`, the number of lines is proportional to the number of modules.
- With three `-v`, the number of lines is proportional to the number of definition of classes.
- With four `-v`, the number of lines is proportional to the number of definition of properties.
+With one `-v`, there is constant number of lines.
+With two `-v`, the number of lines is proportional to the number of modules.
+With three `-v`, the number of lines is proportional to the number of definition of classes.
+With four `-v`, the number of lines is proportional to the number of definition of properties.
-`--log`
-: Generate various log files.
+### `--log`
+Generate various log files.
- The tool will generate some files in the logging directory (see `--log-dir`).
- These files are intended to the advanced user and the developers of the tools.
+The tool will generate some files in the logging directory (see `--log-dir`).
+These files are intended to the advanced user and the developers of the tools.
-`--log-dir`
-: Directory where to generate log files.
+### `--log-dir`
+Directory where to generate log files.
- By default the directory is called `logs` in the working directory.
+By default the directory is called `logs` in the working directory.
-`-h`, `-?`, `--help`
-: Show Help (the list of options).
+### `-h`, `-?`, `--help`
+Show Help (the list of options).
-`--version`
-: Show version and exit.
+### `--version`
+Show version and exit.
## PATHS
-`-I`, `--path`
-: Add an additional include path.
+### `-I`, `--path`
+Add an additional include path.
- This option is used to indicate an additional path of a directory containing Nit libraries.
+This option is used to indicate an additional path of a directory containing Nit libraries.
- The path added with `-I` are searched before those added by the environment variable `NIT_PATH`.
+The path added with `-I` are searched before those added by the environment variable `NIT_PATH`.
- May be used more than once.
+May be used more than once.
-`-o`, `--output`
-: Output executable name.
+### `-o`, `--output`
+Output executable name.
- Indicates the path and name of the produced executable.
+Indicates the path and name of the produced executable.
- Note: it is better to use `--dir` if only the directory is important.
- This way, the platform extension will be correctly set.
+Note: it is better to use `--dir` if only the directory is important.
+This way, the platform extension will be correctly set.
- `-o` is not usable if multiple programs are compiled at once.
+### `-o` is not usable if multiple programs are compiled at once.
-`--dir`
-: Output directory.
+### `--dir`
+Output directory.
- Produce the executables in the given directory instead of the current directory.
+Produce the executables in the given directory instead of the current directory.
-`--nit-dir`
-: Base directory of the Nit installation.
+### `--nit-dir`
+Base directory of the Nit installation.
- Has precedence over the environment variable `NIT_DIR`.
+Has precedence over the environment variable `NIT_DIR`.
## COMPILATION
-`--compile-dir`
-: Directory used to generate temporary files.
+### `--compile-dir`
+Directory used to generate temporary files.
- By default, it is named `nit_compile` and created in the current directory and destroyed after the compilation.
+By default, it is named `nit_compile` and created in the current directory and destroyed after the compilation.
- If the option `--compile_dir` or `--no-cc` is used, then the directory is not destroyed and let as is.
+If the option `--compile_dir` or `--no-cc` is used, then the directory is not destroyed and let as is.
-`--no-cc`
-: Do not invoke the C compiler.
+### `--no-cc`
+Do not invoke the C compiler.
- Files in the compilation directory are generated but the C compiler is not invoked.
+Files in the compilation directory are generated but the C compiler is not invoked.
- This option is mainly used to produce C files distributable then compilable on system that do not have a Nit compiler (e.g. embedded system).
- In this case, it is suggested to also use the options `--dir`, `--compile-dir` and `--semi-global`.
+This option is mainly used to produce C files distributable then compilable on system that do not have a Nit compiler (e.g. embedded system).
+In this case, it is suggested to also use the options `--dir`, `--compile-dir` and `--semi-global`.
- $ nitc examples/hello_world.nit --no-cc --dir hello --compile-dir hello --semi-global
+ $ nitc examples/hello_world.nit --no-cc --dir hello --compile-dir hello --semi-global
- Will produce a `hello` directory that contains the required C files to finish the compilation.
- Only the C files required for the program are generated.
- The final binary will be generated in the same directory.
+Will produce a `hello` directory that contains the required C files to finish the compilation.
+Only the C files required for the program are generated.
+The final binary will be generated in the same directory.
- Note that, to be useful, the compilation directory is not destroyed when `--no-cc` is used.
+Note that, to be useful, the compilation directory is not destroyed when `--no-cc` is used.
-`-m`
-: Additional module to mix-in.
+### `-m`
+Additional module to mix-in.
- Additional modules are imported and refine the main module of the program.
- This has basically the same effect than implementing a specific module that imports the main module of the program then each one of the mix-in modules.
- May be used more than once.
+Additional modules are imported and refine the main module of the program.
+This has basically the same effect than implementing a specific module that imports the main module of the program then each one of the mix-in modules.
+May be used more than once.
- This is option is used to weave additional behaviors to existing programs.
- Modules designated to bring features to programs by refining basic or specialized services, without any intervention of the main program, are good candidates to be used with the `-m` option.
- E.g. `hash_debug`.
+This is option is used to weave additional behaviors to existing programs.
+Modules designated to bring features to programs by refining basic or specialized services, without any intervention of the main program, are good candidates to be used with the `-m` option.
+E.g. `hash_debug`.
- An other usage of the `-m` option is to compile program to a specific platform. E.g. `emscripten` or `android`.
+An other usage of the `-m` option is to compile program to a specific platform. E.g. `emscripten` or `android`.
- A last usage is to develop programs as product lines with a main basic module (vanilla) and specific distinct features as flavor modules, then to combine them at compile-time.
+A last usage is to develop programs as product lines with a main basic module (vanilla) and specific distinct features as flavor modules, then to combine them at compile-time.
- $ nitc prog_vanilla.nit -m feature_chocolate.nit -m feature_cherry.nit
+ $ nitc prog_vanilla.nit -m feature_chocolate.nit -m feature_cherry.nit
-`-D`, `--define`
-: Define a specific property.
+### `-D`, `--define`
+Define a specific property.
- The `-D` option allows to refine a top-level method at compile-time.
- This has basically the same effect than implementing a specific module that imports the main module of the program and refines the designated methods.
+The `-D` option allows to refine a top-level method at compile-time.
+This has basically the same effect than implementing a specific module that imports the main module of the program and refines the designated methods.
- The designated method must be top-level function with no parameters that returns a Bool, an Int or a String.
+The designated method must be top-level function with no parameters that returns a Bool, an Int or a String.
- The argument of the `-D` option is "{name}={value}".
- For Bool, the argument can also be just "{name}", in this case, the value is considered to be `true`.
+The argument of the `-D` option is "{name}={value}".
+For Bool, the argument can also be just "{name}", in this case, the value is considered to be `true`.
- $ nitc foo.nit -D prefix=/opt/foo -D port=8080 -D with_ssl
+ $ nitc foo.nit -D prefix=/opt/foo -D port=8080 -D with_ssl
-`--release`
-: Compile in release mode and finalize application.
+### `--release`
+Compile in release mode and finalize application.
- Currently, this only affect the android platform.
+Currently, this only affect the android platform.
-`-g`, `--debug`
-: Compile in debug mode.
+### `-g`, `--debug`
+Compile in debug mode.
- Currently removes gcc optimizations.
- Also preserves the source-files directory for C-debuggers.
+Currently removes gcc optimizations.
+Also preserves the source-files directory for C-debuggers.
- For more debugging-related options, see also `--hardening` and `NIT_GC_OPTION`
+For more debugging-related options, see also `--hardening` and `NIT_GC_OPTION`
## COMPILATION MODES
-`nitc` includes distinct compilation modes.
+### `nitc` includes distinct compilation modes.
-`--separate`
-: Use separate compilation (default mode).
+### `--separate`
+Use separate compilation (default mode).
- In separate compilation, modules are compiled independently of their programs.
- This makes the recompilation of programs faster since only the modified files need to be recompiled.
+In separate compilation, modules are compiled independently of their programs.
+This makes the recompilation of programs faster since only the modified files need to be recompiled.
-`--global`
-: Use global compilation.
+### `--global`
+Use global compilation.
- The produced executables may become huge and the compilation time is prohibitive.
- But sometime, they are faster.
+The produced executables may become huge and the compilation time is prohibitive.
+But sometime, they are faster.
- In practice, `--semi-global` produces nearly as fast but smaller executables.
+In practice, `--semi-global` produces nearly as fast but smaller executables.
-`--erasure`
-: Erase generic types.
+### `--erasure`
+Erase generic types.
- Like `--separate` but use an erasure dynamic typing policy for generics and virtual types.
- Usually you do not need this, even if you understand the previous sentence.
+Like `--separate` but use an erasure dynamic typing policy for generics and virtual types.
+Usually you do not need this, even if you understand the previous sentence.
## SEMI-GLOBAL OPTIMIZATIONS
Therefore, with these options, the produced executables may be faster and smaller but the recompilation time
will increase.
-`--semi-global`
-: Enable all semi-global optimizations.
+### `--semi-global`
+Enable all semi-global optimizations.
-`--rta`
-: Activate RTA (Rapid Type Analysis).
+### `--rta`
+Activate RTA (Rapid Type Analysis).
- This option only make sense in `--erasure` to enable some semi-global optimizations.
+This option only make sense in `--erasure` to enable some semi-global optimizations.
- RTA is implicitly enabled in `--separate` and `--global`.
+RTA is implicitly enabled in `--separate` and `--global`.
-`--inline-coloring-numbers`
-: Inline colors and ids (semi-global).
+### `--inline-coloring-numbers`
+Inline colors and ids (semi-global).
-`--inline-some-methods`
-: Allow the separate compiler to inline some methods (semi-global).
- Need `--rta`.
+### `--inline-some-methods`
+Allow the separate compiler to inline some methods (semi-global).
+Need `--rta`.
-`--direct-call-monomorph`
-: Allow the separate compiler to direct call monomorphic sites (semi-global).
- Need `--rta`.
+### `--direct-call-monomorph`
+Allow the separate compiler to direct call monomorphic sites (semi-global).
+Need `--rta`.
-`--skip-dead-methods`
-: Do not compile dead methods (semi-global).
- Need `--rta`.
+### `--skip-dead-methods`
+Do not compile dead methods (semi-global).
+Need `--rta`.
## LINK-BOOST OPTIMIZATIONS
Warning: these optimisations are not portable since they use extra features of the GNU linker `ld`.
However, there is very few reasons to not use them if GNU `ld` is available.
-`--link-boost`
-: Enable all link-boost optimizations.
+### `--link-boost`
+Enable all link-boost optimizations.
-`--colors-are-symbols`
-: Store colors as symbols instead of static data.
+### `--colors-are-symbols`
+Store colors as symbols instead of static data.
- By default, the various identifiers used to implement OO-mechanisms are stored as genuine constant static variables.
+By default, the various identifiers used to implement OO-mechanisms are stored as genuine constant static variables.
- This option uses linker symbols to encode these identifiers.
- This makes the compiled program faster since less indirections are required to get the values.
- It also produces executables that are a little bit smaller since static memory does not have to store the colors.
+This option uses linker symbols to encode these identifiers.
+This makes the compiled program faster since less indirections are required to get the values.
+It also produces executables that are a little bit smaller since static memory does not have to store the colors.
-`--substitute-monomorph`
-: Replace monomorphic trampolines with direct call.
+### `--substitute-monomorph`
+Replace monomorphic trampolines with direct call.
- Late-binding is implemented with *trampolines*, that are small functions that just select and jump the to right implementations.
- If, at link-time, is it known that the target will always by the same implementation then all calls to the trampoline are replaced by
- direct calls to this single implementation.
+Late-binding is implemented with *trampolines*, that are small functions that just select and jump the to right implementations.
+If, at link-time, is it known that the target will always by the same implementation then all calls to the trampoline are replaced by
+direct calls to this single implementation.
- Note that using trampolines as indirection slows down the executable.
- However, it is expected that the gain of monomorphic direct-calls overcompensates the additional indirections in polymorphic trampoline-calls.
+Note that using trampolines as indirection slows down the executable.
+However, it is expected that the gain of monomorphic direct-calls overcompensates the additional indirections in polymorphic trampoline-calls.
- Note: automatically enable option `--trampoline-call`.
+Note: automatically enable option `--trampoline-call`.
## DANGEROUS OPTIMIZATIONS
In fact, these options are mainly used to bench the compilation results.
-`--no-check-all`
-: Disable all tests (dangerous).
+### `--no-check-all`
+Disable all tests (dangerous).
-`--no-check-covariance`
-: Disable type tests of covariant parameters (dangerous).
+### `--no-check-covariance`
+Disable type tests of covariant parameters (dangerous).
-`--no-check-attr-isset`
-: Disable isset tests before each attribute access (dangerous).
+### `--no-check-attr-isset`
+Disable isset tests before each attribute access (dangerous).
-`--no-check-assert`
-: Disable the evaluation of explicit `assert` and `as` (dangerous).
+### `--no-check-assert`
+Disable the evaluation of explicit `assert` and `as` (dangerous).
-`--no-check-autocast`
-: Disable implicit casts on unsafe expression usage (dangerous).
+### `--no-check-autocast`
+Disable implicit casts on unsafe expression usage (dangerous).
-`--no-check-null`
-: Disable tests of null receiver (dangerous).
+### `--no-check-null`
+Disable tests of null receiver (dangerous).
-`--no-check-erasure-cast`
-: Disable implicit casts on unsafe return with erasure-typing policy (dangerous).
+### `--no-check-erasure-cast`
+Disable implicit casts on unsafe return with erasure-typing policy (dangerous).
## UNOPTIMIZATIONS
These options are used to debug or to bench the compilation results.
Usually you do not need them since they make the generated code slower.
-`--hardening`
-: Generate contracts in the C code against bugs in the compiler.
+### `--hardening`
+Generate contracts in the C code against bugs in the compiler.
-`--no-shortcut-range`
-: Always instantiate a range and its iterator on 'for' loops.
+### `--no-shortcut-range`
+Always instantiate a range and its iterator on 'for' loops.
-`--no-union-attribute`
-: Put primitive attributes in a box instead of an union.
+### `--no-union-attribute`
+Put primitive attributes in a box instead of an union.
-`--no-shortcut-equal`
-: Always call == in a polymorphic way.
+### `--no-shortcut-equal`
+Always call == in a polymorphic way.
-`--no-tag-primitive`
-: Use only boxes for primitive types.
+### `--no-tag-primitive`
+Use only boxes for primitive types.
The separate compiler uses tagged values to encode common primitive types like Int, Bool and Char.
This option disables tags and forces such primitive values to be boxed.
However, in some cases, it is possible that this option improves performance since the absence of tags simplify the implementation
of OO mechanisms like method calls or equality tests.
-`--no-inline-intern`
-: Do not inline call to intern methods.
+### `--no-inline-intern`
+Do not inline call to intern methods.
-`--colo-dead-methods`
-: Force colorization of dead methods.
+### `--colo-dead-methods`
+Force colorization of dead methods.
-`--no-gcc-directive`
-: Disable advanced gcc directives for optimization.
+### `--no-gcc-directive`
+Disable advanced gcc directives for optimization.
-`--trampoline-call`
-: Use an indirection when calling.
+### `--trampoline-call`
+Use an indirection when calling.
- Just add the trampolines of `--substitute-monomorph` without doing any aditionnal optimizations.
+Just add the trampolines of `--substitute-monomorph` without doing any aditionnal optimizations.
## INTERNAL OPTIONS
These options can be used to control the fine behavior of the tool.
They are useless for a normal user.
-`--disable-phase`
-: Disable a specific phase; use `list` to get the list.
+### `--disable-phase`
+Disable a specific phase; use `list` to get the list.
-`--only-parse`
-: Only proceed to parse files.
+### `--only-parse`
+Only proceed to parse files.
-`--only-metamodel`
-: Stop after meta-model processing.
+### `--only-metamodel`
+Stop after meta-model processing.
-`--ignore-visibility`
-: Do not check, and produce errors, on visibility issues.
+### `--ignore-visibility`
+Do not check, and produce errors, on visibility issues.
-`--no-main`
-: Do not generate main entry point.
+### `--no-main`
+Do not generate main entry point.
-`--no-stacktrace`
-: The compiled program will not display stack traces on runtime errors.
+### `--no-stacktrace`
+The compiled program will not display stack traces on runtime errors.
- Because stack traces rely on libunwind, this option might be useful in order to generate more portable binaries
- since libunwind might be non available on the runtime system (or available with an ABI incompatible version).
+Because stack traces rely on libunwind, this option might be useful in order to generate more portable binaries
+since libunwind might be non available on the runtime system (or available with an ABI incompatible version).
- The generated C is API-portable and can be reused, distributed and compiled on any supported system.
- If the option `--no-stacktrace` is not used but the development files of the library `libunwind` are not available, then a warning will be displayed
- and stack trace will be disabled.
+The generated C is API-portable and can be reused, distributed and compiled on any supported system.
+If the option `--no-stacktrace` is not used but the development files of the library `libunwind` are not available, then a warning will be displayed
+and stack trace will be disabled.
- Note that the `--no-stacktrace` option (or this absence) can be toggled manually in the generated Makefile (search `NO_STACKTRACE` in the Makefile).
- Moreover, the environment variable `NIT_NO_STACK` (see bellow) can also be used at runtime to disable stack traces.
+Note that the `--no-stacktrace` option (or this absence) can be toggled manually in the generated Makefile (search `NO_STACKTRACE` in the Makefile).
+Moreover, the environment variable `NIT_NO_STACK` (see bellow) can also be used at runtime to disable stack traces.
-`--max-c-lines`
-: Maximum number of lines in generated C files. Use 0 for unlimited.
+### `--max-c-lines`
+Maximum number of lines in generated C files. Use 0 for unlimited.
-`--group-c-files`
-: Group all generated code in the same series of files.
+### `--group-c-files`
+Group all generated code in the same series of files.
-`--make-flags`
-: Additional options to the `make` command.
+### `--make-flags`
+Additional options to the `make` command.
- $ nitc foo.nit --make-flags 'CC=clang' --make-flags 'CFLAGS="-O0 -g"'
+ $ nitc foo.nit --make-flags 'CC=clang' --make-flags 'CFLAGS="-O0 -g"'
-`--typing-test-metrics`
-: Enable static and dynamic count of all type tests.
+### `--typing-test-metrics`
+Enable static and dynamic count of all type tests.
-`--invocation-metrics`
-: Enable static and dynamic count of all method invocations.
+### `--invocation-metrics`
+Enable static and dynamic count of all method invocations.
-`--isset-checks-metrics`
-: Enable static and dynamic count of isset checks before attributes access.
+### `--isset-checks-metrics`
+Enable static and dynamic count of isset checks before attributes access.
-`--tables-metrics`
-: Enable static size measuring of tables used for vft, typing and resolution.
+### `--tables-metrics`
+Enable static size measuring of tables used for vft, typing and resolution.
-`--set-dummy-tool`
-: Set toolname and version to DUMMY. Useful for testing.
+### `--set-dummy-tool`
+Set toolname and version to DUMMY. Useful for testing.
-`--bash-completion`
-: Generate bash_completion file for this program.
+### `--bash-completion`
+Generate bash_completion file for this program.
-`--stub-man`
-: Generate a stub manpage in pandoc markdown format.
+### `--stub-man`
+Generate a stub manpage in pandoc markdown format.
-`--keep-going`
-: Continue after errors, whatever the consequences.
+### `--keep-going`
+Continue after errors, whatever the consequences.
The tool does not stop after some errors but continue until it produces incorrect result, crashes, erases the hard drive, or just continue forever in an infinite loop.
This option is used to test the robustness of the tools by allowing phases to progress on incorrect data.
# ENVIRONMENT VARIABLES
-`NIT_DIR`
-: Base directory of the Nit installation.
+### `NIT_DIR`
+Base directory of the Nit installation.
- When the `NIT_DIR` environment variable is set then it specifies the path of the Nit install directory.
+When the `NIT_DIR` environment variable is set then it specifies the path of the Nit install directory.
- This directory is used to locate binaries, shared files and the common libraries.
+This directory is used to locate binaries, shared files and the common libraries.
- When unset, the directory is guessed according to some heuristic.
+When unset, the directory is guessed according to some heuristic.
- The `--nit-dir` option also set the base directory of the Nit installation but has precedence.
+The `--nit-dir` option also set the base directory of the Nit installation but has precedence.
-`NIT_PATH`
-: Additional include paths.
+### `NIT_PATH`
+Additional include paths.
- The `NIT_PATH` environment variable contains paths of directories containing Nit libraries.
- Each path is separated with a column (`:`).
+The `NIT_PATH` environment variable contains paths of directories containing Nit libraries.
+Each path is separated with a column (`:`).
- The `-I` option also add additional paths.
+The `-I` option also add additional paths.
-`NIT_GC_OPTION`
-: Runtime control of the garbage collector.
+### `NIT_GC_OPTION`
+Runtime control of the garbage collector.
- The behavior of the GC of the executables produced by nitc can be tuned with this environment variable.
+The behavior of the GC of the executables produced by nitc can be tuned with this environment variable.
- The environment variable is used when programs are executed, not when they are compiled.
- Thus, you do not need to recompile programs in order to tweak their GC options.
+The environment variable is used when programs are executed, not when they are compiled.
+Thus, you do not need to recompile programs in order to tweak their GC options.
- Available values are:
+Available values are:
- * boehm: use the Boehm-Demers-Weiser's conservative garbage collector (default).
- * malloc: disable the GC and just use `malloc` without doing any `free`.
- * large: disable the GC and just allocate a large memory area to use for all instantiation.
- * help: show the list of available options.
+* boehm: use the Boehm-Demers-Weiser's conservative garbage collector (default).
+* malloc: disable the GC and just use `malloc` without doing any `free`.
+* large: disable the GC and just allocate a large memory area to use for all instantiation.
+* help: show the list of available options.
-`NIT_NO_STACK`
-: Runtime control of stack traces.
+### `NIT_NO_STACK`
+Runtime control of stack traces.
- By default, stack traces are printed when a runtime errors occurs during the execution of a compiled program.
- When setting this environment variable to a non empty value, such stack traces are disabled.
+By default, stack traces are printed when a runtime errors occurs during the execution of a compiled program.
+When setting this environment variable to a non empty value, such stack traces are disabled.
- The environment variable is used when programs are executed, not when they are compiled.
- Thus, you do not need to recompile programs in order to disable generated stack traces.
+The environment variable is used when programs are executed, not when they are compiled.
+Thus, you do not need to recompile programs in order to disable generated stack traces.
- Note that stack traces require that, during the compilation, development files of the library `libunwind` are available.
- If they are not available, then programs are compiled without any stack trace support.
+Note that stack traces require that, during the compilation, development files of the library `libunwind` are available.
+If they are not available, then programs are compiled without any stack trace support.
- To completely disable stack traces, see the option `--no-stacktrace`.
+To completely disable stack traces, see the option `--no-stacktrace`.
# SEE ALSO
-% NITUNIT(1)
-
# NAME
nitunit - executes the unit tests from Nit source files.
Example with a class:
- module foo
- # var foo = new Foo
- # assert foo.bar == 10
- class Foo
- var bar = 10
- end
+~~~
+module foo
+# var foo = new Foo
+# assert foo.bar == 10
+class Foo
+ var bar = 10
+end
+~~~
Everything used in the test must be declared.
To test a method you have to instantiate its class:
- module foo
+~~~
+module foo
+# var foo = new Foo
+# assert foo.bar == 10
+class Foo
# var foo = new Foo
- # assert foo.bar == 10
- class Foo
- # var foo = new Foo
- # assert foo.baz(1, 2) == 3
- fun baz(a, b: Int) do return a + b
- end
+ # assert foo.baz(1, 2) == 3
+ fun baz(a, b: Int) do return a + b
+end
+~~~
In a single piece of documentation, each docunit is considered a part of a single module, thus regrouped when
tested.
The structure of a test suite is the following:
- # test suite for module `foo`
- module test_foo
- import foo # can be intrude to test private things
- class TestFoo
- # test case for `foo::Foo::baz`
- fun test_baz do
- var subject = new Foo
- assert subject.baz(1, 2) == 3
- end
+~~~~
+# test suite for module `foo`
+module test_foo
+import foo # can be intrude to test private things
+class TestFoo
+ # test case for `foo::Foo::baz`
+ fun test_baz do
+ var subject = new Foo
+ assert subject.baz(1, 2) == 3
end
+end
+~~~~
Test suite can be executed using the same `nitunit` command:
`nitunit` will execute a test for each method named `test_*` in a class named `Test*`
so multiple tests can be executed for a single method:
- class TestFoo
- fun test_baz_1 do
- var subject = new Foo
- assert subject.baz(1, 2) == 3
- end
- fun test_baz_2 do
- var subject = new Foo
- assert subject.baz(1, -2) == -1
- end
+~~~~
+class TestFoo
+ fun test_baz_1 do
+ var subject = new Foo
+ assert subject.baz(1, 2) == 3
end
+ fun test_baz_2 do
+ var subject = new Foo
+ assert subject.baz(1, -2) == -1
+ end
+end
+~~~~
`TestSuites` also provide methods to configure the test run:
`before_test` and `after_test`: methods called before/after each test case.
They can be used to factorize repetitive tasks:
- class TestFoo
- var subject: Foo
- # Mandatory empty init
- init do end
- # Method executed before each test
- fun before_test do
- subject = new Foo
- end
- fun test_baz_1 do
- assert subject.baz(1, 2) == 3
- end
- fun test_baz_2 do
- assert subject.baz(1, -2) == -1
- end
+~~~~
+class TestFoo
+ var subject: Foo
+ # Mandatory empty init
+ init do end
+ # Method executed before each test
+ fun before_test do
+ subject = new Foo
+ end
+ fun test_baz_1 do
+ assert subject.baz(1, 2) == 3
+ end
+ fun test_baz_2 do
+ assert subject.baz(1, -2) == -1
end
+end
+~~~~
When using custom test attributes, an empty `init` must be declared to allow automatic test running.
`before_module` and `after_module`: methods called before/after each test suite.
They have to be declared at top level:
- module test_bdd_connector
- import bdd_connector
- # Testing the bdd_connector
- class TestConnector
- # test cases using a server
- end
- # Method executed before testing the module
- fun before_module do
- # start server before all test cases
- end
- # Method executed after testing the module
- fun after_module do
- # stop server after all test cases
- end
+~~~~
+module test_bdd_connector
+import bdd_connector
+# Testing the bdd_connector
+class TestConnector
+ # test cases using a server
+end
+# Method executed before testing the module
+fun before_module do
+ # start server before all test cases
+end
+# Method executed after testing the module
+fun after_module do
+ # stop server after all test cases
+end
+~~~~
## Generating test suites
- Write test suites for big modules can be a repetitive and boring task...
- To make it easier, `nitunit` can generate test skeletons for Nit modules:
+Write test suites for big modules can be a repetitive and boring task...
+To make it easier, `nitunit` can generate test skeletons for Nit modules:
$ nitunit --gen-suite foo.nit
- This will generate the test suite `test_foo` containing test case stubs for all public
- methods found in `foo.nit`.
+This will generate the test suite `test_foo` containing test case stubs for all public
+methods found in `foo.nit`.
# OPTIONS
-`--full`
-: Process also imported modules.
+### `--full`
+Process also imported modules.
- By default, only the modules indicated on the command line are tested.
+By default, only the modules indicated on the command line are tested.
- With the `--full` option, all imported modules (even those in standard) are also precessed.
+With the `--full` option, all imported modules (even those in standard) are also precessed.
-`-o`, `--output`
-: Output name (default is 'nitunit.xml')
+### `-o`, `--output`
+Output name (default is 'nitunit.xml')
- `nitunit` produces a XML file comatible with JUnit.
+### `nitunit` produces a XML file comatible with JUnit.
-`--dir`
-: Working directory (default is '.nitunit')
+### `--dir`
+Working directory (default is '.nitunit')
- In order to execute the tests, nit files are generated then compiled and executed in the giver working directory.
+In order to execute the tests, nit files are generated then compiled and executed in the giver working directory.
-`--no-act`
-: Does not compile and run tests.
+### `--no-act`
+Does not compile and run tests.
-`-p`, `--pattern`
-: Only run test case with name that match pattern. Examples: `TestFoo`, `TestFoo*`, `TestFoo::test_foo`, `TestFoo::test_foo*`, `test_foo`, `test_foo*`
+### `-p`, `--pattern`
+Only run test case with name that match pattern. Examples: `TestFoo`, `TestFoo*`, `TestFoo::test_foo`, `TestFoo::test_foo*`, `test_foo`, `test_foo*`
-`-t`, `--target-file`
-: Specify test suite location.
+### `-t`, `--target-file`
+Specify test suite location.
## SUITE GENERATION
-`--gen-suite`
-: Generate test suite skeleton for a module
+### `--gen-suite`
+Generate test suite skeleton for a module
-`-f`, `--force`
-: Force test generation even if file exists.
+### `-f`, `--force`
+Force test generation even if file exists.
- Any existing test suite will be overwritten.
+Any existing test suite will be overwritten.
-`--private`
-: Also generate test case for private methods.
+### `--private`
+Also generate test case for private methods.
-`--only-show`
-: Only display the skeleton, do not write any file.
+### `--only-show`
+Only display the skeleton, do not write any file.
# SEE ALSO
nitlanguage / nit.git / commitdiff