package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Common syntax highlighting helpers
Some basic stringifiers
Formatters
1. Generic expression printer interface
Debugging versions that don't require a context

package catala

catala.catala_utils
- Catala_utils
  - Cli
    
    Flags
    
    Global
  - File
    
    Map
    
    Set
    
    Tree
  - Global
  - Map
    
    Make
    
    Ord
    
    OrderedType
    
    S
  - Mark
    
    marked_iter
    
    marked_map
    
    pos_iter
    
    pos_map
  - Message
    
    Content
  - Pos
  - String
    
    Map
    
    Set
  - Suggestions
  - Uid
    
    Gen
    
    Map
    
    Set
    
    _
    
    Gen_qualified
    
    Map
    
    Set
    
    _
    
    Id
    
    Map
    
    Set
    
    Info
    
    Make
    
    Map
    
    Set
    
    X
    
    _
    
    MarkedString
    
    Module
    
    Map
    
    Set
    
    Path
    
    Style
  - Version
catala.clerk_driver
- Clerk_driver
catala.dcalc
- Dcalc
catala.desugared
- Desugared
  - Ast
    
    AssertionName
    
    Map
    
    Set
    
    ExprMap
    
    LocationSet
    
    Rule
    
    ScopeDef
    
    Map
    
    Set
  - Dependency
    
    Edge
    
    EdgeExceptions
    
    ExceptionVertex
    
    ExceptionsDependencies
    
    E
    
    V
    
    ScopeDependencies
    
    E
    
    V
    
    Vertex
  - Disambiguate
  - From_surface
  - Linting
  - Name_resolution
  - Print
catala.driver
- Driver
  - Commands
  - Passes
  - Plugin
catala.lcalc
- Lcalc
catala.literate
- Literate
  - Html
  - Latex
  - Literate_common
  - Pygment_lexers
    
    Internal
  - Pygmentize
catala.plugins.api_web
- Api_web
  - To_jsoo
catala.plugins.explain
- Explain
  - E
  - Env
  - G
    
    E
    
    V
  - GTopo
  - V
catala.plugins.json_schema
- Json_schema
  - To_json
catala.plugins.lazy-interpreter
- Lazy_interpreter
  - Lazy_interp
    
    Env
catala.plugins.python
- Python
catala.runtime_jsoo
- Runtime_jsoo
  - Runtime
    
    duration
    
    event
    
    event_manager
    
    raw_event
    
    source_position
catala.runtime_ocaml
- Runtime_ocaml
  - Runtime
    
    Eoption
    
    EventParser
    
    Json
    
    Oper
catala.scalc
- Scalc
  - Ast
    
    FuncName
    
    Map
    
    Set
    
    VarName
    
    Map
    
    Set
  - From_lcalc
  - Print
  - To_c
  - To_python
  - To_r
catala.scopelang
- Scopelang
  - Ast
    
    LocationSet
  - Dependency
    
    SDependencies
    
    E
    
    V
    
    TDependencies
    
    E
    
    V
    
    TVertex
    
    TVertexSet
  - From_desugared
  - Print
catala.shared_ast
- Shared_ast
  - BoundList
  - EnumConstructor
    
    Map
    
    Set
  - EnumName
    
    Map
    
    Set
  - Expr
    
    Box
  - Interpreter
  - LabelName
    
    Map
    
    Set
  - Op
  - Operator
  - Optimizations
  - Print
    
    EXPR_PARAM
    
    ExprConciseParam
    
    ExprDebugParam
    
    ExprGen
    
    _
    
    UserFacing
  - Program
  - Qident
    
    Map
    
    Set
  - RuleName
    
    Map
    
    Set
  - Scope
  - ScopeName
    
    Map
    
    Set
  - ScopeVar
    
    Map
    
    Set
  - StateName
    
    Map
    
    Set
  - StructField
    
    Map
    
    Set
  - StructName
    
    Map
    
    Set
  - TopdefName
    
    Map
    
    Set
  - Type
    
    Map
  - Typing
    
    Env
  - Var
    
    Map
    
    Set
catala.surface
- Surface
  - Ast
    
    map
  - Fill_positions
  - Lexer_common
    
    LocalisedLexer
  - Lexer_en
  - Lexer_fr
  - Lexer_pl
  - Parser
    
    Make
    
    Incremental
    
    Localisation
    
    MenhirInterpreter
  - Parser_driver
  - Parser_errors
  - Print
  - Tokens
catala.verification
- Verification
  - Conditions
  - Globals
  - Io
    
    Backend
    
    BackendIO
    
    MakeBackendIO
    
    B
  - Solver
  - Z3backend
    
    Io

Legend:
Library
Module
Module type
Parameter
Class
Class type

Printing functions for the default calculus AST

Common syntax highlighting helpers

val base_type : Format.formatter -> string -> unit

val keyword : Format.formatter -> string -> unit

val punctuation : Format.formatter -> string -> unit

The argument is assumed to be 1-column wide (but can be a multi-char utf8 character)

val op_style : Format.formatter -> string -> unit

val lit_style : Format.formatter -> string -> unit

Some basic stringifiers

val operator_to_string : 'a Shared_ast__.Definitions.Op.t -> string

Prints the operator symbols with kind suffixes, as expected by the OCaml backend (e.g. "+^", "+$", etc.)

Formatters

val uid_list : 
  Format.formatter ->
  Catala_utils.Uid.MarkedString.info list ->
  unit

val tlit : Format.formatter -> Shared_ast__.Definitions.typ_lit -> unit

val location : 
  Format.formatter ->
  'a Shared_ast__.Definitions.glocation ->
  unit

val external_ref : 
  Format.formatter ->
  Shared_ast__.Definitions.external_ref Catala_utils.Mark.pos ->
  unit

val typ : 
  Shared_ast__.Definitions.decl_ctx ->
  Format.formatter ->
  Shared_ast__.Definitions.naked_typ Catala_utils.Mark.pos ->
  unit

val lit : Format.formatter -> Shared_ast__.Definitions.lit -> unit

val operator : 
  ?debug:bool ->
  Format.formatter ->
  'a Shared_ast__.Definitions.Op.t ->
  unit

val log_entry : Format.formatter -> Shared_ast__.Definitions.log_entry -> unit

val runtime_error : Format.formatter -> Runtime_ocaml.Runtime.error -> unit

val var : Format.formatter -> 'e Var.t -> unit

val var_debug : Format.formatter -> 'e Var.t -> unit

val expr : 
  ?debug:bool ->
  unit ->
  Format.formatter ->
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed ->
  unit

Expression printer.

parameter debug
(default to the global setting) turns on printing of logging nodes, variable indices and operator suffixes. See the interface below for more detailed control.

Generic expression printer interface

module type EXPR_PARAM = sig ... end

module ExprGen (_ : EXPR_PARAM) : sig ... end

module ExprConciseParam : EXPR_PARAM

module ExprDebugParam : EXPR_PARAM

Debugging versions that don't require a context

val typ_debug : 
  Format.formatter ->
  Shared_ast__.Definitions.naked_typ Catala_utils.Mark.pos ->
  unit

val scope : 
  ?debug:bool ->
  Shared_ast__.Definitions.decl_ctx ->
  Format.formatter ->
  (Shared_ast__.Definitions.ScopeName.t
   * (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
       'm Shared_ast__.Definitions.mark)
       Catala_utils.Mark.ed
       Shared_ast__.Definitions.scope_body) ->
  unit

val program : 
  ?debug:bool ->
  Format.formatter ->
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed
    Shared_ast__.Definitions.program ->
  unit

module UserFacing : sig ... end

User-facing, localised printer

val skip_wrappers : 
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed ->
  (('a, 'a, 'm) Shared_ast__.Definitions.base_gexpr,
    'm Shared_ast__.Definitions.mark)
    Catala_utils.Mark.ed

This is exported from Expr, but first defined here for dependency reasons