package ocolor

  1. Overview
  2. Docs
Print with style in your terminal using Format's semantic tags

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (6)

Authors

  1. M
    Marc Chevalier <ocolor@marc-chevalier.com>

Maintainers

  1. M
    Marc Chevalier <ocolor@marc-chevalier.com>

Sources

1.1.tar.gz
md5=094b701f30af41b89f554e978cb0762c
sha512=b558fb735d28c262b0cf047835df2bc59e89daf44fbaf55b3d73293457713cb2a45805965f4bd6aafac1e7bc6325b3e70ec59d3e4a096b25e99072fee68ac8ce

doc/ocolor/Ocolor_printf/index.html

Module Ocolor_printf

Printf-friendly functions

These functions are useful when trying to print with styles with Printf. However, they are a very bad choice. They perform a context-free formatting. For instance, there is no way to end the current style and restore the previous, like stack-base functions of Ocolor_format do. They just print the desired style and keep no track of the current state.

Thus, it's better to use Ocolor_format as much as possible. Moreover, Format provide a nice way of composing printers with %a and Format.asprintf. Even if you don't like boxes, Format.asprintf and semantic tags are cool.

So, here are the Printf-friendly functions. Use with care, and preferably, not at all.

fprintf

%a

val apply_style : out_channel -> Ocolor_types.style -> unit
val apply_styles : out_channel -> Ocolor_types.style list -> unit
val fg_color4 : out_channel -> Ocolor_types.color4 -> unit
val fg_color8 : out_channel -> Ocolor_types.color8 -> unit
val fg_color24 : out_channel -> Ocolor_types.color24 -> unit
val bg_color4 : out_channel -> Ocolor_types.color4 -> unit
val bg_color8 : out_channel -> Ocolor_types.color8 -> unit
val bg_color24 : out_channel -> Ocolor_types.color24 -> unit

%t

val default_fg : out_channel -> unit
val fg_rgb : int -> int -> int -> out_channel -> unit
val default_bg : out_channel -> unit
val bg_rgb : int -> int -> int -> out_channel -> unit
val reset : out_channel -> unit

sprintf

%a

val s_apply_style : unit -> Ocolor_types.style -> string
val s_apply_styles : unit -> Ocolor_types.style list -> string

Printf-like

Just like printf but perform automatic reset after printing if Ocolor_config.auto_reset is set

val fprintf : out_channel -> ('a, out_channel, unit) format -> 'a
val kfprintf : (out_channel -> unit) -> out_channel -> ('a, out_channel, unit) format -> 'a
val sprintf : ('a, unit, string, string) format4 -> 'a
val printf : ('a, out_channel, unit) format -> 'a
val kprintf : (out_channel -> unit) -> ('a, out_channel, unit) format -> 'a

Handy printers

val pp_bool_generic : ?false_style:Ocolor_types.style list -> ?true_style:Ocolor_types.style list -> out_channel -> bool -> unit
val pp_bool : out_channel -> bool -> unit
val pp_list_generic : ?left:string -> ?sep:string -> ?right:string -> ?delim_style:Ocolor_types.style list -> ?sep_style:Ocolor_types.style list -> ?elem_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> out_channel -> 'a list -> unit
val pp_list : (out_channel -> 'a -> unit) -> out_channel -> 'a list -> unit
val pp_option_generic : ?none:string -> ?none_style:Ocolor_types.style list -> ?some_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> out_channel -> 'a option -> unit
val pp_option : (out_channel -> 'a -> unit) -> out_channel -> 'a option -> unit
val pp_pair_generic : ?left:string -> ?sep:string -> ?right:string -> ?delim_style:Ocolor_types.style list -> ?sep_style:Ocolor_types.style list -> ?elem_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> out_channel -> ('a * 'b) -> unit
val pp_pair : (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> out_channel -> ('a * 'b) -> unit
val pp_3_tuple_generic : ?left:string -> ?sep:string -> ?right:string -> ?delim_style:Ocolor_types.style list -> ?sep_style:Ocolor_types.style list -> ?elem_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> out_channel -> ('a * 'b * 'c) -> unit
val pp_3_tuple : (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> out_channel -> ('a * 'b * 'c) -> unit
val pp_4_tuple_generic : ?left:string -> ?sep:string -> ?right:string -> ?delim_style:Ocolor_types.style list -> ?sep_style:Ocolor_types.style list -> ?elem_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> (out_channel -> 'd -> unit) -> out_channel -> ('a * 'b * 'c * 'd) -> unit
val pp_4_tuple : (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> (out_channel -> 'd -> unit) -> out_channel -> ('a * 'b * 'c * 'd) -> unit
val pp_5_tuple_generic : ?left:string -> ?sep:string -> ?right:string -> ?delim_style:Ocolor_types.style list -> ?sep_style:Ocolor_types.style list -> ?elem_style:Ocolor_types.style list -> (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> (out_channel -> 'd -> unit) -> (out_channel -> 'e -> unit) -> out_channel -> ('a * 'b * 'c * 'd * 'e) -> unit
val pp_5_tuple : (out_channel -> 'a -> unit) -> (out_channel -> 'b -> unit) -> (out_channel -> 'c -> unit) -> (out_channel -> 'd -> unit) -> (out_channel -> 'e -> unit) -> out_channel -> ('a * 'b * 'c * 'd * 'e) -> unit