session.cpp 31.6 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) 2010 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
** Commercial Usage
10
**
11
12
13
14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
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
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29
30
31

#include "session.h"

con's avatar
con committed
32
33
34
35
36
#include "project.h"
#include "projectexplorer.h"
#include "projectexplorerconstants.h"
#include "nodesvisitor.h"
#include "editorconfiguration.h"
37
#include "persistentsettings.h"
con's avatar
con committed
38
39
40
41
42
43

#include <coreplugin/icore.h>
#include <coreplugin/imode.h>
#include <coreplugin/filemanager.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
44
#include <coreplugin/progressmanager/progressmanager.h>
con's avatar
con committed
45
46
47
48
#include <coreplugin/modemanager.h>

#include <texteditor/itexteditor.h>

hjk's avatar
hjk committed
49
50
51
#include <utils/listutils.h>
#include <utils/qtcassert.h>

con's avatar
con committed
52
#include <QtCore/QDebug>
hjk's avatar
hjk committed
53
#include <QtCore/QDir>
con's avatar
con committed
54
55
#include <QtCore/QFileInfo>
#include <QtCore/QFuture>
hjk's avatar
hjk committed
56
#include <QtCore/QSettings>
57
#include <QtCore/QTimer>
hjk's avatar
hjk committed
58

59
#include <QtGui/QApplication>
con's avatar
con committed
60
#include <QtGui/QMainWindow>
hjk's avatar
hjk committed
61
#include <QtGui/QMessageBox>
62
#include <QtCore/QTextCodec>
con's avatar
con committed
63
64
65
66
67
68
69
70
71

namespace {
    bool debug = false;
}

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

dt's avatar
dt committed
72
class SessionFile : QObject
con's avatar
con committed
73
74
75
76
{
    Q_OBJECT

public:
hjk's avatar
hjk committed
77
    SessionFile();
con's avatar
con committed
78
79
80
81
82
83
84

    bool load(const QString &fileName);
    bool save(const QString &fileName = QString());

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

85
86
    QStringList failedProjectFileNames() const;

con's avatar
con committed
87
88
89
90
91
92
93
94
95
public slots:
    void sessionLoadingProgress();

private:
    Core::ICore *m_core;

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

    QMap<QString, QVariant> m_values;

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

} // namespace Internal
} // namespace ProjectExplorer

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


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

hjk's avatar
hjk committed
118
SessionFile::SessionFile()
dt's avatar
dt committed
119
  : m_core(Core::ICore::instance()),
con's avatar
con committed
120
121
122
123
124
125
    m_startupProject(0)
{
}

bool SessionFile::load(const QString &fileName)
{
dt's avatar
dt committed
126
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

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

    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();
    QString configDir = QFileInfo(m_core->settings()->fileName()).path();
    QMutableStringListIterator it(fileList);
    while (it.hasNext()) {
        const QString &file = it.next();
        if (QFileInfo(file).isRelative()) {
            // We used to write relative paths into the session file
            // relative to the session files, and those were stored in the
            // config dir
163
            it.setValue(configDir + QLatin1Char('/') + file);
con's avatar
con committed
164
165
166
167
168
169
170
171
172
        }
    }

    int openEditorsCount = reader.restoreValue(QLatin1String("OpenEditors")).toInt();

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

    // indirectly adds projects to session
173
174
175
176
177
178
179
    // 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
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
224
225
226
227
228
229
230
231
232
233

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

bool SessionFile::save(const QString &fileName)
{
    if (!fileName.isEmpty())
        m_fileName = fileName;

dt's avatar
dt committed
234
    Q_ASSERT(!m_fileName.isEmpty());
con's avatar
con committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

    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();
    }
250
251
    // Restore infromation on projects that failed to load:
    projectFiles.append(m_failedProjects);
con's avatar
con committed
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267

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

268

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
299
300
    writer.saveValue(QLatin1String("OpenEditors"),
                     m_core->editorManager()->openedEditors().count());
    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;
}

301
302
303
304
305
QStringList SessionFile::failedProjectFileNames() const
{
    return m_failedProjects;
}

con's avatar
con committed
306
Internal::SessionNodeImpl::SessionNodeImpl(SessionManager *manager)
dt's avatar
dt committed
307
        : ProjectExplorer::SessionNode(manager->currentSession(), manager)
con's avatar
con committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
{
    setFileName("session");
}

void Internal::SessionNodeImpl::addProjectNode(ProjectNode *projectNode)
{
    addProjectNodes(QList<ProjectNode*>() << projectNode);
}

void Internal::SessionNodeImpl::removeProjectNode(ProjectNode *projectNode)
{
    removeProjectNodes(QList<ProjectNode*>() << projectNode);
}

void Internal::SessionNodeImpl::setFileName(const QString &fileName)
{
    setPath(fileName);
325
    setDisplayName(fileName);
con's avatar
con committed
326
327
328
329
}

/* --------------------------------- */

hjk's avatar
hjk committed
330
331
332
333
SessionManager::SessionManager(QObject *parent)
  : QObject(parent),
    m_core(Core::ICore::instance()),
    m_file(new SessionFile),
334
    m_sessionNode(new Internal::SessionNodeImpl(this)),
335
    m_currentEditor(0),
dt's avatar
dt committed
336
    m_virginSession(true)
con's avatar
con committed
337
338
339
340
341
342
343
344
345
346
{
    // Create qtcreator dir if it doesn't yet exist
    QString configDir = QFileInfo(m_core->settings()->fileName()).path();

    QFileInfo fi(configDir + "/qtcreator/");
    if (!fi.exists()) {
        QDir dir;
        dir.mkpath(configDir + "/qtcreator");

        // Move sessions to that directory
hjk's avatar
hjk committed
347
        foreach (const QString &session, sessions()) {
348
            QFile file(configDir + QLatin1Char('/') + session + QLatin1String(".qws"));
con's avatar
con committed
349
            if (file.exists())
350
                if (file.copy(configDir + QLatin1String("/qtcreator/") + session + QLatin1String(".qws")))
con's avatar
con committed
351
352
353
354
355
356
                    file.remove();
        }
    }

    connect(m_core->modeManager(), SIGNAL(currentModeChanged(Core::IMode*)),
            this, SLOT(saveActiveMode(Core::IMode*)));
357
358
359
360

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

    connect(em, SIGNAL(editorCreated(Core::IEditor *, QString)),
con's avatar
con committed
361
362
363
            this, SLOT(setEditorCodec(Core::IEditor *, QString)));
    connect(ProjectExplorerPlugin::instance(), SIGNAL(currentProjectChanged(ProjectExplorer::Project *)),
            this, SLOT(updateWindowTitle()));
364
365
366
    connect(em, SIGNAL(currentEditorChanged(Core::IEditor*)),
            this, SLOT(handleCurrentEditorChange(Core::IEditor*)));
    connect(em, SIGNAL(currentEditorChanged(Core::IEditor*)),
367
            this, SLOT(handleCurrentEditorChange(Core::IEditor*)));
368
369
370
371
372
373
374
375
376
377
378
    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
379
}
con's avatar
con committed
380
381
382

SessionManager::~SessionManager()
{
383
    emit aboutToUnloadSession();
con's avatar
con committed
384
385
386
387
388
389
    delete m_file;
}


bool SessionManager::isDefaultVirgin() const
{
dt's avatar
dt committed
390
391
    return isDefaultSession(m_sessionName)
            && m_virginSession;
con's avatar
con committed
392
393
394
395
}

bool SessionManager::isDefaultSession(const QString &session) const
{
hjk's avatar
hjk committed
396
    return session == QLatin1String("default");
con's avatar
con committed
397
398
399
400
401
}


void SessionManager::saveActiveMode(Core::IMode *mode)
{
402
    setValue(QLatin1String("ActiveMode"), mode->id());
con's avatar
con committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
}

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

429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/*
 * 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
451
452
453
454
455
456
457
458
{
    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);
}

459
bool SessionManager::canAddDependency(const Project *project, const Project *depProject) const
con's avatar
con committed
460
461
462
463
464
465
466
{
    const QString &newDep = project->file()->fileName();
    const QString &checkDep = depProject->file()->fileName();

    return recursiveDependencyCheck(newDep, checkDep);
}

dt's avatar
dt committed
467
bool SessionManager::addDependency(Project *project, Project *depProject)
con's avatar
con committed
468
469
470
471
472
473
474
475
476
477
478
479
480
{
    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
481
    emit dependencyChanged(project, depProject);
con's avatar
con committed
482
483
484
485

    return true;
}

dt's avatar
dt committed
486
void SessionManager::removeDependency(Project *project, Project *depProject)
487
488
489
490
491
492
493
494
495
496
497
{
    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
498
    emit dependencyChanged(project, depProject);
499
500
}

con's avatar
con committed
501
502
503
void SessionManager::setStartupProject(Project *startupProject)
{
    if (debug)
504
        qDebug() << Q_FUNC_INFO << (startupProject ? startupProject->displayName() : "0");
con's avatar
con committed
505
506

    if (startupProject) {
dt's avatar
dt committed
507
        Q_ASSERT(m_file->m_projects.contains(startupProject));
con's avatar
con committed
508
509
    }

510
511
512
    if (m_file->m_startupProject == startupProject)
        return;

con's avatar
con committed
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
    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
529
    m_virginSession = false;
con's avatar
con committed
530
531
532
533
534
535
536
537
538
539
540
    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)
541
                qDebug() << "SessionManager - adding project " << pro->displayName();
con's avatar
con committed
542
543
544
545
546
547
548
549
550
551
552
553
        }
    }

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

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

    // maybe we have a new startup project?
    if (!startupProject())
554
555
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
556
557
558
559
}

void SessionManager::removeProject(Project *project)
{
dt's avatar
dt committed
560
    m_virginSession = false;
con's avatar
con committed
561
562
563
564
565
566
567
568
569
    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
570
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
571
572
573
574
575
576
577

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

    bool success = true;

    if (!m_file->fileName().isEmpty()) {
hjk's avatar
hjk committed
578
        if (!save() || !clear())
con's avatar
con committed
579
580
581
582
            success = false;
    }

    if (success) {
583
        emit aboutToUnloadSession();
con's avatar
con committed
584
        delete m_file;
hjk's avatar
hjk committed
585
        m_file = new SessionFile;
con's avatar
con committed
586
        m_file->setFileName(fileName);
587
        setStartupProject(0);
con's avatar
con committed
588
589
    }

dt's avatar
dt committed
590
    m_virginSession = true;
591

con's avatar
con committed
592
593
594
595
596
597
598
599
600
601
602
    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
603
    Q_ASSERT(!fileName.isEmpty());
con's avatar
con committed
604
605

    if (debug)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
606
        qDebug() << "SessionManager - restoring session " << fileName << " ...";
con's avatar
con committed
607
608
609
610
611
612
613
614
615
616
617

    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
618
    m_virginSession = false;
619

con's avatar
con committed
620
    if (success) {
621
        emit aboutToUnloadSession();
con's avatar
con committed
622
        delete m_file;
hjk's avatar
hjk committed
623
        m_file = new SessionFile;
con's avatar
con committed
624
        if (!m_file->load(fileName)) {
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
625
626
            QMessageBox::warning(0, tr("Error while restoring session"),
                                    tr("Could not restore session %1").arg(fileName));
con's avatar
con committed
627
628
            success = false;
        }
629
630
631
        // 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);
con's avatar
con committed
632
633
634
635
636
    }

    if (success) {
        // restore the active mode
        const QString &modeIdentifier = value(QLatin1String("ActiveMode")).toString();
637
        if (!modeIdentifier.isEmpty()) {
con's avatar
con committed
638
            m_core->modeManager()->activateMode(modeIdentifier);
639
640
            m_core->modeManager()->setFocusToCurrentMode();
        }
con's avatar
con committed
641
642
643
    }

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

    if (success)
        emit sessionLoaded();

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

683
    bool success = m_core->editorManager()->closeAllEditors();
con's avatar
con committed
684
685
686
687
688
689

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

        setStartupProject(0);
690
        removeProjects(projects());
con's avatar
con committed
691
692
693
694
695
696
697
698
    }

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

    return success;
}

699
const QList<Project *> &SessionManager::projects() const
con's avatar
con committed
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
{
    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
784
    Q_ASSERT(rootProjectNode);
con's avatar
con committed
785
786
787
788
789
790
791
792
793
794
795
796

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

    return project;
}

dt's avatar
dt committed
797
Node *SessionManager::nodeForFile(const QString &fileName, Project *project) const
con's avatar
con committed
798
799
{
    Node *node = 0;
dt's avatar
dt committed
800
801
802
    if (!project)
        project = projectForFile(fileName);
    if (project) {
con's avatar
con committed
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
        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 << ")";

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

823
824
825
826
    // Check current project first
    Project *currentProject = ProjectExplorerPlugin::instance()->currentProject();
    if (currentProject && projectContainsFile(currentProject, fileName))
        return currentProject;
con's avatar
con committed
827

828
829
830
831
832
833
834
835
836
837
838
839
    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
840
841
842
843
844
}

void SessionManager::setEditorCodec(Core::IEditor *editor, const QString &fileName)
{
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor*>(editor))
845
846
847
848
        if (Project *project = projectForFile(fileName)) {
            if (QTextCodec *codec = project->editorConfiguration()->defaultTextCodec())
                textEditor->setTextCodec(codec);
        }
con's avatar
con committed
849
850
}

dt's avatar
dt committed
851
QString SessionManager::currentSession() const
con's avatar
con committed
852
{
dt's avatar
dt committed
853
    return m_file->fileName();
con's avatar
con committed
854
855
}

856
857
858
859
860
861
862
863
864
865
866
867
void SessionManager::handleCurrentEditorChange(Core::IEditor *editor)
{
    if (editor != m_currentEditor) {
        if (m_currentEditor)
            disconnect(m_currentEditor, SIGNAL(changed()), this, SLOT(updateWindowTitle()));
        if (editor)
            connect(editor, SIGNAL(changed()), this, SLOT(updateWindowTitle()));
        m_currentEditor = editor;
    }
    updateWindowTitle();
}

con's avatar
con committed
868
869
870
871
872
873
874
875
876
877
void SessionManager::updateWindowTitle()
{
    QString windowTitle = tr("Qt Creator");
    if (!isDefaultSession(m_sessionName)) {
        QString sessionName = m_sessionName;
        if (sessionName.isEmpty())
            sessionName = tr("Untitled");
        windowTitle.prepend(sessionName + " - ");
    } else {
        if (Project *currentProject = ProjectExplorerPlugin::instance()->currentProject())
878
            windowTitle.prepend(currentProject->displayName() + " - ");
con's avatar
con committed
879
    }
880
881
    if (m_core->editorManager()->currentEditor()) {
        QFileInfo fi(m_core->editorManager()->currentEditor()->file()->fileName());
882
883
        QString fileName = fi.fileName();
        if (!fileName.isEmpty())
884
            windowTitle.prepend(fileName + " - ");
885
886
887
888
        m_core->mainWindow()->setWindowFilePath(fi.absoluteFilePath());
    } else {
        m_core->mainWindow()->setWindowFilePath(QString());
    }
con's avatar
con committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
    m_core->mainWindow()->setWindowTitle(windowTitle);
}

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

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

    m_displayName = tr("Session (\'%1\')").arg(sessionName);
    updateWindowTitle();
}


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

    foreach (Project *pro, remove) {
        if (debug)
911
            qDebug() << "SessionManager - emitting aboutToRemoveProject(" << pro->displayName() << ")";
con's avatar
con committed
912
913
914
915
916
917
918
        emit aboutToRemoveProject(pro);
    }

    // TODO: Clear m_modelProjectHash

    // Delete projects
    foreach (Project *pro, remove) {
dt's avatar
dt committed
919
        pro->saveSettings();
con's avatar
con committed
920
921
922
923
924
925
926
927
928
929
        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)
930
            qDebug() << "SessionManager - emitting projectRemoved(" << pro->displayName() << ")";
con's avatar
con committed
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
        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)
958
959
        if (!m_file->m_projects.isEmpty())
            setStartupProject(m_file->m_projects.first());
con's avatar
con committed
960
961
962
963
}

void SessionManager::setValue(const QString &name, const QVariant &value)
{
964
965
966
967
968
969
    if (!m_file)
        return;

    if (m_file->m_values.value(name) == value)
        return;
    m_file->m_values.insert(name, value);
970
    markSessionFileDirty(false);
con's avatar
con committed
971
972
973
974
}

QVariant SessionManager::value(const QString &name)
{
975
    if (!m_file)
con's avatar
con committed
976
        return QVariant();
977
978
    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
979
980
981
982
983
984
985
986
987
}

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

QStringList SessionManager::sessions() const
{
988
    if (m_sessions.isEmpty()) {
Tobias Hunger's avatar
Tobias Hunger committed
989
        // We are not initialized yet, so do that now
990
991
992
993
        QDir sessionDir(QFileInfo(m_core->settings()->fileName()).path()+ "/qtcreator/");
        QList<QFileInfo> sessionFiles = sessionDir.entryInfoList(QStringList() << QLatin1String("*.qws"), QDir::NoFilter, QDir::Time);
        Q_FOREACH(const QFileInfo& fileInfo, sessionFiles) {
            if (fileInfo.completeBaseName() != "default")
994
995
996
997
998
                m_sessions << fileInfo.completeBaseName();
        }
        m_sessions.prepend("default");
    }
    return m_sessions;
con's avatar
con committed
999
1000
1001
1002
}

QString SessionManager::sessionNameToFileName(const QString &session)
{
1003
    return m_core->userResourcePath() + '/' + session + ".qws";
con's avatar
con committed
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
}

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

bool SessionManager::createSession(const QString &session)
{
    if (sessions().contains(session))
        return false;
1016
1017
    Q_ASSERT(m_sessions.size() > 0);
    m_sessions.insert(1, session);
con's avatar
con committed
1018
1019
1020
    return true;
}

1021
1022
1023
1024
1025
1026
1027
1028
1029
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
1030
1031
bool SessionManager::deleteSession(const QString &session)
{
1032
    if (!m_sessions.contains(session))
con's avatar
con committed
1033
        return false;
1034
    m_sessions.removeOne(session);
con's avatar
con committed
1035
1036
1037
1038
1039
1040
1041
1042
    QFile fi(sessionNameToFileName(session));
    if (fi.exists())
        return fi.remove();
    return false;
}

bool SessionManager::cloneSession(const QString &original, const QString &clone)
{
1043
    if (!m_sessions.contains(original))
con's avatar
con committed
1044
1045
1046
1047
1048
        return false;

    QFile fi(sessionNameToFileName(original));
    // If the file does not exist, we can still clone
    if (!fi.exists() || fi.copy(sessionNameToFileName(clone))) {
1049
1050
        Q_ASSERT(m_sessions.size() > 0);
        m_sessions.insert(1, clone);
con's avatar
con committed
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
        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);
            return true;
        }
    } else {
        // Create a new session with that name
hjk's avatar
hjk committed
1074
        if (!createImpl(sessionNameToFileName(session)))
con's avatar
con committed
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
            return false;
        updateName(session);
        return true;
    }
    return false;
}

QString SessionManager::lastSession() const
{
    QSettings *settings = m_core->settings();
    QString fileName = settings->value("ProjectExplorer/StartupSession").toString();
1086
    return QFileInfo(fileName).completeBaseName();
con's avatar
con committed
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
}

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

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

1099
void SessionManager::markSessionFileDirty(bool makeDefaultVirginDirty)
1100
{
1101
1102
    if (m_file && !m_file->fileName().isEmpty())
        m_autoSaveSessionTimer->start();
1103
    if (makeDefaultVirginDirty)
dt's avatar
dt committed
1104
        m_virginSession = false;
1105
}
con's avatar
con committed
1106
1107

#include "session.moc"