#include <berryExtensionTracker.h>

Inheritance diagram for berry::ExtensionTracker:

Collaboration diagram for berry::ExtensionTracker:

Public Member Functions
	ExtensionTracker ()

	~ExtensionTracker () override

	ExtensionTracker (IExtensionRegistry *theRegistry)

void	RegisterHandler (IExtensionChangeHandler *handler, const IExtensionPointFilter &filter) override

void	RegisterHandler (IExtensionChangeHandler *handler, const QString &extensionPointId) override

void	UnregisterHandler (IExtensionChangeHandler *handler) override

void	RegisterObject (const SmartPointer< IExtension > &element, const SmartPointer< Object > &object, ReferenceType referenceType) override

QList< SmartPointer< Object > >	GetObjects (const SmartPointer< IExtension > &element) const override

void	Close () override

void	UnregisterObject (const SmartPointer< IExtension > &extension, const SmartPointer< Object > &object) override

QList< SmartPointer< Object > >	UnregisterObject (const SmartPointer< IExtension > &extension) override

Public Member Functions inherited from berry::IExtensionTracker
virtual	~IExtensionTracker ()

Static Public Member Functions
static IExtensionPointFilter	CreateExtensionPointFilter (const SmartPointer< IExtensionPoint > &xpt)

static IExtensionPointFilter	CreateExtensionPointFilter (const QList< SmartPointer< IExtensionPoint > > &xpts)

static IExtensionPointFilter	CreateNamespaceFilter (const QString &id)

Protected Member Functions
virtual void	ApplyAdd (IExtensionChangeHandler *handler, const SmartPointer< IExtension > &extension)

virtual void	ApplyRemove (IExtensionChangeHandler *handler, const SmartPointer< IExtension > &removedExtension, const QList< SmartPointer< Object > > &removedObjects)

Additional Inherited Members
Public Types inherited from berry::IExtensionTracker
enum	ReferenceType { REF_STRONG, REF_WEAK }

Detailed Description

Implementation of the IExtensionTracker.

See also: IExtensionTracker

Definition at line 30 of file berryExtensionTracker.h.

Constructor & Destructor Documentation

◆ ExtensionTracker() [1/2]

berry::ExtensionTracker::ExtensionTracker ( )

Definition at line 111 of file berryExtensionTracker.cpp.

References berry::Platform::GetExtensionRegistry().

◆ ~ExtensionTracker()

berry::ExtensionTracker::~ExtensionTracker ( )

override

Definition at line 116 of file berryExtensionTracker.cpp.

◆ ExtensionTracker() [2/2]

berry::ExtensionTracker::ExtensionTracker ( IExtensionRegistry * theRegistry )

Construct a new instance of the extension tracker using the given registry containing tracked extensions and extension points.

Parameters

theRegistry the extension registry to track

Definition at line 120 of file berryExtensionTracker.cpp.

References BERRY_ERROR.

Member Function Documentation

◆ ApplyAdd()

void berry::ExtensionTracker::ApplyAdd	(	IExtensionChangeHandler *	handler,
		const SmartPointer< IExtension > &	extension
	)

protectedvirtual

Definition at line 320 of file berryExtensionTracker.cpp.

References berry::IExtensionChangeHandler::AddExtension().

◆ ApplyRemove()

void berry::ExtensionTracker::ApplyRemove	(	IExtensionChangeHandler *	handler,
		const SmartPointer< IExtension > &	removedExtension,
		const QList< SmartPointer< Object > > &	removedObjects
	)

protectedvirtual

Definition at line 325 of file berryExtensionTracker.cpp.

References berry::IExtensionChangeHandler::RemoveExtension().

◆ Close()

void berry::ExtensionTracker::Close ( )

overridevirtual

Close the tracker. All registered objects are freed and all handlers are being automatically removed.

Implements berry::IExtensionTracker.

Definition at line 200 of file berryExtensionTracker.cpp.

◆ CreateExtensionPointFilter() [1/2]

IExtensionPointFilter berry::ExtensionTracker::CreateExtensionPointFilter ( const SmartPointer< IExtensionPoint > & xpt )

static

Return an instance of filter matching all changes for the given extension point.

Parameters

xpt	the extension point

Returns: a filter

Definition at line 259 of file berryExtensionTracker.cpp.

◆ CreateExtensionPointFilter() [2/2]

IExtensionPointFilter berry::ExtensionTracker::CreateExtensionPointFilter ( const QList< SmartPointer< IExtensionPoint > > & xpts )

static

Return an instance of filter matching all changes for the given extension points.

Parameters

xpts	the extension points used to filter

Returns: a filter

Definition at line 277 of file berryExtensionTracker.cpp.

◆ CreateNamespaceFilter()

IExtensionPointFilter berry::ExtensionTracker::CreateNamespaceFilter ( const QString & id )

static

Return an instance of filter matching all changes from a given plugin.

Parameters

id	the plugin id

Returns: a filter

Definition at line 302 of file berryExtensionTracker.cpp.

References berry::IExtensionPoint::GetNamespaceIdentifier().

◆ GetObjects()

QList< SmartPointer< Object > > berry::ExtensionTracker::GetObjects ( const SmartPointer< IExtension > & extension ) const

overridevirtual

Return all the objects that have been associated with the given extension. All objects registered strongly will be return unless they have been unregistered. The objects registered softly or weakly may not be returned if they have been garbage collected. Return an empty array if no associations exist.

Parameters

extension the extension for which the object must be returned

Returns: the array of associated objects

Implements berry::IExtensionTracker.

Definition at line 177 of file berryExtensionTracker.cpp.

References berry::WeakPointer< TObjectType >::Expired(), and berry::WeakPointer< TObjectType >::Lock().

◆ RegisterHandler() [1/2]

void berry::ExtensionTracker::RegisterHandler	(	IExtensionChangeHandler *	handler,
		const IExtensionPointFilter &	filter
	)

overridevirtual

Register an extension change handler with this tracker using the given filter.

Parameters

handler	the handler to be registered
filter	the filter to use to choose interesting changes

Implements berry::IExtensionTracker.

Definition at line 137 of file berryExtensionTracker.cpp.

Referenced by RegisterHandler().

◆ RegisterHandler() [2/2]

void berry::ExtensionTracker::RegisterHandler	(	IExtensionChangeHandler *	handler,
		const QString &	extensionPointId
	)

overridevirtual

Register an extension change handler with this tracker for the given extension point id.

Parameters

handler	the handler to be registered
extensionPointId	the extension point id to track

Implements berry::IExtensionTracker.

Definition at line 145 of file berryExtensionTracker.cpp.

References RegisterHandler().

◆ RegisterObject()

void berry::ExtensionTracker::RegisterObject	(	const SmartPointer< IExtension > &	extension,
		const SmartPointer< Object > &	object,
		ReferenceType	referenceType
	)

overridevirtual

Create an association between the given extension and the given object. The referenceType indicates how strongly the object is being kept in memory. There are 2 possible values: REF_STRONG and REF_WEAK.

Parameters

extension	the extension
object	the object to associate with the extension
referenceType	one of REF_STRONG, REF_WEAK

Implements berry::IExtensionTracker.

Definition at line 160 of file berryExtensionTracker.cpp.

References berry::SmartPointer< TObjectType >::IsNull(), berry::IExtensionTracker::REF_STRONG, and berry::IExtensionTracker::REF_WEAK.

◆ UnregisterHandler()

void berry::ExtensionTracker::UnregisterHandler ( IExtensionChangeHandler * handler )

overridevirtual

Unregister the given extension change handler previously registered with this tracker.

Parameters

handler the handler to be unregistered

Implements berry::IExtensionTracker.

Definition at line 151 of file berryExtensionTracker.cpp.

◆ UnregisterObject() [1/2]

void berry::ExtensionTracker::UnregisterObject	(	const SmartPointer< IExtension > &	extension,
		const SmartPointer< Object > &	object
	)

overridevirtual

Remove an association between the given extension and the given object.

Parameters

extension	the extension under which the object has been registered
object	the object to unregister

Implements berry::IExtensionTracker.

Definition at line 216 of file berryExtensionTracker.cpp.

◆ UnregisterObject() [2/2]

QList< SmartPointer< Object > > berry::ExtensionTracker::UnregisterObject ( const SmartPointer< IExtension > & extension )

overridevirtual

Remove all the objects associated with the given extension. Return the removed objects.

Parameters

extension the extension for which the objects are removed

Returns: the objects that were associated with the extension

Implements berry::IExtensionTracker.

Definition at line 233 of file berryExtensionTracker.cpp.

References berry::WeakPointer< TObjectType >::Expired(), and berry::WeakPointer< TObjectType >::Lock().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExtensionTracker() [1/2]

◆ ~ExtensionTracker()

◆ ExtensionTracker() [2/2]

Member Function Documentation

◆ ApplyAdd()

◆ ApplyRemove()

◆ Close()

◆ CreateExtensionPointFilter() [1/2]

◆ CreateExtensionPointFilter() [2/2]

◆ CreateNamespaceFilter()

◆ GetObjects()

◆ RegisterHandler() [1/2]

◆ RegisterHandler() [2/2]

◆ RegisterObject()

◆ UnregisterHandler()

◆ UnregisterObject() [1/2]

◆ UnregisterObject() [2/2]