HIndent.Pretty

Pretty printing.

Printing

class (Annotated ast, Typeable ast) => Pretty ast

Pretty printing class.

Minimal complete definition

prettyInternal

Instances

Pretty ModuleName

Methods

prettyInternal :: MonadState (PrintState s) m => ModuleName NodeInfo -> m ()

Pretty SpecialCon

Methods

prettyInternal :: MonadState (PrintState s) m => SpecialCon NodeInfo -> m ()

Pretty QName

Methods

prettyInternal :: MonadState (PrintState s) m => QName NodeInfo -> m ()

Pretty Name

Methods

prettyInternal :: MonadState (PrintState s) m => Name NodeInfo -> m ()

Pretty QOp

Methods

prettyInternal :: MonadState (PrintState s) m => QOp NodeInfo -> m ()

Pretty Module

Methods

prettyInternal :: MonadState (PrintState s) m => Module NodeInfo -> m ()

Pretty ModuleHead

Methods

prettyInternal :: MonadState (PrintState s) m => ModuleHead NodeInfo -> m ()

Pretty ExportSpecList

Methods

prettyInternal :: MonadState (PrintState s) m => ExportSpecList NodeInfo -> m ()

Pretty ExportSpec

Methods

prettyInternal :: MonadState (PrintState s) m => ExportSpec NodeInfo -> m ()

Pretty ImportDecl

Methods

prettyInternal :: MonadState (PrintState s) m => ImportDecl NodeInfo -> m ()

Pretty ImportSpecList

Methods

prettyInternal :: MonadState (PrintState s) m => ImportSpecList NodeInfo -> m ()

Pretty ImportSpec

Methods

prettyInternal :: MonadState (PrintState s) m => ImportSpec NodeInfo -> m ()

Pretty Decl

Methods

prettyInternal :: MonadState (PrintState s) m => Decl NodeInfo -> m ()

Pretty DataOrNew

Methods

prettyInternal :: MonadState (PrintState s) m => DataOrNew NodeInfo -> m ()

Pretty DeclHead

Methods

prettyInternal :: MonadState (PrintState s) m => DeclHead NodeInfo -> m ()

Pretty InstRule

Methods

prettyInternal :: MonadState (PrintState s) m => InstRule NodeInfo -> m ()

Pretty InstHead

Methods

prettyInternal :: MonadState (PrintState s) m => InstHead NodeInfo -> m ()

Pretty Deriving

Methods

prettyInternal :: MonadState (PrintState s) m => Deriving NodeInfo -> m ()

Pretty Binds

Methods

prettyInternal :: MonadState (PrintState s) m => Binds NodeInfo -> m ()

Pretty IPBind

Methods

prettyInternal :: MonadState (PrintState s) m => IPBind NodeInfo -> m ()

Pretty Match

Methods

prettyInternal :: MonadState (PrintState s) m => Match NodeInfo -> m ()

Pretty QualConDecl

Methods

prettyInternal :: MonadState (PrintState s) m => QualConDecl NodeInfo -> m ()

Pretty ConDecl

Methods

prettyInternal :: MonadState (PrintState s) m => ConDecl NodeInfo -> m ()

Pretty FieldDecl

Methods

prettyInternal :: MonadState (PrintState s) m => FieldDecl NodeInfo -> m ()

Pretty ClassDecl

Methods

prettyInternal :: MonadState (PrintState s) m => ClassDecl NodeInfo -> m ()

Pretty InstDecl

Methods

prettyInternal :: MonadState (PrintState s) m => InstDecl NodeInfo -> m ()

Pretty BangType

Methods

prettyInternal :: MonadState (PrintState s) m => BangType NodeInfo -> m ()

Pretty Rhs

Methods

prettyInternal :: MonadState (PrintState s) m => Rhs NodeInfo -> m ()

Pretty GuardedRhs

Methods

prettyInternal :: MonadState (PrintState s) m => GuardedRhs NodeInfo -> m ()

Pretty Type

Methods

prettyInternal :: MonadState (PrintState s) m => Type NodeInfo -> m ()

Pretty TyVarBind

Methods

prettyInternal :: MonadState (PrintState s) m => TyVarBind NodeInfo -> m ()

Pretty Kind

Methods

prettyInternal :: MonadState (PrintState s) m => Kind NodeInfo -> m ()

Pretty FunDep

Methods

prettyInternal :: MonadState (PrintState s) m => FunDep NodeInfo -> m ()

Pretty Context

Methods

prettyInternal :: MonadState (PrintState s) m => Context NodeInfo -> m ()

Pretty Asst

Methods

prettyInternal :: MonadState (PrintState s) m => Asst NodeInfo -> m ()

Pretty Literal

Methods

prettyInternal :: MonadState (PrintState s) m => Literal NodeInfo -> m ()

Pretty Sign

Methods

prettyInternal :: MonadState (PrintState s) m => Sign NodeInfo -> m ()

Pretty Exp

Methods

prettyInternal :: MonadState (PrintState s) m => Exp NodeInfo -> m ()

Pretty Bracket

Methods

prettyInternal :: MonadState (PrintState s) m => Bracket NodeInfo -> m ()

Pretty Splice

Methods

prettyInternal :: MonadState (PrintState s) m => Splice NodeInfo -> m ()

Pretty ModulePragma

Methods

prettyInternal :: MonadState (PrintState s) m => ModulePragma NodeInfo -> m ()

Pretty Overlap

Methods

prettyInternal :: MonadState (PrintState s) m => Overlap NodeInfo -> m ()

Pretty WarningText

Methods

prettyInternal :: MonadState (PrintState s) m => WarningText NodeInfo -> m ()

Pretty Pat

Methods

prettyInternal :: MonadState (PrintState s) m => Pat NodeInfo -> m ()

Pretty PatField

Methods

prettyInternal :: MonadState (PrintState s) m => PatField NodeInfo -> m ()

Pretty Stmt

Methods

prettyInternal :: MonadState (PrintState s) m => Stmt NodeInfo -> m ()

Pretty QualStmt

Methods

prettyInternal :: MonadState (PrintState s) m => QualStmt NodeInfo -> m ()

Pretty FieldUpdate

Methods

prettyInternal :: MonadState (PrintState s) m => FieldUpdate NodeInfo -> m ()

Pretty Alt

Methods

prettyInternal :: MonadState (PrintState s) m => Alt NodeInfo -> m ()

pretty :: (Pretty ast, MonadState (PrintState s) m) => ast NodeInfo -> m ()

Pretty print using extenders.

prettyNoExt :: (Pretty ast, MonadState (PrintState s) m) => ast NodeInfo -> m ()

Run the basic printer for the given node without calling an extension hook for this node, but do allow extender hooks in child nodes. Also auto-inserts comments.

User state

getState :: Printer s s

Get the user state.

putState :: s -> Printer s ()

Put the user state.

modifyState :: (s -> s) -> Printer s ()

Modify the user state.

Insertion

write :: MonadState (PrintState s) m => Builder -> m ()

Write out a string, updating the current position information.

newline :: MonadState (PrintState s) m => m ()

Output a newline.

space :: MonadState (PrintState s) m => m ()

Write a space.

comma :: MonadState (PrintState s) m => m ()

Write a comma.

int :: (Integral n, MonadState (PrintState s) m) => n -> m ()

Write an integral.

string :: MonadState (PrintState s) m => String -> m ()

Write a string.

Common node types

maybeCtx :: MonadState (PrintState s) m => Maybe (Context NodeInfo) -> m ()

Maybe render a class context.

printComment :: MonadState (PrintState s) m => Maybe SrcSpan -> Comment -> m ()

Pretty print a comment.

printComments :: (Pretty ast, MonadState (PrintState s) m) => ComInfoLocation -> ast NodeInfo -> m ()

Print comments of a node.

withCaseContext :: MonadState (PrintState s) m => Bool -> m a -> m a

Set the context to a case context, where RHS is printed with -> .

rhsSeparator :: MonadState (PrintState s) m => m ()

Get the current RHS separator, either = or -> .

Interspersing

inter :: MonadState (PrintState s) m => m () -> [m ()] -> m ()

Print all the printers separated by sep.

spaced :: MonadState (PrintState s) m => [m ()] -> m ()

Print all the printers separated by spaces.

lined :: MonadState (PrintState s) m => [m ()] -> m ()

Print all the printers separated by newlines.

prefixedLined :: MonadState (PrintState s) m => Text -> [m ()] -> m ()

Print all the printers separated newlines and optionally a line prefix.

commas :: MonadState (PrintState s) m => [m ()] -> m ()

Print all the printers separated by commas.

Wrapping

parens :: MonadState (PrintState s) m => m a -> m a

Wrap in parens.

brackets :: MonadState (PrintState s) m => m a -> m a

Wrap in brackets.

braces :: MonadState (PrintState s) m => m a -> m a

Wrap in braces.

Indentation

indented :: MonadState (PrintState s) m => Int64 -> m a -> m a

Increase indentation level by n spaces for the given printer.

column :: MonadState (PrintState s) m => Int64 -> m a -> m a

Set the (newline-) indent level to the given column for the given printer.

getColumn :: MonadState (PrintState s) m => m Int64

Get the current indent level.

getLineNum :: MonadState (PrintState s) m => m Int64

Get the current line number.

depend :: MonadState (PrintState s) m => m () -> m b -> m b

Make the latter's indentation depend upon the end column of the former.

dependBind :: MonadState (PrintState s) m => m a -> (a -> m b) -> m b

Make the latter's indentation depend upon the end column of the former.

swing :: MonadState (PrintState s) m => m () -> m b -> m b

Swing the second printer below and indented with respect to the first.

swingBy :: MonadState (PrintState s) m => Int64 -> m () -> m b -> m b

Swing the second printer below and indented with respect to the first by the specified amount.

getIndentSpaces :: MonadState (PrintState s) m => m Int64

Indent spaces, e.g. 2.

getColumnLimit :: MonadState (PrintState s) m => m Int64

Column limit, e.g. 80

Predicates

nullBinds :: Binds NodeInfo -> Bool

No binds?

Sandboxing

sandbox :: MonadState s m => m a -> m (a, s)

Play with a printer and then restore the state to what it was before.

Fallback

pretty' :: (Pretty ast, Pretty (ast SrcSpanInfo), Functor ast, MonadState (PrintState s) m) => ast NodeInfo -> m ()

Pretty print using HSE's own printer. The Pretty class here is HSE's.