Copyright	(c) Winterland 2017-2020
License	BSD
Maintainer	drkoster@qq.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Z.IO.StdStream.Ansi

Contents

Style modifier
Control codes
Style codes
Internal helper

Description

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

Synopsis

bold :: Builder () -> Builder ()
italicize :: Builder () -> Builder ()
underline :: Builder () -> Builder ()
color :: AnsiColor -> Builder () -> Builder ()
color' :: AnsiColor -> AnsiColor -> Builder () -> Builder ()
palette :: PaletteColor -> Builder () -> Builder ()
palette' :: PaletteColor -> PaletteColor -> Builder () -> Builder ()
rgb :: RGBColor -> Builder () -> Builder ()
rgb' :: RGBColor -> RGBColor -> Builder () -> Builder ()
cursorUp :: Int -> Builder ()
cursorDown :: Int -> Builder ()
cursorForward :: Int -> Builder ()
cursorBackward :: Int -> Builder ()
cursorDownLine :: Int -> Builder ()
cursorUpLine :: Int -> Builder ()
setCursorColumn :: Int -> Builder ()
setCursorPosition :: Int -> Int -> Builder ()
saveCursor :: Builder ()
restoreCursor :: Builder ()
clearFromCursorToScreenEnd :: Builder ()
clearFromCursorToScreenBeginning :: Builder ()
clearScreen :: Builder ()
clearFromCursorToLineEnd :: Builder ()
clearFromCursorToLineBeginning :: Builder ()
clearLine :: Builder ()
scrollPageUp :: Int -> Builder ()
scrollPageDown :: Int -> Builder ()
hideCursor :: Builder ()
showCursor :: Builder ()
setTitle :: Text -> Builder ()
reset :: Builder ()
boldIntensity :: Builder ()
faintIntensity :: Builder ()
resetIntensity :: Builder ()
italicized :: Builder ()
noItalicized :: Builder ()
singleUnderline :: Builder ()
doubleUnderline :: Builder ()
noUnderline :: Builder ()
slowBlink :: Builder ()
rapidBlink :: Builder ()
blinkOff :: Builder ()
conceal :: Builder ()
reveal :: Builder ()
invert :: Builder ()
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
- = Black
- | Red
- | Green
- | Yellow
- | Blue
- | Magenta
- | Cyan
- | White
type PaletteColor = Word8
type RGBColor = (Word8, Word8, Word8)
csi :: [Int] -> Builder () -> Builder ()
sgr :: [Word8] -> Builder ()
colorToCode :: AnsiColor -> Word8

Style modifier

bold :: Builder () -> Builder () Source #

italicize :: Builder () -> Builder () Source #

Italicize some text

underline :: Builder () -> Builder () Source #

Add single underline to some text

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

Colorized some text

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

Colorized some text with background color

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

Colorized some text

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

Colorized some text with background color

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

Colorized some text

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

Colorized some text with background color

Control codes

cursorUp Source #

Arguments

:: Int	Number of lines or characters to move
-> Builder ()

cursorDown Source #

Arguments

:: Int	Number of lines or characters to move
-> Builder ()

cursorForward Source #

Arguments

:: Int	Number of lines or characters to move
-> Builder ()

cursorBackward Source #

Arguments

:: Int	Number of lines or characters to move
-> Builder ()

cursorDownLine Source #

Arguments

:: Int	Number of lines to move
-> Builder ()

cursorUpLine Source #

Arguments

:: Int	Number of lines to move
-> Builder ()

setCursorColumn Source #

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 Source #

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 () Source #

restoreCursor :: Builder () Source #

clearFromCursorToScreenEnd :: Builder () Source #

clearFromCursorToScreenBeginning :: Builder () Source #

clearScreen :: Builder () Source #

clearFromCursorToLineEnd :: Builder () Source #

clearFromCursorToLineBeginning :: Builder () Source #

clearLine :: Builder () Source #

scrollPageUp Source #

Arguments

:: Int	Number of lines to scroll by
-> Builder ()

scrollPageDown Source #

Arguments

:: Int	Number of lines to scroll by
-> Builder ()

hideCursor :: Builder () Source #

showCursor :: Builder () Source #

setTitle Source #

Arguments

:: Text	New Icon Name and Window Title
-> Builder ()

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

Style codes

reset :: Builder () Source #

boldIntensity :: Builder () Source #

faintIntensity :: Builder () Source #

resetIntensity :: Builder () Source #

italicized :: Builder () Source #

noItalicized :: Builder () Source #

singleUnderline :: Builder () Source #

doubleUnderline :: Builder () Source #

noUnderline :: Builder () Source #

slowBlink :: Builder () Source #

less than 150 per minute

rapidBlink :: Builder () Source #

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

blinkOff :: Builder () Source #

conceal :: Builder () Source #

Aka Hide, not widely supported.

reveal :: Builder () Source #

invert :: Builder () Source #

Swap foreground and background colors, inconsistent emulation

invertOff :: Builder () Source #

setForeground :: AnsiColor -> Builder () Source #

setBrightForeground :: AnsiColor -> Builder () Source #

setBackground :: AnsiColor -> Builder () Source #

setBrightBackground :: AnsiColor -> Builder () Source #

setPaletteForeground :: PaletteColor -> Builder () Source #

setPaletteBackground :: PaletteColor -> Builder () Source #

setRGBForeground :: RGBColor -> Builder () Source #

setRGBBackground :: RGBColor -> Builder () Source #

setDefaultForeground :: Builder () Source #

setDefaultBackground :: Builder () Source #

data AnsiColor Source #

ANSI's eight standard colors

Constructors

Black
Red
Green
Yellow
Blue
Magenta
Cyan
White

Instances

Instances details

Bounded AnsiColor Source #
Instance details Defined in Z.IO.StdStream.Ansi Methods minBound :: AnsiColor # maxBound :: AnsiColor #
Enum AnsiColor Source #
Instance details 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 Source #
Instance details Defined in Z.IO.StdStream.Ansi Methods (==) :: AnsiColor -> AnsiColor -> Bool # (/=) :: AnsiColor -> AnsiColor -> Bool #
Ord AnsiColor Source #
Instance details 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 Source #
Instance details Defined in Z.IO.StdStream.Ansi Methods readsPrec :: Int -> ReadS AnsiColor # readList :: ReadS [AnsiColor] # readPrec :: ReadPrec AnsiColor # readListPrec :: ReadPrec [AnsiColor] #
Show AnsiColor Source #
Instance details Defined in Z.IO.StdStream.Ansi Methods showsPrec :: Int -> AnsiColor -> ShowS # show :: AnsiColor -> String # showList :: [AnsiColor] -> ShowS #
Generic AnsiColor Source #
Instance details 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 Source #
Instance details Defined in Z.IO.StdStream.Ansi Methods toUTF8BuilderP :: Int -> AnsiColor -> Builder () #
type Rep AnsiColor Source #
Instance details Defined in Z.IO.StdStream.Ansi type Rep AnsiColor = D1 ('MetaData "AnsiColor" "Z.IO.StdStream.Ansi" "Z-IO-0.4.0.0-yZ8PAxRS7u6ehgjyvfzwd" '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 Source #

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

type RGBColor = (Word8, Word8, Word8) Source #

24-bit RGB color

Internal helper

csi Source #

Arguments

:: [Int]	List of parameters for the control sequence
-> Builder ()	Character(s) that identify the control function
-> Builder ()

sgr Source #

Arguments

:: [Word8]	List of sgr code for the control sequence
-> Builder ()

colorToCode :: AnsiColor -> Word8 Source #