LLVM API Documentation

llvm::ReturnInst Class Reference

#include <Instructions.h>

Inheritance diagram for llvm::ReturnInst:

[legend]Collaboration diagram for llvm::ReturnInst:

[legend]List of all members.


Public Member Functions
	ReturnInst (Value RetVal=0, Instruction InsertBefore=0)
	ReturnInst (Value RetVal, BasicBlock InsertAtEnd)
	ReturnInst (BasicBlock *InsertAtEnd)
virtual ReturnInst *	clone () const
	Terminators must implement the methods required by Instruction...
const Value *	getReturnValue () const
Value *	getReturnValue ()
virtual const BasicBlock *	getSuccessor (unsigned idx) const
virtual void	setSuccessor (unsigned idx, BasicBlock *NewSucc)
	Set a successor at a given index.
virtual unsigned	getNumSuccessors () const
Static Public Member Functions
static bool	classof (const ReturnInst *)
static bool	classof (const Instruction *I)
	Methods for support type inquiry through isa, cast, and dyn_cast:.
static bool	classof (const Value *V)

Detailed Description

ReturnInst - Return a value (possibly void), from a function. Execution does not continue in this function any longer.

Definition at line 802 of file Instructions.h.

Constructor & Destructor Documentation

llvm::ReturnInst::ReturnInst ( Value * RetVal = 0,

Instruction * InsertBefore = 0

) [inline]

Definition at line 825 of file Instructions.h.

llvm::ReturnInst::ReturnInst ( Value * RetVal,

BasicBlock * InsertAtEnd

) [inline]

Definition at line 829 of file Instructions.h.

llvm::ReturnInst::ReturnInst ( BasicBlock * InsertAtEnd ) [inline]

Definition at line 833 of file Instructions.h.

Member Function Documentation

static bool llvm::ReturnInst::classof ( const Value * V ) [inline, static]

Reimplemented from llvm::TerminatorInst.
Definition at line 859 of file Instructions.h.
References classof().

static bool llvm::ReturnInst::classof ( const Instruction * I ) [inline, static]

Methods for support type inquiry through isa, cast, and dyn_cast:.

Reimplemented from llvm::TerminatorInst.
Definition at line 856 of file Instructions.h.
References llvm::Instruction::getOpcode(), and llvm::ISD::Ret.

static bool llvm::ReturnInst::classof ( const ReturnInst * ) [inline, static]

Definition at line 855 of file Instructions.h.
Referenced by classof().

ReturnInst * ReturnInst::clone ( ) const [virtual]

Terminators must implement the methods required by Instruction...

Implements llvm::TerminatorInst.
Definition at line 817 of file Instructions.cpp.

virtual unsigned llvm::ReturnInst::getNumSuccessors ( ) const [inline, virtual]

Implements llvm::TerminatorInst.
Definition at line 852 of file Instructions.h.

Value* llvm::ReturnInst::getReturnValue ( ) [inline]

Definition at line 842 of file Instructions.h.
References llvm::User::Operands.

const Value* llvm::ReturnInst::getReturnValue ( ) const [inline]

Definition at line 839 of file Instructions.h.
References llvm::User::Operands.
Referenced by llvm::InlineFunction(), InsertCodeToShowFunctionExit(), llvm::SparcV9RegInfo::suggestReg4RetValue(), and llvm::Interpreter::visitReturnInst().

virtual const BasicBlock* llvm::ReturnInst::getSuccessor ( unsigned idx ) const [inline, virtual]

Additionally, they must provide a method to get at the successors of this terminator instruction. 'idx' may not be >= the number of successors returned by getNumSuccessors()!
Implements llvm::TerminatorInst.
Definition at line 846 of file Instructions.h.
References abort().

void ReturnInst::setSuccessor ( unsigned idx,

BasicBlock * NewSucc

) [virtual]

Set a successor at a given index.

Implements llvm::TerminatorInst.
Definition at line 217 of file Instructions.cpp.

The documentation for this class was generated from the following files:

llvm::ReturnInst Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation