W3cubDocs

/Haskell 8

Language.Haskell.TH.PprLib

Safe Haskell Safe
Language Haskell2010

Description

Monadic front-end to Text.PrettyPrint

The document type

type Doc = PprM Doc Source

data PprM a Source

Instances
Instances details
Monad PprM
Instance details

Defined in Language.Haskell.TH.PprLib

Methods

(>>=) :: PprM a -> (a -> PprM b) -> PprM b Source

(>>) :: PprM a -> PprM b -> PprM b Source

return :: a -> PprM a Source

Functor PprM
Instance details

Defined in Language.Haskell.TH.PprLib

Methods

fmap :: (a -> b) -> PprM a -> PprM b Source

(<$) :: a -> PprM b -> PprM a Source

Show Doc
Instance details

Defined in Language.Haskell.TH.PprLib

Methods

showsPrec :: Int -> Doc -> ShowS Source

show :: Doc -> String Source

showList :: [Doc] -> ShowS Source

Applicative PprM
Instance details

Defined in Language.Haskell.TH.PprLib

Methods

pure :: a -> PprM a Source

(<*>) :: PprM (a -> b) -> PprM a -> PprM b Source

liftA2 :: (a -> b -> c) -> PprM a -> PprM b -> PprM c Source

(*>) :: PprM a -> PprM b -> PprM b Source

(<*) :: PprM a -> PprM b -> PprM a Source

Primitive Documents

empty :: Doc Source

An empty document

semi :: Doc Source

A ';' character

comma :: Doc Source

A ',' character

colon :: Doc Source

A : character

dcolon :: Doc Source

A "::" string

space :: Doc Source

A space character

equals :: Doc Source

A '=' character

arrow :: Doc Source

A "->" string

lparen :: Doc Source

A '(' character

rparen :: Doc Source

A ')' character

lbrack :: Doc Source

A '[' character

rbrack :: Doc Source

A ']' character

lbrace :: Doc Source

A '{' character

rbrace :: Doc Source

A '}' character

Converting values into documents

text :: String -> Doc Source

char :: Char -> Doc Source

ptext :: String -> Doc Source

int :: Int -> Doc Source

integer :: Integer -> Doc Source

float :: Float -> Doc Source

double :: Double -> Doc Source

rational :: Rational -> Doc Source

Wrapping documents in delimiters

parens :: Doc -> Doc Source

Wrap document in (...)

brackets :: Doc -> Doc Source

Wrap document in [...]

braces :: Doc -> Doc Source

Wrap document in {...}

quotes :: Doc -> Doc Source

Wrap document in '...'

doubleQuotes :: Doc -> Doc Source

Wrap document in "..."

Combining documents

(<>) :: Doc -> Doc -> Doc infixl 6 Source

Beside

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

Beside, separated by space

hcat :: [Doc] -> Doc Source

List version of <>

hsep :: [Doc] -> Doc Source

List version of <+>

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

Above; if there is no overlap it "dovetails" the two

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

Above, without dovetailing.

vcat :: [Doc] -> Doc Source

List version of $$

sep :: [Doc] -> Doc Source

Either hsep or vcat

cat :: [Doc] -> Doc Source

Either hcat or vcat

fsep :: [Doc] -> Doc Source

"Paragraph fill" version of sep

fcat :: [Doc] -> Doc Source

"Paragraph fill" version of cat

nest :: Int -> Doc -> Doc Source

Nested

hang :: Doc -> Int -> Doc -> Doc Source 

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

punctuate Source

Arguments

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

Predicates on documents

isEmpty :: Doc -> PprM Bool Source

Returns True if the document is empty

to_HPJ_Doc :: Doc -> Doc Source

pprName :: Name -> Doc Source

pprName' :: NameIs -> Name -> Doc Source

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/8.8.3/docs/html/libraries/template-haskell-2.15.0.0/Language-Haskell-TH-PprLib.html