Portability | portable |
---|---|
Stability | experimental |
Maintainer | libraries@haskell.org |
Safe Haskell | None |
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
- = PageMode
- | ZigZagMode
- | LeftMode
- | OneLineMode
- 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
- = PPOffsideRule
- | PPSemiColon
- | PPInLine
- | PPNoLayout
- defaultMode :: PPHsMode
Pretty printing
class Pretty a
Things that can be pretty-printed, including all the syntactic objects in Language.Haskell.Syntax.
Instances
prettyPrintStyleMode :: Pretty a => Style -> PPHsMode -> a -> String
pretty-print with a given style and mode.
prettyPrintWithMode :: Pretty a => PPHsMode -> a -> String
pretty-print with the default style and a given mode.
prettyPrint :: Pretty a => a -> String
pretty-print with the default style and defaultMode
.
Pretty-printing styles (from Text.PrettyPrint.HughesPJ)
data Style
Constructors
Style | |
Fields
|
data Mode
Constructors
PageMode | |
ZigZagMode | |
LeftMode | |
OneLineMode |
Haskell formatting modes
data PPHsMode
Pretty-printing parameters.
Note: the onsideIndent
must be positive and less than all other indents.
Constructors
PPHsMode | |
Fields
|
type Indent = Int
data PPLayout
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
Eq PPLayout |
The default mode: pretty-print using the offside rule and sensible defaults.