Copyright	(c) Sergey Vinokurov 2018
License	Apache-2.0 (see LICENSE)
Maintainer	serg.foo@gmail.com
Safe Haskell	Safe-Inferred
Language	GHC2021

Prettyprinter.Show

Contents

Reexports

Description

Synopsis

ppShow :: Show a => a -> Doc ann
newtype PPShow a = PPShow {
- unPPShow :: a
}
class Pretty a where
- pretty :: a -> Doc ann
- prettyList :: [a] -> Doc ann

Documentation

ppShow :: Show a => a -> Doc ann Source #

newtype PPShow a Source #

Helper to use Show-based prettyprinting with DerivingVia.

>>> :{
data TestWithDeriving a b = TestWithDeriving
  { testSet         :: Maybe (Set a)
  , testB           :: b
  , testIntMap      :: IntMap String
  , testComplexMap  :: Map (Maybe (Set Int)) (IntMap (Set String))
  }
  deriving (Show)
  deriving Pretty via PPShow (TestWithDeriving a b)
:}

Constructors

PPShow
Fields unPPShow :: a

Instances

Instances details

Show a => Pretty (PPShow a) Source #
Instance details Defined in Prettyprinter.Show Methods pretty :: PPShow a -> Doc ann # prettyList :: [PPShow a] -> Doc ann #

Reexports

class Pretty a where #

Overloaded conversion to Doc.

Laws:

output should be pretty. :-)

Minimal complete definition

pretty

Methods

pretty :: a -> Doc ann #

>>> pretty 1 <+> pretty "hello" <+> pretty 1.234
1 hello 1.234

prettyList :: [a] -> Doc ann #

prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

>>> prettyList [1, 23, 456]
[1, 23, 456]

Instances

Instances details

Pretty Void	Finding a good example for printing something that does not exist is hard, so here is an example of printing a list full of nothing. `>>>` `pretty ([] :: [Void])`[]
Instance details Defined in Prettyprinter.Internal Methods pretty :: Void -> Doc ann # prettyList :: [Void] -> Doc ann #
Pretty Int16
Instance details Defined in Prettyprinter.Internal Methods pretty :: Int16 -> Doc ann # prettyList :: [Int16] -> Doc ann #
Pretty Int32
Instance details Defined in Prettyprinter.Internal Methods pretty :: Int32 -> Doc ann # prettyList :: [Int32] -> Doc ann #
Pretty Int64
Instance details Defined in Prettyprinter.Internal Methods pretty :: Int64 -> Doc ann # prettyList :: [Int64] -> Doc ann #
Pretty Int8
Instance details Defined in Prettyprinter.Internal Methods pretty :: Int8 -> Doc ann # prettyList :: [Int8] -> Doc ann #
Pretty Word16
Instance details Defined in Prettyprinter.Internal Methods pretty :: Word16 -> Doc ann # prettyList :: [Word16] -> Doc ann #
Pretty Word32
Instance details Defined in Prettyprinter.Internal Methods pretty :: Word32 -> Doc ann # prettyList :: [Word32] -> Doc ann #
Pretty Word64
Instance details Defined in Prettyprinter.Internal Methods pretty :: Word64 -> Doc ann # prettyList :: [Word64] -> Doc ann #
Pretty Word8
Instance details Defined in Prettyprinter.Internal Methods pretty :: Word8 -> Doc ann # prettyList :: [Word8] -> Doc ann #
Pretty Text	Automatically converts all newlines to `line`. `>>>` `pretty ("hello\nworld" :: Text)`hello world Note that `line` can be undone by `group`: `>>>` `group (pretty ("hello\nworld" :: Text))`hello world Manually use `hardline` if you definitely want newlines.
Instance details Defined in Prettyprinter.Internal Methods pretty :: Text -> Doc ann # prettyList :: [Text] -> Doc ann #
Pretty Text	(lazy `Doc` instance, identical to the strict version)
Instance details Defined in Prettyprinter.Internal Methods pretty :: Text -> Doc ann # prettyList :: [Text] -> Doc ann #
Pretty Integer	`>>>` `pretty (2^123 :: Integer)`10633823966279326983230456482242756608
Instance details Defined in Prettyprinter.Internal Methods pretty :: Integer -> Doc ann # prettyList :: [Integer] -> Doc ann #
Pretty Natural
Instance details Defined in Prettyprinter.Internal Methods pretty :: Natural -> Doc ann # prettyList :: [Natural] -> Doc ann #
Pretty ()	`>>>` `pretty ()`() The argument is not used: `>>>` `pretty (error "Strict?" :: ())`()
Instance details Defined in Prettyprinter.Internal Methods pretty :: () -> Doc ann # prettyList :: [()] -> Doc ann #
Pretty Bool	`>>>` `pretty True`True
Instance details Defined in Prettyprinter.Internal Methods pretty :: Bool -> Doc ann # prettyList :: [Bool] -> Doc ann #
Pretty Char	Instead of `(pretty 'n')`, consider using `line` as a more readable alternative. `>>>` `pretty 'f' <> pretty 'o' <> pretty 'o'`foo `>>>` `pretty ("string" :: String)`string
Instance details Defined in Prettyprinter.Internal Methods pretty :: Char -> Doc ann # prettyList :: [Char] -> Doc ann #
Pretty Double	`>>>` `pretty (exp 1 :: Double)`2.71828182845904...
Instance details Defined in Prettyprinter.Internal Methods pretty :: Double -> Doc ann # prettyList :: [Double] -> Doc ann #
Pretty Float	`>>>` `pretty (pi :: Float)`3.1415927
Instance details Defined in Prettyprinter.Internal Methods pretty :: Float -> Doc ann # prettyList :: [Float] -> Doc ann #
Pretty Int	`>>>` `pretty (123 :: Int)`123
Instance details Defined in Prettyprinter.Internal Methods pretty :: Int -> Doc ann # prettyList :: [Int] -> Doc ann #
Pretty Word
Instance details Defined in Prettyprinter.Internal Methods pretty :: Word -> Doc ann # prettyList :: [Word] -> Doc ann #
Pretty a => Pretty (Identity a)	`>>>` `pretty (Identity 1)`1
Instance details Defined in Prettyprinter.Internal Methods pretty :: Identity a -> Doc ann # prettyList :: [Identity a] -> Doc ann #
Pretty a => Pretty (NonEmpty a)
Instance details Defined in Prettyprinter.Internal Methods pretty :: NonEmpty a -> Doc ann # prettyList :: [NonEmpty a] -> Doc ann #
(Generic a, GPretty (Rep a)) => Pretty (PPGeneric a) Source #
Instance details Defined in Prettyprinter.Generics Methods pretty :: PPGeneric a -> Doc ann # prettyList :: [PPGeneric a] -> Doc ann #
Show a => Pretty (PPShow a) Source #
Instance details Defined in Prettyprinter.Show Methods pretty :: PPShow a -> Doc ann # prettyList :: [PPShow a] -> Doc ann #
Pretty a => Pretty (Maybe a)	Ignore `Nothing`s, print `Just` contents. `>>>` `pretty (Just True)`True `>>>` `braces (pretty (Nothing :: Maybe Bool))`{} `>>>` `pretty [Just 1, Nothing, Just 3, Nothing]`[1, 3]
Instance details Defined in Prettyprinter.Internal Methods pretty :: Maybe a -> Doc ann # prettyList :: [Maybe a] -> Doc ann #
Pretty a => Pretty [a]	`>>>` `pretty [1,2,3]`[1, 2, 3]
Instance details Defined in Prettyprinter.Internal Methods pretty :: [a] -> Doc ann # prettyList :: [[a]] -> Doc ann #
(Pretty k, Pretty v) => Pretty (MapEntry k v) Source #
Instance details Defined in Prettyprinter.Combinators Methods pretty :: MapEntry k v -> Doc ann # prettyList :: [MapEntry k v] -> Doc ann #
(Pretty a1, Pretty a2) => Pretty (a1, a2)	`>>>` `pretty (123, "hello")`(123, hello)
Instance details Defined in Prettyprinter.Internal Methods pretty :: (a1, a2) -> Doc ann # prettyList :: [(a1, a2)] -> Doc ann #
Pretty a => Pretty (Const a b)
Instance details Defined in Prettyprinter.Internal Methods pretty :: Const a b -> Doc ann # prettyList :: [Const a b] -> Doc ann #
(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)	`>>>` `pretty (123, "hello", False)`(123, hello, False)
Instance details Defined in Prettyprinter.Internal Methods pretty :: (a1, a2, a3) -> Doc ann # prettyList :: [(a1, a2, a3)] -> Doc ann #