Module `Ocaml_typing.Env`

type value_unbound_reason =

| Val_unbound_instance_variable
| Val_unbound_self
| Val_unbound_ancestor
| Val_unbound_ghost_recursive of Ocaml_parsing.Location.t

type module_unbound_reason =

| Mod_unbound_illegal_recursion of {
1. container : string option;
2. unbound : string;
}

type locks

type summary =

| Env_empty
| Env_value of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.value_description * Ocaml_typing.Mode.Value.l
| Env_type of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.type_declaration
| Env_extension of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.extension_constructor
| Env_module of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.module_presence * Ocaml_typing.Types.module_declaration * Ocaml_typing.Mode.Value.l * Ocaml_typing.Env.locks
| Env_modtype of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.modtype_declaration
| Env_class of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.class_declaration
| Env_cltype of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t * Ocaml_typing.Types.class_type_declaration
| Env_open of Ocaml_typing.Env.summary * Ocaml_typing.Path.t
(*
The string set argument of Env_open represents a list of module names to skip, i.e. that won't be imported in the toplevel namespace.
*)
| Env_functor_arg of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t
| Env_constraints of Ocaml_typing.Env.summary * Ocaml_typing.Types.type_declaration Ocaml_typing.Path.Map.t
| Env_copy_types of Ocaml_typing.Env.summary
| Env_persistent of Ocaml_typing.Env.summary * Ocaml_typing.Ident.t
| Env_value_unbound of Ocaml_typing.Env.summary * string * Ocaml_typing.Env.value_unbound_reason
| Env_module_unbound of Ocaml_typing.Env.summary * string * Ocaml_typing.Env.module_unbound_reason

type address = Ocaml_typing.Persistent_env.address =

| Aunit of Ocaml_typing.Compilation_unit.t
| Alocal of Ocaml_typing.Ident.t
| Adot of Ocaml_typing.Env.address * Ocaml_typing.Jkind.Sort.t array * int

type t

type stage

val empty : Ocaml_typing.Env.t

val initial : Ocaml_typing.Env.t Stdlib.Lazy.t

val diff : 
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t list

val same_type_declarations : Ocaml_typing.Env.t -> Ocaml_typing.Env.t -> bool

type type_descr_kind =
  (Ocaml_typing.Types.label_description,
    Ocaml_typing.Types.unboxed_label_description,
    Ocaml_typing.Types.constructor_description)
    Ocaml_typing.Types.type_kind

type type_descriptions = Ocaml_typing.Env.type_descr_kind

type iter_cont

val iter_types : 
  (Ocaml_typing.Path.t ->
    (Ocaml_typing.Path.t * Ocaml_typing.Types.type_declaration) ->
    unit) ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.iter_cont

val run_iter_cont : 
  Ocaml_typing.Env.iter_cont list ->
  (Ocaml_typing.Path.t * Ocaml_typing.Env.iter_cont) list

val same_types : Ocaml_typing.Env.t -> Ocaml_typing.Env.t -> bool

val used_persistent : unit -> Ocaml_typing.Compilation_unit.Name.Set.t

val find_shadowed_types : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t list

val without_cmis : ('a -> 'b) -> 'a -> 'b

val find_value_no_locks_exn : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Subst.Lazy.value_description * Ocaml_typing.Mode.Value.l

Find a value by an Ident.t. Raises if encounters any locks.

val find_value : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Subst.Lazy.value_description

val find_type : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.type_declaration

val find_type_descrs : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.type_descriptions

val find_module_lazy : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Subst.Lazy.module_declaration

val find_module : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.module_declaration

val find_modtype_lazy : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Subst.Lazy.modtype_declaration

val find_modtype : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.modtype_declaration

val find_class : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.class_declaration

val find_cltype : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.class_type_declaration

val find_ident_constructor : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.constructor_description

val find_ident_label : 
  'rcd Ocaml_typing.Types.record_form ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  'rcd Ocaml_typing.Types.gen_label_description

val find_type_expansion : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.type_expr list * Ocaml_typing.Types.type_expr * int

val find_type_expansion_opt : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.type_expr list * Ocaml_typing.Types.type_expr * int

val find_modtype_expansion : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.module_type

val find_modtype_expansion_lazy : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Subst.Lazy.module_type

val find_hash_type : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.type_declaration

val find_value_address : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.address

val find_module_address : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.address

val find_class_address : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.address

val find_constructor_address : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.address

val shape_of_path : 
  namespace:Ocaml_typing.Shape.Sig_component_kind.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Shape.t

val shape_of_path_opt : 
  namespace:Ocaml_typing.Shape.Sig_component_kind.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Shape.t option

val shape_for_constr : 
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  args:Ocaml_typing.Shape.t list ->
  Ocaml_typing.Shape.t option

val add_functor_arg : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val is_functor_arg : Ocaml_typing.Path.t -> Ocaml_typing.Env.t -> bool

val normalize_module_path : 
  Ocaml_parsing.Location.t option ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Path.t

val normalize_type_path : 
  Ocaml_parsing.Location.t option ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Path.t

val normalize_value_path : 
  Ocaml_parsing.Location.t option ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Path.t

val normalize_modtype_path : 
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Path.t

val normalize_instance_names_in_module_path : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Path.t

val reset_required_globals : unit -> unit

val get_required_globals : unit -> Ocaml_typing.Compilation_unit.t list

val add_required_global : Ocaml_typing.Path.t -> Ocaml_typing.Env.t -> unit

val reset_probes : unit -> unit

val add_probe : string -> unit

val has_probe : string -> bool

val has_local_constraints : Ocaml_typing.Env.t -> bool

val mark_value_used : Ocaml_typing.Types.Uid.t -> unit

val mark_module_used : Ocaml_typing.Types.Uid.t -> unit

val mark_type_used : Ocaml_typing.Types.Uid.t -> unit

val mark_value_mutated : Ocaml_typing.Types.Uid.t -> unit

type constructor_usage =

| Positive
| Pattern
| Exported_private
| Exported

val mark_constructor_used : 
  Ocaml_typing.Env.constructor_usage ->
  Ocaml_typing.Types.Uid.t ->
  unit

val mark_extension_used : 
  Ocaml_typing.Env.constructor_usage ->
  Ocaml_typing.Types.Uid.t ->
  unit

type label_usage =

| Projection
| Mutation
| Construct
| Exported_private
| Exported

val mark_label_used : 
  Ocaml_typing.Env.label_usage ->
  Ocaml_typing.Types.Uid.t ->
  unit

type unbound_value_hint =

| No_hint
| Missing_rec of Ocaml_parsing.Location.t

type mode_with_locks = Ocaml_typing.Mode.Value.l * Ocaml_typing.Env.locks

Sometimes we get the locks for something, but either want to walk them later, or walk them for something else. The Longident.t and Location.t are only for error messages, and point to the variable for which we actually want to walk the locks.

val locks_empty : Ocaml_typing.Env.locks

val locks_is_empty : Ocaml_typing.Env.locks -> bool

val mode_unit : Ocaml_typing.Mode.Value.lr

type structure_components_reason =

| Project
| Open

type no_open_quotations_context =

| Object_qt
| Struct_qt
| Sig_qt
| Open_qt

type lookup_error =

| Unbound_value of Ocaml_parsing.Longident.t * Ocaml_typing.Env.unbound_value_hint
| Unbound_type of Ocaml_parsing.Longident.t
| Unbound_constructor of Ocaml_parsing.Longident.t
| Unbound_label of Ocaml_parsing.Longident.t * Ocaml_typing.Types.record_form_packed * Ocaml_typing.Env.label_usage
| Unbound_module of Ocaml_parsing.Longident.t
| Unbound_class of Ocaml_parsing.Longident.t
| Unbound_modtype of Ocaml_parsing.Longident.t
| Unbound_cltype of Ocaml_parsing.Longident.t
| Unbound_settable_variable of string
| Not_a_settable_variable of string
| Masked_instance_variable of Ocaml_parsing.Longident.t
| Masked_self_variable of Ocaml_parsing.Longident.t
| Masked_ancestor_variable of Ocaml_parsing.Longident.t
| Structure_used_as_functor of Ocaml_parsing.Longident.t
| Abstract_used_as_functor of Ocaml_parsing.Longident.t * Ocaml_typing.Path.t
| Functor_used_as_structure of Ocaml_parsing.Longident.t * Ocaml_typing.Env.structure_components_reason
| Abstract_used_as_structure of Ocaml_parsing.Longident.t * Ocaml_typing.Path.t * Ocaml_typing.Env.structure_components_reason
| Generative_used_as_applicative of Ocaml_parsing.Longident.t
| Illegal_reference_to_recursive_module of {
1. container : string option;
2. unbound : string;
}
| Illegal_reference_to_recursive_class_type of {
1. container : string option;
2. unbound : string;
3. unbound_class_type : Ocaml_parsing.Longident.t;
4. container_class_type : string;
}
| Cannot_scrape_alias of Ocaml_parsing.Longident.t * Ocaml_typing.Path.t
| Local_value_used_in_exclave of Ocaml_typing.Mode.Hint.lock_item * Ocaml_parsing.Longident.t
| Non_value_used_in_object of Ocaml_parsing.Longident.t * Ocaml_typing.Types.type_expr * Ocaml_typing.Jkind.Violation.t
| No_unboxed_version of Ocaml_parsing.Longident.t * Ocaml_typing.Types.type_declaration
| Error_from_persistent_env of Ocaml_typing.Persistent_env.error
| Mutable_value_used_in_closure of Ocaml_typing.Mode.Hint.pinpoint
| Incompatible_stage of Ocaml_parsing.Longident.t * Ocaml_parsing.Location.t * Ocaml_typing.Env.stage * Ocaml_parsing.Location.t * Ocaml_typing.Env.stage
| No_constructor_in_stage of Ocaml_parsing.Longident.t * Ocaml_parsing.Location.t * int

val lookup_error : 
  Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.lookup_error ->
  'a

val walk_locks : 
  env:Ocaml_typing.Env.t ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  item:Ocaml_typing.Mode.Hint.lock_item ->
  Ocaml_typing.Types.type_expr option ->
  Ocaml_typing.Env.mode_with_locks ->
  Ocaml_typing.Mode.Value.l

Takes the mode and the type of a value at definition site, walks through the list of locks and constrains the mode and the type. Return the access mode of the value allowed by the locks. ty is optional as the function works on modules and classes as well, for which ty should be None.

val lookup_value : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t
  * Ocaml_typing.Types.value_description
  * Ocaml_typing.Env.mode_with_locks

val lookup_type : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.type_declaration

val lookup_module : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t
  * Ocaml_typing.Types.module_declaration
  * Ocaml_typing.Env.mode_with_locks

val lookup_modtype : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.modtype_declaration

val lookup_class : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t
  * Ocaml_typing.Types.class_declaration
  * Ocaml_typing.Mode.Value.l

val lookup_cltype : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.class_type_declaration

val lookup_module_path : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  load:bool ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Env.mode_with_locks

val lookup_modtype_path : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t

val lookup_module_instance_path : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  load:bool ->
  Ocaml_typing.Global_module.Name.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Env.locks

val lookup_constructor : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.constructor_usage ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.constructor_description * Ocaml_typing.Env.locks

val lookup_all_constructors : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.constructor_usage ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  (((Ocaml_typing.Types.constructor_description * Ocaml_typing.Env.locks)
    * (unit ->
    unit))
     list,
    Ocaml_parsing.Location.t
    * Ocaml_typing.Env.t
    * Ocaml_typing.Env.lookup_error)
    Stdlib.result

val lookup_all_constructors_from_type : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.constructor_usage ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  ((Ocaml_typing.Types.constructor_description * Ocaml_typing.Env.locks)
   * (unit ->
   unit))
    list

val lookup_label : 
  ?use:bool ->
  record_form:'rcd Ocaml_typing.Types.record_form ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.label_usage ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  'rcd Ocaml_typing.Types.gen_label_description

val lookup_all_labels : 
  ?use:bool ->
  record_form:'rcd Ocaml_typing.Types.record_form ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.label_usage ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  (('rcd Ocaml_typing.Types.gen_label_description * (unit -> unit)) list,
    Ocaml_parsing.Location.t
    * Ocaml_typing.Env.t
    * Ocaml_typing.Env.lookup_error)
    Stdlib.result

val lookup_all_labels_from_type : 
  ?use:bool ->
  record_form:'rcd Ocaml_typing.Types.record_form ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.label_usage ->
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  ('rcd Ocaml_typing.Types.gen_label_description * (unit -> unit)) list

type settable_variable =

| Instance_variable of Ocaml_typing.Path.t * Ocaml_parsing.Asttypes.mutable_flag * string * Ocaml_typing.Types.type_expr
| Mutable_variable of Ocaml_typing.Ident.t * Ocaml_typing.Mode.Value.r * Ocaml_typing.Types.type_expr * Ocaml_typing.Jkind.Sort.t

val lookup_settable_variable : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  string ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.settable_variable

For a mutable variable, use means mark as mutated. For an instance variable, it means mark as used.

val find_value_by_name : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.value_description

val find_value_by_name_lazy : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Subst.Lazy.value_description

val find_type_by_name : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.type_declaration

val find_module_by_name_lazy : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Subst.Lazy.module_declaration

val find_modtype_by_name_lazy : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Subst.Lazy.modtype_declaration

val find_class_by_name : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.class_declaration

val find_cltype_by_name : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Types.class_type_declaration

val find_constructor_by_name : 
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.constructor_description

val find_label_by_name : 
  'rep Ocaml_typing.Types.record_form ->
  Ocaml_parsing.Longident.t ->
  Ocaml_typing.Env.t ->
  'rep Ocaml_typing.Types.gen_label_description

val find_value_index : Ocaml_typing.Ident.t -> Ocaml_typing.Env.t -> int option

The find_*_index functions computes a "namespaced" De Bruijn index of an identifier in a given environment. In other words, it returns how many times an identifier has been shadowed by a more recent identifiers with the same name in a given environment. Those functions return None when the identifier is not bound in the environment. This behavior is there to facilitate the detection of inconsistent printing environment, but should disappear in the long term.

val find_type_index : Ocaml_typing.Ident.t -> Ocaml_typing.Env.t -> int option

val find_module_index : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  int option

val find_modtype_index : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  int option

val find_class_index : Ocaml_typing.Ident.t -> Ocaml_typing.Env.t -> int option

val find_cltype_index : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  int option

val bound_value : string -> Ocaml_typing.Env.t -> bool

val bound_module : string -> Ocaml_typing.Env.t -> bool

val bound_type : string -> Ocaml_typing.Env.t -> bool

val bound_modtype : string -> Ocaml_typing.Env.t -> bool

val bound_class : string -> Ocaml_typing.Env.t -> bool

val bound_cltype : string -> Ocaml_typing.Env.t -> bool

val make_copy_of_types : 
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val global_of_instance_compilation_unit : 
  Ocaml_typing.Compilation_unit.t ->
  Ocaml_typing.Global_module.t

val add_value_lazy : 
  ?check:(string -> Ocaml_utils.Warnings.t) ->
  mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Subst.Lazy.value_description ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_value : 
  ?check:(string -> Ocaml_utils.Warnings.t) ->
  mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.value_description ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_type : 
  check:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_type_long_path : 
  check:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_extension : 
  check:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  rebind:bool ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.extension_constructor ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_module : 
  ?arg:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Types.module_type ->
  ?mode:Ocaml_typing.Mode.Value.l ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_module_lazy : 
  update_summary:bool ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Subst.Lazy.module_type ->
  ?mode:Ocaml_typing.Mode.Value.l ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_module_declaration : 
  ?arg:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  check:bool ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Types.module_declaration ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ?locks:Ocaml_typing.Env.locks ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_module_declaration_lazy : 
  ?arg:bool ->
  update_summary:bool ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Subst.Lazy.module_declaration ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ?locks:Ocaml_typing.Env.locks ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_modtype : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.modtype_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_modtype_lazy : 
  update_summary:bool ->
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Subst.Lazy.modtype_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_class : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.class_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_cltype : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.class_type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_local_constraint : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Types.type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_persistent_structure : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val persistent_structures_of_dir : 
  Ocaml_utils.Load_path.Dir.t ->
  Merlin_utils.Misc.String.Set.t

val persistent_structures_of_basenames : 
  string list ->
  Merlin_utils.Misc.String.Set.t

val filter_non_loaded_persistent : 
  (Ocaml_typing.Ident.t -> bool) ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_signature : 
  Ocaml_typing.Types.signature ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_signature_lazy : 
  Ocaml_typing.Subst.Lazy.signature_item list ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val open_signature : 
  used_slot:bool Stdlib.ref ->
  loc:Ocaml_parsing.Location.t ->
  toplevel:bool ->
  Ocaml_parsing.Asttypes.override_flag ->
  Ocaml_parsing.Longident.t Ocaml_parsing.Location.loc ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Env.mode_with_locks * Ocaml_typing.Env.t

val open_signature_by_path : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val open_pers_signature : 
  string ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Path.t * Ocaml_typing.Env.mode_with_locks * Ocaml_typing.Env.t

val remove_last_open : 
  Ocaml_typing.Path.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t option

val enter_value : 
  ?check:(string -> Ocaml_utils.Warnings.t) ->
  mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  string ->
  Ocaml_typing.Types.value_description ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_type : 
  scope:int ->
  string ->
  Ocaml_typing.Types.type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_extension : 
  scope:int ->
  rebind:bool ->
  string ->
  Ocaml_typing.Types.extension_constructor ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_module : 
  scope:int ->
  ?arg:bool ->
  string ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Types.module_type ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_module_declaration : 
  scope:int ->
  ?arg:bool ->
  ?shape:Ocaml_typing.Shape.t ->
  string ->
  Ocaml_typing.Types.module_presence ->
  Ocaml_typing.Types.module_declaration ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  ?locks:Ocaml_typing.Env.locks ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_modtype : 
  scope:int ->
  string ->
  Ocaml_typing.Types.modtype_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_class : 
  scope:int ->
  string ->
  Ocaml_typing.Types.class_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_cltype : 
  scope:int ->
  string ->
  Ocaml_typing.Types.class_type_declaration ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Ident.t * Ocaml_typing.Env.t

val enter_signature : 
  ?mod_shape:Ocaml_typing.Shape.t ->
  scope:int ->
  Ocaml_typing.Types.signature ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.signature * Ocaml_typing.Env.t

val enter_signature_and_shape : 
  scope:int ->
  parent_shape:Ocaml_typing.Shape.Map.t ->
  Ocaml_typing.Shape.t ->
  Ocaml_typing.Types.signature ->
  ?mode:(Ocaml_typing.Mode.allowed * 'r) Ocaml_typing.Mode.Value.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Types.signature * Ocaml_typing.Shape.Map.t * Ocaml_typing.Env.t

val enter_unbound_value : 
  string ->
  Ocaml_typing.Env.value_unbound_reason ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val enter_unbound_module : 
  string ->
  Ocaml_typing.Env.module_unbound_reason ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_closure_lock : 
  Ocaml_typing.Mode.Hint.pinpoint ->
  ('l * Ocaml_typing.Mode.allowed) Ocaml_typing.Mode.Value.Comonadic.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val add_const_closure_lock : 
  ?ghost:bool ->
  Ocaml_typing.Mode.Hint.pinpoint ->
  Ocaml_typing.Mode.Value.Comonadic.Const.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

A variant of add_closure_lock where the mode of the closure is a constant due to the nature of the pinpoint. As a result, the mode is not printed in error messages. ghost = true means the closure is not a value (such as a loop)

val add_region_lock : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val add_exclave_lock : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val add_unboxed_lock : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val enter_quotation : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val enter_splice : 
  loc:Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val check_no_open_quotations : 
  Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.no_open_quotations_context ->
  unit

val stage : Ocaml_typing.Env.t -> Ocaml_typing.Env.stage

val reset_cache : preserve_persistent_env:bool -> unit

val reset_cache_toplevel : unit -> unit

val set_unit_name : Ocaml_typing.Unit_info.t option -> unit

val get_unit_name : unit -> Ocaml_typing.Unit_info.t option

val read_signature : 
  Ocaml_typing.Global_module.Name.t ->
  Ocaml_typing.Unit_info.Artifact.t ->
  Ocaml_typing.Types.signature

val save_signature : 
  alerts:Merlin_utils.Misc.alerts ->
  Ocaml_typing.Types.signature ->
  Ocaml_typing.Compilation_unit.Name.t ->
  Ocaml_typing.Cmi_format.kind ->
  Ocaml_typing.Unit_info.Artifact.t ->
  Ocaml_typing.Cmi_format.cmi_infos_lazy

val save_signature_with_imports : 
  alerts:Merlin_utils.Misc.alerts ->
  Ocaml_typing.Types.signature ->
  Ocaml_typing.Compilation_unit.Name.t ->
  Ocaml_typing.Cmi_format.kind ->
  Ocaml_typing.Unit_info.Artifact.t ->
  Ocaml_typing.Import_info.t array ->
  Ocaml_typing.Cmi_format.cmi_infos_lazy

val register_parameter : Ocaml_typing.Global_module.Parameter_name.t -> unit

val crc_of_unit : Ocaml_typing.Compilation_unit.Name.t -> Stdlib.Digest.t

val imports : unit -> Ocaml_typing.Import_info.t list

val import_crcs : source:string -> Ocaml_typing.Import_info.t array -> unit

val require_global_for_quote : Ocaml_typing.Compilation_unit.Name.t -> unit

val quoted_globals : unit -> Ocaml_typing.Compilation_unit.Name.t list

val runtime_parameter_bindings : 
  unit ->
  (Ocaml_typing.Global_module.t * Ocaml_typing.Ident.t) list

val is_bound_to_runtime_parameter : Ocaml_typing.Ident.t -> bool

val parameters : unit -> Ocaml_typing.Global_module.Parameter_name.t list

val is_imported_opaque : Ocaml_typing.Compilation_unit.Name.t -> bool

val register_import_as_opaque : Ocaml_typing.Compilation_unit.Name.t -> unit

val is_parameter_unit : Ocaml_typing.Global_module.Name.t -> bool

val implemented_parameter : 
  Ocaml_typing.Global_module.Name.t ->
  Ocaml_typing.Global_module.Parameter_name.t option

val is_imported_parameter : Ocaml_typing.Global_module.Name.t -> bool

val summary : Ocaml_typing.Env.t -> Ocaml_typing.Env.summary

val keep_only_summary : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val env_of_only_summary : 
  (Ocaml_typing.Env.summary -> Ocaml_typing.Subst.t -> Ocaml_typing.Env.t) ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val update_short_paths : Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val short_paths : Ocaml_typing.Env.t -> Ocaml_typing.Short_paths.t

type error =

| Missing_module of Ocaml_parsing.Location.t * Ocaml_typing.Path.t * Ocaml_typing.Path.t
| Illegal_value_name of Ocaml_parsing.Location.t * string
| Lookup_error of Ocaml_parsing.Location.t * Ocaml_typing.Env.t * Ocaml_typing.Env.lookup_error
| Incomplete_instantiation of {
1. unset_param : Ocaml_typing.Global_module.Parameter_name.t;
}
| Toplevel_splice of Ocaml_parsing.Location.t
| Unsupported_inside_quotation of Ocaml_parsing.Location.t * Ocaml_typing.Env.no_open_quotations_context

exception Error of Ocaml_typing.Env.error

val report_error : 
  level:int ->
  Stdlib.Format.formatter ->
  Ocaml_typing.Env.error ->
  unit

val report_lookup_error : 
  level:int ->
  Ocaml_parsing.Location.t ->
  Ocaml_typing.Env.t ->
  Stdlib.Format.formatter ->
  Ocaml_typing.Env.lookup_error ->
  unit

val in_signature : bool -> Ocaml_typing.Env.t -> Ocaml_typing.Env.t

val is_in_signature : Ocaml_typing.Env.t -> bool

val set_value_used_callback : 
  Ocaml_typing.Subst.Lazy.value_description ->
  (unit -> unit) ->
  unit

val set_value_mutated_callback : 
  Ocaml_typing.Subst.Lazy.value_description ->
  (unit -> unit) ->
  unit

val set_type_used_callback : 
  Ocaml_typing.Types.type_declaration ->
  ((unit -> unit) -> unit) ->
  unit

val check_functor_application : 
  (errors:bool ->
    loc:Ocaml_parsing.Location.t ->
    lid_whole_app:Ocaml_parsing.Longident.t ->
    f0_path:Ocaml_typing.Path.t ->
    args:(Ocaml_typing.Path.t * Ocaml_typing.Types.module_type) list ->
    arg_path:Ocaml_typing.Path.t ->
    arg_mty:Ocaml_typing.Types.module_type ->
    param_mty:Ocaml_typing.Types.module_type ->
    Ocaml_typing.Env.t ->
    unit)
    Stdlib.ref

val check_well_formed_module : 
  (Ocaml_typing.Env.t ->
    Ocaml_parsing.Location.t ->
    string ->
    Ocaml_typing.Types.module_type ->
    unit)
    Stdlib.ref

val add_delayed_check_forward : ((unit -> unit) -> unit) Stdlib.ref

val scrape_alias : 
  (Ocaml_typing.Env.t ->
    Ocaml_typing.Subst.Lazy.module_type ->
    Ocaml_typing.Subst.Lazy.module_type)
    Stdlib.ref

val same_constr : 
  (Ocaml_typing.Env.t ->
    Ocaml_typing.Types.type_expr ->
    Ocaml_typing.Types.type_expr ->
    bool)
    Stdlib.ref

val constrain_type_jkind : 
  (Ocaml_typing.Env.t ->
    Ocaml_typing.Types.type_expr ->
    Ocaml_typing.Types.jkind_r ->
    (unit, Ocaml_typing.Jkind.Violation.t) Stdlib.result)
    Stdlib.ref

val print_longident : 
  (Stdlib.Format.formatter -> Ocaml_parsing.Longident.t -> unit) Stdlib.ref

val print_path : 
  (Stdlib.Format.formatter -> Ocaml_typing.Path.t -> unit) Stdlib.ref

val print_type_expr : 
  (Stdlib.Format.formatter -> Ocaml_typing.Types.type_expr -> unit) Stdlib.ref

val shorten_module_path : 
  (Ocaml_typing.Env.t -> Ocaml_typing.Path.t -> Ocaml_typing.Path.t) Stdlib.ref

Folds

Folding over all identifiers (for analysis purpose)

val fold_values : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Subst.Lazy.value_description ->
    Ocaml_typing.Mode.Value.l ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_types : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Types.type_declaration ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_constructors : 
  (Ocaml_typing.Types.constructor_description -> 'a -> 'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_labels : 
  'rcd Ocaml_typing.Types.record_form ->
  ('rcd Ocaml_typing.Types.gen_label_description -> 'a -> 'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_modules : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Subst.Lazy.module_declaration ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

Persistent structures are only traversed if they are already loaded.

val fold_modtypes : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Subst.Lazy.modtype_declaration ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_classes : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Types.class_declaration ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val fold_cltypes : 
  (string ->
    Ocaml_typing.Path.t ->
    Ocaml_typing.Types.class_type_declaration ->
    'a ->
    'a) ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val check_value_name : string -> Ocaml_parsing.Location.t -> unit

Utilities

val print_address : Stdlib.Format.formatter -> Ocaml_typing.Env.address -> unit

type address_head =

| AHunit of Ocaml_typing.Compilation_unit.t
| AHlocal of Ocaml_typing.Ident.t

val address_head : Ocaml_typing.Env.address -> Ocaml_typing.Env.address_head

val print_stage : Stdlib.Format.formatter -> Ocaml_typing.Env.stage -> unit

val unbound_class : Ocaml_typing.Path.t

merlin: manage internal state

val check_state_consistency : unit -> bool

val with_cmis : (unit -> 'a) -> 'a

val add_merlin_extension_module : 
  Ocaml_typing.Ident.t ->
  Ocaml_typing.Types.module_type ->
  Ocaml_typing.Env.t ->
  Ocaml_typing.Env.t

val cleanup_functor_caches : stamp:int -> unit

val scrape_lazy : 
  (Ocaml_typing.Env.t ->
    Ocaml_typing.Subst.Lazy.module_type ->
    Ocaml_typing.Subst.Lazy.module_type)
    Stdlib.ref

val cleanup_usage_tables : stamp:int -> unit

val msupport_raise_error : (?ignore_unify:bool -> exn -> unit) Stdlib.ref

This value should be filled in with Msupport.raise_error. Env cannot use this function directly because Msupport depends on Env

type 'acc fold_all_labels_f = {

fold_all_labels_f : 'rcd. 'rcd Ocaml_typing.Types.record_form -> 'rcd Ocaml_typing.Types.gen_label_description -> 'acc -> 'acc;

}

val fold_all_labels : 
  'a Ocaml_typing.Env.fold_all_labels_f ->
  Ocaml_parsing.Longident.t option ->
  Ocaml_typing.Env.t ->
  'a ->
  'a

val print_with_quote_promote : 
  Stdlib.Format.formatter ->
  (string * Ocaml_typing.Env.stage * Ocaml_typing.Env.stage) ->
  unit

Module Ocaml_typing.Env

Module `Ocaml_typing.Env`