package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Log events
Duration
Date conversion
Error management

package catala

catala.catala_utils
- Catala_utils
  - Cli
  - Errors
  - File
  - Marked
    
    marked_iter
    
    marked_map
    
    pos_iter
    
    pos_map
  - Pos
  - String
  - Uid
    
    Gen
    
    Id
    
    Info
    
    Make
    
    X
    
    MarkedString
catala.dcalc
- Dcalc
catala.desugared
- Desugared
  - Ast
    
    ScopeDef
  - Dependency
    
    Vertex
  - Disambiguate
  - From_surface
  - Name_resolution
catala.driver
- Driver
catala.lcalc
- Lcalc
catala.literate
- Literate
catala.plugins.api_web
- Api_web
  - To_jsoo
catala.plugins.json_schema
- Json_schema
  - To_json
catala.plugins.python
- Python
catala.runtime_jsoo
- Runtime_jsoo
  - Runtime
    
    duration
    
    event
    
    event_manager
    
    raw_event
    
    source_position
catala.runtime_ocaml
- Runtime_ocaml
  - Runtime
    
    EventParser
    
    Oper
catala.scalc
- Scalc
  - Ast
    
    FuncName
    
    Map
    
    Set
    
    VarName
    
    Map
    
    Set
  - From_lcalc
  - Print
  - To_python
catala.scopelang
- Scopelang
  - Ast
  - Dependency
    
    TVertex
  - From_desugared
  - Print
catala.shared_ast
- Shared_ast
  - EnumConstructor
    
    Map
    
    Set
  - EnumName
    
    Map
    
    Set
  - Expr
    
    Box
  - LabelName
    
    Map
    
    Set
  - Op
  - Operator
  - Print
  - Program
  - RuleName
    
    Map
    
    Set
  - Scope
  - ScopeName
    
    Map
    
    Set
  - ScopeVar
    
    Map
    
    Set
  - StateName
    
    Map
    
    Set
  - StructField
    
    Map
    
    Set
  - StructName
    
    Map
    
    Set
  - SubScopeName
    
    Map
    
    Set
  - TopdefName
    
    Map
    
    Set
  - Type
  - Typing
    
    Env
  - Var
    
    Map
    
    Set
catala.surface
- Surface
catala.verification
- Verification
  - Conditions
  - Io
    
    Backend
    
    BackendIO
    
    MakeBackendIO
    
    B
  - Solver
  - Z3backend
    
    Io

Legend:
Library
Module
Module type
Parameter
Class
Class type

A js_of_ocaml wrapper around the Runtime_ocaml.Runtime.

Log events

class type source_position = object ... end

Information about the position of the log inside the Catala source file.

class type raw_event = object ... end

Wrapper for the Runtime_ocaml.Runtime.raw_event -- directly collected during the program execution.

class type event = object ... end

Wrapper for the Runtime_ocaml.Runtime.event -- structured log event parsed from the raw_event ones.

class type event_manager = object ... end

val event_manager : event_manager Js_of_ocaml.Js.t

JS object usable to retrieve and reset log events.

Duration

class type duration = object ... end

Simple JSOO wrapper around Runtime_ocaml.Runtime.duration.

val duration_of_jsoo : 
  duration Js_of_ocaml.Js.t ->
  Runtime_ocaml.Runtime.duration

val duration_to_jsoo : 
  Runtime_ocaml.Runtime.duration ->
  duration Js_of_ocaml.Js.t

Date conversion

Date values are encoded to a string in the ISO8601 format: 'YYYY-MM-DD'.

val date_of_jsoo : 
  Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t ->
  Runtime_ocaml.Runtime.date

val date_to_jsoo : 
  Runtime_ocaml.Runtime.date ->
  Js_of_ocaml.Js.js_string Js_of_ocaml.Js.t

Error management

val execute_or_throw_error : (unit -> 'a) -> 'a

execute_or_throw_error f calls f () and propagates the Runtime_ocaml.Runtime.NoValueProvided, Runtime_ocaml.Runtime.ConflictError Runtime_ocaml.Runtime.AssertionFailed exceptions by raising a JS error if needed.