package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Type definitions
Helpers

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

Abstract syntax tree built by the Catala parser

To allow for quick traversal and/or modification of this AST structure, we provide a visitor design pattern. This feature is implemented via François Pottier's OCaml visitors library.

Type definitions

type uident = string

Constructors are CamelCase

include sig ... end

class virtual +'a uident_map : object ... end

include sig ... end

class virtual +'a uident_iter : object ... end

type lident = string

Idents are snake_case

include sig ... end

class virtual +'a lident_map : object ... end

include sig ... end

class virtual +'a lident_iter : object ... end

type path = uident Catala_utils.Marked.pos list

include sig ... end

class virtual +'b path_map : object ... end

include sig ... end

class virtual +'b path_iter : object ... end

type scope_var = lident Catala_utils.Marked.pos list

foo.bar in binding position: used to specify variables of subscopes

include sig ... end

class virtual +'b scope_var_map : object ... end

include sig ... end

class virtual +'b scope_var_iter : object ... end

type primitive_typ =

| Integer
| Decimal
| Boolean
| Money
| Duration
| Text
| Date
| Named of path * uident Catala_utils.Marked.pos

include sig ... end

class virtual +'b primitive_typ_map : object ... end

include sig ... end

class virtual +'b primitive_typ_iter : object ... end

type base_typ_data =

| Primitive of primitive_typ
| Collection of base_typ_data Catala_utils.Marked.pos

include sig ... end

class virtual +'b base_typ_data_map : object ... end

include sig ... end

class virtual +'b base_typ_data_iter : object ... end

type base_typ =

| Condition
| Data of base_typ_data

include sig ... end

class virtual +'b base_typ_map : object ... end

include sig ... end

class virtual +'b base_typ_iter : object ... end

type func_typ = {

arg_typ : (lident Catala_utils.Marked.pos * base_typ Catala_utils.Marked.pos) list;
return_typ : base_typ Catala_utils.Marked.pos;

}

include sig ... end

class virtual +'b func_typ_map : object ... end

include sig ... end

class virtual +'b func_typ_iter : object ... end

type typ = naked_typ Catala_utils.Marked.pos

and naked_typ =

| Base of base_typ
| Func of func_typ

include sig ... end

class virtual +'b typ_map : object ... end

include sig ... end

class virtual +'b typ_iter : object ... end

type struct_decl_field = {

struct_decl_field_name : lident Catala_utils.Marked.pos;
struct_decl_field_typ : typ;

}

include sig ... end

class virtual +'b struct_decl_field_map : object ... end

include sig ... end

class virtual +'b struct_decl_field_iter : object ... end

type struct_decl = {

struct_decl_name : uident Catala_utils.Marked.pos;
struct_decl_fields : struct_decl_field Catala_utils.Marked.pos list;

}

include sig ... end

class virtual +'b struct_decl_map : object ... end

include sig ... end

class virtual +'b struct_decl_iter : object ... end

type enum_decl_case = {

enum_decl_case_name : uident Catala_utils.Marked.pos;
enum_decl_case_typ : typ option;

}

include sig ... end

class virtual +'b enum_decl_case_map : object ... end

include sig ... end

class virtual +'b enum_decl_case_iter : object ... end

type enum_decl = {

enum_decl_name : uident Catala_utils.Marked.pos;
enum_decl_cases : enum_decl_case Catala_utils.Marked.pos list;

}

include sig ... end

class virtual +'b enum_decl_map : object ... end

include sig ... end

class virtual +'b enum_decl_iter : object ... end

type match_case_pattern =
  (path * uident Catala_utils.Marked.pos) Catala_utils.Marked.pos list
  * lident Catala_utils.Marked.pos option

include sig ... end

class virtual +'b match_case_pattern_map : object ... end

include sig ... end

class virtual +'b match_case_pattern_iter : object ... end

type op_kind =

| KPoly
| KInt
| KDec
| KMoney
| KDate
| KDuration

include sig ... end

class virtual +'a op_kind_map : object ... end

include sig ... end

class virtual +'a op_kind_iter : object ... end

type binop =

| And
| Or
| Xor
| Add of op_kind
| Sub of op_kind
| Mult of op_kind
| Div of op_kind
| Lt of op_kind
| Lte of op_kind
| Gt of op_kind
| Gte of op_kind
| Eq
| Neq
| Concat

include sig ... end

class virtual +'a binop_map : object ... end

include sig ... end

class virtual +'a binop_iter : object ... end

type unop =

| Not
| Minus of op_kind

include sig ... end

class virtual +'a unop_map : object ... end

include sig ... end

class virtual +'a unop_iter : object ... end

type builtin_expression =

| Cardinal
| ToDecimal
| ToMoney
| GetDay
| GetMonth
| GetYear
| LastDayOfMonth
| FirstDayOfMonth
| Round

include sig ... end

class virtual +'a builtin_expression_map : object ... end

include sig ... end

class virtual +'a builtin_expression_iter : object ... end

type literal_date = {

literal_date_day : int;
literal_date_month : int;
literal_date_year : int;

}

include sig ... end

class virtual +'b literal_date_map : object ... end

include sig ... end

class virtual +'b literal_date_iter : object ... end

type literal_number =

| Int of string
| Dec of string * string

include sig ... end

class virtual +'a literal_number_map : object ... end

include sig ... end

class virtual +'a literal_number_iter : object ... end

type literal_unit =

| Percent
| Year
| Month
| Day

include sig ... end

class virtual +'a literal_unit_map : object ... end

include sig ... end

class virtual +'a literal_unit_iter : object ... end

type money_amount = {

money_amount_units : string;
money_amount_cents : string;

}

include sig ... end

class virtual +'a money_amount_map : object ... end

include sig ... end

class virtual +'a money_amount_iter : object ... end

type literal =

| LNumber of literal_number Catala_utils.Marked.pos * literal_unit Catala_utils.Marked.pos option
| LBool of bool
| LMoneyAmount of money_amount
| LDate of literal_date

include sig ... end

class virtual +'b literal_map : object ... end

include sig ... end

class virtual +'b literal_iter : object ... end

type collection_op =

| Exists of {
1. predicate : lident Catala_utils.Marked.pos * expression;
}
| Forall of {
1. predicate : lident Catala_utils.Marked.pos * expression;
}
| Map of {
1. f : lident Catala_utils.Marked.pos * expression;
}
| Filter of {
1. f : lident Catala_utils.Marked.pos * expression;
}
| AggregateSum of {
1. typ : primitive_typ;
}
| AggregateExtremum of {
1. max : bool;
2. default : expression;
}
| AggregateArgExtremum of {
1. max : bool;
2. default : expression;
3. f : lident Catala_utils.Marked.pos * expression;
}

and explicit_match_case = {

match_case_pattern : match_case_pattern Catala_utils.Marked.pos;
match_case_expr : expression;

}

and match_case =

| WildCard of expression
| MatchCase of explicit_match_case

and match_cases = match_case Catala_utils.Marked.pos list

and expression = naked_expression Catala_utils.Marked.pos

and naked_expression =

| Paren of expression
| MatchWith of expression * match_cases Catala_utils.Marked.pos
| IfThenElse of expression * expression * expression
| Binop of binop Catala_utils.Marked.pos * expression * expression
| Unop of unop Catala_utils.Marked.pos * expression
| CollectionOp of collection_op * expression
| MemCollection of expression * expression
| TestMatchCase of expression * match_case_pattern Catala_utils.Marked.pos
| FunCall of expression * expression list
| ScopeCall of (path * uident Catala_utils.Marked.pos) Catala_utils.Marked.pos * (lident Catala_utils.Marked.pos * expression) list
| LetIn of lident Catala_utils.Marked.pos * expression * expression
| Builtin of builtin_expression
| Literal of literal
| EnumInject of (path * uident Catala_utils.Marked.pos) Catala_utils.Marked.pos * expression option
| StructLit of (path * uident Catala_utils.Marked.pos) Catala_utils.Marked.pos * (lident Catala_utils.Marked.pos * expression) list
| ArrayLit of expression list
| Ident of path * lident Catala_utils.Marked.pos
| Dotted of expression * (path * lident Catala_utils.Marked.pos) Catala_utils.Marked.pos
(*
Dotted is for both struct field projection and sub-scope variables
*)

include sig ... end

class virtual +'b expression_map : object ... end

include sig ... end

class virtual +'b expression_iter : object ... end

type exception_to =

| NotAnException
| UnlabeledException
| ExceptionToLabel of lident Catala_utils.Marked.pos

include sig ... end

class virtual +'b exception_to_map : object ... end

include sig ... end

class virtual +'b exception_to_iter : object ... end

type rule = {

rule_label : lident Catala_utils.Marked.pos option;
rule_exception_to : exception_to;
rule_parameter : lident Catala_utils.Marked.pos list Catala_utils.Marked.pos option;
rule_condition : expression option;
rule_name : scope_var Catala_utils.Marked.pos;
rule_id : Shared_ast.RuleName.t;
rule_consequence : bool Catala_utils.Marked.pos;
rule_state : lident Catala_utils.Marked.pos option;

}

include sig ... end

class virtual +'b rule_map : object ... end

include sig ... end

class virtual +'b rule_iter : object ... end

type definition = {

definition_label : lident Catala_utils.Marked.pos option;
definition_exception_to : exception_to;
definition_name : scope_var Catala_utils.Marked.pos;
definition_parameter : lident Catala_utils.Marked.pos list Catala_utils.Marked.pos option;
definition_condition : expression option;
definition_id : Shared_ast.RuleName.t;
definition_expr : expression;
definition_state : lident Catala_utils.Marked.pos option;

}

include sig ... end

class virtual +'b definition_map : object ... end

include sig ... end

class virtual +'b definition_iter : object ... end

type variation_typ =

| Increasing
| Decreasing

include sig ... end

class virtual +'a variation_typ_map : object ... end

include sig ... end

class virtual +'a variation_typ_iter : object ... end

type meta_assertion =

| FixedBy of scope_var Catala_utils.Marked.pos * lident Catala_utils.Marked.pos
| VariesWith of scope_var Catala_utils.Marked.pos * expression * variation_typ Catala_utils.Marked.pos option

include sig ... end

class virtual +'b meta_assertion_map : object ... end

include sig ... end

class virtual +'b meta_assertion_iter : object ... end

type assertion = {

assertion_condition : expression option;
assertion_content : expression;

}

include sig ... end

class virtual +'b assertion_map : object ... end

include sig ... end

class virtual +'b assertion_iter : object ... end

type scope_use_item =

| Rule of rule
| Definition of definition
| Assertion of assertion
| MetaAssertion of meta_assertion

include sig ... end

class virtual +'b scope_use_item_map : object ... end

include sig ... end

class virtual +'b scope_use_item_iter : object ... end

type scope_use = {

scope_use_condition : expression option;
scope_use_name : uident Catala_utils.Marked.pos;
scope_use_items : scope_use_item Catala_utils.Marked.pos list;

}

include sig ... end

class virtual +'b scope_use_map : object ... end

include sig ... end

class virtual +'b scope_use_iter : object ... end

type io_input =

| Input
| Context
| Internal

include sig ... end

class virtual +'a io_input_map : object ... end

include sig ... end

class virtual +'a io_input_iter : object ... end

type scope_decl_context_io = {

scope_decl_context_io_input : io_input Catala_utils.Marked.pos;
scope_decl_context_io_output : bool Catala_utils.Marked.pos;

}

include sig ... end

class virtual +'b scope_decl_context_io_map : object ... end

include sig ... end

class virtual +'b scope_decl_context_io_iter : object ... end

type scope_decl_context_scope = {

scope_decl_context_scope_name : lident Catala_utils.Marked.pos;
scope_decl_context_scope_sub_scope : uident Catala_utils.Marked.pos;
scope_decl_context_scope_attribute : scope_decl_context_io;

}

include sig ... end

class virtual +'b scope_decl_context_scope_map : object ... end

include sig ... end

class virtual +'b scope_decl_context_scope_iter : object ... end

type scope_decl_context_data = {

scope_decl_context_item_name : lident Catala_utils.Marked.pos;
scope_decl_context_item_typ : typ;
scope_decl_context_item_parameters : (lident Catala_utils.Marked.pos * typ) list Catala_utils.Marked.pos option;
scope_decl_context_item_attribute : scope_decl_context_io;
scope_decl_context_item_states : lident Catala_utils.Marked.pos list;

}

include sig ... end

class virtual +'b scope_decl_context_data_map : object ... end

include sig ... end

class virtual +'b scope_decl_context_data_iter : object ... end

type scope_decl_context_item =

| ContextData of scope_decl_context_data
| ContextScope of scope_decl_context_scope

include sig ... end

class virtual +'b scope_decl_context_item_map : object ... end

include sig ... end

class virtual +'b scope_decl_context_item_iter : object ... end

type scope_decl = {

scope_decl_name : uident Catala_utils.Marked.pos;
scope_decl_context : scope_decl_context_item Catala_utils.Marked.pos list;

}

include sig ... end

class virtual +'b scope_decl_map : object ... end

include sig ... end

class virtual +'b scope_decl_iter : object ... end

type top_def = {

topdef_name : lident Catala_utils.Marked.pos;
topdef_args : (lident Catala_utils.Marked.pos * base_typ Catala_utils.Marked.pos) list Catala_utils.Marked.pos option;
(*
Empty list if this is not a function
*)
topdef_type : typ;
topdef_expr : expression;

}

include sig ... end

class virtual +'b top_def_map : object ... end

include sig ... end

class virtual +'b top_def_iter : object ... end

type code_item =

| ScopeUse of scope_use
| ScopeDecl of scope_decl
| StructDecl of struct_decl
| EnumDecl of enum_decl
| Topdef of top_def

include sig ... end

class virtual +'b code_item_map : object ... end

include sig ... end

class virtual +'b code_item_iter : object ... end

type code_block = code_item Catala_utils.Marked.pos list

include sig ... end

class virtual +'b code_block_map : object ... end

include sig ... end

class virtual +'b code_block_iter : object ... end

type source_repr = string Catala_utils.Marked.pos

include sig ... end

class virtual +'b source_repr_map : object ... end

include sig ... end

class virtual +'b source_repr_iter : object ... end

type law_heading = {

law_heading_name : string Catala_utils.Marked.pos;
law_heading_id : string option;
law_heading_is_archive : bool;
law_heading_precedence : int;

}

include sig ... end

class virtual +'b law_heading_map : object ... end

include sig ... end

class virtual +'b law_heading_iter : object ... end

type law_include =

| PdfFile of string Catala_utils.Marked.pos * int option
| CatalaFile of string Catala_utils.Marked.pos
| LegislativeText of string Catala_utils.Marked.pos

include sig ... end

class virtual +'b law_include_map : object ... end

include sig ... end

class virtual +'b law_include_iter : object ... end

type law_structure =

| LawInclude of law_include
| LawHeading of law_heading * law_structure list
| LawText of string
| CodeBlock of code_block * source_repr * bool

include sig ... end

class virtual +'b law_structure_map : object ... end

include sig ... end

class virtual +'b law_structure_iter : object ... end

type program = {

program_items : law_structure list;
program_source_files : string list;

}

include sig ... end

class virtual +'b program_map : object ... end

include sig ... end

class virtual +'b program_iter : object ... end

type source_file = law_structure list

Helpers

val rule_to_def : rule -> definition

Translates a rule into the corresponding definition

val type_from_args : 
  (lident Catala_utils.Marked.pos * base_typ Catala_utils.Marked.pos) list
    Catala_utils.Marked.pos
    option ->
  base_typ Catala_utils.Marked.pos ->
  typ