Safe Haskell	None
Language	Haskell2010

Text.Colour.Code

Synopsis

asciiEscape :: Word8
csiStart :: Word8
csiDelimiter :: Word8
newtype CSI = SGR [SGR]
renderCSIBS :: CSI -> ByteString
renderCSI :: CSI -> Builder
data SGR
- = Reset
- | SetItalic !Bool
- | SetUnderlining !Underlining
- | SetConsoleIntensity !ConsoleIntensity
- | SetColour !ColourIntensity !ConsoleLayer !TerminalColour
- | Set8BitColour !ConsoleLayer !Word8
- | Set24BitColour !ConsoleLayer !Word8 !Word8 !Word8
csiParamsToWords :: [Word8] -> Builder
csiParamToWord :: Word8 -> Builder
sgrToCSIParams :: SGR -> [Word8]
data Underlining
- = SingleUnderline
- | DoubleUnderline
- | NoUnderline
data ConsoleIntensity
- = BoldIntensity
- | FaintIntensity
- | NormalIntensity
data ColourIntensity
- = Dull
- | Bright
data ConsoleLayer
- = Foreground
- | Background
data TerminalColour
- = Black
- | Red
- | Green
- | Yellow
- | Blue
- | Magenta
- | Cyan
- | White
terminalColourSGRParameter :: TerminalColour -> Word8
terminalColourFromIndex :: Word8 -> Maybe TerminalColour

Documentation

asciiEscape :: Word8 Source #

csiStart :: Word8 Source #

csiDelimiter :: Word8 Source #

newtype CSI Source #

Constructors

SGR [SGR]

Instances

Instances details

Eq CSI Source #
Instance details Defined in Text.Colour.Code Methods (==) :: CSI -> CSI -> Bool # (/=) :: CSI -> CSI -> Bool #
Show CSI Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> CSI -> ShowS # show :: CSI -> String # showList :: [CSI] -> ShowS #
Generic CSI Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep CSI :: Type -> Type # Methods from :: CSI -> Rep CSI x # to :: Rep CSI x -> CSI #
type Rep CSI Source #
Instance details Defined in Text.Colour.Code type Rep CSI = D1 ('MetaData "CSI" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" 'True) (C1 ('MetaCons "SGR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SGR])))

renderCSIBS :: CSI -> ByteString Source #

Render a CSI directly to bytestring. You probably want to use renderCSI instead. This is just for testing.

renderCSI :: CSI -> Builder Source #

data SGR Source #

Constructors

Reset
SetItalic !Bool
SetUnderlining !Underlining
SetConsoleIntensity !ConsoleIntensity
SetColour !ColourIntensity !ConsoleLayer !TerminalColour
Set8BitColour !ConsoleLayer !Word8
Set24BitColour !ConsoleLayer !Word8 !Word8 !Word8

Instances

Instances details

Eq SGR Source #
Instance details Defined in Text.Colour.Code Methods (==) :: SGR -> SGR -> Bool # (/=) :: SGR -> SGR -> Bool #
Show SGR Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> SGR -> ShowS # show :: SGR -> String # showList :: [SGR] -> ShowS #
Generic SGR Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep SGR :: Type -> Type # Methods from :: SGR -> Rep SGR x # to :: Rep SGR x -> SGR #
type Rep SGR Source #
Instance details Defined in Text.Colour.Code type Rep SGR = D1 ('MetaData "SGR" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" '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 "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))))))

csiParamsToWords :: [Word8] -> Builder Source #

csiParamToWord :: Word8 -> Builder Source #

sgrToCSIParams :: SGR -> [Word8] Source #

data Underlining Source #

ANSI text underlining

Constructors

SingleUnderline
DoubleUnderline
NoUnderline

Instances

Instances details

Bounded Underlining Source #
Instance details Defined in Text.Colour.Code Methods minBound :: Underlining # maxBound :: Underlining #
Enum Underlining Source #
Instance details 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] #
Eq Underlining Source #
Instance details Defined in Text.Colour.Code Methods (==) :: Underlining -> Underlining -> Bool # (/=) :: Underlining -> Underlining -> Bool #
Show Underlining Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> Underlining -> ShowS # show :: Underlining -> String # showList :: [Underlining] -> ShowS #
Generic Underlining Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep Underlining :: Type -> Type # Methods from :: Underlining -> Rep Underlining x # to :: Rep Underlining x -> Underlining #
type Rep Underlining Source #
Instance details Defined in Text.Colour.Code type Rep Underlining = D1 ('MetaData "Underlining" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" '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 ConsoleIntensity Source #

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

Constructors

BoldIntensity
FaintIntensity
NormalIntensity

Instances

Instances details

Bounded ConsoleIntensity Source #
Instance details Defined in Text.Colour.Code Methods minBound :: ConsoleIntensity # maxBound :: ConsoleIntensity #
Enum ConsoleIntensity Source #
Instance details 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] #
Eq ConsoleIntensity Source #
Instance details Defined in Text.Colour.Code Methods (==) :: ConsoleIntensity -> ConsoleIntensity -> Bool # (/=) :: ConsoleIntensity -> ConsoleIntensity -> Bool #
Show ConsoleIntensity Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> ConsoleIntensity -> ShowS # show :: ConsoleIntensity -> String # showList :: [ConsoleIntensity] -> ShowS #
Generic ConsoleIntensity Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep ConsoleIntensity :: Type -> Type # Methods from :: ConsoleIntensity -> Rep ConsoleIntensity x # to :: Rep ConsoleIntensity x -> ConsoleIntensity #
type Rep ConsoleIntensity Source #
Instance details Defined in Text.Colour.Code type Rep ConsoleIntensity = D1 ('MetaData "ConsoleIntensity" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" '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 Source #

ANSI's standard colours come in two intensities

Constructors

Dull
Bright

Instances

Instances details

Bounded ColourIntensity Source #
Instance details Defined in Text.Colour.Code Methods minBound :: ColourIntensity # maxBound :: ColourIntensity #
Enum ColourIntensity Source #
Instance details 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] #
Eq ColourIntensity Source #
Instance details Defined in Text.Colour.Code Methods (==) :: ColourIntensity -> ColourIntensity -> Bool # (/=) :: ColourIntensity -> ColourIntensity -> Bool #
Show ColourIntensity Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> ColourIntensity -> ShowS # show :: ColourIntensity -> String # showList :: [ColourIntensity] -> ShowS #
Generic ColourIntensity Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep ColourIntensity :: Type -> Type # Methods from :: ColourIntensity -> Rep ColourIntensity x # to :: Rep ColourIntensity x -> ColourIntensity #
type Rep ColourIntensity Source #
Instance details Defined in Text.Colour.Code type Rep ColourIntensity = D1 ('MetaData "ColourIntensity" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" 'False) (C1 ('MetaCons "Dull" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Bright" 'PrefixI 'False) (U1 :: Type -> Type))

data ConsoleLayer Source #

ANSI colours can be set on two different layers

Constructors

Foreground
Background

Instances

Instances details

Bounded ConsoleLayer Source #
Instance details Defined in Text.Colour.Code Methods minBound :: ConsoleLayer # maxBound :: ConsoleLayer #
Enum ConsoleLayer Source #
Instance details 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] #
Eq ConsoleLayer Source #
Instance details Defined in Text.Colour.Code Methods (==) :: ConsoleLayer -> ConsoleLayer -> Bool # (/=) :: ConsoleLayer -> ConsoleLayer -> Bool #
Show ConsoleLayer Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> ConsoleLayer -> ShowS # show :: ConsoleLayer -> String # showList :: [ConsoleLayer] -> ShowS #
Generic ConsoleLayer Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep ConsoleLayer :: Type -> Type # Methods from :: ConsoleLayer -> Rep ConsoleLayer x # to :: Rep ConsoleLayer x -> ConsoleLayer #
type Rep ConsoleLayer Source #
Instance details Defined in Text.Colour.Code type Rep ConsoleLayer = D1 ('MetaData "ConsoleLayer" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" 'False) (C1 ('MetaCons "Foreground" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Background" 'PrefixI 'False) (U1 :: Type -> Type))

data TerminalColour Source #

Constructors

Black
Red
Green
Yellow
Blue
Magenta
Cyan
White

Instances

Instances details

Bounded TerminalColour Source #
Instance details Defined in Text.Colour.Code Methods minBound :: TerminalColour # maxBound :: TerminalColour #
Enum TerminalColour Source #
Instance details 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] #
Eq TerminalColour Source #
Instance details Defined in Text.Colour.Code Methods (==) :: TerminalColour -> TerminalColour -> Bool # (/=) :: TerminalColour -> TerminalColour -> Bool #
Show TerminalColour Source #
Instance details Defined in Text.Colour.Code Methods showsPrec :: Int -> TerminalColour -> ShowS # show :: TerminalColour -> String # showList :: [TerminalColour] -> ShowS #
Generic TerminalColour Source #
Instance details Defined in Text.Colour.Code Associated Types type Rep TerminalColour :: Type -> Type # Methods from :: TerminalColour -> Rep TerminalColour x # to :: Rep TerminalColour x -> TerminalColour #
type Rep TerminalColour Source #
Instance details Defined in Text.Colour.Code type Rep TerminalColour = D1 ('MetaData "TerminalColour" "Text.Colour.Code" "safe-coloured-text-0.0.0.0-FRMsFtVgSffG4cdOonTFMy" '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 Source #

terminalColourFromIndex :: Word8 -> Maybe TerminalColour Source #