SessionManager.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 SESSIONMANAGER_H
#define SESSIONMANAGER_H

// Qt
#include <QtCore/QHash>
#include <QtCore/QList>

// Konsole
#include "Profile.h"

class QSignalMapper;

class KConfig;

namespace Konsole
{
class Session;

class KONSOLEPRIVATE_EXPORT SessionManager : public QObject
{
    Q_OBJECT

public:
    SessionManager();

    virtual ~SessionManager();

    static SessionManager* instance();

    void closeAllSessions();

    Session* createSession(Profile::Ptr profile = Profile::Ptr());

    void setSessionProfile(Session* session, Profile::Ptr profile);

    Profile::Ptr sessionProfile(Session* session) const;

    const QList<Session*> sessions() const;

    // System session management
    void saveSessions(KConfig* config);
    void restoreSessions(KConfig* config);
    int  getRestoreId(Session* session);
    Session* idToSession(int id);

signals:
    void sessionUpdated(Session* session);

protected slots:
    void sessionTerminated(QObject* session);

private slots:
    void sessionProfileCommandReceived(const QString& text);

    void profileChanged(Profile::Ptr profile);

private:
    // applies updates to a profile
    // to all sessions currently using that profile
    // if modifiedPropertiesOnly is true, only properties which
    // are set in the profile @p key are updated
    void applyProfile(Profile::Ptr profile , bool modifiedPropertiesOnly);

    // applies updates to the profile @p profile to the session @p session
    // if modifiedPropertiesOnly is true, only properties which
    // are set in @p profile are update ( ie. properties for which profile->isPropertySet(<property>)
    // returns true )
    void applyProfile(Session* session , const Profile::Ptr profile , bool modifiedPropertiesOnly);

    QList<Session*> _sessions; // list of running sessions

    QHash<Session*, Profile::Ptr> _sessionProfiles;
    QHash<Session*, Profile::Ptr> _sessionRuntimeProfiles;
    QHash<Session*, int> _restoreMapping;

    QSignalMapper* _sessionMapper;
};

class ShouldApplyProperty
{
public:
    ShouldApplyProperty(const Profile::Ptr profile , bool modifiedOnly) :
        _profile(profile) , _modifiedPropertiesOnly(modifiedOnly) {}

    bool shouldApply(Profile::Property property) const {
        return !_modifiedPropertiesOnly || _profile->isPropertySet(property);
    }
private:
    const Profile::Ptr _profile;
    bool _modifiedPropertiesOnly;
};
}
#endif //SESSIONMANAGER_H