GhcDump.Pretty

Documentation

class Pretty a where

Overloaded conversion to Doc.

Laws:

1. output should be pretty. :-)

Minimal complete definition

pretty

Methods

pretty :: a -> Doc ann

>>> pretty 1 <+> pretty "hello" <+> pretty 1.234
1 hello 1.234

prettyList :: [a] -> Doc ann

prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

>>> prettyList [1, 23, 456]
[1, 23, 456]

Instances

Pretty Bool

>>> pretty True
True

Defined in Prettyprinter.Internal

Methods

pretty :: Bool -> Doc ann

prettyList :: [Bool] -> Doc ann

Pretty Char

Instead of (pretty 'n'), consider using line as a more readable alternative.

>>> pretty 'f' <> pretty 'o' <> pretty 'o'
foo
>>> pretty ("string" :: String)
string

Defined in Prettyprinter.Internal

Methods

pretty :: Char -> Doc ann

prettyList :: [Char] -> Doc ann

Pretty Double

>>> pretty (exp 1 :: Double)
2.71828182845904...

Defined in Prettyprinter.Internal

Methods

pretty :: Double -> Doc ann

prettyList :: [Double] -> Doc ann

Pretty Float

>>> pretty (pi :: Float)
3.1415927

Defined in Prettyprinter.Internal

Methods

pretty :: Float -> Doc ann

prettyList :: [Float] -> Doc ann

Pretty Int

>>> pretty (123 :: Int)
123

Defined in Prettyprinter.Internal

Methods

pretty :: Int -> Doc ann

prettyList :: [Int] -> Doc ann

Pretty Int8

Defined in Prettyprinter.Internal

Methods

pretty :: Int8 -> Doc ann

prettyList :: [Int8] -> Doc ann

Pretty Int16

Defined in Prettyprinter.Internal

Methods

pretty :: Int16 -> Doc ann

prettyList :: [Int16] -> Doc ann

Pretty Int32

Defined in Prettyprinter.Internal

Methods

pretty :: Int32 -> Doc ann

prettyList :: [Int32] -> Doc ann

Pretty Int64

Defined in Prettyprinter.Internal

Methods

pretty :: Int64 -> Doc ann

prettyList :: [Int64] -> Doc ann

Pretty Integer

>>> pretty (2^123 :: Integer)
10633823966279326983230456482242756608

Defined in Prettyprinter.Internal

Methods

pretty :: Integer -> Doc ann

prettyList :: [Integer] -> Doc ann

Pretty Natural

Defined in Prettyprinter.Internal

Methods

pretty :: Natural -> Doc ann

prettyList :: [Natural] -> Doc ann

Pretty Word

Defined in Prettyprinter.Internal

Methods

pretty :: Word -> Doc ann

prettyList :: [Word] -> Doc ann

Pretty Word8

Defined in Prettyprinter.Internal

Methods

pretty :: Word8 -> Doc ann

prettyList :: [Word8] -> Doc ann

Pretty Word16

Defined in Prettyprinter.Internal

Methods

pretty :: Word16 -> Doc ann

prettyList :: [Word16] -> Doc ann

Pretty Word32

Defined in Prettyprinter.Internal

Methods

pretty :: Word32 -> Doc ann

prettyList :: [Word32] -> Doc ann

Pretty Word64

Defined in Prettyprinter.Internal

Methods

pretty :: Word64 -> Doc ann

prettyList :: [Word64] -> Doc ann

Pretty ()

>>> pretty ()
()

The argument is not used:

>>> pretty (error "Strict?" :: ())
()

Defined in Prettyprinter.Internal

Methods

pretty :: () -> Doc ann

prettyList :: [()] -> Doc ann

Pretty Void

Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing.

>>> pretty ([] :: [Void])
[]

Defined in Prettyprinter.Internal

Methods

pretty :: Void -> Doc ann

prettyList :: [Void] -> Doc ann

Pretty Text

(lazy Text instance, identical to the strict version)

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Text

Automatically converts all newlines to line.

>>> pretty ("hello\nworld" :: Text)
hello
world

Note that line can be undone by group:

>>> group (pretty ("hello\nworld" :: Text))
hello world

Manually use hardline if you definitely want newlines.

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Unique

Defined in GhcDump.Pretty

Methods

pretty :: Unique -> Doc ann

prettyList :: [Unique] -> Doc ann

Pretty ExternalName

Defined in GhcDump.Pretty

Methods

pretty :: ExternalName -> Doc ann

prettyList :: [ExternalName] -> Doc ann

Pretty BinderId

Defined in GhcDump.Pretty

Methods

pretty :: BinderId -> Doc ann

prettyList :: [BinderId] -> Doc ann

Pretty Binder

Defined in GhcDump.Pretty

Methods

pretty :: Binder -> Doc ann

prettyList :: [Binder] -> Doc ann

Pretty OccInfo

Defined in GhcDump.Pretty

Methods

pretty :: OccInfo -> Doc ann

prettyList :: [OccInfo] -> Doc ann

Pretty IdDetails

Defined in GhcDump.Pretty

Methods

pretty :: IdDetails -> Doc ann

prettyList :: [IdDetails] -> Doc ann

Pretty Lit

Defined in GhcDump.Pretty

Methods

pretty :: Lit -> Doc ann

prettyList :: [Lit] -> Doc ann

Pretty TyCon

Defined in GhcDump.Pretty

Methods

pretty :: TyCon -> Doc ann

prettyList :: [TyCon] -> Doc ann

Pretty Type

Defined in GhcDump.Pretty

Methods

pretty :: Type -> Doc ann

prettyList :: [Type] -> Doc ann

Pretty ModuleName

Defined in GhcDump.Pretty

Methods

pretty :: ModuleName -> Doc ann

prettyList :: [ModuleName] -> Doc ann

Pretty Module

Defined in GhcDump.Pretty

Methods

pretty :: Module -> Doc ann

prettyList :: [Module] -> Doc ann

Pretty Expr

Defined in GhcDump.Pretty

Methods

pretty :: Expr -> Doc ann

prettyList :: [Expr] -> Doc ann

Pretty AltCon

Defined in GhcDump.Pretty

Methods

pretty :: AltCon -> Doc ann

prettyList :: [AltCon] -> Doc ann

Pretty TopBinding

Defined in GhcDump.Pretty

Methods

pretty :: TopBinding -> Doc ann

prettyList :: [TopBinding] -> Doc ann

Pretty CoreStats

Defined in GhcDump.Pretty

Methods

pretty :: CoreStats -> Doc ann

prettyList :: [CoreStats] -> Doc ann

Pretty a => Pretty [a]

>>> pretty [1,2,3]
[1, 2, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: [a] -> Doc ann

prettyList :: [[a]] -> Doc ann

Pretty a => Pretty (Maybe a)

Ignore Nothings, print Just contents.

>>> pretty (Just True)
True
>>> braces (pretty (Nothing :: Maybe Bool))
{}

>>> pretty [Just 1, Nothing, Just 3, Nothing]
[1, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: Maybe a -> Doc ann

prettyList :: [Maybe a] -> Doc ann

Pretty a => Pretty (Identity a)

>>> pretty (Identity 1)
1

Defined in Prettyprinter.Internal

Methods

pretty :: Identity a -> Doc ann

prettyList :: [Identity a] -> Doc ann

Pretty a => Pretty (NonEmpty a)

Defined in Prettyprinter.Internal

Methods

pretty :: NonEmpty a -> Doc ann

prettyList :: [NonEmpty a] -> Doc ann

(Pretty a1, Pretty a2) => Pretty (a1, a2)

>>> pretty (123, "hello")
(123, hello)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2) -> Doc ann

prettyList :: [(a1, a2)] -> Doc ann

(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)

>>> pretty (123, "hello", False)
(123, hello, False)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2, a3) -> Doc ann

prettyList :: [(a1, a2, a3)] -> Doc ann

Pretty a => Pretty (Const a b)

Defined in Prettyprinter.Internal

Methods

pretty :: Const a b -> Doc ann

prettyList :: [Const a b] -> Doc ann

data TyPrec

Constructors

TopPrec

FunPrec

TyOpPrec

TyConPrec

Instances

Eq TyPrec

Defined in GhcDump.Pretty

Methods

(==) :: TyPrec -> TyPrec -> Bool

(/=) :: TyPrec -> TyPrec -> Bool

Ord TyPrec

Defined in GhcDump.Pretty

Methods

compare :: TyPrec -> TyPrec -> Ordering

(<) :: TyPrec -> TyPrec -> Bool

(<=) :: TyPrec -> TyPrec -> Bool

(>) :: TyPrec -> TyPrec -> Bool

(>=) :: TyPrec -> TyPrec -> Bool

max :: TyPrec -> TyPrec -> TyPrec

min :: TyPrec -> TyPrec -> TyPrec

data PrettyOpts

Constructors

PrettyOpts

Fields

• showUniques :: Bool
• showIdInfo :: Bool
• showLetTypes :: Bool
• showUnfoldings :: Bool

(<$$>) :: Doc ann -> Doc ann -> Doc ann

defaultPrettyOpts :: PrettyOpts

pprBinder :: PrettyOpts -> Binder -> Doc ann

pprRational :: Rational -> Doc ann

pprIdInfo :: PrettyOpts -> IdInfo Binder Binder -> IdDetails -> Doc ann

pprUnfolding :: PrettyOpts -> Unfolding Binder Binder -> Doc ann

pprType :: PrettyOpts -> Type -> Doc ann

pprType' :: PrettyOpts -> TyPrec -> Type -> Doc ann

maybeParens :: Bool -> Doc ann -> Doc ann

pprExpr :: PrettyOpts -> Expr -> Doc ann

pprExpr' :: PrettyOpts -> Bool -> Expr -> Doc ann

pprTick :: Tick -> Doc ann

pprTopBinding :: PrettyOpts -> TopBinding -> Doc ann

pprTypeSig :: PrettyOpts -> Binder -> Doc ann

pprBinding :: PrettyOpts -> Binder -> Expr -> Doc ann

pprModule :: PrettyOpts -> Module -> Doc ann

comment :: Doc ann -> Doc ann

dcolon :: Doc ann

smallRArrow :: Doc ann

hang' :: Doc ann -> Int -> Doc ann -> Doc ann

ppWhen :: Bool -> Doc ann -> Doc ann

Orphan instances

Pretty Unique

Methods

pretty :: Unique -> Doc ann

prettyList :: [Unique] -> Doc ann

Pretty ExternalName

Methods

pretty :: ExternalName -> Doc ann

prettyList :: [ExternalName] -> Doc ann

Pretty BinderId

Methods

pretty :: BinderId -> Doc ann

prettyList :: [BinderId] -> Doc ann

Pretty Binder

Methods

pretty :: Binder -> Doc ann

prettyList :: [Binder] -> Doc ann

Pretty OccInfo

Methods

pretty :: OccInfo -> Doc ann

prettyList :: [OccInfo] -> Doc ann

Pretty IdDetails

Methods

pretty :: IdDetails -> Doc ann

prettyList :: [IdDetails] -> Doc ann

Pretty Lit

Methods

pretty :: Lit -> Doc ann

prettyList :: [Lit] -> Doc ann

Pretty TyCon

Methods

pretty :: TyCon -> Doc ann

prettyList :: [TyCon] -> Doc ann

Pretty Type

Methods

pretty :: Type -> Doc ann

prettyList :: [Type] -> Doc ann

Pretty ModuleName

Methods

pretty :: ModuleName -> Doc ann

prettyList :: [ModuleName] -> Doc ann

Pretty Module

Methods

pretty :: Module -> Doc ann

prettyList :: [Module] -> Doc ann

Pretty Expr

Methods

pretty :: Expr -> Doc ann

prettyList :: [Expr] -> Doc ann

Pretty AltCon

Methods

pretty :: AltCon -> Doc ann

prettyList :: [AltCon] -> Doc ann

Pretty TopBinding

Methods

pretty :: TopBinding -> Doc ann

prettyList :: [TopBinding] -> Doc ann

Pretty CoreStats

Methods

pretty :: CoreStats -> Doc ann

prettyList :: [CoreStats] -> Doc ann