System.Console.Style

This library provides styled text output using ANSI escape sequences. The main feature is that the library keeps track of a stack of the applied styles using a state monad. This makes it easy to use this library for a pretty printer with nested annotations, e.g., wl-pprint-console.

Example:

basicExample :: IO ()
basicExample = runWithStyle [FgColor Blue] $ do
  withStyle [Bold] $ liftIO $ putStr "Bold Blue"

  setStyle [Save, Italic, BgColor Red]
  liftIO $ putStr "Italic Red"
  setStyle [Restore]

  setStyle [Under]
  liftIO $ putStr "Under Blue"
  setStyle [Reset]

  liftIO $ putStrLn "Normal output"

For many more examples, see the project's extensive Example.hs file.

Documentation

data Blink

Constructors

NoBlink

BlinkSlow

BlinkFast

Instances

Eq Blink

Methods

(==) :: Blink -> Blink -> Bool

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

Ord Blink

Methods

compare :: Blink -> Blink -> Ordering

(<) :: Blink -> Blink -> Bool

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

(>) :: Blink -> Blink -> Bool

(>=) :: Blink -> Blink -> Bool

max :: Blink -> Blink -> Blink

min :: Blink -> Blink -> Blink

Show Blink

Methods

showsPrec :: Int -> Blink -> ShowS

show :: Blink -> String

showList :: [Blink] -> ShowS

data Color

Constructors

DefaultColor

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

DullBlack

DullRed

DullGreen

DullYellow

DullBlue

DullMagenta

DullCyan

DullWhite

Color256 !Word8

RGB !Word8 !Word8 !Word8

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

Show Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

class HasStyle s where

Minimal complete definition

getStyle, putStyle

Methods

getStyle :: s -> Style

putStyle :: Style -> s -> s

Instances

HasStyle Style

Methods

getStyle :: Style -> Style

putStyle :: Style -> Style -> Style

data SetStyle

Constructors

Bold

NotBold

Italic

NotItalic

Under

NotUnder

Invert

NotInvert

Save

Restore

Reset

Blink !Blink

FgColor !Color

BgColor !Color

Instances

Eq SetStyle

Methods

(==) :: SetStyle -> SetStyle -> Bool

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

Ord SetStyle

Methods

compare :: SetStyle -> SetStyle -> Ordering

(<) :: SetStyle -> SetStyle -> Bool

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

(>) :: SetStyle -> SetStyle -> Bool

(>=) :: SetStyle -> SetStyle -> Bool

max :: SetStyle -> SetStyle -> SetStyle

min :: SetStyle -> SetStyle -> SetStyle

Show SetStyle

Methods

showsPrec :: Int -> SetStyle -> ShowS

show :: SetStyle -> String

showList :: [SetStyle] -> ShowS

data Style

Instances

HasStyle Style

Methods

getStyle :: Style -> Style

putStyle :: Style -> Style -> Style

type StyleT = StateT Style

data Term

Constructors

TermDumb

Term8

Term256

TermRGB

TermWin

Instances

Eq Term

Methods

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

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

Show Term

Methods

showsPrec :: Int -> Term -> ShowS

show :: Term -> String

showList :: [Term] -> ShowS

defaultStyle :: Term -> Style

hGetTerm :: MonadIO m => Handle -> m Term

hRunWithStyle :: MonadIO m => Handle -> [SetStyle] -> StyleT m a -> m a

hSetStyle :: (MonadIO m, MonadState s m, HasStyle s, Foldable f) => Handle -> f SetStyle -> m ()

hWithStyle :: (MonadIO m, MonadState s m, HasStyle s, Foldable f) => Handle -> f SetStyle -> m a -> m a

runStyle :: Term -> State Style a -> a

runStyleT :: Monad m => Term -> StyleT m a -> m a

runWithStyle :: MonadIO m => [SetStyle] -> StyleT m a -> m a

setStyle :: (MonadIO m, MonadState s m, HasStyle s, Foldable f) => f SetStyle -> m ()

styleCode' :: Foldable f => Style -> f SetStyle -> (Style, String)

styleCode :: (MonadState s m, HasStyle s, Foldable f) => f SetStyle -> m String

withStyle :: (MonadIO m, MonadState s m, HasStyle s, Foldable f) => f SetStyle -> m a -> m a