package catala

  1. Overview
  2. Docs
Low-level language for tax code specification

Install

Dune Dependency

github.com Readme Edit opam file Versions (8)

Authors

  1. D
    Denis Merigoux

Maintainers

  1. C
    contact@catala-lang.org

Sources

0.2.0.tar.gz
md5=4c6f725ef4d21c5ff91f60d74b454ef7
sha512=98806e03daa6f33740b80a0f78a37320fb70ebea8cb927ea8fed022673459189c32e2389ccba0fa25d93f754b0fa0128a5ee28e1bb9abefa330deb4be8cc7d95

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

Module Surface.AstSource

Abstract syntax tree built by the Catala parser

Sourcemodule Pos = Utils.Pos
Sourcetype constructor = string

Constructors are CamlCase

Sourcetype ident = string

Idents are snake_case

Sourcetype qident = ident Pos.marked list
Sourcetype primitive_typ =
  1. | Integer
  2. | Decimal
  3. | Boolean
  4. | Money
  5. | Duration
  6. | Text
  7. | Date
  8. | Named of constructor
Sourcetype base_typ_data =
  1. | Primitive of primitive_typ
  2. | Collection of base_typ_data Pos.marked
  3. | Optional of base_typ_data Pos.marked
Sourcetype base_typ =
  1. | Condition
  2. | Data of base_typ_data
Sourcetype func_typ = {
  1. arg_typ : base_typ Pos.marked;
  2. return_typ : base_typ Pos.marked;
}
Sourcetype typ =
  1. | Base of base_typ
  2. | Func of func_typ
Sourcetype struct_decl_field = {
  1. struct_decl_field_name : ident Pos.marked;
  2. struct_decl_field_typ : typ Pos.marked;
}
Sourcetype struct_decl = {
  1. struct_decl_name : constructor Pos.marked;
  2. struct_decl_fields : struct_decl_field Pos.marked list;
}
Sourcetype enum_decl_case = {
  1. enum_decl_case_name : constructor Pos.marked;
  2. enum_decl_case_typ : typ Pos.marked option;
}
Sourcetype enum_decl = {
  1. enum_decl_name : constructor Pos.marked;
  2. enum_decl_cases : enum_decl_case Pos.marked list;
}
Sourcetype match_case_pattern = constructor Pos.marked list * ident Pos.marked option
Sourcetype op_kind =
  1. | KInt
    (*

    No suffix

    *)
  2. | KDec
    (*

    Suffix: .

    *)
  3. | KMoney
    (*

    Suffix: $

    *)
  4. | KDate
    (*

    Suffix: @

    *)
  5. | KDuration
    (*

    Suffix: ^

    *)
Sourcetype binop =
  1. | And
  2. | Or
  3. | Add of op_kind
  4. | Sub of op_kind
  5. | Mult of op_kind
  6. | Div of op_kind
  7. | Lt of op_kind
  8. | Lte of op_kind
  9. | Gt of op_kind
  10. | Gte of op_kind
  11. | Eq
  12. | Neq
Sourcetype unop =
  1. | Not
  2. | Minus of op_kind
Sourcetype builtin_expression =
  1. | Cardinal
  2. | Now
Sourcetype aggregate_func =
  1. | AggregateSum
  2. | AggregateCount
Sourcetype literal_date = {
  1. literal_date_day : int Pos.marked;
  2. literal_date_month : int Pos.marked;
  3. literal_date_year : int Pos.marked;
}
Sourcetype literal_number =
  1. | Int of Z.t
  2. | Dec of Z.t * Z.t
Sourcetype literal_unit =
  1. | Percent
  2. | Year
  3. | Month
  4. | Day
Sourcetype collection_op =
  1. | Exists
  2. | Forall
  3. | Aggregate of aggregate_func
Sourcetype money_amount = {
  1. money_amount_units : Z.t;
  2. money_amount_cents : Z.t;
}
Sourcetype literal =
  1. | Number of literal_number Pos.marked * literal_unit Pos.marked option
  2. | Bool of bool
  3. | MoneyAmount of money_amount
  4. | Date of literal_date
Sourcetype match_case = {
  1. match_case_pattern : match_case_pattern Pos.marked;
  2. match_case_expr : expression Pos.marked;
}
Sourceand match_cases = match_case Pos.marked list
Sourceand expression =
  1. | MatchWith of expression Pos.marked * match_cases Pos.marked
  2. | IfThenElse of expression Pos.marked * expression Pos.marked * expression Pos.marked
  3. | Binop of binop Pos.marked * expression Pos.marked * expression Pos.marked
  4. | Unop of unop Pos.marked * expression Pos.marked
  5. | CollectionOp of collection_op Pos.marked * ident Pos.marked * expression Pos.marked * expression Pos.marked
  6. | MemCollection of expression Pos.marked * expression Pos.marked
  7. | TestMatchCase of expression Pos.marked * constructor Pos.marked
  8. | FunCall of expression Pos.marked * expression Pos.marked
  9. | Builtin of builtin_expression
  10. | Literal of literal
  11. | EnumInject of constructor Pos.marked * expression Pos.marked option
  12. | EnumProject of expression Pos.marked * constructor Pos.marked
  13. | StructLit of constructor Pos.marked * (ident Pos.marked * expression Pos.marked) list
  14. | Ident of ident
  15. | Dotted of expression Pos.marked * ident Pos.marked
    (*

    Dotted is for both struct field projection and sub-scope variables

    *)
Sourcetype rule = {
  1. rule_label : ident Pos.marked option;
  2. rule_exception_to : ident Pos.marked option;
  3. rule_parameter : ident Pos.marked option;
  4. rule_condition : expression Pos.marked option;
  5. rule_name : qident Pos.marked;
  6. rule_consequence : bool Pos.marked;
}
Sourcetype definition = {
  1. definition_label : ident Pos.marked option;
  2. definition_exception_to : ident Pos.marked option;
  3. definition_name : qident Pos.marked;
  4. definition_parameter : ident Pos.marked option;
  5. definition_condition : expression Pos.marked option;
  6. definition_expr : expression Pos.marked;
}
Sourcetype variation_typ =
  1. | Increasing
  2. | Decreasing
Sourcetype meta_assertion =
  1. | FixedBy of qident Pos.marked * ident Pos.marked
  2. | VariesWith of qident Pos.marked * expression Pos.marked * variation_typ Pos.marked option
Sourcetype assertion = {
  1. assertion_condition : expression Pos.marked option;
  2. assertion_content : expression Pos.marked;
}
Sourcetype scope_use_item =
  1. | Rule of rule
  2. | Definition of definition
  3. | Assertion of assertion
  4. | MetaAssertion of meta_assertion
Sourcetype scope_use = {
  1. scope_use_condition : expression Pos.marked option;
  2. scope_use_name : constructor Pos.marked;
  3. scope_use_items : scope_use_item Pos.marked list;
}
Sourcetype scope_decl_context_scope = {
  1. scope_decl_context_scope_name : ident Pos.marked;
  2. scope_decl_context_scope_sub_scope : constructor Pos.marked;
}
Sourcetype scope_decl_context_data = {
  1. scope_decl_context_item_name : ident Pos.marked;
  2. scope_decl_context_item_typ : typ Pos.marked;
}
Sourcetype scope_decl_context_item =
  1. | ContextData of scope_decl_context_data
  2. | ContextScope of scope_decl_context_scope
Sourcetype scope_decl = {
  1. scope_decl_name : constructor Pos.marked;
  2. scope_decl_context : scope_decl_context_item Pos.marked list;
}
Sourcetype code_item =
  1. | ScopeUse of scope_use
  2. | ScopeDecl of scope_decl
  3. | StructDecl of struct_decl
  4. | EnumDecl of enum_decl
Sourcetype code_block = code_item Pos.marked list
Sourcetype source_repr = string Pos.marked
Sourcetype law_article = {
  1. law_article_name : string Pos.marked;
  2. law_article_id : string option;
  3. law_article_expiration_date : string option;
}
Sourcetype law_include =
  1. | PdfFile of string Pos.marked * int option
  2. | CatalaFile of string Pos.marked
  3. | LegislativeText of string Pos.marked
Sourcetype law_article_item =
  1. | LawText of string
  2. | CodeBlock of code_block * source_repr
Sourcetype law_heading = {
  1. law_heading_name : string;
  2. law_heading_precedence : int;
}
Sourcetype law_structure =
  1. | LawInclude of law_include
  2. | LawHeading of law_heading * law_structure list
  3. | LawArticle of law_article * law_article_item list
  4. | MetadataBlock of code_block * source_repr
  5. | IntermediateText of string
Sourcetype program_item =
  1. | LawStructure of law_structure
Sourcetype program = {
  1. program_items : program_item list;
  2. program_source_files : string list;
}
Sourcetype source_file_or_master =
  1. | SourceFile of program_item list
  2. | MasterFile of string Pos.marked list
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct