haskell-src-1.0.1.6: Support for manipulating Haskell source code

Portability	portable
Stability	experimental
Maintainer	libraries@haskell.org
Safe Haskell	None

Language.Haskell.Pretty

Contents

Pretty printing
Pretty-printing styles (from Text.PrettyPrint.HughesPJ)
Haskell formatting modes

Description

Pretty printer for Haskell.

Synopsis

Pretty printing

class Pretty a Source

Things that can be pretty-printed, including all the syntactic objects in Language.Haskell.Syntax.

prettyPrintStyleMode :: Pretty a => Style -> PPHsMode -> a -> String Source

pretty-print with a given style and mode.

prettyPrintWithMode :: Pretty a => PPHsMode -> a -> String Source

pretty-print with the default style and a given mode.

prettyPrint :: Pretty a => a -> String Source

pretty-print with the default style and defaultMode.

Pretty-printing styles (from Text.PrettyPrint.HughesPJ)

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

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

data Mode

Rendering mode.

Constructors

PageMode	Normal
ZigZagMode	With zig-zag cuts
LeftMode	No indentation, infinitely long lines
OneLineMode	All on one line

Haskell formatting modes

data PPHsMode Source

Pretty-printing parameters.

Note: the onsideIndent must be positive and less than all other indents.

Constructors

Fields

classIndent :: Indent: indentation of a class or instance
doIndent :: Indent: indentation of a do-expression
caseIndent :: Indent: indentation of the body of a case expression
letIndent :: Indent: indentation of the declarations in a let expression
whereIndent :: Indent: indentation of the declarations in a where clause
onsideIndent :: Indent: indentation added for continuation lines that would otherwise be offside
spacing :: Bool: blank lines between statements?
layout :: PPLayout: Pretty-printing style to use
linePragmas :: Bool: add GHC-style LINE pragmas to output?
comments :: Bool: not implemented yet

type Indent = Int Source

data PPLayout Source

Varieties of layout we can use.

Constructors

PPOffsideRule	classical layout
PPSemiColon	classical layout made explicit
PPInLine	inline decls, with newlines between them
PPNoLayout	everything on a single line

Instances

defaultMode :: PPHsMode Source

The default mode: pretty-print using the offside rule and sensible defaults.