#include <KoResourceServer.h>

Public Types
typedef KoResourceServerObserver< T >	ObserverType

Public Member Functions
void	addObserver (ObserverType *observer)

bool	addResource (QSharedPointer< T > resource, bool save=true)
	Adds an already loaded resource to the server.

QVector< KisTagSP >	assignedTagsList (KoResourceSP resource) const

QSharedPointer< T >	firstResource () const
	Return the first resource available.

KoResourceSP	importResourceFile (const QString &filename, const bool allowOverwrite)

	KoResourceServer (const QString &type)

bool	reloadResource (QSharedPointer< T > resource)

void	removeObserver (ObserverType *observer)

void	removeResourceFile (const QString &filename)
	Removes the resource file from the resource server.

bool	removeResourceFromServer (QSharedPointer< T > resource)
	Remove a resource from Resource Server but not from a file.

QSharedPointer< T >	resource (const QString &md5, const QString &fileName, const QString &name)
	resource retrieves a resource. If the md5sum is not empty, the resource will only be retrieved if a resource with that md5sum exists. If it is empty, a fallback to filename or name is possible.

int	resourceCount () const

KisResourceModel *	resourceModel () const

QString	saveLocation ()
	Returns path where to save user defined and imported resources to.

bool	updateResource (QSharedPointer< T > resource)

virtual	~KoResourceServer ()

Protected Member Functions
void	notifyRemovingResource (QSharedPointer< T > resource)

void	notifyResourceAdded (QSharedPointer< T > resource)

void	notifyResourceChanged (QSharedPointer< T > resource)

Private Member Functions
QSharedPointer< T >	resourceByFilename (const QString &filename) const

QSharedPointer< T >	resourceByMD5 (const QString &md5) const

QSharedPointer< T >	resourceByName (const QString &name) const

Private Attributes
QList< ObserverType * >	m_observers

KisResourceModel *	m_resourceModel {0}

KisTagModel *	m_tagModel {0}

QString	m_type

Detailed Description

template<class T>
class KoResourceServer< T >

KoResourceServer is a shim around KisResourceModel. It knows nothing by its own, and does nothing on its own. It can only be used in the gui thread.

Definition at line 75 of file KoResourceServer.h.

Member Typedef Documentation

◆ ObserverType

template<class T >

typedef KoResourceServerObserver<T> KoResourceServer< T >::ObserverType

Definition at line 79 of file KoResourceServer.h.

Constructor & Destructor Documentation

◆ KoResourceServer()

template<class T >

KoResourceServer< T >::KoResourceServer ( const QString & type )

inline

Definition at line 81 of file KoResourceServer.h.

        : m_resourceModel(new KisResourceModel(type))
        , m_tagModel(new KisTagModel(type))
        , m_type(type)
    {
        Q_ASSERT(!type.isEmpty());
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, and kisBacktrace().

◆ ~KoResourceServer()

template<class T >

virtual KoResourceServer< T >::~KoResourceServer ( )

inlinevirtual

Definition at line 94 of file KoResourceServer.h.

    {
        delete m_resourceModel;
        delete m_tagModel;
        Q_FOREACH (ObserverType* observer, m_observers) {
            observer->unsetResourceServer();
        }
    }

References KoResourceServer< T >::m_observers, KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::m_tagModel, and KoResourceServerObserver< T >::unsetResourceServer().

Member Function Documentation

◆ addObserver()

template<class T >

void KoResourceServer< T >::addObserver ( ObserverType * observer )

inline

Adds an observer to the server

Parameters

observer	the observer to be added
notifyLoadedResources	determines if the observer should be notified about the already loaded resources

Definition at line 208 of file KoResourceServer.h.

    {
        if (observer && !m_observers.contains(observer)) {
            m_observers.append(observer);
        }
    }

References KoResourceServer< T >::m_observers.

◆ addResource()

template<class T >

bool KoResourceServer< T >::addResource	(	QSharedPointer< T >	resource,
		bool	save = true )

inline

Adds an already loaded resource to the server.

Definition at line 133 of file KoResourceServer.h.

                                                                   {
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        if (!resource || !resource->valid()) {
            warnResource << "Tried to add an invalid resource!" << resource;
            return false;
        }
 
        if (m_resourceModel->addResource(resource, save ? QString() : "memory")) {
            notifyResourceAdded(resource);
            return true;
        }
 
        return false;
    }

References KisResourceModel::addResource(), KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::notifyResourceAdded(), KoResourceServer< T >::resource(), and warnResource.

◆ assignedTagsList()

template<class T >

QVector< KisTagSP > KoResourceServer< T >::assignedTagsList ( KoResourceSP resource ) const

inline

Definition at line 336 of file KoResourceServer.h.

    {
        if (resource.isNull()) {
            return QVector<KisTagSP>();
        }
        return m_resourceModel->tagsForResource(resource->resourceId());
    }

References KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::resource(), and KisResourceModel::tagsForResource().

◆ firstResource()

template<class T >

QSharedPointer< T > KoResourceServer< T >::firstResource ( ) const

inline

Return the first resource available.

Definition at line 115 of file KoResourceServer.h.

    {
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        return m_resourceModel->resourceForIndex(m_resourceModel->index(0, 0)).dynamicCast<T>();
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, and KisResourceModel::resourceForIndex().

◆ importResourceFile()

template<class T >

KoResourceSP KoResourceServer< T >::importResourceFile	(	const QString &	filename,
		const bool	allowOverwrite )

inline

Creates a new resource from a given file and adds them to the resource server The base implementation does only load one resource per file, override to implement collections

Parameters

filename	file name of the resource file to be imported
fileCreation	decides whether to create the file in the saveLocation() directory

Definition at line 179 of file KoResourceServer.h.

    {
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        return m_resourceModel->importResourceFile(filename, allowOverwrite);
    }

References KisResourceModel::importResourceFile(), KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), and KoResourceServer< T >::m_resourceModel.

◆ notifyRemovingResource()

template<class T >

void KoResourceServer< T >::notifyRemovingResource ( QSharedPointer< T > resource )

inlineprotected

Definition at line 353 of file KoResourceServer.h.

    {
        Q_FOREACH (ObserverType* observer, m_observers) {
            observer->removingResource(resource);
        }
    }

References KoResourceServer< T >::m_observers, KoResourceServerObserver< T >::removingResource(), and KoResourceServer< T >::resource().

◆ notifyResourceAdded()

template<class T >

void KoResourceServer< T >::notifyResourceAdded ( QSharedPointer< T > resource )

inlineprotected

Definition at line 346 of file KoResourceServer.h.

    {
        Q_FOREACH (ObserverType* observer, m_observers) {
            observer->resourceAdded(resource);
        }
    }

References KoResourceServer< T >::m_observers, KoResourceServer< T >::resource(), and KoResourceServerObserver< T >::resourceAdded().

◆ notifyResourceChanged()

template<class T >

void KoResourceServer< T >::notifyResourceChanged ( QSharedPointer< T > resource )

inlineprotected

Definition at line 360 of file KoResourceServer.h.

    {
        Q_FOREACH (ObserverType* observer, m_observers) {
            observer->resourceChanged(resource);
        }
    }

References KoResourceServer< T >::m_observers, KoResourceServer< T >::resource(), and KoResourceServerObserver< T >::resourceChanged().

◆ reloadResource()

template<class T >

bool KoResourceServer< T >::reloadResource ( QSharedPointer< T > resource )

inline

Reloads the resource from the persistent storage

Definition at line 324 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
        bool result = m_resourceModel->reloadResource(resource);
        notifyResourceChanged(resource);
 
        return result;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::notifyResourceChanged(), KisResourceModel::reloadResource(), and KoResourceServer< T >::resource().

◆ removeObserver()

template<class T >

void KoResourceServer< T >::removeObserver ( ObserverType * observer )

inline

Removes an observer from the server

Parameters

observer the observer to be removed

Definition at line 219 of file KoResourceServer.h.

    {
        int index = m_observers.indexOf(observer);
        if (index < 0) {
            return;
        }
        m_observers.removeAt( index );
    }

References KoResourceServer< T >::m_observers.

◆ removeResourceFile()

template<class T >

void KoResourceServer< T >::removeResourceFile ( const QString & filename )

inline

Removes the resource file from the resource server.

Definition at line 191 of file KoResourceServer.h.

    {
        QFileInfo fi(filename);
 
        QSharedPointer<T> resource = resourceByFilename(fi.fileName());
        if (!resource) {
            warnResource << "Resource file do not exist ";
            return;
        }
        removeResourceFromServer(resource);
    }

References KoResourceServer< T >::removeResourceFromServer(), KoResourceServer< T >::resource(), KoResourceServer< T >::resourceByFilename(), and warnResource.

◆ removeResourceFromServer()

template<class T >

bool KoResourceServer< T >::removeResourceFromServer ( QSharedPointer< T > resource )

inline

Remove a resource from Resource Server but not from a file.

Definition at line 154 of file KoResourceServer.h.

                                                             {
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        if (m_resourceModel->setResourceInactive(m_resourceModel->indexForResource(resource))) {
            notifyRemovingResource(resource);
            return true;
        }
        return false;
    }

References KisResourceModel::indexForResource(), KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::notifyRemovingResource(), KoResourceServer< T >::resource(), and KisAbstractResourceModel::setResourceInactive().

◆ resource()

template<class T >

QSharedPointer< T > KoResourceServer< T >::resource	(	const QString &	md5,
		const QString &	fileName,
		const QString &	name )

inline

resource retrieves a resource. If the md5sum is not empty, the resource will only be retrieved if a resource with that md5sum exists. If it is empty, a fallback to filename or name is possible.

Parameters

md5	This is the hex-encoded md5sum as stored in e.g. configuration objects
fileName	A filename without the path
name	The name of the resource

Returns: a resource, or nullptr

Definition at line 301 of file KoResourceServer.h.

    {
        return KisGlobalResourcesInterface::instance()->source<T>(m_type).bestMatch(md5, fileName, name);
    }

References KisGlobalResourcesInterface::instance(), and KoResourceServer< T >::m_type.

◆ resourceByFilename()

template<class T >

QSharedPointer< T > KoResourceServer< T >::resourceByFilename ( const QString & filename ) const

inlineprivate

Definition at line 230 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
 
        if (filename.isEmpty() || filename.isNull()) {
            return nullptr;
        }
        QVector<KoResourceSP> resources = m_resourceModel->resourcesForFilename(filename);
 
        if (resources.size() > 0) {
            return resources.first().dynamicCast<T>();
        }
 
        return nullptr;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, and KisResourceModel::resourcesForFilename().

◆ resourceByMD5()

template<class T >

QSharedPointer< T > KoResourceServer< T >::resourceByMD5 ( const QString & md5 ) const

inlineprivate

Definition at line 272 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
        if (md5.isEmpty() || md5.isNull()) {
            return nullptr;
        }
        QVector<KoResourceSP> resources = m_resourceModel->resourcesForMD5(md5);
 
        if (resources.size() > 0) {
            return resources.first().dynamicCast<T>();
        }
 
        return nullptr;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, and KisResourceModel::resourcesForMD5().

◆ resourceByName()

template<class T >

QSharedPointer< T > KoResourceServer< T >::resourceByName ( const QString & name ) const

inlineprivate

Definition at line 251 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        if (name.isEmpty() || name.isNull()) {
            return nullptr;
        }
 
        QVector<KoResourceSP> resources = m_resourceModel->resourcesForName(name);
 
        if (resources.size() > 0) {
            return resources.first().dynamicCast<T>();
        }
 
        return nullptr;
 
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, and KisResourceModel::resourcesForName().

◆ resourceCount()

template<class T >

int KoResourceServer< T >::resourceCount ( ) const

inline

Definition at line 126 of file KoResourceServer.h.

                              {
 
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        return m_resourceModel->rowCount();
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, and KoResourceServer< T >::m_resourceModel.

◆ resourceModel()

template<class T >

KisResourceModel * KoResourceServer< T >::resourceModel ( ) const

inline

Returns: the active resource model

Definition at line 104 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
 
        return m_resourceModel;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), and KoResourceServer< T >::m_resourceModel.

◆ saveLocation()

template<class T >

QString KoResourceServer< T >::saveLocation ( )

inline

Returns path where to save user defined and imported resources to.

Definition at line 169 of file KoResourceServer.h.

                           {
        return KisResourceLocator::instance()->resourceLocationBase() + m_type;
    }

References KisResourceLocator::instance(), KoResourceServer< T >::m_type, and KisResourceLocator::resourceLocationBase().

◆ updateResource()

template<class T >

bool KoResourceServer< T >::updateResource ( QSharedPointer< T > resource )

inline

Call after changing the content of a resource and saving it; Notifies the connected views.

Definition at line 310 of file KoResourceServer.h.

    {
        KIS_SAFE_ASSERT_RECOVER_NOOP(QThread::currentThread() == qApp->thread());
        if (QThread::currentThread() != qApp->thread()) {
            qDebug().noquote() << kisBacktrace();
        }
        bool result = m_resourceModel->updateResource(resource);
        notifyResourceChanged(resource);
        return result;
    }

References KIS_SAFE_ASSERT_RECOVER_NOOP, kisBacktrace(), KoResourceServer< T >::m_resourceModel, KoResourceServer< T >::notifyResourceChanged(), KoResourceServer< T >::resource(), and KisResourceModel::updateResource().

Member Data Documentation

◆ m_observers

template<class T >

QList<ObserverType*> KoResourceServer< T >::m_observers

private

Definition at line 369 of file KoResourceServer.h.

◆ m_resourceModel

template<class T >

KisResourceModel* KoResourceServer< T >::m_resourceModel {0}

private

Definition at line 370 of file KoResourceServer.h.

370{0};

◆ m_tagModel

template<class T >

KisTagModel* KoResourceServer< T >::m_tagModel {0}

private

Definition at line 371 of file KoResourceServer.h.

371{0};

◆ m_type

template<class T >

QString KoResourceServer< T >::m_type

private

Definition at line 372 of file KoResourceServer.h.

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

libs/resources/KoResourceServer.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ObserverType

Constructor & Destructor Documentation

◆ KoResourceServer()

◆ ~KoResourceServer()

Member Function Documentation

◆ addObserver()

◆ addResource()

◆ assignedTagsList()

◆ firstResource()

◆ importResourceFile()

◆ notifyRemovingResource()

◆ notifyResourceAdded()

◆ notifyResourceChanged()

◆ reloadResource()

◆ removeObserver()

◆ removeResourceFile()

◆ removeResourceFromServer()

◆ resource()

◆ resourceByFilename()

◆ resourceByMD5()

◆ resourceByName()

◆ resourceCount()

◆ resourceModel()

◆ saveLocation()

◆ updateResource()

Member Data Documentation

◆ m_observers

◆ m_resourceModel

◆ m_tagModel

◆ m_type