share/man/nitc.md

   1 % NITG(1)
   2
   3 # NAME
   4
   5 nitc - compiles Nit programs.
   6
   7
   8 # SYNOPSIS
   9
  10 nitc [*options*] FILE...
  11
  12
  13 # DESCRIPTION
  14
  15 nitc is the current official Nit compiler.
  16 It takes the main module of a Nit program as argument and produces an executable file.
  17
  18 By default, the generated executables are produced in the current directory.
  19 (see `--dir` for details.)
  20
  21 Internally, nitc rely on the presence of a C compiler. Usually gcc (but nitc was successfully tested with clang).
  22 A compilation directory is therefore created and (re-)used.
  23 By default, the compilation directory is named `nit_compile` and is removed after the compilation.
  24 (see `--compile-dir` for details.)
  25
  26 Currently, because Nit is still in heavy development, the compilation directory is not cleaned after the compilation.
  27
  28 By default, the compilation process tries to have a good trade-off between the compilation time and the performance of produced executables.
  29 To produce more optimized executables, the current best option is `--semi-global`.
  30
  31 To improve the compilation time and simplify the compilation of multiple programs, more than one file can be given.
  32 Each one will be compiled into a distinct executable.
  33
  34     $ nitc prog1.nit prog2.nit
  35
  36 To combine files into a single program, use the `-m` option.
  37
  38     $ nitc prog1.nit -m other_module.nit
  39
  40 nitc can produces executables for various platforms when specific modules are used.
  41 Currently, android, pnacl and emscripten are supported.
  42 See the documentation of these specific modules for details.
  43
  44
  45 # OPTIONS
  46
  47 ## MESSAGES
  48
  49 `-W`, `--warn`
  50 :   Show additional warnings (advices).
  51
  52     By default, only important warnings are displayed.
  53     May be overridden by `-w`.
  54
  55     Important warnings are displayed by default. A warning is considered important when:
  56
  57      * There is a simple correction.
  58      * There is no reason to let the code this way.
  59      * There is always a real issue (no false positive).
  60
  61     Other warnings, called advices, are not displayed by default to avoid filling the terminal with
  62     unwanted information.
  63     A warning is considered an advice when:
  64
  65      * The correction could be complex. e.g. require a refactorisation or an API change.
  66      * The correction cannot be done. e.g. Code that use a deprecated API for some compatibility reason.
  67      * There is not a real issue (false positive). Note that this should be unlikely.
  68      * Transitional: While a real important warning, it fires a lot in current code, so a transition is needed
  69        in order to let people fix them before promoting the advice to an important warning.
  70
  71 `-w`, `--warning`
  72 :   Show/hide a specific warning.
  73
  74     Each type of warning can be individually displayed or hidden.
  75     The `-w` option takes the name of a warning (displayed at the end of the warning message, between parentheses) to activate it;
  76     and "no-{name}" to disable it.
  77     It has precedence over -q and -W.
  78     Multiple `-w` can be given.
  79
  80     To show only `missing-doc` warnings in standard"
  81
  82         $ nitc -q -w missing-doc standard
  83
  84     To show all warnings and advices, except `missing-doc`:
  85
  86         $ nitc -W -w no-missing-doc standard
  87
  88     To show important warnings except `useless-type-test`, but not advice except `missing-doc`:
  89
  90         $ nitc -w missing-doc -w no-useless-type-test standard
  91
  92 `-q`, `--quiet`
  93 :   Do not show warnings.
  94     May be overridden by `-w`
  95
  96 `--stop-on-first-error`
  97 :   Just display the first encountered error then stop.
  98
  99     By default, nitc tries to detect and display more than one error before aborting the compilation.
 100
 101 `--no-color`
 102 :   Do not use color to display errors and warnings.
 103
 104     Also, do not echo the line.
 105     This options is mainly used by scripts and tools that need parsable error messages.
 106
 107 `-v`, `--verbose`
 108 :   Additional messages from the tool.
 109     Multiple `-v` can be given to improve the verbosity.
 110
 111     With one `-v`, there is constant number of lines.
 112     With two `-v`, the number of lines is proportional to the number of modules.
 113     With three `-v`, the number of lines is proportional to the number of definition of classes.
 114     With four `-v`, the number of lines is proportional to the number of definition of properties.
 115
 116 `--log`
 117 :   Generate various log files.
 118
 119     The tool will generate some files in the logging directory (see `--log-dir`).
 120     These files are intended to the advanced user and the developers of the tools.
 121
 122 `--log-dir`
 123 :   Directory where to generate log files.
 124
 125     By default the directory is called `logs` in the working directory.
 126
 127
 128 `-h`, `-?`, `--help`
 129 :   Show Help (the list of options).
 130
 131 `--version`
 132 :   Show version and exit.
 133
 134
 135 ## PATHS
 136
 137 `-I`, `--path`
 138 :   Add an additional include path.
 139
 140     This option is used to indicate an additional path of a directory containing Nit libraries.
 141
 142     The path added with `-I` are searched before those added by the environment variable `NIT_PATH`.
 143
 144     May be used more than once.
 145
 146 `-o`, `--output`
 147 :   Output executable name.
 148
 149     Indicates the path and name of the produced executable.
 150
 151     Note: it is better to use `--dir` if only the directory is important.
 152     This way, the platform extension will be correctly set.
 153
 154     `-o` is not usable if multiple programs are compiled at once.
 155
 156 `--dir`
 157 :   Output directory.
 158
 159     Produce the executables in the given directory instead of the current directory.
 160
 161 `--nit-dir`
 162 :   Base directory of the Nit installation.
 163
 164     Has precedence over the environment variable `NIT_DIR`.
 165
 166 ## COMPILATION
 167
 168 `--compile-dir`
 169 :   Directory used to generate temporary files.
 170
 171     By default, it is named `nit_compile` and created in the current directory and destroyed after the compilation.
 172
 173     If the option `--compile_dir` or `--no-cc` is used, then the directory is not destroyed and let as is.
 174
 175 `--no-cc`
 176 :   Do not invoke the C compiler.
 177
 178     Files in the compilation directory are generated but the C compiler is not invoked.
 179
 180     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).
 181     In this case, it is suggested to also use the options `--dir`, `--compile-dir` and `--semi-global`.
 182
 183         $ nitc examples/hello_world.nit --no-cc --dir hello --compile-dir hello --semi-global
 184
 185     Will produce a `hello` directory that contains the required C files to finish the compilation.
 186     Only the C files required for the program are generated.
 187     The final binary will be generated in the same directory.
 188
 189     Note that, to be useful, the compilation directory is not destroyed when `--no-cc` is used.
 190
 191 `-m`
 192 :   Additional module to mix-in.
 193
 194     Additional modules are imported and refine the main module of the program.
 195     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.
 196     May be used more than once.
 197
 198     This is option is used to weave additional behaviors to existing programs.
 199     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.
 200     E.g. `hash_debug`.
 201
 202     An other usage of the `-m` option is to compile program to a specific platform. E.g. `emscripten`  or `android`.
 203
 204     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.
 205
 206         $ nitc prog_vanilla.nit -m feature_chocolate.nit -m feature_cherry.nit
 207
 208 `-D`, `--define`
 209 :   Define a specific property.
 210
 211     The `-D` option allows to refine a top-level method at compile-time.
 212     This has basically the same effect than implementing a specific module that imports the main module of the program and refines the designated methods.
 213
 214     The designated method must be top-level function with no parameters that returns a Bool, an Int or a String.
 215
 216     The argument of the `-D` option is "{name}={value}".
 217     For Bool, the argument can also be just "{name}", in this case, the value is considered to be `true`.
 218
 219         $ nitc foo.nit -D prefix=/opt/foo -D port=8080 -D with_ssl
 220
 221 `--release`
 222 :   Compile in release mode and finalize application.
 223
 224     Currently, this only affect the android platform.
 225
 226 ## COMPILATION MODES
 227
 228 `nitc` includes distinct compilation modes.
 229
 230 `--separate`
 231 :   Use separate compilation (default mode).
 232
 233     In separate compilation, modules are compiled independently of their programs.
 234     This makes the recompilation of programs faster since only the modified files need to be recompiled.
 235
 236 `--global`
 237 :   Use global compilation.
 238
 239     The produced executables may become huge and the compilation time is prohibitive.
 240     But sometime, they are faster.
 241
 242     In practice, `--semi-global` produces nearly as fast but smaller executables.
 243
 244 `--erasure`
 245 :   Erase generic types.
 246
 247     Like `--separate` but use an erasure dynamic typing policy for generics and virtual types.
 248     Usually you do not need this, even if you understand the previous sentence.
 249
 250
 251 ## SEMI-GLOBAL OPTIMIZATIONS
 252
 253 In `--separate` and in `--erasure` modes, some optimization can be gained by relaxing the constraint about
 254 the independence on programs.
 255
 256 Therefore, with these options, the produced executables may be faster and smaller but the recompilation time
 257 will increase.
 258
 259 `--semi-global`
 260 :   Enable all semi-global optimizations.
 261
 262 `--rta`
 263 :   Activate RTA (Rapid Type Analysis).
 264
 265     This option only make sense in `--erasure` to enable some semi-global optimizations.
 266
 267     RTA is implicitly enabled in `--separate` and `--global`.
 268
 269 `--inline-coloring-numbers`
 270 :   Inline colors and ids (semi-global).
 271
 272 `--inline-some-methods`
 273 :   Allow the separate compiler to inline some methods (semi-global).
 274     Need `--rta`.
 275
 276 `--direct-call-monomorph`
 277 :   Allow the separate compiler to direct call monomorphic sites (semi-global).
 278     Need `--rta`.
 279
 280 `--skip-dead-methods`
 281 :   Do not compile dead methods (semi-global).
 282     Need `--rta`.
 283
 284 ## LINK-BOOST OPTIMIZATIONS
 285
 286 In `--separate` and in `--erasure` modes, some optimization can be gained by hijacking the linker process.
 287
 288 Warning: these optimisations are not portable since they use extra features of the GNU linker `ld`.
 289 However, there is very few reasons to not use them if GNU `ld` is available.
 290
 291 `--link-boost`
 292 :   Enable all link-boost optimizations.
 293
 294 `--colors-are-symbols`
 295 :   Store colors as symbols instead of static data.
 296
 297     By default, the various identifiers used to implement OO-mechanisms are stored as genuine constant static variables.
 298
 299     This option uses linker symbols to encode these identifiers.
 300     This makes the compiled program faster since less indirections are required to get the values.
 301     It also produces executables that are a little bit smaller since static memory does not have to store the colors.
 302
 303 `--substitute-monomorph`
 304 :   Replace monomorphic trampolines with direct call.
 305
 306     Late-binding is implemented with *trampolines*, that are small functions that just select and jump the to right implementations.
 307     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
 308     direct calls to this single implementation.
 309
 310     Note that using trampolines as indirection slows down the executable.
 311     However, it is expected that the gain of monomorphic direct-calls overcompensates the additional indirections in polymorphic trampoline-calls.
 312
 313     Note: automatically enable option `--trampoline-call`.
 314
 315 ## DANGEROUS OPTIMIZATIONS
 316
 317 The following optimizations disable runtime checks.
 318 It means that correct (non-buggy) programs may be slightly faster.
 319 It also means that incorrect (buggy) programs may have unspecified behaviors
 320 (e.g. formatting your hard drive or killing your cat).
 321
 322 In fact, these options are mainly used to bench the compilation results.
 323
 324 `--no-check-all`
 325 :   Disable all tests (dangerous).
 326
 327 `--no-check-covariance`
 328 :   Disable type tests of covariant parameters (dangerous).
 329
 330 `--no-check-attr-isset`
 331 :   Disable isset tests before each attribute access (dangerous).
 332
 333 `--no-check-assert`
 334 :   Disable the evaluation of explicit `assert` and `as` (dangerous).
 335
 336 `--no-check-autocast`
 337 :   Disable implicit casts on unsafe expression usage (dangerous).
 338
 339 `--no-check-null`
 340 :   Disable tests of null receiver (dangerous).
 341
 342 `--no-check-erasure-cast`
 343 :   Disable implicit casts on unsafe return with erasure-typing policy (dangerous).
 344
 345
 346 ## UNOPTIMIZATIONS
 347
 348 These options are used to debug or to bench the compilation results.
 349 Usually you do not need them since they make the generated code slower.
 350
 351 `--hardening`
 352 :   Generate contracts in the C code against bugs in the compiler.
 353
 354 `--no-shortcut-range`
 355 :   Always instantiate a range and its iterator on 'for' loops.
 356
 357 `--no-union-attribute`
 358 :   Put primitive attributes in a box instead of an union.
 359
 360 `--no-shortcut-equal`
 361 :   Always call == in a polymorphic way.
 362
 363 `--no-tag-primitive`
 364 :   Use only boxes for primitive types.
 365
 366 The separate compiler uses tagged values to encode common primitive types like Int, Bool and Char.
 367 This option disables tags and forces such primitive values to be boxed.
 368 The drawback is that each boxing costs a memory allocation thus increases the amount of work for the garbage collector.
 369
 370 However, in some cases, it is possible that this option improves performance since the absence of tags simplify the implementation
 371 of OO mechanisms like method calls or equality tests.
 372
 373 `--no-inline-intern`
 374 :   Do not inline call to intern methods.
 375
 376 `--colo-dead-methods`
 377 :   Force colorization of dead methods.
 378
 379 `--no-gcc-directive`
 380 :   Disable advanced gcc directives for optimization.
 381
 382 `--trampoline-call`
 383 :   Use an indirection when calling.
 384
 385     Just add the trampolines of `--substitute-monomorph` without doing any aditionnal optimizations.
 386
 387 ## INTERNAL OPTIONS
 388
 389 These options can be used to control the fine behavior of the tool.
 390 They are useless for a normal user.
 391
 392 `--disable-phase`
 393 :   Disable a specific phase; use `list` to get the list.
 394
 395 `--only-parse`
 396 :   Only proceed to parse files.
 397
 398 `--only-metamodel`
 399 :   Stop after meta-model processing.
 400
 401 `--ignore-visibility`
 402 :   Do not check, and produce errors, on visibility issues.
 403
 404 `--no-main`
 405 :   Do not generate main entry point.
 406
 407 `--stacktrace`
 408 :   Control the generation of stack traces.
 409
 410 `--max-c-lines`
 411 :   Maximum number of lines in generated C files. Use 0 for unlimited.
 412
 413 `--group-c-files`
 414 :   Group all generated code in the same series of files.
 415
 416 `--make-flags`
 417 :   Additional options to the `make` command.
 418
 419           $ nitc foo.nit --make-flags 'CC=clang' --make-flags 'CFLAGS="-O0 -g"'
 420
 421 `--typing-test-metrics`
 422 :   Enable static and dynamic count of all type tests.
 423
 424 `--invocation-metrics`
 425 :   Enable static and dynamic count of all method invocations.
 426
 427 `--isset-checks-metrics`
 428 :   Enable static and dynamic count of isset checks before attributes access.
 429
 430 `--tables-metrics`
 431 :   Enable static size measuring of tables used for vft, typing and resolution.
 432
 433 `--set-dummy-tool`
 434 :   Set toolname and version to DUMMY. Useful for testing.
 435
 436 `--bash-completion`
 437 :   Generate bash_completion file for this program.
 438
 439 `--stub-man`
 440 :   Generate a stub manpage in pandoc markdown format.
 441
 442 `--keep-going`
 443 :   Continue after errors, whatever the consequences.
 444
 445 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.
 446 This option is used to test the robustness of the tools by allowing phases to progress on incorrect data.
 447
 448 # ENVIRONMENT VARIABLES
 449
 450 `NIT_DIR`
 451 :   Base directory of the Nit installation.
 452
 453     When the `NIT_DIR` environment variable is set then it specifies the path of the Nit install directory.
 454
 455     This directory is used to locate binaries, shared files and the common libraries.
 456
 457     When unset, the directory is guessed according to some heuristic.
 458
 459     The `--nit-dir` option also set the base directory of the Nit installation but has precedence.
 460
 461 `NIT_PATH`
 462 :   Additional include paths.
 463
 464     The `NIT_PATH` environment variable contains paths of directories containing Nit libraries.
 465     Each path is separated with a column (`:`).
 466
 467     The `-I` option also add additional paths.
 468
 469 `NIT_GC_OPTION`
 470 :   Runtime control of the garbage collector.
 471
 472     The behavior of the GC of the executables produced by nitc can be tuned with this environment variable.
 473
 474     The environment variable is used when programs are executed, not when they are compiled.
 475     Thus, you do not need to recompile programs in order to tweak their GC options.
 476
 477     Available values are:
 478
 479     * boehm: use the Boehm-Demers-Weiser's conservative garbage collector (default).
 480     * malloc: disable the GC and just use `malloc` without doing any `free`.
 481     * large: disable the GC and just allocate a large memory area to use for all instantiation.
 482     * help: show the list of available options.
 483
 484 # SEE ALSO
 485
 486 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>