Safe Haskell	None
Language	Haskell98

LLVM.IRBuilder.Monad

Contents

Low-level functionality
High-level functionality

Synopsis

newtype IRBuilderT m a = IRBuilderT {
- unIRBuilderT :: StateT IRBuilderState m a
}
type IRBuilder = IRBuilderT Identity
class Monad m => MonadIRBuilder m where
data PartialBlock = PartialBlock {
- partialBlockName :: !Name
- partialBlockInstrs :: SnocList (Named Instruction)
- partialBlockTerm :: Maybe (Named Terminator)
}
emptyPartialBlock :: Name -> PartialBlock
data IRBuilderState = IRBuilderState {
- builderSupply :: !Word
- builderUsedNames :: !(HashSet ShortByteString)
- builderNameSuggestion :: !(Maybe ShortByteString)
- builderBlocks :: SnocList BasicBlock
- builderBlock :: !(Maybe PartialBlock)
}
emptyIRBuilder :: IRBuilderState
runIRBuilder :: IRBuilderState -> IRBuilder a -> (a, [BasicBlock])
runIRBuilderT :: Monad m => IRBuilderState -> IRBuilderT m a -> m (a, [BasicBlock])
execIRBuilder :: IRBuilderState -> IRBuilder a -> [BasicBlock]
execIRBuilderT :: Monad m => IRBuilderState -> IRBuilderT m a -> m [BasicBlock]
modifyBlock :: MonadIRBuilder m => (PartialBlock -> PartialBlock) -> m ()
fresh :: MonadIRBuilder m => m Name
freshName :: MonadIRBuilder m => ShortByteString -> m Name
freshUnName :: MonadIRBuilder m => m Name
emitInstr :: MonadIRBuilder m => Type -> Instruction -> m Operand
emitInstrVoid :: MonadIRBuilder m => Instruction -> m ()
emitTerm :: MonadIRBuilder m => Terminator -> m ()
emitBlockStart :: MonadIRBuilder m => Name -> m ()
block :: MonadIRBuilder m => m Name
named :: MonadIRBuilder m => m r -> ShortByteString -> m r

Documentation

newtype IRBuilderT m a Source #

This provides a uniform API for creating instructions and inserting them into a basic block: either at the end of a BasicBlock, or at a specific location in a block.

Constructors

IRBuilderT
Fields unIRBuilderT :: StateT IRBuilderState m a

Instances

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

type IRBuilder = IRBuilderT Identity Source #

class Monad m => MonadIRBuilder m where Source #

Methods

liftIRState :: State IRBuilderState a -> m a Source #

liftIRState :: (MonadTrans t, MonadIRBuilder m1, m ~ t m1) => State IRBuilderState a -> m a Source #

Instances

MonadIRBuilder m => MonadIRBuilder (ListT m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> ListT m a Source #
MonadIRBuilder m => MonadIRBuilder (MaybeT m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> MaybeT m a Source #
Monad m => MonadIRBuilder (IRBuilderT m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> IRBuilderT m a Source #
MonadIRBuilder m => MonadIRBuilder (IdentityT m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> IdentityT m a Source #
MonadIRBuilder m => MonadIRBuilder (ExceptT e m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> ExceptT e m a Source #
MonadIRBuilder m => MonadIRBuilder (StateT s m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> StateT s m a Source #
MonadIRBuilder m => MonadIRBuilder (StateT s m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> StateT s m a Source #
(Monoid w, MonadIRBuilder m) => MonadIRBuilder (WriterT w m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> WriterT w m a Source #
(Monoid w, MonadIRBuilder m) => MonadIRBuilder (WriterT w m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> WriterT w m a Source #
MonadIRBuilder m => MonadIRBuilder (ContT r m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> ContT r m a Source #
MonadIRBuilder m => MonadIRBuilder (ReaderT r m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> ReaderT r m a Source #
(MonadIRBuilder m, Monoid w) => MonadIRBuilder (RWST r w s m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> RWST r w s m a Source #
(MonadIRBuilder m, Monoid w) => MonadIRBuilder (RWST r w s m) Source #
Instance details Methods liftIRState :: State IRBuilderState a -> RWST r w s m a Source #

data PartialBlock Source #

A partially constructed block as a sequence of instructions

Constructors

PartialBlock
Fields partialBlockName :: !Name partialBlockInstrs :: SnocList (Named Instruction) partialBlockTerm :: Maybe (Named Terminator)

emptyPartialBlock :: Name -> PartialBlock Source #

data IRBuilderState Source #

Builder monad state

Constructors

IRBuilderState
Fields builderSupply :: !Word builderUsedNames :: !(HashSet ShortByteString) builderNameSuggestion :: !(Maybe ShortByteString) builderBlocks :: SnocList BasicBlock builderBlock :: !(Maybe PartialBlock)

emptyIRBuilder :: IRBuilderState Source #

runIRBuilder :: IRBuilderState -> IRBuilder a -> (a, [BasicBlock]) Source #

Evaluate IRBuilder to a result and a list of basic blocks

runIRBuilderT :: Monad m => IRBuilderState -> IRBuilderT m a -> m (a, [BasicBlock]) Source #

Evaluate IRBuilderT to a result and a list of basic blocks

execIRBuilder :: IRBuilderState -> IRBuilder a -> [BasicBlock] Source #

Evaluate IRBuilder to a list of basic blocks

execIRBuilderT :: Monad m => IRBuilderState -> IRBuilderT m a -> m [BasicBlock] Source #

Evaluate IRBuilderT to a list of basic blocks

Low-level functionality

modifyBlock :: MonadIRBuilder m => (PartialBlock -> PartialBlock) -> m () Source #

fresh :: MonadIRBuilder m => m Name Source #

Generate a fresh name. The resulting name is numbered or based on the name suggested with named if that's used.

freshName :: MonadIRBuilder m => ShortByteString -> m Name Source #

Generate a fresh name from a name suggestion

freshUnName :: MonadIRBuilder m => m Name Source #

Generate a fresh numbered name

emitInstr Source #

Arguments

:: MonadIRBuilder m
=> Type	Return type
-> Instruction
-> m Operand

Emit instruction

emitInstrVoid :: MonadIRBuilder m => Instruction -> m () Source #

Emit instruction that returns void

emitTerm :: MonadIRBuilder m => Terminator -> m () Source #

Emit terminator

emitBlockStart :: MonadIRBuilder m => Name -> m () Source #

Starts a new block labelled using the given name and ends the previous one. The name is assumed to be fresh.

High-level functionality

block :: MonadIRBuilder m => m Name Source #

Starts a new block and ends the previous one

named :: MonadIRBuilder m => m r -> ShortByteString -> m r Source #

ir named name executes the IRBuilder ir using name as the base name whenever a fresh local name is generated. Collisions are avoided by appending numbers (first "name", then "name1", "name2", and so on).