Text.PrettyPrint.Class

Document class allowing to have different interpretations of the HughesPJ pretty-printing combinators.

Documentation

data Doc

The abstract type of documents. The Show instance is equivalent to using render.

Instances

Show Doc

Document Doc

class Document d where

Methods

char :: Char -> d

text :: String -> d

zeroWidthText :: String -> d

emptyDoc :: d

(<>) :: d -> d -> d

(<->) :: d -> d -> d

hcat :: [d] -> d

hsep :: [d] -> d

($$) :: d -> d -> d

($-$) :: d -> d -> d

vcat :: [d] -> d

sep :: [d] -> d

cat :: [d] -> d

fsep :: [d] -> d

fcat :: [d] -> d

nest :: Int -> d -> d

caseEmptyDoc :: d -> d -> d -> d

Instances

Document Doc

(Document d, Applicative f) => Document (f d)

isEmpty :: Doc -> Bool

Returns True if the document is empty

render :: Doc -> String

Renders the document as a string using the default style.

renderStyle :: Style -> Doc -> String

Render the document as a string using a specified style.

style :: Style

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

data Style

A rendering style.

Constructors

Style

Fields

mode :: Mode

The rendering mode

lineLength :: Int

Length of line, in chars

ribbonsPerLine :: Float

Ratio of ribbon length to line length

data Mode

Rendering mode.

Constructors

PageMode

Normal

ZigZagMode

With zig-zag cuts

LeftMode

No indentation, infinitely long lines

OneLineMode

All on one line

($--$) :: Document d => d -> d -> d

Vertical concatentation of two documents with an empty line in between.

semi :: Document d => d

colon :: Document d => d

comma :: Document d => d

space :: Document d => d

equals :: Document d => d

lparen :: Document d => d

rparen :: Document d => d

lbrack :: Document d => d

rbrack :: Document d => d

lbrace :: Document d => d

rbrace :: Document d => d

int :: Document d => Int -> d

integer :: Document d => Integer -> d

float :: Document d => Float -> d

double :: Document d => Double -> d

rational :: Document d => Rational -> d

quotes :: Document d => d -> d

doubleQuotes :: Document d => d -> d

parens :: Document d => d -> d

brackets :: Document d => d -> d

braces :: Document d => d -> d

hang :: Document d => d -> Int -> d -> d

punctuate :: Document d => d -> [d] -> [d]