session.h 5.48 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>
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
    ~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);
84
    bool renameSession(const QString &original, const QString &newName);
con's avatar
con committed
85
86
87
88
89
90
91
92
93
94
95
96
97

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

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

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

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

    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
123
    Node *nodeForFile(const QString &fileName, Project *project = 0) const;
con's avatar
con committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
    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);

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

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

150
    void markSessionFileDirty(bool makeDefaultVirginDirty = true);
151
    void sessionLoadingProgress();
152

con's avatar
con committed
153
154
155
private:
    bool loadImpl(const QString &fileName);
    bool createImpl(const QString &fileName);
156
    bool projectContainsFile(Project *p, const QString &fileName) const;
con's avatar
con committed
157
158
159
160
161
162

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

    Internal::SessionFile *m_file;
163
    SessionNode *m_sessionNode;
con's avatar
con committed
164
    QString m_sessionName;
dt's avatar
dt committed
165
    bool m_virginSession;
con's avatar
con committed
166

167
168
169
    mutable QStringList m_sessions;

    mutable QHash<Project *, QStringList> m_projectFileCache;
170
    QTimer *m_autoSaveSessionTimer;
171
172

    Project *m_startupProject;
173
    QList<Project *> m_projects;
174
    QStringList m_failedProjects;
175
    QMap<QString, QStringList> m_depMap;
176
    QMap<QString, QVariant> m_values;
con's avatar
con committed
177
178
179
180
181
};

} // namespace ProjectExplorer

#endif // SESSION_H