Safe Haskell	Safe
Language	Haskell2010

Test.Framework.Pretty

Description

This module defines the Pretty type class. The assert functions from HUnitWrapper use the pretty-printing functionality provided by this type class so as to provide nicely formatted error messages.

Additionally, this module re-exports the standard Haskell pretty-printing module PrettyPrint

Synopsis

class Pretty a where
- pretty :: a -> Doc
- prettyList :: [a] -> Doc
- showPretty :: a -> String
(<=>) :: Doc -> Doc -> Doc
data Mode
- = PageMode
- | ZigZagMode
- | LeftMode
- | OneLineMode
data Style = Style {
- mode :: Mode
- lineLength :: Int
- ribbonsPerLine :: Float
}
style :: Style
fullRender :: Mode -> Int -> Float -> (TextDetails -> a -> a) -> a -> Doc -> a
renderStyle :: Style -> Doc -> String
render :: Doc -> String
fsep :: [Doc] -> Doc
fcat :: [Doc] -> Doc
cat :: [Doc] -> Doc
sep :: [Doc] -> Doc
(<+>) :: Doc -> Doc -> Doc
($+$) :: Doc -> Doc -> Doc
($$) :: Doc -> Doc -> Doc
punctuate :: Doc -> [Doc] -> [Doc]
hang :: Doc -> Int -> Doc -> Doc
nest :: Int -> Doc -> Doc
vcat :: [Doc] -> Doc
hsep :: [Doc] -> Doc
hcat :: [Doc] -> Doc
braces :: Doc -> Doc
brackets :: Doc -> Doc
parens :: Doc -> Doc
doubleQuotes :: Doc -> Doc
quotes :: Doc -> Doc
rational :: Rational -> Doc
double :: Double -> Doc
float :: Float -> Doc
integer :: Integer -> Doc
int :: Int -> Doc
rbrace :: Doc
lbrace :: Doc
rbrack :: Doc
lbrack :: Doc
rparen :: Doc
lparen :: Doc
equals :: Doc
space :: Doc
colon :: Doc
comma :: Doc
semi :: Doc
isEmpty :: Doc -> Bool
empty :: Doc
zeroWidthText :: String -> Doc
sizedText :: Int -> String -> Doc
ptext :: String -> Doc
text :: String -> Doc
char :: Char -> Doc
data Doc
data TextDetails
- = Chr !Char
- | Str String
- | PStr String

Documentation

class Pretty a where Source #

A type class for pretty-printable things. Minimal complete definition: pretty.

Minimal complete definition

pretty

Methods

pretty :: a -> Doc Source #

Pretty-print a single value.

prettyList :: [a] -> Doc Source #

Pretty-print a list of things.

showPretty :: a -> String Source #

Pretty-print a single value as a String.

Instances

Pretty Bool Source #
Instance details Defined in Test.Framework.Pretty Methods pretty :: Bool -> Doc Source # prettyList :: [Bool] -> Doc Source # showPretty :: Bool -> String Source #
Pretty Char Source #
Instance details Defined in Test.Framework.Pretty Methods pretty :: Char -> Doc Source # prettyList :: [Char] -> Doc Source # showPretty :: Char -> String Source #
Pretty Int Source #
Instance details Defined in Test.Framework.Pretty Methods pretty :: Int -> Doc Source # prettyList :: [Int] -> Doc Source # showPretty :: Int -> String Source #
Pretty a => Pretty [a] Source #
Instance details Defined in Test.Framework.Pretty Methods pretty :: [a] -> Doc Source # prettyList :: [[a]] -> Doc Source # showPretty :: [a] -> String Source #

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

Utility function for inserting a = between two Doc values.

data Mode #

Rendering mode.

Constructors

PageMode	Normal rendering (`lineLength` and `ribbonsPerLine` respected').
ZigZagMode	With zig-zag cuts.
LeftMode	No indentation, infinitely long lines (`lineLength` ignored), but explicit new lines, i.e., `text "one" $$ text "two"`, are respected.
OneLineMode	All on one line, `lineLength` ignored and explicit new lines (`$$`) are turned into spaces.

Instances

Eq Mode
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods (==) :: Mode -> Mode -> Bool # (/=) :: Mode -> Mode -> Bool #
Show Mode
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
Generic Mode
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Associated Types type Rep Mode :: Type -> Type # Methods from :: Mode -> Rep Mode x # to :: Rep Mode x -> Mode #
type Rep Mode
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ type Rep Mode = D1 (MetaData "Mode" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" False) ((C1 (MetaCons "PageMode" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ZigZagMode" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "LeftMode" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "OneLineMode" PrefixI False) (U1 :: Type -> Type)))

data Style #

A rendering style. Allows us to specify constraints to choose among the many different rendering options.

Constructors

Style

Fields

mode :: Mode
The rendering mode.
lineLength :: Int
Maximum length of a line, in characters.
ribbonsPerLine :: Float
Ratio of line length to ribbon length. A ribbon refers to the characters on a line excluding indentation. So a lineLength of 100, with a ribbonsPerLine of 2.0 would only allow up to 50 characters of ribbon to be displayed on a line, while allowing it to be indented up to 50 characters.

Instances

Eq Style
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods (==) :: Style -> Style -> Bool # (/=) :: Style -> Style -> Bool #
Show Style
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods showsPrec :: Int -> Style -> ShowS # show :: Style -> String # showList :: [Style] -> ShowS #
Generic Style
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Associated Types type Rep Style :: Type -> Type # Methods from :: Style -> Rep Style x # to :: Rep Style x -> Style #
type Rep Style
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ type Rep Style = D1 (MetaData "Style" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" False) (C1 (MetaCons "Style" PrefixI True) (S1 (MetaSel (Just "mode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Mode) :: (S1 (MetaSel (Just "lineLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "ribbonsPerLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Float))))

style :: Style #

The default style (mode=PageMode, lineLength=100, ribbonsPerLine=1.5).

fullRender #

Arguments

:: Mode	Rendering mode.
-> Int	Line length.
-> Float	Ribbons per line.
-> (TextDetails -> a -> a)	What to do with text.
-> a	What to do at the end.
-> Doc	The document.
-> a	Result.

The general rendering interface. Please refer to the Style and Mode types for a description of rendering mode, line length and ribbons.

renderStyle :: Style -> Doc -> String #

Render the Doc to a String using the given Style.

render :: Doc -> String #

Render the Doc to a String using the default Style (see style).

fsep :: [Doc] -> Doc #

"Paragraph fill" version of sep.

fcat :: [Doc] -> Doc #

"Paragraph fill" version of cat.

cat :: [Doc] -> Doc #

Either hcat or vcat.

sep :: [Doc] -> Doc #

Either hsep or vcat.

(<+>) :: Doc -> Doc -> Doc infixl 6 #

Beside, separated by space, unless one of the arguments is empty. <+> is associative, with identity empty.

($+$) :: Doc -> Doc -> Doc infixl 5 #

Above, with no overlapping. $+$ is associative, with identity empty.

($$) :: Doc -> Doc -> Doc infixl 5 #

Above, except that if the last line of the first argument stops at least one position before the first line of the second begins, these two lines are overlapped. For example:

   text "hi" $$ nest 5 (text "there")

lays out as

   hi   there

rather than

   hi
        there

$$ is associative, with identity empty, and also satisfies

(x $$ y) <> z = x $$ (y <> z), if y non-empty.

punctuate :: Doc -> [Doc] -> [Doc] #

punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]

hang :: Doc -> Int -> Doc -> Doc #

hang d1 n d2 = sep [d1, nest n d2]

nest :: Int -> Doc -> Doc #

Nest (or indent) a document by a given number of positions (which may also be negative). nest satisfies the laws:

```
nest 0 x = x
```
```
nest k (nest k' x) = nest (k+k') x
```
```
nest k (x <> y) = nest k x <> nest k y
```
```
nest k (x $$ y) = nest k x $$ nest k y
```
```
nest k empty = empty
```
x <> nest k y = x <> y, if x non-empty

The side condition on the last law is needed because empty is a left identity for <>.

vcat :: [Doc] -> Doc #

List version of $$.

hsep :: [Doc] -> Doc #

List version of <+>.

hcat :: [Doc] -> Doc #

List version of <>.

braces #

Arguments

:: Doc
-> Doc	Wrap document in `{...}`

brackets #

Arguments

:: Doc
-> Doc	Wrap document in `[...]`

parens #

Arguments

:: Doc
-> Doc	Wrap document in `(...)`

doubleQuotes #

Arguments

:: Doc
-> Doc	Wrap document in `"..."`

quotes #

Arguments

:: Doc
-> Doc	Wrap document in `'...'`

rational #

Arguments

:: Rational
-> Doc	rational n = text (show n)

double #

Arguments

:: Double
-> Doc	double n = text (show n)

float #

Arguments

:: Float
-> Doc	float n = text (show n)

integer #

Arguments

:: Integer
-> Doc	integer n = text (show n)

int #

Arguments

:: Int
-> Doc	int n = text (show n)

rbrace #

Arguments

:: Doc

A '}' character

lbrace #

Arguments

:: Doc

A '{' character

rbrack #

Arguments

:: Doc

A ']' character

lbrack #

Arguments

:: Doc

A '[' character

rparen #

Arguments

:: Doc

A ')' character

lparen #

Arguments

:: Doc

A '(' character

equals #

Arguments

:: Doc

A '=' character

space #

Arguments

:: Doc

A space character

colon #

Arguments

:: Doc

A : character

comma #

Arguments

:: Doc

A ',' character

semi #

Arguments

:: Doc

A ';' character

isEmpty :: Doc -> Bool #

Returns True if the document is empty

empty :: Doc #

The empty document, with no height and no width. empty is the identity for <>, <+>, $$ and $+$ , and anywhere in the argument list for sep, hcat, hsep, vcat, fcat etc.

zeroWidthText :: String -> Doc #

Some text, but without any width. Use for non-printing text such as a HTML or Latex tags

sizedText :: Int -> String -> Doc #

Some text with any width. (text s = sizedText (length s) s)

ptext :: String -> Doc #

Same as text. Used to be used for Bytestrings.

text :: String -> Doc #

A document of height 1 containing a literal string. text satisfies the following laws:

```
text s <> text t = text (s++t)
```
text "" <> x = x, if x non-empty

The side condition on the last law is necessary because text "" has height 1, while empty has no height.

char :: Char -> Doc #

A document of height and width 1, containing a literal character.

data Doc #

The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.

Instances

Eq Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods (==) :: Doc -> Doc -> Bool # (/=) :: Doc -> Doc -> Bool #
Show Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods showsPrec :: Int -> Doc -> ShowS # show :: Doc -> String # showList :: [Doc] -> ShowS #
IsString Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods fromString :: String -> Doc #
Generic Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Associated Types type Rep Doc :: Type -> Type # Methods from :: Doc -> Rep Doc x # to :: Rep Doc x -> Doc #
Semigroup Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods (<>) :: Doc -> Doc -> Doc # sconcat :: NonEmpty Doc -> Doc # stimes :: Integral b => b -> Doc -> Doc #
Monoid Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods mempty :: Doc # mappend :: Doc -> Doc -> Doc # mconcat :: [Doc] -> Doc #
NFData Doc
Instance details Defined in Text.PrettyPrint.HughesPJ Methods rnf :: Doc -> () #
type Rep Doc
Instance details Defined in Text.PrettyPrint.HughesPJ type Rep Doc = D1 (MetaData "Doc" "Text.PrettyPrint.HughesPJ" "pretty-1.1.3.6" True) (C1 (MetaCons "Doc" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Doc ()))))

data TextDetails #

A TextDetails represents a fragment of text that will be output at some point in a Doc.

Constructors

Chr !Char	A single Char fragment
Str String	A whole String fragment
PStr String	Used to represent a Fast String fragment but now deprecated and identical to the Str constructor.

Instances

Eq TextDetails
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods (==) :: TextDetails -> TextDetails -> Bool # (/=) :: TextDetails -> TextDetails -> Bool #
Show TextDetails
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods showsPrec :: Int -> TextDetails -> ShowS # show :: TextDetails -> String # showList :: [TextDetails] -> ShowS #
Generic TextDetails
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Associated Types type Rep TextDetails :: Type -> Type # Methods from :: TextDetails -> Rep TextDetails x # to :: Rep TextDetails x -> TextDetails #
NFData TextDetails
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ Methods rnf :: TextDetails -> () #
type Rep TextDetails
Instance details Defined in Text.PrettyPrint.Annotated.HughesPJ type Rep TextDetails = D1 (MetaData "TextDetails" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" False) (C1 (MetaCons "Chr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) SourceUnpack SourceStrict DecidedUnpack) (Rec0 Char)) :+: (C1 (MetaCons "Str" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "PStr" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))