session.h 6.25 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) 2010 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
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

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

#include "projectexplorer_export.h"
#include "projectnodes.h"

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

42 43 44 45
QT_BEGIN_NAMESPACE
class QAbstractItemModel;
QT_END_NAMESPACE

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

namespace ProjectExplorer {

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

namespace Internal {

class SessionFile;

// Must be in header as otherwise moc has issues
// with ProjectExplorer::SessionNode on msvc2005
hjk's avatar
hjk committed
66
class SessionNodeImpl : public ProjectExplorer::SessionNode
con's avatar
con committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
{
    Q_OBJECT
public:
    SessionNodeImpl(SessionManager *manager);

    void addProjectNode(ProjectNode *projectNode);
    void removeProjectNode(ProjectNode *projectNode);

    void setFileName(const QString &fileName);
};

} // namespace Internal

// TODO the interface of this class is not really great

// The implementation suffers that all the functions from the
// public interface just wrap around functions which do the actual work

// This could be improved.
hjk's avatar
hjk committed
86
class PROJECTEXPLORER_EXPORT SessionManager : public QObject
con's avatar
con committed
87 88 89 90
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
91
    explicit SessionManager(QObject *parent = 0);
con's avatar
con committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
    ~SessionManager();

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

    // creates a new default session and switches to it
    void createAndLoadNewDefaultSession();

    // Just creates a new session (Does not actually create the file)
    bool createSession(const QString &session);

    // delete session name from session list
    // delete file from disk
    bool deleteSession(const QString &session);

    bool cloneSession(const QString &original, const QString &clone);

    // loads a session, takes a session name (not filename)
    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);

124 125 126
    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
127 128
    bool addDependency(Project *project, Project *depProject);
    void removeDependency(Project *project, Project *depProject);
con's avatar
con committed
129 130 131 132

    Core::IFile *file() const;
    Project *startupProject() const;

133
    const QList<Project *> &projects() const;
con's avatar
con committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

    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
149
    Node *nodeForFile(const QString &fileName, Project *project = 0) const;
con's avatar
con committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
    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);

    void sessionLoaded();
165
    void aboutToUnloadSession();
con's avatar
con committed
166
    void aboutToSaveSession();
dt's avatar
dt committed
167
    void dependencyChanged(ProjectExplorer::Project *a, ProjectExplorer::Project *b);
con's avatar
con committed
168 169 170 171 172

private slots:
    void saveActiveMode(Core::IMode *mode);
    void clearProjectFileCache();
    void setEditorCodec(Core::IEditor *editor, const QString &fileName);
173
    void handleCurrentEditorChange(Core::IEditor *editor);
con's avatar
con committed
174 175
    void updateWindowTitle();

176
    void markSessionFileDirty(bool makeDefaultVirginDirty = true);
177

con's avatar
con committed
178 179 180 181
private:
    bool loadImpl(const QString &fileName);
    bool createImpl(const QString &fileName);
    QString sessionNameToFileName(const QString &session);
182
    bool projectContainsFile(Project *p, const QString &fileName) const;
con's avatar
con committed
183 184 185 186 187 188 189 190 191 192 193

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

    void updateName(const QString &session);

    Core::ICore *m_core;

    Internal::SessionFile *m_file;
    Internal::SessionNodeImpl *m_sessionNode;
194
    QPointer<Core::IEditor> m_currentEditor;
con's avatar
con committed
195 196
    QString m_displayName;
    QString m_sessionName;
197
    bool m_defaultVirginSession;
con's avatar
con committed
198

199 200 201
    mutable QStringList m_sessions;

    mutable QHash<Project *, QStringList> m_projectFileCache;
202
    QTimer *m_autoSaveSessionTimer;
con's avatar
con committed
203 204 205 206 207
};

} // namespace ProjectExplorer

#endif // SESSION_H