package catala

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

Builds a context that allows for mapping each name to a precise uid, taking lexical scopes into account

Name resolution context

type unique_rulename =
  1. | Ambiguous of Catala_utils.Pos.t list
  2. | Unique of Shared_ast.RuleName.t Catala_utils.Marked.pos
type scope_def_context = {
  1. default_exception_rulename : unique_rulename option;
  2. label_idmap : Shared_ast.LabelName.t Shared_ast.IdentName.Map.t;
}
type scope_var_or_subscope =
  1. | ScopeVar of Shared_ast.ScopeVar.t
  2. | SubScope of Shared_ast.SubScopeName.t * Shared_ast.ScopeName.t
type scope_context = {
  1. var_idmap : scope_var_or_subscope Shared_ast.IdentName.Map.t;
    (*

    All variables, including scope variables and subscopes

    *)
  2. scope_defs_contexts : scope_def_context Desugared.Ast.ScopeDefMap.t;
    (*

    What is the default rule to refer to for unnamed exceptions, if any

    *)
  3. sub_scopes : Shared_ast.ScopeName.Set.t;
    (*

    Other scopes referred to by this scope. Used for dependency analysis

    *)
}

Inside a scope, we distinguish between the variables and the subscopes.

Types of the fields of a struct

Types of the payloads of the cases of an enum

type var_sig = {
  1. var_sig_typ : Shared_ast.typ;
  2. var_sig_is_condition : bool;
  3. var_sig_parameters : (Catala_utils.Uid.MarkedString.info * Shared_ast.typ) list Catala_utils.Marked.pos option;
  4. var_sig_io : Surface.Ast.scope_decl_context_io;
  5. var_sig_states_idmap : Shared_ast.StateName.t Shared_ast.IdentName.Map.t;
  6. var_sig_states_list : Shared_ast.StateName.t list;
}
type typedef =
  1. | TStruct of Shared_ast.StructName.t
  2. | TEnum of Shared_ast.EnumName.t
  3. | TScope of Shared_ast.ScopeName.t * Shared_ast.scope_out_struct
    (*

    Implicitly defined output struct

    *)

Capitalised type names share a namespace on the user side, but may correspond to only one of the following

type context = {
  1. local_var_idmap : Ast.expr Shared_ast.Var.t Shared_ast.IdentName.Map.t;
    (*

    Inside a definition, local variables can be introduced by functions arguments or pattern matching

    *)
  2. typedefs : typedef Shared_ast.IdentName.Map.t;
    (*

    Gathers the names of the scopes, structs and enums

    *)
  3. field_idmap : Shared_ast.StructField.t Shared_ast.StructName.Map.t Shared_ast.IdentName.Map.t;
    (*

    The names of the struct fields. Names of fields can be shared between different structs

    *)
  4. constructor_idmap : Shared_ast.EnumConstructor.t Shared_ast.EnumName.Map.t Shared_ast.IdentName.Map.t;
    (*

    The names of the enum constructors. Constructor names can be shared between different enums

    *)
  5. scopes : scope_context Shared_ast.ScopeName.Map.t;
    (*

    For each scope, its context

    *)
  6. topdefs : Shared_ast.TopdefName.t Shared_ast.IdentName.Map.t;
    (*

    Global definitions

    *)
  7. structs : struct_context Shared_ast.StructName.Map.t;
    (*

    For each struct, its context

    *)
  8. enums : enum_context Shared_ast.EnumName.Map.t;
    (*

    For each enum, its context

    *)
  9. var_typs : var_sig Shared_ast.ScopeVar.Map.t;
    (*

    The signatures of each scope variable declared

    *)
}

Main context used throughout Surface.Desugaring

Helpers

val raise_unsupported_feature : string -> Catala_utils.Pos.t -> 'a

Temporary function raising an error message saying that a feature is not supported yet

val raise_unknown_identifier : string -> Shared_ast.IdentName.t Catala_utils.Marked.pos -> 'a

Function to call whenever an identifier used somewhere has not been declared in the program previously

Gets the type associated to an uid

val is_var_cond : context -> Shared_ast.ScopeVar.t -> bool

Get the variable uid inside the scope given in argument

Get the subscope uid inside the scope given in argument

val is_subscope_uid : Shared_ast.ScopeName.t -> context -> Shared_ast.IdentName.t -> bool

is_subscope_uid scope_uid ctxt y returns true if y belongs to the subscopes of scope_uid.

Checks if the var_uid belongs to the scope scope_uid

val get_def_typ : context -> Ast.ScopeDef.t -> Shared_ast.typ

Retrieves the type of a scope definition from the context

val is_def_cond : context -> Ast.ScopeDef.t -> bool
val is_type_cond : Surface.Ast.typ -> bool

Adds a binding to the context

Usage: get_def_key var_name var_state scope_uid ctxt pos

Find an enum definition from the typedefs, failing if there is none or it has a different kind

Find a struct definition from the typedefs (possibly an implicit output struct from a scope), failing if there is none or it has a different kind

Find a scope definition from the typedefs, failing if there is none or it has a different kind

val process_type : context -> Surface.Ast.typ -> Shared_ast.typ

Convert a surface base type to an AST type

API

val form_context : Surface.Ast.program -> context

Derive the context from metadata, in one pass over the declarations