Twee.Pretty

Pretty-printing of terms and assorted other values.

Documentation

newtype TermStyle

Defines how to print out a function symbol.

Constructors

TermStyle

Fields

• pPrintTerm :: forall a. Pretty a => PrettyLevel -> Rational -> Doc -> [a] -> Doc

  Renders a function application. Takes the following arguments in this order: Pretty-printing level, current precedence, pretty-printed function symbol and list of arguments to the function.

class Pretty f => PrettyTerm f where

A class for customising the printing of function symbols.

Minimal complete definition

Nothing

Methods

termStyle :: f -> TermStyle

The style of the function symbol. Defaults to curried.

type ANSICode = String

data HighlightedTerm f

Constructors

HighlightedTerm [ANSICode] (Maybe [Int]) (Term f)

Instances

(Labelled f, PrettyTerm f) => Pretty (HighlightedTerm f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> HighlightedTerm f -> Doc

pPrint :: HighlightedTerm f -> Doc

pPrintList :: PrettyLevel -> [HighlightedTerm f] -> Doc

prettyPrint :: Pretty a => a -> IO ()

Print a value to the console.

(<#>) :: Doc -> Doc -> Doc infixl 6

Put one document beside another, i.e., <>. Renamed here because (a different) <> is exported by Prelude.

pPrintEmpty :: Doc

The empty document. Used to avoid name clashes with empty.

pPrintTuple :: [Doc] -> Doc

Print a tuple of values.

pPrintSet :: [Doc] -> Doc

Print a set of vlaues.

supply :: [String] -> [String]

Generate a list of candidate names for pretty-printing.

green :: ANSICode

bold :: ANSICode

highlight :: [ANSICode] -> Doc -> Doc

maybeHighlight :: [ANSICode] -> Maybe [Int] -> Doc -> Doc

invisible :: TermStyle

For operators like $ that should be printed as a blank space.

curried :: TermStyle

For functions that should be printed curried.

uncurried :: TermStyle

For functions that should be printed uncurried.

fixedArity :: Int -> TermStyle -> TermStyle

A helper function that deals with under- and oversaturated applications.

implicitArguments :: Int -> TermStyle -> TermStyle

A helper function that drops a certain number of arguments.

prefix :: TermStyle

For prefix operators.

postfix :: TermStyle

For postfix operators.

infixStyle :: Int -> TermStyle

For infix operators.

tupleStyle :: TermStyle

For tuples.

prettyParen :: Bool -> Doc -> Doc

Parenthesize an value if the boolean is true.

prettyShow :: Pretty a => a -> String

Pretty print a value with the prettyNormal level.

prettyNormal :: PrettyLevel

The "normal" (Level 0) of detail.

newtype PrettyLevel

Level of detail in the pretty printed output. Level 0 is the least detail.

Constructors

PrettyLevel Int

Instances

Eq PrettyLevel

Defined in Text.PrettyPrint.HughesPJClass

Methods

(==) :: PrettyLevel -> PrettyLevel -> Bool

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

Ord PrettyLevel

Defined in Text.PrettyPrint.HughesPJClass

Methods

compare :: PrettyLevel -> PrettyLevel -> Ordering

(<) :: PrettyLevel -> PrettyLevel -> Bool

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

(>) :: PrettyLevel -> PrettyLevel -> Bool

(>=) :: PrettyLevel -> PrettyLevel -> Bool

max :: PrettyLevel -> PrettyLevel -> PrettyLevel

min :: PrettyLevel -> PrettyLevel -> PrettyLevel

Show PrettyLevel

Defined in Text.PrettyPrint.HughesPJClass

Methods

showsPrec :: Int -> PrettyLevel -> ShowS

show :: PrettyLevel -> String

showList :: [PrettyLevel] -> ShowS

class Pretty a where

Pretty printing class. The precedence level is used in a similar way as in the Show class. Minimal complete definition is either pPrintPrec or pPrint.

Minimal complete definition

pPrintPrec | pPrint

Methods

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

pPrint :: a -> Doc

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

Instances

Pretty Bool

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Bool -> Doc

pPrint :: Bool -> Doc

pPrintList :: PrettyLevel -> [Bool] -> Doc

Pretty Char

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Char -> Doc

pPrint :: Char -> Doc

pPrintList :: PrettyLevel -> [Char] -> Doc

Pretty Double

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Double -> Doc

pPrint :: Double -> Doc

pPrintList :: PrettyLevel -> [Double] -> Doc

Pretty Float

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Float -> Doc

pPrint :: Float -> Doc

pPrintList :: PrettyLevel -> [Float] -> Doc

Pretty Int

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Int -> Doc

pPrint :: Int -> Doc

pPrintList :: PrettyLevel -> [Int] -> Doc

Pretty Integer

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Integer -> Doc

pPrint :: Integer -> Doc

pPrintList :: PrettyLevel -> [Integer] -> Doc

Pretty Ordering

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Ordering -> Doc

pPrint :: Ordering -> Doc

pPrintList :: PrettyLevel -> [Ordering] -> Doc

Pretty ()

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> () -> Doc

pPrint :: () -> Doc

pPrintList :: PrettyLevel -> [()] -> Doc

Pretty Doc

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Doc -> Doc

pPrint :: Doc -> Doc

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

Pretty Var

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Var -> Doc

pPrint :: Var -> Doc

pPrintList :: PrettyLevel -> [Var] -> Doc

Pretty Id

Defined in Twee.Base

Methods

pPrintPrec :: PrettyLevel -> Rational -> Id -> Doc

pPrint :: Id -> Doc

pPrintList :: PrettyLevel -> [Id] -> Doc

Pretty a => Pretty [a]

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> [a] -> Doc

pPrint :: [a] -> Doc

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

Pretty a => Pretty (Maybe a)

Defined in Text.PrettyPrint.HughesPJClass

Methods

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

pPrint :: Maybe a -> Doc

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

(Eq a, Integral a, Pretty a) => Pretty (Ratio a)

Defined in Twee.Pretty

Methods

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

pPrint :: Ratio a -> Doc

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

Pretty a => Pretty (Set a)

Defined in Twee.Pretty

Methods

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

pPrint :: Set a -> Doc

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

(Pretty f, Labelled f) => Pretty (Fun f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Fun f -> Doc

pPrint :: Fun f -> Doc

pPrintList :: PrettyLevel -> [Fun f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Term f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Term f -> Doc

pPrint :: Term f -> Doc

pPrintList :: PrettyLevel -> [Term f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (TermList f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> TermList f -> Doc

pPrint :: TermList f -> Doc

pPrintList :: PrettyLevel -> [TermList f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Subst f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Subst f -> Doc

pPrint :: Subst f -> Doc

pPrintList :: PrettyLevel -> [Subst f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (HighlightedTerm f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> HighlightedTerm f -> Doc

pPrint :: HighlightedTerm f -> Doc

pPrintList :: PrettyLevel -> [HighlightedTerm f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Model f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Model f -> Doc

pPrint :: Model f -> Doc

pPrintList :: PrettyLevel -> [Model f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Branch f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Branch f -> Doc

pPrint :: Branch f -> Doc

pPrintList :: PrettyLevel -> [Branch f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Formula f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Formula f -> Doc

pPrint :: Formula f -> Doc

pPrintList :: PrettyLevel -> [Formula f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Atom f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Atom f -> Doc

pPrint :: Atom f -> Doc

pPrintList :: PrettyLevel -> [Atom f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Equation f)

Defined in Twee.Equation

Methods

pPrintPrec :: PrettyLevel -> Rational -> Equation f -> Doc

pPrint :: Equation f -> Doc

pPrintList :: PrettyLevel -> [Equation f] -> Doc

Function f => Pretty (Presentation f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Presentation f -> Doc

pPrint :: Presentation f -> Doc

pPrintList :: PrettyLevel -> [Presentation f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Axiom f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Axiom f -> Doc

pPrint :: Axiom f -> Doc

pPrintList :: PrettyLevel -> [Axiom f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Derivation f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Derivation f -> Doc

pPrint :: Derivation f -> Doc

pPrintList :: PrettyLevel -> [Derivation f] -> Doc

Function f => Pretty (Proof f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Proof f -> Doc

pPrint :: Proof f -> Doc

pPrintList :: PrettyLevel -> [Proof f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Rule f)

Defined in Twee.Rule

Methods

pPrintPrec :: PrettyLevel -> Rational -> Rule f -> Doc

pPrint :: Rule f -> Doc

pPrintList :: PrettyLevel -> [Rule f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (CriticalPair f)

Defined in Twee.CP

Methods

pPrintPrec :: PrettyLevel -> Rational -> CriticalPair f -> Doc

pPrint :: CriticalPair f -> Doc

pPrintList :: PrettyLevel -> [CriticalPair f] -> Doc

Function f => Pretty (Active f)

Defined in Twee

Methods

pPrintPrec :: PrettyLevel -> Rational -> Active f -> Doc

pPrint :: Active f -> Doc

pPrintList :: PrettyLevel -> [Active f] -> Doc

Function f => Pretty (Message f)

Defined in Twee

Methods

pPrintPrec :: PrettyLevel -> Rational -> Message f -> Doc

pPrint :: Message f -> Doc

pPrintList :: PrettyLevel -> [Message f] -> Doc

(Pretty a, Pretty b) => Pretty (Either a b)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Either a b -> Doc

pPrint :: Either a b -> Doc

pPrintList :: PrettyLevel -> [Either a b] -> Doc

(Pretty a, Pretty b) => Pretty (a, b)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b) -> Doc

pPrint :: (a, b) -> Doc

pPrintList :: PrettyLevel -> [(a, b)] -> Doc

(Pretty k, Pretty v) => Pretty (Map k v)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Map k v -> Doc

pPrint :: Map k v -> Doc

pPrintList :: PrettyLevel -> [Map k v] -> Doc

(Pretty a, Pretty b, Pretty c) => Pretty (a, b, c)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c) -> Doc

pPrint :: (a, b, c) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d) => Pretty (a, b, c, d)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d) -> Doc

pPrint :: (a, b, c, d) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e) => Pretty (a, b, c, d, e)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e) -> Doc

pPrint :: (a, b, c, d, e) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f) => Pretty (a, b, c, d, e, f)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f) -> Doc

pPrint :: (a, b, c, d, e, f) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g) => Pretty (a, b, c, d, e, f, g)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g) -> Doc

pPrint :: (a, b, c, d, e, f, g) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g, Pretty h) => Pretty (a, b, c, d, e, f, g, h)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g, h) -> Doc

pPrint :: (a, b, c, d, e, f, g, h) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g, h)] -> Doc

fullRender

Arguments

:: Mode

Rendering mode.

-> Int

Line length.

-> Float

Ribbons per line.

-> (TextDetails -> a -> a)

What to do with text.

-> a

What to do at the end.

-> Doc

The document.

-> a

Result.

The general rendering interface. Please refer to the Style and Mode types for a description of rendering mode, line length and ribbons.

renderStyle :: Style -> Doc -> String

Render the Doc to a String using the given Style.

render :: Doc -> String

Render the Doc to a String using the default Style (see style).

first :: Doc -> Doc -> Doc

first returns its first argument if it is non-empty, otherwise its second.

fsep :: [Doc] -> Doc

"Paragraph fill" version of sep.

fcat :: [Doc] -> Doc

"Paragraph fill" version of cat.

cat :: [Doc] -> Doc

Either hcat or vcat.

sep :: [Doc] -> Doc

Either hsep or vcat.

(<+>) :: Doc -> Doc -> Doc infixl 6

Beside, separated by space, unless one of the arguments is empty. <+> is associative, with identity empty.

($+$) :: Doc -> Doc -> Doc infixl 5

Above, with no overlapping. $+$ is associative, with identity empty.

($$) :: Doc -> Doc -> Doc infixl 5

Above, except that if the last line of the first argument stops at least one position before the first line of the second begins, these two lines are overlapped. For example:

   text "hi" $$ nest 5 (text "there")

lays out as

   hi   there

rather than

   hi
        there

$$ is associative, with identity empty, and also satisfies

• (x $$ y) <> z = x $$ (y <> z), if y non-empty.

punctuate :: Doc -> [Doc] -> [Doc]

punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]

hang :: Doc -> Int -> Doc -> Doc

hang d1 n d2 = sep [d1, nest n d2]

nest :: Int -> Doc -> Doc

Nest (or indent) a document by a given number of positions (which may also be negative). nest satisfies the laws:

• nest 0 x = x

• nest k (nest k' x) = nest (k+k') x

• nest k (x <> y) = nest k x <> nest k y

• nest k (x $$ y) = nest k x $$ nest k y

• nest k empty = empty

• x <> nest k y = x <> y, if x non-empty

The side condition on the last law is needed because empty is a left identity for <>.

vcat :: [Doc] -> Doc

List version of $$.

hsep :: [Doc] -> Doc

List version of <+>.

hcat :: [Doc] -> Doc

List version of <>.

reduceDoc :: Doc -> RDoc

Perform some simplification of a built up GDoc.

maybeDoubleQuotes :: Bool -> Doc -> Doc

Apply doubleQuotes to Doc if boolean is true.

maybeQuotes :: Bool -> Doc -> Doc

Apply quotes to Doc if boolean is true.

maybeBraces :: Bool -> Doc -> Doc

Apply braces to Doc if boolean is true.

maybeBrackets :: Bool -> Doc -> Doc

Apply brackets to Doc if boolean is true.

maybeParens :: Bool -> Doc -> Doc

Apply parens to Doc if boolean is true.

braces

Arguments

:: Doc

-> Doc

Wrap document in {...}

brackets

Arguments

:: Doc

-> Doc

Wrap document in [...]

parens

Arguments

:: Doc

-> Doc

Wrap document in (...)

doubleQuotes

Arguments

:: Doc

-> Doc

Wrap document in "..."

quotes

Arguments

:: Doc

-> Doc

Wrap document in '...'

rational

Arguments

:: Rational

-> Doc

rational n = text (show n)

double

Arguments

:: Double

-> Doc

double n = text (show n)

float

Arguments

:: Float

-> Doc

float n = text (show n)

integer

Arguments

:: Integer

-> Doc

integer n = text (show n)

int

Arguments

:: Int

-> Doc

int n = text (show n)

rbrace

Arguments

:: Doc

A '}' character

lbrace

Arguments

:: Doc

A '{' character

rbrack

Arguments

:: Doc

A ']' character

lbrack

Arguments

:: Doc

A '[' character

rparen

Arguments

:: Doc

A ')' character

lparen

Arguments

:: Doc

A '(' character

equals

Arguments

:: Doc

A '=' character

space

Arguments

:: Doc

A space character

colon

Arguments

:: Doc

A : character

comma

Arguments

:: Doc

A ',' character

semi

Arguments

:: Doc

A ';' character

isEmpty :: Doc -> Bool

Returns True if the document is empty

zeroWidthText :: String -> Doc

Some text, but without any width. Use for non-printing text such as a HTML or Latex tags

sizedText :: Int -> String -> Doc

Some text with any width. (text s = sizedText (length s) s)

ptext :: String -> Doc

Same as text. Used to be used for Bytestrings.

text :: String -> Doc

A document of height 1 containing a literal string. text satisfies the following laws:

• text s <> text t = text (s++t)

• text "" <> x = x, if x non-empty

The side condition on the last law is necessary because text "" has height 1, while empty has no height.

char :: Char -> Doc

A document of height and width 1, containing a literal character.

data Doc

The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.

Instances

Eq Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

(==) :: Doc -> Doc -> Bool

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

Show Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

IsString Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

fromString :: String -> Doc

Generic Doc

Defined in Text.PrettyPrint.HughesPJ

Associated Types

type Rep Doc :: Type -> Type

Methods

from :: Doc -> Rep Doc x

to :: Rep Doc x -> Doc

Semigroup Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

(<>) :: Doc -> Doc -> Doc

sconcat :: NonEmpty Doc -> Doc

stimes :: Integral b => b -> Doc -> Doc

Monoid Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

mempty :: Doc

mappend :: Doc -> Doc -> Doc

mconcat :: [Doc] -> Doc

NFData Doc

Defined in Text.PrettyPrint.HughesPJ

Methods

rnf :: Doc -> ()

Pretty Doc

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Doc -> Doc

pPrint :: Doc -> Doc

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

type Rep Doc

Defined in Text.PrettyPrint.HughesPJ

type Rep Doc = D1 ('MetaData "Doc" "Text.PrettyPrint.HughesPJ" "pretty-1.1.3.6" 'True) (C1 ('MetaCons "Doc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc ()))))

style :: Style

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

data TextDetails

A TextDetails represents a fragment of text that will be output at some point in a Doc.

Constructors

Chr !Char

A single Char fragment

Str String

A whole String fragment

PStr String

Used to represent a Fast String fragment but now deprecated and identical to the Str constructor.

Instances

Eq TextDetails

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

(==) :: TextDetails -> TextDetails -> Bool

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

Show TextDetails

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

showsPrec :: Int -> TextDetails -> ShowS

show :: TextDetails -> String

showList :: [TextDetails] -> ShowS

Generic TextDetails

Defined in Text.PrettyPrint.Annotated.HughesPJ

Associated Types

type Rep TextDetails :: Type -> Type

Methods

from :: TextDetails -> Rep TextDetails x

to :: Rep TextDetails x -> TextDetails

NFData TextDetails

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

rnf :: TextDetails -> ()

type Rep TextDetails

Defined in Text.PrettyPrint.Annotated.HughesPJ

type Rep TextDetails = D1 ('MetaData "TextDetails" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" 'False) (C1 ('MetaCons "Chr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedUnpack) (Rec0 Char)) :+: (C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)) :+: C1 ('MetaCons "PStr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

data Style

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

Constructors

Style

Fields

• 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.

Instances

Eq Style

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

(==) :: Style -> Style -> Bool

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

Show Style

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

showsPrec :: Int -> Style -> ShowS

show :: Style -> String

showList :: [Style] -> ShowS

Generic Style

Defined in Text.PrettyPrint.Annotated.HughesPJ

Associated Types

type Rep Style :: Type -> Type

Methods

from :: Style -> Rep Style x

to :: Rep Style x -> Style

type Rep Style

Defined in Text.PrettyPrint.Annotated.HughesPJ

type Rep Style = D1 ('MetaData "Style" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" '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))))

data 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.

Instances

Eq Mode

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

(==) :: Mode -> Mode -> Bool

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

Show Mode

Defined in Text.PrettyPrint.Annotated.HughesPJ

Methods

showsPrec :: Int -> Mode -> ShowS

show :: Mode -> String

showList :: [Mode] -> ShowS

Generic Mode

Defined in Text.PrettyPrint.Annotated.HughesPJ

Associated Types

type Rep Mode :: Type -> Type

Methods

from :: Mode -> Rep Mode x

to :: Rep Mode x -> Mode

type Rep Mode

Defined in Text.PrettyPrint.Annotated.HughesPJ

type Rep Mode = D1 ('MetaData "Mode" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" 'False) ((C1 ('MetaCons "PageMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ZigZagMode" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LeftMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OneLineMode" 'PrefixI 'False) (U1 :: Type -> Type)))

class Pretty a where

Pretty printing class. The precedence level is used in a similar way as in the Show class. Minimal complete definition is either pPrintPrec or pPrint.

Minimal complete definition

pPrintPrec | pPrint

Methods

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

pPrint :: a -> Doc

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

Instances

Pretty Bool

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Bool -> Doc

pPrint :: Bool -> Doc

pPrintList :: PrettyLevel -> [Bool] -> Doc

Pretty Char

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Char -> Doc

pPrint :: Char -> Doc

pPrintList :: PrettyLevel -> [Char] -> Doc

Pretty Double

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Double -> Doc

pPrint :: Double -> Doc

pPrintList :: PrettyLevel -> [Double] -> Doc

Pretty Float

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Float -> Doc

pPrint :: Float -> Doc

pPrintList :: PrettyLevel -> [Float] -> Doc

Pretty Int

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Int -> Doc

pPrint :: Int -> Doc

pPrintList :: PrettyLevel -> [Int] -> Doc

Pretty Integer

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Integer -> Doc

pPrint :: Integer -> Doc

pPrintList :: PrettyLevel -> [Integer] -> Doc

Pretty Ordering

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Ordering -> Doc

pPrint :: Ordering -> Doc

pPrintList :: PrettyLevel -> [Ordering] -> Doc

Pretty ()

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> () -> Doc

pPrint :: () -> Doc

pPrintList :: PrettyLevel -> [()] -> Doc

Pretty Doc

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Doc -> Doc

pPrint :: Doc -> Doc

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

Pretty Var

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Var -> Doc

pPrint :: Var -> Doc

pPrintList :: PrettyLevel -> [Var] -> Doc

Pretty Id

Defined in Twee.Base

Methods

pPrintPrec :: PrettyLevel -> Rational -> Id -> Doc

pPrint :: Id -> Doc

pPrintList :: PrettyLevel -> [Id] -> Doc

Pretty a => Pretty [a]

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> [a] -> Doc

pPrint :: [a] -> Doc

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

Pretty a => Pretty (Maybe a)

Defined in Text.PrettyPrint.HughesPJClass

Methods

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

pPrint :: Maybe a -> Doc

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

(Eq a, Integral a, Pretty a) => Pretty (Ratio a)

Defined in Twee.Pretty

Methods

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

pPrint :: Ratio a -> Doc

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

Pretty a => Pretty (Set a)

Defined in Twee.Pretty

Methods

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

pPrint :: Set a -> Doc

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

(Pretty f, Labelled f) => Pretty (Fun f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Fun f -> Doc

pPrint :: Fun f -> Doc

pPrintList :: PrettyLevel -> [Fun f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Term f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Term f -> Doc

pPrint :: Term f -> Doc

pPrintList :: PrettyLevel -> [Term f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (TermList f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> TermList f -> Doc

pPrint :: TermList f -> Doc

pPrintList :: PrettyLevel -> [TermList f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Subst f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Subst f -> Doc

pPrint :: Subst f -> Doc

pPrintList :: PrettyLevel -> [Subst f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (HighlightedTerm f)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> HighlightedTerm f -> Doc

pPrint :: HighlightedTerm f -> Doc

pPrintList :: PrettyLevel -> [HighlightedTerm f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Model f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Model f -> Doc

pPrint :: Model f -> Doc

pPrintList :: PrettyLevel -> [Model f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Branch f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Branch f -> Doc

pPrint :: Branch f -> Doc

pPrintList :: PrettyLevel -> [Branch f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Formula f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Formula f -> Doc

pPrint :: Formula f -> Doc

pPrintList :: PrettyLevel -> [Formula f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Atom f)

Defined in Twee.Constraints

Methods

pPrintPrec :: PrettyLevel -> Rational -> Atom f -> Doc

pPrint :: Atom f -> Doc

pPrintList :: PrettyLevel -> [Atom f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Equation f)

Defined in Twee.Equation

Methods

pPrintPrec :: PrettyLevel -> Rational -> Equation f -> Doc

pPrint :: Equation f -> Doc

pPrintList :: PrettyLevel -> [Equation f] -> Doc

Function f => Pretty (Presentation f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Presentation f -> Doc

pPrint :: Presentation f -> Doc

pPrintList :: PrettyLevel -> [Presentation f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Axiom f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Axiom f -> Doc

pPrint :: Axiom f -> Doc

pPrintList :: PrettyLevel -> [Axiom f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Derivation f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Derivation f -> Doc

pPrint :: Derivation f -> Doc

pPrintList :: PrettyLevel -> [Derivation f] -> Doc

Function f => Pretty (Proof f)

Defined in Twee.Proof

Methods

pPrintPrec :: PrettyLevel -> Rational -> Proof f -> Doc

pPrint :: Proof f -> Doc

pPrintList :: PrettyLevel -> [Proof f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Rule f)

Defined in Twee.Rule

Methods

pPrintPrec :: PrettyLevel -> Rational -> Rule f -> Doc

pPrint :: Rule f -> Doc

pPrintList :: PrettyLevel -> [Rule f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (CriticalPair f)

Defined in Twee.CP

Methods

pPrintPrec :: PrettyLevel -> Rational -> CriticalPair f -> Doc

pPrint :: CriticalPair f -> Doc

pPrintList :: PrettyLevel -> [CriticalPair f] -> Doc

Function f => Pretty (Active f)

Defined in Twee

Methods

pPrintPrec :: PrettyLevel -> Rational -> Active f -> Doc

pPrint :: Active f -> Doc

pPrintList :: PrettyLevel -> [Active f] -> Doc

Function f => Pretty (Message f)

Defined in Twee

Methods

pPrintPrec :: PrettyLevel -> Rational -> Message f -> Doc

pPrint :: Message f -> Doc

pPrintList :: PrettyLevel -> [Message f] -> Doc

(Pretty a, Pretty b) => Pretty (Either a b)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> Either a b -> Doc

pPrint :: Either a b -> Doc

pPrintList :: PrettyLevel -> [Either a b] -> Doc

(Pretty a, Pretty b) => Pretty (a, b)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b) -> Doc

pPrint :: (a, b) -> Doc

pPrintList :: PrettyLevel -> [(a, b)] -> Doc

(Pretty k, Pretty v) => Pretty (Map k v)

Defined in Twee.Pretty

Methods

pPrintPrec :: PrettyLevel -> Rational -> Map k v -> Doc

pPrint :: Map k v -> Doc

pPrintList :: PrettyLevel -> [Map k v] -> Doc

(Pretty a, Pretty b, Pretty c) => Pretty (a, b, c)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c) -> Doc

pPrint :: (a, b, c) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d) => Pretty (a, b, c, d)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d) -> Doc

pPrint :: (a, b, c, d) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e) => Pretty (a, b, c, d, e)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e) -> Doc

pPrint :: (a, b, c, d, e) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f) => Pretty (a, b, c, d, e, f)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f) -> Doc

pPrint :: (a, b, c, d, e, f) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g) => Pretty (a, b, c, d, e, f, g)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g) -> Doc

pPrint :: (a, b, c, d, e, f, g) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g, Pretty h) => Pretty (a, b, c, d, e, f, g, h)

Defined in Text.PrettyPrint.HughesPJClass

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g, h) -> Doc

pPrint :: (a, b, c, d, e, f, g, h) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g, h)] -> Doc

Orphan instances

Pretty Doc

Methods

pPrintPrec :: PrettyLevel -> Rational -> Doc -> Doc

pPrint :: Doc -> Doc

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

Pretty Var

Methods

pPrintPrec :: PrettyLevel -> Rational -> Var -> Doc

pPrint :: Var -> Doc

pPrintList :: PrettyLevel -> [Var] -> Doc

(Eq a, Integral a, Pretty a) => Pretty (Ratio a)

Methods

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

pPrint :: Ratio a -> Doc

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

Pretty a => Pretty (Set a)

Methods

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

pPrint :: Set a -> Doc

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

(Pretty f, Labelled f) => Pretty (Fun f)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Fun f -> Doc

pPrint :: Fun f -> Doc

pPrintList :: PrettyLevel -> [Fun f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Term f)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Term f -> Doc

pPrint :: Term f -> Doc

pPrintList :: PrettyLevel -> [Term f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (TermList f)

Methods

pPrintPrec :: PrettyLevel -> Rational -> TermList f -> Doc

pPrint :: TermList f -> Doc

pPrintList :: PrettyLevel -> [TermList f] -> Doc

(Labelled f, PrettyTerm f) => Pretty (Subst f)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Subst f -> Doc

pPrint :: Subst f -> Doc

pPrintList :: PrettyLevel -> [Subst f] -> Doc

(Pretty k, Pretty v) => Pretty (Map k v)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Map k v -> Doc

pPrint :: Map k v -> Doc

pPrintList :: PrettyLevel -> [Map k v] -> Doc