package ocaml-compiler

  1. Overview
  2. Docs
Official release of OCaml 5.3.0

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (13)

Authors

  1. Xavier Leroy
  2. Damien Doligez
  3. Alain Frisch
  4. Jacques Garrigue
  5. Didier Rémy
  6. K
    KC Sivaramakrishnan
  7. J
    Jérôme Vouillon

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

ocaml-5.3.0.tar.gz
sha256=22c1dd9de21bf43b62d1909041fb5fad648905227bf69550a6a6bef31e654f38

doc/compiler-libs.toplevel/Toploop/index.html

Module Toploop

type input =
  1. | Stdin
  2. | File of string
  3. | String of string
val getvalue : string -> Obj.t
val setvalue : string -> Obj.t -> unit
val filename_of_input : input -> string
val set_paths : ?auto_include:Load_path.auto_include_callback -> ?dir:string -> unit -> unit
val loop : Format.formatter -> unit
val run_script : Format.formatter -> input -> string array -> bool
type directive_fun =
  1. | Directive_none of unit -> unit
  2. | Directive_string of string -> unit
  3. | Directive_int of int -> unit
  4. | Directive_ident of Longident.t -> unit
  5. | Directive_bool of bool -> unit
type directive_info = {
  1. section : string;
  2. doc : string;
}
val add_directive : string -> directive_fun -> directive_info -> unit
val get_directive : string -> directive_fun option
val get_directive_info : string -> directive_info option
val all_directive_names : unit -> string list
val directive_table : (string, directive_fun) Hashtbl.t
  • deprecated
val directive_info_table : (string, directive_info) Hashtbl.t
  • deprecated
val toplevel_env : Env.t ref
val initialize_toplevel_env : unit -> unit
val print_exception_outcome : Format.formatter -> exn -> unit
val execute_phrase : bool -> Format.formatter -> Parsetree.toplevel_phrase -> bool
val use_input : Format.formatter -> input -> bool
val use_output : Format.formatter -> string -> bool
val use_silently : Format.formatter -> input -> bool
val mod_use_input : Format.formatter -> input -> bool
val use_file : Format.formatter -> string -> bool
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
val record_backtrace : unit -> unit
val load_file : Format.formatter -> string -> bool
val print_value : Env.t -> Obj.t -> Format.formatter -> Types.type_expr -> unit
val print_untyped_exception : Format.formatter -> Obj.t -> unit
type ('a, 'b) gen_printer =
  1. | Zero of 'b
  2. | Succ of 'a -> ('a, 'b) gen_printer
val install_printer : Path.t -> Types.type_expr -> (Format.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 -> (Format.formatter -> Obj.t -> unit, Format.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
val parse_toplevel_phrase : (Lexing.lexbuf -> Parsetree.toplevel_phrase) ref
val parse_use_file : (Lexing.lexbuf -> Parsetree.toplevel_phrase list) ref
val print_location : Format.formatter -> Location.t -> unit
val print_error : Format.formatter -> Location.error -> unit
val print_warning : Location.t -> Format.formatter -> Warnings.t -> unit
val input_name : string ref
val print_out_value : (Format.formatter -> Outcometree.out_value -> unit) ref
type 'a oprinter := 'a Oprint.printer
val print_out_type : Outcometree.out_type oprinter
val print_out_class_type : Outcometree.out_class_type oprinter
val print_out_module_type : Outcometree.out_module_type oprinter
val print_out_type_extension : Outcometree.out_type_extension oprinter
val print_out_sig_item : Outcometree.out_sig_item oprinter
val print_out_signature : Outcometree.out_sig_item list oprinter
val print_out_phrase : (Format.formatter -> Outcometree.out_phrase -> unit) ref
val read_interactive_input : (string -> bytes -> int -> int * bool) ref
val toplevel_startup_hook : (unit -> unit) ref
type event = ..
type event +=
  1. | Startup
  2. | After_setup
val add_hook : (event -> unit) -> unit
val run_hooks : event -> unit
val may_trace : bool ref
val override_sys_argv : string array -> unit
val split_path : string -> string list

split_path path splits path according to the PATH-splitting conventions of the platform. On Unix, this is exactly String.split_on_char ':' path. On Windows, entries are separated by semicolons. Sections of entries may be double-quoted (which allows semicolons in filenames to be quoted). The double-quote characters are stripped (i.e. f"o"o = foo; also split_path "foo\";\";bar" = ["foo;"; "bar"])

val preload_objects : string list ref

List of compilation units to be loaded before entering the interactive loop.

val prepare : Format.formatter -> ?input:input -> unit -> bool

Setup the load paths and initial toplevel environment and load compilation units in preload_objects.