KDevelop Namespace Reference

Classes
class	AbstractItemRepository
class	AbstractRepositoryManager
class	Bucket
class	DynamicItem
class	ExampleItem
class	ExampleItemRequest
class	IndexedString
class	ItemRepository
class	ItemRepositoryRegistry
struct	Locker
struct	Locker< true >
struct	ReferenceCountManager
struct	RepositoryManager

Enumerations
enum	{ ItemRepositoryBucketSize = 1 << 16, ItemRepositoryBucketLimit = 1 << 16 }

Functions
KDEVPLATFORMSERIALIZATION_EXPORT void	disableDUChainReferenceCounting (void *start)
KDEVPLATFORMSERIALIZATION_EXPORT void	enableDUChainReferenceCounting (void *start, unsigned int size)
ItemRepositoryRegistry &	globalItemRepositoryRegistry ()
void	initReferenceCounting ()
template<typename T >
const T *	make_const (const T *argument)
uint	qHash (const KDevelop::IndexedString &str)
bool	shouldDoDUChainReferenceCounting (void *item)
bool	shouldDoDUChainReferenceCountingInternal (void *item)
uint	staticItemRepositoryVersion ()

Variables
bool	doReferenceCounting = false
QPair< uint, uint >	refCountingFirstRangeExtent = qMakePair(0u, 0u)
void *	refCountingFirstRangeStart = nullptr
bool	refCountingHasAdditionalRanges = false
QMutex	refCountingLock
QMap< void *, QPair< uint, uint > > *	refCountingRanges = new QMap<void*, QPair<uint, uint>>()

Enumeration Type Documentation

anonymous enum

anonymous enum

This file implements a generic bucket-based indexing repository, that can be used for example to index strings.

All you need to do is define your item type that you want to store into the repository, and create a request item similar to ExampleItemRequest that compares and fills the defined item type.

For example the string repository uses "unsigned short" as item-type, uses that actual value to store the length of the string, and uses the space behind to store the actual string content.

See also

AbstractItemRepository

ItemRepository

ExampleItem

ExampleItemRequest

typerepository.h

stringrepository.h

indexedstring.h

Enumerator
ItemRepositoryBucketSize
ItemRepositoryBucketLimit

Definition at line 96 of file itemrepository.h.

Function Documentation

disableDUChainReferenceCounting()

void KDevelop::disableDUChainReferenceCounting

(

void *

start

)

Must be called as often as enableDUChainReferenceCounting, with the same ranges Must never be called for the same range twice, and not for overlapping ranges.

Parameters

start

Position where the reference-counting was started

Definition at line 43 of file referencecounting.cpp.

enableDUChainReferenceCounting()

void KDevelop::enableDUChainReferenceCounting	(	void *	start,
		unsigned int	size
	)

Enable reference-counting for the given range You should only enable the reference-counting for the time it's really needed, and it always has to be enabled too when the items are deleted again, else it will lead to inconsistencies in the repository.

Warning

If you are not working on the duchain internal storage mechanism, you should not care about this stuff at all.

Parameters

start	Position where to start the reference-counting
size	Size of the area in bytes

Definition at line 80 of file referencecounting.cpp.

globalItemRepositoryRegistry()

KDEVPLATFORMSERIALIZATION_EXPORT ItemRepositoryRegistry & KDevelop::globalItemRepositoryRegistry

(

)

The global item-repository registry that is used by default.

Returns

The global item-repository registry (now it is ItemRepositoryRegistry::self()).

Definition at line 206 of file itemrepositoryregistry.cpp.

initReferenceCounting()

KDEVPLATFORMSERIALIZATION_EXPORT void KDevelop::initReferenceCounting

(

)

Definition at line 277 of file referencecounting.cpp.

make_const()

template<typename T >

const T* KDevelop::make_const

(

const T *

argument

)

Definition at line 36 of file referencecounting.h.

qHash()

uint KDevelop::qHash ( const KDevelop::IndexedString &  str )

inline

Definition at line 252 of file indexedstring.h.

shouldDoDUChainReferenceCounting()

bool KDevelop::shouldDoDUChainReferenceCounting ( void *  item )

inline

This is used by indexed items to decide whether they should do reference-counting.

Definition at line 67 of file referencecounting.h.

shouldDoDUChainReferenceCountingInternal()

bool KDevelop::shouldDoDUChainReferenceCountingInternal ( void *  item )

inline

The spin-lock ,must already be locked

Definition at line 54 of file referencecounting.h.

staticItemRepositoryVersion()

KDEVPLATFORMSERIALIZATION_EXPORT uint KDevelop::staticItemRepositoryVersion

(

)

Returns a version-number that is used to reset the item-repository after incompatible layout changes.

Definition at line 24 of file abstractitemrepository.cpp.

Variable Documentation

doReferenceCounting

KDEVPLATFORMSERIALIZATION_EXPORT bool KDevelop::doReferenceCounting = false

Since shouldDoDUChainReferenceCounting is called extremely often, we export some internals into the header here, so the reference-counting code can be inlined.

Definition at line 29 of file referencecounting.cpp.

refCountingFirstRangeExtent

KDEVPLATFORMSERIALIZATION_EXPORT QPair< uint, uint > KDevelop::refCountingFirstRangeExtent = qMakePair(0u, 0u)

Definition at line 40 of file referencecounting.cpp.

refCountingFirstRangeStart

KDEVPLATFORMSERIALIZATION_EXPORT void * KDevelop::refCountingFirstRangeStart = nullptr

Definition at line 39 of file referencecounting.cpp.

refCountingHasAdditionalRanges

KDEVPLATFORMSERIALIZATION_EXPORT bool KDevelop::refCountingHasAdditionalRanges = false

Definition at line 35 of file referencecounting.cpp.

refCountingLock

KDEVPLATFORMSERIALIZATION_EXPORT QMutex KDevelop::refCountingLock

Definition at line 32 of file referencecounting.cpp.

refCountingRanges

KDEVPLATFORMSERIALIZATION_EXPORT QMap< void *, QPair< uint, uint > > * KDevelop::refCountingRanges = new QMap<void*, QPair<uint, uint>>()

Definition at line 34 of file referencecounting.cpp.