KisResourcesInterface::ResourceSourceAdapter Class Reference

#include <KisResourcesInterface.h>

Public Member Functions
KoResourceSP	bestMatch (const QString md5, const QString filename, const QString name)
	bestMatch retrieves a resource, preferably by md5, but with filename and name as fallback for older files that do not store the md5sum. If the resource is not found by md5 and the md5 isn't empty, then it will try to fallback to searching by filename, but will show a warning in case sanity checks are enabled.
KoResourceLoadResult	bestMatchLoadResult (const QString md5, const QString filename, const QString name)
KoResourceSP	exactMatch (const QString md5, const QString filename, const QString name)
	exactMatch retrieves a resource, preferably by md5, but with filename and name as fallback for older files that do not store the md5sum. If the resource is not found by md5 and the md5 isn't empty, then nullptr is returned (that is the difference to bestMatch).
virtual KoResourceSP	fallbackResource () const =0
virtual QVector< KoResourceSP >	resourcesForFilename (const QString &filename) const =0
virtual QVector< KoResourceSP >	resourcesForMD5 (const QString &md5) const =0
virtual QVector< KoResourceSP >	resourcesForName (const QString &name) const =0
	ResourceSourceAdapter (const QString &type)
virtual	~ResourceSourceAdapter ()

Private Member Functions
KoResourceSP	findResource (const QString md5, const QString filename, const QString name, bool exactMatch)
	Q_DISABLE_COPY (ResourceSourceAdapter)

Private Attributes
const QString	m_type

Friends
class	KisResourcesInterface

Detailed Description

Definition at line 43 of file KisResourcesInterface.h.

Constructor & Destructor Documentation

ResourceSourceAdapter()

KisResourcesInterface::ResourceSourceAdapter::ResourceSourceAdapter

(

const QString &

type

)

Definition at line 63 of file KisResourcesInterface.cpp.

    : m_type(type)
{
}

~ResourceSourceAdapter()

KisResourcesInterface::ResourceSourceAdapter::~ResourceSourceAdapter ( )

virtual

Definition at line 68 of file KisResourcesInterface.cpp.

{
}

Member Function Documentation

bestMatch()

KoResourceSP KisResourcesInterface::ResourceSourceAdapter::bestMatch	(	const QString	md5,
		const QString	filename,
		const QString	name )

bestMatch retrieves a resource, preferably by md5, but with filename and name as fallback for older files that do not store the md5sum. If the resource is not found by md5 and the md5 isn't empty, then it will try to fallback to searching by filename, but will show a warning in case sanity checks are enabled.

If multiple resources with the same md5 exist, then it prefers the one with the same filename and name.

Returns

a resource, or 0 of the resource doesn't exist.

Definition at line 72 of file KisResourcesInterface.cpp.

{
    return findResource(md5, filename, name, false);
}

bestMatchLoadResult()

KoResourceLoadResult KisResourcesInterface::ResourceSourceAdapter::bestMatchLoadResult	(	const QString	md5,
		const QString	filename,
		const QString	name )

Same as bestMatch(), but returns KoResourceLoadResult. In case the resource is not found in the backend storage, the load-result will be set in FailedLink state

Definition at line 175 of file KisResourcesInterface.cpp.

{
    KoResourceSP resource = bestMatch(md5, filename, name);
    return
        resource ?
        KoResourceLoadResult(resource) :
        KoResourceLoadResult(KoResourceSignature(m_type, md5, filename, name));
}

exactMatch()

KoResourceSP KisResourcesInterface::ResourceSourceAdapter::exactMatch	(	const QString	md5,
		const QString	filename,
		const QString	name )

exactMatch retrieves a resource, preferably by md5, but with filename and name as fallback for older files that do not store the md5sum. If the resource is not found by md5 and the md5 isn't empty, then nullptr is returned (that is the difference to bestMatch).

If multiple resources with the same md5 exist, then it prefers the one with the same filename and name.

Returns

a resource, or 0 of the resource doesn't exist.

Definition at line 77 of file KisResourcesInterface.cpp.

{
    return findResource(md5, filename, name, true);
}

fallbackResource()

virtual KoResourceSP KisResourcesInterface::ResourceSourceAdapter::fallbackResource ( ) const

pure virtual

findResource()

KoResourceSP KisResourcesInterface::ResourceSourceAdapter::findResource ( const QString md5, const QString filename, const QString name, bool exactMatch )

private

filename is more important than name, so it gives higher penalty

In case of exact match we must find the resource via its md5 if provided

Definition at line 82 of file KisResourcesInterface.cpp.

{
    QVector<QPair<KoResourceSP, int>> foundResources;
 
    if (!md5.isEmpty()) {
        Q_FOREACH (KoResourceSP res, resourcesForMD5(md5)) {
            int penalty = 0;
 
            if (!res->active()) {
                penalty += 100;
            }
 
            if (!filename.isEmpty() && filename != res->filename()) {
                penalty += 2;
            }
 
            if (!name.isEmpty() && name != res->name()) {
                penalty++;
            }
 
            foundResources.append(qMakePair(res, penalty));
        }
 
        if (exactMatch && foundResources.isEmpty()) {
            return {};
        }
    }
 
#ifdef SANITY_CHECKS
    const bool warnAboutIncorrectMd5Fetch =
        foundResources.isEmpty() && !md5.isEmpty();
#endif
 
    if (foundResources.isEmpty()) {
        if (!filename.isEmpty()) {
            Q_FOREACH (KoResourceSP res, resourcesForFilename(filename)) {
                int penalty = 0;
 
                if (!res->active()) {
                    penalty += 100;
                }
 
                if (!name.isEmpty() && name != res->name()) {
                    penalty++;
                }
 
                foundResources.append(qMakePair(res, penalty));
            }
        } else if (!name.isEmpty()) {
            Q_FOREACH (KoResourceSP res, resourcesForName(name)) {
                int penalty = 0;
 
                if (!res->active()) {
                    penalty += 100;
                }
 
                foundResources.append(qMakePair(res, penalty));
            }
        }
    }
 
    auto it = std::min_element(foundResources.begin(), foundResources.end(),
                               [] (const QPair<KoResourceSP, int> &lhs,
                               const QPair<KoResourceSP, int> &rhs) {return lhs.second < rhs.second;});
 
    KoResourceSP result = it != foundResources.end() ? it->first : KoResourceSP();
 
#ifdef SANITY_CHECKS
    if (warnAboutIncorrectMd5Fetch && result) {
        qWarning() << "KisResourcesInterface::ResourceSourceAdapter::bestMatch: failed to fetch a resource using md5; falling back for filename...";
        qWarning() << "    requested:" << ppVar(md5) << ppVar(filename) << ppVar(name);
        qWarning() << "    found:" << result;
        qWarning() << "    candidates:" << foundResources;
 
#ifdef CRASH_ON_SANITY_CHECK_FAILURE
        qFatal("Exiting...");
#endif /* CRASH_ON_SANITY_CHECK_FAILURE */
    }
#endif /* SANITY_CHECKS */
 
    return result;
}

References ppVar.

Q_DISABLE_COPY()

KisResourcesInterface::ResourceSourceAdapter::Q_DISABLE_COPY ( ResourceSourceAdapter )

private

resourcesForFilename()

virtual QVector< KoResourceSP > KisResourcesInterface::ResourceSourceAdapter::resourcesForFilename ( const QString & filename ) const

pure virtual

resourcesForMD5()

virtual QVector< KoResourceSP > KisResourcesInterface::ResourceSourceAdapter::resourcesForMD5 ( const QString & md5 ) const

pure virtual

resourcesForName()

virtual QVector< KoResourceSP > KisResourcesInterface::ResourceSourceAdapter::resourcesForName ( const QString & name ) const

pure virtual

Friends And Related Symbol Documentation

KisResourcesInterface

friend class KisResourcesInterface

friend

Definition at line 49 of file KisResourcesInterface.h.

Member Data Documentation

m_type

const QString KisResourcesInterface::ResourceSourceAdapter::m_type

private

Definition at line 95 of file KisResourcesInterface.h.

---

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

• libs/resources/KisResourcesInterface.h
• libs/resources/KisResourcesInterface.cpp