Text.PrettyPrint.Compact.Core

Documentation

type Annotation a = (Eq a, Monoid a)

class Layout d where

Minimal complete definition

text, flush, annotate

Methods

text :: Monoid a => String -> d a

flush :: Monoid a => d a -> d a

annotate :: forall a. Monoid a => a -> d a -> d a

<> new annotation to the Doc.

Example: 'Any True' annotation will transform the rendered Doc into uppercase:

>>> let r = putStrLn . renderWith defaultOptions { optsAnnotate = \a x -> if a == Any True then map toUpper x else x }
>>> r $ text "hello" <$$> annotate (Any True) (text "world")
hello
WORLD

renderWith

Arguments

:: (Monoid r, Monoid a, Eq a)

=> Options a r

rendering options

-> Doc a

renderable

-> r

data Options a r

Constructors

Options

Fields

• optsPageWidth :: !Int

  maximum page width

• optsAnnotate :: a -> String -> r

  how to annotate the string. Note: the annotation should preserve the visible length of the string.

class Layout d => Document d where

Minimal complete definition

(<|>), empty

Methods

(<|>) :: Eq a => d a -> d a -> d a

empty :: d a

type Doc = DDoc

singleLine :: forall a. Monoid a => DDoc a -> DDoc a