jon.recoil.org

Module OpamStd.FormatSource

Querying information
Sourceval visual_length : string -> int

Returns the length of the string in terminal chars, ignoring ANSI color sequences from OpamConsole.colorise

Text formatting functions
Sourceval cut_at_visual : string -> int -> string

Truncates the string to not visually get over width columns

Sourceval indent_left : string -> ?visual:string -> int -> string

left indenting. ~visual can be used to indent eg. ANSI colored strings and should correspond to the visible characters of s

Sourceval indent_right : string -> ?visual:string -> int -> string
Sourceval align_table : string list list -> string list list

Pads fields in a table with spaces for alignment.

Sourceval reformat : ?start_column:int -> ?indent:int -> ?width:int -> string -> string

Cut long lines in string according to the terminal width

Sourceval itemize : ?bullet:string -> ('a -> string) -> 'a list -> string

Convert a list of items to string as a dashed list (already reformats supposes no additional left margin: don't use within OpamConsole.error or similar)

Sourceval pretty_list : ?last:string -> string list -> string

Display a pretty list: "x";"y";"z" -> "x, y and z". "and" can be changed by specifying last

Sourceval as_aligned_table : ?width:int -> string list -> string list list

Splits a list of strings so that it can be printed as a table that should fit on screen