session.cpp 30.9 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32 33 34

#include "session.h"

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

#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);
Daniel Teske's avatar
Daniel Teske committed
90
    bool save(const QString &fileName);
con's avatar
con committed
91

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

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

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

    QMap<QString, QVariant> m_values;

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

} // namespace Internal
} // namespace ProjectExplorer

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

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

hjk's avatar
hjk committed
122
SessionFile::SessionFile()
hjk's avatar
hjk committed
123
  :  m_startupProject(0)
con's avatar
con committed
124 125 126 127 128
{
}

bool SessionFile::load(const QString &fileName)
{
dt's avatar
dt committed
129
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
130 131 132 133 134 135 136 137

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

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

    PersistentSettingsReader reader;
Daniel Teske's avatar
Daniel Teske committed
138
    if (!reader.load(fileName)) {
con's avatar
con committed
139 140 141 142
        qWarning() << "SessionManager::load failed!" << fileName;
        return false;
    }

hjk's avatar
hjk committed
143
    ICore::progressManager()->addTask(future.future(), tr("Session"),
144
       QLatin1String("ProjectExplorer.SessionFile.Load"));
con's avatar
con committed
145 146 147

    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
148
        QVariant value = reader.restoreValue(QLatin1String("value-") + key);
con's avatar
con committed
149 150 151 152 153 154 155 156 157 158 159
        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
160 161 162
    // Keep projects that failed to load in the session!
    m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
163 164 165
        QString errors;
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList, &errors);
        if (!errors.isEmpty())
hjk's avatar
hjk committed
166
            QMessageBox::critical(Core::ICore::mainWindow(), tr("Failed to open project"), errors);
167 168 169
        foreach (Project *p, projects)
            m_failedProjects.removeAll(p->file()->fileName());
    }
con's avatar
con committed
170 171 172 173 174 175 176 177

    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();
178 179
        if (m_failedProjects.contains(key))
            continue;
con's avatar
con committed
180 181
        QStringList values;
        foreach (const QString &value, i.value().toStringList()) {
182 183
            if (!m_failedProjects.contains(value))
                values << value;
con's avatar
con committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
        }
        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()) {
hjk's avatar
hjk committed
205
        connect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
con's avatar
con committed
206
                this, SLOT(sessionLoadingProgress()));
hjk's avatar
hjk committed
207
        ICore::editorManager()->restoreState(
con's avatar
con committed
208
            QByteArray::fromBase64(editorsettings.toByteArray()));
hjk's avatar
hjk committed
209
        disconnect(ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
con's avatar
con committed
210 211 212 213 214 215 216 217 218 219 220
                   this, SLOT(sessionLoadingProgress()));
    }

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


    future.reportFinished();
    return true;
}

Daniel Teske's avatar
Daniel Teske committed
221
bool SessionFile::save(const QString &fileName)
con's avatar
con committed
222 223
{
    if (debug)
Daniel Teske's avatar
Daniel Teske committed
224
        qDebug() << "SessionFile - saving " << fileName;
con's avatar
con committed
225 226 227 228 229 230 231 232 233 234 235 236

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

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

255

256
    int editorCount = 0;
hjk's avatar
hjk committed
257
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
258 259 260 261 262 263
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
    writer.saveValue(QLatin1String("OpenEditors"), editorCount);
con's avatar
con committed
264
    writer.saveValue(QLatin1String("EditorSettings"),
hjk's avatar
hjk committed
265
                     ICore::editorManager()->saveState().toBase64());
con's avatar
con committed
266 267 268 269 270

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

275
    writer.saveValue(QLatin1String("valueKeys"), keys);
con's avatar
con committed
276 277


Daniel Teske's avatar
Daniel Teske committed
278
    if (writer.save(fileName, QLatin1String("QtCreatorSession"), Core::ICore::mainWindow()))
con's avatar
con committed
279 280 281 282 283
        return true;

    return false;
}

284 285 286 287 288
QStringList SessionFile::failedProjectFileNames() const
{
    return m_failedProjects;
}

289 290 291 292 293
void SessionFile::clearFailedProjectFileNames()
{
    m_failedProjects.clear();
}

294 295 296 297 298 299 300 301 302 303
/*!
     \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
304

hjk's avatar
hjk committed
305 306 307
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_file(new SessionFile),
308
    m_sessionNode(new SessionNode(this)),
309
    m_sessionName(QLatin1String("default")),
dt's avatar
dt committed
310
    m_virginSession(true)
con's avatar
con committed
311
{
312
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
313
            this, SLOT(saveActiveMode(Core::IMode*)));
314

hjk's avatar
hjk committed
315
    EditorManager *em = ICore::editorManager();
316 317

    connect(em, SIGNAL(editorCreated(Core::IEditor *, QString)),
318
            this, SLOT(configureEditor(Core::IEditor *, QString)));
con's avatar
con committed
319 320
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project *)),
            this, SLOT(updateWindowTitle()));
321 322 323 324 325 326 327 328 329
    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()),
hjk's avatar
hjk committed
330
            ICore::instance(), SIGNAL(saveSettingsRequested()));
hjk's avatar
hjk committed
331
}
con's avatar
con committed
332 333 334

SessionManager::~SessionManager()
{
335
    emit aboutToUnloadSession();
con's avatar
con committed
336 337 338 339 340 341
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
342 343
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
344 345 346 347
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
348
    return session == QLatin1String("default");
con's avatar
con committed
349 350 351 352 353
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
354
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
}

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

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
/*
 * 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
403 404 405 406 407 408 409 410
{
    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);
}

411
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
412 413 414 415 416 417 418
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
419
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
420 421 422 423 424 425 426 427 428 429 430 431 432
{
    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
433
    emit dependencyChanged(project, depProject);
con's avatar
con committed
434 435 436 437

    return true;
}

dt's avatar
dt committed
438
void SessionManager::removeDependency(Project *project, Project *depProject)
439 440 441 442 443 444 445 446 447 448 449
{
    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
450
    emit dependencyChanged(project, depProject);
451 452
}

con's avatar
con committed
453 454 455
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
456
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
457 458

    if (startupProject) {
dt's avatar
dt committed
459
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
460 461
    }

462 463 464
    if (m_file->m_startupProject == startupProject)
        return;

con's avatar
con committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    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
481
    m_virginSession = false;
con's avatar
con committed
482 483 484 485 486
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
        if (!m_file->m_projects.contains(pro)) {
            clearedList.append(pro);
            m_file->m_projects.append(pro);
487
            m_sessionNode->addProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
con's avatar
con committed
488 489 490 491 492

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

            if (debug)
493
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
494 495 496 497 498 499 500 501 502 503 504 505
        }
    }

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

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

    // maybe we have a new startup project?
    if (!startupProject())
506 507
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
508 509 510 511
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
512
    m_virginSession = false;
con's avatar
con committed
513 514 515 516 517 518 519 520 521
    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
522
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
523 524 525 526 527

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

    bool success = true;
528 529 530 531
    if (isDefaultVirgin()) {
        // do not save initial and virgin default session
    } else if (!save() || !clear()) {
        success = false;
con's avatar
con committed
532 533 534
    }

    if (success) {
535
        emit aboutToUnloadSession();
con's avatar
con committed
536
        delete m_file;
hjk's avatar
hjk committed
537
        m_file = new SessionFile;
538 539
        const QString &sessionName = sessionNameFromFileName(fileName);
        emit aboutToLoadSession(sessionName);
540 541
        m_sessionName = sessionName;
        updateWindowTitle();
542
        setStartupProject(0);
543

544
        if (!isDefaultVirgin()) {
545 546
            ModeManager::activateMode(QLatin1String(Core::Constants::MODE_EDIT));
            ModeManager::setFocusToCurrentMode();
547
        }
548 549

        emit sessionLoaded();
con's avatar
con committed
550 551
    }

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

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

    return success;
}

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

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
565
        qDebug() << "SessionManager - restoring session " << fileName << " ...";
con's avatar
con committed
566 567

    bool success = true;
568 569 570 571
    if (isDefaultVirgin()) {
        // do not save initial and virgin default session
    } else if (!save() || !clear()) {
        success = false;
con's avatar
con committed
572 573
    }

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

con's avatar
con committed
576
    if (success) {
577
        emit aboutToUnloadSession();
con's avatar
con committed
578
        delete m_file;
hjk's avatar
hjk committed
579
        m_file = new SessionFile;
580 581
        const QString &sessionName = sessionNameFromFileName(fileName);
        emit aboutToLoadSession(sessionName);
582 583
        m_sessionName = sessionName;
        updateWindowTitle();
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
        QString modeIdentifier = value(QLatin1String("ActiveMode")).toString();
        if (modeIdentifier.isEmpty())
617
            modeIdentifier = QLatin1String(Core::Constants::MODE_EDIT);
618

619 620
        ModeManager::activateMode(modeIdentifier);
        ModeManager::setFocusToCurrentMode();
621 622

        emit sessionLoaded();
con's avatar
con committed
623 624 625
    }

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
626
        qDebug() << "SessionManager - restoring session returned " << success;
con's avatar
con committed
627 628 629 630 631 632 633 634 635 636 637

    return success;
}

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

    emit aboutToSaveSession();

Daniel Teske's avatar
Daniel Teske committed
638 639
    QString fileName = sessionNameToFileName(m_sessionName);
    bool result = m_file->save(fileName);
con's avatar
con committed
640 641 642

    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Daniel Teske's avatar
Daniel Teske committed
643
                                tr("Could not save session to file %1").arg(fileName));
con's avatar
con committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
    }

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

hjk's avatar
hjk committed
663
    bool success = ICore::editorManager()->closeAllEditors();
con's avatar
con committed
664 665 666 667 668 669

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

        setStartupProject(0);
670
        removeProjects(projects());
con's avatar
con committed
671 672 673 674 675 676 677 678
    }

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

    return success;
}

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

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

    return project;
}

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

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

803
    // Check current project first
804
    Project *currentProject = ProjectExplorerPlugin::currentProject();
805 806
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
807

808 809 810 811 812 813 814 815 816 817 818 819
    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
820 821
}

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

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
834
    if (isDefaultSession(m_sessionName)) {
835
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
836
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
837
        else
hjk's avatar
hjk committed
838
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
839
    } else {
con's avatar
con committed
840 841 842
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
843
        ICore::editorManager()->setWindowTitleAddition(sessionName);
844
    }
con's avatar
con committed
845 846 847 848 849 850 851 852
}

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

    foreach (Project *pro, remove) {
        if (debug)
853
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
        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;

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
    // 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() << ")";
895
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
896 897 898 899
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
900
    if (startupProject() == 0)
901 902
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
903 904
}

905 906 907 908
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
909 910
void SessionManager::setValue(const QString &name, const QVariant &value)
{
911 912 913 914 915 916
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
917
    markSessionFileDirty(false);
con's avatar
con committed
918 919 920 921
}

QVariant SessionManager::value(const QString &name)
{
922
    if (!m_file)
con's avatar
con committed
923
        return QVariant();
924 925
    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
926 927 928 929 930 931 932 933 934
}

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

QStringList SessionManager::sessions() const
{
935
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
936
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
937
        QDir sessionDir(Core::ICore::userResourcePath());
938 939
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
940
            if (fileInfo.completeBaseName() != QLatin1String("default"))
941 942
                m_sessions << fileInfo.completeBaseName();
        }
943
        m_sessions.prepend(QLatin1String("default"));
944 945
    }
    return m_sessions;
con's avatar
con committed
946 947
}

948
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
949
{
hjk's avatar
hjk committed
950
    return ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws");
con's avatar
con committed
951 952
}

953 954
QString SessionManager::sessionNameFromFileName(const QString &fileName) const
{
955 956
    const int slash = fileName.lastIndexOf(QLatin1Char('/'));
    Q_ASSERT(slash != -1 && fileName.endsWith(QLatin1String(".qws")));
957 958 959
    return fileName.mid(slash + 1, fileName.length() - slash - 5); // Exclude .qws
}

960 961 962 963
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
964 965 966 967
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
968 969
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
970 971 972
    return true;
}

973 974 975 976 977 978 979 980 981
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

982 983 984 985
/*!
     \brief Deletes session name from session list and file from disk.
*/

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

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
999
    if (!m_sessions.contains(original))
con's avatar
con committed
1000 1001 1002 1003 1004
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1005 1006
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1007 1008 1009 1010 1011
        return true;
    }
    return false;
}

1012 1013 1014 1015
/*!
     \brief Loads a session, takes a session name (not filename).
*/

con's avatar
con committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
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

con's avatar
con committed
1027
    QString fileName = sessionNameToFileName(session);
1028 1029 1030 1031 1032
    if (QFileInfo(fileName).exists())
        return loadImpl(fileName);

    // Create a new session with that name
    return createImpl(sessionNameToFileName(session));
con's avatar
con committed
1033 1034 1035 1036
}

QString SessionManager::lastSession() const
{
hjk's avatar
hjk committed
1037
    QString fileName = ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
1038
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
}

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

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

1051
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1052
{
1053
    m_autoSaveSessionTimer->start();
1054
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1055
        m_virginSession = false;
1056
}
con's avatar
con committed
1057 1058

#include "session.moc"