package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Type definitions
Helpers

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

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 constructor = string

Constructors are CamelCase

include sig ... end

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

include sig ... end

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

type ident = string

Idents are snake_case

include sig ... end

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

include sig ... end

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

type qident = ident Utils.Marked.pos list

include sig ... end

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

include sig ... end

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

type primitive_typ =

| Integer
| Decimal
| Boolean
| Money
| Duration
| Text
| Date
| Named of constructor

include sig ... end

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

include sig ... end

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

type base_typ_data =

| Primitive of primitive_typ
| Collection of base_typ_data 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 : base_typ Utils.Marked.pos;
return_typ : base_typ 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 =

| 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 : ident Utils.Marked.pos;
struct_decl_field_typ : typ Utils.Marked.pos;

}

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 : constructor Utils.Marked.pos;
struct_decl_fields : struct_decl_field 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 : constructor Utils.Marked.pos;
enum_decl_case_typ : typ Utils.Marked.pos 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 : constructor Utils.Marked.pos;
enum_decl_cases : enum_decl_case 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 =
  (constructor Utils.Marked.pos option * constructor Utils.Marked.pos) list
  * ident 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 =

| 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
| IntToDec
| MoneyToDec
| DecToMoney
| GetDay
| GetMonth
| GetYear
| LastDayOfMonth
| FirstDayOfMonth
| RoundMoney
| RoundDecimal

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 Utils.Marked.pos * literal_unit 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 aggregate_func =

| AggregateSum of primitive_typ
| AggregateCount
| AggregateExtremum of bool * primitive_typ * expression Utils.Marked.pos
| AggregateArgExtremum of bool * primitive_typ * expression Utils.Marked.pos

and collection_op =

| Exists
| Forall
| Aggregate of aggregate_func
| Map
| Filter

and explicit_match_case = {

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

}

and match_case =

| WildCard of expression Utils.Marked.pos
| MatchCase of explicit_match_case

and match_cases = match_case Utils.Marked.pos list

and expression =

| MatchWith of expression Utils.Marked.pos * match_cases Utils.Marked.pos
| IfThenElse of expression Utils.Marked.pos * expression Utils.Marked.pos * expression Utils.Marked.pos
| Binop of binop Utils.Marked.pos * expression Utils.Marked.pos * expression Utils.Marked.pos
| Unop of unop Utils.Marked.pos * expression Utils.Marked.pos
| CollectionOp of collection_op Utils.Marked.pos * ident Utils.Marked.pos * expression Utils.Marked.pos * expression Utils.Marked.pos
| MemCollection of expression Utils.Marked.pos * expression Utils.Marked.pos
| TestMatchCase of expression Utils.Marked.pos * match_case_pattern Utils.Marked.pos
| FunCall of expression Utils.Marked.pos * expression Utils.Marked.pos
| Builtin of builtin_expression
| Literal of literal
| EnumInject of constructor Utils.Marked.pos option * constructor Utils.Marked.pos * expression Utils.Marked.pos option
| StructLit of constructor Utils.Marked.pos * (ident Utils.Marked.pos * expression Utils.Marked.pos) list
| ArrayLit of expression Utils.Marked.pos list
| Ident of ident
| Dotted of expression Utils.Marked.pos * constructor Utils.Marked.pos option * ident 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 ident 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 : ident Utils.Marked.pos option;
rule_exception_to : exception_to;
rule_parameter : ident Utils.Marked.pos option;
rule_condition : expression Utils.Marked.pos option;
rule_name : qident Utils.Marked.pos;
rule_id : Desugared.Ast.RuleName.t;
rule_consequence : bool Utils.Marked.pos;
rule_state : ident 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 : ident Utils.Marked.pos option;
definition_exception_to : exception_to;
definition_name : qident Utils.Marked.pos;
definition_parameter : ident Utils.Marked.pos option;
definition_condition : expression Utils.Marked.pos option;
definition_id : Desugared.Ast.RuleName.t;
definition_expr : expression Utils.Marked.pos;
definition_state : ident 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 qident Utils.Marked.pos * ident Utils.Marked.pos
| VariesWith of qident Utils.Marked.pos * expression Utils.Marked.pos * variation_typ 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 Utils.Marked.pos option;
assertion_content : expression Utils.Marked.pos;

}

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 Utils.Marked.pos option;
scope_use_name : constructor Utils.Marked.pos;
scope_use_items : scope_use_item 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 Utils.Marked.pos;
scope_decl_context_io_output : bool 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 : ident Utils.Marked.pos;
scope_decl_context_scope_sub_scope : constructor 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 : ident Utils.Marked.pos;
scope_decl_context_item_typ : typ Utils.Marked.pos;
scope_decl_context_item_attribute : scope_decl_context_io;
scope_decl_context_item_states : ident 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 : constructor Utils.Marked.pos;
scope_decl_context : scope_decl_context_item 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 code_item =

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

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 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 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 Utils.Marked.pos;
law_heading_id : string option;
law_heading_expiration_date : string option;
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 Utils.Marked.pos * int option
| CatalaFile of string Utils.Marked.pos
| LegislativeText of string 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