Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Colour.Chunk

Synopsis

data Chunk = Chunk {
- chunkText :: !Text
- chunkItalic :: !(Maybe Bool)
- chunkConsoleIntensity :: !(Maybe ConsoleIntensity)
- chunkUnderlining :: !(Maybe Underlining)
- chunkBlinking :: !(Maybe Blinking)
- chunkForeground :: !(Maybe Colour)
- chunkBackground :: !(Maybe Colour)
}
plainChunk :: TerminalCapabilities -> Chunk -> Bool
plainColour :: TerminalCapabilities -> Colour -> Bool
renderChunksUtf8BS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString
renderChunksUtf8BSBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder
renderChunksText :: Foldable f => TerminalCapabilities -> f Chunk -> Text
renderChunksLazyText :: Foldable f => TerminalCapabilities -> f Chunk -> Text
renderChunksBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder
renderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString
renderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder
renderChunkText :: TerminalCapabilities -> Chunk -> Text
renderChunkLazyText :: TerminalCapabilities -> Chunk -> Text
renderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder
chunkSGR :: TerminalCapabilities -> Chunk -> [SGR]
chunk :: Text -> Chunk
fore :: Colour -> Chunk -> Chunk
back :: Colour -> Chunk -> Chunk
bold :: Chunk -> Chunk
faint :: Chunk -> Chunk
italic :: Chunk -> Chunk
underline :: Chunk -> Chunk
doubleUnderline :: Chunk -> Chunk
noUnderline :: Chunk -> Chunk
slowBlinking :: Chunk -> Chunk
rapidBlinking :: Chunk -> Chunk
noBlinking :: Chunk -> Chunk
data Colour
- = Colour8 !ColourIntensity !TerminalColour
- | Colour8Bit !Word8
- | Colour24Bit !Word8 !Word8 !Word8
colourSGR :: TerminalCapabilities -> ConsoleLayer -> Colour -> Maybe SGR
black :: Colour
red :: Colour
green :: Colour
yellow :: Colour
blue :: Colour
magenta :: Colour
cyan :: Colour
white :: Colour
brightBlack :: Colour
brightRed :: Colour
brightGreen :: Colour
brightYellow :: Colour
brightBlue :: Colour
brightMagenta :: Colour
brightCyan :: Colour
brightWhite :: Colour
colour256 :: Word8 -> Colour
color256 :: Word8 -> Colour
colourRGB :: Word8 -> Word8 -> Word8 -> Colour
colorRGB :: Word8 -> Word8 -> Word8 -> Colour

Documentation

data Chunk Source #

Constructors

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

Instances

Instances details

IsString Chunk Source #
Instance details Defined in Text.Colour.Chunk Methods fromString :: String -> Chunk #
Generic Chunk Source #
Instance details Defined in Text.Colour.Chunk Associated Types type Rep Chunk :: Type -> Type # Methods from :: Chunk -> Rep Chunk x # to :: Rep Chunk x -> Chunk #
Show Chunk Source #
Instance details Defined in Text.Colour.Chunk Methods showsPrec :: Int -> Chunk -> ShowS # show :: Chunk -> String # showList :: [Chunk] -> ShowS #
Eq Chunk Source #
Instance details Defined in Text.Colour.Chunk Methods (==) :: Chunk -> Chunk -> Bool # (/=) :: Chunk -> Chunk -> Bool #
Validity Chunk Source #
Instance details Defined in Text.Colour.Chunk Methods validate :: Chunk -> Validation #
type Rep Chunk Source #
Instance details Defined in Text.Colour.Chunk type Rep Chunk = D1 ('MetaData "Chunk" "Text.Colour.Chunk" "safe-coloured-text-0.3.0.1-1UhgCUXvo4EyxlL8IgG3B" '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))))))

plainChunk :: TerminalCapabilities -> Chunk -> Bool Source #

plainColour :: TerminalCapabilities -> Colour -> Bool Source #

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

Render chunks directly to a UTF8-encoded Bytestring.

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

Render chunks to a UTF8-encoded ByteString Builder.

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

Render chunks directly to strict Text.

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

Render chunks directly to lazy Text.

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

Render chunks to a lazy Text Builder

renderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString Source #

Render a chunk directly to a UTF8-encoded Bytestring.

renderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder Source #

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

renderChunkText :: TerminalCapabilities -> Chunk -> Text Source #

Render a chunk directly to strict Text.

renderChunkLazyText :: TerminalCapabilities -> Chunk -> Text Source #

Render a chunk directly to strict Text.

renderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder Source #

Render a chunk to a lazy Text Builder

chunkSGR :: TerminalCapabilities -> Chunk -> [SGR] Source #

chunk :: Text -> Chunk Source #

Turn a text into a plain chunk, without any styling

fore :: Colour -> Chunk -> Chunk Source #

back :: Colour -> Chunk -> Chunk Source #

bold :: Chunk -> Chunk Source #

faint :: Chunk -> Chunk Source #

italic :: Chunk -> Chunk Source #

underline :: Chunk -> Chunk Source #

doubleUnderline :: Chunk -> Chunk Source #

noUnderline :: Chunk -> Chunk Source #

slowBlinking :: Chunk -> Chunk Source #

rapidBlinking :: Chunk -> Chunk Source #

noBlinking :: Chunk -> Chunk Source #

data Colour Source #

Constructors

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

Instances

Instances details

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