Silkscreen

Silkscreen is a library of pretty-printing transformers built around the prettyprinter package. This module defines the core Printer abstraction and a few instances.

More documentation can be found in Prettyprinter.

Printing

class Monoid p => Printer p where

A Printer abstracts pretty-printing to allow the composition of behaviours such as e.g. rainbow parentheses, precedence handling, and so forth.

Minimal complete definition

liftDoc0, liftDoc1, liftDoc2, column, nesting, pageWidth

Associated Types

type Ann p

The type of annotations supported by the printer.

We provide this as a type family instead of defining Printer over kind Type -> Type in order to allow instances to constrain annotations.

Methods

liftDoc0 :: Doc (Ann p) -> p

Lift a Doc to a Printer.

liftDoc1 :: (Doc (Ann p) -> Doc (Ann p)) -> p -> p

Lift a unary function on Doc to a Printer.

liftDoc2 :: (Doc (Ann p) -> Doc (Ann p) -> Doc (Ann p)) -> p -> p -> p

Lift a binary function on Doc to a Printer.

enclosing :: p -> p -> p -> p

enclosing l r x wraps x in l and r.

Distinct from enclose (which is not overloaded) so that enclose remains available as a convenience for appending documents without whatever extra semantics are implied by any particular Printer (rainbow precedences, resetting precedence, etc.).

Overloadable to support e.g. rainbow parentheses.

squotes :: p -> p

Wrap the argument in single quotes.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow quotes (or disabling of same, if desired).

dquotes :: p -> p

Wrap the argument in double quotes.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow quotes (or disabling of same, if desired).

parens :: p -> p

Parenthesize the argument.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow parentheses (or disabling of same, if desired).

brackets :: p -> p

Wrap the argument in brackets.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow brackets (or disabling of same, if desired).

braces :: p -> p

Wrap the argument in braces.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow braces (or disabling of same, if desired).

angles :: p -> p

Wrap the argument in angle brackets.

The default definition is given in terms of enclosing. Overloadable to support e.g. rainbow angle brackets (or disabling of same, if desired).

column :: (Int -> p) -> p

nesting :: (Int -> p) -> p

pageWidth :: (PageWidth -> p) -> p

Instances

Printer (Doc ann)

Defined in Silkscreen

Associated Types

type Ann (Doc ann)

Methods

liftDoc0 :: Doc (Ann (Doc ann)) -> Doc ann

liftDoc1 :: (Doc (Ann (Doc ann)) -> Doc (Ann (Doc ann))) -> Doc ann -> Doc ann

liftDoc2 :: (Doc (Ann (Doc ann)) -> Doc (Ann (Doc ann)) -> Doc (Ann (Doc ann))) -> Doc ann -> Doc ann -> Doc ann

enclosing :: Doc ann -> Doc ann -> Doc ann -> Doc ann

squotes :: Doc ann -> Doc ann

dquotes :: Doc ann -> Doc ann

parens :: Doc ann -> Doc ann

brackets :: Doc ann -> Doc ann

braces :: Doc ann -> Doc ann

angles :: Doc ann -> Doc ann

column :: (Int -> Doc ann) -> Doc ann

nesting :: (Int -> Doc ann) -> Doc ann

pageWidth :: (PageWidth -> Doc ann) -> Doc ann

Printer a => Printer (Rainbow a)

Defined in Silkscreen.Printer.Rainbow

Associated Types

type Ann (Rainbow a)

Methods

liftDoc0 :: Doc (Ann (Rainbow a)) -> Rainbow a

liftDoc1 :: (Doc (Ann (Rainbow a)) -> Doc (Ann (Rainbow a))) -> Rainbow a -> Rainbow a

liftDoc2 :: (Doc (Ann (Rainbow a)) -> Doc (Ann (Rainbow a)) -> Doc (Ann (Rainbow a))) -> Rainbow a -> Rainbow a -> Rainbow a

enclosing :: Rainbow a -> Rainbow a -> Rainbow a -> Rainbow a

squotes :: Rainbow a -> Rainbow a

dquotes :: Rainbow a -> Rainbow a

parens :: Rainbow a -> Rainbow a

brackets :: Rainbow a -> Rainbow a

braces :: Rainbow a -> Rainbow a

angles :: Rainbow a -> Rainbow a

column :: (Int -> Rainbow a) -> Rainbow a

nesting :: (Int -> Rainbow a) -> Rainbow a

pageWidth :: (PageWidth -> Rainbow a) -> Rainbow a

Printer b => Printer (a -> b)

Defined in Silkscreen

Associated Types

type Ann (a -> b)

Methods

liftDoc0 :: Doc (Ann (a -> b)) -> a -> b

liftDoc1 :: (Doc (Ann (a -> b)) -> Doc (Ann (a -> b))) -> (a -> b) -> a -> b

liftDoc2 :: (Doc (Ann (a -> b)) -> Doc (Ann (a -> b)) -> Doc (Ann (a -> b))) -> (a -> b) -> (a -> b) -> a -> b

enclosing :: (a -> b) -> (a -> b) -> (a -> b) -> a -> b

squotes :: (a -> b) -> a -> b

dquotes :: (a -> b) -> a -> b

parens :: (a -> b) -> a -> b

brackets :: (a -> b) -> a -> b

braces :: (a -> b) -> a -> b

angles :: (a -> b) -> a -> b

column :: (Int -> a -> b) -> a -> b

nesting :: (Int -> a -> b) -> a -> b

pageWidth :: (PageWidth -> a -> b) -> a -> b

(Printer a, Printer b, Ann a ~ Ann b) => Printer (a, b)

Defined in Silkscreen

Associated Types

type Ann (a, b)

Methods

liftDoc0 :: Doc (Ann (a, b)) -> (a, b)

liftDoc1 :: (Doc (Ann (a, b)) -> Doc (Ann (a, b))) -> (a, b) -> (a, b)

liftDoc2 :: (Doc (Ann (a, b)) -> Doc (Ann (a, b)) -> Doc (Ann (a, b))) -> (a, b) -> (a, b) -> (a, b)

enclosing :: (a, b) -> (a, b) -> (a, b) -> (a, b)

squotes :: (a, b) -> (a, b)

dquotes :: (a, b) -> (a, b)

parens :: (a, b) -> (a, b)

brackets :: (a, b) -> (a, b)

braces :: (a, b) -> (a, b)

angles :: (a, b) -> (a, b)

column :: (Int -> (a, b)) -> (a, b)

nesting :: (Int -> (a, b)) -> (a, b)

pageWidth :: (PageWidth -> (a, b)) -> (a, b)

(Bounded level, Printer a) => Printer (Prec level a)

Defined in Silkscreen.Printer.Prec

Associated Types

type Ann (Prec level a)

Methods

liftDoc0 :: Doc (Ann (Prec level a)) -> Prec level a

liftDoc1 :: (Doc (Ann (Prec level a)) -> Doc (Ann (Prec level a))) -> Prec level a -> Prec level a

liftDoc2 :: (Doc (Ann (Prec level a)) -> Doc (Ann (Prec level a)) -> Doc (Ann (Prec level a))) -> Prec level a -> Prec level a -> Prec level a

enclosing :: Prec level a -> Prec level a -> Prec level a -> Prec level a

squotes :: Prec level a -> Prec level a

dquotes :: Prec level a -> Prec level a

parens :: Prec level a -> Prec level a

brackets :: Prec level a -> Prec level a

braces :: Prec level a -> Prec level a

angles :: Prec level a -> Prec level a

column :: (Int -> Prec level a) -> Prec level a

nesting :: (Int -> Prec level a) -> Prec level a

pageWidth :: (PageWidth -> Prec level a) -> Prec level a

Combinators

pretty :: (Printer p, Pretty t) => t -> p

Pretty-print a value using the Pretty instance for its type.

prettyList :: (Printer p, Pretty t) => [t] -> p

annotate :: Printer p => Ann p -> p -> p

Annotate a Printer with an Ann p.

group :: Printer p => p -> p

Try to unwrap the argument, if it will fit.

flatAlt :: Printer p => p -> p -> p

Print the first argument by default, or the second when an enclosing group flattens it.

align :: Printer p => p -> p

Indent lines in the argument to the current column.

hang :: Printer p => Int -> p -> p

Indent following lines in the argument to the current column + some delta.

indent :: Printer p => Int -> p -> p

Indent lines in the argument to the current column + some delta.

nest :: Printer p => Int -> p -> p

nest i p changes the indentation level for new lines in p by i.

concatWith :: (Monoid p, Foldable t) => (p -> p -> p) -> t p -> p

hsep :: Printer p => [p] -> p

vsep :: Printer p => [p] -> p

fillSep :: Printer p => [p] -> p

sep :: Printer p => [p] -> p

hcat :: Printer p => [p] -> p

vcat :: Printer p => [p] -> p

fillCat :: Printer p => [p] -> p

cat :: Printer p => [p] -> p

punctuate :: Printer p => p -> [p] -> [p]

width :: Printer p => p -> (Int -> p) -> p

fill :: Printer p => Int -> p -> p

fillBreak :: Printer p => Int -> p -> p

plural :: (Num amount, Eq amount) => doc -> doc -> amount -> doc

enclose :: Printer p => p -> p -> p -> p

enclose l r x wraps x in l and r.

encloseSep :: Printer p => p -> p -> p -> [p] -> p

list :: Printer p => [p] -> p

tupled :: Printer p => [p] -> p

surround :: Printer p => p -> p -> p -> p

surround x l r wraps x in l and r.

This is a reordering of enclose, but allows for convenient use in e.g. folds:

>>> 'foldr1' ('surround' ('pretty' ", ")) ['pretty' "apple", 'pretty' "banana"]
apple, banana

(<+>) :: Printer p => p -> p -> p infixr 6

Separate the arguments with a space.

(</>) :: Printer p => p -> p -> p infixr 6

Separate the arguments with a line.

Conditional combinators

parensIf :: Printer p => Bool -> p -> p

Conditional parenthesization of a printer. Analogous to showParen, but for printers.

Symbols

space :: Printer p => p

line :: Printer p => p

line' :: Printer p => p

softline :: Printer p => p

softline' :: Printer p => p

hardline :: Printer p => p

lparen :: Printer p => p

rparen :: Printer p => p

lbracket :: Printer p => p

rbracket :: Printer p => p

lbrace :: Printer p => p

rbrace :: Printer p => p

langle :: Printer p => p

rangle :: Printer p => p

squote :: Printer p => p

dquote :: Printer p => p

semi :: Printer p => p

comma :: Printer p => p

colon :: Printer p => p

dot :: Printer p => p

slash :: Printer p => p

backslash :: Printer p => p

equals :: Printer p => p

pipe :: Printer p => p

Re-exports

class Pretty a

Minimal complete definition

pretty

Instances

Pretty Bool

Defined in Prettyprinter.Internal

Methods

pretty :: Bool -> Doc ann

prettyList :: [Bool] -> Doc ann

Pretty Char

Defined in Prettyprinter.Internal

Methods

pretty :: Char -> Doc ann

prettyList :: [Char] -> Doc ann

Pretty Double

Defined in Prettyprinter.Internal

Methods

pretty :: Double -> Doc ann

prettyList :: [Double] -> Doc ann

Pretty Float

Defined in Prettyprinter.Internal

Methods

pretty :: Float -> Doc ann

prettyList :: [Float] -> Doc ann

Pretty Int

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

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 ()

Defined in Prettyprinter.Internal

Methods

pretty :: () -> Doc ann

prettyList :: [()] -> Doc ann

Pretty Void

Defined in Prettyprinter.Internal

Methods

pretty :: Void -> Doc ann

prettyList :: [Void] -> Doc ann

Pretty Text

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty Text

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty a => Pretty [a]

Defined in Prettyprinter.Internal

Methods

pretty :: [a] -> Doc ann

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

Pretty a => Pretty (Maybe a)

Defined in Prettyprinter.Internal

Methods

pretty :: Maybe a -> Doc ann

prettyList :: [Maybe a] -> Doc ann

Pretty a => Pretty (Identity a)

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)

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)

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 PageWidth

Constructors

AvailablePerLine !Int !Double

Unbounded

Instances

Eq PageWidth

Defined in Prettyprinter.Internal

Methods

(==) :: PageWidth -> PageWidth -> Bool

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

Ord PageWidth

Defined in Prettyprinter.Internal

Methods

compare :: PageWidth -> PageWidth -> Ordering

(<) :: PageWidth -> PageWidth -> Bool

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

(>) :: PageWidth -> PageWidth -> Bool

(>=) :: PageWidth -> PageWidth -> Bool

max :: PageWidth -> PageWidth -> PageWidth

min :: PageWidth -> PageWidth -> PageWidth

Show PageWidth

Defined in Prettyprinter.Internal

Methods

showsPrec :: Int -> PageWidth -> ShowS

show :: PageWidth -> String

showList :: [PageWidth] -> ShowS