Ansi.Codes

prefix :: String

The prefix for all escape codes.

colorSuffix :: String

The suffix for escape codes; note that this is only required for colors.

data EscapeCode

An ANSI escape code. Not all sequences are implemented. See: https://en.wikipedia.org/wiki/ANSI_escape_code.

Constructors

• Up Int
• Down Int
• Forward Int
• Back Int
• NextLine Int
• PreviousLine Int
• HorizontalAbsolute Int
• Position Int Int
• EraseData EraseParam
• EraseLine EraseParam
• ScrollUp Int
• ScrollDown Int
• Graphics (NonEmptyList GraphicsParam)
• SavePosition
• RestorePosition
• QueryPosition
• HideCursor
• ShowCursor

Instances

• Generic EscapeCode _
• Eq EscapeCode
• Ord EscapeCode
• Show EscapeCode

escapeCodeToString :: EscapeCode -> String

Convert an escape code to the form recognised by terminals.

data EraseParam

Specifies how much text to erase.

• ToEnd: erase from the cursor to the end of the line or screen.
• FromBeginning: erase to the cursor from the beginning of the line or screen.
• Entire: erase the entire line or screen.

Constructors

• ToEnd
• FromBeginning
• Entire

Instances

• Generic EraseParam _
• Eq EraseParam
• Ord EraseParam
• Show EraseParam

eraseParamToString :: EraseParam -> String

data GraphicsParam

A graphics parameter, controls how text appears; for example, bold, underlined, foreground color, background color.

Constructors

• Reset
• PMode RenderingMode
• PForeground Color
• PBackground Color

Instances

• Generic GraphicsParam _
• Eq GraphicsParam
• Ord GraphicsParam
• Show GraphicsParam

graphicsParamToString :: GraphicsParam -> String

data RenderingMode

Constructors

• Bold
• Dim
• Italic
• Underline
• Inverse
• Strikethrough

Instances

• Generic RenderingMode _
• Eq RenderingMode
• Ord RenderingMode
• Show RenderingMode

codeForRenderingMode :: RenderingMode -> Int

data Color

The standard set of 16 ANSI colors.

Constructors

• Black
• Red
• Green
• Yellow
• Blue
• Magenta
• Cyan
• White
• BrightBlack
• BrightRed
• BrightGreen
• BrightYellow
• BrightBlue
• BrightMagenta
• BrightCyan
• BrightWhite

Instances

• Generic Color _
• Eq Color
• Ord Color
• Show Color

colorCode :: Color -> Int