PDBSymbol defines the base of the inheritance hierarchy for concrete symbol types (e.g. More...

#include "llvm/DebugInfo/PDB/PDBSymbol.h"

Inheritance diagram for llvm::pdb::PDBSymbol:

[legend]

Collaboration diagram for llvm::pdb::PDBSymbol:

Public Member Functions
virtual	~PDBSymbol ()

virtual void	dump (PDBSymDumper &Dumper) const =0
	Dumps the contents of a symbol a raw_ostream. More...

virtual void	dumpRight (PDBSymDumper &Dumper) const
	For certain PDBSymbolTypes, dumps additional information for the type that normally goes on the right side of the symbol. More...

void	defaultDump (raw_ostream &OS, int Indent, PdbSymbolIdField ShowFlags, PdbSymbolIdField RecurseFlags) const

void	dumpProperties () const

void	dumpChildStats () const

PDB_SymType	getSymTag () const

uint32_t	getSymIndexId () const

template<typename T >
std::unique_ptr< T >	findOneChild () const

template<typename T >
std::unique_ptr< ConcreteSymbolEnumerator< T > >	findAllChildren () const

std::unique_ptr< IPDBEnumSymbols >	findAllChildren (PDB_SymType Type) const

std::unique_ptr< IPDBEnumSymbols >	findAllChildren () const

std::unique_ptr< IPDBEnumSymbols >	findChildren (PDB_SymType Type, StringRef Name, PDB_NameSearchFlags Flags) const

std::unique_ptr< IPDBEnumSymbols >	findChildrenByRVA (PDB_SymType Type, StringRef Name, PDB_NameSearchFlags Flags, uint32_t RVA) const

std::unique_ptr< IPDBEnumSymbols >	findInlineFramesByRVA (uint32_t RVA) const

const IPDBRawSymbol &	getRawSymbol () const

IPDBRawSymbol &	getRawSymbol ()

const IPDBSession &	getSession () const

std::unique_ptr< IPDBEnumSymbols >	getChildStats (TagStats &Stats) const

Static Public Member Functions
static std::unique_ptr< PDBSymbol >	create (const IPDBSession &PDBSession, std::unique_ptr< IPDBRawSymbol > RawSymbol)

static std::unique_ptr< PDBSymbol >	create (const IPDBSession &PDBSession, IPDBRawSymbol &RawSymbol)

template<typename ConcreteT >
static std::unique_ptr< ConcreteT >	createAs (const IPDBSession &PDBSession, std::unique_ptr< IPDBRawSymbol > RawSymbol)

template<typename ConcreteT >
static std::unique_ptr< ConcreteT >	createAs (const IPDBSession &PDBSession, IPDBRawSymbol &RawSymbol)

Protected Member Functions
	PDBSymbol (const IPDBSession &PDBSession)

	PDBSymbol (PDBSymbol &&Other)

std::unique_ptr< PDBSymbol >	getSymbolByIdHelper (uint32_t Id) const

template<typename ConcreteType >
std::unique_ptr< ConcreteType >	getConcreteSymbolByIdHelper (uint32_t Id) const

Protected Attributes
const IPDBSession &	Session

std::unique_ptr< IPDBRawSymbol >	OwnedRawSymbol

IPDBRawSymbol *	RawSymbol = nullptr

Detailed Description

PDBSymbol defines the base of the inheritance hierarchy for concrete symbol types (e.g.

functions, executables, vtables, etc). All concrete symbol types inherit from PDBSymbol and expose the exact set of methods that are valid for that particular symbol type, as described in the Microsoft reference "Lexical and Class Hierarchy of Symbol Types": https://msdn.microsoft.com/en-us/library/370hs6k4.aspx

Definition at line 74 of file PDBSymbol.h.

Constructor & Destructor Documentation

◆ PDBSymbol() [1/2]

PDBSymbol::PDBSymbol ( const IPDBSession & PDBSession )

explicitprotected

Definition at line 53 of file PDBSymbol.cpp.

◆ PDBSymbol() [2/2]

PDBSymbol::PDBSymbol ( PDBSymbol && Other )

protected

Definition at line 55 of file PDBSymbol.cpp.

References Other, and ~PDBSymbol().

◆ ~PDBSymbol()

PDBSymbol::~PDBSymbol ( )

virtualdefault

Referenced by createAs(), and PDBSymbol().

Member Function Documentation

◆ create() [1/2]

std::unique_ptr< PDBSymbol > PDBSymbol::create	(	const IPDBSession &	PDBSession,
		std::unique_ptr< IPDBRawSymbol >	RawSymbol
	)

static

Definition at line 103 of file PDBSymbol.cpp.

Referenced by createAs(), llvm::pdb::DIASession::findSymbolByAddress(), llvm::pdb::DIASession::findSymbolByRVA(), llvm::pdb::DIASession::findSymbolBySectOffset(), llvm::pdb::DIAEnumSymbols::getChildAtIndex(), llvm::pdb::DIASession::getGlobalScope(), llvm::pdb::DIAEnumSymbols::getNext(), llvm::pdb::DIASession::getSymbolById(), and llvm::pdb::SymbolCache::getSymbolById().

◆ create() [2/2]

std::unique_ptr< PDBSymbol > PDBSymbol::create	(	const IPDBSession &	PDBSession,
		IPDBRawSymbol &	RawSymbol
	)

static

Definition at line 111 of file PDBSymbol.cpp.

References llvm::pdb::IPDBRawSymbol::getSymTag(), and RawSymbol.

◆ createAs() [1/2]

template<typename ConcreteT >

static std::unique_ptr<ConcreteT> llvm::pdb::PDBSymbol::createAs	(	const IPDBSession &	PDBSession,
		std::unique_ptr< IPDBRawSymbol >	RawSymbol
	)

inlinestatic

Definition at line 91 of file PDBSymbol.h.

References create().

◆ createAs() [2/2]

template<typename ConcreteT >

static std::unique_ptr<ConcreteT> llvm::pdb::PDBSymbol::createAs	(	const IPDBSession &	PDBSession,
		IPDBRawSymbol &	RawSymbol
	)

inlinestatic

Definition at line 97 of file PDBSymbol.h.

References create(), dump(), and ~PDBSymbol().

◆ defaultDump()

void PDBSymbol::defaultDump	(	raw_ostream &	OS,
		int	Indent,
		PdbSymbolIdField	ShowFlags,
		PdbSymbolIdField	RecurseFlags
	)		const

Definition at line 118 of file PDBSymbol.cpp.

References llvm::pdb::IPDBRawSymbol::dump(), and RawSymbol.

Referenced by dumpProperties(), and dumpRight().

◆ dump()

virtual void llvm::pdb::PDBSymbol::dump ( PDBSymDumper & Dumper ) const

pure virtual

Dumps the contents of a symbol a raw_ostream.

By default this will just call dump() on the underlying RawSymbol, which allows us to discover unknown properties, but individual implementations of PDBSymbol may override the behavior to only dump known fields.