Module Catala_utils.Global

This module contains definitions of global flags and types used throughout. They should be defined from the command-line and never modified afterwards.

type file = string

File names ; equal to File.t but let's avoid cyclic dependencies

type raw_file = private file

A file name that has not yet been resolved, options.path_rewrite must be called on it

type backend_lang =
  1. | En
  2. | Fr
  3. | Pl
type when_enum =
  1. | Auto
  2. | Always
  3. | Never

The usual auto/always/never option argument

type message_format_enum =
  1. | Human
  2. | GNU
  3. | Lsp

Format of error and warning messages output by the compiler.

type trace_format_enum =
  1. | Human
  2. | JSON

Format of trace logs

type 'file input_src =
  1. | FileName of 'file
    (*

    A file path to read from disk

    *)
  2. | Contents of string * 'file
    (*

    A raw string containing the code, and the corresponding (fake) filename

    *)
  3. | Stdin of 'file
    (*

    Read from stdin; the specified filename will be used for file lookups, error reportings, etc.

    *)

Sources for program input

Configuration globals

type options = private {
  1. mutable input_src : file input_src;
  2. mutable language : backend_lang option;
  3. mutable debug : bool;
  4. mutable color : when_enum;
  5. mutable message_format : message_format_enum;
  6. mutable trace : Stdlib.Format.formatter Stdlib.Lazy.t option;
  7. mutable trace_format : trace_format_enum;
  8. mutable plugins_dirs : file list;
  9. mutable disable_warnings : bool;
  10. mutable max_prec_digits : int;
  11. mutable path_rewrite : raw_file -> file;
  12. mutable stop_on_error : bool;
  13. mutable no_fail_on_assert : bool;
  14. mutable whole_program : bool;
  15. mutable bin_dir : string;
  16. mutable gen_external : bool;
  17. mutable no_stdlib : bool;
}

Global options, common to all subcommands (note: the fields are internally mutable only for purposes of the globals toplevel value defined below)

val options : options

A global definition to the global options is provided for convenience, e.g. choosing the proper output in formatting functions. Prefer the use of the options returned by the command-line parsing whenever possible.

val enforce_options : ?input_src:file input_src -> ?language:backend_lang option -> ?debug:bool -> ?color:when_enum -> ?message_format:message_format_enum -> ?trace:Stdlib.Format.formatter Stdlib.Lazy.t option -> ?trace_format:trace_format_enum -> ?plugins_dirs:file list -> ?disable_warnings:bool -> ?max_prec_digits:int -> ?path_rewrite:(raw_file -> file) -> ?stop_on_error:bool -> ?no_fail_on_assert:bool -> ?whole_program:bool -> ?bin_dir:string -> ?gen_external:bool -> ?no_stdlib:bool -> unit -> options

Sets up the global options (side-effect); for specific use-cases only, this should never be called from the compiler outside of the Cli module. Other proper uses include setting up the compiler library when using it directly through a specific front-end.

val input_src_file : file input_src -> file
val raw_file : string -> raw_file

Create a raw_file, for use directly after parsing from the cmdline

val has_localised_stdlib : backend_lang -> bool

Returns true for languages which should use a specialised stdlib ; when false, the English stdlib must be used as fallback.