Text.Printer

Monoids with a homomorphism from String to themselves.

The class

class (IsString p, Monoid p) => Printer p where

Text monoid. string must be equivalent to fromString and be a monoid homomorphism, i.e. string mempty = mempty and mappend (string x) (string y) = string (mappend x y). Other operations must be monoid homomorphisms that are eqiuvalent (but possibly faster) to the composition of string and the corresponding embedding, e.g. text = string . unpack.

Methods

char :: Char -> p

Print a character. char c must be equivalent to string [c], but hopefully is faster.

char7 :: Char -> p

Print an ASCII character, can be faster than char.

string :: String -> p

Print a string.

string7 :: String -> p

Print an ASCII string, can be faster than string.

text :: Text -> p

Print a Text.

lazyText :: Text -> p

Print a lazy Text.

ascii :: ByteString -> p

Print an ASCII ByteString.

lazyAscii :: ByteString -> p

Print a lazy ASCII ByteString.

utf8 :: ByteString -> p

Print a UTF-8 ByteString.

lazyUtf8 :: ByteString -> p

Print a lazy UTF-8 ByteString

Instances

Printer String

Printer Doc

Printer Builder

Printer Utf8Builder

Printer AsciiBuilder

Printer StringBuilder

Printer p => Printer (LinePrinter p)

Builders

newtype StringBuilder

A simple string builder as used by Show.

Constructors

StringBuilder

Fields

stringBuilder :: String -> String

Instances

Typeable StringBuilder

IsString StringBuilder

Monoid StringBuilder

Printer StringBuilder

buildString :: StringBuilder -> String

newtype AsciiBuilder

Use this builder when you are sure that only ASCII characters will get printed to it.

Constructors

AsciiBuilder

Fields

asciiBuilder :: Builder

Instances

Typeable AsciiBuilder

IsString AsciiBuilder

Monoid AsciiBuilder

Printer AsciiBuilder

buildAscii :: AsciiBuilder -> ByteString

newtype Utf8Builder

UTF-8 lazy ByteString builder.

Constructors

Utf8Builder

Fields

utf8Builder :: Builder

Instances

Typeable Utf8Builder

IsString Utf8Builder

Monoid Utf8Builder

Printer Utf8Builder

buildUtf8 :: Utf8Builder -> ByteString

Combinators

(<>) :: Monoid m => m -> m -> m

An infix synonym for mappend.

hcat :: (Printer p, Foldable f) => f p -> p

mconcat for Foldable data structures.

fcat :: (Foldable f, Printer p) => (p -> p -> p) -> f p -> p

Combine the items of a Foldable data structure using the provided function. If the data structure is empty, mempty is returned.

separate

Arguments

:: Printer p

=> p

The separator

-> p

-> p

-> p

Concatenate two Printers with a separator between them.

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

Concatenate two Printers with a space between them.

hsep :: (Printer p, Foldable f) => f p -> p

Concatenate the items of a Foldable data structure with spaces between them.

fsep :: (Foldable f, Printer p) => p -> f p -> p

A shorthand for fcat . separate.

list :: (Foldable f, Printer p) => f p -> p

Concatenate the items of a Foldable data structure with commas between them.

   list = fsep (char7 ',')

parens :: Printer p => p -> p

Enclose a Printer with parentheses.

brackets :: Printer p => p -> p

Enclose a Printer with square brackets.

braces :: Printer p => p -> p

Enclose a Printer with curly braces.

angles :: Printer p => p -> p

Enclose a Printer with angle brackets.

squotes :: Printer p => p -> p

Enclose a Printer with single quotes.

dquotes :: Printer p => p -> p

Enclose a Printer with double quotes.

punctuateL :: (Traversable t, Printer p) => p -> t p -> t p

Prepend all but the first element of a Traversable with the provided value, e.g. punctuateL p [x1, x2, ..., xN] = [x1, p <> x2, ..., p <> xN]

punctuateR :: (Traversable t, Printer p) => p -> t p -> t p

Append the provided value to all but the last element of a Traversable, e.g. punctuateR p [x1, ..., xN-1, xN] = [x1 <> p, ..., xN-1 <> p, xN]

Number printers

unsignedBinary :: (Num α, Bits α, Printer p) => α -> p

Print an unsigned number in the binary numeral system.

unsignedOctal :: (Num α, Bits α, Printer p) => α -> p

Print an unsigned number in the octal numeral system.

unsignedUpHex :: (Num α, Bits α, Printer p) => α -> p

Print an unsigned number in the hexadecimal numeral system using upper case digits.

unsignedLowHex :: (Num α, Bits α, Printer p) => α -> p

Print an unsigned number in the hexadecimal numeral system using lower case digits.

unsignedDecimal :: (Integral α, Printer p) => α -> p

Print an unsigned number in the decimal numeral system.

binary'

Arguments

:: (Ord α, Num α, Bits α, Printer p)

=> p

Prefix for negative values

-> p

Prefix for the zero

-> p

Prefix for positive values

-> α

-> p

Print a number in the binary numeral system.

binary :: (Ord α, Num α, Bits α, Printer p) => α -> p

Print a number in the binary numeral system. Negative values are prefixed with "-0b", postive values are prefixed with "0b".

octal'

Arguments

:: (Ord α, Num α, Bits α, Printer p)

=> p

Prefix for negative values

-> p

Prefix for the zero

-> p

Prefix for positive values

-> α

-> p

Print a number in the octal numeral system.

octal :: (Ord α, Num α, Bits α, Printer p) => α -> p

Print a number in the octal numeral system. Negative values are prefixed with "-0o", postive values are prefixed with "0o".

lowHex'

Arguments

:: (Ord α, Num α, Bits α, Printer p)

=> p

Prefix for negative values

-> p

Prefix for the zero

-> p

Prefix for postive values

-> α

-> p

Print a number in the hexadecimal numeral system using lower case digits.

lowHex :: (Ord α, Num α, Bits α, Printer p) => α -> p

Print a number in the hexadecimal numeral system using lower case digits. Negative values are prefixed with "-0x", positive values are prefixed with "0x".

upHex'

Arguments

:: (Ord α, Num α, Bits α, Printer p)

=> p

Prefix for negative values

-> p

Prefix for the zero

-> p

Prefix for postive values

-> α

-> p

Print a number in the hexadecimal numeral system using upper case digits.

upHex :: (Ord α, Num α, Bits α, Printer p) => α -> p

Print a number in the hexadecimal numeral system using upper case digits. Negative values are prefixed with "-0x", positive values are prefixed with "0x".

decimal'

Arguments

:: (Integral α, Printer p)

=> p

Prefix for negative values

-> p

Prefix for the zero

-> p

Prefix for postive values

-> α

-> p

Print a number in the decimal numeral system.

decimal :: (Integral α, Printer p) => α -> p

Print a number in the decimal numeral system. Negative values are prefixed with "-".

Multiline printers

class Printer p => MultilinePrinter p where

Printers that can produce multiple lines of text.

Methods

(<->) :: p -> p -> p

Combine two lines. Must be associative, i.e. x <-> (y <-> z) = (x <-> y) <-> z.

Instances

MultilinePrinter Doc

Printer p => MultilinePrinter (LinePrinter p)

lines :: (MultilinePrinter p, Foldable f) => f p -> p

Combine the items of a Foldable data structure with <->.

newLine :: Printer p => p

Print the LF character ('\n').

crlf :: Printer p => p

Print CR ('\r') followed by LF ('\n').

newtype LinePrinter p

A multiline printer that combines lines with the provided function.

Constructors

LinePrinter

Fields

linePrinter :: (p -> p -> p) -> p

Instances

Typeable1 LinePrinter

IsString p => IsString (LinePrinter p)

Monoid p => Monoid (LinePrinter p)

Printer p => MultilinePrinter (LinePrinter p)

Printer p => Printer (LinePrinter p)

lfPrinter :: Printer p => LinePrinter p -> p

Separate lines with newLine.

crlfPrinter :: Printer p => LinePrinter p -> p

Separate lines with crlf.

Default printers

class Printable α where

The default printer for values of a type.

Methods

print :: Printer p => α -> p

printList :: Printer p => [α] -> p

Instances

Printable Char

Printable Double

Printable Float

Printable Int

Printable Int8

Printable Int16

Printable Int32

Printable Int64

Printable Integer

Printable Word

Printable Word8

Printable Word16

Printable Word32

Printable Word64

Printable ()

Printable Text

Printable Text

Printable α => Printable [α]

(Printable α, Printable β) => Printable (α, β)

(Printable α, Printable β, Printable γ) => Printable (α, β, γ)

(Printable α, Printable β, Printable γ, Printable δ) => Printable (α, β, γ, δ)

defaultPrintList :: (Printable α, Printer p) => [α] -> p

toString :: Printable α => α -> String

Print a Printable value via StringBuilder, i.e. toString = buildString . print.