cppmodelmanager.cpp 31.3 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 "cppcompletionassist.h"
35
#include "cppfindreferences.h"
36 37
#include "cpphighlightingsupport.h"
#include "cpphighlightingsupportinternal.h"
38
#include "cppindexingsupport.h"
39 40
#include "cpppreprocessor.h"
#include "cpptoolsconstants.h"
41
#include "cpptoolseditorsupport.h"
con's avatar
con committed
42

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

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

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

62
namespace CppTools {
63

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

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

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

    return h;
}
76

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

95
} // namespace CppTools
96

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

101
#ifdef QTCREATOR_WITH_DUMP_AST
102 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

#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
141
#endif // QTCREATOR_WITH_DUMP_AST
142

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

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

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

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

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

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

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

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

190 191 192 193 194 195 196 197 198 199 200 201
    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);
202 203
}

con's avatar
con committed
204 205
/*!
    \class CppTools::CppModelManager
206 207 208
    \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
209

210 211 212 213
    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
214 215
*/

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

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

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

    return m_instance;
229 230
}

231
CppModelManager::CppModelManager(QObject *parent)
232
    : CppModelManagerInterface(parent)
233 234 235
    , m_completionAssistProvider(0)
    , m_highlightingFactory(0)
    , m_indexingSupporter(0)
236
    , m_enableGC(true)
con's avatar
con committed
237
{
Roberto Raggi's avatar
Roberto Raggi committed
238
    m_findReferences = new CppFindReferences(this);
239
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
240

241 242
    m_dirty = true;

243 244 245 246
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

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

257 258 259
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

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

262 263
    m_completionFallback = new InternalCompletionAssistProvider;
    m_completionAssistProvider = m_completionFallback;
264
    ExtensionSystem::PluginManager::addObject(m_completionAssistProvider);
265 266
    m_highlightingFallback = new CppHighlightingSupportInternalFactory;
    m_highlightingFactory = m_highlightingFallback;
267
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
268 269 270
}

CppModelManager::~CppModelManager()
271
{
272
    ExtensionSystem::PluginManager::removeObject(m_completionAssistProvider);
273 274
    delete m_completionFallback;
    delete m_highlightingFallback;
275
    delete m_internalIndexingSupport;
276
}
con's avatar
con committed
277

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

284 285
Document::Ptr CppModelManager::document(const QString &fileName) const
{
286
    QMutexLocker locker(&m_snapshotMutex);
287 288 289 290 291 292 293 294
    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)
{
295
    QMutexLocker locker(&m_snapshotMutex);
296 297 298 299 300 301 302 303 304 305

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

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

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

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

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

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

365
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
366 367
{
    QByteArray macros;
368
    QSet<QByteArray> alreadyIn;
369
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
370 371
    while (it.hasNext()) {
        it.next();
372
        const ProjectInfo pinfo = it.value();
373 374 375 376 377 378 379 380 381 382
        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
383 384 385 386
    }
    return macros;
}

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

419 420 421
            qDebug() << "cVersion:" << cVersion;
            qDebug() << "cxxVersion:" << cxxVersion;
            qDebug() << "cxxExtensions:" << cxxExtensions;
422 423 424 425 426
            qDebug() << "Qt version:" << part->qtVersion;
            qDebug() << "precompiled header:" << part->precompiledHeaders;
            qDebug() << "defines:" << part->defines;
            qDebug() << "includes:" << part->includePaths;
            qDebug() << "frameworkPaths:" << part->frameworkPaths;
427
            qDebug() << "files:" << part->files;
428 429 430 431 432 433 434 435 436 437 438 439 440
            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;
441
    qDebug() << "========= End of dump ======";
442 443
}

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

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

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

460
    QMutexLocker locker(&m_cppEditorSupportsMutex);
461

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

470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
/// \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;
495
        delayedGC();
496 497 498
    }
}

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

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

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

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

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

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

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

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

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

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

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

    return workingCopy;
}

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

568 569
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
570 571 572 573
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

574
    if (m_indexingSupporter)
575 576
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
577
}
con's avatar
con committed
578

579 580
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
581
    QMutexLocker locker(&m_projectMutex);
582
    return m_projectToProjectsInfo.values();
583 584 585 586
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
587
    QMutexLocker locker(&m_projectMutex);
588
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
589 590
}

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
/// \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
617
{
618 619 620 621 622 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
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;
};

QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
686
        return QFuture<void>();
687

688 689 690
    QStringList filesToReindex;
    bool filesRemoved = false;

691
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
692 693 694 695
        QMutexLocker projectLocker(&m_projectMutex);

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

697
        // Check if we can avoid a full reindexing
698
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
699
        if (oldProjectInfo.isValid()) {
700 701
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
702 703
                return QFuture<void>();

704 705 706 707 708 709 710 711 712
            // 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());
713
                }
714 715 716 717 718 719 720 721

            // 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();
722
            }
723 724 725 726 727 728 729 730 731 732 733 734

            // 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;
735 736
        }

737
        // Update Project/ProjectInfo and File/ProjectPart table
738
        m_dirty = true;
739
        m_projectToProjectsInfo.insert(project, newProjectInfo);
740 741
        m_fileToProjectParts.clear();
        foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
742
            foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
743
                foreach (const ProjectFile &cxxFile, projectPart->files) {
744
                    m_fileToProjectParts[cxxFile.path].append(projectPart);
745
                }
746 747
            }
        }
748

749 750 751
    } // Mutex scope

    // If requested, dump everything we got
752 753
    if (!qgetenv("QTCREATOR_DUMP_PROJECT_INFO").isEmpty())
        dumpModelManagerConfiguration();
754

755 756 757 758 759
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

761 762
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
763 764
}

765
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
766
{
767
    QList<ProjectPart::Ptr> parts = m_fileToProjectParts.value(fileName);
768 769 770 771 772
    if (!parts.isEmpty())
        return parts;

    DependencyTable table;
    table.build(snapshot());
773
    const QStringList deps = table.filesDependingOn(fileName);
774
    foreach (const QString &dep, deps) {
775
        parts = m_fileToProjectParts.value(dep);
776 777 778 779 780
        if (!parts.isEmpty())
            return parts;
    }

    return parts;
781
}
con's avatar
con committed
782 783 784

bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
785
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
786 787 788 789
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
790
    if (replaceDocument(doc))
791
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
792 793
}

794 795
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
796
    QMutexLocker locker(&m_projectMutex);
797 798 799
    m_dirty = true;
}

800 801 802 803 804
void CppModelManager::delayedGC()
{
    m_delayedGcTimer->start(500);
}

con's avatar
con committed
805 806
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
807
    do {
808
        QMutexLocker locker(&m_projectMutex);
809
        m_dirty = true;
810
        m_projectToProjectsInfo.remove(project);
811 812
    } while (0);

813 814 815 816 817 818 819
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
820 821 822
    GC();
}

823
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
824
{
825
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
826
    do {
827
        QMutexLocker locker(&m_projectMutex);
828
        m_projectToProjectsInfo.clear();
829 830
        m_dirty = true;
    } while (0);
con's avatar
con committed
831 832
}

833 834 835 836 837
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
838 839
void CppModelManager::GC()
{
840 841 842
    if (!m_enableGC)
        return;

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
    // 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();
860
    QSet<QString> reachableFiles;
861 862 863 864
    // 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
865

866
    // Collect all files that are reachable from the project files
867
    while (!todo.isEmpty()) {
868
        const QString file = todo.last();
con's avatar
con committed
869 870
        todo.removeLast();

871
        if (reachableFiles.contains(file))
con's avatar
con committed
872
            continue;
873
        reachableFiles.insert(file);
con's avatar
con committed
874

875
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
876 877 878
            todo += doc->includedFiles();
    }

879 880
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
881 882 883 884
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

885
        if (reachableFiles.contains(fileName))
886 887
            newSnapshot.insert(it.value());
        else
888
            notReachableFiles.append(fileName);
con's avatar
con committed
889 890
    }

891 892
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
893
    replaceSnapshot(newSnapshot);
894
    emit gcFinished();
con's avatar
con committed
895
}
896

897 898 899 900 901
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

902 903
CppCompletionSupport *CppModelManager::completionSupport(Core::IEditor *editor) const
{
904
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor))
905
        return m_completionAssistProvider->completionSupport(textEditor);
906 907 908 909
    else
        return 0;
}

910
void CppModelManager::setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider)
911
{
912
    ExtensionSystem::PluginManager::removeObject(m_completionAssistProvider);
913 914
    if (completionAssistProvider)
        m_completionAssistProvider = completionAssistProvider;
915
    else
916
        m_completionAssistProvider = m_completionFallback;
917
    ExtensionSystem::PluginManager::addObject(m_completionAssistProvider);
918 919
}

920 921
CppHighlightingSupport *CppModelManager::highlightingSupport(Core::IEditor *editor) const
{
922 923
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor))
        return m_highlightingFactory->highlightingSupport(textEditor);
924 925 926
    else
        return 0;
}
927

928 929 930 931 932 933 934 935
void CppModelManager::setHighlightingSupportFactory(CppHighlightingSupportFactory *highlightingFactory)
{
    if (highlightingFactory)
        m_highlightingFactory = highlightingFactory;
    else
        m_highlightingFactory = m_highlightingFallback;
}

936
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
937 938
{
    if (indexingSupport)
939 940 941 942 943 944
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
945 946
}

947 948
void CppModelManager::setExtraDiagnostics(const QString &fileName,
                                          const QString &kind,
949 950
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
951
    QList<CppEditorSupport *> cppEditorSupports;
952

953
    {
954 955
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
956 957
    }