KisInputProfileManager Class Reference

A class to manage a list of profiles and actions. More...

#include <kis_input_profile_manager.h>

Inheritance diagram for KisInputProfileManager:

Signals
void	currentProfileChanged ()
void	profilesChanged ()

Public Member Functions
QList< KisAbstractInputAction * >	actions ()
KisInputProfile *	addProfile (const QString &name)
void	createActions ()
KisInputProfile *	currentProfile () const
void	duplicateProfile (const QString &name, const QString &newName)
QList< KisShortcutConfiguration * >	getConflictingShortcuts (KisInputProfile *profile)
	KisInputProfileManager (QObject *parent=0)
void	loadProfiles ()
	Private ()
KisInputProfile *	profile (const QString &name) const
QString	profileFileName (const QString &profileName)
QStringList	profileNames () const
QList< KisInputProfile * >	profiles () const
void	removeProfile (const QString &name)
bool	renameProfile (const QString &oldName, const QString &newName)
void	resetAll ()
void	saveProfile (KisInputProfile *profile, QString storagePath)
void	saveProfiles ()
void	setCurrentProfile (KisInputProfile *profile)
	~KisInputProfileManager () override

Static Public Member Functions
static KisInputProfileManager *	instance ()

Public Attributes
QList< KisAbstractInputAction * >	actions
KisInputProfile *	currentProfile
QMap< QString, KisInputProfile * >	profiles

Private Member Functions
KisInputProfile *	loadProfileInternal (const QString &fullPath)
KisInputProfile *	loadProfileWithMigration (const ProfileEntry &profileEntry)
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Friends
class	KisInputProfileManagerTest

Detailed Description

A class to manage a list of profiles and actions.

Definition at line 40 of file kis_input_profile_manager.cpp.

Constructor & Destructor Documentation

KisInputProfileManager()

KisInputProfileManager::KisInputProfileManager

(

QObject *

parent = 0

)

Definition at line 458 of file kis_input_profile_manager.cpp.

    : QObject(parent), d(new Private())
{
    d->createActions();
}

References d.

~KisInputProfileManager()

KisInputProfileManager::~KisInputProfileManager ( )

override

Definition at line 464 of file kis_input_profile_manager.cpp.

{
    qDeleteAll(d->profiles);
    qDeleteAll(d->actions);
    delete d;
}

References d.

Member Function Documentation

actions()

QList< KisAbstractInputAction * > KisInputProfileManager::actions

(

)

Returns

The list of all available actions.

addProfile()

KisInputProfile * KisInputProfileManager::addProfile

(

const QString &

name

)

Add a profile.

Parameters

name	The name of the new profile.

Returns

The new, empty profile or the non-empty profile if it already exists.

Definition at line 94 of file kis_input_profile_manager.cpp.

{
    if (d->profiles.contains(name)) {
        return d->profiles.value(name);
    }
 
    KisInputProfile *profile = new KisInputProfile(this);
    profile->setName(name);
    d->profiles.insert(name, profile);
 
    Q_EMIT profilesChanged();
 
    return profile;
}

References d, profile(), profilesChanged(), and KisInputProfile::setName().

createActions()

void KisInputProfileManager::createActions

(

)

currentProfile()

KisInputProfile * KisInputProfileManager::currentProfile

(

)

const

Returns

The current active profile.

currentProfileChanged

void KisInputProfileManager::currentProfileChanged ( )

signal

Emitted when the current active profile changes.

duplicateProfile()

void KisInputProfileManager::duplicateProfile	(	const QString &	name,
		const QString &	newName )

Duplicate a profile.

This creates a new profile with the given name and copies all data from the old profile to the new profile.

Parameters

name	The name of the profile to duplicate.
newName	The name of the new profile.

Definition at line 154 of file kis_input_profile_manager.cpp.

{
    if (!d->profiles.contains(name) || d->profiles.contains(newName)) {
        return;
    }
 
    KisInputProfile *newProfile = new KisInputProfile(this);
    newProfile->setName(newName);
    d->profiles.insert(newName, newProfile);
 
    KisInputProfile *profile = d->profiles.value(name);
    QList<KisShortcutConfiguration *> shortcuts = profile->allShortcuts();
    Q_FOREACH(KisShortcutConfiguration * shortcut, shortcuts) {
        newProfile->addShortcut(new KisShortcutConfiguration(*shortcut));
    }
 
    Q_EMIT profilesChanged();
}

References KisInputProfile::addShortcut(), KisInputProfile::allShortcuts(), d, profile(), profilesChanged(), and KisInputProfile::setName().

getConflictingShortcuts()

QList< KisShortcutConfiguration * > KisInputProfileManager::getConflictingShortcuts

(

KisInputProfile *

profile

)

Return the configurations that have conflicts.

Definition at line 421 of file kis_input_profile_manager.cpp.

{
    QSet<KisShortcutConfiguration *> conflictedShortcuts;
    const QList<KisShortcutConfiguration *> shortcuts = profile->allShortcuts();
    for (auto startIt = shortcuts.constBegin(); startIt != shortcuts.constEnd(); ++startIt) {
        KisShortcutConfiguration *first = *startIt;
        for (auto index = startIt + 1; index != shortcuts.constEnd(); ++index) {
            KisShortcutConfiguration *second = *index;
            // since there can be multiple no-ops in the config and because no-ops are something a user can't
            // perform, there should be no conflicts.
            if (*first == *second && !first->isNoOp()) {
                conflictedShortcuts.insert(first);
                conflictedShortcuts.insert(second);
            }
        }
    }
    return conflictedShortcuts.values();
}

References KisInputProfile::allShortcuts(), KisShortcutConfiguration::isNoOp(), and profile().

instance()

KisInputProfileManager * KisInputProfileManager::instance ( )

static

Returns

The singleton instance of this class.

Definition at line 57 of file kis_input_profile_manager.cpp.

{
    return inputProfileManager;
}

loadProfileInternal()

KisInputProfile * KisInputProfileManager::loadProfileInternal ( const QString & fullPath )

private

Loads a single profile from a file without applying any migrations

Definition at line 299 of file kis_input_profile_manager.cpp.

{
    KConfig config(fullPath, KConfig::SimpleConfig);
 
    QList<KisShortcutConfiguration*> loadedShortcuts;
 
    // Only entries of exactly the right version can be considered
    const int version = config.group("General").readEntry("version", 0);
    const QString name = config.group("General").readEntry("name");
 
    // the profile must be already converted by this point
    KIS_SAFE_ASSERT_RECOVER_NOOP(version == PROFILE_VERSION);
 
    Q_FOREACH (KisAbstractInputAction *action, d->actions) {
        if (!config.hasGroup(action->id())) {
            continue;
        }
 
        KConfigGroup grp = config.group(action->id());
        // Read the settings for the action and create the appropriate shortcuts.
        Q_FOREACH (const QString &entry, grp.entryMap()) {
            KisShortcutConfiguration *shortcut = new KisShortcutConfiguration;
            shortcut->setAction(action);
 
            if (shortcut->unserialize(entry)) {
                loadedShortcuts.append(shortcut);
            } else {
                delete shortcut;
            }
        }
    }
 
    KisInputProfile *newProfile = addProfile(name);
    Q_FOREACH(KisShortcutConfiguration *shortcut, loadedShortcuts) {
        newProfile->addShortcut(shortcut);
    }
    return newProfile;
}

References addProfile(), KisInputProfile::addShortcut(), d, KisAbstractInputAction::id, KIS_SAFE_ASSERT_RECOVER_NOOP, PROFILE_VERSION, KisShortcutConfiguration::setAction(), and KisShortcutConfiguration::unserialize().

loadProfiles()

void KisInputProfileManager::loadProfiles

(

)

Load all profiles from the configuration stored on disk.

Definition at line 178 of file kis_input_profile_manager.cpp.

{
    //Remove any profiles that already exist
    d->currentProfile = nullptr;
    qDeleteAll(d->profiles);
    d->profiles.clear();
 
    //Look up all profiles (this includes those installed to $prefix as well as the user's local data dir)
    QStringList profiles = KoResourcePaths::findAllAssets("data", "input/*.profile", KoResourcePaths::Recursive);
 
    dbgKrita << "profiles" << profiles;
 
    // We don't use list here, because we're assuming we are only going to be changing the user directory and
    // there can only be one of a profile name.
    QMap<QString, ProfileEntry> profileEntriesToMigrate;
    QMap<QString, QList<ProfileEntry>> profileEntries;
 
    KisConfig cfg(true);
 
    // Get only valid entries...
    Q_FOREACH(const QString & p, profiles) {
 
        ProfileEntry entry;
        entry.fullpath = p;
 
        KConfig config(p, KConfig::SimpleConfig);
        if (!config.hasGroup("General") || !config.group("General").hasKey("name") || !config.group("General").hasKey("version")) {
            //Skip if we don't have the proper settings.
            continue;
        }
 
        // Only entries of exactly the right version can be considered
        entry.version = config.group("General").readEntry("version", 0);
        entry.name = config.group("General").readEntry("name");
 
        // NOTE: Migrating profiles doesn't just mean porting them to new version. Migrating a profile
        // may override the existing newer profile file.
        if (entry.version < PROFILE_VERSION) {
            // we only utilize the first entry, because it is the most local one and the one which has to be
            // migrated.
            profileEntriesToMigrate[entry.name] = entry;
 
        } else if (entry.version == PROFILE_VERSION) {
            if (!profileEntries.contains(entry.name)) {
                profileEntries[entry.name] = QList<ProfileEntry>();
            }
 
            // let all the current version entries pile up in the list, it is only later where we check if it
            // is something we will use or a migrated entry.
            profileEntries[entry.name].append(entry);
        }
    }
 
    {
        const QString userLocalSaveLocation = KoResourcePaths::saveLocation("data", "input/");
        auto entriesIt = profileEntriesToMigrate.begin();
        while (entriesIt != profileEntriesToMigrate.end()) {
            ProfileEntry entry = *entriesIt;
            // if entry doesn't exist in profileEntries, means there is no corresponding new version of the
            // entry in user directory. Meaning, it is a certain candidate for migration.
 
            if (profileEntries.contains(entry.name)) {
 
                // we only need first() because if a user-local entry exists, it will be the first.
                ProfileEntry existingEntry = profileEntries[entry.name].first();
 
                // check if the entry's fullpath is a saveLocation, if so, we remove it from migration list.
                if (existingEntry.fullpath.startsWith(userLocalSaveLocation)) {
                    entriesIt = profileEntriesToMigrate.erase(entriesIt);
                } else {
                    // if the entry's fullpath is not a saveLocation, we will migrate it. Because (user's
                    // previous configuration + current default touch shortcuts) are better than. (All default
                    // shortcuts).
                    entriesIt++;
 
                    // Because this entry is supposed to be migrated, it will clash with an already existing
                    // default entry. So remove it.
                    profileEntries.remove(existingEntry.name);
                }
            } else {
                entriesIt++;
            }
        }
    }
 
    for (const auto &profileEntry : profileEntriesToMigrate) {
        loadProfileWithMigration(profileEntry);
    }
 
    Q_FOREACH(const QString & profileName, profileEntries.keys()) {
 
        if (profileEntries[profileName].isEmpty()) {
            continue;
        }
 
        // we have one or more entries for this profile name. We'll take the first,
        // because that's the most local one.
        ProfileEntry entry = profileEntries[profileName].first();
 
        loadProfileInternal(entry.fullpath);
    }
 
    QString currentProfile = cfg.currentInputProfile();
    if (d->profiles.size() > 0) {
        if (currentProfile.isEmpty() || !d->profiles.contains(currentProfile)) {
            QString kritaDefault = QStringLiteral("Krita Default");
            if (d->profiles.contains(kritaDefault)) {
                d->currentProfile = d->profiles.value(kritaDefault);
            } else {
                d->currentProfile = d->profiles.begin().value();
            }
        }
        else {
            d->currentProfile = d->profiles.value(currentProfile);
        }
    }
    if (d->currentProfile) {
        Q_EMIT currentProfileChanged();
    }
}

References KisConfig::currentInputProfile(), currentProfile, currentProfileChanged(), d, dbgKrita, KoResourcePaths::findAllAssets(), ProfileEntry::fullpath, loadProfileInternal(), loadProfileWithMigration(), ProfileEntry::name, p, PROFILE_VERSION, profiles, KoResourcePaths::Recursive, KoResourcePaths::saveLocation(), and ProfileEntry::version.

loadProfileWithMigration()

KisInputProfile * KisInputProfileManager::loadProfileWithMigration ( const ProfileEntry & profileEntry )

private

Loads a single profile from a file performing all the migrations necessary. The old profile will be saved into KoResourcePaths::saveLocation with a version suffix, and the new version will be written with the profile name.

Definition at line 338 of file kis_input_profile_manager.cpp.

{
    QList<KisShortcutConfiguration> parsedShortcuts;
 
    if (profileEntry.version == 5) {
        KisInputProfileMigratorFrom5 migratorFromV5(this);
        parsedShortcuts = migratorFromV5.migrate(profileEntry);
    } else if (profileEntry.version == 6) {
        KisInputProfileMigratorFrom6 migratorFromV6(this);
        parsedShortcuts = migratorFromV6.migrate(profileEntry);
    } else {
        warnKrita << "Unable to migrate input profile: unknown version:" << profileEntry.version << "("
                  << profileEntry.fullpath << ")";
        return nullptr;
    }
 
    dbgKrita << "Migrating a profile " << profileEntry.name << "(" << profileEntry.fullpath << ")" << "from version" << profileEntry.version;
 
    const QString storagePath = KoResourcePaths::saveLocation("data", "input/", true);
 
    {
        // the profile we have here uses the previous config, the only thing we need to make sure is
        // it doesn't overwrite the existing profile to preserve backwards compatibility.
        const QString profilePath = profileEntry.fullpath;
        QString oldProfileName = QFileInfo(profilePath).fileName();
        oldProfileName.replace(".profile", QString::number(PROFILE_VERSION - 1) + ".profile");
 
        QString oldProfilePath = storagePath + oldProfileName;
        // copy the profile to a new file but add version number to the name
        QFile::copy(profilePath, oldProfilePath);
 
        KConfig config(oldProfilePath, KConfig::SimpleConfig);
        config.group("General").writeEntry("migrated", PROFILE_VERSION);
    }
 
    KisInputProfile *newProfile = addProfile(profileEntry.name);
    for (const auto &shortcut : parsedShortcuts) {
        newProfile->addShortcut(new KisShortcutConfiguration(shortcut));
    }
 
    // save the new profile with migrated shortcuts. We overwrite the previous version of file (which
    // previously has been moved for backward compatibility).
    saveProfile(newProfile, storagePath);
 
    return newProfile;
}

References addProfile(), KisInputProfile::addShortcut(), dbgKrita, ProfileEntry::fullpath, KisInputProfileMigratorFrom5::migrate(), KisInputProfileMigratorFrom6::migrate(), ProfileEntry::name, PROFILE_VERSION, KoResourcePaths::saveLocation(), saveProfile(), ProfileEntry::version, and warnKrita.

Private()

KisInputProfileManager::Private ( )

inline

Definition at line 43 of file kis_input_profile_manager.cpp.

: currentProfile(0) { }

profile()

KisInputProfile * KisInputProfileManager::profile

(

const QString &

name

)

const

Retrieve a profile by name.

Parameters

name	The name of the profile to retrieve.

Returns

The profile with the given name, or 0 if not found.

Definition at line 72 of file kis_input_profile_manager.cpp.

{
    if (d->profiles.contains(name)) {
        return d->profiles.value(name);
    }
 
    return 0;
}

References d.

profileFileName()

QString KisInputProfileManager::profileFileName

(

const QString &

profileName

)

profileNames()

QStringList KisInputProfileManager::profileNames

(

)

const

Returns

A list of the names of all profiles.

Definition at line 67 of file kis_input_profile_manager.cpp.

{
    return d->profiles.keys();
}

References d.

profiles()

QList< KisInputProfile * > KisInputProfileManager::profiles

(

)

const

Returns

A list of all profiles.

profilesChanged

void KisInputProfileManager::profilesChanged ( )

signal

Emitted when the list of profiles changes.

removeProfile()

void KisInputProfileManager::removeProfile

(

const QString &

name

)

Remove a profile.

This will remove the given profile from the list of profiles and delete it.

Parameters

name	The profile to remove.

Definition at line 109 of file kis_input_profile_manager.cpp.

{
    if (d->profiles.contains(name)) {
        QString currentProfileName = d->currentProfile->name();
 
        delete d->profiles.value(name);
        d->profiles.remove(name);
 
        //Delete the settings file for the removed profile, if it exists
        QDir userDir(KoResourcePaths::saveLocation("data", "input/"));
 
        if (userDir.exists(d->profileFileName(name))) {
            userDir.remove(d->profileFileName(name));
        }
 
        if (currentProfileName == name) {
            d->currentProfile = d->profiles.begin().value();
            Q_EMIT currentProfileChanged();
        }
 
        Q_EMIT profilesChanged();
    }
}

References currentProfileChanged(), d, profilesChanged(), and KoResourcePaths::saveLocation().

renameProfile()

bool KisInputProfileManager::renameProfile	(	const QString &	oldName,
		const QString &	newName )

Rename a profile.

Parameters

oldName	The current name of the profile.
newName	The new name of the profile.

Returns

true if successful, false if not.

Definition at line 133 of file kis_input_profile_manager.cpp.

{
    if (!d->profiles.contains(oldName)) {
        return false;
    }
 
    KisInputProfile *profile = d->profiles.value(oldName);
    if (profile) {
        d->profiles.remove(oldName);
        profile->setName(newName);
        d->profiles.insert(newName, profile);
 
        Q_EMIT profilesChanged();
 
 
        return true;
    }
 
    return false;
}

References d, profile(), profilesChanged(), and KisInputProfile::setName().

resetAll()

void KisInputProfileManager::resetAll

(

)

Reset all profiles to the default state.

This will remove all custom profiles the user created and reset any changed profiles.

Definition at line 440 of file kis_input_profile_manager.cpp.

{
    QString kdeHome = KoResourcePaths::getAppDataLocation();
    QStringList profiles = KoResourcePaths::findAllAssets("data", "input/*", KoResourcePaths::Recursive);
 
    Q_FOREACH (const QString &profile, profiles) {
        if(profile.contains(kdeHome)) {
            //This is a local file, remove it.
            QFile::remove(profile);
        }
    }
 
    //Load the profiles again, this should now only load those shipped with Krita.
    loadProfiles();
 
    Q_EMIT profilesChanged();
}

References KoResourcePaths::findAllAssets(), KoResourcePaths::getAppDataLocation(), loadProfiles(), profile(), profiles, profilesChanged(), and KoResourcePaths::Recursive.

saveProfile()

void KisInputProfileManager::saveProfile	(	KisInputProfile *	profile,
		QString	storagePath )

Save profile to storagePath

Definition at line 399 of file kis_input_profile_manager.cpp.

{
    const QString profilePath = storagePath + d->profileFileName(profile->name());
    KConfig config(profilePath, KConfig::SimpleConfig);
 
    config.group("General").writeEntry("name", profile->name());
    config.group("General").writeEntry("version", PROFILE_VERSION);
 
    Q_FOREACH(KisAbstractInputAction * action, d->actions) {
        KConfigGroup grp = config.group(action->id());
        grp.deleteGroup(); //Clear the group of any existing shortcuts.
 
        int index = 0;
        QList<KisShortcutConfiguration *> shortcuts = profile->shortcutsForAction(action);
        Q_FOREACH(KisShortcutConfiguration * shortcut, shortcuts) {
            grp.writeEntry(QString("%1").arg(index++), shortcut->serialize());
        }
    }
 
    config.sync();
}

References d, KisAbstractInputAction::id, KisInputProfile::name(), profile(), PROFILE_VERSION, KisShortcutConfiguration::serialize(), and KisInputProfile::shortcutsForAction().

saveProfiles()

void KisInputProfileManager::saveProfiles

(

)

Save all profiles to configuration on disk.

Definition at line 385 of file kis_input_profile_manager.cpp.

{
    QString storagePath = KoResourcePaths::saveLocation("data", "input/", true);
    Q_FOREACH(KisInputProfile * p, d->profiles) {
        saveProfile(p, storagePath);
    }
 
    KisConfig config(false);
    config.setCurrentInputProfile(d->currentProfile->name());
 
    //Force a reload of the current profile in input manager and whatever else uses the profile.
    Q_EMIT currentProfileChanged();
}

References currentProfileChanged(), d, p, KoResourcePaths::saveLocation(), saveProfile(), and KisConfig::setCurrentInputProfile().

setCurrentProfile()

void KisInputProfileManager::setCurrentProfile

(

KisInputProfile *

profile

)

Set the current active profile.

Parameters

profile

The profile to set as current.

Definition at line 86 of file kis_input_profile_manager.cpp.

{
    if (profile && profile != d->currentProfile) {
        d->currentProfile = profile;
        Q_EMIT currentProfileChanged();
    }
}

References currentProfileChanged(), d, and profile().

Friends And Related Symbol Documentation

KisInputProfileManagerTest

friend class KisInputProfileManagerTest

friend

Definition at line 146 of file kis_input_profile_manager.h.

Member Data Documentation

actions

QList< KisAbstractInputAction * > KisInputProfileManager::actions

Definition at line 52 of file kis_input_profile_manager.cpp.

currentProfile

KisInputProfile * KisInputProfileManager::currentProfile

Definition at line 48 of file kis_input_profile_manager.cpp.

d

Private* const KisInputProfileManager::d

private

Definition at line 163 of file kis_input_profile_manager.h.

profiles

QList< KisInputProfile * > KisInputProfileManager::profiles

Definition at line 50 of file kis_input_profile_manager.cpp.

---

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

• libs/ui/input/kis_input_profile_manager.cpp
• libs/ui/input/kis_input_profile_manager.h