session.cpp 29.6 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29 30 31

#include "session.h"

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

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

#include <texteditor/itexteditor.h>

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

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
    QVariantMap data;
316
    // save the startup project
Tobias Hunger's avatar
Tobias Hunger committed
317
    if (m_startupProject)
318
        data.insert(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
319

320 321 322 323 324 325
    QColor c = Utils::StyleHelper::requestedBaseColor();
    if (c.isValid()) {
        QString tmp = QString::fromLatin1("#%1%2%3")
                .arg(c.red(), 2, 16, QLatin1Char('0'))
                .arg(c.green(), 2, 16, QLatin1Char('0'))
                .arg(c.blue(), 2, 16, QLatin1Char('0'));
326
        data.insert(QLatin1String("Color"), tmp);
327 328
    }

329
    QStringList projectFiles;
330
    foreach (Project *pro, m_projects)
331
        projectFiles << pro->document()->fileName();
332 333

    // Restore infromation on projects that failed to load:
334 335 336 337
    // don't readd projects to the list, which the user loaded
    foreach (const QString &failed, m_failedProjects)
        if (!projectFiles.contains(failed))
            projectFiles << failed;
338

339
    data.insert(QLatin1String("ProjectList"), projectFiles);
340 341

    QMap<QString, QVariant> depMap;
342 343
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
344 345 346 347 348 349 350 351
        QString key = i.key();
        QStringList values;
        foreach (const QString &value, i.value()) {
            values << value;
        }
        depMap.insert(key, values);
        ++i;
    }
352
    data.insert(QLatin1String("ProjectDependencies"), QVariant(depMap));
con's avatar
con committed
353

354 355 356 357 358 359 360
    int editorCount = 0;
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
361 362
    data.insert(QLatin1String("OpenEditors"), editorCount);
    data.insert(QLatin1String("EditorSettings"), ICore::editorManager()->saveState().toBase64());
363 364

    QMap<QString, QVariant>::const_iterator it, end;
365
    end = m_values.constEnd();
366
    QStringList keys;
367
    for (it = m_values.constBegin(); it != end; ++it) {
368
        data.insert(QLatin1String("value-") + it.key(), it.value());
369 370 371
        keys << it.key();
    }

372
    data.insert(QLatin1String("valueKeys"), keys);
373

374
    bool result = m_writer->save(data, Core::ICore::mainWindow());
con's avatar
con committed
375 376
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Tobias Hunger's avatar
Tobias Hunger committed
377
                                tr("Could not save session to file %1").arg(m_writer->fileName().toUserOutput()));
con's avatar
con committed
378 379 380 381 382 383 384 385 386
    }

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

    return result;
}

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

389
  Closes all projects
con's avatar
con committed
390
  */
391
void SessionManager::closeAllProjects()
con's avatar
con committed
392
{
393 394
    setStartupProject(0);
    removeProjects(projects());
con's avatar
con committed
395 396
}

397
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
398
{
399
    return m_projects;
con's avatar
con committed
400 401 402 403 404
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
405
    foreach (const QString &dep, m_depMap.value(proName))
con's avatar
con committed
406 407 408 409 410 411 412 413 414 415 416 417 418
        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()) {
419
        const QString &proName = pro->document()->fileName();
con's avatar
con committed
420
        unordered << QPair<QString, QStringList>
421
            (proName, m_depMap.value(proName));
con's avatar
con committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
    }

    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) {
452
        pros = dependencies(project->document()->fileName());
con's avatar
con committed
453 454 455 456 457 458
    } else {
        pros = dependenciesOrder();
    }

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
459
            if (pro->document()->fileName() == proFile) {
con's avatar
con committed
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
                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
482
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
483 484 485 486 487 488 489 490 491 492 493 494

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

    return project;
}

dt's avatar
dt committed
495
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
496 497
{
    Node *node = 0;
dt's avatar
dt committed
498 499 500
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
        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 << ")";

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

521
    // Check current project first
522
    Project *currentProject = ProjectExplorerPlugin::currentProject();
523 524
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
525

526 527 528 529 530 531 532 533 534 535 536 537
    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
538 539
}

540
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
541
{
542 543 544
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
545 546
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
547
    }
con's avatar
con committed
548 549 550 551
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
552
    if (isDefaultSession(m_sessionName)) {
553
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
554
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
555
        else
hjk's avatar
hjk committed
556
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
557
    } else {
con's avatar
con committed
558 559 560
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
561
        ICore::editorManager()->setWindowTitleAddition(sessionName);
562
    }
con's avatar
con committed
563 564 565 566 567 568 569 570
}

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

    foreach (Project *pro, remove) {
        if (debug)
571
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
572 573 574 575 576 577 578 579
        emit aboutToRemoveProject(pro);
    }


    // Refresh dependencies
    QSet<QString> projectFiles;
    foreach (Project *pro, projects()) {
        if (!remove.contains(pro))
580
            projectFiles.insert(pro->document()->fileName());
con's avatar
con committed
581 582 583 584 585
    }

    QSet<QString>::const_iterator i = projectFiles.begin();
    while (i != projectFiles.end()) {
        QStringList dependencies;
586
        foreach (const QString &dependency, m_depMap.value(*i)) {
con's avatar
con committed
587 588 589 590 591 592 593 594
            if (projectFiles.contains(dependency))
                dependencies << dependency;
        }
        if (!dependencies.isEmpty())
            resMap.insert(*i, dependencies);
        ++i;
    }

595
    m_depMap = resMap;
con's avatar
con committed
596

597 598 599 600 601
    // TODO: Clear m_modelProjectHash

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

604
        if (pro == m_startupProject)
605 606 607 608 609 610 611 612
            setStartupProject(0);

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

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
613
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
614 615 616 617
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
618
    if (startupProject() == 0)
619 620
        if (!m_projects.isEmpty())
            setStartupProject(m_projects.first());
con's avatar
con committed
621 622
}

623 624 625 626
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
627 628
void SessionManager::setValue(const QString &name, const QVariant &value)
{
629
    if (m_values.value(name) == value)
630
        return;
631
    m_values.insert(name, value);
632
    markSessionFileDirty(false);
con's avatar
con committed
633 634 635 636
}

QVariant SessionManager::value(const QString &name)
{
637 638
    QMap<QString, QVariant>::const_iterator it = m_values.find(name);
    return (it == m_values.constEnd()) ? QVariant() : *it;
con's avatar
con committed
639 640 641 642 643 644 645 646 647
}

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

QStringList SessionManager::sessions() const
{
648
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
649
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
650
        QDir sessionDir(Core::ICore::userResourcePath());
651 652
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
653
            if (fileInfo.completeBaseName() != QLatin1String("default"))
654 655
                m_sessions << fileInfo.completeBaseName();
        }
656
        m_sessions.prepend(QLatin1String("default"));
657 658
    }
    return m_sessions;
con's avatar
con committed
659 660
}

661
Utils::FileName SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
662
{
663
    return Utils::FileName::fromString(ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws"));
con's avatar
con committed
664 665
}

666 667 668 669
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
670 671 672 673
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
674 675
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
676 677 678
    return true;
}

679 680 681 682 683 684 685 686 687
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

688 689 690
/*!
     \brief Deletes session name from session list and file from disk.
*/
con's avatar
con committed
691 692
bool SessionManager::deleteSession(const QString &session)
{
693
    if (!m_sessions.contains(session))
con's avatar
con committed
694
        return false;
695
    m_sessions.removeOne(session);
696
    QFile fi(sessionNameToFileName(session).toString());
con's avatar
con committed
697 698 699 700 701 702 703
    if (fi.exists())
        return fi.remove();
    return false;
}

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

707
    QFile fi(sessionNameToFileName(original).toString());
con's avatar
con committed
708
    // If the file does not exist, we can still clone
709
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone).toString())) {
710 711
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
712 713 714 715 716
        return true;
    }
    return false;
}

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
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();
732 733 734 735 736 737 738
        if (!m_failedProjects.contains(key)) {
            QStringList values;
            foreach (const QString &value, i.value().toStringList()) {
                if (!m_failedProjects.contains(value))
                    values << value;
            }
            m_depMap.insert(key, values);
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
        }
        ++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) {
771
            if (QDir::cleanPath(pro->document()->fileName()) == startupProject) {
772
                setStartupProject(pro);
773 774 775
                break;
            }
        }
776 777 778 779 780
    }
    if (!m_startupProject) {
        qWarning() << "Could not find startup project" << startupProject;
        if (!projects().isEmpty())
            setStartupProject(projects().first());
781 782 783 784 785 786 787
    }
}

void SessionManager::restoreEditors(const Utils::PersistentSettingsReader &reader)
{
    const QVariant &editorsettings = reader.restoreValue(QLatin1String("EditorSettings"));
    if (editorsettings.isValid()) {
Robert Loehning's avatar
Robert Loehning committed
788
        connect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
789 790 791
                this, SLOT(sessionLoadingProgress()));
        ICore::editorManager()->restoreState(
            QByteArray::fromBase64(editorsettings.toByteArray()));
Robert Loehning's avatar
Robert Loehning committed
792
        disconnect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
793 794 795 796
                   this, SLOT(sessionLoadingProgress()));
    }
}

797 798 799
/*!
     \brief Loads a session, takes a session name (not filename).
*/
800 801 802 803 804 805 806 807 808 809 810
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)
811
            m_failedProjects.removeAll(p->document()->fileName());
812 813
    }
}
814

con's avatar
con committed
815 816 817 818 819 820 821 822 823 824
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;
825

826
    // Try loading the file
827
    Utils::FileName fileName = sessionNameToFileName(session);
828
    PersistentSettingsReader reader;
829
    if (fileName.toFileInfo().exists()) {
830 831
        if (!reader.load(fileName)) {
            QMessageBox::warning(0, tr("Error while restoring session"),
832
                                 tr("Could not restore session %1").arg(fileName.toUserOutput()));
833 834 835 836
            return false;
        }
    }

837 838
    m_loadingSession = true;

839 840 841 842
    // Allow everyone to set something in the session and before saving
    emit aboutToUnloadSession(m_sessionName);

    if (!isDefaultVirgin()) {
843 844
        if (!save()) {
            m_loadingSession = false;
845
            return false;
846
        }
847 848 849
    }

    // Clean up
850 851
    if (!ICore::editorManager()->closeAllEditors()) {
        m_loadingSession = false;
852
        return false;
853
    }
854 855 856 857 858 859 860

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

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

862 863 864
    m_sessionName = session;
    updateWindowTitle();

865
    if (fileName.toFileInfo().exists()) {
866 867 868 869 870 871 872 873
        m_virginSession = false;

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

        restoreValues(reader);
        emit aboutToLoadSession(session);

874 875 876 877
        QColor c = QColor(reader.restoreValue(QLatin1String("Color")).toString());
        if (c.isValid())
            Utils::StyleHelper::setBaseColor(c);

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
        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();
896
        Id modeId;
897
        if (modeIdentifier.isEmpty())
898 899 900
            modeId = Id(Core::Constants::MODE_EDIT);
        else
            modeId = Id(modeIdentifier);
901

902
        ModeManager::activateMode(modeId);
903 904
        ModeManager::setFocusToCurrentMode();
    } else {
905
        ModeManager::activateMode(Id(Core::Constants::MODE_EDIT));
906 907 908 909 910 911
        ModeManager::setFocusToCurrentMode();
    }
    emit sessionLoaded(session);

    // Starts a event loop, better do that at the very end
    askUserAboutFailedProjects();
912
    m_loadingSession = false;
913
    return true;
con's avatar
con committed
914 915 916 917
}

QString SessionManager::lastSession() const
{
918
    return ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
con's avatar
con committed
919 920 921 922 923 924 925 926 927
}

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

void SessionManager::reportProjectLoadingProgress()
{
928
    sessionLoadingProgress();
con's avatar
con committed
929 930
}

931
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
932
{
933
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
934
        m_virginSession = false;
935
}
con's avatar
con committed
936

937 938
void SessionManager::sessionLoadingProgress()
{
939
    m_future.setProgressValue(m_future.progressValue() + 1);
940 941
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}
942

943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
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);
    }
}

964 965
QStringList ProjectExplorer::SessionManager::projectsForSessionName(const QString &session) const
{
966
    const Utils::FileName fileName = sessionNameToFileName(session);
967
    PersistentSettingsReader reader;
968
    if (fileName.toFileInfo().exists()) {
969
        if (!reader.load(fileName)) {
970
            qWarning() << "Could not restore session" << fileName.toUserOutput();
971 972 973 974 975
            return QStringList();
        }
    }
    return reader.restoreValue(QLatin1String("ProjectList")).toStringList();
}