ProfileManager.h

Go to the documentation of this file.

/*
    This source file is part of Konsole, a terminal emulator.

    Copyright 2006-2008 by Robert Knight <robertknight@gmail.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA.
*/

#ifndef PROFILEMANAGER_H
#define PROFILEMANAGER_H

// Qt
#include <QtGui/QKeySequence>
#include <QtCore/QHash>
#include <QtCore/QList>
#include <QtCore/QSet>
#include <QtCore/QStringList>
#include <QtCore/QVariant>
#include <QtCore/QStack>

// Konsole
#include "Profile.h"

namespace Konsole
{
class KONSOLEPRIVATE_EXPORT ProfileManager : public QObject
{
    Q_OBJECT

public:
    ProfileManager();

    virtual ~ProfileManager();

    static ProfileManager* instance();

    QList<Profile::Ptr> allProfiles();

    QList<Profile::Ptr> loadedProfiles() const;

    void loadAllProfiles();

    Profile::Ptr loadProfile(const QString& path);

    QStringList availableProfilePaths() const;

    QStringList availableProfileNames() const;

    void addProfile(Profile::Ptr type);

    bool deleteProfile(Profile::Ptr profile);

    void changeProfile(Profile::Ptr profile , QHash<Profile::Property, QVariant> propertyMap,
                       bool persistent = true);

    void setDefaultProfile(Profile::Ptr profile);

    Profile::Ptr defaultProfile() const;

    Profile::Ptr fallbackProfile() const;

    void setFavorite(Profile::Ptr profile , bool favorite);

    QSet<Profile::Ptr> findFavorites();

    QList<Profile::Ptr> sortedFavorites();

    /*
     * Sorts the profile list by menuindex; those without an menuindex, sort by name.
     *  The menuindex list is first and then the non-menuindex list.
     *
     * @param list The profile list to sort
     */
    void sortProfiles(QList<Profile::Ptr>& list);

    void setShortcut(Profile::Ptr profile , const QKeySequence& shortcut);

    QKeySequence shortcut(Profile::Ptr profile) const;

    QList<QKeySequence> shortcuts();

    Profile::Ptr findByShortcut(const QKeySequence& shortcut);

signals:

    void profileAdded(Profile::Ptr ptr);
    void profileRemoved(Profile::Ptr ptr);
    void profileChanged(Profile::Ptr ptr);

    void favoriteStatusChanged(Profile::Ptr profile , bool favorite);

    void shortcutChanged(Profile::Ptr profile , const QKeySequence& newShortcut);

public slots:
    void saveSettings();

protected slots:

private slots:

private:
    // loads the mappings between shortcut key sequences and
    // profile paths
    void loadShortcuts();
    // saves the mappings between shortcut key sequences and
    // profile paths
    void saveShortcuts();

    //loads the set of favorite profiles
    void loadFavorites();
    //saves the set of favorite profiles
    void saveFavorites();

    // records which profile is set as the default profile
    // Note: it does not save the profile itself into disk. That is
    // what saveProfile() does.
    void saveDefaultProfile();

    // saves a profile to a file
    // returns the path to which the profile was saved, which will
    // be the same as the path property of profile if valid or a newly generated path
    // otherwise
    QString saveProfile(Profile::Ptr profile);

    QSet<Profile::Ptr> _profiles;  // list of all loaded profiles
    QSet<Profile::Ptr> _favorites; // list of favorite profiles

    Profile::Ptr _defaultProfile;
    Profile::Ptr _fallbackProfile;

    bool _loadedAllProfiles; // set to true after loadAllProfiles has been called
    bool _loadedFavorites; // set to true after loadFavorites has been called

    struct ShortcutData {
        Profile::Ptr profileKey;
        QString profilePath;
    };
    QMap<QKeySequence, ShortcutData> _shortcuts; // shortcut keys -> profile path
};

template <class T>
class PopStackOnExit
{
public:
    explicit PopStackOnExit(QStack<T>& stack) : _stack(stack) , _count(stack.count()) {}
    ~PopStackOnExit() {
        while (_stack.count() > _count)
            _stack.pop();
    }
private:
    QStack<T>& _stack;
    int _count;
};
}
#endif //PROFILEMANAGER_H