Text.Colour.Code

Documentation

asciiEscape :: Char

csiStart :: Char

csiDelimiter :: Char

newtype CSI

Constructors

SGR [SGR]

Instances

Generic CSI

Defined in Text.Colour.Code

Associated Types

type Rep CSI :: Type -> Type

Methods

from :: CSI -> Rep CSI x

to :: Rep CSI x -> CSI

Show CSI

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> CSI -> ShowS

show :: CSI -> String

showList :: [CSI] -> ShowS

Eq CSI

Defined in Text.Colour.Code

Methods

(==) :: CSI -> CSI -> Bool

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

Validity CSI

Defined in Text.Colour.Code

Methods

validate :: CSI -> Validation

type Rep CSI

Defined in Text.Colour.Code

type Rep CSI = D1 ('MetaData "CSI" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'True) (C1 ('MetaCons "SGR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SGR])))

renderCSIUtf8BS :: CSI -> ByteString

Render a CSI directly to ByteString using UTF8.

You probably want to use renderCSI instead. This is just for testing.

renderCSIText :: CSI -> Text

Render a CSI directly to strict Text.

You probably want to use renderCSI instead. This is just for testing.

renderCSILazyText :: CSI -> Text

Render a CSI directly to lazy Text.

You probably want to use renderCSI instead. This is just for testing.

renderCSI :: CSI -> Builder

data SGR

Constructors

Reset

SetItalic !Bool

SetUnderlining !Underlining

SetBlinking !Blinking

SetConsoleIntensity !ConsoleIntensity

SetColour !ColourIntensity !ConsoleLayer !TerminalColour

Set8BitColour !ConsoleLayer !Word8

Set24BitColour !ConsoleLayer !Word8 !Word8 !Word8

Instances

Generic SGR

Defined in Text.Colour.Code

Associated Types

type Rep SGR :: Type -> Type

Methods

from :: SGR -> Rep SGR x

to :: Rep SGR x -> SGR

Show SGR

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> SGR -> ShowS

show :: SGR -> String

showList :: [SGR] -> ShowS

Eq SGR

Defined in Text.Colour.Code

Methods

(==) :: SGR -> SGR -> Bool

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

Validity SGR

Defined in Text.Colour.Code

Methods

validate :: SGR -> Validation

type Rep SGR

Defined in Text.Colour.Code

type Rep SGR = D1 ('MetaData "SGR" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (((C1 ('MetaCons "Reset" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetItalic" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :+: (C1 ('MetaCons "SetUnderlining" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Underlining)) :+: C1 ('MetaCons "SetBlinking" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Blinking)))) :+: ((C1 ('MetaCons "SetConsoleIntensity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsoleIntensity)) :+: C1 ('MetaCons "SetColour" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColourIntensity) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsoleLayer) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TerminalColour)))) :+: (C1 ('MetaCons "Set8BitColour" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsoleLayer) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :+: C1 ('MetaCons "Set24BitColour" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ConsoleLayer) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8))))))

renderCSIParams :: [Word8] -> Builder

sgrToCSIParams :: SGR -> [Word8]

data Underlining

ANSI text underlining

Constructors

SingleUnderline

DoubleUnderline

NoUnderline

Instances

Bounded Underlining

Defined in Text.Colour.Code

Methods

minBound :: Underlining

maxBound :: Underlining

Enum Underlining

Defined in Text.Colour.Code

Methods

succ :: Underlining -> Underlining

pred :: Underlining -> Underlining

toEnum :: Int -> Underlining

fromEnum :: Underlining -> Int

enumFrom :: Underlining -> [Underlining]

enumFromThen :: Underlining -> Underlining -> [Underlining]

enumFromTo :: Underlining -> Underlining -> [Underlining]

enumFromThenTo :: Underlining -> Underlining -> Underlining -> [Underlining]

Generic Underlining

Defined in Text.Colour.Code

Associated Types

type Rep Underlining :: Type -> Type

Methods

from :: Underlining -> Rep Underlining x

to :: Rep Underlining x -> Underlining

Show Underlining

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> Underlining -> ShowS

show :: Underlining -> String

showList :: [Underlining] -> ShowS

Eq Underlining

Defined in Text.Colour.Code

Methods

(==) :: Underlining -> Underlining -> Bool

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

Validity Underlining

Defined in Text.Colour.Code

Methods

validate :: Underlining -> Validation

type Rep Underlining

Defined in Text.Colour.Code

type Rep Underlining = D1 ('MetaData "Underlining" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (C1 ('MetaCons "SingleUnderline" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DoubleUnderline" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoUnderline" 'PrefixI 'False) (U1 :: Type -> Type)))

data Blinking

ANSI text blinking

Constructors

SlowBlinking

RapidBlinking

NoBlinking

Instances

Bounded Blinking

Defined in Text.Colour.Code

Methods

minBound :: Blinking

maxBound :: Blinking

Enum Blinking

Defined in Text.Colour.Code

Methods

succ :: Blinking -> Blinking

pred :: Blinking -> Blinking

toEnum :: Int -> Blinking

fromEnum :: Blinking -> Int

enumFrom :: Blinking -> [Blinking]

enumFromThen :: Blinking -> Blinking -> [Blinking]

enumFromTo :: Blinking -> Blinking -> [Blinking]

enumFromThenTo :: Blinking -> Blinking -> Blinking -> [Blinking]

Generic Blinking

Defined in Text.Colour.Code

Associated Types

type Rep Blinking :: Type -> Type

Methods

from :: Blinking -> Rep Blinking x

to :: Rep Blinking x -> Blinking

Show Blinking

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> Blinking -> ShowS

show :: Blinking -> String

showList :: [Blinking] -> ShowS

Eq Blinking

Defined in Text.Colour.Code

Methods

(==) :: Blinking -> Blinking -> Bool

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

Validity Blinking

Defined in Text.Colour.Code

Methods

validate :: Blinking -> Validation

type Rep Blinking

Defined in Text.Colour.Code

type Rep Blinking = D1 ('MetaData "Blinking" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (C1 ('MetaCons "SlowBlinking" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "RapidBlinking" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoBlinking" 'PrefixI 'False) (U1 :: Type -> Type)))

data ConsoleIntensity

ANSI general console intensity: usually treated as setting the font style (e.g. BoldIntensity causes text to be bold)

Constructors

BoldIntensity

FaintIntensity

NormalIntensity

Instances

Bounded ConsoleIntensity

Defined in Text.Colour.Code

Methods

minBound :: ConsoleIntensity

maxBound :: ConsoleIntensity

Enum ConsoleIntensity

Defined in Text.Colour.Code

Methods

succ :: ConsoleIntensity -> ConsoleIntensity

pred :: ConsoleIntensity -> ConsoleIntensity

toEnum :: Int -> ConsoleIntensity

fromEnum :: ConsoleIntensity -> Int

enumFrom :: ConsoleIntensity -> [ConsoleIntensity]

enumFromThen :: ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity]

enumFromTo :: ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity]

enumFromThenTo :: ConsoleIntensity -> ConsoleIntensity -> ConsoleIntensity -> [ConsoleIntensity]

Generic ConsoleIntensity

Defined in Text.Colour.Code

Associated Types

type Rep ConsoleIntensity :: Type -> Type

Methods

from :: ConsoleIntensity -> Rep ConsoleIntensity x

to :: Rep ConsoleIntensity x -> ConsoleIntensity

Show ConsoleIntensity

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> ConsoleIntensity -> ShowS

show :: ConsoleIntensity -> String

showList :: [ConsoleIntensity] -> ShowS

Eq ConsoleIntensity

Defined in Text.Colour.Code

Methods

(==) :: ConsoleIntensity -> ConsoleIntensity -> Bool

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

Validity ConsoleIntensity

Defined in Text.Colour.Code

Methods

validate :: ConsoleIntensity -> Validation

type Rep ConsoleIntensity

Defined in Text.Colour.Code

type Rep ConsoleIntensity = D1 ('MetaData "ConsoleIntensity" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (C1 ('MetaCons "BoldIntensity" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FaintIntensity" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NormalIntensity" 'PrefixI 'False) (U1 :: Type -> Type)))

data ColourIntensity

ANSI's standard colours come in two intensities

Constructors

Dull

Bright

Instances

Bounded ColourIntensity

Defined in Text.Colour.Code

Methods

minBound :: ColourIntensity

maxBound :: ColourIntensity

Enum ColourIntensity

Defined in Text.Colour.Code

Methods

succ :: ColourIntensity -> ColourIntensity

pred :: ColourIntensity -> ColourIntensity

toEnum :: Int -> ColourIntensity

fromEnum :: ColourIntensity -> Int

enumFrom :: ColourIntensity -> [ColourIntensity]

enumFromThen :: ColourIntensity -> ColourIntensity -> [ColourIntensity]

enumFromTo :: ColourIntensity -> ColourIntensity -> [ColourIntensity]

enumFromThenTo :: ColourIntensity -> ColourIntensity -> ColourIntensity -> [ColourIntensity]

Generic ColourIntensity

Defined in Text.Colour.Code

Associated Types

type Rep ColourIntensity :: Type -> Type

Methods

from :: ColourIntensity -> Rep ColourIntensity x

to :: Rep ColourIntensity x -> ColourIntensity

Show ColourIntensity

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> ColourIntensity -> ShowS

show :: ColourIntensity -> String

showList :: [ColourIntensity] -> ShowS

Eq ColourIntensity

Defined in Text.Colour.Code

Methods

(==) :: ColourIntensity -> ColourIntensity -> Bool

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

Validity ColourIntensity

Defined in Text.Colour.Code

Methods

validate :: ColourIntensity -> Validation

type Rep ColourIntensity

Defined in Text.Colour.Code

type Rep ColourIntensity = D1 ('MetaData "ColourIntensity" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (C1 ('MetaCons "Dull" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bright" 'PrefixI 'False) (U1 :: Type -> Type))

data ConsoleLayer

ANSI colours can be set on two different layers

Constructors

Foreground

Background

Instances

Bounded ConsoleLayer

Defined in Text.Colour.Code

Methods

minBound :: ConsoleLayer

maxBound :: ConsoleLayer

Enum ConsoleLayer

Defined in Text.Colour.Code

Methods

succ :: ConsoleLayer -> ConsoleLayer

pred :: ConsoleLayer -> ConsoleLayer

toEnum :: Int -> ConsoleLayer

fromEnum :: ConsoleLayer -> Int

enumFrom :: ConsoleLayer -> [ConsoleLayer]

enumFromThen :: ConsoleLayer -> ConsoleLayer -> [ConsoleLayer]

enumFromTo :: ConsoleLayer -> ConsoleLayer -> [ConsoleLayer]

enumFromThenTo :: ConsoleLayer -> ConsoleLayer -> ConsoleLayer -> [ConsoleLayer]

Generic ConsoleLayer

Defined in Text.Colour.Code

Associated Types

type Rep ConsoleLayer :: Type -> Type

Methods

from :: ConsoleLayer -> Rep ConsoleLayer x

to :: Rep ConsoleLayer x -> ConsoleLayer

Show ConsoleLayer

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> ConsoleLayer -> ShowS

show :: ConsoleLayer -> String

showList :: [ConsoleLayer] -> ShowS

Eq ConsoleLayer

Defined in Text.Colour.Code

Methods

(==) :: ConsoleLayer -> ConsoleLayer -> Bool

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

Validity ConsoleLayer

Defined in Text.Colour.Code

Methods

validate :: ConsoleLayer -> Validation

type Rep ConsoleLayer

Defined in Text.Colour.Code

type Rep ConsoleLayer = D1 ('MetaData "ConsoleLayer" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" 'False) (C1 ('MetaCons "Foreground" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Background" 'PrefixI 'False) (U1 :: Type -> Type))

data TerminalColour

Constructors

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

Instances

Bounded TerminalColour

Defined in Text.Colour.Code

Methods

minBound :: TerminalColour

maxBound :: TerminalColour

Enum TerminalColour

Defined in Text.Colour.Code

Methods

succ :: TerminalColour -> TerminalColour

pred :: TerminalColour -> TerminalColour

toEnum :: Int -> TerminalColour

fromEnum :: TerminalColour -> Int

enumFrom :: TerminalColour -> [TerminalColour]

enumFromThen :: TerminalColour -> TerminalColour -> [TerminalColour]

enumFromTo :: TerminalColour -> TerminalColour -> [TerminalColour]

enumFromThenTo :: TerminalColour -> TerminalColour -> TerminalColour -> [TerminalColour]

Generic TerminalColour

Defined in Text.Colour.Code

Associated Types

type Rep TerminalColour :: Type -> Type

Methods

from :: TerminalColour -> Rep TerminalColour x

to :: Rep TerminalColour x -> TerminalColour

Show TerminalColour

Defined in Text.Colour.Code

Methods

showsPrec :: Int -> TerminalColour -> ShowS

show :: TerminalColour -> String

showList :: [TerminalColour] -> ShowS

Eq TerminalColour

Defined in Text.Colour.Code

Methods

(==) :: TerminalColour -> TerminalColour -> Bool

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

Validity TerminalColour

Defined in Text.Colour.Code

Methods

validate :: TerminalColour -> Validation

type Rep TerminalColour

Defined in Text.Colour.Code

type Rep TerminalColour = D1 ('MetaData "TerminalColour" "Text.Colour.Code" "safe-coloured-text-0.3.0.2-JbAbEzIRe1QBZQlP6o3TOK" '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))))

terminalColourSGRParameter :: TerminalColour -> Word8

terminalColourFromIndex :: Word8 -> Maybe TerminalColour