Modulehaskell-src-exts-1.23.1Haskell98

Language.Haskell.Exts.Pretty

Pretty printer for Haskell with extensions.

5 types
1 class
7 values

Packagehaskell-src-exts-1.23.1
Exports13
LanguageHaskell98
LicenceBSD-3-Clause
SourcePretty.hs

Pretty printing

4 declarations

classclass Pretty a where

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

Instances82Pretty, …

Pretty SrcLocDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty SrcSpanDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty ToolDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (GuardedAlt l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (GuardedAlts l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Activation l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Alt l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Annotation l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Assoc l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Asst l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (BangType l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (BooleanFormula l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Bracket l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (CName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (CallConv l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ClassDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ConDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Context l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (DataOrNew l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Decl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (DeclHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (DerivStrategy l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Deriving l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Exp l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ExportSpec l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ExportSpecList l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (FieldDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (FieldUpdate l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (FunDep l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (GadtDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (GuardedRhs l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (IPBind l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (IPName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ImportDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ImportSpec l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ImportSpecList l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (InjectivityInfo l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (InstDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (InstHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (InstRule l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Literal l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Match l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (MaybePromotedName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Module pos)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ModuleHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ModuleName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ModulePragma l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Name l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Namespace l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Op l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Overlap l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (PXAttr l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Pat l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (PatField l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Promoted l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (QName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (QOp l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (QualConDecl l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (QualStmt l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (RPat l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (RPatOp l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (ResultSig l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Rhs l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Role l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Rule l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (RuleVar l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Safety l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (SpecialCon l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Splice l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Stmt l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (TyVarBind l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Type l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (TypeEqn l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (Unpackedness l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (XAttr l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
Pretty (XName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (PAsst loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (PContext loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (PExp loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (PFieldUpdate loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (PType loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty
SrcInfo loc => Pretty (ParseXAttr loc)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty

valueprettyPrintStyleMode :: Pretty a => Style -> PPHsMode -> a -> String

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.

valueprettyPrintWithMode :: Pretty a => PPHsMode -> a -> String

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

valueprettyPrint :: Pretty a => a -> String

pretty-print with the default style and defaultMode.

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

3 declarations

datadata Style

A rendering style. Allows us to specify constraints to choose among the many different rendering options.

Constructors

Style
- mode :: Mode
  The rendering mode.
- lineLength :: Int
  Maximum length of a line, in characters.
- ribbonsPerLine :: Float
  Ratio of line length to ribbon length. A ribbon refers to the characters on a line excluding indentation. So a lineLength of 100, with a ribbonsPerLine of 2.0 would only allow up to 50 characters of ribbon to be displayed on a line, while allowing it to be indented up to 50 characters.

Instances4Eq, Show, Generic, Rep

Eq StyleDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
Show StyleDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
Generic StyleDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
type Rep Style = D1 ('MetaData "Style" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6-a72d" 'False) (C1 ('MetaCons "Style" 'PrefixI 'True) (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mode) :*: (S1 ('MetaSel ('Just "lineLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "ribbonsPerLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float))))Defined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ

valuestyle :: Style

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

datadata Mode

Rendering mode.

Constructors

PageMode
Normal rendering (lineLength and ribbonsPerLine respected').
ZigZagMode
With zig-zag cuts.
LeftMode
No indentation, infinitely long lines (lineLength ignored), but explicit new lines, i.e., text "one" $$ text "two", are respected.
OneLineMode
All on one line, lineLength ignored and explicit new lines ($$) are turned into spaces.

Instances4Eq, Show, Generic, Rep

Eq ModeDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
Show ModeDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
Generic ModeDefined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ
type Rep Mode = D1 ('MetaData "Mode" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6-a72d" 'False) ((C1 ('MetaCons "PageMode" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ZigZagMode" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "LeftMode" 'PrefixI 'False) U1 :+: C1 ('MetaCons "OneLineMode" 'PrefixI 'False) U1))Defined in pretty-1.1.3.6 · Text.PrettyPrint.Annotated.HughesPJ

Haskell formatting modes

4 declarations

datadata PPHsMode

Pretty-printing parameters.

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

Constructors

PPHsMode
- classIndent :: Indent
  indentation of a class or instance
- doIndent :: Indent
  indentation of a do-expression
- multiIfIndent :: Indent
  indentation of the body of a case expression
- caseIndent :: Indent
  indentation of the body of a multi-if 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?

typetype Indent = Int

datadata 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

Instances1Eq

Eq PPLayoutDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Pretty

valuedefaultMode :: PPHsMode

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

Primitive Printers

2 declarations

valueprettyPrim :: Pretty a => a -> Doc

pretty-print with the default style and defaultMode.

valueprettyPrimWithMode :: Pretty a => PPHsMode -> a -> Doc

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