Modulesafe-coloured-text-0.6.0.0Haskell2010

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.

Contents

Building chunks
Styling
Setting colour
Setting non-colour attributes
Colours
8-colour
Dull
Bright
8-bit
24-bit
Rendering
Composing chunks
Rendering chunks to strict bytestring in UTF8
Rendering chunks to lazy bytestring builders in UTF8
Rendering chunks to strict Text
Rendering chunks to lazy text
Rendering chunks to lazy text builder
IO
Outputting chunks directly

Synopsis

value chunk
data Chunk
data ChunkStyle
value noStyle
value fore
value back
value bold
value faint
value italic
value strikethrough
value swapForegroundBackground
value concealed
value overlined
value underline
value doubleUnderline
value noUnderline
value slowBlinking
value rapidBlinking
value noBlinking
data Colour
value black
value red
value green
value yellow
value blue
value magenta
value cyan
value white
value brightBlack
value brightRed
value brightGreen
value brightYellow
value brightBlue
value brightMagenta
value brightCyan
value brightWhite
value color256
value colour256
value colorRGB
value colourRGB
value unlinesChunks
value unwordsChunks
value renderChunksUtf8BS
value renderChunkUtf8BS
value renderChunksUtf8BSBuilder
value renderChunkUtf8BSBuilder
value renderChunksText
value renderChunkText
value renderChunksLazyText
value renderChunkLazyText
value renderChunksBuilder
value renderChunkBuilder
data TerminalCapabilities
value putChunksUtf8With
value putChunksLocaleWith
value hPutChunksUtf8With
value hPutChunksLocaleWith

Packagesafe-coloured-text-0.6.0.0
Exports57
LanguageHaskell2010
LicenceMIT
SourceColour.hs

Building chunks

valuechunk :: Text -> Chunk

Source#

Turn a text into a plain chunk, without any styling

datadata Chunk

Constructors

Chunk
- chunkText :: !Text
- chunkStyle :: !ChunkStyle

Instances6Eq, Show, IsString, Generic, Validity, Rep

Eq ChunkDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Show ChunkDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
IsString ChunkDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Generic ChunkDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Validity ChunkDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
type Rep Chunk = D1 ('MetaData "Chunk" "Text.Colour.Chunk" "safe-coloured-text-0.6.0.0-KZ8N9726PbF9wBfBB38nBI" 'False) (C1 ('MetaCons "Chunk" 'PrefixI 'True) (S1 ('MetaSel ('Just "chunkText") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "chunkStyle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkStyle)))Defined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk

datadata ChunkStyle

Constructors

ChunkStyle
- chunkStyleItalic :: !Maybe Bool
- chunkStyleStrikethrough :: !Maybe Bool
- chunkStyleSwapForegroundBackground :: !Maybe Bool
- chunkStyleConcealed :: !Maybe Bool
- chunkStyleOverlined :: !Maybe Bool
- chunkStyleConsoleIntensity :: !Maybe ConsoleIntensity
- chunkStyleUnderlining :: !Maybe Underlining
- chunkStyleBlinking :: !Maybe Blinking
- chunkStyleForeground :: !Maybe Colour
- chunkStyleBackground :: !Maybe Colour
- chunkStyleHyperlink :: !Maybe Text
  OSC 8 hyperlink URL, if any. Rendered as ESC]8;;<url>ESC\ before the text and ESC]8;;ESC\ after.

Instances5Eq, Show, Generic, Validity, Rep

Eq ChunkStyleDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Show ChunkStyleDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Generic ChunkStyleDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Validity ChunkStyleDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
type Rep ChunkStyle = D1 ('MetaData "ChunkStyle" "Text.Colour.Chunk" "safe-coloured-text-0.6.0.0-KZ8N9726PbF9wBfBB38nBI" 'False) (C1 ('MetaCons "ChunkStyle" 'PrefixI 'True) (((S1 ('MetaSel ('Just "chunkStyleItalic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "chunkStyleStrikethrough") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "chunkStyleSwapForegroundBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "chunkStyleConcealed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "chunkStyleOverlined") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "chunkStyleConsoleIntensity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ConsoleIntensity)) :*: (S1 ('MetaSel ('Just "chunkStyleUnderlining") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Underlining)) :*: S1 ('MetaSel ('Just "chunkStyleBlinking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Blinking)))) :*: (S1 ('MetaSel ('Just "chunkStyleForeground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour)) :*: (S1 ('MetaSel ('Just "chunkStyleBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour)) :*: S1 ('MetaSel ('Just "chunkStyleHyperlink") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)))))))Defined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk

valuenoStyle :: ChunkStyle

Source#

The empty style, without any styling

Styling

Setting colour

valuefore :: Colour -> Chunk -> Chunk

valueback :: Colour -> Chunk -> Chunk

Setting non-colour attributes

valuebold :: Chunk -> Chunk

valuefaint :: Chunk -> Chunk

valueitalic :: Chunk -> Chunk

valuestrikethrough :: Chunk -> Chunk

valueswapForegroundBackground :: Chunk -> Chunk

valueconcealed :: Chunk -> Chunk

valueoverlined :: Chunk -> Chunk

valueunderline :: Chunk -> Chunk

valuedoubleUnderline :: Chunk -> Chunk

valuenoUnderline :: Chunk -> Chunk

valueslowBlinking :: Chunk -> Chunk

valuerapidBlinking :: Chunk -> Chunk

valuenoBlinking :: Chunk -> Chunk

Colours

datadata Colour

Constructors

Colour8 !ColourIntensity !TerminalColour
Colour8Bit !Word8
Colour24Bit !Word8 !Word8 !Word8

Instances5Eq, Show, Generic, Validity, Rep

Eq ColourDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Show ColourDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Generic ColourDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
Validity ColourDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk
type Rep Colour = D1 ('MetaData "Colour" "Text.Colour.Chunk" "safe-coloured-text-0.6.0.0-KZ8N9726PbF9wBfBB38nBI" 'False) (C1 ('MetaCons "Colour8" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColourIntensity) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TerminalColour)) :+: (C1 ('MetaCons "Colour8Bit" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word8)) :+: C1 ('MetaCons "Colour24Bit" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word8) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word8) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word8)))))Defined in safe-coloured-text-0.6.0.0 · Text.Colour.Chunk

8-colour

Dull

valueblack :: Colour

valuered :: Colour

valuegreen :: Colour

valueyellow :: Colour

valueblue :: Colour

valuemagenta :: Colour

valuecyan :: Colour

valuewhite :: Colour

Bright

valuebrightBlack :: Colour

valuebrightRed :: Colour

valuebrightGreen :: Colour

valuebrightYellow :: Colour

valuebrightBlue :: Colour

valuebrightMagenta :: Colour

valuebrightCyan :: Colour

valuebrightWhite :: Colour

8-bit

valuecolor256 :: Word8 -> Colour

Source#

Alias for colour256, bloody americans...

valuecolour256 :: Word8 -> Colour

Source#

Bulid an 8-bit RGB Colour

This will not be rendered unless With8BitColours is used.

24-bit

valuecolorRGB :: Word8 -> Word8 -> Word8 -> Colour

Source#

Alias for colourRGB, bloody americans...

valuecolourRGB :: Word8 -> Word8 -> Word8 -> Colour

Source#

Bulid a 24-bit RGB Colour

This will not be rendered unless With24BitColours is used.

Rendering

Composing chunks

valueunlinesChunks :: [[Chunk]] -> [Chunk]

Source#

Render lines of chunks.

This puts newlines ("n") at the end of every list of chunks.

valueunwordsChunks :: [[Chunk]] -> [Chunk]

Source#

Render lines of chunks.

This puts newlines (" ") inbetween the list of chunks.

Rendering chunks to strict bytestring in UTF8

valuerenderChunksUtf8BS

Source#

Render chunks directly to a UTF8-encoded Bytestring.

valuerenderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString

Source#

Render a chunk directly to a UTF8-encoded Bytestring.

Rendering chunks to lazy bytestring builders in UTF8

valuerenderChunksUtf8BSBuilder

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

Source#

Render chunks to a UTF8-encoded ByteString Bytestring.Builder.

valuerenderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder

Source#

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

Rendering chunks to strict Text

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

Source#

Render chunks directly to strict Text.

valuerenderChunkText :: TerminalCapabilities -> Chunk -> Text

Source#

Render a chunk directly to strict Text.

Rendering chunks to lazy text

valuerenderChunksLazyText

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

Source#

Render chunks directly to lazy Text.

valuerenderChunkLazyText :: TerminalCapabilities -> Chunk -> Text

Source#

Render a chunk directly to strict Text.

Rendering chunks to lazy text builder

valuerenderChunksBuilder

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

Source#

Render chunks to a lazy Text Builder

valuerenderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder

Source#

Render a chunk to a lazy Text Builder

IO

datadata TerminalCapabilities

Constructors

WithoutColours
No colours
With8Colours
Only 8 colours
With8BitColours
Only 8-bit colours
With24BitColours
All 24-bit colours

Instances5Eq, Ord, Show, Generic, Rep

Eq TerminalCapabilitiesDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Capabilities
Ord TerminalCapabilitiesDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Capabilities
Show TerminalCapabilitiesDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Capabilities
Generic TerminalCapabilitiesDefined in safe-coloured-text-0.6.0.0 · Text.Colour.Capabilities
type Rep TerminalCapabilities = D1 ('MetaData "TerminalCapabilities" "Text.Colour.Capabilities" "safe-coloured-text-0.6.0.0-KZ8N9726PbF9wBfBB38nBI" 'False) ((C1 ('MetaCons "WithoutColours" 'PrefixI 'False) U1 :+: C1 ('MetaCons "With8Colours" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "With8BitColours" 'PrefixI 'False) U1 :+: C1 ('MetaCons "With24BitColours" 'PrefixI 'False) U1))Defined in safe-coloured-text-0.6.0.0 · Text.Colour.Capabilities

Outputting chunks directly

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

Source#

Print a list of chunks to stdout with given TerminalCapabilities.

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

Source#

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

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

Source#

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

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

Source#

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