llvm::ValueSymbolTable Class Reference

This class provides a symbol table of name/value pairs. More...

#include "llvm/IR/ValueSymbolTable.h"

Public Types
Types
using	ValueMap = StringMap< Value * >
	A mapping of names to values.
using	iterator = ValueMap::iterator
	An iterator over a ValueMap.
using	const_iterator = ValueMap::const_iterator
	A const_iterator over a ValueMap.

Public Member Functions
Constructors
	ValueSymbolTable (int MaxNameSize=-1)
	~ValueSymbolTable ()
Accessors
Value *	lookup (StringRef Name) const
	This method finds the value with the given Name in the the symbol table.
bool	empty () const
unsigned	size () const
	The number of name/type pairs is returned.
void	dump () const
	This function can be used from the debugger to display the content of the symbol table while debugging.
Iteration
iterator	begin ()
	Get an iterator that from the beginning of the symbol table.
const_iterator	begin () const
	Get a const_iterator that from the beginning of the symbol table.
iterator	end ()
	Get an iterator to the end of the symbol table.
const_iterator	end () const
	Get a const_iterator to the end of the symbol table.

Friends
class	SymbolTableListTraits< Argument >
class	SymbolTableListTraits< BasicBlock >
class	SymbolTableListTraits< Function >
class	SymbolTableListTraits< GlobalAlias >
class	SymbolTableListTraits< GlobalIFunc >
class	SymbolTableListTraits< GlobalVariable >
class	SymbolTableListTraits< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >
class	Value

Detailed Description

This class provides a symbol table of name/value pairs.

It is essentially a std::map<std::string,Value*> but has a controlled interface provided by LLVM as well as ensuring uniqueness of names.

Definition at line 39 of file ValueSymbolTable.h.

Member Typedef Documentation

const_iterator

using llvm::ValueSymbolTable::const_iterator = ValueMap::const_iterator

A const_iterator over a ValueMap.

Definition at line 60 of file ValueSymbolTable.h.

iterator

using llvm::ValueSymbolTable::iterator = ValueMap::iterator

An iterator over a ValueMap.

Definition at line 57 of file ValueSymbolTable.h.

ValueMap

using llvm::ValueSymbolTable::ValueMap = StringMap<Value*>

A mapping of names to values.

Definition at line 54 of file ValueSymbolTable.h.

Constructor & Destructor Documentation

ValueSymbolTable()

llvm::ValueSymbolTable::ValueSymbolTable ( int  MaxNameSize = -1 )

inline

Definition at line 66 of file ValueSymbolTable.h.

~ValueSymbolTable()

ValueSymbolTable::~ValueSymbolTable

(

)

Definition at line 33 of file ValueSymbolTable.cpp.

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

Member Function Documentation

begin() [1/2]

iterator llvm::ValueSymbolTable::begin ( )

inline

Get an iterator that from the beginning of the symbol table.

Definition at line 101 of file ValueSymbolTable.h.

References llvm::StringMap< ValueTy, AllocatorTy >::begin().

begin() [2/2]

const_iterator llvm::ValueSymbolTable::begin ( ) const

inline

Get a const_iterator that from the beginning of the symbol table.

Definition at line 104 of file ValueSymbolTable.h.

References llvm::StringMap< ValueTy, AllocatorTy >::begin().

dump()

LLVM_DUMP_METHOD void ValueSymbolTable::dump

(

)

const

This function can be used from the debugger to display the content of the symbol table while debugging.

Print out symbol table on stderr

Definition at line 133 of file ValueSymbolTable.cpp.

References I.

empty()

bool llvm::ValueSymbolTable::empty ( ) const

inline

Returns

true iff the symbol table is empty Determine if the symbol table is empty

Definition at line 86 of file ValueSymbolTable.h.

References llvm::StringMapImpl::empty().

end() [1/2]

iterator llvm::ValueSymbolTable::end ( )

inline

Get an iterator to the end of the symbol table.

Definition at line 107 of file ValueSymbolTable.h.

References llvm::StringMap< ValueTy, AllocatorTy >::end().

end() [2/2]

const_iterator llvm::ValueSymbolTable::end ( ) const

inline

Get a const_iterator to the end of the symbol table.

Definition at line 110 of file ValueSymbolTable.h.

References llvm::StringMap< ValueTy, AllocatorTy >::end().

lookup()

Value * llvm::ValueSymbolTable::lookup ( StringRef  Name ) const

inline

This method finds the value with the given Name in the the symbol table.

Returns

the value associated with the Name Lookup a named Value.

Definition at line 77 of file ValueSymbolTable.h.

References llvm::StringMap< ValueTy, AllocatorTy >::lookup(), and Name.

Referenced by parseIRValue().

size()

unsigned llvm::ValueSymbolTable::size ( ) const

inline

The number of name/type pairs is returned.

Definition at line 89 of file ValueSymbolTable.h.

References llvm::StringMapImpl::size().

Friends And Related Function Documentation

SymbolTableListTraits< Argument >

friend class SymbolTableListTraits< Argument >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< BasicBlock >

friend class SymbolTableListTraits< BasicBlock >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< Function >

friend class SymbolTableListTraits< Function >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< GlobalAlias >

friend class SymbolTableListTraits< GlobalAlias >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< GlobalIFunc >

friend class SymbolTableListTraits< GlobalIFunc >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< GlobalVariable >

friend class SymbolTableListTraits< GlobalVariable >

friend

Definition at line 1 of file ValueSymbolTable.h.

SymbolTableListTraits< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >

friend class SymbolTableListTraits< Instruction, ilist_iterator_bits< true >, ilist_parent< BasicBlock > >

friend

Definition at line 1 of file ValueSymbolTable.h.

Value

friend class Value

friend

Definition at line 48 of file ValueSymbolTable.h.

---

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

• include/llvm/IR/ValueSymbolTable.h
• lib/IR/ValueSymbolTable.cpp