Data.Monoid.Colorful.Flat

This module provides the flat Colored type, which is used internally for rendering the nested Colored but is also useful on its own. The API resembles the API of Colorful.

Documentation

data Style

Rendering style

Constructors

Bold

Bold font

Italic

Italic font

Under

Underlined text

Invert

Invert foreground and background color

Blink

Blinking

Instances

Bounded Style

Methods

minBound :: Style

maxBound :: Style

Enum Style

Methods

succ :: Style -> Style

pred :: Style -> Style

toEnum :: Int -> Style

fromEnum :: Style -> Int

enumFrom :: Style -> [Style]

enumFromThen :: Style -> Style -> [Style]

enumFromTo :: Style -> Style -> [Style]

enumFromThenTo :: Style -> Style -> Style -> [Style]

Eq Style

Methods

(==) :: Style -> Style -> Bool

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

Ord Style

Methods

compare :: Style -> Style -> Ordering

(<) :: Style -> Style -> Bool

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

(>) :: Style -> Style -> Bool

(>=) :: Style -> Style -> Bool

max :: Style -> Style -> Style

min :: Style -> Style -> Style

Read Style

Methods

readsPrec :: Int -> ReadS Style

readList :: ReadS [Style]

readPrec :: ReadPrec Style

readListPrec :: ReadPrec [Style]

Show Style

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Generic Style

Associated Types

type Rep Style :: * -> *

Methods

from :: Style -> Rep Style x

to :: Rep Style x -> Style

type Rep Style

type Rep Style = D1 (MetaData "Style" "Data.Monoid.Colorful.Color" "colorful-monoids-0.1.0.0-3LyiExb6f682DnAvcxPZPB" False) ((:+:) ((:+:) (C1 (MetaCons "Bold" PrefixI False) U1) (C1 (MetaCons "Italic" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Under" PrefixI False) U1) ((:+:) (C1 (MetaCons "Invert" PrefixI False) U1) (C1 (MetaCons "Blink" PrefixI False) U1))))

data Color

Named colors, 256 and RGB colors for more capable terminals.

Constructors

DefaultColor

Default terminal color (terminal specific)

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

DullBlack

DullRed

DullGreen

DullYellow

DullBlue

DullMagenta

DullCyan

DullWhite

Color256 !Word8

Color from 256 color scheme. Color is automatically reduced to 8 colors for less capable terminals.

RGB !Word8 !Word8 !Word8

True color. Color is automatically reduced to 256 or 8 colors for less capable terminals.

Instances

Eq Color

Methods

(==) :: Color -> Color -> Bool

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

Ord Color

Methods

compare :: Color -> Color -> Ordering

(<) :: Color -> Color -> Bool

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

(>) :: Color -> Color -> Bool

(>=) :: Color -> Color -> Bool

max :: Color -> Color -> Color

min :: Color -> Color -> Color

Read Color

Methods

readsPrec :: Int -> ReadS Color

readList :: ReadS [Color]

readPrec :: ReadPrec Color

readListPrec :: ReadPrec [Color]

Show Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Generic Color

Associated Types

type Rep Color :: * -> *

Methods

from :: Color -> Rep Color x

to :: Rep Color x -> Color

type Rep Color

type Rep Color = D1 (MetaData "Color" "Data.Monoid.Colorful.Color" "colorful-monoids-0.1.0.0-3LyiExb6f682DnAvcxPZPB" False) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "DefaultColor" PrefixI False) U1) (C1 (MetaCons "Black" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Red" PrefixI False) U1) (C1 (MetaCons "Green" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "Yellow" PrefixI False) U1) (C1 (MetaCons "Blue" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Magenta" PrefixI False) U1) ((:+:) (C1 (MetaCons "Cyan" PrefixI False) U1) (C1 (MetaCons "White" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "DullBlack" PrefixI False) U1) (C1 (MetaCons "DullRed" PrefixI False) U1)) ((:+:) (C1 (MetaCons "DullGreen" PrefixI False) U1) ((:+:) (C1 (MetaCons "DullYellow" PrefixI False) U1) (C1 (MetaCons "DullBlue" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "DullMagenta" PrefixI False) U1) (C1 (MetaCons "DullCyan" PrefixI False) U1)) ((:+:) (C1 (MetaCons "DullWhite" PrefixI False) U1) ((:+:) (C1 (MetaCons "Color256" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8))) (C1 (MetaCons "RGB" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8)) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word8))))))))))

data Term

Terminal type. For less capable terminals the color depth is automatically reduced.

Constructors

TermDumb

Dumb terminal - no color output

Term8

8 colors supported

Term256

256 colors supported

TermRGB

True colors supported

TermWin

Windows terminal. Will use emulation (Not yet implemented).

Instances

Bounded Term

Methods

minBound :: Term

maxBound :: Term

Enum Term

Methods

succ :: Term -> Term

pred :: Term -> Term

toEnum :: Int -> Term

fromEnum :: Term -> Int

enumFrom :: Term -> [Term]

enumFromThen :: Term -> Term -> [Term]

enumFromTo :: Term -> Term -> [Term]

enumFromThenTo :: Term -> Term -> Term -> [Term]

Eq Term

Methods

(==) :: Term -> Term -> Bool

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

Ord Term

Methods

compare :: Term -> Term -> Ordering

(<) :: Term -> Term -> Bool

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

(>) :: Term -> Term -> Bool

(>=) :: Term -> Term -> Bool

max :: Term -> Term -> Term

min :: Term -> Term -> Term

Read Term

Methods

readsPrec :: Int -> ReadS Term

readList :: ReadS [Term]

readPrec :: ReadPrec Term

readListPrec :: ReadPrec [Term]

Show Term

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

Generic Term

Associated Types

type Rep Term :: * -> *

Methods

from :: Term -> Rep Term x

to :: Rep Term x -> Term

type Rep Term

type Rep Term = D1 (MetaData "Term" "Data.Monoid.Colorful.Term" "colorful-monoids-0.1.0.0-3LyiExb6f682DnAvcxPZPB" False) ((:+:) ((:+:) (C1 (MetaCons "TermDumb" PrefixI False) U1) (C1 (MetaCons "Term8" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Term256" PrefixI False) U1) ((:+:) (C1 (MetaCons "TermRGB" PrefixI False) U1) (C1 (MetaCons "TermWin" PrefixI False) U1))))

data Colored a

Constructors

Value a

Style !Style

Unstyle !Style

Fg !Color

Bg !Color

Push

Pop

Reset

Instances

Functor Colored

Methods

fmap :: (a -> b) -> Colored a -> Colored b

(<$) :: a -> Colored b -> Colored a

Foldable Colored

Methods

fold :: Monoid m => Colored m -> m

foldMap :: Monoid m => (a -> m) -> Colored a -> m

foldr :: (a -> b -> b) -> b -> Colored a -> b

foldr' :: (a -> b -> b) -> b -> Colored a -> b

foldl :: (b -> a -> b) -> b -> Colored a -> b

foldl' :: (b -> a -> b) -> b -> Colored a -> b

foldr1 :: (a -> a -> a) -> Colored a -> a

foldl1 :: (a -> a -> a) -> Colored a -> a

toList :: Colored a -> [a]

null :: Colored a -> Bool

length :: Colored a -> Int

elem :: Eq a => a -> Colored a -> Bool

maximum :: Ord a => Colored a -> a

minimum :: Ord a => Colored a -> a

sum :: Num a => Colored a -> a

product :: Num a => Colored a -> a

Traversable Colored

Methods

traverse :: Applicative f => (a -> f b) -> Colored a -> f (Colored b)

sequenceA :: Applicative f => Colored (f a) -> f (Colored a)

mapM :: Monad m => (a -> m b) -> Colored a -> m (Colored b)

sequence :: Monad m => Colored (m a) -> m (Colored a)

Generic1 Colored

Associated Types

type Rep1 (Colored :: * -> *) :: * -> *

Methods

from1 :: Colored a -> Rep1 Colored a

to1 :: Rep1 Colored a -> Colored a

Eq a => Eq (Colored a)

Methods

(==) :: Colored a -> Colored a -> Bool

(/=) :: Colored a -> Colored a -> Bool

Ord a => Ord (Colored a)

Methods

compare :: Colored a -> Colored a -> Ordering

(<) :: Colored a -> Colored a -> Bool

(<=) :: Colored a -> Colored a -> Bool

(>) :: Colored a -> Colored a -> Bool

(>=) :: Colored a -> Colored a -> Bool

max :: Colored a -> Colored a -> Colored a

min :: Colored a -> Colored a -> Colored a

Show a => Show (Colored a)

Methods

showsPrec :: Int -> Colored a -> ShowS

show :: Colored a -> String

showList :: [Colored a] -> ShowS

Generic (Colored a)

Associated Types

type Rep (Colored a) :: * -> *

Methods

from :: Colored a -> Rep (Colored a) x

to :: Rep (Colored a) x -> Colored a

type Rep1 Colored

type Rep1 Colored = D1 (MetaData "Colored" "Data.Monoid.Colorful.Flat" "colorful-monoids-0.1.0.0-3LyiExb6f682DnAvcxPZPB" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Value" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) Par1)) (C1 (MetaCons "Style" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Style)))) ((:+:) (C1 (MetaCons "Unstyle" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Style))) (C1 (MetaCons "Fg" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Color))))) ((:+:) ((:+:) (C1 (MetaCons "Bg" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Color))) (C1 (MetaCons "Push" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Pop" PrefixI False) U1) (C1 (MetaCons "Reset" PrefixI False) U1))))

type Rep (Colored a)

type Rep (Colored a) = D1 (MetaData "Colored" "Data.Monoid.Colorful.Flat" "colorful-monoids-0.1.0.0-3LyiExb6f682DnAvcxPZPB" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "Value" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) (C1 (MetaCons "Style" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Style)))) ((:+:) (C1 (MetaCons "Unstyle" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Style))) (C1 (MetaCons "Fg" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Color))))) ((:+:) ((:+:) (C1 (MetaCons "Bg" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Color))) (C1 (MetaCons "Push" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Pop" PrefixI False) U1) (C1 (MetaCons "Reset" PrefixI False) U1))))

hGetTerm :: Handle -> IO Term

The action (hGetTerm handle) determines the terminal type of the file handle.

The terminal type is determined by checking if the file handle points to a device and by looking at the $TERM environment variable.

getTerm :: IO Term

hPrintColored :: (Handle -> a -> IO ()) -> Handle -> Term -> [Colored a] -> IO ()

printColored :: (a -> IO ()) -> Term -> [Colored a] -> IO ()

hPrintColoredIO :: Handle -> Term -> [Colored (IO ())] -> IO ()

printColoredIO :: Term -> [Colored (IO ())] -> IO ()

hPrintColoredS :: Handle -> Term -> [Colored String] -> IO ()

printColoredS :: Term -> [Colored String] -> IO ()

showColored :: Monoid o => (a -> o) -> (SGRCode -> o) -> Term -> [Colored a] -> o

showColoredA :: (Applicative f, Monoid o) => (a -> f o) -> (SGRCode -> f o) -> Term -> [Colored a] -> f o

showColoredS :: Term -> [Colored String] -> ShowS