llvm::sandboxir::Function Class Reference

#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::Function:

Public Types
using	iterator = mapped_iterator< llvm::Function::iterator, LLVMBBToBB >
Public Types inherited from llvm::sandboxir::Value
enum class	ClassID : unsigned { DEF_VALUE , DEF_USER , DEF_INSTR }
using	use_iterator = UserUseIterator
using	const_use_iterator = UserUseIterator
using	user_iterator = mapped_iterator< sandboxir::UserUseIterator, UseToUser >
using	const_user_iterator = user_iterator

Public Member Functions
Argument *	getArg (unsigned Idx) const
size_t	arg_size () const
bool	arg_empty () const
iterator	begin () const
iterator	end () const
void	verify () const final
	Should crash if there is something wrong with the instruction.
void	dumpNameAndArgs (raw_ostream &OS) const
void	dump (raw_ostream &OS) const final
LLVM_DUMP_METHOD void	dump () const final
Public Member Functions inherited from llvm::sandboxir::Value
virtual	~Value ()=default
ClassID	getSubclassID () const
use_iterator	use_begin ()
const_use_iterator	use_begin () const
use_iterator	use_end ()
const_use_iterator	use_end () const
iterator_range< use_iterator >	uses ()
iterator_range< const_use_iterator >	uses () const
user_iterator	user_begin ()
user_iterator	user_end ()
const_user_iterator	user_begin () const
const_user_iterator	user_end () const
iterator_range< user_iterator >	users ()
iterator_range< const_user_iterator >	users () const
unsigned	getNumUses () const
	\Returns the number of user edges (not necessarily to unique users).
bool	hasNUsesOrMore (unsigned Num) const
	Return true if this value has N uses or more.
bool	hasNUses (unsigned Num) const
	Return true if this Value has exactly N uses.
Type *	getType () const
Context &	getContext () const
void	replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
void	replaceAllUsesWith (Value *Other)
virtual void	verify () const =0
	Should crash if there is something wrong with the instruction.
std::string	getName () const
	Returns the name in the form 'SB<number>.' like 'SB1.'.
virtual void	dumpCommonHeader (raw_ostream &OS) const
void	dumpCommonFooter (raw_ostream &OS) const
void	dumpCommonPrefix (raw_ostream &OS) const
void	dumpCommonSuffix (raw_ostream &OS) const
void	printAsOperandCommon (raw_ostream &OS) const
virtual void	dump (raw_ostream &OS) const =0
virtual LLVM_DUMP_METHOD void	dump () const =0

Static Public Member Functions
static bool	classof (const sandboxir::Value *From)
	For isa/dyn_cast.

Friends
class	Context

Additional Inherited Members
Protected Member Functions inherited from llvm::sandboxir::Value
void	clearValue ()
	Value (ClassID SubclassID, llvm::Value *Val, Context &Ctx)
Static Protected Member Functions inherited from llvm::sandboxir::Value
static const char *	getSubclassIDStr (ClassID ID)
Protected Attributes inherited from llvm::sandboxir::Value
ClassID	SubclassID
	For isa/dyn_cast.
unsigned	UID
	A unique ID used for forming the name (used for debugging).
llvm::Value *	Val = nullptr
	The LLVM Value that corresponds to this SandboxIR Value.
Context &	Ctx
	All values point to the context.

Detailed Description

Definition at line 663 of file SandboxIR.h.

Member Typedef Documentation

iterator

using llvm::sandboxir::Function::iterator = mapped_iterator<llvm::Function::iterator, LLVMBBToBB>

Definition at line 691 of file SandboxIR.h.

Member Function Documentation

arg_empty()

bool llvm::sandboxir::Function::arg_empty ( ) const

inline

Definition at line 689 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

arg_size()

size_t llvm::sandboxir::Function::arg_size ( ) const

inline

Definition at line 688 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

begin()

iterator llvm::sandboxir::Function::begin ( ) const

inline

Definition at line 692 of file SandboxIR.h.

References begin(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

Referenced by begin().

classof()

static bool llvm::sandboxir::Function::classof ( const sandboxir::Value *  From )

inlinestatic

For isa/dyn_cast.

Definition at line 679 of file SandboxIR.h.

References From.

dump() [1/2]

void Function::dump ( ) const

finalvirtual

Implements llvm::sandboxir::Value.

Definition at line 336 of file SandboxIR.cpp.

References llvm::dbgs(), and dump().

Referenced by dump().

dump() [2/2]

void Function::dump ( raw_ostream &  OS ) const

finalvirtual

Implements llvm::sandboxir::Value.

Definition at line 320 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, dumpNameAndArgs(), llvm::sandboxir::Context::getValue(), llvm::interleave(), OS, and llvm::sandboxir::Value::Val.

dumpNameAndArgs()

void Function::dumpNameAndArgs

(

raw_ostream &

OS

)

const

Definition at line 305 of file SandboxIR.cpp.

References F, llvm::interleave(), OS, and llvm::sandboxir::Value::Val.

Referenced by dump().

end()

iterator llvm::sandboxir::Function::end ( ) const

inline

Definition at line 696 of file SandboxIR.h.

References llvm::sandboxir::Value::Ctx, end(), and llvm::sandboxir::Value::Val.

Referenced by end().

getArg()

Argument * llvm::sandboxir::Function::getArg ( unsigned  Idx ) const

inline

Definition at line 683 of file SandboxIR.h.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Context::getValue(), Idx, and llvm::sandboxir::Value::Val.

verify()

void llvm::sandboxir::Function::verify ( ) const

inlinefinalvirtual

Should crash if there is something wrong with the instruction.

Implements llvm::sandboxir::Value.

Definition at line 702 of file SandboxIR.h.

References assert(), and llvm::sandboxir::Value::Val.

Friends And Related Function Documentation

Context

friend class Context

friend

Definition at line 675 of file SandboxIR.h.

---

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

• include/llvm/SandboxIR/SandboxIR.h
• lib/SandboxIR/SandboxIR.cpp