package ocolor

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Printf-friendly functions
1. fprintf
  1. %a
  2. %t
2. sprintf
  1. %a
3. Printf-like

ocolor
- README
- Library ocolor
- Sources
  - ocolor
    
    ocolor_color_space.ml
    
    ocolor_config.ml
    
    ocolor_converter.ml
    
    ocolor_format.ml
    
    ocolor_palettes.ml
    
    ocolor_pp.ml
    
    ocolor_printf.ml
    
    ocolor_sgr.ml
    
    ocolor_types.ml
    
    ocolor_x11.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Ocolor_printf`Source

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

Sourceval apply_style : out_channel -> Ocolor_types.style -> unit

Sourceval apply_styles : out_channel -> Ocolor_types.style list -> unit

Sourceval fg_color4 : out_channel -> Ocolor_types.color4 -> unit

Sourceval fg_color8 : out_channel -> Ocolor_types.color8 -> unit

Sourceval fg_color24 : out_channel -> Ocolor_types.color24 -> unit

Sourceval bg_color4 : out_channel -> Ocolor_types.color4 -> unit

Sourceval bg_color8 : out_channel -> Ocolor_types.color8 -> unit

Sourceval bg_color24 : out_channel -> Ocolor_types.color24 -> unit

%t

Sourceval default_fg : out_channel -> unit

Sourceval fg_rgb : int -> int -> int -> out_channel -> unit

Sourceval default_bg : out_channel -> unit

Sourceval bg_rgb : int -> int -> int -> out_channel -> unit

Sourceval reset : out_channel -> unit

sprintf

%a

Sourceval s_apply_style : unit -> Ocolor_types.style -> string

Sourceval 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

Sourceval fprintf : out_channel -> ('a, out_channel, unit) format -> 'a

val kfprintf : 
  (out_channel -> unit) ->
  out_channel ->
  ('a, out_channel, unit) format ->
  'a

Sourceval sprintf : ('a, unit, string, string) format4 -> 'a

Sourceval printf : ('a, out_channel, unit) format -> 'a

Sourceval kprintf : (out_channel -> unit) -> ('a, out_channel, unit) format -> 'a

Sourcemodule StylingPrettyPrinters : sig ... end

include module type of struct include StylingPrettyPrinters end

Sourcetype !'a pp = out_channel -> 'a -> unit

val pp_bool_generic : 
  ?false_style:Ocolor_types.style list ->
  ?true_style:Ocolor_types.style list ->
  bool pp

Sourceval pp_bool : bool pp

val pp_option_more_generic : 
  ?none:string ->
  ?none_style:Ocolor_types.style list ->
  ?some_style:Ocolor_types.style list ->
  ?some_format:
    (Ocolor_types.style list pp ->
      Ocolor_types.style list ->
      'a pp ->
      'a ->
      unit pp ->
      unit ->
      unit,
      out_channel,
      unit,
      unit,
      unit,
      unit)
      format6 ->
  ?none_format:
    (Ocolor_types.style list pp ->
      Ocolor_types.style list ->
      string ->
      unit pp ->
      unit ->
      unit,
      out_channel,
      unit,
      unit,
      unit,
      unit)
      format6 ->
  'a pp ->
  'a option pp

val pp_option_generic : 
  ?none:string ->
  ?none_style:Ocolor_types.style list ->
  ?some_style:Ocolor_types.style list ->
  'a pp ->
  'a option pp

Sourceval pp_option : 'a pp -> 'a option pp

val pp_result_more_generic : 
  ?ok_style:Ocolor_types.style list ->
  ?error_style:Ocolor_types.style list ->
  ?ok_format:
    (Ocolor_types.style list pp ->
      Ocolor_types.style list ->
      'a pp ->
      'a ->
      unit pp ->
      unit ->
      unit,
      out_channel,
      unit,
      unit,
      unit,
      unit)
      format6 ->
  ?error_format:
    (Ocolor_types.style list pp ->
      Ocolor_types.style list ->
      'b pp ->
      'b ->
      unit pp ->
      unit ->
      unit,
      out_channel,
      unit,
      unit,
      unit,
      unit)
      format6 ->
  'a pp ->
  'b pp ->
  ('a, 'b) result pp

val pp_result_generic : 
  ?ok_style:Ocolor_types.style list ->
  ?error_style:Ocolor_types.style list ->
  'a pp ->
  'b pp ->
  ('a, 'b) result pp

Sourceval pp_result : 'a pp -> 'b pp -> ('a, 'b) result pp

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 ->
  'a pp ->
  'b pp ->
  ('a * 'b) pp

Sourceval pp_pair : 'a pp -> 'b pp -> ('a * 'b) pp

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 ->
  'a pp ->
  'b pp ->
  'c pp ->
  ('a * 'b * 'c) pp

Sourceval pp_3_tuple : 'a pp -> 'b pp -> 'c pp -> ('a * 'b * 'c) pp

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 ->
  'a pp ->
  'b pp ->
  'c pp ->
  'd pp ->
  ('a * 'b * 'c * 'd) pp

Sourceval pp_4_tuple : 'a pp -> 'b pp -> 'c pp -> 'd pp -> ('a * 'b * 'c * 'd) pp

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 ->
  'a pp ->
  'b pp ->
  'c pp ->
  'd pp ->
  'e pp ->
  ('a * 'b * 'c * 'd * 'e) pp

val pp_5_tuple : 
  'a pp ->
  'b pp ->
  'c pp ->
  'd pp ->
  'e pp ->
  ('a * 'b * 'c * 'd * 'e) pp

val pp_iterable_generic : 
  ?left:string ->
  ?sep:string ->
  ?right:string ->
  ?empty:string ->
  ?delim_style:Ocolor_types.style list ->
  ?sep_style:Ocolor_types.style list ->
  ?elem_style:Ocolor_types.style list ->
  ?empty_style:Ocolor_types.style list ->
  (('a -> unit) -> 'b -> unit) ->
  'a pp ->
  'b pp

Sourceval pp_iterable : (('a -> unit) -> 'b -> unit) -> 'a pp -> 'b pp

val pp_list_generic : 
  ?left:string ->
  ?sep:string ->
  ?right:string ->
  ?empty:string ->
  ?delim_style:Ocolor_types.style list ->
  ?sep_style:Ocolor_types.style list ->
  ?elem_style:Ocolor_types.style list ->
  ?empty_style:Ocolor_types.style list ->
  'a pp ->
  'a list pp

Sourceval pp_list : 'a pp -> 'a list pp

val pp_array_generic : 
  ?left:string ->
  ?sep:string ->
  ?right:string ->
  ?empty:string ->
  ?delim_style:Ocolor_types.style list ->
  ?sep_style:Ocolor_types.style list ->
  ?elem_style:Ocolor_types.style list ->
  ?empty_style:Ocolor_types.style list ->
  'a pp ->
  'a array pp

Sourceval pp_array : 'a pp -> 'a array pp

val pp_iterable_mapping_more_generic : 
  ?left:string ->
  ?sep:string ->
  ?right:string ->
  ?empty:string ->
  ?delim_style:Ocolor_types.style list ->
  ?sep_style:Ocolor_types.style list ->
  ?empty_style:Ocolor_types.style list ->
  (('a -> 'b -> unit) -> 'c -> unit) ->
  ('a * 'b) pp ->
  'c pp

val pp_iterable_mapping_generic : 
  ?left:string ->
  ?sep:string ->
  ?right:string ->
  ?mapsto:string ->
  ?empty:string ->
  ?delim_style:Ocolor_types.style list ->
  ?sep_style:Ocolor_types.style list ->
  ?mapsto_style:Ocolor_types.style list ->
  ?key_style:Ocolor_types.style list ->
  ?value_style:Ocolor_types.style list ->
  ?empty_style:Ocolor_types.style list ->
  (('a -> 'b -> unit) -> 'c -> unit) ->
  'a pp ->
  'b pp ->
  'c pp

val pp_iterable_mapping : 
  (('a -> 'b -> unit) -> 'c -> unit) ->
  'a pp ->
  'b pp ->
  'c pp

Sourcemodule NonStylingPrettyPrinters : sig ... end