package matrix

  1. Overview
  2. Docs
Fast, modern terminal toolkit for OCaml

Install 

dune-project
 Dependency

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

Authors

  1. Thibaut Mattio

Maintainers

  1. Thibaut Mattio

Sources

mosaic-0.1.0.tbz
sha256=9e4e90d17f9b2af1b07071fe425bc2c519c849c4f1d1ab73cde512be2d874849
sha512=06e9c4a741590942e81a27738d0b5c0413fafec8cf3b7dae047ad69f155e7b718aa4223818dc161b7d028efffcfd3365905e264d6fd31d453910ddfa91dcf9b9

doc/matrix.ansi/Ansi/Style/index.html

Module Ansi.StyleSource

Terminal text styles.

Terminal text styles.

A style aggregates foreground color, background color, text attributes, and an optional hyperlink URL into an immutable value. Styles compose with overlay semantics: colors and hyperlinks from the overlay replace those in the base, while attributes are unioned. See merge.

Styles

Sourcetype t = private {
  1. fg : Color.t option;
  2. bg : Color.t option;
  3. attrs : Attr.t;
}

The type for styles. Fields are exposed for pattern matching but cannot be modified directly. Use make or the modifier functions to create new instances.

Sourceval default : t

default is the empty style: no colors, no attributes, no hyperlink.

Constructors

Sourceval make : ?fg:Color.t -> ?bg:Color.t -> ?bold:bool -> ?dim:bool -> ?italic:bool -> ?underline:bool -> ?blink:bool -> ?inverse:bool -> ?hidden:bool -> ?strikethrough:bool -> ?overline:bool -> ?double_underline:bool -> ?framed:bool -> ?encircled:bool -> ?link:string -> unit -> t

make ?fg ?bg ... () is a style with the given properties. fg and bg default to None (inherit terminal default). Boolean attributes default to false. link defaults to None.

Modifiers

Colors

Sourceval fg : Color.t -> t -> t

fg c s is s with foreground set to c.

Sourceval bg : Color.t -> t -> t

bg c s is s with background set to c.

Sourceval with_no_fg : t -> t

with_no_fg s is s with no foreground (inherits terminal default).

Sourceval with_no_bg : t -> t

with_no_bg s is s with no background (inherits terminal default).

Attributes

Sourceval with_attrs : Attr.t -> t -> t

with_attrs a s is s with attributes replaced by a.

Sourceval overlay_attrs : t -> Attr.t -> t

overlay_attrs s a is s with a unioned into its existing attributes.

Sourceval add_attr : Attr.flag -> t -> t

add_attr f s is s with f enabled.

Sourceval remove_attr : Attr.flag -> t -> t

remove_attr f s is s with f disabled.

Sourceval with_bold : bool -> t -> t

with_bold b s sets or clears bold on s.

Sourceval with_dim : bool -> t -> t

with_dim b s sets or clears dim on s.

Sourceval with_italic : bool -> t -> t

with_italic b s sets or clears italic on s.

Sourceval with_underline : bool -> t -> t

with_underline b s sets or clears underline on s.

Sourceval with_double_underline : bool -> t -> t

with_double_underline b s sets or clears double underline on s.

with_blink b s sets or clears blink on s.

Sourceval with_inverse : bool -> t -> t

with_inverse b s sets or clears inverse on s.

Sourceval with_hidden : bool -> t -> t

with_hidden b s sets or clears hidden on s.

Sourceval with_strikethrough : bool -> t -> t

with_strikethrough b s sets or clears strikethrough on s.

Sourceval with_overline : bool -> t -> t

with_overline b s sets or clears overline on s.

Sourceval with_framed : bool -> t -> t

with_framed b s sets or clears framed on s.

Sourceval with_encircled : bool -> t -> t

with_encircled b s sets or clears encircled on s.

hyperlink url s is s with OSC 8 hyperlink set to url.

link s is the hyperlink URL of s, if any.

unlink s is s with the hyperlink removed.

Composition

Sourceval merge : base:t -> overlay:t -> t

merge ~base ~overlay is the style combining base and overlay:

  • Colors: overlay takes precedence. If overlay.fg is None, base.fg is kept.
  • Attributes: union of base and overlay attributes.
  • Link: overlay takes precedence.
Sourceval (++) : t -> t -> t

base ++ overlay is merge ~base ~overlay.

Sourceval resolve : t list -> t

resolve ss merges ss left to right starting from default.

Predicates and comparisons

Sourceval equal : t -> t -> bool

equal a b is true iff all colors, attributes, and links are identical.

Sourceval compare : t -> t -> int

compare a b orders a and b. The order is compatible with equal.

Sourceval hash : t -> int

hash s is a hash of s. Compatible with equal.

Emission

Sourceval to_sgr_codes : ?prev:t -> t -> int list

to_sgr_codes ~prev s is the minimal SGR codes needed to transition from prev to s. prev defaults to default. Returns [] if prev and s are equal. Returns [0] if s is default.

Sourceval sgr_sequence : ?prev:t -> t -> string

sgr_sequence ~prev s is the ANSI escape string for to_sgr_codes ~prev s. Returns "" if no transition is needed.

Sourceval emit : ?prev:t -> t -> Writer.t -> unit

emit ~prev s w writes the minimal SGR codes to w to transition from prev (defaults to default) to s.

Handles shared disable codes correctly (Bold/Dim share 22, Underline/Double_underline share 24, Framed/Encircled share 54).

Note. Emits SGR sequences only. The link field is not emitted here; use Ansi.render for hyperlink support.

Sourceval styled : ?reset:bool -> t -> string -> string

styled ~reset s str is str wrapped in the escape codes for s. If reset is true (default false), appends a reset sequence.

Formatting

Sourceval pp : Format.formatter -> t -> unit

pp formats a style for inspection (e.g. "Style\{fg=#FF0000, attrs=[Bold, Underline]\}").