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
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11
12
13
14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** Alternatively, 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.
24
**
con's avatar
con committed
25
26
27
28
29
30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33
34

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

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

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

#include <texteditor/itexteditor.h>

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

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

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

namespace {
    bool debug = false;
}

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

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

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

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

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

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

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

private:
    Core::ICore *m_core;

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

    QMap<QString, QVariant> m_values;

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

} // namespace Internal
} // namespace ProjectExplorer

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

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

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

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

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

    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
168
169
170
171
172
173
174
    // 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
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
223

    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
224
bool SessionFile::save()
con's avatar
con committed
225
{
dt's avatar
dt committed
226
    Q_ASSERT(!m_fileName.isEmpty());
con's avatar
con committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

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

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

260

261
262
263
264
265
266
267
268
    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
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
298
    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;
}

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

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

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

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

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

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

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


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

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


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

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

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

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

    return recursiveDependencyCheck(newDep, checkDep);
}

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

    return true;
}

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

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

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

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

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

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

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

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

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

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

    bool success = true;

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

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

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

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

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

    if (success)
        emit sessionLoaded();

    return success;
}

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

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

    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
582
    m_virginSession = false;
583

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

        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
615
616
617
618
    }

    if (success) {
        // restore the active mode
619
620
621
622
623
624
        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
625
626
627
    }

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
628
        qDebug() << "SessionManager - restoring session returned " << success;
con's avatar
con committed
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
660
661
662
663

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

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

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

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

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

    return success;
}

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

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

    return project;
}

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

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

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

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

823
void SessionManager::configureEditor(Core::IEditor *editor, const QString &fileName)
con's avatar
con committed
824
{
825
826
827
828
829
    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);
830
        }
831
    }
con's avatar
con committed
832
833
}

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

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

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)
872
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
873
874
875
876
877
878
879
        emit aboutToRemoveProject(pro);
    }

    // TODO: Clear m_modelProjectHash

    // Delete projects
    foreach (Project *pro, remove) {
dt's avatar
dt committed
880
        pro->saveSettings();
con's avatar
con committed
881
882
883
884
885
886
887
888
889
890
        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)
891
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
con's avatar
con committed
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
        m_sessionNode->removeProjectNode(pro->rootProjectNode());
        emit projectRemoved(pro);
        delete 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;

    if (startupProject() == 0)
919
920
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
921
922
923
924
}

void SessionManager::setValue(const QString &name, const QVariant &value)
{
925
926
927
928
929
930
    if (!m_file)
        return;

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

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

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

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

962
QString SessionManager::sessionNameToFileName(const QString &session) const
con's avatar
con committed
963
{
964
    return m_core->userResourcePath() + '/' + session + ".qws";
con's avatar
con committed
965
966
967
968
969
970
971
972
973
974
975
976
}

void SessionManager::createAndLoadNewDefaultSession()
{
    updateName("default");
    createImpl(sessionNameToFileName(m_sessionName));
}

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

982
983
984
985
986
987
988
989
990
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
991
992
bool SessionManager::deleteSession(const QString &session)
{
993
    if (!m_sessions.contains(session))
con's avatar
con committed
994
        return false;
995
    m_sessions.removeOne(session);
con's avatar
con committed
996
997
998
999
1000
1001
1002
1003
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

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

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1010
1011
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
        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;
    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"