Safe Haskell	Safe-Inferred
Language	Haskell98

Text.PrettyPrint.Compact.Core

Synopsis

type Annotation a = Monoid a
class Layout d where
- text :: Monoid a => String -> d a
- flush :: Monoid a => d a -> d a
- annotate :: forall a. Monoid a => a -> d a -> d a
renderWith :: (Monoid r, Annotation a) => Options a r -> ODoc a -> r
data Options a r = Options {
- optsPageWidth :: !Int
- optsAnnotate :: a -> String -> r
}
groupingBy :: Monoid a => String -> [(Int, Doc a)] -> Doc a
type Doc = ODoc
($$) :: (Layout d, Monoid a, Semigroup (d a)) => d a -> d a -> d a

Documentation

type Annotation a = Monoid a Source #

class Layout d where Source #

Methods

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

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

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

<> 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 Source #

Arguments

:: (Monoid r, Annotation a)
=> Options a r	rendering options
-> ODoc a	renderable
-> r

data Options a r Source #

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.

groupingBy :: Monoid a => String -> [(Int, Doc a)] -> Doc a Source #

type Doc = ODoc Source #

($$) :: (Layout d, Monoid a, Semigroup (d a)) => d a -> d a -> d a Source #

The document (x $$> y) concatenates document x and y with a linebreak in between. (infixr 5)