package lambda-term

  1. Overview
  2. Docs
Terminal manipulation library for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (14)

Authors

  1. J
    Jérémie Dimino

Maintainers

  1. J
    jeremie@dimino.org

Sources

lambda-term-2.0.1.tbz
sha256=541cda520f42bc5551175e0d24ddec8724b9391d52da7c7253f7817972c49a5a
md5=4b4b8480fe1280e1ed2a34ed93d16675

doc/lambda-term/LTerm_text/index.html

Module LTerm_textSource

Styled text.

Sourcetype t = (Zed_char.t * LTerm_style.t) array

Type of a string with styles for each characters.

Sourceval aval_width : Zed_string.width -> int
Conversions
Sourceval of_string : Zed_string.t -> t

Creates a styled string from a string. All characters of the string have no style.

Sourceval to_string : t -> Zed_string.t

Returns the string part of a styled string.

Sourceval of_utf8 : string -> t

Creates a styled string from a utf8 string. All characters of the string have no style.

Sourceval of_string_maybe_invalid : Zed_string.t -> t

Creates a styled string from a Zed_string. All characters of the string have no style. The string may contain invalid sequences, in which case invalid bytes are escaped with the syntax \yXX.

Sourceval of_utf8_maybe_invalid : string -> t

Creates a styled string from a string. All characters of the string have no style. The string may contain invalid UTF-8 sequences, in which case invalid bytes are escaped with the syntax \yXX.

Sourceval of_rope : Zed_rope.t -> t

Creates a styled string from a rope.

Sourceval to_rope : t -> Zed_rope.t

Returns the string part of a styled string as a rope.

Sourceval stylise : string -> LTerm_style.t -> t

stylise string style creates a styled string with all styles set to style.

Parenthesis matching
Sourceval stylise_parenthesis : t -> ?paren:(Zed_char.t * Zed_char.t) list -> int -> LTerm_style.t -> unit

stylise_parenthesis text ?paren pos style searchs for parenthesis group starting or ending at pos and apply them the style style. paren is the list of parenthesis recognized.

Markup strings

Markup strings are used to conveniently define styled strings.

Sourcetype item =
  1. | S of Zed_utf8.t
    (*

    A UTF-8 encoded string.

    *)
  2. | R of Zed_rope.t
    (*

    A rope.

    *)
  3. | B_bold of bool
    (*

    Begins bold mode.

    *)
  4. | E_bold
    (*

    Ends bold mode.

    *)
  5. | B_underline of bool
    (*

    Begins underlined mode.

    *)
  6. | E_underline
    (*

    Ends underlined mode.

    *)
  7. | B_reverse of bool
    (*

    Begins reverse video mode.

    *)
  8. | E_reverse
    (*

    Ends reverse video mode.

    *)
  9. | B_fg of LTerm_style.color
    (*

    Begins foreground color.

    *)
  10. | E_fg
    (*

    Ends foreground color.

    *)
  11. | B_bg of LTerm_style.color
    (*

    Begins background color.

    *)
  12. | E_bg
    (*

    Ends background color.

    *)

Type of an item in a markup string.

Sourcetype markup = item list

Type of a markup string.

Sourceval eval : markup -> t

eval makrup evaluates a markup strings as a styled string.

Styled formatters
Sourceval make_formatter : ?read_color:(Format.tag -> LTerm_style.t) -> unit -> (unit -> t) * Format.formatter

Create a formatter on a styled string. Returns a tuple get_content, fmt. Calling get_content () will flush the formatter and output the resulting styled string.

If a read_color function is provided, Format's tag are enabled and read_color is used to transform tags into styles.

Sourceval pp_with_style : (LTerm_style.t -> Format.tag) -> LTerm_style.t -> ('b, Format.formatter, unit, unit) format4 -> Format.formatter -> 'b

pp_with_style f will create a pretty printer analogous to stylise, using f to encode style into tags. Will only work on a formatter with tag enabled.

Sourceval styprintf : ?read_color:(Format.tag -> LTerm_style.t) -> ('a, Format.formatter, unit, t) format4 -> 'a

Equivalent of Format.sprintf for styled strings.

Sourceval kstyprintf : ?read_color:(Format.tag -> LTerm_style.t) -> (t -> 'a) -> ('b, Format.formatter, unit, 'a) format4 -> 'b

Equivalent of Format.ksprintf for styled strings.