Skip to content

HORIZON HASKELL Docs lts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulesafe-coloured-text-0.3.0.2Haskell2010

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.

3 types
48 values

Packagesafe-coloured-text-0.3.0.2
Exports51
LanguageHaskell2010
LicenceMIT
SourceColour.hs

Building chunks

2 declarations

valuechunk :: Text -> Chunk

Turn a text into a plain chunk, without any styling

datadata Chunk

Constructors

Chunk
- chunkText :: !Text
- chunkItalic :: !Maybe Bool
- chunkConsoleIntensity :: !Maybe ConsoleIntensity
- chunkUnderlining :: !Maybe Underlining
- chunkBlinking :: !Maybe Blinking
- chunkForeground :: !Maybe Colour
- chunkBackground :: !Maybe Colour

Instances6Eq, Show, IsString, Generic, Validity, Rep

Eq ChunkDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
Show ChunkDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
IsString ChunkDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
Generic ChunkDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
Validity ChunkDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
type Rep Chunk = D1 ('MetaData "Chunk" "Text.Colour.Chunk" "safe-coloured-text-0.3.0.2-2uitOnCY80jBmbI1tawE6k" '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 "chunkBlinking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Blinking))) :*: (S1 ('MetaSel ('Just "chunkForeground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour)) :*: S1 ('MetaSel ('Just "chunkBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour))))))Defined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk

Styling

Setting colour

valuefore :: Colour -> Chunk -> Chunk

valueback :: Colour -> Chunk -> Chunk

Setting non-colour attributes

valuebold :: Chunk -> Chunk

valuefaint :: Chunk -> Chunk

valueitalic :: 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.3.0.2 · Text.Colour.Chunk
Show ColourDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
Generic ColourDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
Validity ColourDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Chunk
type Rep Colour = D1 ('MetaData "Colour" "Text.Colour.Chunk" "safe-coloured-text-0.3.0.2-2uitOnCY80jBmbI1tawE6k" '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.3.0.2 · 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

Alias for colour256, bloody americans...

valuecolour256 :: Word8 -> Colour

Bulid an 8-bit RGB Colour

This will not be rendered unless With8BitColours is used.

24-bit

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

Alias for colourRGB, bloody americans...

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

Bulid a 24-bit RGB Colour

This will not be rendered unless With24BitColours is used.

Rendering

0 declarations

Composing chunks

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

Render lines of chunks.

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

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

Render lines of chunks.

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

Rendering chunks to strict bytestring in UTF8

valuerenderChunksUtf8BS

Render chunks directly to a UTF8-encoded Bytestring.

valuerenderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString

Render a chunk directly to a UTF8-encoded Bytestring.

Rendering chunks to lazy bytestring builders in UTF8

valuerenderChunksUtf8BSBuilder

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

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

valuerenderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder

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

Rendering chunks to strict Text

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

Render chunks directly to strict Text.

valuerenderChunkText :: TerminalCapabilities -> Chunk -> Text

Render a chunk directly to strict Text.

Rendering chunks to lazy text

valuerenderChunksLazyText

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

Render chunks directly to lazy Text.

valuerenderChunkLazyText :: TerminalCapabilities -> Chunk -> Text

Render a chunk directly to strict Text.

Rendering chunks to lazy text builder

valuerenderChunksBuilder

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

Render chunks to a lazy Text Builder

valuerenderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder

Render a chunk to a lazy Text Builder

IO

1 declaration

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.3.0.2 · Text.Colour.Capabilities
Ord TerminalCapabilitiesDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Capabilities
Show TerminalCapabilitiesDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Capabilities
Generic TerminalCapabilitiesDefined in safe-coloured-text-0.3.0.2 · Text.Colour.Capabilities
type Rep TerminalCapabilities = D1 ('MetaData "TerminalCapabilities" "Text.Colour.Capabilities" "safe-coloured-text-0.3.0.2-2uitOnCY80jBmbI1tawE6k" '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.3.0.2 · Text.Colour.Capabilities

Outputting chunks directly

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

Print a list of chunks to stdout with given TerminalCapabilities.

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

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

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

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

valuehPutChunksLocaleWith :: 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.