Text.Pretty.Simple

Output With Color

pShow :: Show a => a -> Text

pPrint :: (MonadIO m, Show a) => a -> m ()

pString :: String -> Text

Output With NO Color

pShowNoColor :: Show a => a -> Text

pPrintNoColor :: (MonadIO m, Show a) => a -> m ()

pStringNoColor :: String -> Text

Output With Output Options

pShowOpt :: Show a => OutputOptions -> a -> Text

pPrintOpt :: (MonadIO m, Show a) => OutputOptions -> a -> m ()

pStringOpt :: OutputOptions -> String -> Text

data OutputOptions

Data-type wrapping up all the options available when rendering the list of Outputs.

Constructors

OutputOptions

Fields

• _indentAmount :: Int

  Number of spaces to use when indenting. It should probably be either 2 or 4.

• _useColor :: UseColor

  Whether or not to use ansi escape sequences to print colors.

Instances

Eq OutputOptions

Methods

(==) :: OutputOptions -> OutputOptions -> Bool

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

Data OutputOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OutputOptions -> c OutputOptions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OutputOptions

toConstr :: OutputOptions -> Constr

dataTypeOf :: OutputOptions -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c OutputOptions)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OutputOptions)

gmapT :: (forall b. Data b => b -> b) -> OutputOptions -> OutputOptions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OutputOptions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OutputOptions -> r

gmapQ :: (forall d. Data d => d -> u) -> OutputOptions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> OutputOptions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> OutputOptions -> m OutputOptions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OutputOptions -> m OutputOptions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OutputOptions -> m OutputOptions

Read OutputOptions

Methods

readsPrec :: Int -> ReadS OutputOptions

readList :: ReadS [OutputOptions]

readPrec :: ReadPrec OutputOptions

readListPrec :: ReadPrec [OutputOptions]

Show OutputOptions

Methods

showsPrec :: Int -> OutputOptions -> ShowS

show :: OutputOptions -> String

showList :: [OutputOptions] -> ShowS

Generic OutputOptions

Associated Types

type Rep OutputOptions :: * -> *

Methods

from :: OutputOptions -> Rep OutputOptions x

to :: Rep OutputOptions x -> OutputOptions

type Rep OutputOptions

type Rep OutputOptions = D1 (MetaData "OutputOptions" "Text.Pretty.Simple.Internal.OutputPrinter" "pretty-simple-1.0.0.6-3vJ7uo3XxpBFwtEo5JjIqV" False) (C1 (MetaCons "OutputOptions" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_indentAmount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_useColor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 UseColor))))

data UseColor

UseColor describes whether or not we want to use color when printing the Output list.

Constructors

NoColor

UseColor

Instances

Eq UseColor

Methods

(==) :: UseColor -> UseColor -> Bool

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

Data UseColor

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UseColor -> c UseColor

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UseColor

toConstr :: UseColor -> Constr

dataTypeOf :: UseColor -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UseColor)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UseColor)

gmapT :: (forall b. Data b => b -> b) -> UseColor -> UseColor

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UseColor -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UseColor -> r

gmapQ :: (forall d. Data d => d -> u) -> UseColor -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UseColor -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UseColor -> m UseColor

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UseColor -> m UseColor

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UseColor -> m UseColor

Read UseColor

Methods

readsPrec :: Int -> ReadS UseColor

readList :: ReadS [UseColor]

readPrec :: ReadPrec UseColor

readListPrec :: ReadPrec [UseColor]

Show UseColor

Methods

showsPrec :: Int -> UseColor -> ShowS

show :: UseColor -> String

showList :: [UseColor] -> ShowS

Generic UseColor

Associated Types

type Rep UseColor :: * -> *

Methods

from :: UseColor -> Rep UseColor x

to :: Rep UseColor x -> UseColor

type Rep UseColor

type Rep UseColor = D1 (MetaData "UseColor" "Text.Pretty.Simple.Internal.OutputPrinter" "pretty-simple-1.0.0.6-3vJ7uo3XxpBFwtEo5JjIqV" False) ((:+:) (C1 (MetaCons "NoColor" PrefixI False) U1) (C1 (MetaCons "UseColor" PrefixI False) U1))

defaultOutputOptions :: OutputOptions

Default values for OutputOptions. _indentAmount defaults to 4, and _useColor defaults to UseColor.

noColorOutputOptions :: OutputOptions

Examples

Simple Haskell datatype:

>>> data Foo a = Foo a String deriving Show

>>> pPrintNoColor $ Foo 3 "hello"
Foo 3 "hello"

Lists:

>>> pPrintNoColor $ [1,2,3]
[ 1
, 2
, 3
]

Slightly more complicated lists:

>>> pPrintNoColor $ [ Foo [ (), () ] "hello" ]
[ Foo
    [ ()
    , ()
    ] "hello"
]

>>> pPrintNoColor $ [ Foo [ "bar", "baz" ] "hello", Foo [] "bye" ]
[ Foo
    [ "bar"
    , "baz"
    ] "hello"
, Foo [] "bye"
]

Record:

>>> :{
data Bar b = Bar
  { barInt :: Int
  , barA :: b
  , barList :: [Foo Double]
  } deriving Show
:}

>>> pPrintNoColor $ Bar 1 [10, 11] [Foo 1.1 "", Foo 2.2 "hello"]
Bar
    { barInt = 1
    , barA =
        [ 10
        , 11
        ]
    , barList =
        [ Foo 1.1 ""
        , Foo 2.2 "hello"
        ]
    }

Newtype:

>>> newtype Baz = Baz { unBaz :: [String] } deriving Show

>>> pPrintNoColor $ Baz ["hello", "bye"]
Baz
    { unBaz =
        [ "hello"
        , "bye"
        ]
    }