KDevelop::IndexedDeclaration Class Reference

#include <indexeddeclaration.h>

Public Member Functions
	IndexedDeclaration (const Declaration *decl=nullptr)
	IndexedDeclaration (uint topContext, uint declarationIndex)
Declaration *	data () const
Declaration *	declaration () const
QPair< uint, uint >	dummyData () const
uint	hash () const
IndexedTopDUContext	indexedTopContext () const
bool	isDummy () const
bool	isValid () const
uint	localIndex () const
bool	operator< (const IndexedDeclaration &rhs) const
bool	operator== (const IndexedDeclaration &rhs) const
void	setDummyData (QPair< uint, uint > data)
void	setIsDummy (bool dummy)
uint	topContextIndex () const

Detailed Description

Represents a declaration only by its global indices.

Definition at line 33 of file indexeddeclaration.h.

Constructor & Destructor Documentation

IndexedDeclaration() [1/2]

IndexedDeclaration::IndexedDeclaration

(

const Declaration *

decl = nullptr

)

Definition at line 33 of file indexeddeclaration.cpp.

IndexedDeclaration() [2/2]

IndexedDeclaration::IndexedDeclaration	(	uint	topContext,
		uint	declarationIndex
	)

Definition at line 27 of file indexeddeclaration.cpp.

Member Function Documentation

data()

Declaration* KDevelop::IndexedDeclaration::data ( ) const

inline

Warning

Duchain must be read locked

Definition at line 47 of file indexeddeclaration.h.

declaration()

Declaration * IndexedDeclaration::declaration

(

)

const

Warning

Duchain must be read locked

Definition at line 44 of file indexeddeclaration.cpp.

dummyData()

QPair<uint, uint> KDevelop::IndexedDeclaration::dummyData ( ) const

inline

Definition at line 129 of file indexeddeclaration.h.

hash()

uint KDevelop::IndexedDeclaration::hash ( ) const

inline

Definition at line 57 of file indexeddeclaration.h.

indexedTopContext()

IndexedTopDUContext KDevelop::IndexedDeclaration::indexedTopContext ( ) const

inline

Definition at line 96 of file indexeddeclaration.h.

isDummy()

bool KDevelop::IndexedDeclaration::isDummy ( ) const

inline

Definition at line 122 of file indexeddeclaration.h.

isValid()

bool KDevelop::IndexedDeclaration::isValid ( ) const

inline

Warning

The duchain needs to be locked when this is called

Definition at line 65 of file indexeddeclaration.h.

localIndex()

uint KDevelop::IndexedDeclaration::localIndex ( ) const

inline

Returns

Index of the Declaration within the top context

Definition at line 80 of file indexeddeclaration.h.

operator<()

bool KDevelop::IndexedDeclaration::operator< ( const IndexedDeclaration &  rhs ) const

inline

Definition at line 70 of file indexeddeclaration.h.

operator==()

bool KDevelop::IndexedDeclaration::operator== ( const IndexedDeclaration &  rhs ) const

inline

Definition at line 52 of file indexeddeclaration.h.

setDummyData()

void KDevelop::IndexedDeclaration::setDummyData ( QPair< uint, uint >  data )

inline

Warning

Do not call this when this object is valid.

The first integer loses one bit of precision.

Definition at line 140 of file indexeddeclaration.h.

setIsDummy()

void KDevelop::IndexedDeclaration::setIsDummy ( bool  dummy )

inline

The following functions allow storing 2 integers in this object and marking it as a dummy, which makes the isValid() function always return false for this object, and use the integers for other purposes.

Clears the contained data

Definition at line 111 of file indexeddeclaration.h.

topContextIndex()

uint KDevelop::IndexedDeclaration::topContextIndex ( ) const

inline

Definition at line 88 of file indexeddeclaration.h.

---

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

• indexeddeclaration.h
• indexeddeclaration.cpp