opam-core 2.2.0~beta3 · OCaml Package

Console output, ANSI color, logging and user querying

Global configuration parameters (read from OpamGlobalConfig, and the environment when necessary)

val debug : unit -> bool

val verbose : unit -> bool

val color : unit -> bool

val utf8 : unit -> bool

val utf8_extended : unit -> bool

val disp_status_line : unit -> bool

General text formatting

type text_style = [

| `black
| `blue
| `bold
| `crossed
| `cyan
| `green
| `magenta
| `red
| `underline
| `white
| `yellow

]

Settable attributes for ANSI terminal output. Nesting is generally not handled.

val colorise : text_style -> string -> string

Helper coloring functions. Returns the string unchanged if color is disabled

val colorise' : text_style list -> string -> string

val acolor : text_style -> unit -> string -> string

val acolor_w : int -> text_style -> Stdlib.Format.formatter -> string -> unit

module Symbols : sig ... end

val utf8_symbol : 
  Stdlib.Uchar.t ->
  ?alternates:Stdlib.Uchar.t list ->
  string ->
  string

Logging

val timer : unit -> unit -> float

Timers, only active when debug is on. Returns the time between the application to each argument, in seconds

val log : 
  string ->
  ?level:int ->
  ('a, Stdlib.Format.formatter, unit) Stdlib.format ->
  'a

log section ~level fmt args. Used for debug messages, default level is 1

val slog : ('a -> string) -> Stdlib.Format.formatter -> 'a -> unit

Helper to pass stringifiers to log (use log "%a" (slog to_string) x rather than log "%s" (to_string x) to avoid costly unneeded stringifications

val error : ('a, unit, string, unit) Stdlib.format4 -> 'a

val warning : ('a, unit, string, unit) Stdlib.format4 -> 'a

val note : ('a, unit, string, unit) Stdlib.format4 -> 'a

val errmsg : ('a, unit, string, unit) Stdlib.format4 -> 'a

Message without prefix, reformat or newline, to stderr (useful to continue error messages without repeating "ERROR")

val formatted_errmsg : 
  ?indent:int ->
  ('a, unit, string, unit) Stdlib.format4 ->
  'a

val error_and_exit : 
  OpamStd.Sys.exit_reason ->
  ('a, unit, string, 'b) Stdlib.format4 ->
  'a

val msg : ('a, unit, string, unit) Stdlib.format4 -> 'a

val formatted_msg : 
  ?indent:int ->
  ('a, unit, string, unit) Stdlib.format4 ->
  'a

val header_msg : ('a, unit, string, unit) Stdlib.format4 -> 'a

val header_error : 
  ('a, unit, string, ('b, unit, string, unit) Stdlib.format4 -> 'b)
    Stdlib.format4 ->
  'a

val carriage_delete : unit -> unit

Erase the current line on stdout (doesn't flush stdout)

val status_line : ('a, unit, string, unit) Stdlib.format4 -> 'a

Display a dynamic status line to stdout, that will be erased on next call. The message should not be wider than screen nor contain newlines. Use clear_status when the status line should be erased.

val clear_status : unit -> unit

Erase the status line and restore the cursor to the start of the line

val pause : ('a, unit, string, unit) Stdlib.format4 -> 'a

Show a prompt and wait for the user to press anything.

val confirm : 
  ?require_unsafe_yes:bool ->
  ?default:bool ->
  ('a, unit, string, bool) Stdlib.format4 ->
  'a

Ask the user to press Y/y/N/n to continue (returns a boolean). Defaults to true (yes) if unspecified. If require_unsafe_yes is true, it automatically answer yes to the question if automatic answering is set to `unsafe_yes ; otherwise it will prompt and wait user input if it is set `all_yes (interactive). Its default is false.

val menu : 
  ?default:'a ->
  ?unsafe_yes:'a ->
  ?yes:'a ->
  no:'a ->
  options:('a * string) list ->
  ('b, unit, string, 'a) Stdlib.format4 ->
  'b

Prompts the user with multiple numbered choices (answer, message).

unsafe_yes, yes are the options to choose if the corresponding global options are set. no is the option to choose otherwise, when non interactive, on escape. default is the option to choose on an active empty input ("\n"). Max 35 options.

val read : ('a, unit, string, string option) Stdlib.format4 -> 'a

Read some input from the user (returns a string option)

val print_table : 
  ?cut:[ `Wrap of string | `Truncate | `None ] ->
  Stdlib.out_channel ->
  sep:string ->
  string list list ->
  unit

Prints a table; generally called on tables passed through align_table. The default cut is to wrap on stdout, stderr, keep as-is otherwise. `Wrap sep prepends sep on wrapped lines

module Tree : sig ... end

Tree printing

package opam-core