Safe Haskell	None
Language	Haskell98

LLVM.General.PrettyPrint

Description

Tools for printing out AST.Module code so that it's actually useful.

Synopsis

Documentation

class Show a => PrettyShow a where Source

a class for simple pretty-printing with indentation a function only of syntactic depth.

Minimal complete definition

Nothing

Methods

prettyShow :: a -> QTree Source

prettyShowList :: [a] -> QTree Source

Instances

PrettyShow Bool
PrettyShow Char
PrettyShow Double
PrettyShow Float
PrettyShow Int
PrettyShow Integer
PrettyShow Word
PrettyShow Word16
PrettyShow Word32
PrettyShow Word64
PrettyShow SomeFloat
PrettyShow AddrSpace
PrettyShow DataLayout
PrettyShow AlignType
PrettyShow AlignmentInfo
PrettyShow Endianness
PrettyShow FunctionAttribute
PrettyShow ParameterAttribute
PrettyShow CallingConvention
PrettyShow FloatingPointPredicate
PrettyShow IntegerPredicate
PrettyShow Linkage
PrettyShow Visibility
PrettyShow RMWOperation
PrettyShow Name
PrettyShow Type
PrettyShow FloatingPointFormat
PrettyShow InlineAssembly
PrettyShow Dialect
PrettyShow Constant
PrettyShow Operand
PrettyShow MetadataNode
PrettyShow MetadataNodeID
PrettyShow Instruction
PrettyShow LandingPadClause
PrettyShow Atomicity
PrettyShow MemoryOrdering
PrettyShow FastMathFlags
PrettyShow Terminator
PrettyShow BasicBlock
PrettyShow Parameter
PrettyShow Global
PrettyShow Module
PrettyShow Definition
PrettyShow a => PrettyShow [a]
PrettyShow a0 => PrettyShow (Maybe a)
PrettyShow a => PrettyShow (Set a)
PrettyShow a0 => PrettyShow (Named a)
(PrettyShow a0, PrettyShow a1) => PrettyShow (Either a a)
(PrettyShow a, PrettyShow b) => PrettyShow (a, b)
(PrettyShow k, PrettyShow a) => PrettyShow (Map k a)

showPretty :: PrettyShow a => a -> String Source

Show an AST.Module or part thereof both with qualified identifiers (resolving some ambiguity, making the output usable Haskell) and with indentation (making the output readable).

showPrettyEx Source

Arguments

:: PrettyShow a
=> Int	line length before attempting breaking
-> String	one unit of indentation
-> PrefixScheme	prefixes to use for qualifying names
-> a
-> String

Like showPretty but allowing configuration of the format

newtype PrefixScheme Source

A PrefixScheme is a mapping between haskell module names and the prefixes with which they should be rendered when printing code.

Constructors

PrefixScheme (Map String (Maybe String))

Instances

Eq PrefixScheme
Ord PrefixScheme
Read PrefixScheme
Show PrefixScheme
Monoid PrefixScheme

shortPrefixScheme :: PrefixScheme Source

a terse PrefixScheme, leaving most names unqualified.

longPrefixScheme :: PrefixScheme Source

a conservative PrefixScheme which qualifies everything.

defaultPrefixScheme :: PrefixScheme Source

the default PrefixScheme used by showPretty

basePrefixScheme :: PrefixScheme Source

a PrefixScheme for types not of llvm-general, but nevertheless used in the AST. Useful for building other PrefixSchemes.

shortASTPrefixScheme :: PrefixScheme Source

a terse PrefixScheme for types in the AST, leaving most names unqualified. Useful for building other PrefixSchemes. If you think you want to use this, you probably want shortPrefixScheme instead.

longASTPrefixScheme :: PrefixScheme Source

a conservative PrefixScheme for types in the AST which qualifies everything. Useful for building other PrefixSchemes. If you think you want to use this, you probably want longPrefixScheme instead.

imports :: PrefixScheme -> String Source

print Haskell imports to define the correct prefixes for use with the output of a given PrefixScheme.