ocaml/typing/env.mli

96 lines
3.2 KiB
OCaml

(***********************************************************************)
(* *)
(* Caml Special Light *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1995 Institut National de Recherche en Informatique et *)
(* Automatique. Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(* Environment handling *)
open Typedtree
type t
val empty: t
val initial: t
(* Lookup by paths *)
val find_value: Path.t -> t -> value_description
val find_type: Path.t -> t -> type_declaration
val find_modtype: Path.t -> t -> modtype_declaration
(* Lookup by long identifiers *)
val lookup_value: Longident.t -> t -> Path.t * value_description
val lookup_constructor: Longident.t -> t -> constructor_description
val lookup_label: Longident.t -> t -> label_description
val lookup_type: Longident.t -> t -> Path.t * type_declaration
val lookup_module: Longident.t -> t -> Path.t * module_type
val lookup_modtype: Longident.t -> t -> Path.t * modtype_declaration
(* Insertion by identifier *)
val add_value: Ident.t -> value_description -> t -> t
val add_type: Ident.t -> type_declaration -> t -> t
val add_exception: Ident.t -> exception_declaration -> t -> t
val add_module: Ident.t -> module_type -> t -> t
val add_modtype: Ident.t -> modtype_declaration -> t -> t
(* Insertion of all fields of a signature. *)
val add_signature: signature -> t -> t
(* Insertion of all fields of a signature, relative to the given path.
Used to implement open. *)
val open_signature: Path.t -> signature -> t -> t
val open_pers_signature: string -> t -> t
(* Insertion by name *)
val enter_value: string -> value_description -> t -> Ident.t * t
val enter_type: string -> type_declaration -> t -> Ident.t * t
val enter_exception: string -> exception_declaration -> t -> Ident.t * t
val enter_module: string -> module_type -> t -> Ident.t * t
val enter_modtype: string -> modtype_declaration -> t -> Ident.t * t
(* Reset the cache of in-core module interfaces.
To be called in particular when load_path changes. *)
val reset_cache: unit -> unit
(* Read, save a signature to/from a file *)
val read_signature: string -> string -> signature * Digest.t
(* Arguments: module name, file name.
Results: signature, CRC. *)
val save_signature: signature -> string -> string -> Digest.t
(* Arguments: signature, module name, file name.
Result: CRC. *)
(* Return the set of compilation units imported, with their CRC *)
val imported_units: unit -> (string * Digest.t) list
(* Error report *)
type error =
Not_an_interface of string
| Corrupted_interface of string
| Illegal_renaming of string * string
exception Error of error
val report_error: error -> unit
(* Forward declaration to break mutual recursion with includemod. *)
val check_modtype_inclusion: (t -> module_type -> module_type -> unit) ref