Data.Portray.Pretty

Provides rendering of Portrayal to Doc.

The primary intended use of this module is to import WrappedPortray and use it to derive Pretty instances:

    data MyRecord = MyRecord { anInt :: Int, anotherRecord :: MyRecord }
      deriving Generic
      deriving Portray via Wrapped Generic MyRecord
      deriving Pretty via WrappedPortray MyRecord

This module also exports the underlying rendering functionality in a variety of forms for more esoteric uses.

Pretty-Printing

showPortrayal :: Portray a => a -> String

Pretty-print a value using its Portray instance.

pp :: Portray a => a -> IO ()

Pretty-print a value to stdout using its Portray instance.

Diffing

showDiff :: Diff a => a -> a -> String

Pretty-print a diffe between to values using a Diff instance.

ppd :: Diff a => a -> a -> IO ()

Pretty-print a diff between two values to stdout using a Diff instance.

DerivingVia wrapper

newtype WrappedPortray a

A newtype providing a Pretty instance via Portray, for DerivingVia.

Sadly we can't use Wrapped since it would be an orphan instance. Oh well. We'll just define a unique WrappedPortray newtype in each pretty-printer-integration package.

Constructors

WrappedPortray

Fields

• unWrappedPortray :: a

Instances

Eq a => Eq (WrappedPortray a)

Defined in Data.Portray.Pretty

Methods

(==) :: WrappedPortray a -> WrappedPortray a -> Bool

(/=) :: WrappedPortray a -> WrappedPortray a -> Bool

Ord a => Ord (WrappedPortray a)

Defined in Data.Portray.Pretty

Methods

compare :: WrappedPortray a -> WrappedPortray a -> Ordering

(<) :: WrappedPortray a -> WrappedPortray a -> Bool

(<=) :: WrappedPortray a -> WrappedPortray a -> Bool

(>) :: WrappedPortray a -> WrappedPortray a -> Bool

(>=) :: WrappedPortray a -> WrappedPortray a -> Bool

max :: WrappedPortray a -> WrappedPortray a -> WrappedPortray a

min :: WrappedPortray a -> WrappedPortray a -> WrappedPortray a

Show a => Show (WrappedPortray a)

Defined in Data.Portray.Pretty

Methods

showsPrec :: Int -> WrappedPortray a -> ShowS

show :: WrappedPortray a -> String

showList :: [WrappedPortray a] -> ShowS

Portray a => Pretty (WrappedPortray a)

Provide an instance for Pretty by way of Portray.

Defined in Data.Portray.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> WrappedPortray a -> Doc

pPrint :: WrappedPortray a -> Doc

pPrintList :: PrettyLevel -> [WrappedPortray a] -> Doc

Rendering Functions

With Associativity

type DocAssocPrec = Assoc -> Rational -> Doc

A Doc that varies according to associativity and precedence context.

toDocAssocPrecF :: PortrayalF DocAssocPrec -> DocAssocPrec

Render one layer of PortrayalF to DocAssocPrec.

toDocAssocPrec :: Portrayal -> DocAssocPrec

Render a Portrayal to a Doc with support for operator associativity.

With Precedence

portrayalToDocPrecF :: PortrayalF DocAssocPrec -> PrettyLevel -> Rational -> Doc

Render a PortrayalF to a Doc.

portrayalToDocPrec :: Portrayal -> PrettyLevel -> Rational -> Doc

Render a Portrayal to a Doc with only operator precedence.

Convenience Functions

portrayalToDoc :: Portrayal -> Doc

Convert a Portrayal to a Doc.

prettyShowPortrayal :: Portrayal -> String

Convenience function for rendering a Portrayal to a String.

pPrintPortrayal :: PrettyLevel -> Rational -> Portrayal -> Doc

portrayalToDocPrec with arguments ordered for use in pPrintPrec.