Data.Text.Escaped

Documentation

data Escaped

Bits of escaped text

Constructors

Plain Text

Reset

Bold

Dim

Underlined

Blink

Reverse

Hidden

FG Color

BG Color

Instances

Eq Escaped

Defined in Data.Text.Escaped

Methods

(==) :: Escaped -> Escaped -> Bool

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

Show Escaped

Defined in Data.Text.Escaped

Methods

showsPrec :: Int -> Escaped -> ShowS

show :: Escaped -> String

showList :: [Escaped] -> ShowS

IsString Escaped

Defined in Data.Text.Escaped

Methods

fromString :: String -> Escaped

Semigroup Escaped

Defined in Data.Text.Escaped

Methods

(<>) :: Escaped -> Escaped -> Escaped

sconcat :: NonEmpty Escaped -> Escaped

stimes :: Integral b => b -> Escaped -> Escaped

Monoid Escaped

Defined in Data.Text.Escaped

Methods

mempty :: Escaped

mappend :: Escaped -> Escaped -> Escaped

mconcat :: [Escaped] -> Escaped

Arbitrary Escaped

Defined in Data.Text.Escaped

Methods

arbitrary :: Gen Escaped

shrink :: Escaped -> [Escaped]

data Color

Supported colors

Constructors

Default

Custom Int

Black

Blue

Cyan

DarkGray

Green

LightBlue

LightCyan

LightGray

LightGreen

LightMagenta

LightRed

LightYellow

Magenta

Red

White

Yellow

Instances

Eq Color

Defined in Data.Text.Escaped

Methods

(==) :: Color -> Color -> Bool

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

Show Color

Defined in Data.Text.Escaped

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Arbitrary Color

Defined in Data.Text.Escaped

Methods

arbitrary :: Gen Color

shrink :: Color -> [Color]

black :: Escaped -> Escaped

blue :: Escaped -> Escaped

cyan :: Escaped -> Escaped

darkGray :: Escaped -> Escaped

green :: Escaped -> Escaped

lightBlue :: Escaped -> Escaped

lightCyan :: Escaped -> Escaped

lightGray :: Escaped -> Escaped

lightGreen :: Escaped -> Escaped

lightMagenta :: Escaped -> Escaped

lightRed :: Escaped -> Escaped

lightYellow :: Escaped -> Escaped

magenta :: Escaped -> Escaped

red :: Escaped -> Escaped

white :: Escaped -> Escaped

yellow :: Escaped -> Escaped

fg :: Color -> Escaped -> Escaped

Escape with foreground Color, then Reset

>>> fg Red "red"
Many [FG Red,Plain "red",Reset]

bg :: Color -> Escaped -> Escaped

Escape with background Color, then Reset

>>> bg Red "red"
Many [BG Red,Plain "red",Reset]

esc :: Escaped -> Escaped -> Escaped

Apply the given escape, then Reset

>>> esc (FG Red) "red"
Many [FG Red,Plain "red",Reset]

render :: Escaped -> Text

Render an Escaped to actually-escaped Text

Examples:

>>> render "Some text via OverloadedStrings."
"Some text via OverloadedStrings."

>>> render $ Plain "Some text."
"Some text."

>>> render $ "Some " <> FG Red <> "red" <> Reset <> " text."
"Some \ESC[31mred\ESC[0m text."

>>> render $ "Some " <> blue "blue" <> " text."
"Some \ESC[34mblue\ESC[0m text."

>>> render $ "Some " <> fg (Custom 212) "color 212" <> " text."
"Some \ESC[38;5;212mcolor 212\ESC[0m text."

plain :: Escaped -> Text

Render only the Text parts

Examples

>>> plain $ Plain "Some text."
"Some text."

>>> plain $ "Some " <> FG Red <> "red" <> Reset <> " text."
"Some red text."

visibleLength :: Escaped -> Int

Calculate the visible length of an Escaped

terminalRenderer :: IO (Escaped -> Text)

An IO action to produce the appropriate renderer for a terminal

Returns render if stdout is a terminal, otherwise plain

>>> r <- terminalRenderer
>>> print $ r $ red "red text"
"red text"