Safe Haskell	Safe
Language	Haskell98

System.Console.Terminfo.PrettyPrint

Contents

Raw Effect (requires the effect be present)
A Color Pretty Printer

Synopsis

data ScopedEffect
- = Bold
- | Standout
- | Underline
- | Reverse
- | Blink
- | Dim
- | Invisible
- | Protected
- | Foreground Color
- | Background Color
- | Else ScopedEffect ScopedEffect
- | Nop
with :: ScopedEffect -> TermDoc -> TermDoc
data Effect
- = Push ScopedEffect
- | Pop
- | Ring Bell
soft :: ScopedEffect -> ScopedEffect
blink :: TermDoc -> TermDoc
bold :: TermDoc -> TermDoc
underline :: TermDoc -> TermDoc
standout :: TermDoc -> TermDoc
reversed :: TermDoc -> TermDoc
protected :: TermDoc -> TermDoc
invisible :: TermDoc -> TermDoc
dim :: TermDoc -> TermDoc
red :: TermDoc -> TermDoc
black :: TermDoc -> TermDoc
green :: TermDoc -> TermDoc
blue :: TermDoc -> TermDoc
yellow :: TermDoc -> TermDoc
magenta :: TermDoc -> TermDoc
cyan :: TermDoc -> TermDoc
white :: TermDoc -> TermDoc
foreground :: Color -> TermDoc -> TermDoc
background :: Color -> TermDoc -> TermDoc
data Bell
- = VisibleBellOnly
- | AudibleBellOnly
- | VisibleBellPreferred
- | AudibleBellPreferred
ring :: Bell -> TermDoc
type TermDoc = Doc Effect
display :: (MonadIO m, PrettyTerm t) => t -> m ()
displayLn :: MonadIO m => PrettyTerm t => t -> m ()
displayDoc :: (MonadIO m, PrettyTerm t) => Float -> t -> m ()
displayDoc' :: (MonadIO m, PrettyTerm t) => Terminal -> Float -> t -> m ()
displayDoc'' :: (MonadIO m, PrettyTerm t) => Terminal -> Float -> Int -> t -> m ()
class Pretty t => PrettyTerm t where
type SimpleTermDoc = SimpleDoc Effect
evalTermState :: Monad m => StateT TermState m a -> m a
displayCap :: SimpleTermDoc -> StateT TermState Capability TermOutput

Raw Effect (requires the effect be present)

data ScopedEffect Source #

Constructors

Bold
Standout
Underline
Reverse
Blink
Dim
Invisible
Protected
Foreground Color
Background Color
Else ScopedEffect ScopedEffect
Nop

Instances

Eq ScopedEffect Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods (==) :: ScopedEffect -> ScopedEffect -> Bool # (/=) :: ScopedEffect -> ScopedEffect -> Bool #

with :: ScopedEffect -> TermDoc -> TermDoc Source #

data Effect Source #

Constructors

Push ScopedEffect
Pop
Ring Bell

Instances

Eq Effect Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods (==) :: Effect -> Effect -> Bool # (/=) :: Effect -> Effect -> Bool #

Graceful degradation

soft :: ScopedEffect -> ScopedEffect Source #

Effects (built with soft)

blink :: TermDoc -> TermDoc Source #

bold :: TermDoc -> TermDoc Source #

underline :: TermDoc -> TermDoc Source #

standout :: TermDoc -> TermDoc Source #

reversed :: TermDoc -> TermDoc Source #

protected :: TermDoc -> TermDoc Source #

invisible :: TermDoc -> TermDoc Source #

dim :: TermDoc -> TermDoc Source #

Colors (built with soft)

red :: TermDoc -> TermDoc Source #

black :: TermDoc -> TermDoc Source #

green :: TermDoc -> TermDoc Source #

blue :: TermDoc -> TermDoc Source #

yellow :: TermDoc -> TermDoc Source #

magenta :: TermDoc -> TermDoc Source #

cyan :: TermDoc -> TermDoc Source #

white :: TermDoc -> TermDoc Source #

foreground :: Color -> TermDoc -> TermDoc Source #

background :: Color -> TermDoc -> TermDoc Source #

Ringing bells

data Bell Source #

Constructors

VisibleBellOnly
AudibleBellOnly
VisibleBellPreferred
AudibleBellPreferred

Instances

Enum Bell Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods succ :: Bell -> Bell # pred :: Bell -> Bell # toEnum :: Int -> Bell # fromEnum :: Bell -> Int # enumFrom :: Bell -> [Bell] # enumFromThen :: Bell -> Bell -> [Bell] # enumFromTo :: Bell -> Bell -> [Bell] # enumFromThenTo :: Bell -> Bell -> Bell -> [Bell] #
Eq Bell Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods (==) :: Bell -> Bell -> Bool # (/=) :: Bell -> Bell -> Bool #
Ord Bell Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods compare :: Bell -> Bell -> Ordering # (<) :: Bell -> Bell -> Bool # (<=) :: Bell -> Bell -> Bool # (>) :: Bell -> Bell -> Bool # (>=) :: Bell -> Bell -> Bool # max :: Bell -> Bell -> Bell # min :: Bell -> Bell -> Bell #
Show Bell Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods showsPrec :: Int -> Bell -> ShowS # show :: Bell -> String # showList :: [Bell] -> ShowS #

ring :: Bell -> TermDoc Source #

A Color Pretty Printer

type TermDoc = Doc Effect Source #

display :: (MonadIO m, PrettyTerm t) => t -> m () Source #

displayLn :: MonadIO m => PrettyTerm t => t -> m () Source #

Progressively less magical formatting

displayDoc :: (MonadIO m, PrettyTerm t) => Float -> t -> m () Source #

displayDoc' :: (MonadIO m, PrettyTerm t) => Terminal -> Float -> t -> m () Source #

displayDoc'' :: (MonadIO m, PrettyTerm t) => Terminal -> Float -> Int -> t -> m () Source #

A Classy Interface

class Pretty t => PrettyTerm t where Source #

Methods

prettyTerm :: t -> TermDoc Source #

prettyTermList :: [t] -> TermDoc Source #

Instances

PrettyTerm Bool Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Bool -> TermDoc Source # prettyTermList :: [Bool] -> TermDoc Source #
PrettyTerm Char Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Char -> TermDoc Source # prettyTermList :: [Char] -> TermDoc Source #
PrettyTerm Double Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Double -> TermDoc Source # prettyTermList :: [Double] -> TermDoc Source #
PrettyTerm Float Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Float -> TermDoc Source # prettyTermList :: [Float] -> TermDoc Source #
PrettyTerm Int Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Int -> TermDoc Source # prettyTermList :: [Int] -> TermDoc Source #
PrettyTerm Int8 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Int8 -> TermDoc Source # prettyTermList :: [Int8] -> TermDoc Source #
PrettyTerm Int16 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Int16 -> TermDoc Source # prettyTermList :: [Int16] -> TermDoc Source #
PrettyTerm Int32 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Int32 -> TermDoc Source # prettyTermList :: [Int32] -> TermDoc Source #
PrettyTerm Int64 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Int64 -> TermDoc Source # prettyTermList :: [Int64] -> TermDoc Source #
PrettyTerm Integer Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Integer -> TermDoc Source # prettyTermList :: [Integer] -> TermDoc Source #
PrettyTerm Natural Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Natural -> TermDoc Source # prettyTermList :: [Natural] -> TermDoc Source #
PrettyTerm Word Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Word -> TermDoc Source # prettyTermList :: [Word] -> TermDoc Source #
PrettyTerm Word8 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Word8 -> TermDoc Source # prettyTermList :: [Word8] -> TermDoc Source #
PrettyTerm Word16 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Word16 -> TermDoc Source # prettyTermList :: [Word16] -> TermDoc Source #
PrettyTerm Word32 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Word32 -> TermDoc Source # prettyTermList :: [Word32] -> TermDoc Source #
PrettyTerm Word64 Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Word64 -> TermDoc Source # prettyTermList :: [Word64] -> TermDoc Source #
PrettyTerm () Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: () -> TermDoc Source # prettyTermList :: [()] -> TermDoc Source #
PrettyTerm ByteString Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: ByteString -> TermDoc Source # prettyTermList :: [ByteString] -> TermDoc Source #
PrettyTerm ByteString Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: ByteString -> TermDoc Source # prettyTermList :: [ByteString] -> TermDoc Source #
PrettyTerm Text Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Text -> TermDoc Source # prettyTermList :: [Text] -> TermDoc Source #
PrettyTerm Text Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Text -> TermDoc Source # prettyTermList :: [Text] -> TermDoc Source #
PrettyTerm t => PrettyTerm [t] Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: [t] -> TermDoc Source # prettyTermList :: [[t]] -> TermDoc Source #
PrettyTerm a => PrettyTerm (Maybe a) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Maybe a -> TermDoc Source # prettyTermList :: [Maybe a] -> TermDoc Source #
PrettyTerm a => PrettyTerm (NonEmpty a) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: NonEmpty a -> TermDoc Source # prettyTermList :: [NonEmpty a] -> TermDoc Source #
PrettyTerm a => PrettyTerm (Seq a) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Seq a -> TermDoc Source # prettyTermList :: [Seq a] -> TermDoc Source #
e ~ Effect => PrettyTerm (Doc e) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: Doc e -> TermDoc Source # prettyTermList :: [Doc e] -> TermDoc Source #
(PrettyTerm a, PrettyTerm b) => PrettyTerm (a, b) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: (a, b) -> TermDoc Source # prettyTermList :: [(a, b)] -> TermDoc Source #
(PrettyTerm a, PrettyTerm b, PrettyTerm c) => PrettyTerm (a, b, c) Source #
Instance details Defined in System.Console.Terminfo.PrettyPrint Methods prettyTerm :: (a, b, c) -> TermDoc Source # prettyTermList :: [(a, b, c)] -> TermDoc Source #

Evaluation

type SimpleTermDoc = SimpleDoc Effect Source #

evalTermState :: Monad m => StateT TermState m a -> m a Source #

displayCap :: SimpleTermDoc -> StateT TermState Capability TermOutput Source #