KoColorProfileStorage Class Reference

The KoColorProfileStorage class is a "composite subclass" of KoColorSpaceRegistry that ensures that the access to profiles is guarded by a separate lock and the hierarchy of locks is always followed (which avoid deadlocks). More...

#include <KoColorProfileStorage.h>

Classes
struct	Private

Public Member Functions
void	addProfile (KoColorProfile *profile)
void	addProfileAlias (const QString &name, const QString &to)
bool	containsProfile (const KoColorProfile *profile)
	containsProfile shows if a profile is registered in the storage
	KoColorProfileStorage ()
QString	profileAlias (const QString &name) const
const KoColorProfile *	profileByName (const QString &name) const
const KoColorProfile *	profileByUniqueId (const QByteArray &id) const
QList< const KoColorProfile * >	profilesFor (const KoColorProfileQuery &query, double error=0.0001)
	profilesFor Return the list of profiles for a colorspace represented by it's colorants and type.
QList< const KoColorProfile * >	profilesFor (const KoColorSpaceFactory *csf) const
void	removeProfile (KoColorProfile *profile)
void	removeProfileAlias (const QString &name)
	~KoColorProfileStorage ()

Private Attributes
const QScopedPointer< Private >	d

Detailed Description

The KoColorProfileStorage class is a "composite subclass" of KoColorSpaceRegistry that ensures that the access to profiles is guarded by a separate lock and the hierarchy of locks is always followed (which avoid deadlocks).

Registry locking hierarchy is basically the following:

1) KoColorSpaceRegistry::Private::registrylock 2) KoColorProfileStorage::Private::lock

It means that we can take any single lock if we need it separately, but if we need to take both of them, we should always take them is a specified order.

Encapsulation of the profile accesses inside a separate class lets us follow this rule without even thinking of it. KoColorProfileStorage just never calls any method of the registry, therefore lock order inversion is not possible,

Definition at line 39 of file KoColorProfileStorage.h.

Constructor & Destructor Documentation

KoColorProfileStorage()

KoColorProfileStorage::KoColorProfileStorage

(

)

Definition at line 51 of file KoColorProfileStorage.cpp.

    : d(new Private)
{
 
}

~KoColorProfileStorage()

KoColorProfileStorage::~KoColorProfileStorage

(

)

Definition at line 57 of file KoColorProfileStorage.cpp.

{
}

Member Function Documentation

addProfile()

void KoColorProfileStorage::addProfile

(

KoColorProfile *

profile

)

Register the profile in the storage

Parameters

profile

the new profile to be registered

Definition at line 61 of file KoColorProfileStorage.cpp.

{
    QWriteLocker locker(&d->lock);
 
    if (profile->valid()) {
        d->profileMap[profile->name()] = profile;
        if (d->profileUniqueIdMap.contains(profile->uniqueId())) {
            //warnPigment << "Duplicated profile" << profile->name() << profile->fileName() << d->profileUniqueIdMap[profile->uniqueId()]->fileName();
            d->duplicates.append(d->profileUniqueIdMap[profile->uniqueId()]);
        }
        d->profileUniqueIdMap.insert(profile->uniqueId(), profile);
    }
}

References d, KoColorProfile::name, KoColorProfile::uniqueId(), and KoColorProfile::valid().

addProfileAlias()

void KoColorProfileStorage::addProfileAlias	(	const QString &	name,
		const QString &	to )

Create an alias to a profile with a different name. Then profileByName will return the profile to when passed name as a parameter.

Aliases are considered 'weak'. If a real profile with the name name is present (or added), it shadows the existing alias. If such an explicit profile gets removed, then the alias takes its place again.

Definition at line 90 of file KoColorProfileStorage.cpp.

{
    QWriteLocker l(&d->lock);
    d->profileAlias[name] = to;
}

References d.

containsProfile()

bool KoColorProfileStorage::containsProfile

(

const KoColorProfile *

profile

)

containsProfile shows if a profile is registered in the storage

Definition at line 84 of file KoColorProfileStorage.cpp.

{
    QReadLocker l(&d->lock);
    return d->profileMap.contains(profile->name());
}

References d, and KoColorProfile::name.

profileAlias()

QString KoColorProfileStorage::profileAlias

(

const QString &

name

)

const

Returns

the profile alias, or name if not aliased

Profile aliases are considered 'weak', i.e. they can be overridden by a read profile added to the storage.

Definition at line 102 of file KoColorProfileStorage.cpp.

{
    QReadLocker l(&d->lock);
    return d->profileMap.contains(name) ? name : d->profileAlias.value(name, name);
}

References d.

profileByName()

const KoColorProfile * KoColorProfileStorage::profileByName

(

const QString &

name

)

const

Return a profile by its given name, or 0 if none registered.

Returns

a profile by its given name, or 0 if none registered.

Parameters

name	the product name as set on the profile.

See also

addProfile()

KoColorProfile::productName()

Profile aliases are considered 'weak', i.e. they can be overridden by a read profile added to the storage.

Definition at line 112 of file KoColorProfileStorage.cpp.

{
    QReadLocker l(&d->lock);
    if (d->profileMap.contains(name)) {
        return d->profileMap[name];
    }
 
    return d->profileMap.value(d->profileAlias.value(name, name), 0);
}

References d.

profileByUniqueId()

const KoColorProfile * KoColorProfileStorage::profileByUniqueId

(

const QByteArray &

id

)

const

Returns a profile by its unique id stored/calculated in the header. The first call to this function might take long, because the map is created on the first use only (atm used by SVG only)

Parameters

id	unique ProfileID of the profile (MD5 sum of its header)

Returns

the profile or 0 if not found

Definition at line 145 of file KoColorProfileStorage.cpp.

{
    QReadLocker l(&d->lock);
    if (d->profileUniqueIdMap.isEmpty()) {
        l.unlock();
        d->populateUniqueIdMap();
        l.relock();
    }
    return d->profileUniqueIdMap.value(id, 0);
 
}

References d.

profilesFor() [1/2]

QList< const KoColorProfile * > KoColorProfileStorage::profilesFor	(	const KoColorProfileQuery &	query,
		double	error = 0.0001 )

profilesFor Return the list of profiles for a colorspace represented by it's colorants and type.

Parameters

colorants	list of at the least 2 values representing the whitePoint xyY, or 8 representing whitePoint, red, green and blue x and y xyY values. If the colorant type is set, the colorants will not be used.
colorantType	the named colorantType, if 2, it's undefined and the colorants will be used.
transferType	the name transfer type, if 2 it's undefined.
error	the margin of error with which the colorants get compared.

Returns

list of available profiles.

Definition at line 176 of file KoColorProfileStorage.cpp.

{
    QList<const KoColorProfile *> profiles;
 
    if (!query.isValid()) {
        return profiles;
    }
 
    QReadLocker l(&d->lock);
    for (const KoColorProfile* profile : d->profileMap) {
        bool colorantMatch = (!query.rgbColorants.isEmpty() || query.primaries != PRIMARIES_UNSPECIFIED);
        bool colorantTypeMatch = (query.primaries == PRIMARIES_UNSPECIFIED);
        bool transferMatch = (query.transfer == TRC_UNSPECIFIED);
        if (query.primaries != PRIMARIES_UNSPECIFIED) {
            if (int(profile->getColorPrimaries()) == query.primaries) {
                colorantTypeMatch = true;
            }
        }
        if (query.transfer != TRC_UNSPECIFIED) {
            if (int(profile->getTransferCharacteristics()) == query.transfer) {
                transferMatch = true;
            }
        }
 
        if (!query.rgbColorants.isEmpty() && query.primaries == PRIMARIES_UNSPECIFIED) {
            KoColorimetryUtils::xyY wp = profile->getWhitePointxyY();
            if (profile->getColorantsxyY().size() == query.rgbColorants.size()) {
                QVector<KoColorimetryUtils::xyY> col = profile->getColorantsxyY();
                if (col.isEmpty()) {
                    // too few colorants, skip.
                    continue;
                }
 
                colorantMatch = (std::fabs(wp.x - query.whitePoint.x) < error) && (std::fabs(wp.y - query.whitePoint.y) < error);
                if (!colorantMatch) {
                    continue;
                }
 
                for (int i = 0; i < col.size(); i++) {
                    colorantMatch = (std::fabs(col[i].x - query.rgbColorants[i].x) < error) && (std::fabs(col[i].y - query.rgbColorants[i].y) < error);
                    if (!colorantMatch) {
                        break;
                    }
                }
            } else {
                if (std::fabs(wp.x - query.whitePoint.x) < error && std::fabs(wp.y - query.whitePoint.y) < error) {
                    colorantMatch = true;
                }
            }
        }
 
        if (transferMatch && colorantMatch && colorantTypeMatch) {
            profiles.push_back(profile);
        }
    }
 
    return profiles;
}

References d, KoColorProfileQuery::isValid(), KoColorProfileQuery::primaries, PRIMARIES_UNSPECIFIED, KoColorProfileQuery::rgbColorants, KoColorProfileQuery::transfer, TRC_UNSPECIFIED, KoColorProfileQuery::whitePoint, KoColorimetryUtils::xy::x, KoColorimetryUtils::xyY::x, KoColorimetryUtils::xy::y, and KoColorimetryUtils::xyY::y.

profilesFor() [2/2]

QList< const KoColorProfile * > KoColorProfileStorage::profilesFor

(

const KoColorSpaceFactory *

csf

)

const

Return the list of profiles for a colorspace represented by its factory. Profiles will not work with any color space, you can query which profiles that are registered with this registry can be used in combination with the argument factory.

Parameters

csf	is a factory for the requested color space

Returns

a list of profiles for the factory

Definition at line 157 of file KoColorProfileStorage.cpp.

{
    QList<const KoColorProfile *>  profiles;
    if (!csf) return profiles;
 
    QReadLocker l(&d->lock);
 
    QHash<QString, KoColorProfile * >::ConstIterator it;
    for (it = d->profileMap.constBegin(); it != d->profileMap.constEnd(); ++it) {
        KoColorProfile *  profile = it.value();
        if (csf->profileIsCompatible(profile)) {
            Q_ASSERT(profile);
            //         if (profile->colorSpaceSignature() == csf->colorSpaceSignature()) {
            profiles.push_back(profile);
        }
    }
    return profiles;
}

References d, and KoColorSpaceFactory::profileIsCompatible().

removeProfile()

void KoColorProfileStorage::removeProfile

(

KoColorProfile *

profile

)

Removes the profile from the storage. Please note that the caller should delete the profile object himself!

Parameters

profile

the profile to be removed

Definition at line 75 of file KoColorProfileStorage.cpp.

{
    QWriteLocker locker(&d->lock);
 
    d->profileMap.remove(profile->name());
    d->profileUniqueIdMap.remove(profile->uniqueId());
    d->duplicates.removeAll(profile);
}

References d, KoColorProfile::name, and KoColorProfile::uniqueId().

removeProfileAlias()

void KoColorProfileStorage::removeProfileAlias

(

const QString &

name

)

Remove a profile name if exists

Definition at line 96 of file KoColorProfileStorage.cpp.

{
    QWriteLocker l(&d->lock);
    d->profileAlias.remove(name);
}

References d.

Member Data Documentation

d

const QScopedPointer<Private> KoColorProfileStorage::d

private

Definition at line 128 of file KoColorProfileStorage.h.

---

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

• libs/pigment/KoColorProfileStorage.h
• libs/pigment/KoColorProfileStorage.cpp