Text.PrettyPrint.GHCi

Interactive expression printing

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

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

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

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

A Good Enough colour scheme

Interactive doc string printing

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

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

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

data HaddockPrintConf

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

A Good Enough colour scheme

Formatting options

data AnsiStyle

Render the annotated document in a certain style. Styles not set in the annotation will use the style of the surrounding document, or the terminal’s default if none has been set yet.

style = color Green <> bold
styledDoc = annotate style "hello world"

Instances

Eq AnsiStyle

Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal

Methods

(==) :: AnsiStyle -> AnsiStyle -> Bool

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

Ord AnsiStyle

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

Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal

Methods

showsPrec :: Int -> AnsiStyle -> ShowS

show :: AnsiStyle -> String

showList :: [AnsiStyle] -> ShowS

Semigroup AnsiStyle

Keep the first decision for each of foreground color, background color, boldness, italication, and underlining. If a certain style is not set, the terminal’s default will be used.

Example:

color Red <> color Green

is red because the first color wins, and not bold because (or if) that’s the terminal’s default.

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

mempty does nothing, which is equivalent to inheriting the style of the surrounding doc, or the terminal’s default if no style has been set yet.

Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal

Methods

mempty :: AnsiStyle

mappend :: AnsiStyle -> AnsiStyle -> AnsiStyle

mconcat :: [AnsiStyle] -> AnsiStyle

Color

color :: Color -> AnsiStyle

Style the foreground with a vivid color.

colorDull :: Color -> AnsiStyle

Style the foreground with a dull color.

bgColor :: Color -> AnsiStyle

Style the background with a vivid color.

bgColorDull :: Color -> AnsiStyle

Style the background with a dull color.

data Color

The 8 ANSI terminal colors.

Constructors

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

Instances

Eq Color

Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal

Methods

(==) :: Color -> Color -> Bool

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

Ord Color

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

Defined in Data.Text.Prettyprint.Doc.Render.Terminal.Internal

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Style

bold :: AnsiStyle

Render in bold.

italicized :: AnsiStyle

Render in italics.

underlined :: AnsiStyle

Render underlined.