Module `Surface.Name_resolution`Source

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

Sourcemodule Pos = Utils.Pos

Sourcemodule Errors = Utils.Errors

Name resolution context

Sourcetype ident = string

Sourcetype typ = Scopelang.Ast.typ

Sourcetype scope_context = {

var_idmap : Scopelang.Ast.ScopeVar.t Desugared.Ast.IdentMap.t;
(*
Scope variables
*)
label_idmap : Desugared.Ast.RuleName.t Desugared.Ast.IdentMap.t;
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.

Sourcetype struct_context = typ Pos.marked Scopelang.Ast.StructFieldMap.t

Types of the fields of a struct

Sourcetype enum_context = typ Pos.marked Scopelang.Ast.EnumConstructorMap.t

Types of the payloads of the cases of an enum

Sourcetype context = {

local_var_idmap : Scopelang.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 : typ Pos.marked Scopelang.Ast.ScopeVarMap.t;
(*
The types of each scope variable declared
*)

}

Main context used throughout Surface.Desugaring

Helpers

Sourceval raise_unsupported_feature : string -> Pos.t -> 'a

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

Sourceval raise_unknown_identifier : string -> ident Pos.marked -> 'a

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

Sourceval get_var_typ : context -> Scopelang.Ast.ScopeVar.t -> typ Pos.marked

Gets the type associated to an uid

Source

val get_var_uid : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  ident Pos.marked ->
  Scopelang.Ast.ScopeVar.t

Get the variable uid inside the scope given in argument

Source

val get_subscope_uid : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  ident Pos.marked ->
  Scopelang.Ast.SubScopeName.t

Get the subscope uid inside the scope given in argument

Sourceval 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.

Source

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

Checks if the var_uid belongs to the scope scope_uid

Sourceval get_def_typ : context -> Desugared.Ast.ScopeDef.t -> typ Pos.marked

Retrieves the type of a scope definition from the context

Declarations pass

Source

val process_subscope_decl : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  Ast.scope_decl_context_scope ->
  context

Process a subscope declaration

Source

val process_base_typ : 
  context ->
  Ast.base_typ Pos.marked ->
  Scopelang.Ast.typ Pos.marked

Process a basic type (all types except function types)

Source

val process_type : 
  context ->
  Ast.typ Pos.marked ->
  Scopelang.Ast.typ Pos.marked

Process a type (function or not)

Source

val process_data_decl : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  Ast.scope_decl_context_data ->
  context

Process data declaration

Source

val process_item_decl : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  Ast.scope_decl_context_item ->
  context

Process an item declaration

Source

val add_def_local_var : 
  context ->
  ident Pos.marked ->
  context * Scopelang.Ast.Var.t

Adds a binding to the context

Sourceval process_scope_decl : context -> Ast.scope_decl -> context

Process a scope declaration

Sourceval process_struct_decl : context -> Ast.struct_decl -> context

Process a struct declaration

Sourceval process_enum_decl : context -> Ast.enum_decl -> context

Process an enum declaration

Sourceval process_decl_item : context -> Ast.code_item Pos.marked -> context

Process a code item that is a declaration

Source

val process_code_block : 
  context ->
  Ast.code_block ->
  (context -> Ast.code_item Pos.marked -> context) ->
  context

Process a code block

Source

val process_law_article_item : 
  context ->
  Ast.law_article_item ->
  (context -> Ast.code_item Pos.marked -> context) ->
  context

Process a law article item, only considering the code blocks

Source

val process_law_structure : 
  context ->
  Ast.law_structure ->
  (context -> Ast.code_item Pos.marked -> context) ->
  context

Process a law structure, only considering the code blocks

Source

val process_program_item : 
  context ->
  Ast.program_item ->
  (context -> Ast.code_item Pos.marked -> context) ->
  context

Process a program item, only considering the code blocks

Scope uses pass

Sourceval process_rule : context -> Scopelang.Ast.ScopeName.t -> Ast.rule -> context

Source

val process_definition : 
  context ->
  Scopelang.Ast.ScopeName.t ->
  Ast.definition ->
  context

Source

val process_scope_use_item : 
  Scopelang.Ast.ScopeName.t ->
  context ->
  Ast.scope_use_item Pos.marked ->
  context

Sourceval process_scope_use : context -> Ast.scope_use -> context

Sourceval process_use_item : context -> Ast.code_item Pos.marked -> context

API

Sourceval form_context : Ast.program -> context

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

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `Surface.Name_resolution`Source

Name resolution context

Helpers

Declarations pass

Scope uses pass

API

package catala

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Surface.Name_resolutionSource

Name resolution context

Helpers

Declarations pass

Scope uses pass

API

Module `Surface.Name_resolution`Source