package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Configuration globals
CLI terms
Terminal formatting
1. Markers
2. Printers

package catala

catala.dcalc
- Dcalc
  - Ast
    
    EnumConstructor
    
    EnumName
    
    Infer
    
    Any
    
    ScopeName
    
    StructFieldName
    
    StructName
    
    Var
  - Interpreter
  - Optimizations
  - Print
  - Typing
catala.desugared
- Desugared
  - Ast
    
    LabelName
    
    RuleName
    
    ScopeDef
    
    ScopeVar
    
    StateName
    
    Var
  - Dependency
    
    Vertex
  - Desugared_to_scope
catala.driver
- Driver
catala.lcalc
- Lcalc
catala.literate
- Literate
catala.runtime_jsoo
- Runtime_jsoo
  - Runtime
    
    duration
    
    event
    
    event_manager
    
    raw_event
    
    source_position
catala.runtime_ocaml
- Runtime_ocaml
  - Runtime
    
    EventParser
catala.scalc
- Scalc
catala.scopelang
- Scopelang
  - Ast
    
    EnumConstructorMapLift
    
    ScopeVar
    
    StructFieldMapLift
    
    SubScopeName
    
    Var
  - Dependency
    
    TVertex
  - Print
  - Scope_to_dcalc
catala.surface
- Surface
catala.utils
- Utils
  - Cli
  - Errors
  - File
  - Marked
    
    marked_iter
    
    marked_map
    
    pos_iter
    
    pos_map
  - Pos
  - String_common
  - Uid
    
    Id
    
    Info
    
    Make
    
    X
    
    MarkedString
catala.verification
- Verification
  - Conditions
  - Io
    
    Backend
    
    BackendIO
    
    MakeBackendIO
    
    B
  - Solver
  - Z3backend
    
    Io

Legend:
Library
Module
Module type
Parameter
Class
Class type

type backend_lang =

| En
| Fr
| Pl

type backend_option_builtin = [

| `Latex
| `Makefile
| `Html
| `Interpret
| `Typecheck
| `OCaml
| `Python
| `Scalc
| `Lcalc
| `Dcalc
| `Scopelang
| `Proof

]

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 backend_option corresponding to the backend string.

Configuration globals

val source_files : string list Stdlib.ref

Source files to be compiled

val locale_lang : backend_lang Stdlib.ref

val contents : string Stdlib.ref

val debug_flag : bool Stdlib.ref

val style_flag : bool Stdlib.ref

Styles the terminal output

val optimize_flag : bool Stdlib.ref

val max_prec_digits : int Stdlib.ref

Max number of digits to show for decimal results

val trace_flag : bool Stdlib.ref

val disable_counterexamples : bool Stdlib.ref

Disables model-generated counterexamples for proofs that fail.

val avoid_exceptions_flag : bool Stdlib.ref

Avoids using try ... with exceptions when compiling the default calculus.

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

type when_enum =

| Auto
| Always
| Never

The usual auto/always/never option argument

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;

}

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

Terminal formatting

Markers

val with_style : 
  ANSITerminal.style list ->
  ('a, unit, string) Stdlib.format ->
  'a

val format_with_style : 
  ANSITerminal.style list ->
  Stdlib.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

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, Stdlib.out_channel, unit) Stdlib.format -> 'a

val debug_format : ('a, Stdlib.Format.formatter, unit) Stdlib.format -> 'a

val error_print : ('a, Stdlib.out_channel, unit) Stdlib.format -> 'a

val warning_print : ('a, Stdlib.out_channel, unit) Stdlib.format -> 'a

val result_print : ('a, Stdlib.out_channel, unit) Stdlib.format -> 'a

val result_format : ('a, Stdlib.Format.formatter, unit) Stdlib.format -> 'a

val log_print : ('a, Stdlib.out_channel, unit) Stdlib.format -> 'a

val log_format : ('a, Stdlib.Format.formatter, unit) Stdlib.format -> 'a