| Copyright | Daniel Mendler (c) 2017 |
|---|---|
| License | MIT (see the file LICENSE) |
| Maintainer | mail@daniel-mendler.de |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | Safe |
| Language | Haskell2010 |
Data.Monoid.Colorful
Contents
Description
This library provides styled text output using ANSI escape sequences. The colored text is modeled as nested Colored values, which form a Monoid. As a result the colored code has a relatively concise form.
For rendering, the Colored Monoid is flattended and then printed out. The library keeps track of a stack of the active styles internally, such that correct and minimal escape sequences are generated.
This library is used by wl-pprint-console, which is a pretty printer with support for annotations.
Warning: Windows support is currently not implemented, but is planned (by using ansi-terminal or the ffi).
Example:
basicExample :: IO ()
basicExample = do
term <- getTerm
printColoredS term $ Style Underline (Style Bold "Basic Example\n")
<> Style Bold "Bold"
<> Style Italic (Bg Red "Italic Red")
<> Style Underline "Underline"
putChar '\n'For many more examples, see the example.hs file.
Synopsis
- data Colored a
- data Style
- data Color
- data Term
- hGetTerm :: Handle -> IO Term
- 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
- showColoredM :: (Monad f, Monoid o) => (a -> f o) -> (SGRCode -> f o) -> Term -> Colored a -> f o
- showColoredS :: Term -> Colored String -> ShowS
- (<>) :: Semigroup a => a -> a -> a
The Monoid
Colored Monoid
Constructors
| Nil | |
| Value a | |
| Style !Style (Colored a) | |
| Unstyle !Style (Colored a) | |
| Fg !Color (Colored a) | |
| Bg !Color (Colored a) | |
| Pair (Colored a) (Colored a) |
Instances
Rendering style
Constructors
| Bold | Bold font |
| Italic | Italic font |
| Underline | Underlined text |
| Invert | Invert foreground and background color |
| Blink | Blinking |
Instances
| Bounded Style Source # | |
| Enum Style Source # | |
Defined in Data.Monoid.Colorful.Color | |
| Eq Style Source # | |
| Ord Style Source # | |
| Read Style Source # | |
| Show Style Source # | |
| Generic Style Source # | |
| type Rep Style Source # | |
Defined in Data.Monoid.Colorful.Color type Rep Style = D1 (MetaData "Style" "Data.Monoid.Colorful.Color" "colorful-monoids-0.2.1.3-KQ4pdXOAU8zLHhz6xJWI7W" False) ((C1 (MetaCons "Bold" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Italic" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Underline" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Invert" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Blink" PrefixI False) (U1 :: Type -> Type)))) | |
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
Terminal type
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 Source # | |
| Enum Term Source # | |
| Eq Term Source # | |
| Ord Term Source # | |
| Read Term Source # | |
| Show Term Source # | |
| Generic Term Source # | |
| type Rep Term Source # | |
Defined in Data.Monoid.Colorful.Term type Rep Term = D1 (MetaData "Term" "Data.Monoid.Colorful.Term" "colorful-monoids-0.2.1.3-KQ4pdXOAU8zLHhz6xJWI7W" False) ((C1 (MetaCons "TermDumb" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Term8" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Term256" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "TermRGB" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TermWin" PrefixI False) (U1 :: Type -> Type)))) | |
hGetTerm :: Handle -> IO Term Source #
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.
Colorful printing to file handle
Show with ANSI escape sequences
showColoredM :: (Monad f, Monoid o) => (a -> f o) -> (SGRCode -> f o) -> Term -> Colored a -> f o Source #