session.cpp 30.1 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 90 91 92 93 94

public slots:
    void sessionLoadingProgress();

private:
    QList<Project *> m_projects;
    Project *m_startupProject;
95
    QStringList m_failedProjects;
con's avatar
con committed
96 97 98 99 100 101 102 103 104 105 106 107
    QMap<QString, QStringList> m_depMap;

    QMap<QString, QVariant> m_values;

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

} // namespace Internal
} // namespace ProjectExplorer

using namespace ProjectExplorer;
108
using namespace ProjectExplorer::Internal;
con's avatar
con committed
109 110 111 112 113 114 115

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

hjk's avatar
hjk committed
116
SessionFile::SessionFile()
hjk's avatar
hjk committed
117
  :  m_startupProject(0)
con's avatar
con committed
118 119 120
{
}

121 122 123 124 125 126 127 128 129 130
/*!
     \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
131

hjk's avatar
hjk committed
132 133 134
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_file(new SessionFile),
135
    m_sessionNode(new SessionNode(this)),
136
    m_sessionName(QLatin1String("default")),
dt's avatar
dt committed
137
    m_virginSession(true)
con's avatar
con committed
138
{
139
    connect(ModeManager::instance(), SIGNAL(currentModeChanged(Core::IMode*)),
con's avatar
con committed
140
            this, SLOT(saveActiveMode(Core::IMode*)));
141

hjk's avatar
hjk committed
142
    EditorManager *em = ICore::editorManager();
143 144

    connect(em, SIGNAL(editorCreated(Core::IEditor *, QString)),
145
            this, SLOT(configureEditor(Core::IEditor *, QString)));
con's avatar
con committed
146 147
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project *)),
            this, SLOT(updateWindowTitle()));
148 149 150 151 152 153 154 155 156
    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
157
            ICore::instance(), SIGNAL(saveSettingsRequested()));
hjk's avatar
hjk committed
158
}
con's avatar
con committed
159 160 161

SessionManager::~SessionManager()
{
162
    emit aboutToUnloadSession();
con's avatar
con committed
163 164 165 166 167 168
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
169 170
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
171 172 173 174
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
175
    return session == QLatin1String("default");
con's avatar
con committed
176 177 178 179 180
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
181
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
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
}

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

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
/*
 * 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
230 231 232 233 234 235 236 237
{
    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);
}

238
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
239 240 241 242 243 244 245
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
246
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
247 248 249 250 251 252 253 254 255 256 257 258 259
{
    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
260
    emit dependencyChanged(project, depProject);
con's avatar
con committed
261 262 263 264

    return true;
}

dt's avatar
dt committed
265
void SessionManager::removeDependency(Project *project, Project *depProject)
266 267 268 269 270 271 272 273 274 275 276
{
    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
277
    emit dependencyChanged(project, depProject);
278 279
}

con's avatar
con committed
280 281 282
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
283
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : QLatin1String("0"));
con's avatar
con committed
284 285

    if (startupProject) {
dt's avatar
dt committed
286
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
287 288
    }

289 290 291
    if (m_file->m_startupProject == startupProject)
        return;

con's avatar
con committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
    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
308
    m_virginSession = false;
con's avatar
con committed
309 310 311 312 313
    QList<Project*> clearedList;
    foreach (Project *pro, projects) {
        if (!m_file->m_projects.contains(pro)) {
            clearedList.append(pro);
            m_file->m_projects.append(pro);
314
            m_sessionNode->addProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
con's avatar
con committed
315 316 317 318 319

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

            if (debug)
320
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
321 322 323 324 325 326 327 328 329 330 331 332
        }
    }

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

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

    // maybe we have a new startup project?
    if (!startupProject())
333 334
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
335 336 337 338
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
339
    m_virginSession = false;
con's avatar
con committed
340 341 342 343 344 345 346 347 348
    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
349
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
350 351 352 353 354

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

    bool success = true;
355 356 357 358
    if (isDefaultVirgin()) {
        // do not save initial and virgin default session
    } else if (!save() || !clear()) {
        success = false;
con's avatar
con committed
359 360 361
    }

    if (success) {
362
        emit aboutToUnloadSession();
con's avatar
con committed
363
        delete m_file;
hjk's avatar
hjk committed
364
        m_file = new SessionFile;
365 366
        const QString &sessionName = sessionNameFromFileName(fileName);
        emit aboutToLoadSession(sessionName);
367 368
        m_sessionName = sessionName;
        updateWindowTitle();
369
        setStartupProject(0);
370

371
        if (!isDefaultVirgin()) {
372 373
            ModeManager::activateMode(QLatin1String(Core::Constants::MODE_EDIT));
            ModeManager::setFocusToCurrentMode();
374
        }
375 376

        emit sessionLoaded();
con's avatar
con committed
377 378
    }

dt's avatar
dt committed
379
    m_virginSession = true;
380

con's avatar
con committed
381 382 383 384 385 386 387 388
    if (debug)
        qDebug() << "SessionManager - creating new session returns " << success;

    return success;
}

bool SessionManager::loadImpl(const QString &fileName)
{
dt's avatar
dt committed
389
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
390 391

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

394 395 396
    if (isDefaultVirgin()) {
        // do not save initial and virgin default session
    } else if (!save() || !clear()) {
397 398 399 400
        m_virginSession = false;
        if (debug)
            qDebug() << "SessionManager - restoring session returned " << false;
        return false;
con's avatar
con committed
401 402
    }

dt's avatar
dt committed
403
    m_virginSession = false;
404

405 406 407 408 409 410 411
    emit aboutToUnloadSession();
    delete m_file;
    m_file = new SessionFile;
    const QString &sessionName = sessionNameFromFileName(fileName);
    emit aboutToLoadSession(sessionName);
    m_sessionName = sessionName;
    updateWindowTitle();
412 413 414

    PersistentSettingsReader reader;
    if (!reader.load(fileName)) {
415 416 417 418 419 420 421
        QMessageBox::warning(0, tr("Error while restoring session"),
                                tr("Could not restore session %1").arg(fileName));
        if (debug)
            qDebug() << "SessionManager - restoring session returned " << false;

        return false;
    }
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

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

    const QStringList &keys = reader.restoreValue(QLatin1String("valueKeys")).toStringList();
    foreach (const QString &key, keys) {
        QVariant value = reader.restoreValue(QLatin1String("value-") + key);
        m_file->m_values.insert(key, value);
    }

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

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

    // indirectly adds projects to session
    // Keep projects that failed to load in the session!
    m_file->m_failedProjects = fileList;
    if (!fileList.isEmpty()) {
        QString errors;
        QList<Project *> projects = ProjectExplorerPlugin::instance()->openProjects(fileList, &errors);
        if (!errors.isEmpty())
            QMessageBox::critical(Core::ICore::mainWindow(), tr("Failed to open project"), errors);
        foreach (Project *p, projects)
            m_file->m_failedProjects.removeAll(p->file()->fileName());
    }

    m_file->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();
        if (m_file->m_failedProjects.contains(key))
            continue;
        QStringList values;
        foreach (const QString &value, i.value().toStringList()) {
            if (!m_file->m_failedProjects.contains(value))
                values << value;
        }
        m_file->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_file->m_projects) {
            if (QDir::cleanPath(pro->file()->fileName()) == startupProjectPath) {
                m_file->m_startupProject = pro;
                break;
            }
        }
        if (!m_file->m_startupProject)
            qWarning() << "Could not find startup project" << startupProjectPath;
    }

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

    m_file->future.reportFinished();

495 496 497 498
    // 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);

499
    QStringList failedProjects = m_file->m_failedProjects;
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
    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)
515
            m_file->m_failedProjects.clear();
con's avatar
con committed
516 517
    }

518 519 520 521
    // restore the active mode
    QString modeIdentifier = value(QLatin1String("ActiveMode")).toString();
    if (modeIdentifier.isEmpty())
        modeIdentifier = QLatin1String(Core::Constants::MODE_EDIT);
522

523 524
    ModeManager::activateMode(modeIdentifier);
    ModeManager::setFocusToCurrentMode();
525

526
    emit sessionLoaded();
con's avatar
con committed
527 528

    if (debug)
529
        qDebug() << "SessionManager - restoring session returned " << true;
con's avatar
con committed
530

531
    return true;
con's avatar
con committed
532 533 534 535 536 537 538 539 540
}

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

    emit aboutToSaveSession();

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
    PersistentSettingsWriter writer;

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

    QStringList projectFiles;
    foreach (Project *pro, m_file->m_projects)
        projectFiles << pro->file()->fileName();

    // Restore infromation on projects that failed to load:
    projectFiles.append(m_file->m_failedProjects);

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

    QMap<QString, QVariant> depMap;
    QMap<QString, QStringList>::const_iterator i = m_file->m_depMap.constBegin();
    while (i != m_file->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));
con's avatar
con committed
569

570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
    int editorCount = 0;
    QList<Core::IEditor *> editors = ICore::editorManager()->openedEditors();
    foreach (Core::IEditor *editor, editors) {
        Q_ASSERT(editor);
        if (!editor->isTemporary())
            ++editorCount;
    }
    writer.saveValue(QLatin1String("OpenEditors"), editorCount);
    writer.saveValue(QLatin1String("EditorSettings"),
                     ICore::editorManager()->saveState().toBase64());

    QMap<QString, QVariant>::const_iterator it, end;
    end = m_file->m_values.constEnd();
    QStringList keys;
    for (it = m_file->m_values.constBegin(); it != end; ++it) {
        writer.saveValue(QLatin1String("value-") + it.key(), it.value());
        keys << it.key();
    }

    writer.saveValue(QLatin1String("valueKeys"), keys);

    QString fileName = sessionNameToFileName(m_sessionName);
    bool result = writer.save(fileName, QLatin1String("QtCreatorSession"), Core::ICore::mainWindow());
con's avatar
con committed
593 594
    if (!result) {
        QMessageBox::warning(0, tr("Error while saving session"),
Daniel Teske's avatar
Daniel Teske committed
595
                                tr("Could not save session to file %1").arg(fileName));
con's avatar
con committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
    }

    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
615
    bool success = ICore::editorManager()->closeAllEditors();
con's avatar
con committed
616 617 618 619 620 621

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

        setStartupProject(0);
622
        removeProjects(projects());
con's avatar
con committed
623 624 625 626 627 628 629 630
    }

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

    return success;
}

631
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
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 666 667 668 669 670 671 672 673 674 675 676 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
{
    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
716
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
717 718 719 720 721 722 723 724 725 726 727 728

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

    return project;
}

dt's avatar
dt committed
729
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
730 731
{
    Node *node = 0;
dt's avatar
dt committed
732 733 734
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
        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 << ")";

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

755
    // Check current project first
756
    Project *currentProject = ProjectExplorerPlugin::currentProject();
757 758
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
759

760 761 762 763 764 765 766 767 768 769 770 771
    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
772 773
}

774
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
775
{
776 777 778
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor)) {
        Project *project = projectForFile(fileName);
        // Global settings are the default.
779 780
        if (project)
            project->editorConfiguration()->configureEditor(textEditor);
781
    }
con's avatar
con committed
782 783 784 785
}

void SessionManager::updateWindowTitle()
{
dt's avatar
dt committed
786
    if (isDefaultSession(m_sessionName)) {
787
        if (Project *currentProject = ProjectExplorerPlugin::currentProject())
hjk's avatar
hjk committed
788
            ICore::editorManager()->setWindowTitleAddition(currentProject->displayName());
789
        else
hjk's avatar
hjk committed
790
            ICore::editorManager()->setWindowTitleAddition(QString());
dt's avatar
dt committed
791
    } else {
con's avatar
con committed
792 793 794
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
hjk's avatar
hjk committed
795
        ICore::editorManager()->setWindowTitleAddition(sessionName);
796
    }
con's avatar
con committed
797 798 799 800 801 802 803 804
}

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

    foreach (Project *pro, remove) {
        if (debug)
805
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
        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;

831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
    // 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() << ")";
847
        m_sessionNode->removeProjectNodes(QList<ProjectNode *>() << pro->rootProjectNode());
848 849 850 851
        emit projectRemoved(pro);
        delete pro;
    }

con's avatar
con committed
852
    if (startupProject() == 0)
853 854
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
855 856
}

857 858 859 860
/*!
    \brief Let other plugins store persistent values within the session file.
*/

con's avatar
con committed
861 862
void SessionManager::setValue(const QString &name, const QVariant &value)
{
863 864 865 866 867 868
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
869
    markSessionFileDirty(false);
con's avatar
con committed
870 871 872 873
}

QVariant SessionManager::value(const QString &name)
{
874
    if (!m_file)
con's avatar
con committed
875
        return QVariant();
876 877
    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
878 879 880 881 882 883 884 885 886
}

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

QStringList SessionManager::sessions() const
{
887
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
888
        // We are not initialized yet, so do that now
hjk's avatar
hjk committed
889
        QDir sessionDir(Core::ICore::userResourcePath());
890 891
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
892
            if (fileInfo.completeBaseName() != QLatin1String("default"))
893 894
                m_sessions << fileInfo.completeBaseName();
        }
895
        m_sessions.prepend(QLatin1String("default"));
896 897
    }
    return m_sessions;
con's avatar
con committed
898 899
}

900
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
901
{
hjk's avatar
hjk committed
902
    return ICore::userResourcePath() + QLatin1Char('/') + session + QLatin1String(".qws");
con's avatar
con committed
903 904
}

905 906
QString SessionManager::sessionNameFromFileName(const QString &fileName) const
{
907 908
    const int slash = fileName.lastIndexOf(QLatin1Char('/'));
    Q_ASSERT(slash != -1 && fileName.endsWith(QLatin1String(".qws")));
909 910 911
    return fileName.mid(slash + 1, fileName.length() - slash - 5); // Exclude .qws
}

912 913 914 915
/*!
    \brief Just creates a new session (Does not actually create the file).
*/

con's avatar
con committed
916 917 918 919
bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
920 921
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
922 923 924
    return true;
}

925 926 927 928 929 930 931 932 933
bool SessionManager::renameSession(const QString &original, const QString &newName)
{
    if (!cloneSession(original, newName))
        return false;
    if (original == activeSession())
        loadSession(newName);
    return deleteSession(original);
}

934 935 936 937
/*!
     \brief Deletes session name from session list and file from disk.
*/

con's avatar
con committed
938 939
bool SessionManager::deleteSession(const QString &session)
{
940
    if (!m_sessions.contains(session))
con's avatar
con committed
941
        return false;
942
    m_sessions.removeOne(session);
con's avatar
con committed
943 944 945 946 947 948 949 950
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
951
    if (!m_sessions.contains(original))
con's avatar
con committed
952 953 954 955 956
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
957 958
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
959 960 961 962 963
        return true;
    }
    return false;
}

964 965 966 967
/*!
     \brief Loads a session, takes a session name (not filename).
*/

con's avatar
con committed
968 969 970 971 972 973 974 975 976 977
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;
978

con's avatar
con committed
979
    QString fileName = sessionNameToFileName(session);
980 981 982 983 984
    if (QFileInfo(fileName).exists())
        return loadImpl(fileName);

    // Create a new session with that name
    return createImpl(sessionNameToFileName(session));
con's avatar
con committed
985 986 987 988
}

QString SessionManager::lastSession() const
{
hjk's avatar
hjk committed
989
    QString fileName = ICore::settings()->value(QLatin1String("ProjectExplorer/StartupSession")).toString();
990
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
991 992 993 994 995 996 997 998 999 1000 1001 1002
}

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

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

1003
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1004
{
1005
    m_autoSaveSessionTimer->start();
1006
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1007
        m_virginSession = false;
1008
}
con's avatar
con committed
1009 1010

#include "session.moc"