Sindre.Formatting

Parser and definition of the dzen2-inspired formatting language used by Sindre. A format string is a sequence of commands changing drawing option parameters, and things to draw.

Documentation

data Format

A formatting command is either a change to the drawing state, or a string to be printed at the current location.

Constructors

Fg String

Draw text in the given colour.

DefFg

Draw text in the default colour.

Bg String

Draw the background in the given colour.

DefBg

Draw the background in the default colour.

Text Text

Draw the given string.

Instances

Eq Format

Defined in Sindre.Formatting

Methods

(==) :: Format -> Format -> Bool

(/=) :: Format -> Format -> Bool

Ord Format

Defined in Sindre.Formatting

Methods

compare :: Format -> Format -> Ordering

(<) :: Format -> Format -> Bool

(<=) :: Format -> Format -> Bool

(>) :: Format -> Format -> Bool

(>=) :: Format -> Format -> Bool

max :: Format -> Format -> Format

min :: Format -> Format -> Format

Show Format

Defined in Sindre.Formatting

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Mold FormatString

Defined in Sindre.Formatting

Methods

mold :: Value -> Maybe FormatString

unmold :: FormatString -> Value

type FormatString = [Format]

A list of formatting commands, interpreted left-to-right.

textContents :: FormatString -> Text

The human-readable part of a format string, with formatting directives stripped.

startBg :: FormatString -> Maybe String

The first background colour preceding any default background colour or text entry specified in the format string, if any.

parseFormatString :: Text -> Either String FormatString

Parse a format string, returning either an error message or the result of the parse.

unparseFormatString :: FormatString -> Text

Prettyprint a FormatString to a string that, when parsed by parseFormatString, results in the original FormatString