Safe Haskell	None
Language	Haskell2010

Text.PrettyPrint.GHCi

Contents

Interactive expression printing
Interactive doc string printing
Formatting options
- Color
- Style

Synopsis

prettyPrintValue :: Bool -> String -> IO ()
value2Doc :: String -> Doc AnsiStyle
data ValuePrintConf = ValuePrintConf {
- vpc_number :: AnsiStyle
- vpc_character :: AnsiStyle
- vpc_string :: AnsiStyle
- vpc_control :: AnsiStyle
- vpc_comma :: AnsiStyle
- vpc_operator :: AnsiStyle
- vpc_field :: AnsiStyle
- vpc_indent :: Int
}
defaultValueConf :: ValuePrintConf
prettyPrintHaddock :: Bool -> String -> IO ()
haddock2Doc :: String -> Doc AnsiStyle
data HaddockPrintConf = HaddockPrintConf {
- hpc_default :: AnsiStyle
- hpc_emphasis :: AnsiStyle
- hpc_bold :: AnsiStyle
- hpc_monospaced :: AnsiStyle
- hpc_header :: AnsiStyle
- hpc_identifier :: AnsiStyle
- hpc_math :: AnsiStyle
- hpc_links :: AnsiStyle
- hpc_warning :: AnsiStyle
- hpc_control :: AnsiStyle
}
defaultHaddockConf :: HaddockPrintConf
data AnsiStyle
color :: Color -> AnsiStyle
colorDull :: Color -> AnsiStyle
bgColor :: Color -> AnsiStyle
bgColorDull :: Color -> AnsiStyle
data Color
- = Black
- | Red
- | Green
- | Yellow
- | Blue
- | Magenta
- | Cyan
- | White
bold :: AnsiStyle
italicized :: AnsiStyle
underlined :: AnsiStyle

Interactive expression printing

prettyPrintValue :: Bool -> String -> IO () Source #

Given a Show-ed value, print that value out to the terminal, add helpful indentation and colours whenever possible. If a structured value cannot be parsed out, this falls back on print.

The Bool is to enable a slower but potentially smarter layout algorithm.

value2Doc :: String -> Doc AnsiStyle Source #

Parse a shown value into a pretty Doc. Can throw an error on outputs that could not be parsed properly, but should not throw errors for inputs which are the outputs of show from derived Show instances.

data ValuePrintConf Source #

Options for how to colour the terminal output

Constructors

ValuePrintConf
Fields vpc_number :: AnsiStyle all sorts of numeric literals vpc_character :: AnsiStyle character literals vpc_string :: AnsiStyle string literals vpc_control :: AnsiStyle various control characters (ex: parens) vpc_comma :: AnsiStyle commas vpc_operator :: AnsiStyle general operators vpc_field :: AnsiStyle field in a record vpc_indent :: Int how many spaces is one indent?

defaultValueConf :: ValuePrintConf Source #

A Good Enough colour scheme

Interactive doc string printing

prettyPrintHaddock :: Bool -> String -> IO () Source #

Given a Haddock-formatted docstring, format and print that docstring to the terminal.

The Bool is to enable a slower but potentially smarter layout algorithm.

haddock2Doc :: String -> Doc AnsiStyle Source #

Parse a docstring into a pretty Doc. Should never throw an exception (since haddock-library will parse something out of any input).

data HaddockPrintConf Source #

Options for how to colour the terminal output

Constructors

HaddockPrintConf

Fields

hpc_default :: AnsiStyle
the default background
hpc_emphasis :: AnsiStyle
emphasized text
hpc_bold :: AnsiStyle
bold text
hpc_monospaced :: AnsiStyle
code blocks and inline code
hpc_header :: AnsiStyle
header bodies
hpc_identifier :: AnsiStyle
identifiers, module links, anchors
hpc_math :: AnsiStyle
\( ... \) and \[ ... \] delimited math
hpc_links :: AnsiStyle
the link part of hyperlinks or images
hpc_warning :: AnsiStyle
warning texts
hpc_control :: AnsiStyle
things like: equals in headers, bullets in lists, etc.

defaultHaddockConf :: HaddockPrintConf Source #

A Good Enough colour scheme

Formatting options

data AnsiStyle #

Instances

Eq AnsiStyle
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods (==) :: AnsiStyle -> AnsiStyle -> Bool # (/=) :: AnsiStyle -> AnsiStyle -> Bool #
Ord AnsiStyle
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods compare :: AnsiStyle -> AnsiStyle -> Ordering # (<) :: AnsiStyle -> AnsiStyle -> Bool # (<=) :: AnsiStyle -> AnsiStyle -> Bool # (>) :: AnsiStyle -> AnsiStyle -> Bool # (>=) :: AnsiStyle -> AnsiStyle -> Bool # max :: AnsiStyle -> AnsiStyle -> AnsiStyle # min :: AnsiStyle -> AnsiStyle -> AnsiStyle #
Show AnsiStyle
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods showsPrec :: Int -> AnsiStyle -> ShowS # show :: AnsiStyle -> String # showList :: [AnsiStyle] -> ShowS #
Semigroup AnsiStyle
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods (<>) :: AnsiStyle -> AnsiStyle -> AnsiStyle # sconcat :: NonEmpty AnsiStyle -> AnsiStyle # stimes :: Integral b => b -> AnsiStyle -> AnsiStyle #
Monoid AnsiStyle
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods mempty :: AnsiStyle # mappend :: AnsiStyle -> AnsiStyle -> AnsiStyle # mconcat :: [AnsiStyle] -> AnsiStyle #

Color

color :: Color -> AnsiStyle #

colorDull :: Color -> AnsiStyle #

bgColor :: Color -> AnsiStyle #

bgColorDull :: Color -> AnsiStyle #

data Color #

Constructors

Black
Red
Green
Yellow
Blue
Magenta
Cyan
White

Instances

Eq Color
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods (==) :: Color -> Color -> Bool # (/=) :: Color -> Color -> Bool #
Ord Color
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal 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
Instance details Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal Methods showsPrec :: Int -> Color -> ShowS # show :: Color -> String # showList :: [Color] -> ShowS #

Style

bold :: AnsiStyle #

italicized :: AnsiStyle #

underlined :: AnsiStyle #