Module `Surface.Ast`Source

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

Sourcetype constructor = string

Constructors are CamelCase

include sig ... end

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

include sig ... end

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

Sourcetype ident = string

Idents are snake_case

include sig ... end

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

include sig ... end

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

Sourcetype qident = ident Utils.Pos.marked list

include sig ... end

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

include sig ... end

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

Sourcetype primitive_typ =

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

include sig ... end

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

include sig ... end

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

Sourcetype base_typ_data =

| Primitive of primitive_typ
| Collection of base_typ_data Utils.Pos.marked

include sig ... end

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

include sig ... end

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

Sourcetype base_typ =

| Condition
| Data of base_typ_data

include sig ... end

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

include sig ... end

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

Sourcetype func_typ = {

arg_typ : base_typ Utils.Pos.marked;
return_typ : base_typ Utils.Pos.marked;

}

include sig ... end

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

include sig ... end

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

Sourcetype typ =

| Base of base_typ
| Func of func_typ

include sig ... end

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

include sig ... end

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

Sourcetype struct_decl_field = {

struct_decl_field_name : ident Utils.Pos.marked;
struct_decl_field_typ : typ Utils.Pos.marked;

}

include sig ... end

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

include sig ... end

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

Sourcetype struct_decl = {

struct_decl_name : constructor Utils.Pos.marked;
struct_decl_fields : struct_decl_field Utils.Pos.marked list;

}

include sig ... end

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

include sig ... end

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

Sourcetype enum_decl_case = {

enum_decl_case_name : constructor Utils.Pos.marked;
enum_decl_case_typ : typ Utils.Pos.marked option;

}

include sig ... end

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

include sig ... end

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

Sourcetype enum_decl = {

enum_decl_name : constructor Utils.Pos.marked;
enum_decl_cases : enum_decl_case Utils.Pos.marked list;

}

include sig ... end

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

include sig ... end

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

Source

type match_case_pattern =
  (constructor Utils.Pos.marked option * constructor Utils.Pos.marked) list
  * ident Utils.Pos.marked option

include sig ... end

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

include sig ... end

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

Sourcetype op_kind =

| KInt
| KDec
| KMoney
| KDate
| KDuration

include sig ... end

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

include sig ... end

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

Sourcetype 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

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

include sig ... end

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

Sourcetype unop =

| Not
| Minus of op_kind

include sig ... end

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

include sig ... end

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

Sourcetype builtin_expression =

| Cardinal
| IntToDec
| GetDay
| GetMonth
| GetYear

include sig ... end

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

include sig ... end

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

Sourcetype literal_date = {

literal_date_day : int Utils.Pos.marked;
literal_date_month : int Utils.Pos.marked;
literal_date_year : int Utils.Pos.marked;

}

include sig ... end

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

include sig ... end

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

Sourcetype literal_number =

| Int of Runtime.integer
| Dec of Runtime.integer * Runtime.integer

include sig ... end

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

include sig ... end

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

Sourcetype literal_unit =

| Percent
| Year
| Month
| Day

include sig ... end

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

include sig ... end

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

Sourcetype money_amount = {

money_amount_units : Runtime.integer;
money_amount_cents : Runtime.integer;

}

include sig ... end

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

include sig ... end

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

Sourcetype literal =

| LNumber of literal_number Utils.Pos.marked * literal_unit Utils.Pos.marked option
| LBool of bool
| LMoneyAmount of money_amount
| LDate of literal_date

include sig ... end

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

include sig ... end

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

Sourcetype aggregate_func =

| AggregateSum of primitive_typ
| AggregateCount
| AggregateExtremum of bool * primitive_typ * expression Utils.Pos.marked
| AggregateArgExtremum of bool * primitive_typ * expression Utils.Pos.marked

Sourceand collection_op =

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

Sourceand explicit_match_case = {

match_case_pattern : match_case_pattern Utils.Pos.marked;
match_case_expr : expression Utils.Pos.marked;

}

Sourceand match_case =

| WildCard of expression Utils.Pos.marked
| MatchCase of explicit_match_case

Sourceand match_cases = match_case Utils.Pos.marked list

Sourceand expression =

| MatchWith of expression Utils.Pos.marked * match_cases Utils.Pos.marked
| IfThenElse of expression Utils.Pos.marked * expression Utils.Pos.marked * expression Utils.Pos.marked
| Binop of binop Utils.Pos.marked * expression Utils.Pos.marked * expression Utils.Pos.marked
| Unop of unop Utils.Pos.marked * expression Utils.Pos.marked
| CollectionOp of collection_op Utils.Pos.marked * ident Utils.Pos.marked * expression Utils.Pos.marked * expression Utils.Pos.marked
| MemCollection of expression Utils.Pos.marked * expression Utils.Pos.marked
| TestMatchCase of expression Utils.Pos.marked * match_case_pattern Utils.Pos.marked
| FunCall of expression Utils.Pos.marked * expression Utils.Pos.marked
| Builtin of builtin_expression
| Literal of literal
| EnumInject of constructor Utils.Pos.marked option * constructor Utils.Pos.marked * expression Utils.Pos.marked option
| StructLit of constructor Utils.Pos.marked * (ident Utils.Pos.marked * expression Utils.Pos.marked) list
| ArrayLit of expression Utils.Pos.marked list
| Ident of ident
| Dotted of expression Utils.Pos.marked * constructor Utils.Pos.marked option * ident Utils.Pos.marked
(*
Dotted is for both struct field projection and sub-scope variables
*)

include sig ... end

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

include sig ... end

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

Sourcetype exception_to =

| NotAnException
| UnlabeledException
| ExceptionToLabel of ident Utils.Pos.marked

include sig ... end

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

include sig ... end

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

Sourcetype rule = {

rule_label : ident Utils.Pos.marked option;
rule_exception_to : exception_to;
rule_parameter : ident Utils.Pos.marked option;
rule_condition : expression Utils.Pos.marked option;
rule_name : qident Utils.Pos.marked;
rule_id : Desugared.Ast.RuleName.t;
rule_consequence : bool Utils.Pos.marked;
rule_state : ident Utils.Pos.marked option;

}

include sig ... end

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

include sig ... end

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

Sourcetype definition = {

definition_label : ident Utils.Pos.marked option;
definition_exception_to : exception_to;
definition_name : qident Utils.Pos.marked;
definition_parameter : ident Utils.Pos.marked option;
definition_condition : expression Utils.Pos.marked option;
definition_id : Desugared.Ast.RuleName.t;
definition_expr : expression Utils.Pos.marked;
definition_state : ident Utils.Pos.marked option;

}

include sig ... end

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

include sig ... end

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

Sourcetype variation_typ =

| Increasing
| Decreasing

include sig ... end

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

include sig ... end

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

Sourcetype meta_assertion =

| FixedBy of qident Utils.Pos.marked * ident Utils.Pos.marked
| VariesWith of qident Utils.Pos.marked * expression Utils.Pos.marked * variation_typ Utils.Pos.marked option

include sig ... end

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

include sig ... end

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

Sourcetype assertion = {

assertion_condition : expression Utils.Pos.marked option;
assertion_content : expression Utils.Pos.marked;

}

include sig ... end

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

include sig ... end

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

Sourcetype scope_use_item =

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

include sig ... end

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

include sig ... end

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

Sourcetype scope_use = {

scope_use_condition : expression Utils.Pos.marked option;
scope_use_name : constructor Utils.Pos.marked;
scope_use_items : scope_use_item Utils.Pos.marked list;

}

include sig ... end

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

include sig ... end

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

Sourcetype io_input =

| Input
| Context
| Internal

include sig ... end

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

include sig ... end

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

Sourcetype scope_decl_context_io = {

scope_decl_context_io_input : io_input Utils.Pos.marked;
scope_decl_context_io_output : bool Utils.Pos.marked;

}

include sig ... end

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

include sig ... end

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

Sourcetype scope_decl_context_scope = {

scope_decl_context_scope_name : ident Utils.Pos.marked;
scope_decl_context_scope_sub_scope : constructor Utils.Pos.marked;
scope_decl_context_scope_attribute : scope_decl_context_io;

}

include sig ... end

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

include sig ... end

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

Sourcetype scope_decl_context_data = {

scope_decl_context_item_name : ident Utils.Pos.marked;
scope_decl_context_item_typ : typ Utils.Pos.marked;
scope_decl_context_item_attribute : scope_decl_context_io;
scope_decl_context_item_states : ident Utils.Pos.marked list;

}

include sig ... end

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

include sig ... end

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

Sourcetype scope_decl_context_item =

| ContextData of scope_decl_context_data
| ContextScope of scope_decl_context_scope

include sig ... end

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

include sig ... end

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

Sourcetype scope_decl = {

scope_decl_name : constructor Utils.Pos.marked;
scope_decl_context : scope_decl_context_item Utils.Pos.marked list;

}

include sig ... end

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

include sig ... end

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

Sourcetype code_item =

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

include sig ... end

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

include sig ... end

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

Sourcetype code_block = code_item Utils.Pos.marked list

include sig ... end

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

include sig ... end

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

Sourcetype source_repr = string Utils.Pos.marked

include sig ... end

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

include sig ... end

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

Sourcetype law_heading = {

law_heading_name : string Utils.Pos.marked;
law_heading_id : string option;
law_heading_expiration_date : string option;
law_heading_precedence : int;

}

include sig ... end

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

include sig ... end

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

Sourcetype law_include =

| PdfFile of string Utils.Pos.marked * int option
| CatalaFile of string Utils.Pos.marked
| LegislativeText of string Utils.Pos.marked

include sig ... end

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

include sig ... end

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

Sourcetype 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

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

include sig ... end

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

Sourcetype program = {

program_items : law_structure list;
program_source_files : string list;

}

include sig ... end

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

include sig ... end

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

Sourcetype source_file = law_structure list

Helpers

Sourceval rule_to_def : rule -> definition

Translates a rule into the corresponding definition

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.surface/Surface/Ast/index.html

Module `Surface.Ast`Source

Type definitions

Helpers

package catala

Install

Dune Dependency

Authors

Maintainers

Sources

doc/catala.surface/Surface/Ast/index.html

Module Surface.AstSource

Type definitions

Helpers

Module `Surface.Ast`Source