session.cpp 31.8 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 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

#include "session.h"
34
#include "sessionnodeimpl.h"
hjk's avatar
hjk committed
35

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

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
#include <coreplugin/filemanager.h>
#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
#include <utils/listutils.h>
#include <utils/qtcassert.h>
Jarek Kobus's avatar
Jarek Kobus committed
55
#include <utils/persistentsettings.h>
hjk's avatar
hjk committed
56

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

64
#include <QtGui/QApplication>
con's avatar
con committed
65
#include <QtGui/QMainWindow>
hjk's avatar
hjk committed
66
#include <QtGui/QMessageBox>
67
#include <QtGui/QPushButton>
68
#include <QtCore/QTextCodec>
con's avatar
con committed
69 70 71 72 73

namespace {
    bool debug = false;
}

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

con's avatar
con committed
78 79 80 81
/* SessionFile definitions */
namespace ProjectExplorer {
namespace Internal {

dt's avatar
dt committed
82
class SessionFile : QObject
con's avatar
con committed
83 84 85 86
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
87
    SessionFile();
con's avatar
con committed
88 89

    bool load(const QString &fileName);
dt's avatar
dt committed
90
    bool save();
con's avatar
con committed
91 92 93 94

    QString fileName() const;
    void setFileName(const QString &fileName);

95
    QStringList failedProjectFileNames() const;
96
    void clearFailedProjectFileNames();
97

con's avatar
con committed
98 99 100 101 102 103 104 105 106
public slots:
    void sessionLoadingProgress();

private:
    Core::ICore *m_core;

    QString m_fileName;
    QList<Project *> m_projects;
    Project *m_startupProject;
107
    QStringList m_failedProjects;
con's avatar
con committed
108 109 110 111 112 113 114 115 116 117 118 119
    QMap<QString, QStringList> m_depMap;

    QMap<QString, QVariant> m_values;

    QFutureInterface<void> future;
    friend class ProjectExplorer::SessionManager;
};

} // namespace Internal
} // namespace ProjectExplorer

using namespace ProjectExplorer;
120
using namespace ProjectExplorer::Internal;
con's avatar
con committed
121 122 123 124 125 126 127

void SessionFile::sessionLoadingProgress()
{
    future.setProgressValue(future.progressValue() + 1);
    QCoreApplication::processEvents(QEventLoop::ExcludeUserInputEvents);
}

hjk's avatar
hjk committed
128
SessionFile::SessionFile()
dt's avatar
dt committed
129
  : m_core(Core::ICore::instance()),
con's avatar
con committed
130 131 132 133 134 135
    m_startupProject(0)
{
}

bool SessionFile::load(const QString &fileName)
{
dt's avatar
dt committed
136
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

    if (debug)
        qDebug() << "SessionFile::load " << fileName;

    m_fileName = fileName;

    // NPE: Load the session in the background?
    // NPE: Let FileManager monitor filename

    PersistentSettingsReader reader;
    if (!reader.load(m_fileName)) {
        qWarning() << "SessionManager::load failed!" << fileName;
        return false;
    }

    m_core->progressManager()->addTask(future.future(), tr("Session"),
153
       QLatin1String("ProjectExplorer.SessionFile.Load"));
con's avatar
con committed
154 155 156

    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
157
        QVariant value = reader.restoreValue(QLatin1String("value-") + key);
con's avatar
con committed
158 159 160 161 162 163 164 165 166 167 168
        m_values.insert(key, value);
    }

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

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

    // indirectly adds projects to session
169 170 171
    // Keep projects that failed to load in the session!
    m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
172 173 174 175
        QString errors;
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList, &errors);
        if (!errors.isEmpty())
            QMessageBox::critical(Core::ICore::instance()->mainWindow(), tr("Failed to open project"), errors);
176 177 178
        foreach (Project *p, projects)
            m_failedProjects.removeAll(p->file()->fileName());
    }
con's avatar
con committed
179 180 181 182 183 184 185 186

    sessionLoadingProgress();

    // convert the relative paths in the dependency map to absolute paths
    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();
187 188
        if (m_failedProjects.contains(key))
            continue;
con's avatar
con committed
189 190
        QStringList values;
        foreach (const QString &value, i.value().toStringList()) {
191 192
            if (!m_failedProjects.contains(value))
                values << value;
con's avatar
con committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
        }
        m_depMap.insert(key, values);
        ++i;
    }

    // find and set the startup project
    const QString startupProject = reader.restoreValue(QLatin1String("StartupProject")).toString();
    if (!startupProject.isEmpty()) {
        const QString startupProjectPath = startupProject;
        foreach (Project *pro, m_projects) {
            if (QDir::cleanPath(pro->file()->fileName()) == startupProjectPath) {
                m_startupProject = pro;
                break;
            }
        }
        if (!m_startupProject)
            qWarning() << "Could not find startup project" << startupProjectPath;
    }

    const QVariant &editorsettings = reader.restoreValue(QLatin1String("EditorSettings"));
    if (editorsettings.isValid()) {
        connect(m_core->editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
                this, SLOT(sessionLoadingProgress()));
        m_core->editorManager()->restoreState(
            QByteArray::fromBase64(editorsettings.toByteArray()));
        disconnect(m_core->editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
                   this, SLOT(sessionLoadingProgress()));
    }

    if (debug)
        qDebug() << "SessionFile::load finished" << fileName;


    future.reportFinished();
    return true;
}

dt's avatar
dt committed
230
bool SessionFile::save()
con's avatar
con committed
231
{
dt's avatar
dt committed
232
    Q_ASSERT(!m_fileName.isEmpty());
con's avatar
con committed
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247

    if (debug)
        qDebug() << "SessionFile - saving " << m_fileName;

    PersistentSettingsWriter writer;

    // save the startup project
    if (m_startupProject) {
        writer.saveValue(QLatin1String("StartupProject"), m_startupProject->file()->fileName());
    }

    QStringList projectFiles;
    foreach (Project *pro, m_projects) {
        projectFiles << pro->file()->fileName();
    }
248 249
    // Restore infromation on projects that failed to load:
    projectFiles.append(m_failedProjects);
con's avatar
con committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

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

    QMap<QString, QVariant> depMap;
    QMap<QString, QStringList>::const_iterator i = m_depMap.constBegin();
    while (i != m_depMap.constEnd()) {
        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));

266

267 268 269 270 271 272 273 274
    int editorCount = 0;
    QList<Core::IEditor *> editors = m_core->editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
    writer.saveValue(QLatin1String("OpenEditors"), editorCount);
con's avatar
con committed
275 276 277 278 279 280 281
    writer.saveValue(QLatin1String("EditorSettings"),
                     m_core->editorManager()->saveState().toBase64());

    QMap<QString, QVariant>::const_iterator it, end;
    end = m_values.constEnd();
    QStringList keys;
    for (it = m_values.constBegin(); it != end; ++it) {
282
        writer.saveValue(QLatin1String("value-") + it.key(), it.value());
con's avatar
con committed
283 284 285
        keys << it.key();
    }

286
    writer.saveValue(QLatin1String("valueKeys"), keys);
con's avatar
con committed
287 288


289
    if (writer.save(m_fileName, QLatin1String("QtCreatorSession"), Core::ICore::instance()->mainWindow()))
con's avatar
con committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
        return true;

    return false;
}

QString SessionFile::fileName() const
{
    return m_fileName;
}

void SessionFile::setFileName(const QString &fileName)
{
    m_fileName = fileName;
}

305 306 307 308 309
QStringList SessionFile::failedProjectFileNames() const
{
    return m_failedProjects;
}

310 311 312 313 314
void SessionFile::clearFailedProjectFileNames()
{
    m_failedProjects.clear();
}

315 316 317 318 319 320 321 322 323 324
/*!
     \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
325

hjk's avatar
hjk committed
326 327 328 329
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_core(Core::ICore::instance()),
    m_file(new SessionFile),
330
    m_sessionNode(new Internal::SessionNodeImpl(this)),
dt's avatar
dt committed
331
    m_virginSession(true)
con's avatar
con committed
332
{
333
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
334
            this, SLOT(saveActiveMode(Core::IMode*)));
335 336 337 338

    Core::EditorManager *em = m_core->editorManager();

    connect(em, SIGNAL(editorCreated(Core::IEditor *, QString)),
339
            this, SLOT(configureEditor(Core::IEditor *, QString)));
con's avatar
con committed
340 341
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project *)),
            this, SLOT(updateWindowTitle()));
342 343 344 345 346 347 348 349 350 351 352
    connect(em, SIGNAL(editorOpened(Core::IEditor*)),
            this, SLOT(markSessionFileDirty()));
    connect(em, SIGNAL(editorsClosed(QList<Core::IEditor*>)),
            this, SLOT(markSessionFileDirty()));


    m_autoSaveSessionTimer = new QTimer(this);
    m_autoSaveSessionTimer->setSingleShot(true);
    m_autoSaveSessionTimer->setInterval(10000);
    connect(m_autoSaveSessionTimer, SIGNAL(timeout()),
            m_core, SIGNAL(saveSettingsRequested()));
hjk's avatar
hjk committed
353
}
con's avatar
con committed
354 355 356

SessionManager::~SessionManager()
{
357
    emit aboutToUnloadSession();
con's avatar
con committed
358 359 360 361 362 363
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
364 365
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
366 367 368 369
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
370
    return session == QLatin1String("default");
con's avatar
con committed
371 372 373 374 375
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
376
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
}

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;

    foreach (const QString &dependency, m_file->m_depMap.value(checkDep)) {
        if (!recursiveDependencyCheck(newDep, dependency))
            return false;
    }

    return true;
}

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
/*
 * 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
{
    const QString &proName = project->file()->fileName();
    const QStringList &proDeps = m_file->m_depMap.value(proName);

    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
425 426 427 428 429 430 431 432
{
    const QString &proName = project->file()->fileName();
    const QString &depName = depProject->file()->fileName();

    const QStringList &proDeps = m_file->m_depMap.value(proName);
    return proDeps.contains(depName);
}

433
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
434 435 436 437 438 439 440
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
441
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
442 443 444 445 446 447 448 449 450 451 452 453 454
{
    const QString &proName = project->file()->fileName();
    const QString &depName = depProject->file()->fileName();

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

    QStringList proDeps = m_file->m_depMap.value(proName);
    if (!proDeps.contains(depName)) {
        proDeps.append(depName);
        m_file->m_depMap[proName] = proDeps;
    }
dt's avatar
dt committed
455
    emit dependencyChanged(project, depProject);
con's avatar
con committed
456 457 458 459

    return true;
}

dt's avatar
dt committed
460
void SessionManager::removeDependency(Project *project, Project *depProject)
461 462 463 464 465 466 467 468 469 470 471
{
    const QString &proName = project->file()->fileName();
    const QString &depName = depProject->file()->fileName();

    QStringList proDeps = m_file->m_depMap.value(proName);
    proDeps.removeAll(depName);
    if (proDeps.isEmpty()) {
        m_file->m_depMap.remove(proName);
    } else {
        m_file->m_depMap[proName] = proDeps;
    }
dt's avatar
dt committed
472
    emit dependencyChanged(project, depProject);
473 474
}

con's avatar
con committed
475 476 477
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
478
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
479 480

    if (startupProject) {
dt's avatar
dt committed
481
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
482 483
    }

484 485 486
    if (m_file->m_startupProject == startupProject)
        return;

con's avatar
con committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
    m_file->m_startupProject = startupProject;
    emit startupProjectChanged(startupProject);
}

Project *SessionManager::startupProject() const
{
    return m_file->m_startupProject;
}

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

void SessionManager::addProjects(const QList<Project*> &projects)
{
dt's avatar
dt committed
503
    m_virginSession = false;
con's avatar
con committed
504 505 506 507 508 509 510 511 512 513 514
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
        if (!m_file->m_projects.contains(pro)) {
            clearedList.append(pro);
            m_file->m_projects.append(pro);
            m_sessionNode->addProjectNode(pro->rootProjectNode());

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

            if (debug)
515
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
516 517 518 519 520 521 522 523 524 525 526 527
        }
    }

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

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

    // maybe we have a new startup project?
    if (!startupProject())
528 529
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
530 531 532 533
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
534
    m_virginSession = false;
con's avatar
con committed
535 536 537 538 539 540 541 542 543
    if (project == 0) {
        qDebug() << "SessionManager::removeProject(0) ... THIS SHOULD NOT HAPPEN";
        return;
    }
    removeProjects(QList<Project*>() << project);
}

bool SessionManager::createImpl(const QString &fileName)
{
dt's avatar
dt committed
544
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
545 546 547 548 549 550 551

    if (debug)
        qDebug() << "SessionManager - creating new session " << fileName << " ...";

    bool success = true;

    if (!m_file->fileName().isEmpty()) {
hjk's avatar
hjk committed
552
        if (!save() || !clear())
con's avatar
con committed
553 554 555 556
            success = false;
    }

    if (success) {
557
        emit aboutToUnloadSession();
con's avatar
con committed
558
        delete m_file;
hjk's avatar
hjk committed
559
        m_file = new SessionFile;
560 561 562
        const QString &sessionName = sessionNameFromFileName(fileName);
        emit aboutToLoadSession(sessionName);
        updateName(sessionName);
con's avatar
con committed
563
        m_file->setFileName(fileName);
564
        setStartupProject(0);
565

566
        if (!isDefaultVirgin()) {
567
            ModeManager::instance()->activateMode(QLatin1String(Core::Constants::MODE_EDIT));
568
            ModeManager::instance()->setFocusToCurrentMode();
569
        }
570 571

        emit sessionLoaded();
con's avatar
con committed
572 573
    }

dt's avatar
dt committed
574
    m_virginSession = true;
575

con's avatar
con committed
576 577 578 579 580 581 582 583
    if (debug)
        qDebug() << "SessionManager - creating new session returns " << success;

    return success;
}

bool SessionManager::loadImpl(const QString &fileName)
{
dt's avatar
dt committed
584
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
585 586

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
587
        qDebug() << "SessionManager - restoring session " << fileName << " ...";
con's avatar
con committed
588 589 590 591 592 593 594 595 596 597 598

    bool success = true;

    if (!m_file->fileName().isEmpty()) {
        if (isDefaultVirgin()) {
            // do not save initial and virgin default session
        } else if (!save() || !clear()) {
            success = false;
        }
    }

dt's avatar
dt committed
599
    m_virginSession = false;
600

con's avatar
con committed
601
    if (success) {
602
        emit aboutToUnloadSession();
con's avatar
con committed
603
        delete m_file;
hjk's avatar
hjk committed
604
        m_file = new SessionFile;
605 606 607
        const QString &sessionName = sessionNameFromFileName(fileName);
        emit aboutToLoadSession(sessionName);
        updateName(sessionName);
con's avatar
con committed
608
        if (!m_file->load(fileName)) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
609 610
            QMessageBox::warning(0, tr("Error while restoring session"),
                                    tr("Could not restore session %1").arg(fileName));
con's avatar
con committed
611 612
            success = false;
        }
613 614 615
        // m_file->load() sets the m_file->startupProject
        // but doesn't emit this signal, so we do it here
        emit startupProjectChanged(m_file->m_startupProject);
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634

        QStringList failedProjects = m_file->failedProjectFileNames();
        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_file->clearFailedProjectFileNames();
        }
con's avatar
con committed
635 636 637 638
    }

    if (success) {
        // restore the active mode
639 640
        QString modeIdentifier = value(QLatin1String("ActiveMode")).toString();
        if (modeIdentifier.isEmpty())
641
            modeIdentifier = QLatin1String(Core::Constants::MODE_EDIT);
642

643 644
        ModeManager::instance()->activateMode(modeIdentifier);
        ModeManager::instance()->setFocusToCurrentMode();
645 646

        emit sessionLoaded();
con's avatar
con committed
647 648 649
    }

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
650
        qDebug() << "SessionManager - restoring session returned " << success;
con's avatar
con committed
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

    return success;
}

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

    emit aboutToSaveSession();

    bool result = m_file->save();

    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
                                tr("Could not save session to file %1").arg(m_file->fileName()));
    }

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

    return result;
}


/*!
  \fn bool SessionManager::clear()

  Returns whether the clear operation has been not cancelled & all projects could be closed.
  */
bool SessionManager::clear()
{
    if (debug)
        qDebug() << "SessionManager - clearing session ...";

686
    bool success = m_core->editorManager()->closeAllEditors();
con's avatar
con committed
687 688 689 690 691 692

    if (success) {
        if (debug)
            qDebug() << "SessionManager - Removing projects ...";

        setStartupProject(0);
693
        removeProjects(projects());
con's avatar
con committed
694 695 696 697 698 699 700 701
    }

    if (debug)
        qDebug() << "SessionManager - clearing session result is " << success;

    return success;
}

702
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
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 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
{
    return m_file->m_projects;
}

QStringList SessionManager::dependencies(const QString &proName) const
{
    QStringList result;
    foreach (const QString &dep, m_file->m_depMap.value(proName))
        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()) {
        const QString &proName = pro->file()->fileName();
        unordered << QPair<QString, QStringList>
            (proName, m_file->m_depMap.value(proName));
    }

    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) {
        pros = dependencies(project->file()->fileName());
    } else {
        pros = dependenciesOrder();
    }

    foreach (const QString &proFile, pros) {
        foreach (Project *pro, projects()) {
            if (pro->file()->fileName() == proFile) {
                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
787
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
788 789 790 791 792 793 794 795 796 797 798 799

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

    return project;
}

dt's avatar
dt committed
800
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
801 802
{
    Node *node = 0;
dt's avatar
dt committed
803 804 805
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
        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 << ")";

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

826 827 828 829
    // Check current project first
    Project *currentProject = ProjectExplorerPlugin::instance()->currentProject();
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
830

831 832 833 834 835 836 837 838 839 840 841 842
    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
843 844
}

845
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
846
{
847 848 849
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
850 851
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
852
    }
con's avatar
con committed
853 854
}

dt's avatar
dt committed
855
QString SessionManager::currentSession() const
con's avatar
con committed
856
{
857
    return QFileInfo(m_file->fileName()).completeBaseName();
con's avatar
con committed
858 859 860 861
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
862 863
    if (isDefaultSession(m_sessionName)) {
        if (Project *currentProject = ProjectExplorerPlugin::instance()->currentProject())
864
            m_core->editorManager()->setWindowTitleAddition(currentProject->displayName());
865
        else
866
            m_core->editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
867
    } else {
con's avatar
con committed
868 869 870
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
871
        m_core->editorManager()->setWindowTitleAddition(sessionName);
872
    }
con's avatar
con committed
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
}

void SessionManager::updateName(const QString &session)
{
    m_sessionName = session;
    updateWindowTitle();
}


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

    foreach (Project *pro, remove) {
        if (debug)
888
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
        emit aboutToRemoveProject(pro);
    }


    // Refresh dependencies
    QSet<QString> projectFiles;
    foreach (Project *pro, projects()) {
        if (!remove.contains(pro))
            projectFiles.insert(pro->file()->fileName());
    }

    QSet<QString>::const_iterator i = projectFiles.begin();
    while (i != projectFiles.end()) {
        QStringList dependencies;
        foreach (const QString &dependency, m_file->m_depMap.value(*i)) {
            if (projectFiles.contains(dependency))
                dependencies << dependency;
        }
        if (!dependencies.isEmpty())
            resMap.insert(*i, dependencies);
        ++i;
    }

    m_file->m_depMap = resMap;

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
    // TODO: Clear m_modelProjectHash

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

        if (pro == m_file->m_startupProject)
            setStartupProject(0);

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

        if (debug)
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
        m_sessionNode->removeProjectNode(pro->rootProjectNode());
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
935
    if (startupProject() == 0)
936 937
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
938 939
}

940 941 942 943
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
944 945
void SessionManager::setValue(const QString &name, const QVariant &value)
{
946 947 948 949 950 951
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
952
    markSessionFileDirty(false);
con's avatar
con committed
953 954 955 956
}

QVariant SessionManager::value(const QString &name)
{
957
    if (!m_file)
con's avatar
con committed
958
        return QVariant();
959 960
    QMap<QString, QVariant>::const_iterator it = m_file->m_values.find(name);
    return (it == m_file->m_values.constEnd()) ? QVariant() : *it;
con's avatar
con committed
961 962 963 964 965 966 967 968 969
}

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

QStringList SessionManager::sessions() const
{
970
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
971
        // We are not initialized yet, so do that now
972
        QDir sessionDir(Core::ICore::instance()->userResourcePath());
973 974
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
975
            if (fileInfo.completeBaseName() != QLatin1String("default"))
976 977
                m_sessions << fileInfo.completeBaseName();
        }
978
        m_sessions.prepend(QLatin1String("default"));
979 980
    }
    return m_sessions;
con's avatar
con committed
981 982
}

983
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
984
{
985
    return m_core->userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws");
con's avatar
con committed
986 987
}

988 989
QString SessionManager::sessionNameFromFileName(const QString &fileName) const
{
990 991
    const int slash = fileName.lastIndexOf(QLatin1Char('/'));
    Q_ASSERT(slash != -1 && fileName.endsWith(QLatin1String(".qws")));
992 993 994
    return fileName.mid(slash + 1, fileName.length() - slash - 5); // Exclude .qws
}

995 996 997 998
/*!
    \brief Creates a new default session and switches to it.
*/

con's avatar
con committed
999 1000
void SessionManager::createAndLoadNewDefaultSession()
{
1001
    createImpl(sessionNameToFileName(QLatin1String("default")));
con's avatar
con committed
1002 1003
}

1004 1005 1006 1007
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
1008 1009 1010 1011
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
1012 1013
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
1014 1015 1016
    return true;
}

1017 1018 1019 1020 1021 1022 1023 1024 1025
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

1026 1027 1028 1029
/*!
     \brief Deletes session name from session list and file from disk.
*/

con's avatar
con committed
1030 1031
bool SessionManager::deleteSession(const QString &session)
{
1032
    if (!m_sessions.contains(session))
con's avatar
con committed
1033
        return false;
1034
    m_sessions.removeOne(session);
con's avatar
con committed
1035 1036 1037 1038 1039 1040 1041 1042
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
1043
    if (!m_sessions.contains(original))
con's avatar
con committed
1044 1045 1046 1047 1048
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1049 1050
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1051 1052 1053 1054 1055
        return true;
    }
    return false;
}

1056 1057 1058 1059
/*!
     \brief Loads a session, takes a session name (not filename).
*/

con's avatar
con committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
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;
1070

con's avatar
con committed
1071
    QString fileName = sessionNameToFileName(session);
1072 1073 1074 1075 1076
    if (QFileInfo(fileName).exists())
        return loadImpl(fileName);

    // Create a new session with that name
    return createImpl(sessionNameToFileName(session));
con's avatar
con committed
1077 1078 1079 1080 1081
}

QString SessionManager::lastSession() const
{
    QSettings *settings = m_core->settings();
1082
    QString fileName = settings->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
1083
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
}

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

void SessionManager::reportProjectLoadingProgress()
{
    m_file->sessionLoadingProgress();
}

1096
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1097
{
1098 1099
    if (m_file && !m_file->fileName().isEmpty())
        m_autoSaveSessionTimer->start();
1100
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1101
        m_virginSession = false;
1102
}
con's avatar
con committed
1103 1104

#include "session.moc"