session.h 5.74 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 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/QMap>
42
#include <QtCore/QFutureInterface>
43
#include <utils/persistentsettings.h>
con's avatar
con committed
44

45 46
QT_BEGIN_NAMESPACE
class QAbstractItemModel;
47
class QTimer;
48 49
QT_END_NAMESPACE

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

namespace ProjectExplorer {

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

hjk's avatar
hjk committed
63
class PROJECTEXPLORER_EXPORT SessionManager : public QObject
con's avatar
con committed
64 65 66 67
{
    Q_OBJECT

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

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

    bool createSession(const QString &session);

    bool deleteSession(const QString &session);

    bool cloneSession(const QString &original, const QString &clone);
81
    bool renameSession(const QString &original, const QString &newName);
con's avatar
con committed
82 83 84 85 86 87 88 89 90 91 92 93 94

    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);

95 96 97
    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
98 99
    bool addDependency(Project *project, Project *depProject);
    void removeDependency(Project *project, Project *depProject);
con's avatar
con committed
100

101
    QString sessionNameToFileName(const QString &session) const;
con's avatar
con committed
102 103
    Project *startupProject() const;

104
    const QList<Project *> &projects() const;
con's avatar
con committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118

    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;

    SessionNode *sessionNode() const;

    Project *projectForNode(ProjectExplorer::Node *node) const;
dt's avatar
dt committed
119
    Node *nodeForFile(const QString &fileName, Project *project = 0) const;
con's avatar
con committed
120 121 122 123 124 125 126 127 128 129 130 131 132
    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);

133
    void aboutToUnloadSession(QString sessionName);
134
    void aboutToLoadSession(QString sessionName);
135
    void sessionLoaded(QString sessionName);
con's avatar
con committed
136
    void aboutToSaveSession();
dt's avatar
dt committed
137
    void dependencyChanged(ProjectExplorer::Project *a, ProjectExplorer::Project *b);
con's avatar
con committed
138 139 140 141

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

145
    void markSessionFileDirty(bool makeDefaultVirginDirty = true);
146
    void sessionLoadingProgress();
147

con's avatar
con committed
148
private:
149
    bool projectContainsFile(Project *p, const QString &fileName) const;
150 151 152 153 154 155
    void restoreValues(const Utils::PersistentSettingsReader &reader);
    void restoreDependencies(const Utils::PersistentSettingsReader &reader);
    void restoreStartupProject(const Utils::PersistentSettingsReader &reader);
    void restoreEditors(const Utils::PersistentSettingsReader &reader);
    void restoreProjects(const QStringList &fileList);
    void askUserAboutFailedProjects();
con's avatar
con committed
156 157 158 159 160

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

161
    SessionNode *m_sessionNode;
con's avatar
con committed
162
    QString m_sessionName;
dt's avatar
dt committed
163
    bool m_virginSession;
con's avatar
con committed
164

165 166 167
    mutable QStringList m_sessions;

    mutable QHash<Project *, QStringList> m_projectFileCache;
168
    QTimer *m_autoSaveSessionTimer;
169 170

    Project *m_startupProject;
171
    QList<Project *> m_projects;
172
    QStringList m_failedProjects;
173
    QMap<QString, QStringList> m_depMap;
174
    QMap<QString, QVariant> m_values;
Daniel Teske's avatar
Daniel Teske committed
175
    QFutureInterface<void> m_future;
con's avatar
con committed
176 177 178 179 180
};

} // namespace ProjectExplorer

#endif // SESSION_H