| Copyright | (c) The GHC Team, Noel Winstanley 1997-2000 |
|---|---|
| License | BSD-style (see the file libraries/base/LICENSE) |
| Maintainer | libraries@haskell.org |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell98 |
Language.Haskell.Pretty
Contents
Description
Pretty printer for Haskell.
- 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
- caseIndent :: Indent
- letIndent :: Indent
- whereIndent :: Indent
- onsideIndent :: Indent
- spacing :: Bool
- layout :: PPLayout
- linePragmas :: Bool
- comments :: Bool
- type Indent = Int
- data PPLayout
- defaultMode :: PPHsMode
Pretty printing
Things that can be pretty-printed, including all the syntactic objects in Language.Haskell.Syntax.
Instances
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
| |
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.