package catala
Install
Dune Dependency
Authors
Maintainers
Sources
md5=8f891209d18b6540df9c34b2d1a6a783
sha512=737770b87a057674bceefe77e8526720732552f51f424afcebcb6a628267eab522c4fd993caca1ae8ed7ace65a4a87e485af10c1676e51ca5939509a1b841ac2
doc/catala.catala_utils/Catala_utils/Cli/index.html
Module Catala_utils.Cli
Source
File names ; equal to File.t
but let's avoid cyclic dependencies
A file name that has not yet been resolved, options.path_rewrite
must be called on it
The usual auto/always/never option argument
Sources for program input
Returns the lowercase two-letter language code
Associates a file extension with its corresponding Cli.backend_lang
string representation.
If to_dir
is a path to a given directory and f
a path to a file as seen from absolute path from_dir
, reverse_path ~from_dir ~to_dir f
is a path leading to f
from to_dir
. The results attempts to be relative to to_dir
.
Configuration globals
type options = private {
mutable input_src : 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 : string 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)
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_globals :
?input_src:input_src ->
?language:backend_lang option ->
?debug:bool ->
?color:when_enum ->
?message_format:message_format_enum ->
?trace:bool ->
?plugins_dirs:string list ->
?disable_warnings:bool ->
?max_prec_digits:int ->
?path_rewrite:(file -> file) ->
unit ->
options
Sets up the global options (side-effect); for specific use-cases only, this should never be called from the compiler or when going through normal command-line parsing. Proper uses include setting up the compiler library when using it directly through a specific front-end.
CLI flags and options
Command-line application
Manpage section name for the installed plugins
Exit with a specific exit code (but less brutally than Sys.exit
which would bypass all finalisers)