Type.Check.HM.Pretty

Pretty printer for types and terms.

Documentation

type PrettyVar a = (Pretty a, PrintCons a, IsVar a)

data FixityCtx var a

Type to querry fixity of infix operations in type variables.

Constructors

FixityCtx

Fields

• fixity'context :: var -> Maybe OpFix

  Function that provides fixity-type for a given variable

• fixity'data :: a

  content

Instances

(Pretty loc, PrettyVar var) => Pretty (FixityCtx var (TypeError loc var))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx var (TypeError loc var) -> Doc ann

prettyList :: [FixityCtx var (TypeError loc var)] -> Doc ann

(PrettyVar v, Pretty prim) => Pretty (FixityCtx v (Term prim loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Term prim loc v) -> Doc ann

prettyList :: [FixityCtx v (Term prim loc v)] -> Doc ann

PrettyVar v => Pretty (FixityCtx v (Type loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Type loc v) -> Doc ann

prettyList :: [FixityCtx v (Type loc v)] -> Doc ann

PrettyVar v => Pretty (FixityCtx v (Signature loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Signature loc v) -> Doc ann

prettyList :: [FixityCtx v (Signature loc v)] -> Doc ann

class PrintCons v where

This class is useful to define the way to print special cases like constructors for tuples or lists.

Methods

printCons :: v -> [Doc ann] -> Doc ann

Instances

PrintCons Int

Defined in Type.Check.HM.Pretty

Methods

printCons :: Int -> [Doc ann] -> Doc ann

PrintCons String

Defined in Type.Check.HM.Pretty

Methods

printCons :: String -> [Doc ann] -> Doc ann

PrintCons Text

Defined in Type.Check.HM.Pretty

Methods

printCons :: Text -> [Doc ann] -> Doc ann

data OpFix

Defines fixity type and order of infix operation

Constructors

OpFix

Fields

• opFix'fixity :: !Fixity

  fixity type

• opFix'prec :: !Int

  fixity order

data Fixity

Infix operation can be left or right associative or associativity is not known.

Constructors

FixLeft

FixRight

FixNone

Instances

Eq Fixity

Defined in Type.Check.HM.Pretty

Methods

(==) :: Fixity -> Fixity -> Bool

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

class Pretty a where

Overloaded conversion to Doc.

Laws:

1. 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

Pretty Bool

>>> pretty True
True

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

Defined in Prettyprinter.Internal

Methods

pretty :: Char -> Doc ann

prettyList :: [Char] -> Doc ann

Pretty Double

>>> pretty (exp 1 :: Double)
2.71828182845904...

Defined in Prettyprinter.Internal

Methods

pretty :: Double -> Doc ann

prettyList :: [Double] -> Doc ann

Pretty Float

>>> pretty (pi :: Float)
3.1415927

Defined in Prettyprinter.Internal

Methods

pretty :: Float -> Doc ann

prettyList :: [Float] -> Doc ann

Pretty Int

>>> pretty (123 :: Int)
123

Defined in Prettyprinter.Internal

Methods

pretty :: Int -> Doc ann

prettyList :: [Int] -> Doc ann

Pretty Int8

Defined in Prettyprinter.Internal

Methods

pretty :: Int8 -> Doc ann

prettyList :: [Int8] -> Doc ann

Pretty Int16

Defined in Prettyprinter.Internal

Methods

pretty :: Int16 -> Doc ann

prettyList :: [Int16] -> Doc ann

Pretty Int32

Defined in Prettyprinter.Internal

Methods

pretty :: Int32 -> Doc ann

prettyList :: [Int32] -> Doc ann

Pretty Int64

Defined in Prettyprinter.Internal

Methods

pretty :: Int64 -> Doc ann

prettyList :: [Int64] -> Doc ann

Pretty Integer

>>> pretty (2^123 :: Integer)
10633823966279326983230456482242756608

Defined in Prettyprinter.Internal

Methods

pretty :: Integer -> Doc ann

prettyList :: [Integer] -> Doc ann

Pretty Natural

Defined in Prettyprinter.Internal

Methods

pretty :: Natural -> Doc ann

prettyList :: [Natural] -> Doc ann

Pretty Word

Defined in Prettyprinter.Internal

Methods

pretty :: Word -> Doc ann

prettyList :: [Word] -> Doc ann

Pretty Word8

Defined in Prettyprinter.Internal

Methods

pretty :: Word8 -> Doc ann

prettyList :: [Word8] -> Doc ann

Pretty Word16

Defined in Prettyprinter.Internal

Methods

pretty :: Word16 -> Doc ann

prettyList :: [Word16] -> Doc ann

Pretty Word32

Defined in Prettyprinter.Internal

Methods

pretty :: Word32 -> Doc ann

prettyList :: [Word32] -> Doc ann

Pretty Word64

Defined in Prettyprinter.Internal

Methods

pretty :: Word64 -> Doc ann

prettyList :: [Word64] -> Doc ann

Pretty ()

>>> pretty ()
()

The argument is not used,

>>> pretty (error "Strict?" :: ())
()

Defined in Prettyprinter.Internal

Methods

pretty :: () -> Doc ann

prettyList :: [()] -> Doc ann

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])
[]

Defined in Prettyprinter.Internal

Methods

pretty :: Void -> Doc ann

prettyList :: [Void] -> Doc ann

Pretty Text

(lazy Text instance, identical to the strict version)

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> 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.

Defined in Prettyprinter.Internal

Methods

pretty :: Text -> Doc ann

prettyList :: [Text] -> Doc ann

Pretty a => Pretty [a]

>>> pretty [1,2,3]
[1, 2, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: [a] -> Doc ann

prettyList :: [[a]] -> Doc ann

Pretty a => Pretty (Maybe a)

Ignore Nothings, print Just contents.

>>> pretty (Just True)
True
>>> braces (pretty (Nothing :: Maybe Bool))
{}

>>> pretty [Just 1, Nothing, Just 3, Nothing]
[1, 3]

Defined in Prettyprinter.Internal

Methods

pretty :: Maybe a -> Doc ann

prettyList :: [Maybe a] -> Doc ann

Pretty a => Pretty (Identity a)

>>> pretty (Identity 1)
1

Defined in Prettyprinter.Internal

Methods

pretty :: Identity a -> Doc ann

prettyList :: [Identity a] -> Doc ann

Pretty a => Pretty (NonEmpty a)

Defined in Prettyprinter.Internal

Methods

pretty :: NonEmpty a -> Doc ann

prettyList :: [NonEmpty a] -> Doc ann

(Pretty a1, Pretty a2) => Pretty (a1, a2)

>>> pretty (123, "hello")
(123, hello)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2) -> Doc ann

prettyList :: [(a1, a2)] -> Doc ann

PrettyVar v => Pretty (Type loc v)

Defined in Type.Check.HM.Pretty

Methods

pretty :: Type loc v -> Doc ann

prettyList :: [Type loc v] -> Doc ann

PrettyVar v => Pretty (Signature loc v)

Defined in Type.Check.HM.Pretty

Methods

pretty :: Signature loc v -> Doc ann

prettyList :: [Signature loc v] -> Doc ann

(Pretty loc, PrettyVar var) => Pretty (TypeError loc var)

Defined in Type.Check.HM.Pretty

Methods

pretty :: TypeError loc var -> Doc ann

prettyList :: [TypeError loc var] -> Doc ann

(Pretty loc, PrettyVar var) => Pretty (FixityCtx var (TypeError loc var))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx var (TypeError loc var) -> Doc ann

prettyList :: [FixityCtx var (TypeError loc var)] -> Doc ann

(PrettyVar v, Pretty prim) => Pretty (FixityCtx v (Term prim loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Term prim loc v) -> Doc ann

prettyList :: [FixityCtx v (Term prim loc v)] -> Doc ann

PrettyVar v => Pretty (FixityCtx v (Type loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Type loc v) -> Doc ann

prettyList :: [FixityCtx v (Type loc v)] -> Doc ann

PrettyVar v => Pretty (FixityCtx v (Signature loc v))

Defined in Type.Check.HM.Pretty

Methods

pretty :: FixityCtx v (Signature loc v) -> Doc ann

prettyList :: [FixityCtx v (Signature loc v)] -> Doc ann

(Pretty a1, Pretty a2, Pretty a3) => Pretty (a1, a2, a3)

>>> pretty (123, "hello", False)
(123, hello, False)

Defined in Prettyprinter.Internal

Methods

pretty :: (a1, a2, a3) -> Doc ann

prettyList :: [(a1, a2, a3)] -> Doc ann

Pretty a => Pretty (Const a b)

Defined in Prettyprinter.Internal

Methods

pretty :: Const a b -> Doc ann

prettyList :: [Const a b] -> Doc ann

(PrettyVar v, Pretty prim) => Pretty (Term prim loc v)

Defined in Type.Check.HM.Pretty

Methods

pretty :: Term prim loc v -> Doc ann

prettyList :: [Term prim loc v] -> Doc ann

Orphan instances

PrettyVar v => Pretty (Type loc v)

Methods

pretty :: Type loc v -> Doc ann

prettyList :: [Type loc v] -> Doc ann

PrettyVar v => Pretty (Signature loc v)

Methods

pretty :: Signature loc v -> Doc ann

prettyList :: [Signature loc v] -> Doc ann

(Pretty loc, PrettyVar var) => Pretty (TypeError loc var)

Methods

pretty :: TypeError loc var -> Doc ann

prettyList :: [TypeError loc var] -> Doc ann

(PrettyVar v, Pretty prim) => Pretty (Term prim loc v)

Methods

pretty :: Term prim loc v -> Doc ann

prettyList :: [Term prim loc v] -> Doc ann