session.cpp 28.7 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),
94
    m_startupProject(0)
con's avatar
con committed
95
{
96
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
97
            this, SLOT(saveActiveMode(Core::IMode*)));
98

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

Robert Loehning's avatar
Robert Loehning committed
101 102 103
    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
104
            this, SLOT(updateWindowTitle()));
105 106 107 108
    connect(em, SIGNAL(editorOpened(Core::IEditor*)),
            this, SLOT(markSessionFileDirty()));
    connect(em, SIGNAL(editorsClosed(QList<Core::IEditor*>)),
            this, SLOT(markSessionFileDirty()));
hjk's avatar
hjk committed
109
}
con's avatar
con committed
110 111 112

SessionManager::~SessionManager()
{
113
    emit aboutToUnloadSession(m_sessionName);
con's avatar
con committed
114 115 116 117 118
}


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

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


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

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;

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

    return true;
}

158
/*
159
 * The dependency management exposes an interface based on projects, but
160 161 162 163 164 165 166
 * 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
{
167
    const QString &proName = project->document()->fileName();
168
    const QStringList &proDeps = m_depMap.value(proName);
169 170 171 172 173 174 175 176 177 178 179

    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
180
{
181 182
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
183

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

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

    return recursiveDependencyCheck(newDep, checkDep);
}

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

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

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

    return true;
}

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

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

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

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

239
    if (m_startupProject == startupProject)
240 241
        return;

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

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

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

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

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

269 270 271
            connect(pro, SIGNAL(displayNameChanged()),
                    this, SLOT(projectDisplayNameChanged()));

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

    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
287
    m_virginSession = false;
con's avatar
con committed
288 289 290 291 292 293 294
    if (project == 0) {
        qDebug() << "SessionManager::removeProject(0) ... THIS SHOULD NOT HAPPEN";
        return;
    }
    removeProjects(QList<Project*>() << project);
}

295 296 297 298 299
bool SessionManager::loadingSession()
{
    return m_loadingSession;
}

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

    emit aboutToSaveSession();

307 308 309
    PersistentSettingsWriter writer;

    // save the startup project
310
    if (m_startupProject) {
311
        writer.saveValue(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
312 313 314
    }

    QStringList projectFiles;
315
    foreach (Project *pro, m_projects)
316
        projectFiles << pro->document()->fileName();
317 318

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

    writer.saveValue(QLatin1String("ProjectList"), projectFiles);

    QMap<QString, QVariant> depMap;
327 328
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
329 330 331 332 333 334 335 336 337
        QString key = i.key();
        QStringList values;
        foreach (const QString &value, i.value()) {
            values << value;
        }
        depMap.insert(key, values);
        ++i;
    }
    writer.saveValue(QLatin1String("ProjectDependencies"), QVariant(depMap));
con's avatar
con committed
338

339 340 341 342 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;
    }
    writer.saveValue(QLatin1String("OpenEditors"), editorCount);
    writer.saveValue(QLatin1String("EditorSettings"),
                     ICore::editorManager()->saveState().toBase64());

    QMap<QString, QVariant>::const_iterator it, end;
351
    end = m_values.constEnd();
352
    QStringList keys;
353
    for (it = m_values.constBegin(); it != end; ++it) {
354 355 356 357 358 359
        writer.saveValue(QLatin1String("value-") + it.key(), it.value());
        keys << it.key();
    }

    writer.saveValue(QLatin1String("valueKeys"), keys);

360
    Utils::FileName fileName = sessionNameToFileName(m_sessionName);
361
    bool result = writer.save(fileName, QLatin1String("QtCreatorSession"), Core::ICore::mainWindow());
con's avatar
con committed
362 363
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
364
                                tr("Could not save session to file %1").arg(fileName.toUserOutput()));
con's avatar
con committed
365 366 367 368 369 370 371 372 373
    }

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

    return result;
}

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

376
  Closes all projects
con's avatar
con committed
377
  */
378
void SessionManager::closeAllProjects()
con's avatar
con committed
379
{
380 381
    setStartupProject(0);
    removeProjects(projects());
con's avatar
con committed
382 383
}

384
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
385
{
386
    return m_projects;
con's avatar
con committed
387 388 389 390 391
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
392
    foreach (const QString &dep, m_depMap.value(proName))
con's avatar
con committed
393 394 395 396 397 398 399 400 401 402 403 404 405
        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()) {
406
        const QString &proName = pro->document()->fileName();
con's avatar
con committed
407
        unordered << QPair<QString, QStringList>
408
            (proName, m_depMap.value(proName));
con's avatar
con committed
409 410 411 412 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
    }

    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) {
439
        pros = dependencies(project->document()->fileName());
con's avatar
con committed
440 441 442 443 444 445
    } else {
        pros = dependenciesOrder();
    }

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
446
            if (pro->document()->fileName() == proFile) {
con's avatar
con committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
                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
469
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
470 471 472 473 474 475 476 477 478 479 480 481

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

    return project;
}

dt's avatar
dt committed
482
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
483 484
{
    Node *node = 0;
dt's avatar
dt committed
485 486 487
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
        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 << ")";

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

508
    // Check current project first
509
    Project *currentProject = ProjectExplorerPlugin::currentProject();
510 511
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
512

513 514 515 516 517 518 519 520 521 522 523 524
    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
525 526
}

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

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

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

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


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

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

582
    m_depMap = resMap;
con's avatar
con committed
583

584 585 586 587 588
    // TODO: Clear m_modelProjectHash

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

591
        if (pro == m_startupProject)
592 593 594 595 596 597 598 599
            setStartupProject(0);

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

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
600
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
601 602 603 604
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
605
    if (startupProject() == 0)
606 607
        if (!m_projects.isEmpty())
            setStartupProject(m_projects.first());
con's avatar
con committed
608 609
}

610 611 612 613
/*!
    \brief Let other plugins store persistent values within the session file.
*/

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

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

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

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

648
Utils::FileName SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
649
{
650
    return Utils::FileName::fromString(ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws"));
con's avatar
con committed
651 652
}

653 654 655 656
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

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

666 667 668 669 670 671 672 673 674
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

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

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

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

704 705 706 707 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
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) {
758
            if (QDir::cleanPath(pro->document()->fileName()) == startupProject) {
759
                setStartupProject(pro);
760 761 762
                break;
            }
        }
763 764 765 766 767
    }
    if (!m_startupProject) {
        qWarning() << "Could not find startup project" << startupProject;
        if (!projects().isEmpty())
            setStartupProject(projects().first());
768 769 770 771 772 773 774
    }
}

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

784 785 786
/*!
     \brief Loads a session, takes a session name (not filename).
*/
787 788 789 790 791 792 793 794 795 796 797
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)
798
            m_failedProjects.removeAll(p->document()->fileName());
799 800
    }
}
801

con's avatar
con committed
802 803 804 805 806 807 808 809 810 811
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;
812

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

824 825
    m_loadingSession = true;

826 827 828 829
    // Allow everyone to set something in the session and before saving
    emit aboutToUnloadSession(m_sessionName);

    if (!isDefaultVirgin()) {
830 831
        if (!save()) {
            m_loadingSession = false;
832
            return false;
833
        }
834 835 836
    }

    // Clean up
837 838
    if (!ICore::editorManager()->closeAllEditors()) {
        m_loadingSession = false;
839
        return false;
840
    }
841 842 843 844 845 846 847

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

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

849 850 851
    m_sessionName = session;
    updateWindowTitle();

852
    if (fileName.toFileInfo().exists()) {
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
        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();
879
        Id modeId;
880
        if (modeIdentifier.isEmpty())
881 882 883
            modeId = Id(Core::Constants::MODE_EDIT);
        else
            modeId = Id(modeIdentifier);
884

885
        ModeManager::activateMode(modeId);
886 887
        ModeManager::setFocusToCurrentMode();
    } else {
888
        ModeManager::activateMode(Id(Core::Constants::MODE_EDIT));
889 890 891 892 893 894
        ModeManager::setFocusToCurrentMode();
    }
    emit sessionLoaded(session);

    // Starts a event loop, better do that at the very end
    askUserAboutFailedProjects();
895
    m_loadingSession = false;
896
    return true;
con's avatar
con committed
897 898 899 900
}

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

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

void SessionManager::reportProjectLoadingProgress()
{
912
    sessionLoadingProgress();
con's avatar
con committed
913 914
}

915
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
916
{
917
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
918
        m_virginSession = false;
919
}
con's avatar
con committed
920

921 922
void SessionManager::sessionLoadingProgress()
{
923
    m_future.setProgressValue(m_future.progressValue() + 1);
924 925
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}
926

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
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);
    }
}

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