Rainbow.Types

All the main types in Rainbow. Using this module you can specify that you want different formatting for 8- and 256-color terminals. Many of the names in this module conflict with the names in Rainbow, so it's probably best to import this module qualified.

Documentation

newtype Color a

A color; a Nothing value means that the terminal's default color is used. The type of the Maybe generally will be an Enum8 to represent one of 8 colors, or a Word8 to represent one of 256 colors.

Constructors

Color (Maybe a)

Instances

Functor Color

Defined in Rainbow.Types

Methods

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

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

Foldable Color

Defined in Rainbow.Types

Methods

fold :: Monoid m => Color m -> m

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

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

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

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

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

foldr1 :: (a -> a -> a) -> Color a -> a

foldl1 :: (a -> a -> a) -> Color a -> a

toList :: Color a -> [a]

null :: Color a -> Bool

length :: Color a -> Int

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

maximum :: Ord a => Color a -> a

minimum :: Ord a => Color a -> a

sum :: Num a => Color a -> a

product :: Num a => Color a -> a

Traversable Color

Defined in Rainbow.Types

Methods

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

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

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

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

Eq a => Eq (Color a)

Defined in Rainbow.Types

Methods

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

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

Ord a => Ord (Color a)

Defined in Rainbow.Types

Methods

compare :: Color a -> Color a -> Ordering

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

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

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

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

max :: Color a -> Color a -> Color a

min :: Color a -> Color a -> Color a

Show a => Show (Color a)

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Color a -> ShowS

show :: Color a -> String

showList :: [Color a] -> ShowS

Generic (Color a)

Defined in Rainbow.Types

Associated Types

type Rep (Color a) :: Type -> Type

Methods

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

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

Semigroup (Color a)

Defined in Rainbow.Types

Methods

(<>) :: Color a -> Color a -> Color a

sconcat :: NonEmpty (Color a) -> Color a

stimes :: Integral b => b -> Color a -> Color a

Monoid (Color a)

Takes the last non-Nothing Color. mempty is no color.

Defined in Rainbow.Types

Methods

mempty :: Color a

mappend :: Color a -> Color a -> Color a

mconcat :: [Color a] -> Color a

type Rep (Color a)

Defined in Rainbow.Types

type Rep (Color a) = D1 (MetaData "Color" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" True) (C1 (MetaCons "Color" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe a))))

data Enum8

A simple enumeration for eight values. Represents eight colors.

Constructors

E0

E1

E2

E3

E4

E5

E6

E7

Instances

Bounded Enum8

Defined in Rainbow.Types

Methods

minBound :: Enum8

maxBound :: Enum8

Enum Enum8

Defined in Rainbow.Types

Methods

succ :: Enum8 -> Enum8

pred :: Enum8 -> Enum8

toEnum :: Int -> Enum8

fromEnum :: Enum8 -> Int

enumFrom :: Enum8 -> [Enum8]

enumFromThen :: Enum8 -> Enum8 -> [Enum8]

enumFromTo :: Enum8 -> Enum8 -> [Enum8]

enumFromThenTo :: Enum8 -> Enum8 -> Enum8 -> [Enum8]

Eq Enum8

Defined in Rainbow.Types

Methods

(==) :: Enum8 -> Enum8 -> Bool

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

Ord Enum8

Defined in Rainbow.Types

Methods

compare :: Enum8 -> Enum8 -> Ordering

(<) :: Enum8 -> Enum8 -> Bool

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

(>) :: Enum8 -> Enum8 -> Bool

(>=) :: Enum8 -> Enum8 -> Bool

max :: Enum8 -> Enum8 -> Enum8

min :: Enum8 -> Enum8 -> Enum8

Show Enum8

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Enum8 -> ShowS

show :: Enum8 -> String

showList :: [Enum8] -> ShowS

Generic Enum8

Defined in Rainbow.Types

Associated Types

type Rep Enum8 :: Type -> Type

Methods

from :: Enum8 -> Rep Enum8 x

to :: Rep Enum8 x -> Enum8

type Rep Enum8

Defined in Rainbow.Types

type Rep Enum8 = D1 (MetaData "Enum8" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (((C1 (MetaCons "E0" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "E1" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "E2" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "E3" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "E4" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "E5" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "E6" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "E7" PrefixI False) (U1 :: Type -> Type))))

enum8toWord8 :: Enum8 -> Word8

black :: Enum8

red :: Enum8

green :: Enum8

yellow :: Enum8

blue :: Enum8

magenta :: Enum8

cyan :: Enum8

white :: Enum8

grey :: Word8

brightRed :: Word8

brightGreen :: Word8

brightYellow :: Word8

brightBlue :: Word8

brightMagenta :: Word8

brightCyan :: Word8

brightWhite :: Word8

data Format

Text formatting such as bold, italic, etc.

Constructors

Format

Fields

• _bold :: Bool
• _faint :: Bool
• _italic :: Bool
• _underline :: Bool
• _blink :: Bool
• _inverse :: Bool
• _invisible :: Bool
• _strikeout :: Bool

Instances

Eq Format

Defined in Rainbow.Types

Methods

(==) :: Format -> Format -> Bool

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

Ord Format

Defined in Rainbow.Types

Methods

compare :: Format -> Format -> Ordering

(<) :: Format -> Format -> Bool

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

(>) :: Format -> Format -> Bool

(>=) :: Format -> Format -> Bool

max :: Format -> Format -> Format

min :: Format -> Format -> Format

Show Format

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Generic Format

Defined in Rainbow.Types

Associated Types

type Rep Format :: Type -> Type

Methods

from :: Format -> Rep Format x

to :: Rep Format x -> Format

Semigroup Format

Defined in Rainbow.Types

Methods

(<>) :: Format -> Format -> Format

sconcat :: NonEmpty Format -> Format

stimes :: Integral b => b -> Format -> Format

Monoid Format

For each field, the resulting field is True if either field is True. For mempty, every field is False.

Defined in Rainbow.Types

Methods

mempty :: Format

mappend :: Format -> Format -> Format

mconcat :: [Format] -> Format

type Rep Format

Defined in Rainbow.Types

type Rep Format = D1 (MetaData "Format" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (C1 (MetaCons "Format" PrefixI True) (((S1 (MetaSel (Just "_bold") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "_faint") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "_italic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "_underline") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool))) :*: ((S1 (MetaSel (Just "_blink") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "_inverse") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "_invisible") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "_strikeout") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

underline :: Lens' Format Bool

strikeout :: Lens' Format Bool

italic :: Lens' Format Bool

invisible :: Lens' Format Bool

inverse :: Lens' Format Bool

faint :: Lens' Format Bool

bold :: Lens' Format Bool

blink :: Lens' Format Bool

data Style a

The foreground and background color, and the Format. This represents all colors and formatting attributes for either an 8- or 256-color terminal.

Constructors

Style

Fields

• _fore :: Color a
• _back :: Color a
• _format :: Format

Instances

Functor Style

Defined in Rainbow.Types

Methods

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

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

Foldable Style

Defined in Rainbow.Types

Methods

fold :: Monoid m => Style m -> m

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

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

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

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

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

foldr1 :: (a -> a -> a) -> Style a -> a

foldl1 :: (a -> a -> a) -> Style a -> a

toList :: Style a -> [a]

null :: Style a -> Bool

length :: Style a -> Int

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

maximum :: Ord a => Style a -> a

minimum :: Ord a => Style a -> a

sum :: Num a => Style a -> a

product :: Num a => Style a -> a

Traversable Style

Defined in Rainbow.Types

Methods

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

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

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

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

Eq a => Eq (Style a)

Defined in Rainbow.Types

Methods

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

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

Ord a => Ord (Style a)

Defined in Rainbow.Types

Methods

compare :: Style a -> Style a -> Ordering

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

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

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

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

max :: Style a -> Style a -> Style a

min :: Style a -> Style a -> Style a

Show a => Show (Style a)

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Style a -> ShowS

show :: Style a -> String

showList :: [Style a] -> ShowS

Generic (Style a)

Defined in Rainbow.Types

Associated Types

type Rep (Style a) :: Type -> Type

Methods

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

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

Semigroup (Style a)

Defined in Rainbow.Types

Methods

(<>) :: Style a -> Style a -> Style a

sconcat :: NonEmpty (Style a) -> Style a

stimes :: Integral b => b -> Style a -> Style a

Monoid (Style a)

Uses the underlying Monoid instances for Color and Format.

Defined in Rainbow.Types

Methods

mempty :: Style a

mappend :: Style a -> Style a -> Style a

mconcat :: [Style a] -> Style a

type Rep (Style a)

Defined in Rainbow.Types

type Rep (Style a) = D1 (MetaData "Style" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (C1 (MetaCons "Style" PrefixI True) (S1 (MetaSel (Just "_fore") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Color a)) :*: (S1 (MetaSel (Just "_back") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Color a)) :*: S1 (MetaSel (Just "_format") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Format))))

format :: forall a. Lens' (Style a) Format

fore :: forall a. Lens' (Style a) (Color a)

back :: forall a. Lens' (Style a) (Color a)

data Scheme

Holds the Style for both 8- and 256-color terminals.

Constructors

Scheme

Fields

• _style8 :: Style Enum8
• _style256 :: Style Word8

Instances

Eq Scheme

Defined in Rainbow.Types

Methods

(==) :: Scheme -> Scheme -> Bool

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

Ord Scheme

Defined in Rainbow.Types

Methods

compare :: Scheme -> Scheme -> Ordering

(<) :: Scheme -> Scheme -> Bool

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

(>) :: Scheme -> Scheme -> Bool

(>=) :: Scheme -> Scheme -> Bool

max :: Scheme -> Scheme -> Scheme

min :: Scheme -> Scheme -> Scheme

Show Scheme

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Scheme -> ShowS

show :: Scheme -> String

showList :: [Scheme] -> ShowS

Generic Scheme

Defined in Rainbow.Types

Associated Types

type Rep Scheme :: Type -> Type

Methods

from :: Scheme -> Rep Scheme x

to :: Rep Scheme x -> Scheme

Semigroup Scheme

Defined in Rainbow.Types

Methods

(<>) :: Scheme -> Scheme -> Scheme

sconcat :: NonEmpty Scheme -> Scheme

stimes :: Integral b => b -> Scheme -> Scheme

Monoid Scheme

Defined in Rainbow.Types

Methods

mempty :: Scheme

mappend :: Scheme -> Scheme -> Scheme

mconcat :: [Scheme] -> Scheme

type Rep Scheme

Defined in Rainbow.Types

type Rep Scheme = D1 (MetaData "Scheme" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (C1 (MetaCons "Scheme" PrefixI True) (S1 (MetaSel (Just "_style8") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Style Enum8)) :*: S1 (MetaSel (Just "_style256") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Style Word8))))

style8 :: Lens' Scheme (Style Enum8)

style256 :: Lens' Scheme (Style Word8)

data Chunk

A chunk is some textual data coupled with a description of what color the text is, attributes like whether it is bold or underlined, etc. The chunk knows what foreground and background colors and what attributes to use for both an 8 color terminal and a 256 color terminal.

Constructors

Chunk

Fields

• _scheme :: Scheme
• _yarn :: Text

Instances

Eq Chunk

Defined in Rainbow.Types

Methods

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

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

Ord Chunk

Defined in Rainbow.Types

Methods

compare :: Chunk -> Chunk -> Ordering

(<) :: Chunk -> Chunk -> Bool

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

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

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

max :: Chunk -> Chunk -> Chunk

min :: Chunk -> Chunk -> Chunk

Show Chunk

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

IsString Chunk

Creates a Chunk with no formatting and with the given text.

Defined in Rainbow.Types

Methods

fromString :: String -> Chunk

Generic Chunk

Defined in Rainbow.Types

Associated Types

type Rep Chunk :: Type -> Type

Methods

from :: Chunk -> Rep Chunk x

to :: Rep Chunk x -> Chunk

Semigroup Chunk

Uses the underlying Semigroup instances for both the underlying Scheme and the underlying Text.

Defined in Rainbow.Types

Methods

(<>) :: Chunk -> Chunk -> Chunk

sconcat :: NonEmpty Chunk -> Chunk

stimes :: Integral b => b -> Chunk -> Chunk

Monoid Chunk

Uses the underlying Monoid instances for the Scheme and for the underlying Text. Therefore mempty will have no formatting, no colors, and no text.

Defined in Rainbow.Types

Methods

mempty :: Chunk

mappend :: Chunk -> Chunk -> Chunk

mconcat :: [Chunk] -> Chunk

type Rep Chunk

Defined in Rainbow.Types

type Rep Chunk = D1 (MetaData "Chunk" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (C1 (MetaCons "Chunk" PrefixI True) (S1 (MetaSel (Just "_scheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Scheme) :*: S1 (MetaSel (Just "_yarn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

chunk :: Text -> Chunk

Creates a Chunk with no formatting and with the given text. A Chunk is also an instance of IsString so you can create them with the OverloadedStrings extension. Such a Chunk has the text of the string and no formatting.

yarn :: Lens' Chunk Text

scheme :: Lens' Chunk Scheme

data Radiant

Stores colors that may affect 8-color terminals, 256-color terminals, both, or neither.

Constructors

Radiant

Fields

• _color8 :: Color Enum8
• _color256 :: Color Word8

Instances

Eq Radiant

Defined in Rainbow.Types

Methods

(==) :: Radiant -> Radiant -> Bool

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

Ord Radiant

Defined in Rainbow.Types

Methods

compare :: Radiant -> Radiant -> Ordering

(<) :: Radiant -> Radiant -> Bool

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

(>) :: Radiant -> Radiant -> Bool

(>=) :: Radiant -> Radiant -> Bool

max :: Radiant -> Radiant -> Radiant

min :: Radiant -> Radiant -> Radiant

Show Radiant

Defined in Rainbow.Types

Methods

showsPrec :: Int -> Radiant -> ShowS

show :: Radiant -> String

showList :: [Radiant] -> ShowS

Generic Radiant

Defined in Rainbow.Types

Associated Types

type Rep Radiant :: Type -> Type

Methods

from :: Radiant -> Rep Radiant x

to :: Rep Radiant x -> Radiant

Semigroup Radiant

Defined in Rainbow.Types

Methods

(<>) :: Radiant -> Radiant -> Radiant

sconcat :: NonEmpty Radiant -> Radiant

stimes :: Integral b => b -> Radiant -> Radiant

Monoid Radiant

Uses the underlying Monoid instance for the Colors. Thus the last non-Nothing Color is used. This can be useful to specify one color for 8-color terminals and a different color for 256-color terminals.

Defined in Rainbow.Types

Methods

mempty :: Radiant

mappend :: Radiant -> Radiant -> Radiant

mconcat :: [Radiant] -> Radiant

type Rep Radiant

Defined in Rainbow.Types

type Rep Radiant = D1 (MetaData "Radiant" "Rainbow.Types" "rainbow-0.34.2.2-1ah5PZE6w84FK2I3qiFqVN" False) (C1 (MetaCons "Radiant" PrefixI True) (S1 (MetaSel (Just "_color8") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Color Enum8)) :*: S1 (MetaSel (Just "_color256") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Color Word8))))

color8 :: Lens' Radiant (Color Enum8)

color256 :: Lens' Radiant (Color Word8)