session.cpp 28.9 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
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
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
**
29
**************************************************************************/
hjk's avatar
hjk committed
30 31 32

#include "session.h"

con's avatar
con committed
33 34 35 36 37
#include "project.h"
#include "projectexplorer.h"
#include "projectexplorerconstants.h"
#include "nodesvisitor.h"
#include "editorconfiguration.h"
38
#include "projectnodes.h"
con's avatar
con committed
39 40 41

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
42
#include <coreplugin/documentmanager.h>
con's avatar
con committed
43 44
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
45
#include <coreplugin/coreconstants.h>
46
#include <coreplugin/progressmanager/progressmanager.h>
con's avatar
con committed
47 48 49 50
#include <coreplugin/modemanager.h>

#include <texteditor/itexteditor.h>

hjk's avatar
hjk committed
51 52 53
#include <utils/listutils.h>
#include <utils/qtcassert.h>

54 55 56 57 58 59
#include <QDebug>
#include <QDir>
#include <QFileInfo>
#include <QFuture>
#include <QSettings>
#include <QTimer>
hjk's avatar
hjk committed
60

61 62 63 64
#include <QApplication>
#include <QMessageBox>
#include <QPushButton>
#include <QTextCodec>
con's avatar
con committed
65 66 67 68 69

namespace {
    bool debug = false;
}

70
using namespace Core;
Jarek Kobus's avatar
Jarek Kobus committed
71 72
using Utils::PersistentSettingsReader;
using Utils::PersistentSettingsWriter;
73

con's avatar
con committed
74
using namespace ProjectExplorer;
75
using namespace ProjectExplorer::Internal;
con's avatar
con committed
76

77 78 79 80 81 82 83 84 85 86
/*!
     \class ProjectExplorer::SessionManager

     \brief Session management.

     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.
*/
con's avatar
con committed
87

hjk's avatar
hjk committed
88 89
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
90
    m_sessionNode(new SessionNode(this)),
91
    m_sessionName(QLatin1String("default")),
92
    m_virginSession(true),
93
    m_loadingSession(false),
Tobias Hunger's avatar
Tobias Hunger committed
94 95
    m_startupProject(0),
    m_writer(0)
con's avatar
con committed
96
{
97
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
98
            this, SLOT(saveActiveMode(Core::IMode*)));
99

hjk's avatar
hjk committed
100
    EditorManager *em = ICore::editorManager();
101

Robert Loehning's avatar
Robert Loehning committed
102 103 104
    connect(em, SIGNAL(editorCreated(Core::IEditor*,QString)),
            this, SLOT(configureEditor(Core::IEditor*,QString)));
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project*)),
con's avatar
con committed
105
            this, SLOT(updateWindowTitle()));
106 107 108 109
    connect(em, SIGNAL(editorOpened(Core::IEditor*)),
            this, SLOT(markSessionFileDirty()));
    connect(em, SIGNAL(editorsClosed(QList<Core::IEditor*>)),
            this, SLOT(markSessionFileDirty()));
hjk's avatar
hjk committed
110
}
con's avatar
con committed
111 112 113

SessionManager::~SessionManager()
{
114
    emit aboutToUnloadSession(m_sessionName);
Tobias Hunger's avatar
Tobias Hunger committed
115
    delete m_writer;
con's avatar
con committed
116 117 118 119 120
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
121 122
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
123 124 125 126
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
127
    return session == QLatin1String("default");
con's avatar
con committed
128 129 130 131 132
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
133
    setValue(QLatin1String("ActiveMode"), mode->id().toString());
con's avatar
con committed
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
}

void SessionManager::clearProjectFileCache()
{
    // If triggered by the fileListChanged signal of one project
    // only invalidate cache for this project
    Project *pro = qobject_cast<Project*>(sender());
    if (pro)
        m_projectFileCache.remove(pro);
    else
        m_projectFileCache.clear();
}

bool SessionManager::recursiveDependencyCheck(const QString &newDep, const QString &checkDep) const
{
    if (newDep == checkDep)
        return false;

152
    foreach (const QString &dependency, m_depMap.value(checkDep)) {
con's avatar
con committed
153 154 155 156 157 158 159
        if (!recursiveDependencyCheck(newDep, dependency))
            return false;
    }

    return true;
}

160
/*
161
 * The dependency management exposes an interface based on projects, but
162 163 164 165 166 167 168
 * is internally purely string based. This is suboptimal. Probably it would be
 * nicer to map the filenames to projects on load and only map it back to
 * filenames when saving.
 */

QList<Project *> SessionManager::dependencies(const Project *project) const
{
169
    const QString &proName = project->document()->fileName();
170
    const QStringList &proDeps = m_depMap.value(proName);
171 172 173 174 175 176 177 178 179 180 181

    QList<Project *> projects;
    foreach (const QString &dep, proDeps) {
        if (Project *pro = projectForFile(dep))
            projects += pro;
    }

    return projects;
}

bool SessionManager::hasDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
182
{
183 184
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
185

186
    const QStringList &proDeps = m_depMap.value(proName);
con's avatar
con committed
187 188 189
    return proDeps.contains(depName);
}

190
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
191
{
192 193
    const QString &newDep = project->document()->fileName();
    const QString &checkDep = depProject->document()->fileName();
con's avatar
con committed
194 195 196 197

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
198
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
199
{
200 201
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
202 203 204 205 206

    // check if this dependency is valid
    if (!recursiveDependencyCheck(proName, depName))
        return false;

207
    QStringList proDeps = m_depMap.value(proName);
con's avatar
con committed
208 209
    if (!proDeps.contains(depName)) {
        proDeps.append(depName);
210
        m_depMap[proName] = proDeps;
con's avatar
con committed
211
    }
dt's avatar
dt committed
212
    emit dependencyChanged(project, depProject);
con's avatar
con committed
213 214 215 216

    return true;
}

dt's avatar
dt committed
217
void SessionManager::removeDependency(Project *project, Project *depProject)
218
{
219 220
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
221

222
    QStringList proDeps = m_depMap.value(proName);
223 224
    proDeps.removeAll(depName);
    if (proDeps.isEmpty()) {
225
        m_depMap.remove(proName);
226
    } else {
227
        m_depMap[proName] = proDeps;
228
    }
dt's avatar
dt committed
229
    emit dependencyChanged(project, depProject);
230 231
}

con's avatar
con committed
232 233 234
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
235
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
236 237

    if (startupProject) {
238
        Q_ASSERT(m_projects.contains(startupProject));
con's avatar
con committed
239 240
    }

241
    if (m_startupProject == startupProject)
242 243
        return;

244
    m_startupProject = startupProject;
con's avatar
con committed
245 246 247 248 249
    emit startupProjectChanged(startupProject);
}

Project *SessionManager::startupProject() const
{
250
    return m_startupProject;
con's avatar
con committed
251 252 253 254 255 256 257 258 259
}

void SessionManager::addProject(Project *project)
{
    addProjects(QList<Project*>() << project);
}

void SessionManager::addProjects(const QList<Project*> &projects)
{
dt's avatar
dt committed
260
    m_virginSession = false;
con's avatar
con committed
261 262
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
263
        if (!m_projects.contains(pro)) {
con's avatar
con committed
264
            clearedList.append(pro);
265
            m_projects.append(pro);
266
            m_sessionNode->addProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
con's avatar
con committed
267 268 269 270

            connect(pro, SIGNAL(fileListChanged()),
                    this, SLOT(clearProjectFileCache()));

271 272 273
            connect(pro, SIGNAL(displayNameChanged()),
                    this, SLOT(projectDisplayNameChanged()));

con's avatar
con committed
274
            if (debug)
275
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
276 277 278 279 280 281 282 283 284 285 286 287 288
        }
    }

    foreach (Project *pro, clearedList) {
        emit projectAdded(pro);
    }

    if (clearedList.count() == 1)
        emit singleProjectAdded(clearedList.first());
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
289
    m_virginSession = false;
con's avatar
con committed
290 291 292 293 294 295 296
    if (project == 0) {
        qDebug() << "SessionManager::removeProject(0) ... THIS SHOULD NOT HAPPEN";
        return;
    }
    removeProjects(QList<Project*>() << project);
}

297 298 299 300 301
bool SessionManager::loadingSession()
{
    return m_loadingSession;
}

con's avatar
con committed
302 303 304 305 306 307 308
bool SessionManager::save()
{
    if (debug)
        qDebug() << "SessionManager - saving session" << m_sessionName;

    emit aboutToSaveSession();

Tobias Hunger's avatar
Tobias Hunger committed
309 310 311 312 313
    if (!m_writer || m_writer->fileName() != sessionNameToFileName(m_sessionName)) {
        delete m_writer;
        m_writer = new Utils::PersistentSettingsWriter(sessionNameToFileName(m_sessionName),
                                                       QLatin1String("QtCreatorSession"));
    }
314 315

    // save the startup project
Tobias Hunger's avatar
Tobias Hunger committed
316 317
    if (m_startupProject)
        m_writer->saveValue(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
318 319

    QStringList projectFiles;
320
    foreach (Project *pro, m_projects)
321
        projectFiles << pro->document()->fileName();
322 323

    // Restore infromation on projects that failed to load:
324 325 326 327
    // don't readd projects to the list, which the user loaded
    foreach (const QString &failed, m_failedProjects)
        if (!projectFiles.contains(failed))
            projectFiles << failed;
328

Tobias Hunger's avatar
Tobias Hunger committed
329
    m_writer->saveValue(QLatin1String("ProjectList"), projectFiles);
330 331

    QMap<QString, QVariant> depMap;
332 333
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
334 335 336 337 338 339 340 341
        QString key = i.key();
        QStringList values;
        foreach (const QString &value, i.value()) {
            values << value;
        }
        depMap.insert(key, values);
        ++i;
    }
Tobias Hunger's avatar
Tobias Hunger committed
342
    m_writer->saveValue(QLatin1String("ProjectDependencies"), QVariant(depMap));
con's avatar
con committed
343

344 345 346 347 348 349 350
    int editorCount = 0;
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
Tobias Hunger's avatar
Tobias Hunger committed
351 352 353
    m_writer->saveValue(QLatin1String("OpenEditors"), editorCount);
    m_writer->saveValue(QLatin1String("EditorSettings"),
                        ICore::editorManager()->saveState().toBase64());
354 355

    QMap<QString, QVariant>::const_iterator it, end;
356
    end = m_values.constEnd();
357
    QStringList keys;
358
    for (it = m_values.constBegin(); it != end; ++it) {
Tobias Hunger's avatar
Tobias Hunger committed
359
        m_writer->saveValue(QLatin1String("value-") + it.key(), it.value());
360 361 362
        keys << it.key();
    }

Tobias Hunger's avatar
Tobias Hunger committed
363
    m_writer->saveValue(QLatin1String("valueKeys"), keys);
364

Tobias Hunger's avatar
Tobias Hunger committed
365
    bool result = m_writer->save(Core::ICore::mainWindow());
con's avatar
con committed
366 367
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Tobias Hunger's avatar
Tobias Hunger committed
368
                                tr("Could not save session to file %1").arg(m_writer->fileName().toUserOutput()));
con's avatar
con committed
369 370 371 372 373 374 375 376 377
    }

    if (debug)
        qDebug() << "SessionManager - saving session returned " << result;

    return result;
}

/*!
378
  \fn bool SessionManager::closeAllProjects()
con's avatar
con committed
379

380
  Closes all projects
con's avatar
con committed
381
  */
382
void SessionManager::closeAllProjects()
con's avatar
con committed
383
{
384 385
    setStartupProject(0);
    removeProjects(projects());
con's avatar
con committed
386 387
}

388
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
389
{
390
    return m_projects;
con's avatar
con committed
391 392 393 394 395
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
396
    foreach (const QString &dep, m_depMap.value(proName))
con's avatar
con committed
397 398 399 400 401 402 403 404 405 406 407 408 409
        result += dependencies(dep);

    result << proName;
    return result;
}

QStringList SessionManager::dependenciesOrder() const
{
    QList<QPair<QString, QStringList> > unordered;
    QStringList ordered;

    // copy the map to a temporary list
    foreach (Project *pro, projects()) {
410
        const QString &proName = pro->document()->fileName();
con's avatar
con committed
411
        unordered << QPair<QString, QStringList>
412
            (proName, m_depMap.value(proName));
con's avatar
con committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    }

    while (!unordered.isEmpty()) {
        for (int i=(unordered.count()-1); i>=0; --i) {
            if (unordered.at(i).second.isEmpty()) {
                ordered << unordered.at(i).first;
                unordered.removeAt(i);
            }
        }

        // remove the handled projects from the dependency lists
        // of the remaining unordered projects
        for (int i = 0; i < unordered.count(); ++i) {
            foreach (const QString &pro, ordered) {
                QStringList depList = unordered.at(i).second;
                depList.removeAll(pro);
                unordered[i].second = depList;
            }
        }
    }

    return ordered;
}

QList<Project *> SessionManager::projectOrder(Project *project) const
{
    QList<Project *> result;

    QStringList pros;
    if (project) {
443
        pros = dependencies(project->document()->fileName());
con's avatar
con committed
444 445 446 447 448 449
    } else {
        pros = dependenciesOrder();
    }

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
450
            if (pro->document()->fileName() == proFile) {
con's avatar
con committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
                result << pro;
                break;
            }
        }
    }

    return result;
}

Project *SessionManager::projectForNode(Node *node) const
{
    if (!node)
        return 0;

    Project *project = 0;

    FolderNode *rootProjectNode = qobject_cast<FolderNode*>(node);
    if (!rootProjectNode)
        rootProjectNode = node->parentFolderNode();
    while (rootProjectNode && rootProjectNode->parentFolderNode() != m_sessionNode)
        rootProjectNode = rootProjectNode->parentFolderNode();

dt's avatar
dt committed
473
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
474 475 476 477 478 479 480 481 482 483 484 485

    QList<Project *> projectList = projects();
    foreach (Project *p, projectList) {
        if (p->rootProjectNode() == rootProjectNode) {
            project = p;
            break;
        }
    }

    return project;
}

dt's avatar
dt committed
486
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
487 488
{
    Node *node = 0;
dt's avatar
dt committed
489 490 491
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
        FindNodesForFileVisitor findNodes(fileName);
        project->rootProjectNode()->accept(&findNodes);

        foreach (Node *n, findNodes.nodes()) {
            // prefer file nodes
            if (!node || (node->nodeType() != FileNodeType && n->nodeType() == FileNodeType))
                node = n;
        }
    }

    return node;
}

Project *SessionManager::projectForFile(const QString &fileName) const
{
    if (debug)
        qDebug() << "SessionManager::projectForFile(" << fileName << ")";

510
    const QList<Project *> &projectList = projects();
con's avatar
con committed
511

512
    // Check current project first
513
    Project *currentProject = ProjectExplorerPlugin::currentProject();
514 515
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
516

517 518 519 520 521 522 523 524 525 526 527 528
    foreach (Project *p, projectList)
        if (p != currentProject && projectContainsFile(p, fileName))
            return p;
    return 0;
}

bool SessionManager::projectContainsFile(Project *p, const QString &fileName) const
{
    if (!m_projectFileCache.contains(p))
        m_projectFileCache.insert(p, p->files(Project::AllFiles));

    return m_projectFileCache.value(p).contains(fileName);
con's avatar
con committed
529 530
}

531
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
532
{
533 534 535
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
536 537
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
538
    }
con's avatar
con committed
539 540 541 542
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
543
    if (isDefaultSession(m_sessionName)) {
544
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
545
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
546
        else
hjk's avatar
hjk committed
547
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
548
    } else {
con's avatar
con committed
549 550 551
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
552
        ICore::editorManager()->setWindowTitleAddition(sessionName);
553
    }
con's avatar
con committed
554 555 556 557 558 559 560 561
}

void SessionManager::removeProjects(QList<Project *> remove)
{
    QMap<QString, QStringList> resMap;

    foreach (Project *pro, remove) {
        if (debug)
562
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
563 564 565 566 567 568 569 570
        emit aboutToRemoveProject(pro);
    }


    // Refresh dependencies
    QSet<QString> projectFiles;
    foreach (Project *pro, projects()) {
        if (!remove.contains(pro))
571
            projectFiles.insert(pro->document()->fileName());
con's avatar
con committed
572 573 574 575 576
    }

    QSet<QString>::const_iterator i = projectFiles.begin();
    while (i != projectFiles.end()) {
        QStringList dependencies;
577
        foreach (const QString &dependency, m_depMap.value(*i)) {
con's avatar
con committed
578 579 580 581 582 583 584 585
            if (projectFiles.contains(dependency))
                dependencies << dependency;
        }
        if (!dependencies.isEmpty())
            resMap.insert(*i, dependencies);
        ++i;
    }

586
    m_depMap = resMap;
con's avatar
con committed
587

588 589 590 591 592
    // TODO: Clear m_modelProjectHash

    // Delete projects
    foreach (Project *pro, remove) {
        pro->saveSettings();
593
        m_projects.removeOne(pro);
594

595
        if (pro == m_startupProject)
596 597 598 599 600 601 602 603
            setStartupProject(0);

        disconnect(pro, SIGNAL(fileListChanged()),
                this, SLOT(clearProjectFileCache()));
        m_projectFileCache.remove(pro);

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
604
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
605 606 607 608
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
609
    if (startupProject() == 0)
610 611
        if (!m_projects.isEmpty())
            setStartupProject(m_projects.first());
con's avatar
con committed
612 613
}

614 615 616 617
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
618 619
void SessionManager::setValue(const QString &name, const QVariant &value)
{
620
    if (m_values.value(name) == value)
621
        return;
622
    m_values.insert(name, value);
623
    markSessionFileDirty(false);
con's avatar
con committed
624 625 626 627
}

QVariant SessionManager::value(const QString &name)
{
628 629
    QMap<QString, QVariant>::const_iterator it = m_values.find(name);
    return (it == m_values.constEnd()) ? QVariant() : *it;
con's avatar
con committed
630 631 632 633 634 635 636 637 638
}

QString SessionManager::activeSession() const
{
    return m_sessionName;
}

QStringList SessionManager::sessions() const
{
639
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
640
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
641
        QDir sessionDir(Core::ICore::userResourcePath());
642 643
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
644
            if (fileInfo.completeBaseName() != QLatin1String("default"))
645 646
                m_sessions << fileInfo.completeBaseName();
        }
647
        m_sessions.prepend(QLatin1String("default"));
648 649
    }
    return m_sessions;
con's avatar
con committed
650 651
}

652
Utils::FileName SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
653
{
654
    return Utils::FileName::fromString(ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws"));
con's avatar
con committed
655 656
}

657 658 659 660
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
661 662 663 664
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
665 666
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
667 668 669
    return true;
}

670 671 672 673 674 675 676 677 678
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

679 680 681
/*!
     \brief Deletes session name from session list and file from disk.
*/
con's avatar
con committed
682 683
bool SessionManager::deleteSession(const QString &session)
{
684
    if (!m_sessions.contains(session))
con's avatar
con committed
685
        return false;
686
    m_sessions.removeOne(session);
687
    QFile fi(sessionNameToFileName(session).toString());
con's avatar
con committed
688 689 690 691 692 693 694
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
695
    if (!m_sessions.contains(original))
con's avatar
con committed
696 697
        return false;

698
    QFile fi(sessionNameToFileName(original).toString());
con's avatar
con committed
699
    // If the file does not exist, we can still clone
700
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone).toString())) {
701 702
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
703 704 705 706 707
        return true;
    }
    return false;
}

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
void SessionManager::restoreValues(const Utils::PersistentSettingsReader &reader)
{
    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
        QVariant value = reader.restoreValue(QLatin1String("value-") + key);
        m_values.insert(key, value);
    }
}

void SessionManager::restoreDependencies(const Utils::PersistentSettingsReader &reader)
{
    QMap<QString, QVariant> depMap = reader.restoreValue(QLatin1String("ProjectDependencies")).toMap();
    QMap<QString, QVariant>::const_iterator i = depMap.constBegin();
    while (i != depMap.constEnd()) {
        const QString &key = i.key();
        if (m_failedProjects.contains(key))
            continue;
        QStringList values;
        foreach (const QString &value, i.value().toStringList()) {
            if (!m_failedProjects.contains(value))
                values << value;
        }
        m_depMap.insert(key, values);
        ++i;
    }
}

void SessionManager::askUserAboutFailedProjects()
{
    QStringList failedProjects = m_failedProjects;
    if (!failedProjects.isEmpty()) {
        QString fileList =
            QDir::toNativeSeparators(failedProjects.join(QLatin1String("<br>")));
        QMessageBox * box = new QMessageBox(QMessageBox::Warning,
                                            tr("Failed to restore project files"),
                                            tr("Could not restore the following project files:<br><b>%1</b>").
                                            arg(fileList));
        QPushButton * keepButton = new QPushButton(tr("Keep projects in Session"), box);
        QPushButton * removeButton = new QPushButton(tr("Remove projects from Session"), box);
        box->addButton(keepButton, QMessageBox::AcceptRole);
        box->addButton(removeButton, QMessageBox::DestructiveRole);

        box->exec();

        if (box->clickedButton() == removeButton)
            m_failedProjects.clear();
    }
}

void SessionManager::restoreStartupProject(const Utils::PersistentSettingsReader &reader)
{
    const QString startupProject = reader.restoreValue(QLatin1String("StartupProject")).toString();
    if (!startupProject.isEmpty()) {
        foreach (Project *pro, m_projects) {
762
            if (QDir::cleanPath(pro->document()->fileName()) == startupProject) {
763
                setStartupProject(pro);
764 765 766
                break;
            }
        }
767 768 769 770 771
    }
    if (!m_startupProject) {
        qWarning() << "Could not find startup project" << startupProject;
        if (!projects().isEmpty())
            setStartupProject(projects().first());
772 773 774 775 776 777 778
    }
}

void SessionManager::restoreEditors(const Utils::PersistentSettingsReader &reader)
{
    const QVariant &editorsettings = reader.restoreValue(QLatin1String("EditorSettings"));
    if (editorsettings.isValid()) {
Robert Loehning's avatar
Robert Loehning committed
779
        connect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
780 781 782
                this, SLOT(sessionLoadingProgress()));
        ICore::editorManager()->restoreState(
            QByteArray::fromBase64(editorsettings.toByteArray()));
Robert Loehning's avatar
Robert Loehning committed
783
        disconnect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
784 785 786 787
                   this, SLOT(sessionLoadingProgress()));
    }
}

788 789 790
/*!
     \brief Loads a session, takes a session name (not filename).
*/
791 792 793 794 795 796 797 798 799 800 801
void SessionManager::restoreProjects(const QStringList &fileList)
{
    // indirectly adds projects to session
    // Keep projects that failed to load in the session!
    m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
        QString errors;
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList, &errors);
        if (!errors.isEmpty())
            QMessageBox::critical(Core::ICore::mainWindow(), tr("Failed to open project"), errors);
        foreach (Project *p, projects)
802
            m_failedProjects.removeAll(p->document()->fileName());
803 804
    }
}
805

con's avatar
con committed
806 807 808 809 810 811 812 813 814 815
bool SessionManager::loadSession(const QString &session)
{
    // Do nothing if we have that session already loaded,
    // exception if the session is the default virgin session
    // we still want to be able to load the default session
    if (session == m_sessionName && !isDefaultVirgin())
        return true;

    if (!sessions().contains(session))
        return false;
816

817
    // Try loading the file
818
    Utils::FileName fileName = sessionNameToFileName(session);
819
    PersistentSettingsReader reader;
820
    if (fileName.toFileInfo().exists()) {
821 822
        if (!reader.load(fileName)) {
            QMessageBox::warning(0, tr("Error while restoring session"),
823
                                 tr("Could not restore session %1").arg(fileName.toUserOutput()));
824 825 826 827
            return false;
        }
    }

828 829
    m_loadingSession = true;

830 831 832 833
    // Allow everyone to set something in the session and before saving
    emit aboutToUnloadSession(m_sessionName);

    if (!isDefaultVirgin()) {
834 835
        if (!save()) {
            m_loadingSession = false;
836
            return false;
837
        }
838 839 840
    }

    // Clean up
841 842
    if (!ICore::editorManager()->closeAllEditors()) {
        m_loadingSession = false;
843
        return false;
844
    }
845 846 847 848 849 850 851

    setStartupProject(0);
    removeProjects(projects());

    m_failedProjects.clear();
    m_depMap.clear();
    m_values.clear();
852

853 854 855
    m_sessionName = session;
    updateWindowTitle();

856
    if (fileName.toFileInfo().exists()) {
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
        m_virginSession = false;

        ICore::progressManager()->addTask(m_future.future(), tr("Session"),
           QLatin1String("ProjectExplorer.SessionFile.Load"));

        restoreValues(reader);
        emit aboutToLoadSession(session);

        QStringList fileList =
            reader.restoreValue(QLatin1String("ProjectList")).toStringList();
        int openEditorsCount = reader.restoreValue(QLatin1String("OpenEditors")).toInt();

        m_future.setProgressRange(0, fileList.count() + openEditorsCount + 2);
        m_future.setProgressValue(1);

        restoreProjects(fileList);
        sessionLoadingProgress();
        restoreDependencies(reader);
        restoreStartupProject(reader);
        restoreEditors(reader);

        m_future.reportFinished();
        m_future = QFutureInterface<void>();

        // restore the active mode
        QString modeIdentifier = value(QLatin1String("ActiveMode")).toString();
883
        Id modeId;
884
        if (modeIdentifier.isEmpty())
885 886 887
            modeId = Id(Core::Constants::MODE_EDIT);
        else
            modeId = Id(modeIdentifier);
888

889
        ModeManager::activateMode(modeId);
890 891
        ModeManager::setFocusToCurrentMode();
    } else {
892
        ModeManager::activateMode(Id(Core::Constants::MODE_EDIT));
893 894 895 896 897 898
        ModeManager::setFocusToCurrentMode();
    }
    emit sessionLoaded(session);

    // Starts a event loop, better do that at the very end
    askUserAboutFailedProjects();
899
    m_loadingSession = false;
900
    return true;
con's avatar
con committed
901 902 903 904
}

QString SessionManager::lastSession() const
{
hjk's avatar
hjk committed
905
    QString fileName = ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
906
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
907 908 909 910 911 912 913 914 915
}

SessionNode *SessionManager::sessionNode() const
{
    return m_sessionNode;
}

void SessionManager::reportProjectLoadingProgress()
{
916
    sessionLoadingProgress();
con's avatar
con committed
917 918
}

919
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
920
{
921
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
922
        m_virginSession = false;
923
}
con's avatar
con committed
924

925 926
void SessionManager::sessionLoadingProgress()
{
927
    m_future.setProgressValue(m_future.progressValue() + 1);
928 929
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}
930

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
void SessionManager::projectDisplayNameChanged()
{
    Project *pro = qobject_cast<Project*>(sender());
    if (pro) {
        Node *currentNode = 0;
        if (ProjectExplorerPlugin::currentProject() == pro)
            currentNode = ProjectExplorerPlugin::instance()->currentNode();

        // Fix node sorting
        QList<ProjectNode *> nodes;
        nodes << pro->rootProjectNode();
        m_sessionNode->removeProjectNodes(nodes);
        m_sessionNode->addProjectNodes(nodes);

        if (currentNode)
            ProjectExplorerPlugin::instance()->setCurrentNode(currentNode);

        emit projectDisplayNameChanged(pro);
    }
}

952 953
QStringList ProjectExplorer::SessionManager::projectsForSessionName(const QString &session) const
{
954
    const Utils::FileName fileName = sessionNameToFileName(session);
955
    PersistentSettingsReader reader;
956
    if (fileName.toFileInfo().exists()) {
957
        if (!reader.load(fileName)) {
958
            qWarning() << "Could not restore session" << fileName.toUserOutput();
959 960 961 962 963
            return QStringList();
        }
    }
    return reader.restoreValue(QLatin1String("ProjectList")).toStringList();
}