| Copyright | (c) Niklas Broberg 2004-2009, (c) The GHC Team, Noel Winstanley 1997-2000 |
|---|---|
| License | BSD-style (see the file LICENSE.txt) |
| Maintainer | Niklas Broberg, d00nibro@chalmers.se |
| Stability | stable |
| Portability | portable |
| Safe Haskell | Safe |
| Language | Haskell98 |
Language.Haskell.Exts.Pretty
Contents
Description
Pretty printer for Haskell with extensions.
- class Pretty a
- prettyPrintStyleMode :: Pretty a => Style -> PPHsMode -> a -> String
- prettyPrintWithMode :: Pretty a => PPHsMode -> a -> String
- prettyPrint :: Pretty a => a -> String
- data Style :: * = Style {
- mode :: Mode
- lineLength :: Int
- ribbonsPerLine :: Float
- style :: Style
- data Mode :: *
- data PPHsMode = PPHsMode {
- classIndent :: Indent
- doIndent :: Indent
- multiIfIndent :: Indent
- caseIndent :: Indent
- letIndent :: Indent
- whereIndent :: Indent
- onsideIndent :: Indent
- spacing :: Bool
- layout :: PPLayout
- linePragmas :: Bool
- type Indent = Int
- data PPLayout
- defaultMode :: PPHsMode
- prettyPrim :: Pretty a => a -> Doc
- prettyPrimWithMode :: Pretty a => PPHsMode -> a -> Doc
Pretty printing
Things that can be pretty-printed, including all the syntactic objects in Language.Haskell.Exts.Syntax and Language.Haskell.Exts.Annotated.Syntax.
Instances
prettyPrintStyleMode :: Pretty a => Style -> PPHsMode -> a -> String Source
render the document with a given mode. renderWithMode :: PPHsMode -> Doc -> String renderWithMode = renderStyleMode P.style
render the document with defaultMode.
render :: Doc -> String
render = renderWithMode defaultMode
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
| |
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
Pretty-printing parameters.
Note: the onsideIndent must be positive and less than all other indents.
Constructors
| PPHsMode | |
Fields
| |
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 |
defaultMode :: PPHsMode Source
The default mode: pretty-print using the offside rule and sensible defaults.
Primitive Printers
prettyPrim :: Pretty a => a -> Doc Source
pretty-print with the default style and defaultMode.
prettyPrimWithMode :: Pretty a => PPHsMode -> a -> Doc Source
pretty-print with the default style and a given mode.