session.h 5.96 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
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
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
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

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

#include "projectexplorer_export.h"

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

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

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

namespace ProjectExplorer {

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

namespace Internal {
class SessionFile;
65
class SessionNodeImpl;
con's avatar
con committed
66 67 68 69 70 71 72 73
} // 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
74
class PROJECTEXPLORER_EXPORT SessionManager : public QObject
con's avatar
con committed
75 76 77 78
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
79
    explicit SessionManager(QObject *parent = 0);
con's avatar
con committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
    ~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);
98
    bool renameSession(const QString &original, const QString &newName);
con's avatar
con committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112

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

113 114 115
    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
116 117
    bool addDependency(Project *project, Project *depProject);
    void removeDependency(Project *project, Project *depProject);
con's avatar
con committed
118

dt's avatar
dt committed
119
    QString currentSession() const;
con's avatar
con committed
120 121
    Project *startupProject() const;

122
    const QList<Project *> &projects() const;
con's avatar
con committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137

    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
138
    Node *nodeForFile(const QString &fileName, Project *project = 0) const;
con's avatar
con committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
    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();
154
    void aboutToUnloadSession();
con's avatar
con committed
155
    void aboutToSaveSession();
dt's avatar
dt committed
156
    void dependencyChanged(ProjectExplorer::Project *a, ProjectExplorer::Project *b);
con's avatar
con committed
157 158 159 160 161 162 163

private slots:
    void saveActiveMode(Core::IMode *mode);
    void clearProjectFileCache();
    void setEditorCodec(Core::IEditor *editor, const QString &fileName);
    void updateWindowTitle();

164
    void markSessionFileDirty(bool makeDefaultVirginDirty = true);
165

con's avatar
con committed
166 167 168
private:
    bool loadImpl(const QString &fileName);
    bool createImpl(const QString &fileName);
169
    QString sessionNameToFileName(const QString &session) const;
170
    bool projectContainsFile(Project *p, const QString &fileName) const;
con's avatar
con committed
171 172 173 174 175 176 177 178 179 180 181 182

    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;
    QString m_sessionName;
dt's avatar
dt committed
183
    bool m_virginSession;
con's avatar
con committed
184

185 186 187
    mutable QStringList m_sessions;

    mutable QHash<Project *, QStringList> m_projectFileCache;
188
    QTimer *m_autoSaveSessionTimer;
con's avatar
con committed
189 190 191 192 193
};

} // namespace ProjectExplorer

#endif // SESSION_H