session.h 5.47 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33 34 35 36 37 38 39 40
#ifndef SESSION_H
#define SESSION_H

#include "projectexplorer_export.h"

#include <QtCore/QHash>
#include <QtCore/QString>
#include <QtCore/QStringList>
41
#include <QtCore/QPointer>
con's avatar
con committed
42

43 44
QT_BEGIN_NAMESPACE
class QAbstractItemModel;
45
class QTimer;
46 47
QT_END_NAMESPACE

con's avatar
con committed
48 49 50
namespace Core {
class IMode;
class IEditor;
51
class IFile;
con's avatar
con committed
52 53 54 55 56 57 58 59 60 61 62
}

namespace ProjectExplorer {

class Project;
class Node;
class SessionNode;
class SessionManager;

namespace Internal {
class SessionFile;
63
class SessionNodeImpl;
con's avatar
con committed
64 65
} // namespace Internal

hjk's avatar
hjk committed
66
class PROJECTEXPLORER_EXPORT SessionManager : public QObject
con's avatar
con committed
67 68 69 70
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
71
    explicit SessionManager(QObject *parent = 0);
con's avatar
con committed
72 73 74 75 76 77 78 79 80 81 82 83 84
    ~SessionManager();

    // higher level session management
    QString activeSession() const;
    QString lastSession() const;
    QStringList sessions() const;

    void createAndLoadNewDefaultSession();
    bool createSession(const QString &session);

    bool deleteSession(const QString &session);

    bool cloneSession(const QString &original, const QString &clone);
85
    bool renameSession(const QString &original, const QString &newName);
con's avatar
con committed
86 87 88 89 90 91 92 93 94 95 96 97 98

    bool loadSession(const QString &session);

    bool save();
    bool clear();

    void addProject(Project *project);
    void addProjects(const QList<Project*> &projects);
    void removeProject(Project *project);
    void removeProjects(QList<Project *> remove);

    void setStartupProject(Project *startupProject);

99 100 101
    QList<Project *> dependencies(const Project *project) const;
    bool hasDependency(const Project *project, const Project *depProject) const;
    bool canAddDependency(const Project *project, const Project *depProject) const;
dt's avatar
dt committed
102 103
    bool addDependency(Project *project, Project *depProject);
    void removeDependency(Project *project, Project *depProject);
con's avatar
con committed
104

dt's avatar
dt committed
105
    QString currentSession() const;
106
    QString sessionNameToFileName(const QString &session) const;
107
    QString sessionNameFromFileName(const QString &fileName) const;
con's avatar
con committed
108 109
    Project *startupProject() const;

110
    const QList<Project *> &projects() const;
con's avatar
con committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

    bool isDefaultVirgin() const;
    bool isDefaultSession(const QString &session) const;

    // Let other plugins store persistent values within the session file
    void setValue(const QString &name, const QVariant &value);
    QVariant value(const QString &name);

    // NBS rewrite projectOrder (dependency management)
    QList<Project *> projectOrder(Project *project = 0) const;
    QAbstractItemModel *model(const QString &modelId) const;

    SessionNode *sessionNode() const;

    Project *projectForNode(ProjectExplorer::Node *node) const;
dt's avatar
dt committed
126
    Node *nodeForFile(const QString &fileName, Project *project = 0) const;
con's avatar
con committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140
    Project *projectForFile(const QString &fileName) const;


    void reportProjectLoadingProgress();

signals:
    void projectAdded(ProjectExplorer::Project *project);
    void singleProjectAdded(ProjectExplorer::Project *project);
    void aboutToRemoveProject(ProjectExplorer::Project *project);

    void projectRemoved(ProjectExplorer::Project *project);

    void startupProjectChanged(ProjectExplorer::Project *project);

141
    void aboutToLoadSession(QString sessionName);
con's avatar
con committed
142
    void sessionLoaded();
143
    void aboutToUnloadSession();
con's avatar
con committed
144
    void aboutToSaveSession();
dt's avatar
dt committed
145
    void dependencyChanged(ProjectExplorer::Project *a, ProjectExplorer::Project *b);
con's avatar
con committed
146 147 148 149

private slots:
    void saveActiveMode(Core::IMode *mode);
    void clearProjectFileCache();
150
    void configureEditor(Core::IEditor *editor, const QString &fileName);
con's avatar
con committed
151 152
    void updateWindowTitle();

153
    void markSessionFileDirty(bool makeDefaultVirginDirty = true);
154

con's avatar
con committed
155 156 157
private:
    bool loadImpl(const QString &fileName);
    bool createImpl(const QString &fileName);
158
    bool projectContainsFile(Project *p, const QString &fileName) const;
con's avatar
con committed
159 160 161 162 163 164 165 166 167 168

    bool recursiveDependencyCheck(const QString &newDep, const QString &checkDep) const;
    QStringList dependencies(const QString &proName) const;
    QStringList dependenciesOrder() const;

    void updateName(const QString &session);

    Internal::SessionFile *m_file;
    Internal::SessionNodeImpl *m_sessionNode;
    QString m_sessionName;
dt's avatar
dt committed
169
    bool m_virginSession;
con's avatar
con committed
170

171 172 173
    mutable QStringList m_sessions;

    mutable QHash<Project *, QStringList> m_projectFileCache;
174
    QTimer *m_autoSaveSessionTimer;
con's avatar
con committed
175 176 177 178 179
};

} // namespace ProjectExplorer

#endif // SESSION_H