Source

ocaml-core / base / core / extended / lib / console.mli

The branch 'bash' does not exist.
Full commit
open Core.Std
  (** Printing on console tty's  *)

(** Handling of ansi codes. *)
module Ansi : sig
  val kill_line : unit -> unit
  val bell : unit -> unit
  val home_cursor : unit -> unit
  val save_cursor : unit -> unit
  val unsave_cursor : unit -> unit

  type color = [
  | `Black
  | `Red
  | `Green
  | `Yellow
  | `Blue
  | `Magenta
  | `Cyan
  | `White
  ]

  type attr = [
  | `Bright
  | `Dim
  | `Underscore
  | `Reverse
  | color
  | `Bg of color
  ]

  val printf  : attr list -> ('a, out_channel, unit) format -> 'a
  val eprintf : attr list -> ('a, out_channel, unit) format -> 'a

  val output_string : attr list -> out_channel -> string -> unit
  val output : attr list -> out_channel -> string -> int -> int -> unit

  (* Create string with embedded formatting codes *)
  val string_with_attr : attr list -> string -> string

end

val is_color_tty : unit -> bool

(** The width in characters of the current output. Returns [None] if stdout is
    not connected to a tty.*)
val width : unit -> [ `Cols of int | `Not_a_tty | `Not_available ]

(** print a list in a columnize way (like the output of ls) *)
val print_list : out_channel -> (string * Ansi.attr list) list -> unit