UTopUTop configuration.
val get_ui : unit -> uiReturns the user interface in use.
If true (the default) identifiers starting with a '_' will be hidden from the output. i.e. the following phrase won't produces any output:
let _x = 1This is for hidding variables created by code generators for internal use. It can also be set/unset by the command line options -hide-reserved and -show-reserved.
Returns the value of hide_reserved.
Modifies hide_reserved.
If true (not the default) expressions entered in the toplevel are automatically bound, for example:
# 3 + 4;;
+UTop (utop.UTop) Module UTop
UTop configuration.
val get_ui : unit -> uiReturns the user interface in use.
If true (the default) identifiers starting with a '_' will be hidden from the output. i.e. the following phrase won't produces any output:
let _x = 1
This is for hidding variables created by code generators for internal use. It can also be set/unset by the command line options -hide-reserved and -show-reserved.
Returns the value of hide_reserved.
Modifies hide_reserved.
If true (not the default) expressions entered in the toplevel are automatically bound, for example:
# 3 + 4;;
_0 : int = 7
# _0 + 10;;
_1 : int = 17
Returns the value of create_implicits.
Modifies create_implicits.
If false (the default) messages from findlib are hidden. This is only effective with findlib >= 1.4.
Returns the value of topfind_verbose.
Modifies topfind_verbose.
List of messages logged by findlib since the beginning of the session. This requires findlib >= 1.4.
Returns the value of show_box.
Modifies show_box.
Margin of the standard and error formatters as a function of the screen size.
The default is:
fun size -> Some (min 80 size.cols)
Returns the value of phrase_terminator.
Modifies phrase_terminator.
If true (the default) toplevel lwt expressions are automatically run with Lwt_main.run. i.e. if you type:
Lwt_io.printl "Hello, world"
this will be replaced by:
Lwt_main.run (Lwt_io.printl "Hello, world")
Returns the value of auto_run_lwt.
Modifies auto_run_lwt.
If true (the default) toplevel Async expressions are automatically run with in a separate thread with Thread_safe.block_on_async_exn. i.e. if you type:
after (Time.Span.of_s 1.0)
this will be replaced by:
Thread_safe.block_on_async_exn (fun () -> after (Time.Span.of_s 1.0))
Returns the value of auto_run_async.
Modifies auto_run_async.
Action that add the phrase terminator at the end of the current phrase and accepts it. For instance to avoid typing ;;, add this to your ~/.config/utop/init.ml:
#require "lambda-term";;
@@ -21,4 +21,4 @@
Stdlib.Buffer.t ->
Stdlib.Format.formatter list ->
(unit -> 'a) ->
- 'a
collect_formatters buf pps f executes f and redirect everything it prints on pps to buf.
discard_formatters pps f executes f, dropping everything it prints on pps.
compiler-libs reexports
\ No newline at end of file
+ 'acollect_formatters buf pps f executes f and redirect everything it prints on pps to buf.
discard_formatters pps f executes f, dropping everything it prints on pps.
UTop_compat.ExpUTop_compatUTop_compatmodule Exp : sig ... endUTop_completeOCaml completion.
complete ~phrase_terminator ~input returns the start of the completed word in input and the list of possible completions with their suffixes.
UTop_completeOCaml completion.
complete ~phrase_terminator ~input returns the start of the completed word in input and the list of possible completions with their suffixes.
UTop_historyval create : unit -> tCreate a new, empty history
val add_input : t -> string -> unitAdd an input
val add_output : t -> string -> unitAdd an output
val add_error : t -> string -> unitAdd an error
val add_warnings : t -> string -> unitAdd a warning
val add_bad_input : t -> string -> unitAdd an input that resulted in an error
UTop_historyval create : unit -> tCreate a new, empty history
val add_input : t -> string -> unitAdd an input
val add_output : t -> string -> unitAdd an output
val add_error : t -> string -> unitAdd an error
val add_warnings : t -> string -> unitAdd a warning
val add_bad_input : t -> string -> unitAdd an input that resulted in an error
UTop_lexerval lex_string : string -> (UTop_token.t * UTop_token.location) listlex_string str returns all the tokens contained in str.
UTop_lexerval lex_string : string -> (UTop_token.t * UTop_token.location) listlex_string str returns all the tokens contained in str.
UTop_mainException raised when a signal that should terminate the process is received. The argument is the signal number.
utop raises this exception for SIGHUP and SIGTERM by default.
val interact :
- ?search_path:string list ->
- ?build_dir:string ->
- unit:string ->
- loc:(string * int * int * int) ->
- values:value list ->
+UTop_main (utop.UTop_main) Module UTop_main
Exception raised when a signal that should terminate the process is received. The argument is the signal number.
utop raises this exception for SIGHUP and SIGTERM by default.
val interact :
+ ?search_path:string list ->
+ ?build_dir:string ->
+ unit:string ->
+ loc:(string * int * int * int) ->
+ values:value list ->
unit ->
- unit
\ No newline at end of file
+ unitUTop_private.Default_pathsUTop_private.Default_pathsUTop_privatemodule Default_paths : sig ... endval set_key_sequence :
- ?step:React.step ->
+UTop_private (utop.UTop_private) Module UTop_private
module Default_paths : sig ... endval ui : ui React.signalval set_ui : ?step:React.step -> ui -> unitval ui : ui React.signalval set_ui : ?step:React.step -> ui -> unit
\ No newline at end of file
+ unitUTop_stylesStyled loaded from ~/.utoprc
type styles = {mutable style_keyword : LTerm_style.t;mutable style_symbol : LTerm_style.t;mutable style_ident : LTerm_style.t;mutable style_module : LTerm_style.t;mutable style_constant : LTerm_style.t;mutable style_char : LTerm_style.t;mutable style_string : LTerm_style.t;mutable style_quotation : LTerm_style.t;mutable style_comment : LTerm_style.t;mutable style_doc : LTerm_style.t;mutable style_blanks : LTerm_style.t;mutable style_error : LTerm_style.t;mutable style_directive : LTerm_style.t;mutable style_paren : LTerm_style.t;mutable style_font : string option;mutable style_foreground : LTerm_style.color option;mutable style_background : LTerm_style.color option;mutable style_cursor : LTerm_style.color option;}Type of utop styles.
val styles : stylesThe styles in use.
val stylise :
+UTop_styles (utop.UTop_styles) Module UTop_styles
Styled loaded from ~/.utoprc
type styles = {mutable style_keyword : LTerm_style.t;mutable style_symbol : LTerm_style.t;mutable style_ident : LTerm_style.t;mutable style_module : LTerm_style.t;mutable style_constant : LTerm_style.t;mutable style_char : LTerm_style.t;mutable style_string : LTerm_style.t;mutable style_quotation : LTerm_style.t;mutable style_comment : LTerm_style.t;mutable style_doc : LTerm_style.t;mutable style_blanks : LTerm_style.t;mutable style_error : LTerm_style.t;mutable style_directive : LTerm_style.t;mutable style_paren : LTerm_style.t;mutable style_font : string option;mutable style_foreground : LTerm_style.color option;mutable style_background : LTerm_style.color option;mutable style_cursor : LTerm_style.color option;
}Type of utop styles.
val styles : stylesThe styles in use.
val stylise :
(UTop_token.location -> LTerm_style.t -> unit) ->
(UTop_token.t * UTop_token.location) list ->
- unitstylise apply tokens calls apply on all token locations with the associated style.
\ No newline at end of file
+ unitstylise apply tokens calls apply on all token locations with the associated style.
UTop_tokenTokens.
The type of tokens is semi-structured: parentheses construct and quotations are nested and others tokens are flat list.
type location = {idx1 : int;Start position in unicode characters.
*)idx2 : int;Stop position in unicode characters.
*)ofs1 : int;Start position in bytes.
*)ofs2 : int;Stop position in bytes.
*)}Locations in the source string, which is encoded in UTF-8.
type t = | Symbol of string| Lident of string| Uident of string| Constant of string| Char| String of int * boolString (quote_size, terminated).
| Comment of comment_kind * boolComment (kind, terminated).
| Blanks| Error| Quotation of (quotation_item * location) list * boolQuotation (items, terminated).
UTop_tokenTokens.
The type of tokens is semi-structured: parentheses construct and quotations are nested and others tokens are flat list.
type location = {idx1 : int;Start position in unicode characters.
*)idx2 : int;Stop position in unicode characters.
*)ofs1 : int;Start position in bytes.
*)ofs2 : int;Stop position in bytes.
*)}Locations in the source string, which is encoded in UTF-8.
type t = | Symbol of string| Lident of string| Uident of string| Constant of string| Char| String of int * boolString (quote_size, terminated).
| Comment of comment_kind * boolComment (kind, terminated).
| Blanks| Error| Quotation of (quotation_item * location) list * boolQuotation (items, terminated).
This library exposes the following toplevel modules:
UTop UTop configuration.UTop_compat UTop_complete OCaml completion.UTop_history UTop_lexer UTop_main UTop_private UTop_styles Styled loaded from ~/.utoprcUTop_token Tokens.This library exposes the following toplevel modules:
UTop UTop configuration.UTop_compat UTop_complete OCaml completion.UTop_history UTop_lexer UTop_main UTop_private UTop_styles Styled loaded from ~/.utoprcUTop_token Tokens.