session.cpp 27.5 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
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
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
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32 33 34

#include "session.h"

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

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

#include <texteditor/itexteditor.h>

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

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

63 64 65 66 67
#include <QApplication>
#include <QMainWindow>
#include <QMessageBox>
#include <QPushButton>
#include <QTextCodec>
con's avatar
con committed
68 69 70 71 72

namespace {
    bool debug = false;
}

73
using namespace Core;
Jarek Kobus's avatar
Jarek Kobus committed
74 75
using Utils::PersistentSettingsReader;
using Utils::PersistentSettingsWriter;
76

con's avatar
con committed
77
using namespace ProjectExplorer;
78
using namespace ProjectExplorer::Internal;
con's avatar
con committed
79

80 81 82 83 84 85 86 87 88 89
/*!
     \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
90

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

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

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

SessionManager::~SessionManager()
{
115
    emit aboutToUnloadSession(m_sessionName);
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());
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 162 163 164 165 166 167 168
/*
 * TODO: The dependency management exposes an interface based on projects, but
 * 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 271

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

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

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

bool SessionManager::save()
{
    if (debug)
        qDebug() << "SessionManager - saving session" << m_sessionName;

    emit aboutToSaveSession();

301 302 303
    PersistentSettingsWriter writer;

    // save the startup project
304
    if (m_startupProject) {
305
        writer.saveValue(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
306 307 308
    }

    QStringList projectFiles;
309
    foreach (Project *pro, m_projects)
310
        projectFiles << pro->document()->fileName();
311 312

    // Restore infromation on projects that failed to load:
313
    projectFiles.append(m_failedProjects);
314 315 316 317

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

    QMap<QString, QVariant> depMap;
318 319
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
320 321 322 323 324 325 326 327 328
        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
329

330 331 332 333 334 335 336 337 338 339 340 341
    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;
342
    end = m_values.constEnd();
343
    QStringList keys;
344
    for (it = m_values.constBegin(); it != end; ++it) {
345 346 347 348 349 350 351 352
        writer.saveValue(QLatin1String("value-") + it.key(), it.value());
        keys << it.key();
    }

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

    QString fileName = sessionNameToFileName(m_sessionName);
    bool result = writer.save(fileName, QLatin1String("QtCreatorSession"), Core::ICore::mainWindow());
con's avatar
con committed
353 354
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Daniel Teske's avatar
Daniel Teske committed
355
                                tr("Could not save session to file %1").arg(fileName));
con's avatar
con committed
356 357 358 359 360 361 362 363 364
    }

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

    return result;
}

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

367
  Closes all projects
con's avatar
con committed
368
  */
369
void SessionManager::closeAllProjects()
con's avatar
con committed
370
{
371 372
    setStartupProject(0);
    removeProjects(projects());
con's avatar
con committed
373 374
}

375
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
376
{
377
    return m_projects;
con's avatar
con committed
378 379 380 381 382
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
383
    foreach (const QString &dep, m_depMap.value(proName))
con's avatar
con committed
384 385 386 387 388 389 390 391 392 393 394 395 396
        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()) {
397
        const QString &proName = pro->document()->fileName();
con's avatar
con committed
398
        unordered << QPair<QString, QStringList>
399
            (proName, m_depMap.value(proName));
con's avatar
con committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    }

    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) {
430
        pros = dependencies(project->document()->fileName());
con's avatar
con committed
431 432 433 434 435 436
    } else {
        pros = dependenciesOrder();
    }

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
437
            if (pro->document()->fileName() == proFile) {
con's avatar
con committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
                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
460
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
461 462 463 464 465 466 467 468 469 470 471 472

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

    return project;
}

dt's avatar
dt committed
473
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
474 475
{
    Node *node = 0;
dt's avatar
dt committed
476 477 478
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
        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 << ")";

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

499
    // Check current project first
500
    Project *currentProject = ProjectExplorerPlugin::currentProject();
501 502
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
503

504 505 506 507 508 509 510 511 512 513 514 515
    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
516 517
}

518
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
519
{
520 521 522
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
523 524
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
525
    }
con's avatar
con committed
526 527 528 529
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
530
    if (isDefaultSession(m_sessionName)) {
531
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
532
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
533
        else
hjk's avatar
hjk committed
534
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
535
    } else {
con's avatar
con committed
536 537 538
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
539
        ICore::editorManager()->setWindowTitleAddition(sessionName);
540
    }
con's avatar
con committed
541 542 543 544 545 546 547 548
}

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

    foreach (Project *pro, remove) {
        if (debug)
549
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
550 551 552 553 554 555 556 557
        emit aboutToRemoveProject(pro);
    }


    // Refresh dependencies
    QSet<QString> projectFiles;
    foreach (Project *pro, projects()) {
        if (!remove.contains(pro))
558
            projectFiles.insert(pro->document()->fileName());
con's avatar
con committed
559 560 561 562 563
    }

    QSet<QString>::const_iterator i = projectFiles.begin();
    while (i != projectFiles.end()) {
        QStringList dependencies;
564
        foreach (const QString &dependency, m_depMap.value(*i)) {
con's avatar
con committed
565 566 567 568 569 570 571 572
            if (projectFiles.contains(dependency))
                dependencies << dependency;
        }
        if (!dependencies.isEmpty())
            resMap.insert(*i, dependencies);
        ++i;
    }

573
    m_depMap = resMap;
con's avatar
con committed
574

575 576 577 578 579
    // TODO: Clear m_modelProjectHash

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

582
        if (pro == m_startupProject)
583 584 585 586 587 588 589 590
            setStartupProject(0);

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

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
591
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
592 593 594 595
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
596
    if (startupProject() == 0)
597 598
        if (!m_projects.isEmpty())
            setStartupProject(m_projects.first());
con's avatar
con committed
599 600
}

601 602 603 604
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
605 606
void SessionManager::setValue(const QString &name, const QVariant &value)
{
607
    if (m_values.value(name) == value)
608
        return;
609
    m_values.insert(name, value);
610
    markSessionFileDirty(false);
con's avatar
con committed
611 612 613 614
}

QVariant SessionManager::value(const QString &name)
{
615 616
    QMap<QString, QVariant>::const_iterator it = m_values.find(name);
    return (it == m_values.constEnd()) ? QVariant() : *it;
con's avatar
con committed
617 618 619 620 621 622 623 624 625
}

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

QStringList SessionManager::sessions() const
{
626
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
627
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
628
        QDir sessionDir(Core::ICore::userResourcePath());
629 630
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
631
            if (fileInfo.completeBaseName() != QLatin1String("default"))
632 633
                m_sessions << fileInfo.completeBaseName();
        }
634
        m_sessions.prepend(QLatin1String("default"));
635 636
    }
    return m_sessions;
con's avatar
con committed
637 638
}

639
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
640
{
hjk's avatar
hjk committed
641
    return ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws");
con's avatar
con committed
642 643
}

644 645 646 647
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
648 649 650 651
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
652 653
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
654 655 656
    return true;
}

657 658 659 660 661 662 663 664 665
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

666 667 668
/*!
     \brief Deletes session name from session list and file from disk.
*/
con's avatar
con committed
669 670
bool SessionManager::deleteSession(const QString &session)
{
671
    if (!m_sessions.contains(session))
con's avatar
con committed
672
        return false;
673
    m_sessions.removeOne(session);
con's avatar
con committed
674 675 676 677 678 679 680 681
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
682
    if (!m_sessions.contains(original))
con's avatar
con committed
683 684 685 686 687
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
688 689
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
690 691 692 693 694
        return true;
    }
    return false;
}

695 696 697 698 699 700 701 702 703 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
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()) {
        const QString startupProjectPath = startupProject;
        foreach (Project *pro, m_projects) {
750
            if (QDir::cleanPath(pro->document()->fileName()) == startupProjectPath) {
751
                setStartupProject(pro);
752 753 754 755 756 757 758 759 760 761 762 763
                break;
            }
        }
        if (!m_startupProject)
            qWarning() << "Could not find startup project" << startupProjectPath;
    }
}

void SessionManager::restoreEditors(const Utils::PersistentSettingsReader &reader)
{
    const QVariant &editorsettings = reader.restoreValue(QLatin1String("EditorSettings"));
    if (editorsettings.isValid()) {
Robert Loehning's avatar
Robert Loehning committed
764
        connect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
765 766 767
                this, SLOT(sessionLoadingProgress()));
        ICore::editorManager()->restoreState(
            QByteArray::fromBase64(editorsettings.toByteArray()));
Robert Loehning's avatar
Robert Loehning committed
768
        disconnect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
769 770 771 772
                   this, SLOT(sessionLoadingProgress()));
    }
}

773 774 775
/*!
     \brief Loads a session, takes a session name (not filename).
*/
776 777 778 779 780 781 782 783 784 785 786
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)
787
            m_failedProjects.removeAll(p->document()->fileName());
788 789
    }
}
790

con's avatar
con committed
791 792 793 794 795 796 797 798 799 800
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;
801

802
    // Try loading the file
con's avatar
con committed
803
    QString fileName = sessionNameToFileName(session);
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
    PersistentSettingsReader reader;
    if (QFileInfo(fileName).exists()) {
        if (!reader.load(fileName)) {
            QMessageBox::warning(0, tr("Error while restoring session"),
                                 tr("Could not restore session %1").arg(fileName));
            return false;
        }
    }

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

    if (!isDefaultVirgin()) {
        if (!save())
            return false;
    }

    // Clean up
    if (!ICore::editorManager()->closeAllEditors())
        return false;

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

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

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
    m_sessionName = session;
    updateWindowTitle();

    if (QFileInfo(fileName).exists()) {
        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();
        if (modeIdentifier.isEmpty())
            modeIdentifier = QLatin1String(Core::Constants::MODE_EDIT);

        ModeManager::activateMode(modeIdentifier);
        ModeManager::setFocusToCurrentMode();
    } else {
        ModeManager::activateMode(QLatin1String(Core::Constants::MODE_EDIT));
        ModeManager::setFocusToCurrentMode();
    }
    emit sessionLoaded(session);

    // Starts a event loop, better do that at the very end
    askUserAboutFailedProjects();
    return true;
con's avatar
con committed
876 877 878 879
}

QString SessionManager::lastSession() const
{
hjk's avatar
hjk committed
880
    QString fileName = ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
881
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
882 883 884 885 886 887 888 889 890
}

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

void SessionManager::reportProjectLoadingProgress()
{
891
    sessionLoadingProgress();
con's avatar
con committed
892 893
}

894
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
895
{
896
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
897
        m_virginSession = false;
898
}
con's avatar
con committed
899

900 901
void SessionManager::sessionLoadingProgress()
{
902
    m_future.setProgressValue(m_future.progressValue() + 1);
903 904
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}
905 906 907 908 909 910 911 912 913 914 915 916 917

QStringList ProjectExplorer::SessionManager::projectsForSessionName(const QString &session) const
{
    const QString fileName = sessionNameToFileName(session);
    PersistentSettingsReader reader;
    if (QFileInfo(fileName).exists()) {
        if (!reader.load(fileName)) {
            qWarning() << "Could not restore session" << fileName;
            return QStringList();
        }
    }
    return reader.restoreValue(QLatin1String("ProjectList")).toStringList();
}