Module `Ocaml_typing.Env`Source

Sourcemodule Jkind = Btype.Jkind0

Sourcetype stage = private int

Sourcemodule StagedPath : sig ... end

Sourcetype value_unbound_reason =

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

Sourcetype module_unbound_reason =

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

Sourcetype locks

Sourcetype summary =

| Env_empty
| Env_value of summary * Ident.t * Types.value_description * Mode.Value.l
| Env_type of summary * Ident.t * Types.type_declaration
| Env_extension of summary * Ident.t * Types.extension_constructor
| Env_module of summary * Ident.t * Types.module_presence * Types.module_declaration * Mode.Value.l * locks
| Env_modtype of summary * Ident.t * Types.modtype_declaration
| Env_class of summary * Ident.t * Types.class_declaration
| Env_cltype of summary * Ident.t * Types.class_type_declaration
| Env_open of summary * 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 summary * Ident.t
| Env_constraints of summary * Types.type_declaration StagedPath.Map.t
| Env_copy_types of summary
| Env_persistent of summary * Ident.t
| Env_value_unbound of summary * string * value_unbound_reason
| Env_module_unbound of summary * string * module_unbound_reason
| Env_jkind of summary * Ident.t * Types.jkind_declaration

Sourcetype address = Persistent_env.address =

| Aunit of Compilation_unit.t
| Alocal of Ident.t
| Adot of address * Jkind_types.Sort.t array * int

Sourcetype t

Sourceval empty : t

Sourceval initial : t Lazy.t

Sourceval diff : t -> t -> Ident.t list

Sourceval same_type_declarations : t -> t -> bool

Source

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

Sourcetype type_descriptions = type_descr_kind

Sourcetype iter_cont

Source

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

Sourceval run_iter_cont : iter_cont list -> (Path.t * iter_cont) list

Sourceval same_types : t -> t -> bool

Sourceval used_persistent : unit -> Compilation_unit.Name.Set.t

Sourceval find_shadowed_types : Path.t -> t -> Path.t list

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

Source

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

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

Sourceval find_value : Path.t -> t -> Subst.Lazy.value_description

Sourceval find_type : Path.t -> t -> Types.type_declaration

Sourceval find_type_descrs : Path.t -> t -> type_descriptions

Sourceval find_module_lazy : Path.t -> t -> Subst.Lazy.module_declaration

Sourceval find_module : Path.t -> t -> Types.module_declaration

Sourceval find_modtype_lazy : Path.t -> t -> Subst.Lazy.modtype_declaration

Sourceval find_modtype : Path.t -> t -> Types.modtype_declaration

Sourceval find_class : Path.t -> t -> Types.class_declaration

Sourceval find_cltype : Path.t -> t -> Types.class_type_declaration

Sourceval find_jkind : Path.t -> t -> Types.jkind_declaration

Sourceval find_ident_constructor : Ident.t -> t -> Types.constructor_description

Source

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

Source

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

Source

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

Sourceval find_modtype_expansion : Path.t -> t -> Types.module_type

Sourceval find_modtype_expansion_lazy : Path.t -> t -> Subst.Lazy.module_type

Sourceval find_jkind_expansion : Path.t -> t -> Types.jkind_const_desc_lr

Sourceval find_hash_type : Path.t -> t -> Types.type_declaration

Sourceval find_implicit_jkind : string -> t -> Types.jkind_lr option

Sourceval find_value_address : Path.t -> t -> address

Sourceval find_module_address : Path.t -> t -> address

Sourceval find_class_address : Path.t -> t -> address

Sourceval find_constructor_address : Path.t -> t -> address

Source

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

Source

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

Sourceval shape_for_constr : t -> Path.t -> args:Shape.t list -> Shape.t option

Sourceval add_functor_arg : Ident.t -> t -> t

Sourceval is_functor_arg : Path.t -> t -> bool

Source

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

Source

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

Source

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

Sourceval normalize_modtype_path : t -> Path.t -> Path.t

Sourceval normalize_instance_names_in_module_path : Path.t -> Path.t

Sourceval reset_required_globals : unit -> unit

Sourceval get_required_globals : unit -> Compilation_unit.t list

Sourceval add_required_global : Path.t -> t -> unit

Sourceval add_required_global_for_quote : Path.t -> t -> unit

Sourceval quoted_intfs : unit -> Compilation_unit.Name.Set.t

Source

val loaded_transitive_dependencies : 
  Compilation_unit.Name.Set.t ->
  Compilation_unit.Name.Set.t

Sourceval quoted_impls : unit -> Compilation_unit.Set.t

Sourceval reset_probes : unit -> unit

Sourceval add_probe : string -> unit

Sourceval has_probe : string -> bool

Sourceval has_local_constraints : t -> bool

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

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

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

Sourceval mark_jkind_used : Ocaml_typing.Types.Uid.t -> unit

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

Sourcetype constructor_usage =

| Positive
| Pattern
| Exported_private
| Exported

Source

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

Sourceval mark_extension_used : constructor_usage -> Ocaml_typing.Types.Uid.t -> unit

Sourcetype label_usage =

| Projection
| Mutation
| Construct
| Exported_private
| Exported

Sourceval mark_label_used : label_usage -> Ocaml_typing.Types.Uid.t -> unit

Sourcetype unbound_value_hint =

| No_hint
| Missing_rec of Ocaml_parsing.Location.t

Sourcetype mode_with_locks = Mode.Value.l * 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.

Sourceval locks_empty : locks

Sourceval locks_is_empty : locks -> bool

Sourceval mode_unit : staticity:Mode.Staticity.Const.t -> Mode.Value.lr

Sourcetype structure_components_reason =

| Project
| Open

Sourcetype no_open_quotations_context =

| Object_qt
| Struct_qt
| Sig_qt
| Open_qt
| Object_field_with_attribute_qt
| Variant_tag_with_attribute_qt
| Jkind_annotation_qt
| Layout_polymorphism_qt
| Tconst_pat_qt of Ocaml_parsing.Longident.t
| Class_type_qt

Sourcetype none_in_quotations_context =

| Constructor
| Label

Sourcetype lookup_error =

| Unbound_value of Ocaml_parsing.Longident.t * unbound_value_hint
| Unbound_type of Ocaml_parsing.Longident.t
| Unbound_constructor of Ocaml_parsing.Longident.t
| Unbound_label of Ocaml_parsing.Longident.t * Types.record_form_packed * 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_jkind 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 * Path.t
| Functor_used_as_structure of Ocaml_parsing.Longident.t * structure_components_reason
| Abstract_used_as_structure of Ocaml_parsing.Longident.t * Path.t * 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 * 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 * Types.type_expr * Jkind.Violation.t
| No_unboxed_version of Ocaml_parsing.Longident.t * Types.type_declaration
| Error_from_persistent_env of 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 * stage * Ocaml_parsing.Location.t * stage
| Unbound_in_stage of none_in_quotations_context * Ocaml_parsing.Longident.t * Ocaml_parsing.Location.t * stage * stage

Sourceval lookup_error : Ocaml_parsing.Location.t -> t -> lookup_error -> 'a

Source

val walk_locks : 
  env:t ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  item:Ocaml_typing.Mode.Hint.lock_item ->
  Types.type_expr option ->
  mode_with_locks ->
  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.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

val lookup_jkind : 
  ?use:bool ->
  loc:Ocaml_parsing.Location.t ->
  Ocaml_parsing.Longident.t ->
  t ->
  Path.t * Types.jkind_declaration

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Sourcetype settable_variable =

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

Source

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

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

val find_jkind_by_name : 
  Ocaml_parsing.Longident.t ->
  t ->
  Path.t * Types.jkind_declaration

Source

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

Source

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

Sourceval find_value_index : Ident.t -> 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.

Sourceval find_type_index : Ident.t -> t -> int option

Sourceval find_module_index : Ident.t -> t -> int option

Sourceval find_modtype_index : Ident.t -> t -> int option

Sourceval find_class_index : Ident.t -> t -> int option

Sourceval find_cltype_index : Ident.t -> t -> int option

Sourceval bound_value : string -> t -> bool

Sourceval bound_module : string -> t -> bool

Sourceval bound_type : string -> t -> bool

Sourceval bound_modtype : string -> t -> bool

Sourceval bound_class : string -> t -> bool

Sourceval bound_cltype : string -> t -> bool

Sourceval make_copy_of_types : t -> t -> t

Sourceval global_of_instance_compilation_unit : Compilation_unit.t -> Global_module.t

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Sourceval add_modtype : Ident.t -> Types.modtype_declaration -> t -> t

Source

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

Sourceval add_class : Ident.t -> Types.class_declaration -> t -> t

Sourceval add_cltype : Ident.t -> Types.class_type_declaration -> t -> t

Source

val add_local_constraint : 
  stage:stage ->
  Path.t ->
  Types.type_declaration ->
  t ->
  t

Source

val add_implicit_jkind : 
  loc:Ocaml_parsing.Location.t ->
  string ->
  Types.jkind_lr ->
  t ->
  t

Sourceval clear_implicit_jkinds : t -> t

Source

val add_jkind : 
  check:bool ->
  ?shape:Shape.t ->
  Ident.t ->
  Types.jkind_declaration ->
  t ->
  t

Sourceval add_persistent_structure : Ident.t -> t -> t

Source

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

Source

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

Sourceval filter_non_loaded_persistent : (Ident.t -> bool) -> t -> t

Sourceval add_signature : Types.signature -> t -> t

Sourceval add_signature_lazy : Subst.Lazy.signature_item list -> t -> t

Source

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

Sourceval open_signature_by_path : Path.t -> t -> t

Sourceval open_pers_signature : string -> t -> Path.t * mode_with_locks * t

Sourceval remove_last_open : Path.t -> t -> t option

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

val enter_jkind : 
  scope:int ->
  string ->
  Types.jkind_declaration ->
  t ->
  Ident.t * t

Source

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

Source

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

Sourceval enter_unbound_value : string -> value_unbound_reason -> t -> t

Sourceval enter_unbound_module : string -> module_unbound_reason -> t -> t

Source

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

Source

val add_const_closure_lock : 
  ?ghost:bool ->
  Ocaml_typing.Mode.Hint.pinpoint ->
  Mode.Value.Comonadic.Const.t ->
  t ->
  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)

Sourceval add_region_lock : t -> t

Sourceval add_exclave_lock : t -> t

Sourceval add_unboxed_lock : t -> t

Sourceval enter_quotation : t -> t

Sourceval enter_splice : loc:Ocaml_parsing.Location.t -> t -> t

Sourceval enter_future : t -> t

Set the environment's stage to a fixed one in the far future. Should only be used in cases where the stage is unknown.

Source

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

Sourceval stage : t -> stage

Sourceval mark_toplevel_in_quotations : scope:int -> t -> t

Sourceval path_is_toplevel_in_quotations : t -> Path.t -> bool

Sourceval reset_cache : preserve_persistent_env:bool -> unit

Sourceval reset_cache_toplevel : unit -> unit

Sourceval set_unit_name : Unit_info.t option -> unit

Sourceval get_unit_name : unit -> Unit_info.t option

Source

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

Source

val save_signature : 
  alerts:Ocaml_utils.Misc.alerts ->
  Types.persistent_signature ->
  Compilation_unit.Name.t ->
  Cmi_format.kind ->
  Unit_info.Artifact.t ->
  Cmi_format.cmi_infos_lazy

Source

val save_signature_with_imports : 
  alerts:Ocaml_utils.Misc.alerts ->
  Types.persistent_signature ->
  Compilation_unit.Name.t ->
  Cmi_format.kind ->
  Unit_info.Artifact.t ->
  Import_info.t array ->
  Cmi_format.cmi_infos_lazy

Sourceval register_parameter : Global_module.Parameter_name.t -> unit

Sourceval crc_of_unit : Compilation_unit.Name.t -> Digest.t

Sourceval imports : unit -> Import_info.t list

Sourceval import_crcs : source:string -> Import_info.t array -> unit

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

Sourceval is_bound_to_runtime_parameter : Ident.t -> bool

Sourceval parameters : unit -> Global_module.Parameter_name.t list

Sourceval is_imported_opaque : Compilation_unit.Name.t -> bool

Sourceval register_import_as_opaque : Compilation_unit.Name.t -> unit

Sourceval is_parameter_unit : Global_module.Name.t -> bool

Source

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

Sourceval is_imported_parameter : Global_module.Name.t -> bool

Sourceval summary : t -> summary

Sourceval keep_only_summary : t -> t

Sourceval env_of_only_summary : (summary -> Subst.t -> t) -> t -> t

Sourceval update_short_paths : t -> t

Sourceval short_paths : t -> Short_paths.t

Sourcetype error =

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

Sourceexception Error of error

Sourceval report_error : error Ocaml_utils.Format_doc.format_printer

Sourceval report_error_doc : error Ocaml_utils.Format_doc.printer

Source

val report_lookup_error : 
  Ocaml_parsing.Location.t ->
  t ->
  lookup_error Ocaml_utils.Format_doc.format_printer

Source

val report_lookup_error_doc : 
  Ocaml_parsing.Location.t ->
  t ->
  lookup_error Ocaml_utils.Format_doc.printer

Sourceval in_signature : bool -> t -> t

Sourceval is_in_signature : t -> bool

Source

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

Source

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

Source

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

Source

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

Source

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

Sourceval add_delayed_check_forward : ((unit -> unit) -> unit) ref

Sourceval scrape_alias : (t -> Subst.Lazy.module_type -> Subst.Lazy.module_type) ref

Sourceval same_constr : (t -> Types.type_expr -> Types.type_expr -> bool) ref

Source

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

Source

val print_longident : 
  Ocaml_parsing.Longident.t Ocaml_utils.Format_doc.printer ref

Sourceval print_path : Path.t Ocaml_utils.Format_doc.printer ref

Sourceval print_type_expr : Types.type_expr Ocaml_utils.Format_doc.printer ref

Source

val report_jkind_violation_with_offender : 
  (offender:(Ocaml_utils.Format_doc.formatter -> unit) ->
    t ->
    Ocaml_utils.Format_doc.formatter ->
    Jkind.Violation.t ->
    unit)
    ref

Sourceval shorten_module_path : (t -> Path.t -> Path.t) ref

Folds

Folding over all identifiers (for analysis purpose)

Source

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

Source

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

Source

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

Source

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

Source

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

Persistent structures are only traversed if they are already loaded.

Source

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

Source

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

Source

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

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

Utilities

Sourceval print_address : Format.formatter -> address -> unit

Sourcetype address_head =

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

Sourceval address_head : address -> address_head

Sourceval print_stage : Ocaml_utils.Format_doc.formatter -> stage -> unit

Sourceval unbound_class : Path.t

merlin: manage internal state

Sourceval check_state_consistency : unit -> bool

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

Sourceval add_merlin_extension_module : Ident.t -> Types.module_type -> t -> t

Sourceval cleanup_functor_caches : stamp:int -> unit

Sourceval scrape_lazy : (t -> Subst.Lazy.module_type -> Subst.Lazy.module_type) ref

Sourceval cleanup_usage_tables : stamp:int -> unit

Sourceval msupport_raise_error : (?ignore_unify:bool -> exn -> unit) ref

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

Sourcetype 'acc fold_all_labels_f = {

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

}

Source

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

Source

val print_with_quote_promote : 
  Ocaml_utils.Format_doc.formatter ->
  (string * stage * stage) ->
  unit

Module Ocaml_typing.EnvSource

Module `Ocaml_typing.Env`Source