Moduletext-printer-0.5.0.2Haskell2010

Text.Printer

Monoids with a homomorphism from String to themselves.

5 types
2 classes
28 values

Packagetext-printer-0.5.0.2
Exports36
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePrinter.hs

The class

1 declaration

classclass (IsString p, Semigroup 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

Instances7Printer, …

Printer StringDefined in text-printer-0.5.0.2 · Text.Printer
Printer BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Printer StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer p => Printer (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer

Builders

12 declarations

newtypenewtype StringBuilder

A simple string builder as used by Show.

Constructors

StringBuilder
- stringBuilder :: String -> String

Instances6IsString, Generic, Semigroup, Monoid, Printer, Rep

IsString StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Generic StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Semigroup StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Monoid StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer StringBuilderDefined in text-printer-0.5.0.2 · Text.Printer
type Rep StringBuilder = D1 ('MetaData "StringBuilder" "Text.Printer" "text-printer-0.5.0.2-1bWqb3MFQIg8VOCQKIXP9Z" 'True) (C1 ('MetaCons "StringBuilder" 'PrefixI 'True) (S1 ('MetaSel ('Just "stringBuilder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (String -> String))))Defined in text-printer-0.5.0.2 · Text.Printer

valuebuildString :: StringBuilder -> String

valuebuildText :: Builder -> Text

valuebuildLazyText :: Builder -> Text

newtypenewtype AsciiBuilder

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

Constructors

AsciiBuilder
- asciiBuilder :: Builder

Instances6IsString, Generic, Semigroup, Monoid, Printer, Rep

IsString AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Generic AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Semigroup AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Monoid AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer AsciiBuilderDefined in text-printer-0.5.0.2 · Text.Printer
type Rep AsciiBuilder = D1 ('MetaData "AsciiBuilder" "Text.Printer" "text-printer-0.5.0.2-1bWqb3MFQIg8VOCQKIXP9Z" 'True) (C1 ('MetaCons "AsciiBuilder" 'PrefixI 'True) (S1 ('MetaSel ('Just "asciiBuilder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Builder)))Defined in text-printer-0.5.0.2 · Text.Printer

valuebuildAscii :: AsciiBuilder -> ByteString

valuebuildLazyAscii :: AsciiBuilder -> ByteString

newtypenewtype Utf8Builder

UTF-8 lazy ByteString builder.

Constructors

Utf8Builder
- utf8Builder :: Builder

Instances6IsString, Generic, Semigroup, Monoid, Printer, Rep

IsString Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Generic Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Semigroup Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Monoid Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
Printer Utf8BuilderDefined in text-printer-0.5.0.2 · Text.Printer
type Rep Utf8Builder = D1 ('MetaData "Utf8Builder" "Text.Printer" "text-printer-0.5.0.2-1bWqb3MFQIg8VOCQKIXP9Z" 'True) (C1 ('MetaCons "Utf8Builder" 'PrefixI 'True) (S1 ('MetaSel ('Just "utf8Builder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Builder)))Defined in text-printer-0.5.0.2 · Text.Printer

valuebuildUtf8 :: Utf8Builder -> ByteString

valuebuildLazyUtf8 :: Utf8Builder -> ByteString

newtypenewtype PrettyPrinter

Constructors

PrettyPrinter
- prettyPrinter :: Doc

Instances7IsString, Generic, Semigroup, Monoid, MultilinePrinter, Printer, …

IsString PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Generic PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Semigroup PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Monoid PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
MultilinePrinter PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Printer PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
type Rep PrettyPrinter = D1 ('MetaData "PrettyPrinter" "Text.Printer" "text-printer-0.5.0.2-1bWqb3MFQIg8VOCQKIXP9Z" 'True) (C1 ('MetaCons "PrettyPrinter" 'PrefixI 'True) (S1 ('MetaSel ('Just "prettyPrinter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Doc)))Defined in text-printer-0.5.0.2 · Text.Printer

valuerenderPretty :: PrettyPrinter -> String

An alias for render . prettyPrinter

Combinators

16 declarations

method(<>) :: a -> a -> a

An associative operation.

Examples

Example1 expression

>>> [1,2,3] <> [4,5,6][1,2,3,4,5,6]

Example1 expression

>>> Just [1, 2, 3] <> Just [4, 5, 6]Just [1,2,3,4,5,6]

Example1 expression

>>> putStr "Hello, " <> putStrLn "World!"Hello, World!

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

mconcat for Foldable data structures.

valuefcat :: (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.

valueseparate

:: Printer p
=> p
The separator
-> p
-> p
-> p

Concatenate two Printers with a separator between them.

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

Concatenate two Printers with a space between them.

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

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

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

A shorthand for fcat . separate.

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

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

  list = fsep (char7 ',')

valueparens :: Printer p => p -> p

Enclose a Printer with parentheses.

valuebrackets :: Printer p => p -> p

Enclose a Printer with square brackets.

valuebraces :: Printer p => p -> p

Enclose a Printer with curly braces.

valueangles :: Printer p => p -> p

Enclose a Printer with angle brackets.

valuesquotes :: Printer p => p -> p

Enclose a Printer with single quotes.

valuedquotes :: Printer p => p -> p

Enclose a Printer with double quotes.

valuepunctuateL :: (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]

valuepunctuateR :: (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]

Multiline printers

7 declarations

classclass Printer p => MultilinePrinter p where

Printers that can produce multiple lines of text.

Methods

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

Instances2MultilinePrinter

MultilinePrinter PrettyPrinterDefined in text-printer-0.5.0.2 · Text.Printer
Printer p => MultilinePrinter (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer

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

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

valuenewLine :: Printer p => p

Print the LF character ('n').

valuecrlf :: Printer p => p

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

newtypenewtype LinePrinter p

A multiline printer that combines lines with the provided function.

Constructors

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

Instances7IsString, Generic, Semigroup, Monoid, MultilinePrinter, Printer, …

IsString p => IsString (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
Generic (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
Semigroup p => Semigroup (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
Monoid p => Monoid (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
Printer p => MultilinePrinter (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
Printer p => Printer (LinePrinter p)Defined in text-printer-0.5.0.2 · Text.Printer
type Rep (LinePrinter p) = D1 ('MetaData "LinePrinter" "Text.Printer" "text-printer-0.5.0.2-1bWqb3MFQIg8VOCQKIXP9Z" 'True) (C1 ('MetaCons "LinePrinter" 'PrefixI 'True) (S1 ('MetaSel ('Just "linePrinter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ((p -> p -> p) -> p))))Defined in text-printer-0.5.0.2 · Text.Printer

valuelfPrinter :: Printer p => LinePrinter p -> p

Separate lines with newLine.

valuecrlfPrinter :: Printer p => LinePrinter p -> p

Separate lines with crlf.