Futhark.Util.Pretty

A re-export of the prettyprinting library, along with some convenience functions.

Rendering to texts

prettyTuple :: Pretty a => [a] -> Text

Prettyprint a list enclosed in curly braces.

prettyTupleLines :: Pretty a => [a] -> Text

Like prettyTuple, but put a linebreak after every element.

prettyString :: Pretty a => a -> String

Prettyprint a value to a String, appropriately wrapped.

prettyText :: Pretty a => a -> Text

Prettyprint a value to a Text, appropriately wrapped.

prettyTextOneLine :: Pretty a => a -> Text

Prettyprint a value to a Text on a single line.

docText :: Doc a -> Text

Convert a Doc to text. Thsi ignores any annotations (i.e. it will be non-coloured output).

docTextForHandle :: Handle -> Doc AnsiStyle -> IO Text

Produce text suitable for printing on the given handle. This mostly means stripping any control characters if the handle is not a terminal.

Rendering to terminal

putDoc :: Doc AnsiStyle -> IO ()

Like hPutDoc, but to stdout.

hPutDoc :: Handle -> Doc AnsiStyle -> IO ()

Print a doc with styling to the given file; stripping colors if the file does not seem to support such things.

putDocLn :: Doc AnsiStyle -> IO ()

Like putDoc, but with a final newline.

hPutDocLn :: Handle -> Doc AnsiStyle -> IO ()

Like hPutDoc, but with a final newline.

Building blocks

module Prettyprinter

module Prettyprinter.Symbols.Ascii

bold :: AnsiStyle

Render in bold.

bgColorDull :: Color -> AnsiStyle

Style the background with a dull color.

colorDull :: Color -> AnsiStyle

Style the foreground with a dull color.

bgColor :: Color -> AnsiStyle

Style the background with a vivid color.

color :: Color -> AnsiStyle

Style the foreground with a vivid color.

data Color

The 8 ANSI terminal colors.

Constructors

Black

Red

Green

Yellow

Blue

Magenta

Cyan

White

Instances

Show Color

Defined in Prettyprinter.Render.Terminal.Internal

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Eq Color

Defined in Prettyprinter.Render.Terminal.Internal

Methods

(==) :: Color -> Color -> Bool

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

Ord Color

Defined in Prettyprinter.Render.Terminal.Internal

Methods

compare :: Color -> Color -> Ordering

(<) :: Color -> Color -> Bool

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

(>) :: Color -> Color -> Bool

(>=) :: Color -> Color -> Bool

max :: Color -> Color -> Color

min :: Color -> Color -> Color

data AnsiStyle

Render the annotated document in a certain style. Styles not set in the annotation will use the style of the surrounding document, or the terminal’s default if none has been set yet.

style = color Green <> bold
styledDoc = annotate style "hello world"

Instances

Monoid AnsiStyle

mempty does nothing, which is equivalent to inheriting the style of the surrounding doc, or the terminal’s default if no style has been set yet.

Defined in Prettyprinter.Render.Terminal.Internal

Methods

mempty :: AnsiStyle

mappend :: AnsiStyle -> AnsiStyle -> AnsiStyle

mconcat :: [AnsiStyle] -> AnsiStyle

Semigroup AnsiStyle

Keep the first decision for each of foreground color, background color, boldness, italication, and underlining. If a certain style is not set, the terminal’s default will be used.

Example:

color Red <> color Green

is red because the first color wins, and not bold because (or if) that’s the terminal’s default.

Defined in Prettyprinter.Render.Terminal.Internal

Methods

(<>) :: AnsiStyle -> AnsiStyle -> AnsiStyle

sconcat :: NonEmpty AnsiStyle -> AnsiStyle

stimes :: Integral b => b -> AnsiStyle -> AnsiStyle

Show AnsiStyle

Defined in Prettyprinter.Render.Terminal.Internal

Methods

showsPrec :: Int -> AnsiStyle -> ShowS

show :: AnsiStyle -> String

showList :: [AnsiStyle] -> ShowS

Eq AnsiStyle

Defined in Prettyprinter.Render.Terminal.Internal

Methods

(==) :: AnsiStyle -> AnsiStyle -> Bool

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

Ord AnsiStyle

Defined in Prettyprinter.Render.Terminal.Internal

Methods

compare :: AnsiStyle -> AnsiStyle -> Ordering

(<) :: AnsiStyle -> AnsiStyle -> Bool

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

(>) :: AnsiStyle -> AnsiStyle -> Bool

(>=) :: AnsiStyle -> AnsiStyle -> Bool

max :: AnsiStyle -> AnsiStyle -> AnsiStyle

min :: AnsiStyle -> AnsiStyle -> AnsiStyle

apply :: [Doc a] -> Doc a

The document apply ds separates ds with commas and encloses them with parentheses.

oneLine :: Doc a -> Doc a

Make sure that the given document is printed on just a single line.

annot :: [Doc a] -> Doc a -> Doc a

Stack and prepend a list of Docs to another Doc, separated by a linebreak. If the list is empty, the second Doc will be returned without a preceding linebreak.

nestedBlock :: Doc a -> Doc a -> Doc a -> Doc a

Surround the given document with enclosers and add linebreaks and indents.

textwrap :: Text -> Doc a

Splits the string into words and permits line breaks between all of them.

shorten :: Doc a -> Doc b

Prettyprint on a single line up to at most some appropriate number of characters, with trailing ... if necessary. Used for error messages.

commastack :: [Doc a] -> Doc a

Like commasep, but a newline after every comma.

commasep :: [Doc a] -> Doc a

Separate with commas.

semistack :: [Doc a] -> Doc a

Like semisep, but a newline after every semicolon.

semisep :: [Doc a] -> Doc a

Separate with semicolons.

stack :: [Doc a] -> Doc a

Separate with linebreaks.

parensIf :: Bool -> Doc a -> Doc a

The document parensIf p d encloses the document d in parenthesis if p is True, and otherwise yields just d.

ppTuple' :: [Doc a] -> Doc a

ppTupleLines' :: [Doc a] -> Doc a

Operators

(</>) :: Doc a -> Doc a -> Doc a

Orphan instances

Pretty Half

Methods

pretty :: Half -> Doc ann

prettyList :: [Half] -> Doc ann