Safe Haskell	None
Language	Haskell2010

LLVM.IRBuilder.Module

Synopsis

newtype ModuleBuilderT m a = ModuleBuilderT {
- unModuleBuilderT :: StateT ModuleBuilderState m a
}
newtype ModuleBuilderState = ModuleBuilderState {
- builderDefs :: SnocList Definition
}
emptyModuleBuilder :: ModuleBuilderState
type ModuleBuilder = ModuleBuilderT Identity
class Monad m => MonadModuleBuilder m where
runModuleBuilder :: ModuleBuilderState -> ModuleBuilder a -> (a, [Definition])
runModuleBuilderT :: Monad m => ModuleBuilderState -> ModuleBuilderT m a -> m (a, [Definition])
execModuleBuilder :: ModuleBuilderState -> ModuleBuilder a -> [Definition]
execModuleBuilderT :: Monad m => ModuleBuilderState -> ModuleBuilderT m a -> m [Definition]
emitDefn :: MonadModuleBuilder m => Definition -> m ()
data ParameterName
- = NoParameterName
- | ParameterName ShortByteString
function :: MonadModuleBuilder m => Name -> [(Type, ParameterName)] -> Type -> ([Operand] -> IRBuilderT m ()) -> m Operand
extern :: MonadModuleBuilder m => Name -> [Type] -> Type -> m Operand
typedef :: MonadModuleBuilder m => Name -> Maybe Type -> m ()
buildModule :: ShortByteString -> ModuleBuilder a -> Module
buildModuleT :: Monad m => ShortByteString -> ModuleBuilderT m a -> m Module

Documentation

newtype ModuleBuilderT m a Source #

Constructors

ModuleBuilderT
Fields unModuleBuilderT :: StateT ModuleBuilderState m a

Instances

MonadTrans ModuleBuilderT Source #
Instance details Defined in LLVM.IRBuilder.Module Methods lift :: Monad m => m a -> ModuleBuilderT m a #
MonadWriter w m => MonadWriter w (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods writer :: (a, w) -> ModuleBuilderT m a # tell :: w -> ModuleBuilderT m () # listen :: ModuleBuilderT m a -> ModuleBuilderT m (a, w) # pass :: ModuleBuilderT m (a, w -> w) -> ModuleBuilderT m a #
MonadState s m => MonadState s (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods get :: ModuleBuilderT m s # put :: s -> ModuleBuilderT m () # state :: (s -> (a, s)) -> ModuleBuilderT m a #
MonadReader r m => MonadReader r (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods ask :: ModuleBuilderT m r # local :: (r -> r) -> ModuleBuilderT m a -> ModuleBuilderT m a # reader :: (r -> a) -> ModuleBuilderT m a #
MonadError e m => MonadError e (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods throwError :: e -> ModuleBuilderT m a # catchError :: ModuleBuilderT m a -> (e -> ModuleBuilderT m a) -> ModuleBuilderT m a #
Monad m => Monad (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods (>>=) :: ModuleBuilderT m a -> (a -> ModuleBuilderT m b) -> ModuleBuilderT m b # (>>) :: ModuleBuilderT m a -> ModuleBuilderT m b -> ModuleBuilderT m b # return :: a -> ModuleBuilderT m a # fail :: String -> ModuleBuilderT m a #
Functor m => Functor (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods fmap :: (a -> b) -> ModuleBuilderT m a -> ModuleBuilderT m b # (<$) :: a -> ModuleBuilderT m b -> ModuleBuilderT m a #
MonadFix m => MonadFix (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods mfix :: (a -> ModuleBuilderT m a) -> ModuleBuilderT m a #
MonadFail m => MonadFail (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods fail :: String -> ModuleBuilderT m a #
Monad m => Applicative (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods pure :: a -> ModuleBuilderT m a # (<>) :: ModuleBuilderT m (a -> b) -> ModuleBuilderT m a -> ModuleBuilderT m b # liftA2 :: (a -> b -> c) -> ModuleBuilderT m a -> ModuleBuilderT m b -> ModuleBuilderT m c # (>) :: ModuleBuilderT m a -> ModuleBuilderT m b -> ModuleBuilderT m b # (<*) :: ModuleBuilderT m a -> ModuleBuilderT m b -> ModuleBuilderT m a #
MonadPlus m => Alternative (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods empty :: ModuleBuilderT m a # (<\|>) :: ModuleBuilderT m a -> ModuleBuilderT m a -> ModuleBuilderT m a # some :: ModuleBuilderT m a -> ModuleBuilderT m [a] # many :: ModuleBuilderT m a -> ModuleBuilderT m [a] #
MonadPlus m => MonadPlus (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods mzero :: ModuleBuilderT m a # mplus :: ModuleBuilderT m a -> ModuleBuilderT m a -> ModuleBuilderT m a #
MonadIO m => MonadIO (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftIO :: IO a -> ModuleBuilderT m a #
MonadCont m => MonadCont (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods callCC :: ((a -> ModuleBuilderT m b) -> ModuleBuilderT m a) -> ModuleBuilderT m a #
Monad m => MonadModuleBuilder (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ModuleBuilderT m a Source #

newtype ModuleBuilderState Source #

Constructors

ModuleBuilderState
Fields builderDefs :: SnocList Definition

emptyModuleBuilder :: ModuleBuilderState Source #

type ModuleBuilder = ModuleBuilderT Identity Source #

class Monad m => MonadModuleBuilder m where Source #

Methods

liftModuleState :: State ModuleBuilderState a -> m a Source #

liftModuleState :: (MonadTrans t, MonadModuleBuilder m1, m ~ t m1) => State ModuleBuilderState a -> m a Source #

Instances

MonadModuleBuilder m => MonadModuleBuilder (ListT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ListT m a Source #
MonadModuleBuilder m => MonadModuleBuilder (MaybeT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> MaybeT m a Source #
Monad m => MonadModuleBuilder (ModuleBuilderT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ModuleBuilderT m a Source #
MonadModuleBuilder m => MonadModuleBuilder (IdentityT m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> IdentityT m a Source #
MonadModuleBuilder m => MonadModuleBuilder (ExceptT e m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ExceptT e m a Source #
MonadModuleBuilder m => MonadModuleBuilder (StateT s m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> StateT s m a Source #
MonadModuleBuilder m => MonadModuleBuilder (StateT s m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> StateT s m a Source #
(Monoid w, MonadModuleBuilder m) => MonadModuleBuilder (WriterT w m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> WriterT w m a Source #
(Monoid w, MonadModuleBuilder m) => MonadModuleBuilder (WriterT w m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> WriterT w m a Source #
MonadModuleBuilder m => MonadModuleBuilder (ContT r m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ContT r m a Source #
MonadModuleBuilder m => MonadModuleBuilder (ReaderT r m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> ReaderT r m a Source #
(MonadModuleBuilder m, Monoid w) => MonadModuleBuilder (RWST r w s m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> RWST r w s m a Source #
(MonadModuleBuilder m, Monoid w) => MonadModuleBuilder (RWST r w s m) Source #
Instance details Defined in LLVM.IRBuilder.Module Methods liftModuleState :: State ModuleBuilderState a -> RWST r w s m a Source #

runModuleBuilder :: ModuleBuilderState -> ModuleBuilder a -> (a, [Definition]) Source #

Evaluate ModuleBuilder to a result and a list of definitions

runModuleBuilderT :: Monad m => ModuleBuilderState -> ModuleBuilderT m a -> m (a, [Definition]) Source #

Evaluate ModuleBuilderT to a result and a list of definitions

execModuleBuilder :: ModuleBuilderState -> ModuleBuilder a -> [Definition] Source #

Evaluate ModuleBuilder to a list of definitions

execModuleBuilderT :: Monad m => ModuleBuilderState -> ModuleBuilderT m a -> m [Definition] Source #

Evaluate ModuleBuilderT to a list of definitions

emitDefn :: MonadModuleBuilder m => Definition -> m () Source #

data ParameterName Source #

A parameter name suggestion

Constructors

NoParameterName
ParameterName ShortByteString

Instances

Eq ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Methods (==) :: ParameterName -> ParameterName -> Bool # (/=) :: ParameterName -> ParameterName -> Bool #
Data ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParameterName -> c ParameterName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParameterName # toConstr :: ParameterName -> Constr # dataTypeOf :: ParameterName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ParameterName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParameterName) # gmapT :: (forall b. Data b => b -> b) -> ParameterName -> ParameterName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParameterName -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParameterName -> r # gmapQ :: (forall d. Data d => d -> u) -> ParameterName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ParameterName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParameterName -> m ParameterName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParameterName -> m ParameterName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParameterName -> m ParameterName #
Ord ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Methods compare :: ParameterName -> ParameterName -> Ordering # (<) :: ParameterName -> ParameterName -> Bool # (<=) :: ParameterName -> ParameterName -> Bool # (>) :: ParameterName -> ParameterName -> Bool # (>=) :: ParameterName -> ParameterName -> Bool # max :: ParameterName -> ParameterName -> ParameterName # min :: ParameterName -> ParameterName -> ParameterName #
Read ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Methods readsPrec :: Int -> ReadS ParameterName # readList :: ReadS [ParameterName] # readPrec :: ReadPrec ParameterName # readListPrec :: ReadPrec [ParameterName] #
Show ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Methods showsPrec :: Int -> ParameterName -> ShowS # show :: ParameterName -> String # showList :: [ParameterName] -> ShowS #
IsString ParameterName Source #	Using `fromString` on non-ASCII strings will throw an error.
Instance details Defined in LLVM.IRBuilder.Module Methods fromString :: String -> ParameterName #
Generic ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module Associated Types type Rep ParameterName :: * -> * # Methods from :: ParameterName -> Rep ParameterName x # to :: Rep ParameterName x -> ParameterName #
type Rep ParameterName Source #
Instance details Defined in LLVM.IRBuilder.Module type Rep ParameterName = D1 (MetaData "ParameterName" "LLVM.IRBuilder.Module" "llvm-hs-pure-6.2.0-EYOLM0hMFOhEED6ANzgqvG" False) (C1 (MetaCons "NoParameterName" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ParameterName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortByteString)))

function Source #

Arguments

:: MonadModuleBuilder m
=> Name	Function name
-> [(Type, ParameterName)]	Parameter types and name suggestions
-> Type	Return type
-> ([Operand] -> IRBuilderT m ())	Function body builder
-> m Operand

Define and emit a (non-variadic) function definition

extern Source #

Arguments

:: MonadModuleBuilder m
=> Name	Definition name
-> [Type]	Parameter types
-> Type	Type
-> m Operand

An external function definition

typedef :: MonadModuleBuilder m => Name -> Maybe Type -> m () Source #

A named type definition

buildModule :: ShortByteString -> ModuleBuilder a -> Module Source #

Convenience function for module construction

buildModuleT :: Monad m => ShortByteString -> ModuleBuilderT m a -> m Module Source #

Convenience function for module construction (transformer version)