session.cpp 31 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
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.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
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.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
#include "project.h"
#include "projectexplorer.h"
#include "projectexplorerconstants.h"
#include "nodesvisitor.h"
#include "editorconfiguration.h"
41
#include "persistentsettings.h"
con's avatar
con committed
42 43 44 45 46 47

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
#include <coreplugin/filemanager.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
48
#include <coreplugin/coreconstants.h>
49
#include <coreplugin/progressmanager/progressmanager.h>
con's avatar
con committed
50 51 52 53
#include <coreplugin/modemanager.h>

#include <texteditor/itexteditor.h>

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

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 74 75 76 77

namespace {
    bool debug = false;
}

/* SessionFile definitions */
namespace ProjectExplorer {
namespace Internal {

dt's avatar
dt committed
78
class SessionFile : QObject
con's avatar
con committed
79 80 81 82
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
83
    SessionFile();
con's avatar
con committed
84 85

    bool load(const QString &fileName);
dt's avatar
dt committed
86
    bool save();
con's avatar
con committed
87 88 89 90

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

91
    QStringList failedProjectFileNames() const;
92
    void clearFailedProjectFileNames();
93

con's avatar
con committed
94 95 96 97 98 99 100 101 102
public slots:
    void sessionLoadingProgress();

private:
    Core::ICore *m_core;

    QString m_fileName;
    QList<Project *> m_projects;
    Project *m_startupProject;
103
    QStringList m_failedProjects;
con's avatar
con committed
104 105 106 107 108 109 110 111 112 113 114 115
    QMap<QString, QStringList> m_depMap;

    QMap<QString, QVariant> m_values;

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

} // namespace Internal
} // namespace ProjectExplorer

using namespace ProjectExplorer;
116
using namespace ProjectExplorer::Internal;
con's avatar
con committed
117 118 119 120 121 122 123

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

hjk's avatar
hjk committed
124
SessionFile::SessionFile()
dt's avatar
dt committed
125
  : m_core(Core::ICore::instance()),
con's avatar
con committed
126 127 128 129 130 131
    m_startupProject(0)
{
}

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

    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"),
149
       QLatin1String("ProjectExplorer.SessionFile.Load"));
con's avatar
con committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
        QVariant value = reader.restoreValue("value-" + key);
        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
165 166 167 168 169 170 171
    // Keep projects that failed to load in the session!
    m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList);
        foreach (Project *p, projects)
            m_failedProjects.removeAll(p->file()->fileName());
    }
con's avatar
con committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 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

    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();
        QStringList values;
        foreach (const QString &value, i.value().toStringList()) {
            values << value;
        }
        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
220
bool SessionFile::save()
con's avatar
con committed
221
{
dt's avatar
dt committed
222
    Q_ASSERT(!m_fileName.isEmpty());
con's avatar
con committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

    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();
    }
238 239
    // Restore infromation on projects that failed to load:
    projectFiles.append(m_failedProjects);
con's avatar
con committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255

    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));

256

257 258 259 260 261 262 263 264
    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
265 266 267 268 269 270 271 272 273 274 275 276 277 278
    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) {
        writer.saveValue("value-" + it.key(), it.value());
        keys << it.key();
    }

    writer.saveValue("valueKeys", keys);


279
    if (writer.save(m_fileName, "QtCreatorSession", Core::ICore::instance()->mainWindow()))
con's avatar
con committed
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
        return true;

    return false;
}

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

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

295 296 297 298 299
QStringList SessionFile::failedProjectFileNames() const
{
    return m_failedProjects;
}

300 301 302 303 304
void SessionFile::clearFailedProjectFileNames()
{
    m_failedProjects.clear();
}

305 306 307 308 309 310 311 312 313 314
/*!
     \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
315

hjk's avatar
hjk committed
316 317 318 319
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_core(Core::ICore::instance()),
    m_file(new SessionFile),
320
    m_sessionNode(new Internal::SessionNodeImpl(this)),
dt's avatar
dt committed
321
    m_virginSession(true)
con's avatar
con committed
322 323 324
{
    connect(m_core->modeManager(), SIGNAL(currentModeChanged(Core::IMode*)),
            this, SLOT(saveActiveMode(Core::IMode*)));
325 326 327 328

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

    connect(em, SIGNAL(editorCreated(Core::IEditor *, QString)),
329
            this, SLOT(configureEditor(Core::IEditor *, QString)));
con's avatar
con committed
330 331
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project *)),
            this, SLOT(updateWindowTitle()));
332 333 334 335 336 337 338 339 340 341 342
    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
343
}
con's avatar
con committed
344 345 346

SessionManager::~SessionManager()
{
347
    emit aboutToUnloadSession();
con's avatar
con committed
348 349 350 351 352 353
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
354 355
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
356 357 358 359
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
360
    return session == QLatin1String("default");
con's avatar
con committed
361 362 363 364 365
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
366
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
}

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;
}

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
/*
 * 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
415 416 417 418 419 420 421 422
{
    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);
}

423
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
424 425 426 427 428 429 430
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
431
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
432 433 434 435 436 437 438 439 440 441 442 443 444
{
    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
445
    emit dependencyChanged(project, depProject);
con's avatar
con committed
446 447 448 449

    return true;
}

dt's avatar
dt committed
450
void SessionManager::removeDependency(Project *project, Project *depProject)
451 452 453 454 455 456 457 458 459 460 461
{
    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
462
    emit dependencyChanged(project, depProject);
463 464
}

con's avatar
con committed
465 466 467
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
468
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : "0");
con's avatar
con committed
469 470

    if (startupProject) {
dt's avatar
dt committed
471
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
472 473
    }

474 475 476
    if (m_file->m_startupProject == startupProject)
        return;

con's avatar
con committed
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
    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
493
    m_virginSession = false;
con's avatar
con committed
494 495 496 497 498 499 500 501 502 503 504
    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)
505
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
506 507 508 509 510 511 512 513 514 515 516 517
        }
    }

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

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

    // maybe we have a new startup project?
    if (!startupProject())
518 519
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
520 521 522 523
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
524
    m_virginSession = false;
con's avatar
con committed
525 526 527 528 529 530 531 532 533
    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
534
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
535 536 537 538 539 540 541

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

    bool success = true;

    if (!m_file->fileName().isEmpty()) {
hjk's avatar
hjk committed
542
        if (!save() || !clear())
con's avatar
con committed
543 544 545 546
            success = false;
    }

    if (success) {
547
        emit aboutToUnloadSession();
con's avatar
con committed
548
        delete m_file;
hjk's avatar
hjk committed
549
        m_file = new SessionFile;
con's avatar
con committed
550
        m_file->setFileName(fileName);
551
        setStartupProject(0);
552

553 554 555 556
        if (!isDefaultVirgin()) {
            m_core->modeManager()->activateMode(Core::Constants::MODE_EDIT);
            m_core->modeManager()->setFocusToCurrentMode();
        }
con's avatar
con committed
557 558
    }

dt's avatar
dt committed
559
    m_virginSession = true;
560

con's avatar
con committed
561 562 563 564 565 566 567 568
    if (debug)
        qDebug() << "SessionManager - creating new session returns " << success;

    return success;
}

bool SessionManager::loadImpl(const QString &fileName)
{
dt's avatar
dt committed
569
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
570 571

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
572
        qDebug() << "SessionManager - restoring session " << fileName << " ...";
con's avatar
con committed
573 574 575 576 577 578 579 580 581 582 583

    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
584
    m_virginSession = false;
585

con's avatar
con committed
586
    if (success) {
587
        emit aboutToUnloadSession();
con's avatar
con committed
588
        delete m_file;
hjk's avatar
hjk committed
589
        m_file = new SessionFile;
con's avatar
con committed
590
        if (!m_file->load(fileName)) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
591 592
            QMessageBox::warning(0, tr("Error while restoring session"),
                                    tr("Could not restore session %1").arg(fileName));
con's avatar
con committed
593 594
            success = false;
        }
595 596 597
        // 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);
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616

        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
617 618 619 620
    }

    if (success) {
        // restore the active mode
621 622 623 624 625 626
        QString modeIdentifier = value(QLatin1String("ActiveMode")).toString();
        if (modeIdentifier.isEmpty())
            modeIdentifier = Core::Constants::MODE_EDIT;

        m_core->modeManager()->activateMode(modeIdentifier);
        m_core->modeManager()->setFocusToCurrentMode();
con's avatar
con committed
627 628 629
    }

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
630
        qDebug() << "SessionManager - restoring session returned " << success;
con's avatar
con committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

    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 ...";

666
    bool success = m_core->editorManager()->closeAllEditors();
con's avatar
con committed
667 668 669 670 671 672

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

        setStartupProject(0);
673
        removeProjects(projects());
con's avatar
con committed
674 675 676 677 678 679 680 681
    }

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

    return success;
}

682
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
683 684 685 686 687 688 689 690 691 692 693 694 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 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
{
    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
767
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
768 769 770 771 772 773 774 775 776 777 778 779

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

    return project;
}

dt's avatar
dt committed
780
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
781 782
{
    Node *node = 0;
dt's avatar
dt committed
783 784 785
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
        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 << ")";

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

806 807 808 809
    // Check current project first
    Project *currentProject = ProjectExplorerPlugin::instance()->currentProject();
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
810

811 812 813 814 815 816 817 818 819 820 821 822
    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
823 824
}

825
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
826
{
827 828 829
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
830 831
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
832
    }
con's avatar
con committed
833 834
}

dt's avatar
dt committed
835
QString SessionManager::currentSession() const
con's avatar
con committed
836
{
dt's avatar
dt committed
837
    return m_file->fileName();
con's avatar
con committed
838 839 840 841
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
842 843
    if (isDefaultSession(m_sessionName)) {
        if (Project *currentProject = ProjectExplorerPlugin::instance()->currentProject())
844
            m_core->editorManager()->setWindowTitleAddition(currentProject->displayName());
845 846
        else
            m_core->editorManager()->setWindowTitleAddition("");
dt's avatar
dt committed
847
    } else {
con's avatar
con committed
848 849 850
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
851
        m_core->editorManager()->setWindowTitleAddition(sessionName);
852
    }
con's avatar
con committed
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
}

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

    if (sessionName.isEmpty())
        sessionName = tr("Untitled");

    updateWindowTitle();
}


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

    foreach (Project *pro, remove) {
        if (debug)
873
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
        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;

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
    // 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
920
    if (startupProject() == 0)
921 922
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
923 924
}

925 926 927 928
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
929 930
void SessionManager::setValue(const QString &name, const QVariant &value)
{
931 932 933 934 935 936
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
937
    markSessionFileDirty(false);
con's avatar
con committed
938 939 940 941
}

QVariant SessionManager::value(const QString &name)
{
942
    if (!m_file)
con's avatar
con committed
943
        return QVariant();
944 945
    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
946 947 948 949 950 951 952 953 954
}

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

QStringList SessionManager::sessions() const
{
955
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
956
        // We are not initialized yet, so do that now
957
        QDir sessionDir(Core::ICore::instance()->userResourcePath());
958 959 960
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
            if (fileInfo.completeBaseName() != "default")
961 962 963 964 965
                m_sessions << fileInfo.completeBaseName();
        }
        m_sessions.prepend("default");
    }
    return m_sessions;
con's avatar
con committed
966 967
}

968
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
969
{
970
    return m_core->userResourcePath() + '/' + session + ".qws";
con's avatar
con committed
971 972
}

973 974 975 976
/*!
    \brief Creates a new default session and switches to it.
*/

con's avatar
con committed
977 978
void SessionManager::createAndLoadNewDefaultSession()
{
979
    emit aboutToLoadSession();
con's avatar
con committed
980 981
    updateName("default");
    createImpl(sessionNameToFileName(m_sessionName));
982
    emit sessionLoaded();
con's avatar
con committed
983 984
}

985 986 987 988
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
989 990 991 992
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
993 994
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
995 996 997
    return true;
}

998 999 1000 1001 1002 1003 1004 1005 1006
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

1007 1008 1009 1010
/*!
     \brief Deletes session name from session list and file from disk.
*/

con's avatar
con committed
1011 1012
bool SessionManager::deleteSession(const QString &session)
{
1013
    if (!m_sessions.contains(session))
con's avatar
con committed
1014
        return false;
1015
    m_sessions.removeOne(session);
con's avatar
con committed
1016 1017 1018 1019 1020 1021 1022 1023
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
1024
    if (!m_sessions.contains(original))
con's avatar
con committed
1025 1026 1027 1028 1029
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1030 1031
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1032 1033 1034 1035 1036
        return true;
    }
    return false;
}

1037 1038 1039 1040
/*!
     \brief Loads a session, takes a session name (not filename).
*/

con's avatar
con committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
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;
1051
    emit aboutToLoadSession();
con's avatar
con committed
1052 1053 1054 1055
    QString fileName = sessionNameToFileName(session);
    if (QFileInfo(fileName).exists()) {
        if (loadImpl(fileName)) {
            updateName(session);
1056
            emit sessionLoaded();
con's avatar
con committed
1057 1058 1059 1060
            return true;
        }
    } else {
        // Create a new session with that name
hjk's avatar
hjk committed
1061
        if (!createImpl(sessionNameToFileName(session)))
con's avatar
con committed
1062 1063
            return false;
        updateName(session);
1064
        emit sessionLoaded();
con's avatar
con committed
1065 1066 1067 1068 1069 1070 1071 1072 1073
        return true;
    }
    return false;
}

QString SessionManager::lastSession() const
{
    QSettings *settings = m_core->settings();
    QString fileName = settings->value("ProjectExplorer/StartupSession").toString();
1074
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
}

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

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

1087
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1088
{
1089 1090
    if (m_file && !m_file->fileName().isEmpty())
        m_autoSaveSessionTimer->start();
1091
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1092
        m_virginSession = false;
1093
}
con's avatar
con committed
1094 1095

#include "session.moc"