154 lines
6.0 KiB
OCaml
154 lines
6.0 KiB
OCaml
(**************************************************************************)
|
|
(* *)
|
|
(* OCaml *)
|
|
(* *)
|
|
(* 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 GNU Lesser General Public License version 2.1, with the *)
|
|
(* special exception on linking described in the file LICENSE. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
open Format
|
|
|
|
(* Set the load paths, before running anything *)
|
|
|
|
val set_paths : unit -> unit
|
|
|
|
(* The interactive toplevel loop *)
|
|
|
|
val loop : formatter -> unit
|
|
|
|
(* Read and execute a script from the given file *)
|
|
|
|
val run_script : formatter -> string -> string array -> bool
|
|
(* true if successful, false if error *)
|
|
|
|
(* Interface with toplevel directives *)
|
|
|
|
type directive_fun =
|
|
| Directive_none of (unit -> unit)
|
|
| Directive_string of (string -> unit)
|
|
| Directive_int of (int -> unit)
|
|
| Directive_ident of (Longident.t -> unit)
|
|
| Directive_bool of (bool -> unit)
|
|
|
|
val directive_table : (string, directive_fun) Hashtbl.t
|
|
(* Table of known directives, with their execution function *)
|
|
val toplevel_env : Env.t ref
|
|
(* Typing environment for the toplevel *)
|
|
val initialize_toplevel_env : unit -> unit
|
|
(* Initialize the typing environment for the toplevel *)
|
|
val print_exception_outcome : formatter -> exn -> unit
|
|
(* Print an exception resulting from the evaluation of user code. *)
|
|
val execute_phrase : bool -> formatter -> Parsetree.toplevel_phrase -> bool
|
|
(* Execute the given toplevel phrase. Return [true] if the
|
|
phrase executed with no errors and [false] otherwise.
|
|
First bool says whether the values and types of the results
|
|
should be printed. Uncaught exceptions are always printed. *)
|
|
val preprocess_phrase :
|
|
formatter -> Parsetree.toplevel_phrase -> Parsetree.toplevel_phrase
|
|
(* Preprocess the given toplevel phrase using regular and ppx
|
|
preprocessors. Return the updated phrase. *)
|
|
val use_file : formatter -> string -> bool
|
|
val use_output : formatter -> string -> bool
|
|
val use_silently : formatter -> string -> bool
|
|
val mod_use_file : formatter -> string -> bool
|
|
(* Read and execute commands from a file.
|
|
[use_file] prints the types and values of the results.
|
|
[use_silently] does not print them.
|
|
[mod_use_file] wrap the file contents into a module. *)
|
|
val eval_module_path: Env.t -> Path.t -> Obj.t
|
|
val eval_value_path: Env.t -> Path.t -> Obj.t
|
|
val eval_extension_path: Env.t -> Path.t -> Obj.t
|
|
val eval_class_path: Env.t -> Path.t -> Obj.t
|
|
(* Return the toplevel object referred to by the given path *)
|
|
|
|
(* Printing of values *)
|
|
|
|
val print_value: Env.t -> Obj.t -> formatter -> Types.type_expr -> unit
|
|
val print_untyped_exception: formatter -> Obj.t -> unit
|
|
|
|
type ('a, 'b) gen_printer =
|
|
| Zero of 'b
|
|
| Succ of ('a -> ('a, 'b) gen_printer)
|
|
|
|
val install_printer :
|
|
Path.t -> Types.type_expr -> (formatter -> Obj.t -> unit) -> unit
|
|
val install_generic_printer :
|
|
Path.t -> Path.t ->
|
|
(int -> (int -> Obj.t -> Outcometree.out_value,
|
|
Obj.t -> Outcometree.out_value) gen_printer) -> unit
|
|
val install_generic_printer' :
|
|
Path.t -> Path.t -> (formatter -> Obj.t -> unit,
|
|
formatter -> Obj.t -> unit) gen_printer -> unit
|
|
val remove_printer : Path.t -> unit
|
|
|
|
val max_printer_depth: int ref
|
|
val max_printer_steps: int ref
|
|
|
|
(* Hooks for external parsers and printers *)
|
|
|
|
val parse_toplevel_phrase : (Lexing.lexbuf -> Parsetree.toplevel_phrase) ref
|
|
val parse_use_file : (Lexing.lexbuf -> Parsetree.toplevel_phrase list) ref
|
|
val print_location : formatter -> Location.t -> unit
|
|
val print_error : formatter -> Location.error -> unit
|
|
val print_warning : Location.t -> formatter -> Warnings.t -> unit
|
|
val input_name : string ref
|
|
|
|
val print_out_value :
|
|
(formatter -> Outcometree.out_value -> unit) ref
|
|
val print_out_type :
|
|
(formatter -> Outcometree.out_type -> unit) ref
|
|
val print_out_class_type :
|
|
(formatter -> Outcometree.out_class_type -> unit) ref
|
|
val print_out_module_type :
|
|
(formatter -> Outcometree.out_module_type -> unit) ref
|
|
val print_out_type_extension :
|
|
(formatter -> Outcometree.out_type_extension -> unit) ref
|
|
val print_out_sig_item :
|
|
(formatter -> Outcometree.out_sig_item -> unit) ref
|
|
val print_out_signature :
|
|
(formatter -> Outcometree.out_sig_item list -> unit) ref
|
|
val print_out_phrase :
|
|
(formatter -> Outcometree.out_phrase -> unit) ref
|
|
|
|
(* Hooks for external line editor *)
|
|
|
|
val read_interactive_input : (string -> bytes -> int -> int * bool) ref
|
|
|
|
(* Hooks *)
|
|
|
|
val toplevel_startup_hook : (unit -> unit) ref
|
|
|
|
type event = ..
|
|
type event +=
|
|
| Startup
|
|
| After_setup
|
|
(* Just after the setup, when the toplevel is ready to evaluate user
|
|
input. This happens before the toplevel has evaluated any kind of
|
|
user input, in particular this happens before loading the
|
|
[.ocamlinit] file. *)
|
|
|
|
val add_hook : (event -> unit) -> unit
|
|
(* Add a function that will be called at key points of the toplevel
|
|
initialization process. *)
|
|
|
|
val run_hooks : event -> unit
|
|
(* Run all the registered hooks. *)
|
|
|
|
|
|
(* Misc *)
|
|
|
|
val override_sys_argv : string array -> unit
|
|
(* [override_sys_argv args] replaces the contents of [Sys.argv] by [args]
|
|
and reset [Arg.current] to [0].
|
|
|
|
This is called by [run_script] so that [Sys.argv] represents
|
|
"script.ml args..." instead of the full command line:
|
|
"ocamlrun unix.cma ... script.ml args...". *)
|