mirror of
https://github.com/CatalaLang/catala.git
synced 2024-09-19 16:28:12 +03:00
153 lines
4.6 KiB
OCaml
153 lines
4.6 KiB
OCaml
(* This file is part of the Catala compiler, a specification language for tax
|
|
and social benefits computation rules. Copyright (C) 2020 Inria,
|
|
contributors: Denis Merigoux <denis.merigoux@inria.fr>, Emile Rolley
|
|
<emile.rolley@tuta.io>
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
use this file except in compliance with the License. You may obtain a copy of
|
|
the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations under
|
|
the License. *)
|
|
|
|
type backend_lang = En | Fr | Pl
|
|
|
|
type backend_option_builtin =
|
|
[ `Latex
|
|
| `Makefile
|
|
| `Html
|
|
| `Interpret
|
|
| `Typecheck
|
|
| `OCaml
|
|
| `Python
|
|
| `Scalc
|
|
| `Lcalc
|
|
| `Dcalc
|
|
| `Scopelang
|
|
| `Proof
|
|
| `DcalcInvariants ]
|
|
|
|
type 'a backend_option = [ backend_option_builtin | `Plugin of 'a ]
|
|
|
|
val backend_option_to_string : string backend_option -> string
|
|
(** [backend_option_to_string backend] returns the string representation of the
|
|
given [backend].*)
|
|
|
|
val backend_option_of_string : string -> string backend_option
|
|
(** [backend_option_of_string backend] returns the {!type:backend_option}
|
|
corresponding to the [backend] string. *)
|
|
|
|
(** {2 Configuration globals} *)
|
|
|
|
val source_files : string list ref
|
|
(** Source files to be compiled *)
|
|
|
|
val locale_lang : backend_lang ref
|
|
val contents : string ref
|
|
val debug_flag : bool ref
|
|
|
|
val style_flag : bool ref
|
|
(** Styles the terminal output *)
|
|
|
|
val optimize_flag : bool ref
|
|
|
|
val max_prec_digits : int ref
|
|
(** Max number of digits to show for decimal results *)
|
|
|
|
val trace_flag : bool ref
|
|
|
|
val disable_counterexamples : bool ref
|
|
(** Disables model-generated counterexamples for proofs that fail. *)
|
|
|
|
val avoid_exceptions_flag : bool ref
|
|
(** Avoids using [try ... with] exceptions when compiling the default calculus. *)
|
|
|
|
(** {2 CLI terms} *)
|
|
|
|
val file : string Cmdliner.Term.t
|
|
val debug : bool Cmdliner.Term.t
|
|
val unstyled : bool Cmdliner.Term.t
|
|
val trace_opt : bool Cmdliner.Term.t
|
|
val wrap_weaved_output : bool Cmdliner.Term.t
|
|
val print_only_law : bool Cmdliner.Term.t
|
|
val backend : string Cmdliner.Term.t
|
|
val plugins_dirs : string list Cmdliner.Term.t
|
|
val language : string option Cmdliner.Term.t
|
|
val max_prec_digits_opt : int option Cmdliner.Term.t
|
|
val ex_scope : string option Cmdliner.Term.t
|
|
val output : string option Cmdliner.Term.t
|
|
|
|
(** The usual auto/always/never option argument *)
|
|
type when_enum = Auto | Always | Never
|
|
|
|
type options = {
|
|
debug : bool;
|
|
color : when_enum;
|
|
wrap_weaved_output : bool;
|
|
avoid_exceptions : bool;
|
|
backend : string;
|
|
plugins_dirs : string list;
|
|
language : string option;
|
|
max_prec_digits : int option;
|
|
trace : bool;
|
|
disable_counterexamples : bool;
|
|
optimize : bool;
|
|
ex_scope : string option;
|
|
output_file : string option;
|
|
closure_conversion : bool;
|
|
print_only_law : bool;
|
|
}
|
|
(** {2 Command-line application} *)
|
|
|
|
val options : options Cmdliner.Term.t
|
|
|
|
val catala_t : (string -> options -> 'a) -> 'a Cmdliner.Term.t
|
|
(** Main entry point: [catala_t file options] *)
|
|
|
|
val set_option_globals : options -> unit
|
|
val version : string
|
|
val info : Cmdliner.Cmd.info
|
|
|
|
(**{1 Terminal formatting}*)
|
|
|
|
(**{2 Markers}*)
|
|
|
|
val with_style : ANSITerminal.style list -> ('a, unit, string) format -> 'a
|
|
|
|
val format_with_style :
|
|
ANSITerminal.style list -> Format.formatter -> string -> unit
|
|
|
|
val call_unstyled : (unit -> 'a) -> 'a
|
|
(** [call_unstyled f] calls the function [f] with the [style_flag] set to false
|
|
during the execution. *)
|
|
|
|
val debug_marker : unit -> string
|
|
val error_marker : unit -> string
|
|
val warning_marker : unit -> string
|
|
val result_marker : unit -> string
|
|
val log_marker : unit -> string
|
|
|
|
(**{2 Printers}*)
|
|
|
|
(** All the printers below print their argument after the correct marker *)
|
|
|
|
val concat_with_line_depending_prefix_and_suffix :
|
|
(int -> string) -> (int -> string) -> string list -> string
|
|
|
|
val add_prefix_to_each_line : string -> (int -> string) -> string
|
|
(** The int argument of the prefix corresponds to the line number, starting at 0 *)
|
|
|
|
val debug_print : ('a, out_channel, unit) format -> 'a
|
|
val debug_format : ('a, Format.formatter, unit) format -> 'a
|
|
val error_print : ('a, out_channel, unit) format -> 'a
|
|
val warning_print : ('a, out_channel, unit) format -> 'a
|
|
val result_print : ('a, out_channel, unit) format -> 'a
|
|
val result_format : ('a, Format.formatter, unit) format -> 'a
|
|
val log_print : ('a, out_channel, unit) format -> 'a
|
|
val log_format : ('a, Format.formatter, unit) format -> 'a
|