Text.Colour

Safe Coloured Text

This module is responsible for defining, building, and rendering coloured text.

The text to be coloured is Text, but the rendered text, while technically still (probably) valid Utf8, will be a ByteString builder.

Building chunks

chunk :: Text -> Chunk

Turn a text into a plain chunk, without any styling

data Chunk

Constructors

Chunk

Fields

• chunkText :: !Text
• chunkItalic :: !(Maybe Bool)
• chunkConsoleIntensity :: !(Maybe ConsoleIntensity)
• chunkUnderlining :: !(Maybe Underlining)
• chunkForeground :: !(Maybe Colour)
• chunkBackground :: !(Maybe Colour)

Instances

Eq Chunk

Defined in Text.Colour.Chunk

Methods

(==) :: Chunk -> Chunk -> Bool

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

Show Chunk

Defined in Text.Colour.Chunk

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

IsString Chunk

Defined in Text.Colour.Chunk

Methods

fromString :: String -> Chunk

Generic Chunk

Defined in Text.Colour.Chunk

Associated Types

type Rep Chunk :: Type -> Type

Methods

from :: Chunk -> Rep Chunk x

to :: Rep Chunk x -> Chunk

Validity Chunk

Defined in Text.Colour.Chunk

Methods

validate :: Chunk -> Validation

type Rep Chunk

Defined in Text.Colour.Chunk

type Rep Chunk = D1 ('MetaData "Chunk" "Text.Colour.Chunk" "safe-coloured-text-0.2.0.0-CYny960IEWDA7ODh5aXbAt" 'False) (C1 ('MetaCons "Chunk" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chunkText") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "chunkItalic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "chunkConsoleIntensity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ConsoleIntensity)))) :*: (S1 ('MetaSel ('Just "chunkUnderlining") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Underlining)) :*: (S1 ('MetaSel ('Just "chunkForeground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour)) :*: S1 ('MetaSel ('Just "chunkBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour))))))

Styling

Setting colour

fore :: Colour -> Chunk -> Chunk

back :: Colour -> Chunk -> Chunk

Setting non-colour attributes

bold :: Chunk -> Chunk

faint :: Chunk -> Chunk

italic :: Chunk -> Chunk

underline :: Chunk -> Chunk

doubleUnderline :: Chunk -> Chunk

Colours

data Colour

Constructors

Colour8 !ColourIntensity !TerminalColour

Colour8Bit !Word8

Colour24Bit !Word8 !Word8 !Word8

Instances

Eq Colour

Defined in Text.Colour.Chunk

Methods

(==) :: Colour -> Colour -> Bool

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

Show Colour

Defined in Text.Colour.Chunk

Methods

showsPrec :: Int -> Colour -> ShowS

show :: Colour -> String

showList :: [Colour] -> ShowS

Generic Colour

Defined in Text.Colour.Chunk

Associated Types

type Rep Colour :: Type -> Type

Methods

from :: Colour -> Rep Colour x

to :: Rep Colour x -> Colour

Validity Colour

Defined in Text.Colour.Chunk

Methods

validate :: Colour -> Validation

type Rep Colour

Defined in Text.Colour.Chunk

type Rep Colour = D1 ('MetaData "Colour" "Text.Colour.Chunk" "safe-coloured-text-0.2.0.0-CYny960IEWDA7ODh5aXbAt" 'False) (C1 ('MetaCons "Colour8" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColourIntensity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TerminalColour)) :+: (C1 ('MetaCons "Colour8Bit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :+: C1 ('MetaCons "Colour24Bit" 'PrefixI 'False) (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)))))

8-colour

Dull

black :: Colour

red :: Colour

green :: Colour

yellow :: Colour

blue :: Colour

magenta :: Colour

cyan :: Colour

white :: Colour

Bright

brightBlack :: Colour

brightRed :: Colour

brightGreen :: Colour

brightYellow :: Colour

brightBlue :: Colour

brightMagenta :: Colour

brightCyan :: Colour

brightWhite :: Colour

8-bit

color256 :: Word8 -> Colour

Alias for colour256, bloody americans...

colour256 :: Word8 -> Colour

Bulid an 8-bit RGB Colour

This will not be rendered unless With8BitColours is used.

24-bit

colorRGB :: Word8 -> Word8 -> Word8 -> Colour

Alias for colourRGB, bloody americans...

colourRGB :: Word8 -> Word8 -> Word8 -> Colour

Bulid a 24-bit RGB Colour

This will not be rendered unless With24BitColours is used.

Rendering

Rendering chunks to strict bytestring in UTF8

renderChunksUtf8BS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString

Render chunks directly to a UTF8-encoded Bytestring.

renderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString

Render a chunk directly to a UTF8-encoded Bytestring.

Rendering chunks to lazy bytestring builders in UTF8

renderChunksUtf8BSBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder

Render chunks to a UTF8-encoded ByteString Builder.

renderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder

Render a chunk directly to a UTF8-encoded Bytestring Builder.

Rendering chunks to strict Text

renderChunksText :: Foldable f => TerminalCapabilities -> f Chunk -> Text

Render chunks directly to strict Text.

renderChunkText :: TerminalCapabilities -> Chunk -> Text

Render a chunk directly to strict Text.

Rendering chunks to lazy text

renderChunksLazyText :: Foldable f => TerminalCapabilities -> f Chunk -> Text

Render chunks directly to lazy Text.

renderChunkLazyText :: TerminalCapabilities -> Chunk -> Text

Render a chunk directly to strict Text.

Rendering chunks to lazy text builder

renderChunksBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder

Render chunks to a lazy Text Builder

renderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder

Render a chunk to a lazy Text Builder

Decrecated rendering chunks to strict bytestring in UTF8

renderChunksBS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString

Deprecated: Use renderChunksText, or renderChunksUtf8BS if you must.

Deprecated synonym for renderChunksUtf8BS

renderChunkBS :: TerminalCapabilities -> Chunk -> ByteString

Deprecated: Use renderChunkText, or renderChunkUtf8BS if you must.

Deprecated synonym for renderChunkUtf8BS

Deprecated rendering chunks to lazy bytestring builders in UTF8

renderChunks :: Foldable f => TerminalCapabilities -> f Chunk -> Builder

Deprecated: Use renderChunksBuilder, or renderChunksUtf8BSBuilder if you must.

Deprecated synonym for renderChunksUtf8BSBuilder

renderChunk :: TerminalCapabilities -> Chunk -> Builder

Deprecated: Use renderChunkBuilder, or renderChunkUtf8BSBuilder if you must.

Deprecated synonym for renderChunkUtf8BSBuilder

IO

data TerminalCapabilities

Constructors

WithoutColours

No colours

With8Colours

Only 8 colours

With8BitColours

Only 8-bit colours

With24BitColours

All 24-bit colours

Instances

Eq TerminalCapabilities

Defined in Text.Colour.Capabilities

Methods

(==) :: TerminalCapabilities -> TerminalCapabilities -> Bool

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

Ord TerminalCapabilities

Defined in Text.Colour.Capabilities

Methods

compare :: TerminalCapabilities -> TerminalCapabilities -> Ordering

(<) :: TerminalCapabilities -> TerminalCapabilities -> Bool

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

(>) :: TerminalCapabilities -> TerminalCapabilities -> Bool

(>=) :: TerminalCapabilities -> TerminalCapabilities -> Bool

max :: TerminalCapabilities -> TerminalCapabilities -> TerminalCapabilities

min :: TerminalCapabilities -> TerminalCapabilities -> TerminalCapabilities

Show TerminalCapabilities

Defined in Text.Colour.Capabilities

Methods

showsPrec :: Int -> TerminalCapabilities -> ShowS

show :: TerminalCapabilities -> String

showList :: [TerminalCapabilities] -> ShowS

Generic TerminalCapabilities

Defined in Text.Colour.Capabilities

Associated Types

type Rep TerminalCapabilities :: Type -> Type

Methods

from :: TerminalCapabilities -> Rep TerminalCapabilities x

to :: Rep TerminalCapabilities x -> TerminalCapabilities

type Rep TerminalCapabilities

Defined in Text.Colour.Capabilities

type Rep TerminalCapabilities = D1 ('MetaData "TerminalCapabilities" "Text.Colour.Capabilities" "safe-coloured-text-0.2.0.0-CYny960IEWDA7ODh5aXbAt" 'False) ((C1 ('MetaCons "WithoutColours" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "With8Colours" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "With8BitColours" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "With24BitColours" 'PrefixI 'False) (U1 :: Type -> Type)))

Outputting chunks directly

putChunksUtf8With :: TerminalCapabilities -> [Chunk] -> IO ()

Print a list of chunks to stdout with given TerminalCapabilities.

putChunksLocaleWith :: TerminalCapabilities -> [Chunk] -> IO ()

Print a list of chunks to stdout with given TerminalCapabilities in an encoding according to the system's locale.

hPutChunksUtf8With :: TerminalCapabilities -> Handle -> [Chunk] -> IO ()

Print a list of chunks to the given Handle with given TerminalCapabilities.

hPutChunksLocaleWith :: TerminalCapabilities -> Handle -> [Chunk] -> IO ()

Print a list of chunks to the given Handle with given TerminalCapabilities in an encoding according to the system's locale.

putChunksWith :: TerminalCapabilities -> [Chunk] -> IO ()

Deprecated: Use putChunksLocaleWith, or putChunksUtf8With if you must.

Deprecated synonym of putChunksUtf8With

hPutChunksWith :: TerminalCapabilities -> Handle -> [Chunk] -> IO ()

Deprecated: Use hPutChunksLocaleWith, or hPutChunksUtf8With if you must.

Deprecated synonym of hPutChunksUtf8With