Copyright	(c) 2023-2025 Sayo contributors (c) 2010-2011 Patrick Bahr Tom Hvitved (c) 2020 Michael Szvetits
License	MPL-2.0 (see the LICENSE file) AND BSD-3-Clause
Maintainer	ymdfield@outlook.jp
Safe Haskell	None
Language	GHC2021

Data.Effect.TH.Internal

Contents

Utility functions

Description

Synopsis

data EffectInfo = EffectInfo {
- eName :: Name
- eParamVars :: [TyVarBndr ()]
- eCarrier :: TyVarBndr ()
- eOps :: [OpInfo]
}
data OpInfo = OpInfo {
- opName :: Name
- opParamTypes :: [Type]
- opDataType :: Type
- opResultType :: Type
- opTyVars :: [TyVarBndrSpec]
- opCarrier :: TyVarBndr ()
- opCxt :: Cxt
- opOrder :: EffectOrder
}
data EffectConf = EffectConf {
- opConf :: Name -> OpConf
- doesGenerateLabel :: Bool
- doesGenerateOrderInstance :: Bool
}
alterOpConf :: (OpConf -> OpConf) -> EffectConf -> EffectConf
data OpConf = OpConf {
- _normalPerformerConf :: Maybe PerformerConf
- _keyedPerformerConf :: Maybe PerformerConf
- _taggedPerformerConf :: Maybe PerformerConf
- _senderConf :: Maybe PerformerConf
}
data PerformerConf = PerformerConf {
- _performerName :: String
- _doesGeneratePerformerSignature :: Bool
- _performerDoc :: Maybe String -> Q (Maybe String)
- _performerArgDoc :: Int -> Maybe String -> Q (Maybe String)
}
performerConfs :: Traversal' OpConf PerformerConf
keyedPerformerConf :: Lens' OpConf (Maybe PerformerConf)
normalPerformerConf :: Lens' OpConf (Maybe PerformerConf)
senderConf :: Lens' OpConf (Maybe PerformerConf)
taggedPerformerConf :: Lens' OpConf (Maybe PerformerConf)
doesGeneratePerformerSignature :: Lens' PerformerConf Bool
performerArgDoc :: Lens' PerformerConf (Int -> Maybe String -> Q (Maybe String))
performerDoc :: Lens' PerformerConf (Maybe String -> Q (Maybe String))
performerName :: Lens' PerformerConf String
noGenerateNormalPerformer :: EffectConf -> EffectConf
noGenerateKeyedPerformer :: EffectConf -> EffectConf
noGenerateTaggedPerformer :: EffectConf -> EffectConf
noGeneratePerformerSignature :: EffectConf -> EffectConf
noGenerateLabel :: EffectConf -> EffectConf
noGenerateOrderInstance :: EffectConf -> EffectConf
type EffectGenerator = ReaderT (EffectConf, Name, Info, DataInfo, EffectInfo) (WriterT [Dec] Q) ()
genEffect :: EffectGenerator
genFOE :: EffectGenerator
genHOE :: EffectGenerator
genPerformers :: EffectConf -> EffectInfo -> Q [Dec]
genLabel :: EffectConf -> EffectInfo -> Q [Dec]
genNormalPerformer :: OpInfo -> PerformerConf -> WriterT [Dec] Q ()
genKeyedPerformer :: OpInfo -> PerformerConf -> WriterT [Dec] Q ()
genTaggedPerformer :: OpInfo -> PerformerConf -> WriterT [Dec] Q ()
genSender :: OpInfo -> PerformerConf -> WriterT [Dec] Q ()
genPerformer :: (Exp -> Exp) -> (Type -> Type -> Type) -> ([TyVarBndrSpec] -> [TyVarBndrSpec]) -> OpInfo -> PerformerConf -> WriterT [Dec] Q ()
genPerformerArmor :: (Type -> Type -> Type) -> ([TyVarBndrSpec] -> [TyVarBndrSpec]) -> OpInfo -> PerformerConf -> (Type -> Q Clause) -> WriterT [Dec] Q ()
arrowChain :: Foldable t => t Type -> Type -> Type
data DataInfo = DataInfo {
- dataCxt :: Cxt
- dataName :: Name
- dataTyVars :: [TyVarBndr ()]
- dataCons :: [ConInfo]
}
data ConInfo = ConInfo {
- conName :: Name
- conArgs :: [BangType]
- conGadtReturnType :: Maybe Type
- conTyVars :: [TyVarBndrSpec]
- conCxt :: Cxt
}
reifyEffect :: Name -> Q (Info, DataInfo, EffectInfo)
analyzeEffect :: DataInfo -> Either Text EffectInfo
tyVarName :: TyVarBndr a -> Name
tyVarType :: TyVarBndr a -> Type
unkindTypeRec :: Type -> Type
unkindType :: Type -> Type
unkindTyVar :: TyVarBndr a -> TyVarBndr a
occurs :: Name -> Type -> Bool
analyzeData :: Info -> Maybe DataInfo
normalizeCon :: Con -> [ConInfo]
normalizeNonForallCon :: Con -> [ConInfo]

Documentation

data EffectInfo Source #

Constructors

EffectInfo
Fields eName :: Name eParamVars :: [TyVarBndr ()] eCarrier :: TyVarBndr () eOps :: [OpInfo]

data OpInfo Source #

Constructors

OpInfo
Fields opName :: Name opParamTypes :: [Type] opDataType :: Type opResultType :: Type opTyVars :: [TyVarBndrSpec] opCarrier :: TyVarBndr () opCxt :: Cxt opOrder :: EffectOrder

data EffectConf Source #

Constructors

EffectConf
Fields opConf :: Name -> OpConf doesGenerateLabel :: Bool doesGenerateOrderInstance :: Bool

Instances

Instances details

Default EffectConf Source #
Instance details Defined in Data.Effect.TH.Internal Methods def :: EffectConf #

alterOpConf :: (OpConf -> OpConf) -> EffectConf -> EffectConf Source #

data OpConf Source #

Constructors

OpConf
Fields _normalPerformerConf :: Maybe PerformerConf _keyedPerformerConf :: Maybe PerformerConf _taggedPerformerConf :: Maybe PerformerConf _senderConf :: Maybe PerformerConf

data PerformerConf Source #

Constructors

PerformerConf
Fields _performerName :: String _doesGeneratePerformerSignature :: Bool _performerDoc :: Maybe String -> Q (Maybe String) _performerArgDoc :: Int -> Maybe String -> Q (Maybe String)