Clash.Core.TermLiteral

Tools to convert a Term into its "real" representation

Documentation

class TermLiteral a

Tools to deal with literals encoded as a Term.

Minimal complete definition

termToData

Instances

TermLiteral Bool

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Bool

showsTypePrec :: Int -> Proxy Bool -> ShowS

TermLiteral Char

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Char

showsTypePrec :: Int -> Proxy Char -> ShowS

TermLiteral Int

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Int

showsTypePrec :: Int -> Proxy Int -> ShowS

TermLiteral Integer

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Integer

showsTypePrec :: Int -> Proxy Integer -> ShowS

TermLiteral Natural

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Natural

showsTypePrec :: Int -> Proxy Natural -> ShowS

TermLiteral Word

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Word

showsTypePrec :: Int -> Proxy Word -> ShowS

TermLiteral String

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term String

showsTypePrec :: Int -> Proxy String -> ShowS

TermLiteral Text

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Text

showsTypePrec :: Int -> Proxy Text -> ShowS

TermLiteral Term

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term Term

showsTypePrec :: Int -> Proxy Term -> ShowS

TermLiteral RenderAs

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term RenderAs

showsTypePrec :: Int -> Proxy RenderAs -> ShowS

TermLiteral a => TermLiteral (Maybe a)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Maybe a)

showsTypePrec :: Int -> Proxy (Maybe a) -> ShowS

KnownNat n => TermLiteral (Index n)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Index n)

showsTypePrec :: Int -> Proxy (Index n) -> ShowS

TermLiteral (SNat n)

Unsafe warning: If you use this instance in a monomorphic context (e.g., TermLiteral (SNat 5)), you need to make very sure that the term corresponds to the literal. If you don't, there will be a mismatch between type level variables and the proof carried in SNats KnownNat. Typical usage of this instance will therefore leave the n polymorphic.

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (SNat n)

showsTypePrec :: Int -> Proxy (SNat n) -> ShowS

TermLiteral a => TermLiteral (Attr a)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Attr a)

showsTypePrec :: Int -> Proxy (Attr a) -> ShowS

TermLiteral a => TermLiteral (Assertion' a)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Assertion' a)

showsTypePrec :: Int -> Proxy (Assertion' a) -> ShowS

TermLiteral a => TermLiteral (Property' a)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Property' a)

showsTypePrec :: Int -> Proxy (Property' a) -> ShowS

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

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Either a b)

showsTypePrec :: Int -> Proxy (Either a b) -> ShowS

(TermLiteral a, TermLiteral b) => TermLiteral (a, b)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (a, b)

showsTypePrec :: Int -> Proxy (a, b) -> ShowS

(TermLiteral a, KnownNat n) => TermLiteral (Vec n a)

Defined in Clash.Core.TermLiteral

Methods

termToData :: Term -> Either Term (Vec n a)

showsTypePrec :: Int -> Proxy (Vec n a) -> ShowS

showsTypePrec

Arguments

:: TermLiteral a

=> Int

The operator precedence of the enclosing context (a number from 0 to 11). Function application has precedence 10. Used to determine whether the result should be wrapped in parentheses.

-> Proxy a

Proxy for a term whose type needs to be pretty printed

-> ShowS

Pretty print the type of a term (for error messages). Its default implementation uses Typeable to print the type. Note that this method is there to allow an instance for SNat to exist (and other GADTs imposing KnownNat). Without it, GHC would ask for a KnownNat constraint on the instance, which would defeat the purpose of it.

showType :: TermLiteral a => Proxy a -> String

Pretty print type a

termToData

Arguments

:: (TermLiteral a, HasCallStack)

=> Term

Term to convert

-> Either Term a

Left indicates a failure, containing the (sub)term that failed to translate. Right indicates a success.

Convert Term to the constant it represents. Will return an error if (one of the subterms) fail to translate.

termToDataError :: forall a. TermLiteral a => Term -> Either String a

Same as termToData, but returns printable error message if it couldn't translate a term.

deriveTermLiteral :: Name -> Q [Dec]

Derive a TermLiteral instance for given type