LLVM API Documentation

Public Types | Public Member Functions | Friends
llvm::object::SymbolRef Class Reference

#include <ObjectFile.h>

Inheritance diagram for llvm::object::SymbolRef:
Inheritance graph
[legend]
Collaboration diagram for llvm::object::SymbolRef:
Collaboration graph
[legend]

List of all members.

Public Types

enum  Type {
  ST_Unknown, ST_Data, ST_Debug, ST_File,
  ST_Function, ST_Other
}

Public Member Functions

 SymbolRef ()
 SymbolRef (DataRefImpl SymbolP, const ObjectFile *Owner)
std::error_code getName (StringRef &Result) const
std::error_code getAddress (uint64_t &Result) const
std::error_code getAlignment (uint32_t &Result) const
 Get the alignment of this symbol as the actual value (not log 2).
std::error_code getSize (uint64_t &Result) const
std::error_code getType (SymbolRef::Type &Result) const
std::error_code getOther (uint8_t &Result) const
std::error_code getSection (section_iterator &Result) const
 Get section this symbol is defined in reference to. Result is end_sections() if it is undefined or is an absolute symbol.
const ObjectFilegetObject () const

Friends

class SectionRef

Detailed Description

SymbolRef - This is a value type class that represents a single symbol in the list of symbols in the object file.

Definition at line 129 of file ObjectFile.h.


Member Enumeration Documentation

Enumerator:
ST_Unknown 
ST_Data 
ST_Debug 
ST_File 
ST_Function 
ST_Other 

Definition at line 135 of file ObjectFile.h.


Constructor & Destructor Documentation

Definition at line 133 of file ObjectFile.h.

llvm::object::SymbolRef::SymbolRef ( DataRefImpl  SymbolP,
const ObjectFile Owner 
) [inline]

Definition at line 338 of file ObjectFile.h.


Member Function Documentation

std::error_code llvm::object::SymbolRef::getAddress ( uint64_t &  Result) const [inline]

Returns the symbol virtual address (i.e. address at which it will be mapped).

Definition at line 345 of file ObjectFile.h.

References getObject(), llvm::object::BasicSymbolRef::getRawDataRefImpl(), and llvm::object::ObjectFile::getSymbolAddress().

Referenced by llvm::DWARFContextInMemory::DWARFContextInMemory(), and llvm::getOffset().

std::error_code llvm::object::SymbolRef::getAlignment ( uint32_t &  Result) const [inline]

Get the alignment of this symbol as the actual value (not log 2).

Definition at line 349 of file ObjectFile.h.

References getObject(), llvm::object::BasicSymbolRef::getRawDataRefImpl(), and llvm::object::ObjectFile::getSymbolAlignment().

std::error_code llvm::object::SymbolRef::getName ( StringRef Result) const [inline]
std::error_code llvm::object::SymbolRef::getOther ( uint8_t &  Result) const [inline]
std::error_code llvm::object::SymbolRef::getSection ( section_iterator Result) const [inline]

Get section this symbol is defined in reference to. Result is end_sections() if it is undefined or is an absolute symbol.

Definition at line 357 of file ObjectFile.h.

References getObject(), llvm::object::BasicSymbolRef::getRawDataRefImpl(), and llvm::object::ObjectFile::getSymbolSection().

Referenced by llvm::getOffset(), and llvm::RuntimeDyldELF::processRelocationRef().

std::error_code llvm::object::SymbolRef::getSize ( uint64_t &  Result) const [inline]
std::error_code llvm::object::SymbolRef::getType ( SymbolRef::Type Result) const [inline]

Friends And Related Function Documentation

friend class SectionRef [friend]

Definition at line 130 of file ObjectFile.h.


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