cppmodelmanager.cpp 32.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "cppmodelmanager.h"
31

32
#include "abstracteditorsupport.h"
33
#include "builtinindexingsupport.h"
34
#include "cppcodemodelsettings.h"
35
#include "cppfindreferences.h"
36
#include "cpphighlightingsupport.h"
37
#include "cppindexingsupport.h"
38
#include "cppmodelmanagersupportinternal.h"
39
40
#include "cpppreprocessor.h"
#include "cpptoolsconstants.h"
41
#include "cpptoolseditorsupport.h"
42
#include "cpptoolsplugin.h"
con's avatar
con committed
43

44
45
#include <coreplugin/icore.h>
#include <coreplugin/progressmanager/progressmanager.h>
46
47
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
48
#include <extensionsystem/pluginmanager.h>
hjk's avatar
hjk committed
49
#include <utils/qtcassert.h>
con's avatar
con committed
50

51
52
53
54
#include <QCoreApplication>
#include <QDebug>
#include <QMutexLocker>
#include <QTextBlock>
55
#include <QTimer>
56

57
58
#if defined(QTCREATOR_WITH_DUMP_AST) && defined(Q_CC_GNU)
#define WITH_AST_DUMP
59
60
#include <iostream>
#include <sstream>
61
#endif
hjk's avatar
hjk committed
62

63
namespace CppTools {
64

65
uint qHash(const ProjectPart &p)
66
{
67
    uint h = qHash(p.defines) ^ p.cVersion ^ p.cxxVersion ^ p.cxxExtensions ^ p.qtVersion;
68
69
70
71
72
73
74
75
76

    foreach (const QString &i, p.includePaths)
        h ^= qHash(i);

    foreach (const QString &f, p.frameworkPaths)
        h ^= qHash(f);

    return h;
}
77

78
79
bool operator==(const ProjectPart &p1,
                const ProjectPart &p2)
80
81
82
{
    if (p1.defines != p2.defines)
        return false;
83
84
85
86
87
    if (p1.cVersion != p2.cVersion)
        return false;
    if (p1.cxxVersion != p2.cxxVersion)
        return false;
    if (p1.cxxExtensions != p2.cxxExtensions)
88
        return false;
89
    if (p1.qtVersion!= p2.qtVersion)
90
91
92
93
94
        return false;
    if (p1.includePaths != p2.includePaths)
        return false;
    return p1.frameworkPaths == p2.frameworkPaths;
}
95

96
} // namespace CppTools
97

98
99
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
100
101
using namespace CPlusPlus;

102
#ifdef QTCREATOR_WITH_DUMP_AST
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

#include <cxxabi.h>

class DumpAST: protected ASTVisitor
{
public:
    int depth;

    DumpAST(Control *control)
        : ASTVisitor(control), depth(0)
    { }

    void operator()(AST *ast)
    { accept(ast); }

protected:
    virtual bool preVisit(AST *ast)
    {
        std::ostringstream s;
        PrettyPrinter pp(control(), s);
        pp(ast);
        QString code = QString::fromStdString(s.str());
        code.replace('\n', ' ');
        code.replace(QRegExp("\\s+"), " ");

        const char *name = abi::__cxa_demangle(typeid(*ast).name(), 0, 0, 0) + 11;

        QByteArray ind(depth, ' ');
        ind += name;

        printf("%-40s %s\n", ind.constData(), qPrintable(code));
        ++depth;
        return true;
    }

    virtual void postVisit(AST *)
    { --depth; }
};

Roberto Raggi's avatar
Roberto Raggi committed
142
#endif // QTCREATOR_WITH_DUMP_AST
143

con's avatar
con committed
144
145
static const char pp_configuration[] =
    "# 1 \"<configuration>\"\n"
146
    "#define Q_CREATOR_RUN 1\n"
con's avatar
con committed
147
148
149
150
151
152
    "#define __cplusplus 1\n"
    "#define __extension__\n"
    "#define __context__\n"
    "#define __range__\n"
    "#define   restrict\n"
    "#define __restrict\n"
153
    "#define __restrict__\n"
con's avatar
con committed
154

155
156
157
158
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

159
160
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
161
162
    // ### add macros for win32
    "#define __cdecl\n"
163
    "#define __stdcall\n"
con's avatar
con committed
164
165
166
167
168
    "#define QT_WA(x) x\n"
    "#define CALLBACK\n"
    "#define STDMETHODCALLTYPE\n"
    "#define __RPC_FAR\n"
    "#define __declspec(a)\n"
169
170
171
    "#define STDMETHOD(method) virtual HRESULT STDMETHODCALLTYPE method\n"
    "#define __try try\n"
    "#define __except catch\n"
172
173
174
    "#define __finally\n"
    "#define __inline inline\n"
    "#define __forceinline inline\n";
con's avatar
con committed
175

176
QStringList CppModelManager::timeStampModifiedFiles(const QList<Document::Ptr> documentsToCheck)
177
178
179
{
    QStringList sourceFiles;

180
    foreach (const Document::Ptr doc, documentsToCheck) {
181
182
        const QDateTime lastModified = doc->lastModified();

183
        if (!lastModified.isNull()) {
184
185
186
187
188
189
190
            QFileInfo fileInfo(doc->fileName());

            if (fileInfo.exists() && fileInfo.lastModified() != lastModified)
                sourceFiles.append(doc->fileName());
        }
    }

191
192
193
194
195
196
197
198
199
200
201
202
    return sourceFiles;
}

void CppModelManager::updateModifiedSourceFiles()
{
    const Snapshot snapshot = this->snapshot();
    QList<Document::Ptr> documentsToCheck;
    foreach (const Document::Ptr document, snapshot)
        documentsToCheck << document;

    const QStringList filesToUpdate = timeStampModifiedFiles(documentsToCheck);
    updateSourceFiles(filesToUpdate);
203
204
}

con's avatar
con committed
205
206
/*!
    \class CppTools::CppModelManager
207
208
209
    \brief The CppModelManager keeps tracks of the source files the code model is aware of.

    The CppModelManager manages the source files in a Snapshot object.
con's avatar
con committed
210

211
212
213
214
    The snapshot is updated in case e.g.
        * New files are opened/edited (Editor integration)
        * A project manager pushes updated project information (Project integration)
        * Files are garbage collected
con's avatar
con committed
215
216
*/

217
218
QMutex CppModelManager::m_instanceMutex;
CppModelManager *CppModelManager::m_instance = 0;
219
220
221

CppModelManager *CppModelManager::instance()
{
222
223
224
225
226
227
228
229
    if (m_instance)
        return m_instance;

    QMutexLocker locker(&m_instanceMutex);
    if (!m_instance)
        m_instance = new CppModelManager;

    return m_instance;
230
231
}

232
CppModelManager::CppModelManager(QObject *parent)
233
    : CppModelManagerInterface(parent)
234
    , m_indexingSupporter(0)
235
    , m_enableGC(true)
con's avatar
con committed
236
{
Erik Verbruggen's avatar
Erik Verbruggen committed
237
238
239
240
241
    connect(this, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            this, SIGNAL(globalSnapshotChanged()));
    connect(this, SIGNAL(aboutToRemoveFiles(QStringList)),
            this, SIGNAL(globalSnapshotChanged()));

Roberto Raggi's avatar
Roberto Raggi committed
242
    m_findReferences = new CppFindReferences(this);
243
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
244

245
246
    m_dirty = true;

247
248
249
250
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

hjk's avatar
hjk committed
251
252
    QObject *sessionManager = ProjectExplorer::SessionManager::instance();
    connect(sessionManager, SIGNAL(projectAdded(ProjectExplorer::Project*)),
253
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
254
    connect(sessionManager, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
Robert Loehning's avatar
Robert Loehning committed
255
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
256
    connect(sessionManager, SIGNAL(aboutToLoadSession(QString)),
257
            this, SLOT(onAboutToLoadSession()));
hjk's avatar
hjk committed
258
    connect(sessionManager, SIGNAL(aboutToUnloadSession(QString)),
259
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
260

261
262
263
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

con's avatar
con committed
264
265
    qRegisterMetaType<CPlusPlus::Document::Ptr>("CPlusPlus::Document::Ptr");

266
    m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
267
268
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
                m_modelManagerSupportFallback->id());
269
270
    addModelManagerSupport(m_modelManagerSupportFallback.data());

271
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
272
273
274
}

CppModelManager::~CppModelManager()
275
{
276
    delete m_internalIndexingSupport;
277
}
con's avatar
con committed
278

279
Snapshot CppModelManager::snapshot() const
280
{
281
    QMutexLocker locker(&m_snapshotMutex);
282
283
    return m_snapshot;
}
con's avatar
con committed
284

285
286
Document::Ptr CppModelManager::document(const QString &fileName) const
{
287
    QMutexLocker locker(&m_snapshotMutex);
288
289
290
291
292
293
294
295
    return m_snapshot.document(fileName);
}

/// Replace the document in the snapshot.
///
/// \returns true if successful, false if the new document is out-dated.
bool CppModelManager::replaceDocument(Document::Ptr newDoc)
{
296
    QMutexLocker locker(&m_snapshotMutex);
297
298
299
300
301
302
303
304
305
306

    Document::Ptr previous = m_snapshot.document(newDoc->fileName());
    if (previous && (newDoc->revision() != 0 && newDoc->revision() < previous->revision()))
        // the new document is outdated
        return false;

    m_snapshot.insert(newDoc);
    return true;
}

307
308
void CppModelManager::ensureUpdated()
{
309
    QMutexLocker locker(&m_projectMutex);
310
    if (!m_dirty)
311
312
        return;

313
314
315
316
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
317
318
319
    m_dirty = false;
}

320
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
321
322
{
    QStringList files;
323
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
324
325
    while (it.hasNext()) {
        it.next();
326
        const ProjectInfo pinfo = it.value();
327
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
328
329
            foreach (const ProjectFile &file, part->files)
                files += file.path;
330
        }
con's avatar
con committed
331
    }
332
    files.removeDuplicates();
con's avatar
con committed
333
334
335
    return files;
}

336
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
337
338
{
    QStringList includePaths;
339
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
340
341
    while (it.hasNext()) {
        it.next();
342
        const ProjectInfo pinfo = it.value();
343
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
344
345
            foreach (const QString &path, part->includePaths)
                includePaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
346
    }
347
    includePaths.removeDuplicates();
con's avatar
con committed
348
349
350
    return includePaths;
}

351
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
352
353
{
    QStringList frameworkPaths;
354
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
355
356
    while (it.hasNext()) {
        it.next();
357
        const ProjectInfo pinfo = it.value();
358
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
359
360
            foreach (const QString &path, part->frameworkPaths)
                frameworkPaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
361
    }
362
    frameworkPaths.removeDuplicates();
con's avatar
con committed
363
364
365
    return frameworkPaths;
}

366
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
367
368
{
    QByteArray macros;
369
    QSet<QByteArray> alreadyIn;
370
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
371
372
    while (it.hasNext()) {
        it.next();
373
        const ProjectInfo pinfo = it.value();
374
375
376
377
378
379
380
381
382
383
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            const QList<QByteArray> defs = part->defines.split('\n');
            foreach (const QByteArray &def, defs) {
                if (!alreadyIn.contains(def)) {
                    macros += def;
                    macros.append('\n');
                    alreadyIn.insert(def);
                }
            }
        }
con's avatar
con committed
384
385
386
387
    }
    return macros;
}

388
/// This function will aquire the mutex!
389
390
391
void CppModelManager::dumpModelManagerConfiguration()
{
    // Tons of debug output...
392
393
    qDebug() << "========= CppModelManager::dumpModelManagerConfiguration ======";
    foreach (const ProjectInfo &pinfo, m_projectToProjectsInfo) {
394
        qDebug() << " for project:"<< pinfo.project().data()->projectFilePath();
395
396
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            qDebug() << "=== part ===";
397
398
399
400
401
402
403
            const char* cVersion;
            switch (part->cVersion) {
            case ProjectPart::C89: cVersion = "C89"; break;
            case ProjectPart::C99: cVersion = "C99"; break;
            case ProjectPart::C11: cVersion = "C11"; break;
            default: cVersion = "INVALID";
            }
404
            const char* cxxVersion;
405
            switch (part->cxxVersion) {
406
407
            case ProjectPart::CXX98: cxxVersion = "CXX98"; break;
            case ProjectPart::CXX11: cxxVersion = "CXX11"; break;
408
409
            default: cxxVersion = "INVALID";
            }
410
411
412
413
414
415
416
            QStringList cxxExtensions;
            if (part->cxxExtensions & ProjectPart::GnuExtensions)
                cxxExtensions << QLatin1String("GnuExtensions");
            if (part->cxxExtensions & ProjectPart::MicrosoftExtensions)
                cxxExtensions << QLatin1String("MicrosoftExtensions");
            if (part->cxxExtensions & ProjectPart::BorlandExtensions)
                cxxExtensions << QLatin1String("BorlandExtensions");
417
            if (part->cxxExtensions & ProjectPart::OpenMPExtensions)
418
                cxxExtensions << QLatin1String("OpenMP");
419

420
421
422
            qDebug() << "cVersion:" << cVersion;
            qDebug() << "cxxVersion:" << cxxVersion;
            qDebug() << "cxxExtensions:" << cxxExtensions;
423
424
425
426
427
            qDebug() << "Qt version:" << part->qtVersion;
            qDebug() << "precompiled header:" << part->precompiledHeaders;
            qDebug() << "defines:" << part->defines;
            qDebug() << "includes:" << part->includePaths;
            qDebug() << "frameworkPaths:" << part->frameworkPaths;
428
            qDebug() << "files:" << part->files;
429
430
431
432
433
434
435
436
437
438
439
440
441
            qDebug() << "";
        }
    }

    ensureUpdated();
    qDebug() << "=== Merged include paths ===";
    foreach (const QString &inc, m_includePaths)
        qDebug() << inc;
    qDebug() << "=== Merged framework paths ===";
    foreach (const QString &inc, m_frameworkPaths)
        qDebug() << inc;
    qDebug() << "=== Merged defined macros ===";
    qDebug() << m_definedMacros;
442
    qDebug() << "========= End of dump ======";
443
444
}

445
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
446
{
447
    m_extraEditorSupports.insert(editorSupport);
448
449
}

450
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
451
{
452
    m_extraEditorSupports.remove(editorSupport);
453
454
}

455
456
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
457
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
458
{
459
    Q_ASSERT(textEditor);
460

461
    QMutexLocker locker(&m_cppEditorSupportsMutex);
462

463
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
464
    if (!editorSupport && isCppEditor(textEditor)) {
465
466
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
467
468
469
470
    }
    return editorSupport;
}

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
/// \brief Removes the CppEditorSupport for the closed editor.
void CppModelManager::deleteCppEditorSupport(TextEditor::BaseTextEditor *textEditor)
{
    static short numberOfClosedEditors = 0;

    QTC_ASSERT(textEditor, return);

    if (!isCppEditor(textEditor))
        return;

    CppEditorSupport *editorSupport;
    int numberOfOpenEditors = 0;

    { // Only lock the operations on m_cppEditorSupport
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        editorSupport = m_cppEditorSupports.value(textEditor, 0);
        m_cppEditorSupports.remove(textEditor);
        numberOfOpenEditors = m_cppEditorSupports.size();
    }

    delete editorSupport;

    ++numberOfClosedEditors;
    if (numberOfOpenEditors == 0 || numberOfClosedEditors == 5) {
        numberOfClosedEditors = 0;
496
        delayedGC();
497
498
499
    }
}

500
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
501
{
502
    return m_findReferences->references(symbol, context);
503
504
}

505
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
506
{
507
    if (symbol->identifier())
508
        m_findReferences->findUsages(symbol, context);
509
510
}

511
512
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
513
                                   const QString &replacement)
514
515
{
    if (symbol->identifier())
516
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
517
518
}

Christian Kamm's avatar
Christian Kamm committed
519
520
521
522
523
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

524
525
526
527
528
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

529
530
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
531
    QMutexLocker snapshotLocker(&m_snapshotMutex);
532
533
534
    m_snapshot = newSnapshot;
}

535
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
536
{
537
    QList<CppEditorSupport *> cppEditorSupports;
538
539

    {
540
541
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
542
543
    }

544
    WorkingCopy workingCopy;
545
    foreach (const CppEditorSupport *editorSupport, cppEditorSupports) {
546
547
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
548
549
    }

550
551
552
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
553
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
554
555
    }

556
    // Add the project configuration file
557
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
558
    conf += definedMacros();
559
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
560
561
562
563

    return workingCopy;
}

564
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
565
566
567
568
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

569
570
571
572
573
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

574
575
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
576
577
578
579
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

580
    if (m_indexingSupporter)
581
582
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
583
}
con's avatar
con committed
584

585
586
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
587
    QMutexLocker locker(&m_projectMutex);
588
    return m_projectToProjectsInfo.values();
589
590
591
592
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
593
    QMutexLocker locker(&m_projectMutex);
594
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
595
596
}

597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
/// \brief Remove all files and their includes (recursively) of given ProjectInfo from the snapshot.
void CppModelManager::removeProjectInfoFilesAndIncludesFromSnapshot(const ProjectInfo &projectInfo)
{
    if (!projectInfo.isValid())
        return;

    QMutexLocker snapshotLocker(&m_snapshotMutex);
    foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
        foreach (const ProjectFile &cxxFile, projectPart->files) {
            foreach (const QString &fileName, m_snapshot.allIncludesForDocument(cxxFile.path))
                m_snapshot.remove(fileName);
            m_snapshot.remove(cxxFile.path);
        }
    }
}

/// \brief Remove all given files from the snapshot.
void CppModelManager::removeFilesFromSnapshot(const QSet<QString> &filesToRemove)
{
    QMutexLocker snapshotLocker(&m_snapshotMutex);
    QSetIterator<QString> i(filesToRemove);
    while (i.hasNext())
        m_snapshot.remove(i.next());
}

class ProjectInfoComparer
623
{
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
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
public:
    ProjectInfoComparer(const CppModelManager::ProjectInfo &oldProjectInfo,
                        const CppModelManager::ProjectInfo &newProjectInfo)
        : m_old(oldProjectInfo)
        , m_oldSourceFiles(oldProjectInfo.sourceFiles().toSet())
        , m_new(newProjectInfo)
        , m_newSourceFiles(newProjectInfo.sourceFiles().toSet())
    {}

    bool definesChanged() const
    {
        return m_new.defines() != m_old.defines();
    }

    bool configurationChanged() const
    {
        return definesChanged()
            || m_new.includePaths() != m_old.includePaths()
            || m_new.frameworkPaths() != m_old.frameworkPaths();
    }

    bool nothingChanged() const
    {
        return !configurationChanged() && m_new.sourceFiles() == m_old.sourceFiles();
    }

    QSet<QString> addedFiles() const
    {
        QSet<QString> addedFilesSet = m_newSourceFiles;
        addedFilesSet.subtract(m_oldSourceFiles);
        return addedFilesSet;
    }

    QSet<QString> removedFiles() const
    {
        QSet<QString> removedFilesSet = m_oldSourceFiles;
        removedFilesSet.subtract(m_newSourceFiles);
        return removedFilesSet;
    }

    /// Returns a list of common files that have a changed timestamp.
    QSet<QString> timeStampModifiedFiles(const Snapshot &snapshot) const
    {
        QSet<QString> commonSourceFiles = m_newSourceFiles;
        commonSourceFiles.intersect(m_oldSourceFiles);

        QList<Document::Ptr> documentsToCheck;
        QSetIterator<QString> i(commonSourceFiles);
        while (i.hasNext()) {
            const QString file = i.next();
            if (Document::Ptr document = snapshot.document(file))
                documentsToCheck << document;
        }

        return CppModelManager::timeStampModifiedFiles(documentsToCheck).toSet();
    }

private:
    const CppModelManager::ProjectInfo &m_old;
    const QSet<QString> m_oldSourceFiles;

    const CppModelManager::ProjectInfo &m_new;
    const QSet<QString> m_newSourceFiles;
};

689
690
691
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
692
    m_projectFileToProjectPart.clear();
693
694
695
    m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
696
697
            m_projectFileToProjectPart[projectPart->projectFile] = projectPart;
            foreach (const ProjectFile &cxxFile, projectPart->files)
698
                m_fileToProjectParts[cxxFile.path].append(projectPart);
699

700
701
702
703
        }
    }
}

704
705
706
QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
707
        return QFuture<void>();
708

709
710
711
    QStringList filesToReindex;
    bool filesRemoved = false;

712
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
713
714
715
716
        QMutexLocker projectLocker(&m_projectMutex);

        ProjectExplorer::Project *project = newProjectInfo.project().data();
        const QStringList newSourceFiles = newProjectInfo.sourceFiles();
717

718
        // Check if we can avoid a full reindexing
719
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
720
        if (oldProjectInfo.isValid()) {
721
722
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
723
724
                return QFuture<void>();

725
726
727
728
729
730
731
732
733
            // If the project configuration changed, do a full reindexing
            if (comparer.configurationChanged()) {
                removeProjectInfoFilesAndIncludesFromSnapshot(oldProjectInfo);
                filesToReindex << newSourceFiles;

                // The "configuration file" includes all defines and therefore should be updated
                if (comparer.definesChanged()) {
                    QMutexLocker snapshotLocker(&m_snapshotMutex);
                    m_snapshot.remove(configurationFileName());
734
                }
735
736
737
738
739
740
741
742

            // Otherwise check for added and modified files
            } else {
                const QSet<QString> addedFiles = comparer.addedFiles();
                filesToReindex << addedFiles.toList();

                const QSet<QString> modifiedFiles = comparer.timeStampModifiedFiles(snapshot());
                filesToReindex << modifiedFiles.toList();
743
            }
744
745
746
747
748
749
750
751
752
753
754
755

            // Announce and purge the removed files from the snapshot
            const QSet<QString> removedFiles = comparer.removedFiles();
            if (!removedFiles.isEmpty()) {
                filesRemoved = true;
                emit aboutToRemoveFiles(removedFiles.toList());
                removeFilesFromSnapshot(removedFiles);
            }

        // A new project was opened/created, do a full indexing
        } else {
            filesToReindex << newSourceFiles;
756
757
        }

758
        // Update Project/ProjectInfo and File/ProjectPart table
759
        m_dirty = true;
760
        m_projectToProjectsInfo.insert(project, newProjectInfo);
761
        recalculateFileToProjectParts();
762

763
764
765
    } // Mutex scope

    // If requested, dump everything we got
766
767
    if (!qgetenv("QTCREATOR_DUMP_PROJECT_INFO").isEmpty())
        dumpModelManagerConfiguration();
768

769
770
771
772
773
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

    emit projectPartsUpdated(newProjectInfo.project().data());
774

775
776
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
777
778
}

779
780
781
782
783
ProjectPart::Ptr CppModelManager::projectPartForProjectFile(const QString &projectFile) const
{
    return m_projectFileToProjectPart.value(projectFile);
}

784
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
785
{
786
787
    return m_fileToProjectParts.value(fileName);
}
788

789
790
791
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(const QString &fileName) const
{
    QSet<ProjectPart::Ptr> parts;
792
793
    DependencyTable table;
    table.build(snapshot());
794
    const QStringList deps = table.filesDependingOn(fileName);
795
796
    foreach (const QString &dep, deps)
        parts.unite(QSet<ProjectPart::Ptr>::fromList(m_fileToProjectParts.value(dep)));
797

798
    return parts.values();
799
}
con's avatar
con committed
800

801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

    part->defines = m_definedMacros;
    part->includePaths = m_includePaths;
    part->frameworkPaths = m_frameworkPaths;
    part->cVersion = ProjectPart::C11;
    part->cxxVersion = ProjectPart::CXX11;
    part->cxxExtensions = ProjectPart::AllExtensions;
    part->qtVersion = ProjectPart::Qt5;

    return part;
}

con's avatar
con committed
816
817
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
818
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
819
820
821
822
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
823
    if (replaceDocument(doc))
824
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
825
826
}

827
828
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
829
    QMutexLocker locker(&m_projectMutex);
830
831
832
    m_dirty = true;
}

833
834
835
836
837
void CppModelManager::delayedGC()
{
    m_delayedGcTimer->start(500);
}

con's avatar
con committed
838
839
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
840
    do {
841
        QMutexLocker locker(&m_projectMutex);
842
        m_dirty = true;
843
        m_projectToProjectsInfo.remove(project);
844
        recalculateFileToProjectParts();
845
846
    } while (0);

847
848
849
850
851
852
853
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
854
855
856
    GC();
}

857
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
858
{
859
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
860
    do {
861
        QMutexLocker locker(&m_projectMutex);
862
        m_projectToProjectsInfo.clear();
863
        recalculateFileToProjectParts();
864
865
        m_dirty = true;
    } while (0);
con's avatar
con committed
866
867
}

868
869
870
871
872
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
873
874
void CppModelManager::GC()
{
875
876
877
    if (!m_enableGC)
        return;

878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
    // Collect files of CppEditorSupport and AbstractEditorSupport.
    QStringList filesInEditorSupports;
    QList<CppEditorSupport *> cppEditorSupports;
    {
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
    }
    foreach (const CppEditorSupport *cppEditorSupport, cppEditorSupports)
        filesInEditorSupports << cppEditorSupport->fileName();

    QSetIterator<AbstractEditorSupport *> jt(m_extraEditorSupports);
    while (jt.hasNext()) {
        AbstractEditorSupport *abstractEditorSupport = jt.next();
        filesInEditorSupports << abstractEditorSupport->fileName();
    }

    Snapshot currentSnapshot = snapshot();
895
    QSet<QString> reachableFiles;
896
897
898
899
    // The configuration file is part of the project files, which is just fine.
    // If single files are open, without any project, then there is no need to
    // keep the configuration file around.
    QStringList todo = filesInEditorSupports + projectFiles();
con's avatar
con committed
900

901
    // Collect all files that are reachable from the project files
902
    while (!todo.isEmpty()) {
903
        const QString file = todo.last();
con's avatar
con committed
904
905
        todo.removeLast();

906
        if (reachableFiles.contains(file))
con's avatar
con committed
907
            continue;
908
        reachableFiles.insert(file);
con's avatar
con committed
909

910
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
911
912
913
            todo += doc->includedFiles();
    }

914
915
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
916
917
918
919
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

920
        if (reachableFiles.contains(fileName))
921
922
            newSnapshot.insert(it.value());
        else
923
            notReachableFiles.append(fileName);
con's avatar
con committed
924
925
    }

926
927
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
928
    replaceSnapshot(newSnapshot);
929
    emit gcFinished();
con's avatar
con committed
930
}
931

932
933
934
935
936
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

937
void CppModelManager::addModelManagerSupport(ModelManagerSupport *modelManagerSupport)
938
{
939
940
941
942
    Q_ASSERT(modelManagerSupport);
    m_idTocodeModelSupporter[modelManagerSupport->id()] = modelManagerSupport;
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    cms->setModelManagerSupports(m_idTocodeModelSupporter.values());
943
}
944

945
946
ModelManagerSupport *CppModelManager::modelManagerSupportForMimeType(const QString &mimeType) const
{
947
948
949
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    const QString &id = cms->modelManagerSupportId(mimeType);
    return m_idTocodeModelSupporter.value(id, m_modelManagerSupportFallback.data());
950
951
}

952
CppCompletionAssistProvider *CppModelManager::completionAssistProvider(Core::IEditor *editor) const
953
{
954
955
956
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->completionAssistProvider();
957
958
}

959
960
CppHighlightingSupport *CppModelManager::highlightingSupport(Core::IEditor *editor) const
{
961
962
    TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
    if (!textEditor)
963
        return 0;
964

965
966
967
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->highlightingSupport(textEditor);
968
969
}

970
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
971
972
{
    if (indexingSupport)
973
974
975
976
977
978
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
979
980
}

981
982
void CppModelManager::setExtraDiagnostics(const QString &fileName,
                                          const QString &kind,
983
984
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
985
    QList<CppEditorSupport *> cppEditorSupports;
986

987
    {
988
989
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
990
991
    }