package catala

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Name resolution context
Helpers
API

package catala

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

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

Name resolution context

type ident = string

type typ = Scopelang.Ast.typ

type unique_rulename =

| Ambiguous of Utils.Pos.t list
| Unique of Desugared.Ast.RuleName.t Utils.Marked.pos

type scope_def_context = {

default_exception_rulename : unique_rulename option;
label_idmap : Desugared.Ast.LabelName.t Desugared.Ast.IdentMap.t;

}

type scope_context = {

var_idmap : Desugared.Ast.ScopeVar.t Desugared.Ast.IdentMap.t;
(*
Scope variables
*)
scope_defs_contexts : scope_def_context Desugared.Ast.ScopeDefMap.t;
(*
What is the default rule to refer to for unnamed exceptions, if any
*)
sub_scopes_idmap : Scopelang.Ast.SubScopeName.t Desugared.Ast.IdentMap.t;
(*
Sub-scopes variables
*)
sub_scopes : Scopelang.Ast.ScopeName.t Scopelang.Ast.SubScopeMap.t;
(*
To what scope sub-scopes refer to?
*)

}

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

type struct_context = typ Utils.Marked.pos Scopelang.Ast.StructFieldMap.t

Types of the fields of a struct

type enum_context = typ Utils.Marked.pos Scopelang.Ast.EnumConstructorMap.t

Types of the payloads of the cases of an enum

type var_sig = {

var_sig_typ : typ Utils.Marked.pos;
var_sig_is_condition : bool;
var_sig_io : Ast.scope_decl_context_io;
var_sig_states_idmap : Desugared.Ast.StateName.t Desugared.Ast.IdentMap.t;
var_sig_states_list : Desugared.Ast.StateName.t list;

}

type context = {

local_var_idmap : Desugared.Ast.Var.t Desugared.Ast.IdentMap.t;
(*
Inside a definition, local variables can be introduced by functions arguments or pattern matching
*)
scope_idmap : Scopelang.Ast.ScopeName.t Desugared.Ast.IdentMap.t;
(*
The names of the scopes
*)
struct_idmap : Scopelang.Ast.StructName.t Desugared.Ast.IdentMap.t;
(*
The names of the structs
*)
field_idmap : Scopelang.Ast.StructFieldName.t Scopelang.Ast.StructMap.t Desugared.Ast.IdentMap.t;
(*
The names of the struct fields. Names of fields can be shared between different structs
*)
enum_idmap : Scopelang.Ast.EnumName.t Desugared.Ast.IdentMap.t;
(*
The names of the enums
*)
constructor_idmap : Scopelang.Ast.EnumConstructor.t Scopelang.Ast.EnumMap.t Desugared.Ast.IdentMap.t;
(*
The names of the enum constructors. Constructor names can be shared between different enums
*)
scopes : scope_context Scopelang.Ast.ScopeMap.t;
(*
For each scope, its context
*)
structs : struct_context Scopelang.Ast.StructMap.t;
(*
For each struct, its context
*)
enums : enum_context Scopelang.Ast.EnumMap.t;
(*
For each enum, its context
*)
var_typs : var_sig Desugared.Ast.ScopeVarMap.t;
(*
The signatures of each scope variable declared
*)

}

Main context used throughout Surface.Desugaring

Helpers

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

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

val raise_unknown_identifier : string -> ident Utils.Marked.pos -> 'a

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

val get_var_typ : context -> Desugared.Ast.ScopeVar.t -> typ Utils.Marked.pos

Gets the type associated to an uid

val is_var_cond : context -> Desugared.Ast.ScopeVar.t -> bool

val get_var_io : 
  context ->
  Desugared.Ast.ScopeVar.t ->
  Ast.scope_decl_context_io

val get_var_uid : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  ident Utils.Marked.pos ->
  Desugared.Ast.ScopeVar.t

Get the variable uid inside the scope given in argument

val get_subscope_uid : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  ident Utils.Marked.pos ->
  Scopelang.Ast.SubScopeName.t

Get the subscope uid inside the scope given in argument

val is_subscope_uid : Scopelang.Ast.ScopeName.t -> context -> ident -> bool

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

val belongs_to : 
  context ->
  Desugared.Ast.ScopeVar.t ->
  Scopelang.Ast.ScopeName.t ->
  bool

Checks if the var_uid belongs to the scope scope_uid

val get_def_typ : context -> Desugared.Ast.ScopeDef.t -> typ Utils.Marked.pos

Retrieves the type of a scope definition from the context

val is_def_cond : context -> Desugared.Ast.ScopeDef.t -> bool

val is_type_cond : Ast.typ Utils.Marked.pos -> bool

val add_def_local_var : context -> ident -> context * Desugared.Ast.Var.t

Adds a binding to the context

val get_def_key : 
  Ast.qident ->
  Ast.ident Utils.Marked.pos option ->
  Scopelang.Ast.ScopeName.t ->
  context ->
  Utils.Pos.t ->
  Desugared.Ast.ScopeDef.t

Usage: get_def_key var_name var_state scope_uid ctxt pos

API

val form_context : Ast.program -> context

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