Module `Catala_utils.Global`Source

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

Sourcetype file = string

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

Sourcetype raw_file = private file

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

Sourcetype backend_lang =

| En
| Fr
| Pl

Sourcetype when_enum =

| Auto
| Always
| Never

The usual auto/always/never option argument

Sourcetype message_format_enum =

| Human
| GNU
(*
Format of error and warning messages output by the compiler.
*)

Sourcetype 'file input_src =

| FileName of 'file
(*
A file path to read from disk
*)
| Contents of string * 'file
(*
A raw string containing the code, and the corresponding (fake) filename
*)
| Stdin of 'file
(*
Read from stdin; the specified filename will be used for file lookups, error reportings, etc.
*)

Sources for program input

Configuration globals

Sourcetype options = private {

mutable input_src : file input_src;
mutable language : backend_lang option;
mutable debug : bool;
mutable color : when_enum;
mutable message_format : message_format_enum;
mutable trace : bool;
mutable plugins_dirs : file list;
mutable disable_warnings : bool;
mutable max_prec_digits : int;
mutable path_rewrite : raw_file -> file;

}

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

Sourceval 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.

Source

val enforce_options : 
  ?input_src:file input_src ->
  ?language:backend_lang option ->
  ?debug:bool ->
  ?color:when_enum ->
  ?message_format:message_format_enum ->
  ?trace:bool ->
  ?plugins_dirs:file list ->
  ?disable_warnings:bool ->
  ?max_prec_digits:int ->
  ?path_rewrite:(raw_file -> file) ->
  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.

Sourceval input_src_file : file input_src -> file

Sourceval raw_file : string -> raw_file

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

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.catala_utils/Catala_utils/Global/index.html

Module `Catala_utils.Global`Source

Configuration globals

package catala

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.catala_utils/Catala_utils/Global/index.html

Module Catala_utils.GlobalSource

Configuration globals

Module `Catala_utils.Global`Source