148 lines
5.4 KiB
OCaml
148 lines
5.4 KiB
OCaml
(***********************************************************************)
|
|
(* *)
|
|
(* Objective Caml *)
|
|
(* *)
|
|
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
|
|
(* *)
|
|
(* Copyright 1996 Institut National de Recherche en Informatique et *)
|
|
(* en Automatique. All rights reserved. This file is distributed *)
|
|
(* under the terms of the Q Public License version 1.0. *)
|
|
(* *)
|
|
(***********************************************************************)
|
|
|
|
(* $Id$ *)
|
|
|
|
(* Environment handling *)
|
|
|
|
open Types
|
|
|
|
type t
|
|
|
|
val empty: t
|
|
val initial: t
|
|
val diff: t -> t -> Ident.t list
|
|
|
|
(* Lookup by paths *)
|
|
|
|
val find_value: Path.t -> t -> value_description
|
|
val find_type: Path.t -> t -> type_declaration
|
|
val find_module: Path.t -> t -> module_type
|
|
val find_modtype: Path.t -> t -> modtype_declaration
|
|
val find_class: Path.t -> t -> class_declaration
|
|
val find_cltype: Path.t -> t -> cltype_declaration
|
|
|
|
val find_type_expansion: Path.t -> t -> type_expr list * type_expr
|
|
val find_type_expansion_opt: Path.t -> t -> type_expr list * type_expr
|
|
(* Find the manifest type information associated to a type for the sake
|
|
of the compiler's type-based optimisations. *)
|
|
val find_modtype_expansion: Path.t -> t -> Types.module_type
|
|
|
|
(* Lookup by long identifiers *)
|
|
|
|
val lookup_value: Longident.t -> t -> Path.t * value_description
|
|
val lookup_annot: Longident.t -> t -> Path.t * Annot.ident
|
|
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
|
|
val lookup_class: Longident.t -> t -> Path.t * class_declaration
|
|
val lookup_cltype: Longident.t -> t -> Path.t * cltype_declaration
|
|
|
|
(* Insertion by identifier *)
|
|
|
|
val add_value: Ident.t -> value_description -> t -> t
|
|
val add_annot: Ident.t -> Annot.ident -> 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
|
|
val add_class: Ident.t -> class_declaration -> t -> t
|
|
val add_cltype: Ident.t -> cltype_declaration -> t -> t
|
|
|
|
(* Insertion of all fields of a signature. *)
|
|
|
|
val add_item: signature_item -> t -> t
|
|
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
|
|
val enter_class: string -> class_declaration -> t -> Ident.t * t
|
|
val enter_cltype: string -> cltype_declaration -> t -> Ident.t * t
|
|
|
|
(* Initialize the cache of in-core module interfaces. *)
|
|
val reset_cache: unit -> unit
|
|
|
|
(* Remember the name of the current compilation unit. *)
|
|
val set_unit_name: string -> unit
|
|
|
|
(* Read, save a signature to/from a file *)
|
|
|
|
val read_signature: string -> string -> signature
|
|
(* Arguments: module name, file name. Results: signature. *)
|
|
val save_signature: signature -> string -> string -> unit
|
|
(* Arguments: signature, module name, file name. *)
|
|
val save_signature_with_imports:
|
|
signature -> string -> string -> (string * Digest.t) list -> unit
|
|
(* Arguments: signature, module name, file name,
|
|
imported units with their CRCs. *)
|
|
|
|
(* Return the CRC of the interface of the given compilation unit *)
|
|
|
|
val crc_of_unit: string -> Digest.t
|
|
|
|
(* Return the set of compilation units imported, with their CRC *)
|
|
|
|
val imported_units: unit -> (string * Digest.t) list
|
|
|
|
(* Direct access to the table of imported compilation units with their CRC *)
|
|
|
|
val crc_units: Consistbl.t
|
|
|
|
(* Summaries -- compact representation of an environment, to be
|
|
exported in debugging information. *)
|
|
|
|
type summary =
|
|
Env_empty
|
|
| Env_value of summary * Ident.t * value_description
|
|
| Env_type of summary * Ident.t * type_declaration
|
|
| Env_exception of summary * Ident.t * exception_declaration
|
|
| Env_module of summary * Ident.t * module_type
|
|
| Env_modtype of summary * Ident.t * modtype_declaration
|
|
| Env_class of summary * Ident.t * class_declaration
|
|
| Env_cltype of summary * Ident.t * cltype_declaration
|
|
| Env_open of summary * Path.t
|
|
|
|
val summary: t -> summary
|
|
|
|
(* Error report *)
|
|
|
|
type error =
|
|
Not_an_interface of string
|
|
| Corrupted_interface of string
|
|
| Illegal_renaming of string * string
|
|
| Inconsistent_import of string * string * string
|
|
| Need_recursive_types of string * string
|
|
|
|
exception Error of error
|
|
|
|
open Format
|
|
|
|
val report_error: formatter -> error -> unit
|
|
|
|
(* Forward declaration to break mutual recursion with Includemod. *)
|
|
val check_modtype_inclusion:
|
|
(t -> module_type -> Path.t -> module_type -> unit) ref
|
|
|