session.cpp 29.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** 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
#include "project.h"
#include "projectexplorer.h"
#include "nodesvisitor.h"
#include "editorconfiguration.h"
36
#include "projectnodes.h"
con's avatar
con committed
37 38 39 40

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

#include <texteditor/itexteditor.h>

47
#include <utils/stylehelper.h>
hjk's avatar
hjk committed
48

49 50 51
#include <QDebug>
#include <QDir>
#include <QFileInfo>
hjk's avatar
hjk committed
52

53 54
#include <QMessageBox>
#include <QPushButton>
con's avatar
con committed
55 56 57 58 59

namespace {
    bool debug = false;
}

60
using namespace Core;
Jarek Kobus's avatar
Jarek Kobus committed
61 62
using Utils::PersistentSettingsReader;
using Utils::PersistentSettingsWriter;
63

con's avatar
con committed
64
using namespace ProjectExplorer;
65
using namespace ProjectExplorer::Internal;
con's avatar
con committed
66

67 68 69 70 71 72 73 74 75 76
/*!
     \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
77

hjk's avatar
hjk committed
78 79
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
80
    m_sessionNode(new SessionNode(this)),
81
    m_sessionName(QLatin1String("default")),
82
    m_virginSession(true),
83
    m_loadingSession(false),
Tobias Hunger's avatar
Tobias Hunger committed
84 85
    m_startupProject(0),
    m_writer(0)
con's avatar
con committed
86
{
87
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
88
            this, SLOT(saveActiveMode(Core::IMode*)));
89

hjk's avatar
hjk committed
90
    EditorManager *em = ICore::editorManager();
91

Robert Loehning's avatar
Robert Loehning committed
92 93 94
    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
95
            this, SLOT(updateWindowTitle()));
96 97 98 99
    connect(em, SIGNAL(editorOpened(Core::IEditor*)),
            this, SLOT(markSessionFileDirty()));
    connect(em, SIGNAL(editorsClosed(QList<Core::IEditor*>)),
            this, SLOT(markSessionFileDirty()));
hjk's avatar
hjk committed
100
}
con's avatar
con committed
101 102 103

SessionManager::~SessionManager()
{
104
    emit aboutToUnloadSession(m_sessionName);
Tobias Hunger's avatar
Tobias Hunger committed
105
    delete m_writer;
con's avatar
con committed
106 107 108 109 110
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
111 112
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
113 114 115 116
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
117
    return session == QLatin1String("default");
con's avatar
con committed
118 119 120 121 122
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
123
    setValue(QLatin1String("ActiveMode"), mode->id().toString());
con's avatar
con committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
}

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;

142
    foreach (const QString &dependency, m_depMap.value(checkDep)) {
con's avatar
con committed
143 144 145 146 147 148 149
        if (!recursiveDependencyCheck(newDep, dependency))
            return false;
    }

    return true;
}

150
/*
151
 * The dependency management exposes an interface based on projects, but
152 153 154 155 156 157 158
 * 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
{
159
    const QString &proName = project->document()->fileName();
160
    const QStringList &proDeps = m_depMap.value(proName);
161 162 163 164 165 166 167 168 169 170 171

    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
172
{
173 174
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
con's avatar
con committed
175

176
    const QStringList &proDeps = m_depMap.value(proName);
con's avatar
con committed
177 178 179
    return proDeps.contains(depName);
}

180
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
181
{
182 183
    const QString &newDep = project->document()->fileName();
    const QString &checkDep = depProject->document()->fileName();
con's avatar
con committed
184 185 186 187

    return recursiveDependencyCheck(newDep, checkDep);
}

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

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

197
    QStringList proDeps = m_depMap.value(proName);
con's avatar
con committed
198 199
    if (!proDeps.contains(depName)) {
        proDeps.append(depName);
200
        m_depMap[proName] = proDeps;
con's avatar
con committed
201
    }
dt's avatar
dt committed
202
    emit dependencyChanged(project, depProject);
con's avatar
con committed
203 204 205 206

    return true;
}

dt's avatar
dt committed
207
void SessionManager::removeDependency(Project *project, Project *depProject)
208
{
209 210
    const QString &proName = project->document()->fileName();
    const QString &depName = depProject->document()->fileName();
211

212
    QStringList proDeps = m_depMap.value(proName);
213
    proDeps.removeAll(depName);
214
    if (proDeps.isEmpty())
215
        m_depMap.remove(proName);
216
    else
217
        m_depMap[proName] = proDeps;
dt's avatar
dt committed
218
    emit dependencyChanged(project, depProject);
219 220
}

con's avatar
con committed
221 222 223
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
224
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
225 226

    if (startupProject) {
227
        Q_ASSERT(m_projects.contains(startupProject));
con's avatar
con committed
228 229
    }

230
    if (m_startupProject == startupProject)
231 232
        return;

233
    m_startupProject = startupProject;
con's avatar
con committed
234 235 236 237 238
    emit startupProjectChanged(startupProject);
}

Project *SessionManager::startupProject() const
{
239
    return m_startupProject;
con's avatar
con committed
240 241 242 243 244 245 246 247 248
}

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

void SessionManager::addProjects(const QList<Project*> &projects)
{
dt's avatar
dt committed
249
    m_virginSession = false;
con's avatar
con committed
250 251
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
252
        if (!m_projects.contains(pro)) {
con's avatar
con committed
253
            clearedList.append(pro);
254
            m_projects.append(pro);
255
            m_sessionNode->addProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
con's avatar
con committed
256 257 258 259

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

260 261 262
            connect(pro, SIGNAL(displayNameChanged()),
                    this, SLOT(projectDisplayNameChanged()));

con's avatar
con committed
263
            if (debug)
264
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
265 266 267 268 269 270 271 272 273 274 275 276 277
        }
    }

    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
278
    m_virginSession = false;
con's avatar
con committed
279 280 281 282 283 284 285
    if (project == 0) {
        qDebug() << "SessionManager::removeProject(0) ... THIS SHOULD NOT HAPPEN";
        return;
    }
    removeProjects(QList<Project*>() << project);
}

286 287 288 289 290
bool SessionManager::loadingSession()
{
    return m_loadingSession;
}

con's avatar
con committed
291 292 293 294 295 296 297
bool SessionManager::save()
{
    if (debug)
        qDebug() << "SessionManager - saving session" << m_sessionName;

    emit aboutToSaveSession();

Tobias Hunger's avatar
Tobias Hunger committed
298 299 300 301 302
    if (!m_writer || m_writer->fileName() != sessionNameToFileName(m_sessionName)) {
        delete m_writer;
        m_writer = new Utils::PersistentSettingsWriter(sessionNameToFileName(m_sessionName),
                                                       QLatin1String("QtCreatorSession"));
    }
303

304
    QVariantMap data;
305
    // save the startup project
Tobias Hunger's avatar
Tobias Hunger committed
306
    if (m_startupProject)
307
        data.insert(QLatin1String("StartupProject"), m_startupProject->document()->fileName());
308

309 310 311 312 313 314
    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'));
315
        data.insert(QLatin1String("Color"), tmp);
316 317
    }

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

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

328
    data.insert(QLatin1String("ProjectList"), projectFiles);
329 330

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

343 344 345 346 347 348 349
    int editorCount = 0;
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
350 351
    data.insert(QLatin1String("OpenEditors"), editorCount);
    data.insert(QLatin1String("EditorSettings"), ICore::editorManager()->saveState().toBase64());
352 353

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

361
    data.insert(QLatin1String("valueKeys"), keys);
362

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

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

    return result;
}

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

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

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

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

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

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

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

    return project;
}

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

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

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

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

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

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

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

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


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

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

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

585 586 587 588 589
    // TODO: Clear m_modelProjectHash

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
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();
720 721 722 723 724 725 726
        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);
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
        }
        ++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) {
759
            if (QDir::cleanPath(pro->document()->fileName()) == startupProject) {
760
                setStartupProject(pro);
761 762 763
                break;
            }
        }
764 765 766 767 768
    }
    if (!m_startupProject) {
        qWarning() << "Could not find startup project" << startupProject;
        if (!projects().isEmpty())
            setStartupProject(projects().first());
769 770 771 772 773 774 775
    }
}

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

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

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

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

825 826
    m_loadingSession = true;

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

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

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

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

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

850 851 852
    m_sessionName = session;
    updateWindowTitle();

853
    if (fileName.toFileInfo().exists()) {
854 855 856 857 858 859 860 861
        m_virginSession = false;

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

        restoreValues(reader);
        emit aboutToLoadSession(session);

862 863 864 865
        QColor c = QColor(reader.restoreValue(QLatin1String("Color")).toString());
        if (c.isValid())
            Utils::StyleHelper::setBaseColor(c);

866 867 868 869 870 871 872
        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);

873 874 875 876
        // if one processEvents doesn't get the job done
        // just use two!
        QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
        QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
877 878 879 880 881 882 883 884 885 886
        restoreProjects(fileList);
        sessionLoadingProgress();
        restoreDependencies(reader);
        restoreStartupProject(reader);
        restoreEditors(reader);

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

        // restore the active mode
887 888
        Id modeId = Id::fromSetting(value(QLatin1String("ActiveMode")));
        if (!modeId.isValid())
889
            modeId = Id(Core::Constants::MODE_EDIT);
890

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

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

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

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

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

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

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

932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
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);
    }
}

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