KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase > Class Template Reference

Abstract definition-use chain use builder class. More...

#include <abstractusebuilder.h>

Inherits LanguageSpecificUseBuilderBase.

List of all members.

Classes
struct	ContextUseTracker
	Register a new use at the AST node name. More...
Public Member Functions
	AbstractUseBuilder ()
void	buildUses (T *node)
Protected Member Functions
virtual void	closeContext ()
void	newUse (T *node, const SimpleRange &newRange, Declaration *declaration)
void	newUse (T *node, KDevelop::Declaration *declaration)
void	newUse (NameT *name)
virtual void	openContext (KDevelop::DUContext *newContext)

---

Detailed Description

template<typename T, typename NameT, typename LanguageSpecificUseBuilderBase>
class KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >

Abstract definition-use chain use builder class.

The AbstractUseBuilder is a convenience class template for creating customized definition-use chain use builders from an AST. It simplifies:

• use of your editor integrator
• creating or modifying existing Uses

Author:

Hamish Rodda <rodda@kde.org>

Definition at line 44 of file abstractusebuilder.h.

---

Constructor & Destructor Documentation

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::AbstractUseBuilder

(

)

[inline]

Constructor.

Definition at line 48 of file abstractusebuilder.h.

---

Member Function Documentation

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::buildUses

(

T *

node

)

[inline]

Iterate an existing duchain, and add, remove or modify uses as determined from the ast.

Parameters:

node

AST node to start visiting.

Definition at line 59 of file abstractusebuilder.h.

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

virtual void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::closeContext

(

)

[inline, protected, virtual]

Reimplementation of closeContext, to track which uses should be assigned to which context.

Definition at line 229 of file abstractusebuilder.h.

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::newUse	(	T *	node,
		const SimpleRange &	newRange,
		Declaration *	declaration
	)			[inline, protected]

Register a new use.

Parameters:

	newRange	Text range which encompasses the use.
	decl	Declaration which is being used. May be null when a declaration cannot be found for the use.

Todo:

This can cause I/O, so it would be better if it was possible with only a read-lock

Definition at line 124 of file abstractusebuilder.h.

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::newUse	(	T *	node,
		KDevelop::Declaration *	declaration
	)			[inline, protected]

Register a new use for a declaration with a node.

Todo:

Work this over! We must not pass around "Declaration*" values if the duchain is not locked.

Parameters:

	node	Node which encompasses the use.
	decl	Declaration which is being used. May be null when a declaration cannot be found for the use.

Definition at line 113 of file abstractusebuilder.h.

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::newUse

(

NameT *

name

)

[inline, protected]

Todo:

Don't call findDeclarations during write-lock, it can lead to UI lockups

Definition at line 85 of file abstractusebuilder.h.

template<typename T , typename NameT , typename LanguageSpecificUseBuilderBase >

virtual void KDevelop::AbstractUseBuilder< T, NameT, LanguageSpecificUseBuilderBase >::openContext

(

KDevelop::DUContext *

newContext

)

[inline, protected, virtual]

Reimplementation of openContext, to track which uses should be assigned to which context.

Definition at line 211 of file abstractusebuilder.h.

---

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

• abstractusebuilder.h