Data.Portray

Provides a compatibility layer of Haskell-like terms for pretty-printers.

Syntax Tree

newtype Portrayal

The portrayal of a Haskell runtime value as a pseudo-Haskell syntax tree.

This can be rendered to various pretty-printing libraries' document types relatively easily; as such, it provides a lingua franca for integrating with pretty-printers, without incurring heavyweight dependencies.

Constructors

Portrayal

Fields

• unPortrayal :: Fix PortrayalF

Bundled Patterns

pattern Atom :: Text -> Portrayal

A single chunk of text included directly in the pretty-printed output.

This is used for things like literals and constructor names.

pattern Name :: Text -> Portrayal

Compatibility aid for portray-0.2.

Use this as Name "a_string_literal" or Name (fromString s) to support both 0.1 and 0.2.

pattern Opaque :: Text -> Portrayal

Compatibility aid for portray-0.2.

Use this with any Text argument to support both 0.1 and 0.2.

pattern Apply :: Portrayal -> [Portrayal] -> Portrayal

A function or constructor application of arbitrary arity.

Although we could have just unary function application, this gives backends a hint about how to format the result: for example, the "pretty" backend prints the function (parenthesized if non-atomic) followed by the arguments indented by two spaces; a chain of unary applications would be needlessly parenthesized.

Given:

    Apply "These" ["2", "4"]

We render something like These 2 4, or if line-wrapped:

    These
      2
      4

pattern Binop :: Text -> Infixity -> Portrayal -> Portrayal -> Portrayal

A binary operator application.

The fixity is used to avoid unnecessary parentheses, even in chains of operators of the same precedence.

Given:

    Binop "+" (infixl_ 6)
      [ Binop "+" (infixl_ 6) ["2", "4"]
      , "6"
      ]

We render something like: 2 + 4 + 6

pattern Tuple :: [Portrayal] -> Portrayal

A tuple.

Given Tuple ["2", "4"], we render something like (2, 4)

pattern List :: [Portrayal] -> Portrayal

A list literal.

Given:

    List [Apply "These" ["2", "4"], Apply "That" ["6"]]

We render something like:

    [ These 2 4
    , That 6
    ]

pattern LambdaCase :: [(Portrayal, Portrayal)] -> Portrayal

A lambda-case.

Given LambdaCase [("0", ""hi""), ("1", ""hello"")], we render something like case 0 -> "hi"; 1 -> "hello".

This can be useful in cases where meaningful values effectively appear in negative position in a type, like in a total map or table with non-integral indices.

pattern Record :: Portrayal -> [FactorPortrayal Portrayal] -> Portrayal

A record literal.

Given:

    Record "Identity" [FactorPortrayal "runIdentity" "2"]

We render something like:

    Identity
      { runIdentity = 2
      }

pattern TyApp :: Portrayal -> Portrayal -> Portrayal

A type application.

Given TyApp "Proxy" "Int", we render Proxy @Int

pattern TySig :: Portrayal -> Portrayal -> Portrayal

An explicit type signature.

Given TySig "Proxy" [Apply "Proxy" [Int]], we render Proxy :: Proxy Int

pattern Quot :: Text -> Portrayal -> Portrayal

A quasiquoter expression.

Given Quot "expr" (Binop "+" _ ["x", "!y"]), we render [expr| x + !y |]

pattern Unlines :: [Portrayal] -> Portrayal

A series of lines arranged vertically, if supported.

This is meant for use inside Quot, where it makes sense to use non-Haskell syntax.

pattern Nest :: Int -> Portrayal -> Portrayal

Indent a sub-expression by the given number of spaces.

This is meant for use inside Quot, where it makes sense to use non-Haskell syntax.

Instances

Eq Portrayal

Defined in Data.Portray

Methods

(==) :: Portrayal -> Portrayal -> Bool

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

Read Portrayal

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS Portrayal

readList :: ReadS [Portrayal]

readPrec :: ReadPrec Portrayal

readListPrec :: ReadPrec [Portrayal]

Show Portrayal

Defined in Data.Portray

Methods

showsPrec :: Int -> Portrayal -> ShowS

show :: Portrayal -> String

showList :: [Portrayal] -> ShowS

IsString Portrayal

Defined in Data.Portray

Methods

fromString :: String -> Portrayal

Generic Portrayal

Defined in Data.Portray

Associated Types

type Rep Portrayal :: Type -> Type

Methods

from :: Portrayal -> Rep Portrayal x

to :: Rep Portrayal x -> Portrayal

Portray Portrayal

Defined in Data.Portray

Methods

portray :: Portrayal -> Portrayal

type Rep Portrayal

Defined in Data.Portray

type Rep Portrayal = D1 ('MetaData "Portrayal" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'True) (C1 ('MetaCons "Portrayal" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPortrayal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Fix PortrayalF))))

data FactorPortrayal a

A Portrayal along with a field name; one piece of a record literal.

Constructors

FactorPortrayal

Fields

• _fpFieldName :: !Text
• _fpPortrayal :: !a

Instances

Functor FactorPortrayal

Defined in Data.Portray

Methods

fmap :: (a -> b) -> FactorPortrayal a -> FactorPortrayal b

(<$) :: a -> FactorPortrayal b -> FactorPortrayal a

Foldable FactorPortrayal

Defined in Data.Portray

Methods

fold :: Monoid m => FactorPortrayal m -> m

foldMap :: Monoid m => (a -> m) -> FactorPortrayal a -> m

foldMap' :: Monoid m => (a -> m) -> FactorPortrayal a -> m

foldr :: (a -> b -> b) -> b -> FactorPortrayal a -> b

foldr' :: (a -> b -> b) -> b -> FactorPortrayal a -> b

foldl :: (b -> a -> b) -> b -> FactorPortrayal a -> b

foldl' :: (b -> a -> b) -> b -> FactorPortrayal a -> b

foldr1 :: (a -> a -> a) -> FactorPortrayal a -> a

foldl1 :: (a -> a -> a) -> FactorPortrayal a -> a

toList :: FactorPortrayal a -> [a]

null :: FactorPortrayal a -> Bool

length :: FactorPortrayal a -> Int

elem :: Eq a => a -> FactorPortrayal a -> Bool

maximum :: Ord a => FactorPortrayal a -> a

minimum :: Ord a => FactorPortrayal a -> a

sum :: Num a => FactorPortrayal a -> a

product :: Num a => FactorPortrayal a -> a

Traversable FactorPortrayal

Defined in Data.Portray

Methods

traverse :: Applicative f => (a -> f b) -> FactorPortrayal a -> f (FactorPortrayal b)

sequenceA :: Applicative f => FactorPortrayal (f a) -> f (FactorPortrayal a)

mapM :: Monad m => (a -> m b) -> FactorPortrayal a -> m (FactorPortrayal b)

sequence :: Monad m => FactorPortrayal (m a) -> m (FactorPortrayal a)

Eq a => Eq (FactorPortrayal a)

Defined in Data.Portray

Methods

(==) :: FactorPortrayal a -> FactorPortrayal a -> Bool

(/=) :: FactorPortrayal a -> FactorPortrayal a -> Bool

Ord a => Ord (FactorPortrayal a)

Defined in Data.Portray

Methods

compare :: FactorPortrayal a -> FactorPortrayal a -> Ordering

(<) :: FactorPortrayal a -> FactorPortrayal a -> Bool

(<=) :: FactorPortrayal a -> FactorPortrayal a -> Bool

(>) :: FactorPortrayal a -> FactorPortrayal a -> Bool

(>=) :: FactorPortrayal a -> FactorPortrayal a -> Bool

max :: FactorPortrayal a -> FactorPortrayal a -> FactorPortrayal a

min :: FactorPortrayal a -> FactorPortrayal a -> FactorPortrayal a

Read a => Read (FactorPortrayal a)

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS (FactorPortrayal a)

readList :: ReadS [FactorPortrayal a]

readPrec :: ReadPrec (FactorPortrayal a)

readListPrec :: ReadPrec [FactorPortrayal a]

Show a => Show (FactorPortrayal a)

Defined in Data.Portray

Methods

showsPrec :: Int -> FactorPortrayal a -> ShowS

show :: FactorPortrayal a -> String

showList :: [FactorPortrayal a] -> ShowS

Generic (FactorPortrayal a)

Defined in Data.Portray

Associated Types

type Rep (FactorPortrayal a) :: Type -> Type

Methods

from :: FactorPortrayal a -> Rep (FactorPortrayal a) x

to :: Rep (FactorPortrayal a) x -> FactorPortrayal a

Portray a => Portray (FactorPortrayal a)

Defined in Data.Portray

Methods

portray :: FactorPortrayal a -> Portrayal

type Rep (FactorPortrayal a)

Defined in Data.Portray

type Rep (FactorPortrayal a) = D1 ('MetaData "FactorPortrayal" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'False) (C1 ('MetaCons "FactorPortrayal" 'PrefixI 'True) (S1 ('MetaSel ('Just "_fpFieldName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_fpPortrayal") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

Operator Fixity

data Assoc

Associativity of an infix operator.

Constructors

AssocL

AssocR

AssocNope

Instances

Eq Assoc

Defined in Data.Portray

Methods

(==) :: Assoc -> Assoc -> Bool

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

Ord Assoc

Defined in Data.Portray

Methods

compare :: Assoc -> Assoc -> Ordering

(<) :: Assoc -> Assoc -> Bool

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

(>) :: Assoc -> Assoc -> Bool

(>=) :: Assoc -> Assoc -> Bool

max :: Assoc -> Assoc -> Assoc

min :: Assoc -> Assoc -> Assoc

Read Assoc

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS Assoc

readList :: ReadS [Assoc]

readPrec :: ReadPrec Assoc

readListPrec :: ReadPrec [Assoc]

Show Assoc

Defined in Data.Portray

Methods

showsPrec :: Int -> Assoc -> ShowS

show :: Assoc -> String

showList :: [Assoc] -> ShowS

Generic Assoc

Defined in Data.Portray

Associated Types

type Rep Assoc :: Type -> Type

Methods

from :: Assoc -> Rep Assoc x

to :: Rep Assoc x -> Assoc

Portray Assoc

Defined in Data.Portray

Methods

portray :: Assoc -> Portrayal

type Rep Assoc

Defined in Data.Portray

type Rep Assoc = D1 ('MetaData "Assoc" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'False) (C1 ('MetaCons "AssocL" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AssocR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AssocNope" 'PrefixI 'False) (U1 :: Type -> Type)))

data Infixity

Associativity and binding precedence of an infix operator.

Constructors

Infixity !Assoc !Rational

Instances

Eq Infixity

Defined in Data.Portray

Methods

(==) :: Infixity -> Infixity -> Bool

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

Ord Infixity

Defined in Data.Portray

Methods

compare :: Infixity -> Infixity -> Ordering

(<) :: Infixity -> Infixity -> Bool

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

(>) :: Infixity -> Infixity -> Bool

(>=) :: Infixity -> Infixity -> Bool

max :: Infixity -> Infixity -> Infixity

min :: Infixity -> Infixity -> Infixity

Read Infixity

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS Infixity

readList :: ReadS [Infixity]

readPrec :: ReadPrec Infixity

readListPrec :: ReadPrec [Infixity]

Show Infixity

Defined in Data.Portray

Methods

showsPrec :: Int -> Infixity -> ShowS

show :: Infixity -> String

showList :: [Infixity] -> ShowS

Generic Infixity

Defined in Data.Portray

Associated Types

type Rep Infixity :: Type -> Type

Methods

from :: Infixity -> Rep Infixity x

to :: Rep Infixity x -> Infixity

Portray Infixity

Defined in Data.Portray

Methods

portray :: Infixity -> Portrayal

type Rep Infixity

Defined in Data.Portray

type Rep Infixity = D1 ('MetaData "Infixity" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'False) (C1 ('MetaCons "Infixity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Assoc) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Rational)))

infix_ :: Rational -> Infixity

Construct the Infixity corresponding to e.g. infix 6 +&&+*

infixl_ :: Rational -> Infixity

Construct the Infixity corresponding to e.g. infixl 6 +&&+*

infixr_ :: Rational -> Infixity

Construct the Infixity corresponding to e.g. infixr 6 +&&+*

Base Functor

data PortrayalF a

A single level of pseudo-Haskell expression; used to define Portrayal.

Constructors

AtomF !Text

Render this text directly.

ApplyF !a [a]

Render a function application to several arguments.

BinopF !Text !Infixity !a !a

Render a binary infix operator application to two arguments.

TupleF [a]

Render a tuple of sub-values.

ListF [a]

Render a list of sub-values.

LambdaCaseF [(a, a)]

Render a lambda-case expression.

RecordF !a [FactorPortrayal a]

Render a record construction/update syntax.

TyAppF !a !a

Render a TypeApplication.

TySigF !a !a

Render a term with explicit type signature.

QuotF !Text !a

Render a quasiquoter term with the given name.

UnlinesF [a]

Render a collection of vertically-aligned lines

NestF !Int !a

Indent the subdocument by the given number of columns.

Instances

Functor PortrayalF

Defined in Data.Portray

Methods

fmap :: (a -> b) -> PortrayalF a -> PortrayalF b

(<$) :: a -> PortrayalF b -> PortrayalF a

Foldable PortrayalF

Defined in Data.Portray

Methods

fold :: Monoid m => PortrayalF m -> m

foldMap :: Monoid m => (a -> m) -> PortrayalF a -> m

foldMap' :: Monoid m => (a -> m) -> PortrayalF a -> m

foldr :: (a -> b -> b) -> b -> PortrayalF a -> b

foldr' :: (a -> b -> b) -> b -> PortrayalF a -> b

foldl :: (b -> a -> b) -> b -> PortrayalF a -> b

foldl' :: (b -> a -> b) -> b -> PortrayalF a -> b

foldr1 :: (a -> a -> a) -> PortrayalF a -> a

foldl1 :: (a -> a -> a) -> PortrayalF a -> a

toList :: PortrayalF a -> [a]

null :: PortrayalF a -> Bool

length :: PortrayalF a -> Int

elem :: Eq a => a -> PortrayalF a -> Bool

maximum :: Ord a => PortrayalF a -> a

minimum :: Ord a => PortrayalF a -> a

sum :: Num a => PortrayalF a -> a

product :: Num a => PortrayalF a -> a

Traversable PortrayalF

Defined in Data.Portray

Methods

traverse :: Applicative f => (a -> f b) -> PortrayalF a -> f (PortrayalF b)

sequenceA :: Applicative f => PortrayalF (f a) -> f (PortrayalF a)

mapM :: Monad m => (a -> m b) -> PortrayalF a -> m (PortrayalF b)

sequence :: Monad m => PortrayalF (m a) -> m (PortrayalF a)

Eq a => Eq (PortrayalF a)

Defined in Data.Portray

Methods

(==) :: PortrayalF a -> PortrayalF a -> Bool

(/=) :: PortrayalF a -> PortrayalF a -> Bool

Ord a => Ord (PortrayalF a)

Defined in Data.Portray

Methods

compare :: PortrayalF a -> PortrayalF a -> Ordering

(<) :: PortrayalF a -> PortrayalF a -> Bool

(<=) :: PortrayalF a -> PortrayalF a -> Bool

(>) :: PortrayalF a -> PortrayalF a -> Bool

(>=) :: PortrayalF a -> PortrayalF a -> Bool

max :: PortrayalF a -> PortrayalF a -> PortrayalF a

min :: PortrayalF a -> PortrayalF a -> PortrayalF a

Read a => Read (PortrayalF a)

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS (PortrayalF a)

readList :: ReadS [PortrayalF a]

readPrec :: ReadPrec (PortrayalF a)

readListPrec :: ReadPrec [PortrayalF a]

Show a => Show (PortrayalF a)

Defined in Data.Portray

Methods

showsPrec :: Int -> PortrayalF a -> ShowS

show :: PortrayalF a -> String

showList :: [PortrayalF a] -> ShowS

IsString (PortrayalF a)

Defined in Data.Portray

Methods

fromString :: String -> PortrayalF a

Generic (PortrayalF a)

Defined in Data.Portray

Associated Types

type Rep (PortrayalF a) :: Type -> Type

Methods

from :: PortrayalF a -> Rep (PortrayalF a) x

to :: Rep (PortrayalF a) x -> PortrayalF a

Portray a => Portray (PortrayalF a)

Defined in Data.Portray

Methods

portray :: PortrayalF a -> Portrayal

type Rep (PortrayalF a)

Defined in Data.Portray

type Rep (PortrayalF a) = D1 ('MetaData "PortrayalF" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'False) (((C1 ('MetaCons "AtomF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: (C1 ('MetaCons "ApplyF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])) :+: C1 ('MetaCons "BinopF" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Infixity)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a))))) :+: (C1 ('MetaCons "TupleF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])) :+: (C1 ('MetaCons "ListF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])) :+: C1 ('MetaCons "LambdaCaseF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(a, a)]))))) :+: ((C1 ('MetaCons "RecordF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FactorPortrayal a])) :+: (C1 ('MetaCons "TyAppF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "TySigF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))) :+: (C1 ('MetaCons "QuotF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: (C1 ('MetaCons "UnlinesF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])) :+: C1 ('MetaCons "NestF" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a))))))

Class

class Portray a where

A class providing rendering to pseudo-Haskell syntax.

Instances should guarantee that they produce output that could, in principle, be parsed as Haskell source that evaluates to a value equal to the one being printed, provided the right functions, quasiquoters, plugins, extensions, etc. are available. Note this doesn't require you to /actually implement/ these functions, quasiquoters, etc; just that it would be feasible to do so.

Most of the time, this requirement is dispatched simply by portraying the datum as its actual tree of data constructors. However, since this can sometimes be unwieldy, you might wish to have more stylized portrayals.

The most basic form of stylized portrayal is to retract the datum through a function, e.g. portraying 4 :| [2] :: NonEmpty a as fromList [4, 2].

For cases where you actually want to escape the Haskell syntax, you can use (or pretend to use) quasiquoter syntax, e.g. portray EAdd (ELit 2) (EVar a) as [expr| 2 + a |].

Methods

portray :: a -> Portrayal

Instances

Portray Bool

Defined in Data.Portray

Methods

portray :: Bool -> Portrayal

Portray Char

Defined in Data.Portray

Methods

portray :: Char -> Portrayal

Portray Double

Defined in Data.Portray

Methods

portray :: Double -> Portrayal

Portray Float

Defined in Data.Portray

Methods

portray :: Float -> Portrayal

Portray Int

Defined in Data.Portray

Methods

portray :: Int -> Portrayal

Portray Int8

Defined in Data.Portray

Methods

portray :: Int8 -> Portrayal

Portray Int16

Defined in Data.Portray

Methods

portray :: Int16 -> Portrayal

Portray Int32

Defined in Data.Portray

Methods

portray :: Int32 -> Portrayal

Portray Int64

Defined in Data.Portray

Methods

portray :: Int64 -> Portrayal

Portray Integer

Defined in Data.Portray

Methods

portray :: Integer -> Portrayal

Portray Natural

Defined in Data.Portray

Methods

portray :: Natural -> Portrayal

Portray Word

Defined in Data.Portray

Methods

portray :: Word -> Portrayal

Portray Word8

Defined in Data.Portray

Methods

portray :: Word8 -> Portrayal

Portray Word16

Defined in Data.Portray

Methods

portray :: Word16 -> Portrayal

Portray Word32

Defined in Data.Portray

Methods

portray :: Word32 -> Portrayal

Portray Word64

Defined in Data.Portray

Methods

portray :: Word64 -> Portrayal

Portray CallStack

Defined in Data.Portray

Methods

portray :: CallStack -> Portrayal

Portray SomeTypeRep

Defined in Data.Portray

Methods

portray :: SomeTypeRep -> Portrayal

Portray ()

Defined in Data.Portray

Methods

portray :: () -> Portrayal

Portray TyCon

Defined in Data.Portray

Methods

portray :: TyCon -> Portrayal

Portray Void

Defined in Data.Portray

Methods

portray :: Void -> Portrayal

Portray Text

Defined in Data.Portray

Methods

portray :: Text -> Portrayal

Portray Portrayal

Defined in Data.Portray

Methods

portray :: Portrayal -> Portrayal

Portray Infixity

Defined in Data.Portray

Methods

portray :: Infixity -> Portrayal

Portray Assoc

Defined in Data.Portray

Methods

portray :: Assoc -> Portrayal

Portray a => Portray [a]

Defined in Data.Portray

Methods

portray :: [a] -> Portrayal

Portray a => Portray (Maybe a)

Defined in Data.Portray

Methods

portray :: Maybe a -> Portrayal

Portray a => Portray (Ratio a)

Defined in Data.Portray

Methods

portray :: Ratio a -> Portrayal

Portray a => Portray (Identity a)

Defined in Data.Portray

Methods

portray :: Identity a -> Portrayal

Portray a => Portray (NonEmpty a)

Defined in Data.Portray

Methods

portray :: NonEmpty a -> Portrayal

Portray a => Portray (IntMap a)

Defined in Data.Portray

Methods

portray :: IntMap a -> Portrayal

Portray a => Portray (Seq a)

Defined in Data.Portray

Methods

portray :: Seq a -> Portrayal

(Ord a, Portray a) => Portray (Set a)

Defined in Data.Portray

Methods

portray :: Set a -> Portrayal

Show a => Portray (ShowAtom a)

Defined in Data.Portray

Methods

portray :: ShowAtom a -> Portrayal

(forall a. Portray a => Portray (f a)) => Portray (Fix f)

Defined in Data.Portray

Methods

portray :: Fix f -> Portrayal

Portray a => Portray (FactorPortrayal a)

Defined in Data.Portray

Methods

portray :: FactorPortrayal a -> Portrayal

Portray a => Portray (PortrayalF a)

Defined in Data.Portray

Methods

portray :: PortrayalF a -> Portrayal

(Portray a, Portray b) => Portray (Either a b)

Defined in Data.Portray

Methods

portray :: Either a b -> Portrayal

Portray (TypeRep a)

Defined in Data.Portray

Methods

portray :: TypeRep a -> Portrayal

(Portray a, Portray b) => Portray (a, b)

Defined in Data.Portray

Methods

portray :: (a, b) -> Portrayal

Portray (Proxy a)

Defined in Data.Portray

Methods

portray :: Proxy a -> Portrayal

(Ord k, Portray k, Portray a) => Portray (Map k a)

Defined in Data.Portray

Methods

portray :: Map k a -> Portrayal

(IsList a, Portray (Item a)) => Portray (Wrapped IsList a)

Portray a list-like type as "fromList [...]".

Defined in Data.Portray

Methods

portray :: Wrapped IsList a -> Portrayal

(Generic a, GPortray (Rep a)) => Portray (Wrapped Generic a)

Defined in Data.Portray

Methods

portray :: Wrapped Generic a -> Portrayal

(Portray a, Portray b, Portray c) => Portray (a, b, c)

Defined in Data.Portray

Methods

portray :: (a, b, c) -> Portrayal

Portray a => Portray (Const a b)

Defined in Data.Portray

Methods

portray :: Const a b -> Portrayal

Portray (Coercion a b)

Defined in Data.Portray

Methods

portray :: Coercion a b -> Portrayal

Portray (a :~: b)

Defined in Data.Portray

Methods

portray :: (a :~: b) -> Portrayal

(Portray a, Portray b, Portray c, Portray d) => Portray (a, b, c, d)

Defined in Data.Portray

Methods

portray :: (a, b, c, d) -> Portrayal

(Portray a, Portray b, Portray c, Portray d, Portray e) => Portray (a, b, c, d, e)

Defined in Data.Portray

Methods

portray :: (a, b, c, d, e) -> Portrayal

Via Show

newtype ShowAtom a

A newtype wrapper providing a Portray instance via showAtom.

Constructors

ShowAtom

Fields

• unShowAtom :: a

Instances

Show a => Portray (ShowAtom a)

Defined in Data.Portray

Methods

portray :: ShowAtom a -> Portrayal

Via Generic

class GPortray f where

Generics-based deriving of Portray.

Exported mostly to give Haddock something to link to; use deriving Portray via Wrapped Generic MyType.

Methods

gportray :: f a -> Portrayal

Instances

GPortray (V1 :: k -> Type)

Defined in Data.Portray

Methods

gportray :: forall (a :: k0). V1 a -> Portrayal

(Constructor ('MetaCons n fx 'False), GPortrayProduct f) => GPortray (C1 ('MetaCons n fx 'False) f :: k -> Type)

Defined in Data.Portray

Methods

gportray :: forall (a :: k0). C1 ('MetaCons n fx 'False) f a -> Portrayal

(KnownSymbol n, GPortrayProduct f) => GPortray (C1 ('MetaCons n fx 'True) f :: k -> Type)

Defined in Data.Portray

Methods

gportray :: forall (a :: k0). C1 ('MetaCons n fx 'True) f a -> Portrayal

(GPortray f, GPortray g) => GPortray (f :+: g :: k -> Type)

Defined in Data.Portray

Methods

gportray :: forall (a :: k0). (f :+: g) a -> Portrayal

GPortray f => GPortray (D1 d f :: k -> Type)

Defined in Data.Portray

Methods

gportray :: forall (a :: k0). D1 d f a -> Portrayal

class GPortrayProduct f where

Generics-based deriving of Portray for product types.

Exported mostly to give Haddock something to link to; use deriving Portray via Wrapped Generic MyType.

Methods

gportrayProduct :: f a -> [FactorPortrayal Portrayal] -> [FactorPortrayal Portrayal]

Instances

GPortrayProduct (U1 :: k -> Type)

Defined in Data.Portray

Methods

gportrayProduct :: forall (a :: k0). U1 a -> [FactorPortrayal Portrayal] -> [FactorPortrayal Portrayal]

(GPortrayProduct f, GPortrayProduct g) => GPortrayProduct (f :*: g :: k -> Type)

Defined in Data.Portray

Methods

gportrayProduct :: forall (a :: k0). (f :*: g) a -> [FactorPortrayal Portrayal] -> [FactorPortrayal Portrayal]

(Selector s, Portray a) => GPortrayProduct (S1 s (K1 i a :: k -> Type) :: k -> Type)

Defined in Data.Portray

Methods

gportrayProduct :: forall (a0 :: k0). S1 s (K1 i a) a0 -> [FactorPortrayal Portrayal] -> [FactorPortrayal Portrayal]

Convenience

showAtom :: Show a => a -> Portrayal

Convenience for using a Show instance and wrapping the result in Atom.

strAtom :: String -> Portrayal

Convenience for building an Atom from a String.

Note if you just want a string literal, OverloadedStrings is supported.

strQuot :: String -> Portrayal -> Portrayal

Convenience for building a Quot from a String.

strBinop :: String -> Infixity -> Portrayal -> Portrayal -> Portrayal

Convenience for building a Binop with a String operator name.

Miscellaneous

newtype Fix f

Fixed-point of a functor.

There are many packages that provide equivalent things, but we need almost nothing but the type itself, so we may as well just define one locally.

Constructors

Fix (f (Fix f))

Instances

(forall a. Eq a => Eq (f a)) => Eq (Fix f)

Defined in Data.Portray

Methods

(==) :: Fix f -> Fix f -> Bool

(/=) :: Fix f -> Fix f -> Bool

(forall a. Read a => Read (f a)) => Read (Fix f)

Defined in Data.Portray

Methods

readsPrec :: Int -> ReadS (Fix f)

readList :: ReadS [Fix f]

readPrec :: ReadPrec (Fix f)

readListPrec :: ReadPrec [Fix f]

(forall a. Show a => Show (f a)) => Show (Fix f)

Defined in Data.Portray

Methods

showsPrec :: Int -> Fix f -> ShowS

show :: Fix f -> String

showList :: [Fix f] -> ShowS

Generic (Fix f)

Defined in Data.Portray

Associated Types

type Rep (Fix f) :: Type -> Type

Methods

from :: Fix f -> Rep (Fix f) x

to :: Rep (Fix f) x -> Fix f

(forall a. Portray a => Portray (f a)) => Portray (Fix f)

Defined in Data.Portray

Methods

portray :: Fix f -> Portrayal

type Rep (Fix f)

Defined in Data.Portray

type Rep (Fix f) = D1 ('MetaData "Fix" "Data.Portray" "portray-0.1.1-HnA3u8chgE3BfaajrZVKzU" 'True) (C1 ('MetaCons "Fix" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f (Fix f)))))

cata :: Functor f => (f a -> a) -> Fix f -> a

Fold a Fix f to a given a function to collapse each layer.

portrayCallStack :: [(String, SrcLoc)] -> Portrayal

Construct a Portrayal of a CallStack without the "callStack" prefix.

portrayType :: TypeRep a -> Portrayal

Portray the type described by the given TypeRep.

This gives the type-level syntax for the type, as opposed to value-level syntax that would construct the TypeRep.