package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Unique identifiers
Source code positions
Error messages
Other utilies

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

Compiler utilities

Unique identifiers

In the desugared representation or in the the scope language, a number of things are named using global identifiers. These identifiers use OCaml's type system to statically distinguish e.g. a scope identifier from a struct identifier.

The Uid module provides a generative functor whose output is a fresh sort of global identifiers.

Related modules:

Uid

Source code positions

This module is used throughout the compiler to annotate the abstract syntax trees with information about the position of the element in the original source code. These annotations are critical to produce readable error messages.

Related modules:

Pos

Error messages

Error handling is critical in a compiler. The Catala compiler uses an architecture of error messages inspired by the Rust compiler, where error messages all correspond to the same exception. This exception carries messages and positions that are displayed in the end in a nicely-formatted error message.

Hence, all error thrown by the compiler should use Utils.Errors

Related modules:

Utils.Errors

Other utilies

Related modules:

Utils.File
Utils.String_common