Z.IO.StdStream.Ansi

Provides utilities to build code sequences https://en.wikipedia.org/wiki/ANSI_escape_code.

> putStd . bold . italicize . color Red  $ "hello"
hello   -- bold, italicize and red

Style modifier

bold :: Builder () -> Builder ()

italicize :: Builder () -> Builder ()

Italicize some text

underline :: Builder () -> Builder ()

Add single underline to some text

color :: AnsiColor -> Builder () -> Builder ()

Colorized some text

color' :: AnsiColor -> AnsiColor -> Builder () -> Builder ()

Colorized some text with background color

palette :: PaletteColor -> Builder () -> Builder ()

Colorized some text

palette' :: PaletteColor -> PaletteColor -> Builder () -> Builder ()

Colorized some text with background color

rgb :: RGBColor -> Builder () -> Builder ()

Colorized some text

rgb' :: RGBColor -> RGBColor -> Builder () -> Builder ()

Colorized some text with background color

Control codes

cursorUp

Arguments

:: Int

Number of lines or characters to move

-> Builder ()

cursorDown

Arguments

:: Int

Number of lines or characters to move

-> Builder ()

cursorForward

Arguments

:: Int

Number of lines or characters to move

-> Builder ()

cursorBackward

Arguments

:: Int

Number of lines or characters to move

-> Builder ()

cursorDownLine

Arguments

:: Int

Number of lines to move

-> Builder ()

cursorUpLine

Arguments

:: Int

Number of lines to move

-> Builder ()

setCursorColumn

Arguments

:: Int

1-based column to move to

-> Builder ()

Code to move the cursor to the specified column. The column numbering is 1-based (that is, the left-most column is numbered 1).

setCursorPosition

Arguments

:: Int

1-based row to move to

-> Int

1-based column to move to

-> Builder ()

Code to move the cursor to the specified position (row and column). The position is 1-based (that is, the top-left corner is at row 1 column 1).

saveCursor :: Builder ()

restoreCursor :: Builder ()

clearFromCursorToScreenEnd :: Builder ()

clearFromCursorToScreenBeginning :: Builder ()

clearScreen :: Builder ()

clearFromCursorToLineEnd :: Builder ()

clearFromCursorToLineBeginning :: Builder ()

clearLine :: Builder ()

scrollPageUp

Arguments

:: Int

Number of lines to scroll by

-> Builder ()

scrollPageDown

Arguments

:: Int

Number of lines to scroll by

-> Builder ()

hideCursor :: Builder ()

showCursor :: Builder ()

setTitle

Arguments

:: Text

New Icon Name and Window Title

-> Builder ()

XTerm control sequence to set the Icon Name and Window Title.

Style codes

reset :: Builder ()

boldIntensity :: Builder ()

faintIntensity :: Builder ()

resetIntensity :: Builder ()

italicized :: Builder ()

noItalicized :: Builder ()

singleUnderline :: Builder ()

doubleUnderline :: Builder ()

noUnderline :: Builder ()

slowBlink :: Builder ()

less than 150 per minute

rapidBlink :: Builder ()

MS-DOS ANSI.SYS, 150+ per minute; not widely supported

blinkOff :: Builder ()

conceal :: Builder ()

Aka Hide, not widely supported.

reveal :: Builder ()

invert :: Builder ()

Swap foreground and background colors, inconsistent emulation

invertOff :: Builder ()

setForeground :: AnsiColor -> Builder ()

setBrightForeground :: AnsiColor -> Builder ()

setBackground :: AnsiColor -> Builder ()

setBrightBackground :: AnsiColor -> Builder ()

setPaletteForeground :: PaletteColor -> Builder ()

setPaletteBackground :: PaletteColor -> Builder ()

setRGBForeground :: RGBColor -> Builder ()

setRGBBackground :: RGBColor -> Builder ()

setDefaultForeground :: Builder ()

setDefaultBackground :: Builder ()

data AnsiColor

ANSI's eight standard colors

Constructors

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

Instances

Bounded AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

minBound :: AnsiColor

maxBound :: AnsiColor

Enum AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

succ :: AnsiColor -> AnsiColor

pred :: AnsiColor -> AnsiColor

toEnum :: Int -> AnsiColor

fromEnum :: AnsiColor -> Int

enumFrom :: AnsiColor -> [AnsiColor]

enumFromThen :: AnsiColor -> AnsiColor -> [AnsiColor]

enumFromTo :: AnsiColor -> AnsiColor -> [AnsiColor]

enumFromThenTo :: AnsiColor -> AnsiColor -> AnsiColor -> [AnsiColor]

Eq AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

(==) :: AnsiColor -> AnsiColor -> Bool

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

Ord AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

compare :: AnsiColor -> AnsiColor -> Ordering

(<) :: AnsiColor -> AnsiColor -> Bool

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

(>) :: AnsiColor -> AnsiColor -> Bool

(>=) :: AnsiColor -> AnsiColor -> Bool

max :: AnsiColor -> AnsiColor -> AnsiColor

min :: AnsiColor -> AnsiColor -> AnsiColor

Read AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

readsPrec :: Int -> ReadS AnsiColor

readList :: ReadS [AnsiColor]

readPrec :: ReadPrec AnsiColor

readListPrec :: ReadPrec [AnsiColor]

Show AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

showsPrec :: Int -> AnsiColor -> ShowS

show :: AnsiColor -> String

showList :: [AnsiColor] -> ShowS

Generic AnsiColor

Defined in Z.IO.StdStream.Ansi

Associated Types

type Rep AnsiColor :: Type -> Type

Methods

from :: AnsiColor -> Rep AnsiColor x

to :: Rep AnsiColor x -> AnsiColor

Print AnsiColor

Defined in Z.IO.StdStream.Ansi

Methods

toUTF8BuilderP :: Int -> AnsiColor -> Builder ()

type Rep AnsiColor

Defined in Z.IO.StdStream.Ansi

type Rep AnsiColor = D1 ('MetaData "AnsiColor" "Z.IO.StdStream.Ansi" "Z-IO-0.5.0.0-KfhXy1PmMe0F8vl3nywnMz" 'False) (((C1 ('MetaCons "Black" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Red" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Green" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Yellow" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Blue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Magenta" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cyan" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "White" 'PrefixI 'False) (U1 :: Type -> Type))))

type PaletteColor = Word8

8-bit palette color, see https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit

type RGBColor = (Word8, Word8, Word8)

24-bit RGB color

Internal helper

csi

Arguments

:: [Int]

List of parameters for the control sequence

-> Builder ()

Character(s) that identify the control function

-> Builder ()

sgr

Arguments

:: [Word8]

List of sgr code for the control sequence

-> Builder ()

colorToCode :: AnsiColor -> Word8