session.cpp 30.5 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 29
** If you have questions regarding the use of this file, please contact
** 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
#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 149 150

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

    m_fileName = fileName;

    // NPE: Load the session in the background?
    // NPE: Let FileManager monitor filename
    QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));

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

    m_core->progressManager()->addTask(future.future(), tr("Session"),
151
       QLatin1String("ProjectExplorer.SessionFile.Load"));
con's avatar
con committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166

    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
167 168 169 170 171 172 173
    // 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
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 220 221 222

    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();
    QApplication::restoreOverrideCursor();
    return true;
}

dt's avatar
dt committed
223
bool SessionFile::save()
con's avatar
con committed
224
{
dt's avatar
dt committed
225
    Q_ASSERT(!m_fileName.isEmpty());
con's avatar
con committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

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

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

259

260 261 262 263 264 265 266 267
    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
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
    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);


    if (writer.save(m_fileName, "QtCreatorSession"))
        return true;

    return false;
}

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

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

298 299 300 301 302
QStringList SessionFile::failedProjectFileNames() const
{
    return m_failedProjects;
}

303 304 305 306 307
void SessionFile::clearFailedProjectFileNames()
{
    m_failedProjects.clear();
}

con's avatar
con committed
308 309
/* --------------------------------- */

hjk's avatar
hjk committed
310 311 312 313
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_core(Core::ICore::instance()),
    m_file(new SessionFile),
314
    m_sessionNode(new Internal::SessionNodeImpl(this)),
dt's avatar
dt committed
315
    m_virginSession(true)
con's avatar
con committed
316 317 318
{
    connect(m_core->modeManager(), SIGNAL(currentModeChanged(Core::IMode*)),
            this, SLOT(saveActiveMode(Core::IMode*)));
319 320 321 322

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

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

SessionManager::~SessionManager()
{
341
    emit aboutToUnloadSession();
con's avatar
con committed
342 343 344 345 346 347
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
348 349
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
350 351 352 353
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
354
    return session == QLatin1String("default");
con's avatar
con committed
355 356 357 358 359
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
360
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
}

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

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
/*
 * 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
409 410 411 412 413 414 415 416
{
    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);
}

417
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
418 419 420 421 422 423 424
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
425
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
426 427 428 429 430 431 432 433 434 435 436 437 438
{
    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
439
    emit dependencyChanged(project, depProject);
con's avatar
con committed
440 441 442 443

    return true;
}

dt's avatar
dt committed
444
void SessionManager::removeDependency(Project *project, Project *depProject)
445 446 447 448 449 450 451 452 453 454 455
{
    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
456
    emit dependencyChanged(project, depProject);
457 458
}

con's avatar
con committed
459 460 461
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
462
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : "0");
con's avatar
con committed
463 464

    if (startupProject) {
dt's avatar
dt committed
465
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
466 467
    }

468 469 470
    if (m_file->m_startupProject == startupProject)
        return;

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

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

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

    // maybe we have a new startup project?
    if (!startupProject())
512 513
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
514 515 516 517
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
518
    m_virginSession = false;
con's avatar
con committed
519 520 521 522 523 524 525 526 527
    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
528
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
529 530 531 532 533 534 535

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

    bool success = true;

    if (!m_file->fileName().isEmpty()) {
hjk's avatar
hjk committed
536
        if (!save() || !clear())
con's avatar
con committed
537 538 539 540
            success = false;
    }

    if (success) {
541
        emit aboutToUnloadSession();
con's avatar
con committed
542
        delete m_file;
hjk's avatar
hjk committed
543
        m_file = new SessionFile;
con's avatar
con committed
544
        m_file->setFileName(fileName);
545
        setStartupProject(0);
546

547 548 549 550
        if (!isDefaultVirgin()) {
            m_core->modeManager()->activateMode(Core::Constants::MODE_EDIT);
            m_core->modeManager()->setFocusToCurrentMode();
        }
con's avatar
con committed
551 552
    }

dt's avatar
dt committed
553
    m_virginSession = true;
554

con's avatar
con committed
555 556 557 558 559 560 561 562
    if (debug)
        qDebug() << "SessionManager - creating new session returns " << success;

    return success;
}

bool SessionManager::loadImpl(const QString &fileName)
{
dt's avatar
dt committed
563
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
564 565

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
566
        qDebug() << "SessionManager - restoring session " << fileName << " ...";
con's avatar
con committed
567 568 569 570 571 572 573 574 575 576 577

    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
578
    m_virginSession = false;
579

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

        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
611 612 613 614
    }

    if (success) {
        // restore the active mode
615 616 617 618 619 620
        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
621 622 623
    }

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
624
        qDebug() << "SessionManager - restoring session returned " << success;
con's avatar
con committed
625 626 627 628 629 630 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

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

660
    bool success = m_core->editorManager()->closeAllEditors();
con's avatar
con committed
661 662 663 664 665 666

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

        setStartupProject(0);
667
        removeProjects(projects());
con's avatar
con committed
668 669 670 671 672 673 674 675
    }

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

    return success;
}

676
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
677 678 679 680 681 682 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
{
    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
761
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
762 763 764 765 766 767 768 769 770 771 772 773

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

    return project;
}

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

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

800 801 802 803
    // Check current project first
    Project *currentProject = ProjectExplorerPlugin::instance()->currentProject();
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
804

805 806 807 808 809 810 811 812 813 814 815 816
    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
817 818
}

819
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
820
{
821 822 823 824 825
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
        if (project && !project->editorConfiguration()->useGlobalSettings()) {
            project->editorConfiguration()->apply(textEditor);
826
        }
827
    }
con's avatar
con committed
828 829
}

dt's avatar
dt committed
830
QString SessionManager::currentSession() const
con's avatar
con committed
831
{
dt's avatar
dt committed
832
    return m_file->fileName();
con's avatar
con committed
833 834 835 836
}

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

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)
868
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893
        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;

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

void SessionManager::setValue(const QString &name, const QVariant &value)
{
922 923 924 925 926 927
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
928
    markSessionFileDirty(false);
con's avatar
con committed
929 930 931 932
}

QVariant SessionManager::value(const QString &name)
{
933
    if (!m_file)
con's avatar
con committed
934
        return QVariant();
935 936
    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
937 938 939 940 941 942 943 944 945
}

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

QStringList SessionManager::sessions() const
{
946
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
947
        // We are not initialized yet, so do that now
948
        QDir sessionDir(Core::ICore::instance()->userResourcePath());
949 950 951
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
            if (fileInfo.completeBaseName() != "default")
952 953 954 955 956
                m_sessions << fileInfo.completeBaseName();
        }
        m_sessions.prepend("default");
    }
    return m_sessions;
con's avatar
con committed
957 958
}

959
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
960
{
961
    return m_core->userResourcePath() + '/' + session + ".qws";
con's avatar
con committed
962 963 964 965
}

void SessionManager::createAndLoadNewDefaultSession()
{
966
    emit aboutToLoadSession();
con's avatar
con committed
967 968
    updateName("default");
    createImpl(sessionNameToFileName(m_sessionName));
969
    emit sessionLoaded();
con's avatar
con committed
970 971 972 973 974 975
}

bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
976 977
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
978 979 980
    return true;
}

981 982 983 984 985 986 987 988 989
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

con's avatar
con committed
990 991
bool SessionManager::deleteSession(const QString &session)
{
992
    if (!m_sessions.contains(session))
con's avatar
con committed
993
        return false;
994
    m_sessions.removeOne(session);
con's avatar
con committed
995 996 997 998 999 1000 1001 1002
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
1003
    if (!m_sessions.contains(original))
con's avatar
con committed
1004 1005 1006 1007 1008
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1009 1010
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
        return true;
    }
    return false;
}

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;
1026
    emit aboutToLoadSession();
con's avatar
con committed
1027 1028 1029 1030
    QString fileName = sessionNameToFileName(session);
    if (QFileInfo(fileName).exists()) {
        if (loadImpl(fileName)) {
            updateName(session);
1031
            emit sessionLoaded();
con's avatar
con committed
1032 1033 1034 1035
            return true;
        }
    } else {
        // Create a new session with that name
hjk's avatar
hjk committed
1036
        if (!createImpl(sessionNameToFileName(session)))
con's avatar
con committed
1037 1038
            return false;
        updateName(session);
1039
        emit sessionLoaded();
con's avatar
con committed
1040 1041 1042 1043 1044 1045 1046 1047 1048
        return true;
    }
    return false;
}

QString SessionManager::lastSession() const
{
    QSettings *settings = m_core->settings();
    QString fileName = settings->value("ProjectExplorer/StartupSession").toString();
1049
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
}

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

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

1062
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1063
{
1064 1065
    if (m_file && !m_file->fileName().isEmpty())
        m_autoSaveSessionTimer->start();
1066
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1067
        m_virginSession = false;
1068
}
con's avatar
con committed
1069 1070

#include "session.moc"