package catala

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

Abstract syntax tree of the scope language

Identifiers

module ScopeName = Dcalc.Ast.ScopeName
module ScopeNameSet : Stdlib.Set.S with type elt = ScopeName.t
module ScopeMap : Stdlib.Map.S with type key = ScopeName.t
module SubScopeNameSet : Stdlib.Set.S with type elt = SubScopeName.t
module SubScopeMap : Stdlib.Map.S with type key = SubScopeName.t
module ScopeVarSet : Stdlib.Set.S with type elt = ScopeVar.t
module ScopeVarMap : Stdlib.Map.S with type key = ScopeVar.t
module StructName = Dcalc.Ast.StructName
module StructMap = Dcalc.Ast.StructMap
module StructFieldName = Dcalc.Ast.StructFieldName
module StructFieldMap : Stdlib.Map.S with type key = StructFieldName.t
module StructFieldMapLift : sig ... end
module EnumName = Dcalc.Ast.EnumName
module EnumMap = Dcalc.Ast.EnumMap
module EnumConstructor = Dcalc.Ast.EnumConstructor
module EnumConstructorMap : Stdlib.Map.S with type key = EnumConstructor.t
module EnumConstructorMapLift : sig ... end
module LocationSet : Stdlib.Set.S with type elt = location Utils.Pos.marked

Abstract syntax tree

type typ =
  1. | TLit of Dcalc.Ast.typ_lit
  2. | TStruct of StructName.t
  3. | TEnum of EnumName.t
  4. | TArrow of typ Utils.Pos.marked * typ Utils.Pos.marked
  5. | TArray of typ
  6. | TAny
type expr =
  1. | ELocation of location
  2. | EVar of expr Bindlib.var Utils.Pos.marked
  3. | EStruct of StructName.t * expr Utils.Pos.marked StructFieldMap.t
  4. | EStructAccess of expr Utils.Pos.marked * StructFieldName.t * StructName.t
  5. | EEnumInj of expr Utils.Pos.marked * EnumConstructor.t * EnumName.t
  6. | EMatch of expr Utils.Pos.marked * EnumName.t * expr Utils.Pos.marked EnumConstructorMap.t
  7. | ELit of Dcalc.Ast.lit
  8. | EAbs of (expr, expr Utils.Pos.marked) Bindlib.mbinder Utils.Pos.marked * typ Utils.Pos.marked list
  9. | EApp of expr Utils.Pos.marked * expr Utils.Pos.marked list
  10. | EOp of Dcalc.Ast.operator
  11. | EDefault of expr Utils.Pos.marked list * expr Utils.Pos.marked * expr Utils.Pos.marked
  12. | EIfThenElse of expr Utils.Pos.marked * expr Utils.Pos.marked * expr Utils.Pos.marked
  13. | EArray of expr Utils.Pos.marked list
  14. | ErrorOnEmpty of expr Utils.Pos.marked

The expressions use the Bindlib library, based on higher-order abstract syntax

val locations_used : expr Utils.Pos.marked -> LocationSet.t
type io_input =
  1. | NoInput
    (*

    For an internal variable defined only in the scope, and does not appear in the input.

    *)
  2. | OnlyInput
    (*

    For variables that should not be redefined in the scope, because they appear in the input.

    *)
  3. | Reentrant
    (*

    For variables defined in the scope that can also be redefined by the caller as they appear in the input.

    *)

This type characterizes the three levels of visibility for a given scope variable with regards to the scope's input and possible redefinitions inside the scope..

type io = {
  1. io_output : bool Utils.Pos.marked;
    (*

    true is present in the output of the scope.

    *)
  2. io_input : io_input Utils.Pos.marked;
}

Characterization of the input/output status of a scope variable.

type scope_decl = {
  1. scope_decl_name : ScopeName.t;
  2. scope_sig : (typ Utils.Pos.marked * io) ScopeVarMap.t;
  3. scope_decl_rules : rule list;
}
type struct_ctx = (StructFieldName.t * typ Utils.Pos.marked) list StructMap.t
type enum_ctx = (EnumConstructor.t * typ Utils.Pos.marked) list EnumMap.t
type program = {
  1. program_scopes : scope_decl ScopeMap.t;
  2. program_enums : enum_ctx;
  3. program_structs : struct_ctx;
}

Variable helpers

module Var : sig ... end
module VarMap : Stdlib.Map.S with type key = Var.t
type vars = expr Bindlib.mvar
val make_var : Var.t Utils.Pos.marked -> expr Utils.Pos.marked Bindlib.box
val make_abs : vars -> expr Utils.Pos.marked Bindlib.box -> Utils.Pos.t -> typ Utils.Pos.marked list -> Utils.Pos.t -> expr Utils.Pos.marked Bindlib.box
val make_app : expr Utils.Pos.marked Bindlib.box -> expr Utils.Pos.marked Bindlib.box list -> Utils.Pos.t -> expr Utils.Pos.marked Bindlib.box
val make_let_in : Var.t -> typ Utils.Pos.marked -> expr Utils.Pos.marked Bindlib.box -> expr Utils.Pos.marked Bindlib.box -> expr Utils.Pos.marked Bindlib.box
OCaml

Innovation. Community. Security.