Data.Effect.TH.Internal

Documentation

data EffClsInfo

Constructors

EffClsInfo

Fields

• ecName :: Name
• ecParamVars :: [TyVarBndr ()]
• ecCarrier :: Maybe (TyVarBndr ())
• ecEffs :: [EffConInfo]

data EffConInfo

Constructors

EffConInfo

Fields

• effName :: Name
• effParamTypes :: [Type]
• effDataType :: Type
• effResultType :: Type
• effTyVars :: [TyVarBndrSpec]
• effCarrier :: Maybe (TyVarBndr ())
• effCxt :: Cxt

data EffectOrder

An order of effect.

Constructors

FirstOrder

HigherOrder

Instances

Show EffectOrder

Defined in Data.Effect.TH.Internal

Methods

showsPrec :: Int -> EffectOrder -> ShowS

show :: EffectOrder -> String

showList :: [EffectOrder] -> ShowS

Eq EffectOrder

Defined in Data.Effect.TH.Internal

Methods

(==) :: EffectOrder -> EffectOrder -> Bool

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

Ord EffectOrder

Defined in Data.Effect.TH.Internal

Methods

compare :: EffectOrder -> EffectOrder -> Ordering

(<) :: EffectOrder -> EffectOrder -> Bool

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

(>) :: EffectOrder -> EffectOrder -> Bool

(>=) :: EffectOrder -> EffectOrder -> Bool

max :: EffectOrder -> EffectOrder -> EffectOrder

min :: EffectOrder -> EffectOrder -> EffectOrder

orderOf :: EffClsInfo -> EffectOrder

newtype MakeEffectConf

Constructors

MakeEffectConf

Fields

• unMakeEffectConf :: EffClsInfo -> Q EffectClassConf

Instances

Default MakeEffectConf

Defined in Data.Effect.TH.Internal

Methods

def :: MakeEffectConf

alterEffectClassConf :: (EffectClassConf -> EffectClassConf) -> MakeEffectConf -> MakeEffectConf

alterEffectConf :: (EffectConf -> EffectConf) -> MakeEffectConf -> MakeEffectConf

data EffectClassConf

Constructors

EffectClassConf

Fields

• _confByEffect :: Name -> EffectConf
• _doesDeriveHFunctor :: Bool
• _doesGenerateLiftFOETypeSynonym :: Bool
• _doesGenerateLiftFOEPatternSynonyms :: Bool

Instances

Default EffectClassConf

Defined in Data.Effect.TH.Internal

Methods

def :: EffectClassConf

data EffectConf

Constructors

EffectConf

Fields

• _normalSenderGenConf :: Maybe SenderFunctionConf
• _taggedSenderGenConf :: Maybe SenderFunctionConf
• _keyedSenderGenConf :: Maybe SenderFunctionConf
• _warnFirstOrderInHOE :: Bool

data SenderFunctionConf

Constructors

SenderFunctionConf

Fields

• _senderFnName :: String
• _doesGenerateSenderFnSignature :: Bool
• _senderFnDoc :: Maybe String -> Q (Maybe String)
• _senderFnArgDoc :: Int -> Maybe String -> Q (Maybe String)

senderFnConfs :: Traversal' EffectConf SenderFunctionConf

confByEffect :: Lens' EffectClassConf (Name -> EffectConf)

doesDeriveHFunctor :: Lens' EffectClassConf Bool

doesGenerateLiftFOEPatternSynonyms :: Lens' EffectClassConf Bool

doesGenerateLiftFOETypeSynonym :: Lens' EffectClassConf Bool

keyedSenderGenConf :: Lens' EffectConf (Maybe SenderFunctionConf)

normalSenderGenConf :: Lens' EffectConf (Maybe SenderFunctionConf)

taggedSenderGenConf :: Lens' EffectConf (Maybe SenderFunctionConf)

warnFirstOrderInHOE :: Lens' EffectConf Bool

doesGenerateSenderFnSignature :: Lens' SenderFunctionConf Bool

senderFnArgDoc :: Lens' SenderFunctionConf (Int -> Maybe String -> Q (Maybe String))

senderFnDoc :: Lens' SenderFunctionConf (Maybe String -> Q (Maybe String))

senderFnName :: Lens' SenderFunctionConf String

deriveHFunctor :: MakeEffectConf -> MakeEffectConf

noDeriveHFunctor :: MakeEffectConf -> MakeEffectConf

generateLiftFOETypeSynonym :: MakeEffectConf -> MakeEffectConf

noGenerateLiftFOETypeSynonym :: MakeEffectConf -> MakeEffectConf

generateLiftFOEPatternSynonyms :: MakeEffectConf -> MakeEffectConf

noGenerateLiftFOEPatternSynonyms :: MakeEffectConf -> MakeEffectConf

noGenerateNormalSenderFunction :: MakeEffectConf -> MakeEffectConf

noGenerateTaggedSenderFunction :: MakeEffectConf -> MakeEffectConf

noGenerateKeyedSenderFunction :: MakeEffectConf -> MakeEffectConf

suppressFirstOrderInHigherOrderEffectWarning :: MakeEffectConf -> MakeEffectConf

noGenerateSenderFunctionSignature :: MakeEffectConf -> MakeEffectConf

genSenders :: EffectClassConf -> EffClsInfo -> Q [Dec]

genNormalSender :: EffectOrder -> SenderFunctionConf -> EffConInfo -> WriterT [Dec] Q ()

genTaggedSender :: EffectOrder -> SenderFunctionConf -> EffConInfo -> WriterT [Dec] Q ()

genKeyedSender :: EffectOrder -> SenderFunctionConf -> EffConInfo -> WriterT [Dec] Q ()

genSender :: EffectOrder -> (Exp -> Exp) -> (Type -> Type -> Type) -> ([TyVarBndrSpec] -> [TyVarBndrSpec]) -> SenderFunctionConf -> EffConInfo -> WriterT [Dec] Q ()

genSenderArmor :: (Type -> Type -> Type) -> ([TyVarBndrSpec] -> [TyVarBndrSpec]) -> SenderFunctionConf -> EffConInfo -> (Type -> Q Clause) -> WriterT [Dec] Q ()

arrowChain :: Foldable t => t Type -> Type -> Type

data DataInfo

A reified information of a datatype.

Constructors

DataInfo

Fields

• dataCxt :: Cxt
• dataName :: Name
• dataTyVars :: [TyVarBndr ()]
• dataCons :: [ConInfo]

data ConInfo

Constructors

ConInfo

Fields

• conName :: Name
• conArgs :: [BangType]
• conGadtReturnType :: Maybe Type
• conTyVars :: [TyVarBndrSpec]
• conCxt :: Cxt

reifyEffCls :: EffectOrder -> Name -> Q (Info, DataInfo, EffClsInfo)

analyzeEffCls :: EffectOrder -> DataInfo -> Either Text EffClsInfo

Generating Synonyms about LiftFOE

genLiftFOEPatternSynonyms :: EffClsInfo -> Q [Dec]

Generate the pattern synonyms for operation constructors:

pattern LBaz ... = LiftFOE (Baz ...)

genLiftFOETypeSynonym :: EffClsInfo -> Dec

Generate the type synonym for an first-order effect datatype:

type (LFoobar ...) = LiftFOE (Foobar ...)

Utility functions

tyVarName :: TyVarBndr a -> Name

Pures the name of a type variable.

tyVarType :: TyVarBndr a -> Type

Converts a type variable to a type.

unkindTypeRec :: Type -> Type

Throws away all kind information from a type.

unkindType :: Type -> Type

unkindTyVar :: TyVarBndr a -> TyVarBndr a

Throws away the kind information of a type variable.

occurs :: Name -> Type -> Bool

Checks if a name m appears somewhere in a type.

analyzeData :: Info -> Maybe DataInfo

This function abstracts away newtype declaration, it turns them into data declarations.

normalizeCon :: Con -> [ConInfo]

normalizeNonForallCon :: Con -> [ConInfo]