Moduleprettyprinter-1.7.2Haskell2010

Prettyprinter.Render.Text

Render an unannotated SimpleDocStream as plain Text.

Contents

Conversion to plain Text
Render to a Handle
Convenience functions

Synopsis

value renderLazy
value renderStrict
value renderIO
value putDoc
value hPutDoc

Packageprettyprinter-1.7.2
Exports5
LanguageHaskell2010
LicenceBSD-2-Clause
SourceText.hs

Conversion to plain Text

valuerenderLazy :: SimpleDocStream ann -> Text

Source#

(renderLazy sdoc) takes the output sdoc from a rendering function and transforms it to lazy text.

Example3 expressions

>>> let render = TL.putStrLn . renderLazy . layoutPretty defaultLayoutOptions>>> let doc = "lorem" <+> align (vsep ["ipsum dolor", parens "foo bar", "sit amet"])>>> render doclorem ipsum dolor      (foo bar)      sit amet

valuerenderStrict :: SimpleDocStream ann -> Text

Source#

(renderStrict sdoc) takes the output sdoc from a rendering function and transforms it to strict text.

Render to a Handle

valuerenderIO :: Handle -> SimpleDocStream ann -> IO ()

Source#

(renderIO h sdoc) writes sdoc to the file h.

Example1 expression

>>> renderIO System.IO.stdout (layoutPretty defaultLayoutOptions "hello\nworld")helloworld

This function is more efficient than hPutStr h (renderStrict sdoc), since it writes to the handle directly, skipping the intermediate Text representation.

Convenience functions

valueputDoc :: Doc ann -> IO ()

Source#

(putDoc doc) prettyprints document doc to standard output. Uses the defaultLayoutOptions.

Example1 expression

>>> putDoc ("hello" <+> "world")hello world

putDoc = hPutDoc stdout

valuehPutDoc :: Handle -> Doc ann -> IO ()

Source#

Like putDoc, but instead of using stdout, print to a user-provided handle, e.g. a file or a socket. Uses the defaultLayoutOptions.

main = withFile filename (h -> hPutDoc h doc)
  where
    doc = vcat ["vertical", "text"]
    filename = "someFile.txt"

hPutDoc h doc = renderIO h (layoutPretty defaultLayoutOptions doc)