package textutils_kernel

  1. Overview
  2. Docs
Text output utilities

Install 

dune-project
 Dependency

github.com MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

textutils_kernel-v0.14.0.tar.gz
sha256=633c2079cb5250dffee6a1329b28d63fa863a66489369f85f9dcc0e4256db0f0
md5=60108803a21379909ca35d2ba96d3843

doc/textutils_kernel.text_block/Text_block/index.html

Module Text_blockSource

Sourcetype t

two dimensional blocks of text

Sourceval sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
include Core_kernel.Invariant.S with type t := t
Sourceval invariant : t -> unit
Sourceval nil : t

the empty block. a left and right unit to both hcat and vcat

Sourceval fill : char -> width:int -> height:int -> t

fill and space assume width and height are non-negative

Sourceval space : width:int -> height:int -> t
Sourcetype valign = [
  1. | `Top
  2. | `Bottom
  3. | `Center
]

vertical and horizontal alignment specifications

Sourcetype halign = [
  1. | `Left
  2. | `Right
  3. | `Center
]
Sourceval text : ?align:halign -> ?max_width:int -> string -> t

a basic block of text, split on newlines and horizontally aligned as specified.

If max_width is provided, split on whitespace and wrap words to respect the request. So long as no words are longer than max_width, the resulting text block will be no wider than max_width

Sourceval textf : ?align:halign -> ?max_width:int -> ('r, unit, string, t) Core_kernel.format4 -> 'r
Sourceval vcat : ?align:halign -> ?sep:t -> t list -> t

vertical and horizontal concatenation with alignment

Sourceval hcat : ?align:valign -> ?sep:t -> t list -> t
Sourceval width : t -> int

text block dimensions

Sourceval height : t -> int
Sourceval valign : valign -> t list -> t list

vertical and horizontal sequence alignment. Both valign and halign return a list of the same length as the input, with the corresponding elements padded to the appropriate alignment.

If you have a list of a statically known length, using With_static_lengths.valign or With_static_lengths.halign below will let the type checker know that the length of the returned list is equal to the length of the input list.

Sourceval halign : halign -> t list -> t list
Sourceval hstrut : int -> t

empty blocks with either horizontal or vertical extent -- useful for specifying a minimum width or height in conjunction with valign or halign, respectively

Sourceval vstrut : int -> t
Sourceval ansi_escape : ?prefix:string -> ?suffix:string -> t -> t

wrap a block with an ANSI escape sequence. The prefix and suffix arguments should render with zero width and height.

Sourceval render : t -> string

render a block of text as a string

Sourceval table : ?sep_width:int -> [ `Cols of (t list * halign) list ] -> [ `Rows of t list ]
Sourceval compress_table_header : ?sep_width:int -> [ `Cols of (t * t list * halign) list ] -> [ `Header of t ] * [ `Rows of t list ]

compress table header according to column widths. Input: a list of columns of the form (title, values, column alignment). Output: one header block and row sequence. Raises: if the values lists are not the same length in each column. Example:

                                             first name
  age  first name  last name            age  |     last name
  |    |           |            ==>     |    |     |
  30   sue         smith                30   sue   smith
  18   bill        rodriguez            18   bill  rodriguez
  76   rick        jones                76   rick  jones
Sourceval vsep : t

vsep = vstrut 1

Sourceval hsep : t

hsep = hstrut 1

Sourceval indent : ?n:int -> t -> t

indent ~n t = hcat [hstrut n; t]. n defaults to 2

Sourceval sexp : ('a -> Core_kernel.Sexp.t) -> 'a -> t

sexp sexp_of_a a = sexp_of_a a |> Sexp.to_string |> text

Sourcemodule With_static_lengths : sig ... end

Provide versions of halign and valign with the invariant about list length encoded into the types.