Grisette.TH

Convenient derivation of all instances relating to Grisette

derive :: Name -> [Name] -> Q [Dec]

Derive specified classes for a type with the given name.

Support the same set of classes as deriveAll.

deriveAll :: Name -> Q [Dec]

Derive all classes related to Grisette for a type with the given name.

Classes that are be derived by this procedure are:

• Generic
• Show
• Eq
• Ord
• Lift
• NFData
• Hashable
• Serial
• AllSyms
• EvalSym
• ExtractSym
• PPrint
• Mergeable
• SymEq
• SymOrd
• SubstSym
• ToCon
• ToSym
• UnifiedSymEq
• UnifiedSymOrd

Ord isn't valid for all types (symbolic-only types), so it may be necessary to exclude it.

deriveAll needs the following language extensions:

• DeriveAnyClass
• DeriveGeneric
• DeriveLift
• DerivingVia
• FlexibleContexts
• FlexibleInstances
• MonoLocalBinds
• MultiParamTypeClasses
• ScopedTypeVariables
• StandaloneDeriving
• TemplateHaskell
• TypeApplications
• UndecidableInstances

Deriving for a newtype may also need

• GeneralizedNewtypeDeriving

You may get warnings if you don't have the following extensions:

• TypeOperators

It also requires that the Default data constructor is visible. You may get strange errors if you only import Default type but not the data constructor.

deriveAllExcept :: Name -> [Name] -> Q [Dec]

Derive all classes related to Grisette for a type with the given name, except for the given classes.

Excluding Ord or SymOrd will also exclude UnifiedSymOrd. Excluding Eq or SymEq will also exclude UnifiedSymEq.

Smart constructors that merges in a monad

mkMergeConstructor

Arguments

:: String

Prefix for generated wrappers

-> Name

The type to generate the wrappers for

-> Q [Dec]

Generate constructor wrappers that wraps the result in a container with TryMerge.

mkMergeConstructor "mrg" ''Maybe

generates

mrgJust :: (Mergeable (Maybe a), Applicative m, TryMerge m) => m (Maybe a)
mrgNothing = mrgSingle Nothing
mrgJust :: (Mergeable (Maybe a), Applicative m, TryMerge m) => a -> m (Maybe a)
mrgJust = \x -> mrgSingle (Just x)

mkMergeConstructor'

Arguments

:: [String]

Names for generated wrappers

-> Name

The type to generate the wrappers for

-> Q [Dec]

Generate constructor wrappers that wraps the result in a container with TryMerge with provided names.

mkMergeConstructor' ["mrgTuple2"] ''(,)

generates

mrgTuple2 :: (Mergeable (a, b), Applicative m, TryMerge m) => a -> b -> u (a, b)
mrgTuple2 = \v1 v2 -> mrgSingle (v1, v2)

Smart constructors that are polymorphic in evaluation modes

mkUnifiedConstructor

Arguments

:: String

Prefix for generated wrappers

-> Name

The type to generate the wrappers for

-> Q [Dec]

Generate smart constructors to create unified values.

For a type T mode a b c with constructors T1, T2, etc., this function will generate smart constructors with the given prefix, e.g., mkT1, mkT2, etc.

The generated smart constructors will contruct values of type GetData mode (T mode a b c).

mkUnifiedConstructor'

Arguments

:: [String]

Names for generated wrappers

-> Name

The type to generate the wrappers for

-> Q [Dec]

Generate smart constructors to create unified values.

For a type T mode a b c with constructors T1, T2, etc., this function will generate smart constructors with the given names.

The generated smart constructors will contruct values of type GetData mode (T mode a b c).

Tools for building more derivation procedures

Type parameter handlers

class DeriveTypeParamHandler handler where

A derive type param handler handles type parameters and provides constraints or instantiations for them.

The first argument is the number of types that are zipped together. For most classes, this is 1, but for some classes, like ToCon, this is 2.

The second argument is the handler itself.

The third argument is a list of type parameters and their constraints. Each entry in the list corresponds to a type parameter of the datatype. The first element in the pair is a list of zipped type parameters with possibly concrete types. For example, if we are deriving ToCon for Either, the argument will be:

[([(e0, Nothing), (e1, Nothing)], Nothing),
 ([(a0, Nothing), (a1, Nothing)], Nothing)]

We can see that the type parameters for the concrete and symbolic Either types are zipped together: the first element of the list are for the error types, and the second element of the list are for the value types.

The handler may concretize some types, or add constraints based on the type parameters.

Methods

handleTypeParams :: Int -> handler -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: handler -> [[Type]] -> Q [Pred]

Instances

DeriveTypeParamHandler IsFPBits

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> IsFPBits -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: IsFPBits -> [[Type]] -> Q [Pred]

DeriveTypeParamHandler NatShouldBePositive

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> NatShouldBePositive -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: NatShouldBePositive -> [[Type]] -> Q [Pred]

DeriveTypeParamHandler PrimaryConstraint

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> PrimaryConstraint -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: PrimaryConstraint -> [[Type]] -> Q [Pred]

DeriveTypeParamHandler SomeDeriveTypeParamHandler

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> SomeDeriveTypeParamHandler -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: SomeDeriveTypeParamHandler -> [[Type]] -> Q [Pred]

DeriveTypeParamHandler PrimaryUnifiedConstraint

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

handleTypeParams :: Int -> PrimaryUnifiedConstraint -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: PrimaryUnifiedConstraint -> [[Type]] -> Q [Pred]

DeriveTypeParamHandler TypeableMode

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

handleTypeParams :: Int -> TypeableMode -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: TypeableMode -> [[Type]] -> Q [Pred]

data IsFPBits

Ensures that the type parameters are valid for floating point operations.

Constructors

IsFPBits

Fields

• ebIdx :: Int
• sbIdx :: Int

Instances

DeriveTypeParamHandler IsFPBits

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> IsFPBits -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: IsFPBits -> [[Type]] -> Q [Pred]

data NatShouldBePositive

Ensures that type parameters with the kind Nat are known and positive.

Constructors

NatShouldBePositive

Instances

DeriveTypeParamHandler NatShouldBePositive

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> NatShouldBePositive -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: NatShouldBePositive -> [[Type]] -> Q [Pred]

data PrimaryConstraint

Adds a primary constraint to the type parameters. It applies the class to each type parameter that are zipped into a list, with the desired kinds.

For example, if we are deriving ToCon for Either, and the input to this handler is as follows:

[([(e0, Nothing), (e1, Nothing)], Nothing),
 ([(a0, Nothing), (a1, Nothing)], Nothing)]

Then this will generate constraints for the type parameters of Either:

[([(e0, Nothing), (e1, Nothing)], Just [ToCon e0 e1]),
 ([(a0, Nothing), (a1, Nothing)], Just [ToCon a0 a1])]

Type parameters that are already handled by other handlers can be ignored.

Constructors

PrimaryConstraint

Fields

• className :: Name
• ignoreIfAlreadyHandled :: Bool

Instances

DeriveTypeParamHandler PrimaryConstraint

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> PrimaryConstraint -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: PrimaryConstraint -> [[Type]] -> Q [Pred]

data SomeDeriveTypeParamHandler where

A type that can handle type parameters.

Constructors

SomeDeriveTypeParamHandler :: DeriveTypeParamHandler handler => handler -> SomeDeriveTypeParamHandler

Instances

DeriveTypeParamHandler SomeDeriveTypeParamHandler

Defined in Grisette.Internal.TH.DeriveTypeParamHandler

Methods

handleTypeParams :: Int -> SomeDeriveTypeParamHandler -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: SomeDeriveTypeParamHandler -> [[Type]] -> Q [Pred]

Instance providers

class DeriveInstanceProvider provider where

A derive instance provider provides the instance declaration.

Methods

instanceDeclaration :: provider -> [[(TyVarBndrUnit, Maybe Type)]] -> [Pred] -> [Type] -> Q [Dec]

Instances

DeriveInstanceProvider Strategy

Defined in Grisette.Internal.TH.DeriveInstanceProvider

Methods

instanceDeclaration :: Strategy -> [[(TyVarBndrUnit, Maybe Type)]] -> [Pred] -> [Type] -> Q [Dec]

DeriveInstanceProvider UnifiedInstance

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

instanceDeclaration :: UnifiedInstance -> [[(TyVarBndrUnit, Maybe Type)]] -> [Pred] -> [Type] -> Q [Dec]

data Strategy

A strategy for deriving instances.

Constructors

Stock

Fields

• strategyClassName :: Name

WithNewtype

Fields

• strategyClassName :: Name

ViaDefault

Fields

• strategyClassName :: Name

ViaDefault1

Fields

• strategyClassName :: Name

Anyclass

Fields

• strategyClassName :: Name

Instances

Eq Strategy

Defined in Grisette.Internal.TH.DeriveInstanceProvider

Methods

(==) :: Strategy -> Strategy -> Bool

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

DeriveInstanceProvider Strategy

Defined in Grisette.Internal.TH.DeriveInstanceProvider

Methods

instanceDeclaration :: Strategy -> [[(TyVarBndrUnit, Maybe Type)]] -> [Pred] -> [Type] -> Q [Dec]

For unified interfaces

data TypeableMode

Add a Typeable constraint to the modes.

Constructors

TypeableMode

Instances

DeriveTypeParamHandler TypeableMode

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

handleTypeParams :: Int -> TypeableMode -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: TypeableMode -> [[Type]] -> Q [Pred]

data PrimaryUnifiedConstraint

Add a primary unified constraint that applies to all the type parameters with the desired kind.

Constructors

PrimaryUnifiedConstraint Name Bool

Instances

DeriveTypeParamHandler PrimaryUnifiedConstraint

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

handleTypeParams :: Int -> PrimaryUnifiedConstraint -> [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])] -> Q [([(TyVarBndrUnit, Maybe Type)], Maybe [Pred])]

handleBody :: PrimaryUnifiedConstraint -> [[Type]] -> Q [Pred]

data UnifiedInstance

Provide an instance for a unified interface.

Constructors

UnifiedInstance

Fields

• _cls :: Name
• _clsWithFunc :: Name
• _withFunc :: Name
• _withFunc1 :: Maybe Name

Instances

DeriveInstanceProvider UnifiedInstance

Defined in Grisette.Internal.TH.DeriveUnifiedInterface

Methods

instanceDeclaration :: UnifiedInstance -> [[(TyVarBndrUnit, Maybe Type)]] -> [Pred] -> [Type] -> Q [Dec]

Other helpers

deriveWithHandlers :: DeriveInstanceProvider provider => [SomeDeriveTypeParamHandler] -> provider -> Bool -> Int -> [Name] -> Q [Dec]

Derive instances for a list of types with a list of handlers and a provider.

derivePredefined :: Name -> Name -> Q [Dec]

Derive instances for a type with the given name, with the predefined strategy.

derivePredefinedMultipleClasses :: [Name] -> Name -> Q [Dec]

Derive instances for a type with the given name, with the predefined strategy.

Multiple classes can be derived at once.

deriveBuiltinExtra :: [SomeDeriveTypeParamHandler] -> Maybe [SomeDeriveTypeParamHandler] -> Bool -> Strategy -> [Name] -> Name -> Q [Dec]

Derive a builtin class for a type, with extra handlers.

deriveUnifiedInterfaceExtra :: [SomeDeriveTypeParamHandler] -> Name -> Name -> Name -> Q [Dec]

Derive an instance for a unified interface, with extra handlers.

deriveUnifiedInterface1Extra :: [SomeDeriveTypeParamHandler] -> Name -> Name -> Name -> Name -> Name -> Q [Dec]

Derive an instance for a unified interface for functors, with extra handlers.

deriveFunctorArgUnifiedInterfaceExtra :: [SomeDeriveTypeParamHandler] -> Name -> Name -> Name -> Name -> Name -> Q [Dec]

Derive an instance for a unified interface, with extra handlers. The type being derived may have functor type parameters.