Safe Haskell	Safe
Language	Haskell98

BuildBox.Pretty

Description

Pretty printing utils.

Synopsis

Documentation

class Pretty a where Source #

Minimal complete definition

ppr

Methods

ppr :: a -> Text Source #

Instances

Pretty Char Source #
Methods ppr :: Char -> Text Source #
Pretty Int Source #
Methods ppr :: Int -> Text Source #
Pretty Integer Source #
Methods ppr :: Integer -> Text Source #
Pretty String Source #
Methods ppr :: String -> Text Source #
Pretty Text Source #
Methods ppr :: Text -> Text Source #
Pretty UTCTime Source #
Methods ppr :: UTCTime -> Text Source #
Pretty Bytes Source #
Methods ppr :: Bytes -> Text Source #
Pretty Seconds Source #
Methods ppr :: Seconds -> Text Source #
Pretty Sized Source #
Methods ppr :: Sized -> Text Source #
Pretty Used Source #
Methods ppr :: Used -> Text Source #
Pretty Timed Source #
Methods ppr :: Timed -> Text Source #
Pretty BuildError Source #
Methods ppr :: BuildError -> Text Source #
Pretty Platform Source #
Methods ppr :: Platform -> Text Source #
Pretty Environment Source #
Methods ppr :: Environment -> Text Source #
Pretty a => Pretty (Range a) Source #
Methods ppr :: Range a -> Text Source #
Pretty a => Pretty (Comparison a) Source #
Methods ppr :: Comparison a -> Text Source #

data Text :: * #

A space efficient, packed, unboxed Unicode text type.

Instances

Pretty Text Source #
Methods ppr :: Text -> Text Source #
type Item Text
type Item Text = Char

(%) :: Text -> Text -> Text Source #

Append two text strings.

(%%) :: Text -> Text -> Text Source #

Append two text strings separated by a space.

empty :: Text Source #

An empty text string.

char :: Char -> Text Source #

Convert a single Char to text.

string :: String -> Text Source #

Convert a String to text.

text :: Text -> Text Source #

Convert a Text to Text (id).

vcat :: [Text] -> Text Source #

Concatenate a list of text vertically.

vsep :: [Text] -> Text Source #

Concatenate a list of text vertically, with blank lines in between.

hcat :: [Text] -> Text Source #

Concatenate a list of text.

hsep :: [Text] -> Text Source #

Concatenate a list of text, with spaces in between.

parens :: Text -> Text Source #

Wrap a text thing in round parens.

braces :: Text -> Text Source #

Wrap a text thing in round parens.

brackets :: Text -> Text Source #

Wrap a text thing in round parens.

angles :: Text -> Text Source #

Wrap a text thing in round parens.

indents :: Int -> [Text] -> Text Source #

Indent some text by the given number of characters.

padRc :: Int -> Char -> Text -> Text Source #

Right justify a doc, padding with a given character.

padR :: Int -> Text -> Text Source #

Right justify a string with spaces.

padLc :: Int -> Char -> Text -> Text Source #

Left justify a string, padding with a given character.

padL :: Int -> Text -> Text Source #

Left justify a string with spaces.

pprEngDouble :: String -> Double -> Maybe Text Source #

Pretty print an engineering value, to 4 significant figures. Valid range is 10^(-24) (y/yocto) to 10^(+24) (Y/Yotta). Out of range values yield Nothing.

examples:

  liftM render $ pprEngDouble "J" 102400    ==>   Just "1.024MJ"
  liftM render $ pprEngDouble "s" 0.0000123 ==>   Just "12.30us"

pprEngInteger :: String -> Integer -> Maybe Text Source #

Like pprEngDouble but don't display fractional part when the value is < 1000. Good for units where fractional values might not make sense (like bytes).