BNFC.PrettyPrint

Extends 'PrettyPrint'.

Documentation

module Text.PrettyPrint

class Pretty a where

Overloaded function pretty.

Minimal complete definition

pretty | prettyPrec

Methods

pretty :: a -> Doc

prettyPrec :: Int -> a -> Doc

Instances

Pretty String

Defined in BNFC.PrettyPrint

Methods

pretty :: String -> Doc

prettyPrec :: Int -> String -> Doc

Pretty Int

Defined in BNFC.PrettyPrint

Methods

pretty :: Int -> Doc

prettyPrec :: Int -> Int -> Doc

Pretty Integer

Defined in BNFC.PrettyPrint

Methods

pretty :: Integer -> Doc

prettyPrec :: Int -> Integer -> Doc

Pretty Cat

Defined in BNFC.CF

Methods

pretty :: Cat -> Doc

prettyPrec :: Int -> Cat -> Doc

Pretty a => Pretty (WithPosition a)

Defined in BNFC.CF

Methods

pretty :: WithPosition a -> Doc

prettyPrec :: Int -> WithPosition a -> Doc

(IsFun f, Pretty f) => Pretty (Exp' f)

Defined in BNFC.CF

Methods

pretty :: Exp' f -> Doc

prettyPrec :: Int -> Exp' f -> Doc

Pretty function => Pretty (Rul function)

Defined in BNFC.CF

Methods

pretty :: Rul function -> Doc

prettyPrec :: Int -> Rul function -> Doc

prettyShow :: Pretty a => a -> String

Render as String.

parensIf :: Bool -> Doc -> Doc

Put parens around document if given condition is true.

>>> parensIf True "foo"
(foo)

>>> parensIf False "bar"
bar

($++$) :: Doc -> Doc -> Doc

Separate vertically by a blank line.

>>> "foo" $++$ "bar"
foo

bar

>>> "foo" $++$ empty
foo

vsep :: [Doc] -> Doc

List version of $++$.

>>> vsep [ "foo", nest 4 "bar" ]
foo

    bar

>>> vsep []

vcat' :: [Doc] -> Doc

List version of $+$.

>>> vcat' [text "abc", nest 4 (text "def")]
abc
    def

(<=>) :: Doc -> Doc -> Doc

Pretty print separator with = (for assignments...).

>>> "a" <=> "123"
a = 123

prettyList

Arguments

:: Int

Indentation.

-> Doc

Preamble.

-> Doc

Left parenthesis.

-> Doc

Right parenthesis.

-> Doc

Separator (usually not including spaces).

-> [Doc]

List item.

-> Doc

Print a list of 0-1 elements on the same line as some preamble and from 2 elements on the following lines, indented.

>>> prettyList 2 ("foo" <+> equals) lbrack rbrack comma []
foo = []
>>> prettyList 2 ("foo" <+> equals) lbrack rbrack comma [ "a" ]
foo = [a]
>>> prettyList 2 ("foo" <+> equals) lbrack rbrack comma [ "a", "b" ]
foo =
  [ a
  , b
  ]

Used in the Agda backend.

codeblock :: Int -> [Doc] -> Doc

Code block. A block of C/Java code, surrounded by {} and indented.

>>> codeblock 4 ["abc", "def"]
{
    abc
    def
}

Used in the C backend.