prettyprinter-compat-ansi-wl-pprint-1.0.2: Drop-in compatibility package to migrate from »ansi-wl-pprint« to »prettyprinter«.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.PrettyPrint.ANSI.Leijen

Description

Deprecated: Compatibility module for users of ansi-wl-pprint - use Prettyprinter instead

Synopsis

Documentation

type Doc = Doc AnsiStyle Source #

putDoc :: Doc -> IO () Source #

hPutDoc :: Handle -> Doc -> IO () Source #

empty :: Doc Source #

char :: Char -> Doc Source #

text :: String -> Doc Source #

(<>) :: Semigroup a => a -> a -> a infixr 6 #

An associative operation.

>>> [1,2,3] <> [4,5,6]
[1,2,3,4,5,6]

nest :: Int -> Doc -> Doc Source #

line :: Doc Source #

linebreak :: Doc Source #

group :: Doc -> Doc Source #

softline :: Doc Source #

softbreak :: Doc Source #

hardline :: Doc Source #

flatAlt :: Doc -> Doc -> Doc Source #

renderSmart :: Float -> Int -> Doc -> SimpleDoc Source #

align :: Doc -> Doc Source #

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

indent :: Int -> Doc -> Doc Source #

encloseSep :: Doc -> Doc -> Doc -> [Doc] -> Doc Source #

list :: [Doc] -> Doc Source #

tupled :: [Doc] -> Doc Source #

semiBraces :: [Doc] -> Doc Source #

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

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

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

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

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

hsep :: [Doc] -> Doc Source #

vsep :: [Doc] -> Doc Source #

fillSep :: [Doc] -> Doc Source #

sep :: [Doc] -> Doc Source #

hcat :: [Doc] -> Doc Source #

vcat :: [Doc] -> Doc Source #

fillCat :: [Doc] -> Doc Source #

cat :: [Doc] -> Doc Source #

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

fill :: Int -> Doc -> Doc Source #

fillBreak :: Int -> Doc -> Doc Source #

enclose :: Doc -> Doc -> Doc -> Doc Source #

squotes :: Doc -> Doc Source #

dquotes :: Doc -> Doc Source #

parens :: Doc -> Doc Source #

angles :: Doc -> Doc Source #

braces :: Doc -> Doc Source #

brackets :: Doc -> Doc Source #

lparen :: Doc Source #

rparen :: Doc Source #

langle :: Doc Source #

rangle :: Doc Source #

lbrace :: Doc Source #

rbrace :: Doc Source #

lbracket :: Doc Source #

rbracket :: Doc Source #

squote :: Doc Source #

dquote :: Doc Source #

semi :: Doc Source #

colon :: Doc Source #

comma :: Doc Source #

space :: Doc Source #

dot :: Doc Source #

backslash :: Doc Source #

equals :: Doc Source #

black :: Doc -> Doc Source #

red :: Doc -> Doc Source #

green :: Doc -> Doc Source #

yellow :: Doc -> Doc Source #

blue :: Doc -> Doc Source #

magenta :: Doc -> Doc Source #

cyan :: Doc -> Doc Source #

white :: Doc -> Doc Source #

dullblack :: Doc -> Doc Source #

dullred :: Doc -> Doc Source #

dullgreen :: Doc -> Doc Source #

dullyellow :: Doc -> Doc Source #

dullblue :: Doc -> Doc Source #

dullmagenta :: Doc -> Doc Source #

dullcyan :: Doc -> Doc Source #

dullwhite :: Doc -> Doc Source #

onblack :: Doc -> Doc Source #

onred :: Doc -> Doc Source #

ongreen :: Doc -> Doc Source #

onyellow :: Doc -> Doc Source #

onblue :: Doc -> Doc Source #

onmagenta :: Doc -> Doc Source #

oncyan :: Doc -> Doc Source #

onwhite :: Doc -> Doc Source #

ondullblack :: Doc -> Doc Source #

ondullred :: Doc -> Doc Source #

ondullgreen :: Doc -> Doc Source #

ondullyellow :: Doc -> Doc Source #

ondullblue :: Doc -> Doc Source #

ondullmagenta :: Doc -> Doc Source #

ondullcyan :: Doc -> Doc Source #

ondullwhite :: Doc -> Doc Source #

bold :: Doc -> Doc Source #

debold :: Doc -> Doc Source #

underline :: Doc -> Doc Source #

deunderline :: Doc -> Doc Source #

plain :: Doc -> Doc Source #

string :: String -> Doc Source #

int :: Int -> Doc Source #

integer :: Integer -> Doc Source #

float :: Float -> Doc Source #

double :: Double -> Doc Source #

rational :: Rational -> Doc Source #

class Pretty a where #

Overloaded conversion to Doc.

Laws:

  1. output should be pretty. :-)

Minimal complete definition

pretty

Methods

pretty :: a -> Doc ann #

>>> pretty 1 <+> pretty "hello" <+> pretty 1.234
1 hello 1.234

prettyList :: [a] -> Doc ann #

prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

>>> prettyList [1, 23, 456]
[1, 23, 456]

Instances

Instances details
Pretty Bool
>>> pretty True
True
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Bool -> Doc ann #

prettyList :: [Bool] -> Doc ann #

Pretty Char

Instead of (pretty 'n'), consider using line as a more readable alternative.

>>> pretty 'f' <> pretty 'o' <> pretty 'o'
foo
>>> pretty ("string" :: String)
string
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Char -> Doc ann #

prettyList :: [Char] -> Doc ann #

Pretty Double
>>> pretty (exp 1 :: Double)
2.71828182845904...
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Double -> Doc ann #

prettyList :: [Double] -> Doc ann #

Pretty Float
>>> pretty (pi :: Float)
3.1415927
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Float -> Doc ann #

prettyList :: [Float] -> Doc ann #

Pretty Int
>>> pretty (123 :: Int)
123
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Int -> Doc ann #

prettyList :: [Int] -> Doc ann #

Pretty Int8 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Int8 -> Doc ann #

prettyList :: [Int8] -> Doc ann #

Pretty Int16 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Int16 -> Doc ann #

prettyList :: [Int16] -> Doc ann #

Pretty Int32 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Int32 -> Doc ann #

prettyList :: [Int32] -> Doc ann #

Pretty Int64 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Int64 -> Doc ann #

prettyList :: [Int64] -> Doc ann #

Pretty Integer
>>> pretty (2^123 :: Integer)
10633823966279326983230456482242756608
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Integer -> Doc ann #

prettyList :: [Integer] -> Doc ann #

Pretty Natural 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Natural -> Doc ann #

prettyList :: [Natural] -> Doc ann #

Pretty Word 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Word -> Doc ann #

prettyList :: [Word] -> Doc ann #

Pretty Word8 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Word8 -> Doc ann #

prettyList :: [Word8] -> Doc ann #

Pretty Word16 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Word16 -> Doc ann #

prettyList :: [Word16] -> Doc ann #

Pretty Word32 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Word32 -> Doc ann #

prettyList :: [Word32] -> Doc ann #

Pretty Word64 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Word64 -> Doc ann #

prettyList :: [Word64] -> Doc ann #

Pretty ()
>>> pretty ()
()

The argument is not used:

>>> pretty (error "Strict?" :: ())
()
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: () -> Doc ann #

prettyList :: [()] -> Doc ann #

Pretty Void

Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing.

>>> pretty ([] :: [Void])
[]
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Void -> Doc ann #

prettyList :: [Void] -> Doc ann #

Pretty Text

(lazy Text instance, identical to the strict version)

Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann #

prettyList :: [Text] -> Doc ann #

Pretty Text

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)
hello
world

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))
hello world

Manually use hardline if you definitely want newlines.

Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann #

prettyList :: [Text] -> Doc ann #

Pretty a => Pretty [a]
>>> pretty [1,2,3]
[1, 2, 3]
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: [a] -> Doc ann #

prettyList :: [[a]] -> Doc ann #

Pretty a => Pretty (Maybe a)

Ignore Nothings, print Just contents.

>>> pretty (Just True)
True
>>> braces (pretty (Nothing :: Maybe Bool))
{}

>>> pretty [Just 1, Nothing, Just 3, Nothing]
[1, 3]
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Maybe a -> Doc ann #

prettyList :: [Maybe a] -> Doc ann #

Pretty a => Pretty (Identity a)
>>> pretty (Identity 1)
1
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Identity a -> Doc ann #

prettyList :: [Identity a] -> Doc ann #

Pretty a => Pretty (NonEmpty a) 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: NonEmpty a -> Doc ann #

prettyList :: [NonEmpty a] -> Doc ann #

(Pretty a1, Pretty a2) => Pretty (a1, a2)
>>> pretty (123, "hello")
(123, hello)
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2) -> Doc ann #

prettyList :: [(a1, a2)] -> Doc ann #

(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)
>>> pretty (123, "hello", False)
(123, hello, False)
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2, a3) -> Doc ann #

prettyList :: [(a1, a2, a3)] -> Doc ann #

Pretty a => Pretty (Const a b) 
Instance details

Defined in Prettyprinter.Internal

Methods

pretty :: Const a b -> Doc ann #

prettyList :: [Const a b] -> Doc ann #

type SimpleDoc = SimpleDocStream AnsiStyle Source #

renderPretty :: Float -> Int -> Doc -> SimpleDoc Source #

renderCompact :: Doc -> SimpleDoc Source #

displayS :: SimpleDoc -> ShowS Source #

displayIO :: Handle -> SimpleDoc -> IO () Source #

bool :: Bool -> Doc Source #

column :: (Int -> Doc) -> Doc Source #

columns :: (Maybe Int -> Doc) -> Doc Source #

nesting :: (Int -> Doc) -> Doc Source #

width :: Doc -> (Int -> Doc) -> Doc Source #