cppmodelmanager.cpp 31.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2014 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 "cppcodemodelinspectordumper.h"
35
#include "cppcodemodelsettings.h"
36
#include "cppfindreferences.h"
37
#include "cpphighlightingsupport.h"
38
#include "cppindexingsupport.h"
39
#include "cppmodelmanagersupportinternal.h"
40 41
#include "cpppreprocessor.h"
#include "cpptoolsconstants.h"
42
#include "cpptoolseditorsupport.h"
43
#include "cpptoolsplugin.h"
con's avatar
con committed
44

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

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

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

64 65
static const bool DumpProjectInfo = qgetenv("QTC_DUMP_PROJECT_INFO") == "1";

66
namespace CppTools {
67

68
uint qHash(const ProjectPart &p)
69
{
70
    uint h = qHash(p.toolchainDefines) ^ qHash(p.projectDefines) ^ p.cVersion ^ p.cxxVersion
71
            ^ p.cxxExtensions ^ p.qtVersion ^ qHash(p.projectConfigFile);
72 73 74 75 76 77 78 79 80

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

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

    return h;
}
81

82 83
bool operator==(const ProjectPart &p1,
                const ProjectPart &p2)
84
{
85 86 87
    if (p1.toolchainDefines != p2.toolchainDefines)
        return false;
    if (p1.projectDefines != p2.projectDefines)
88
        return false;
89 90
    if (p1.projectConfigFile != p2.projectConfigFile)
        return false;
91 92 93 94 95
    if (p1.cVersion != p2.cVersion)
        return false;
    if (p1.cxxVersion != p2.cxxVersion)
        return false;
    if (p1.cxxExtensions != p2.cxxExtensions)
96
        return false;
97
    if (p1.qtVersion!= p2.qtVersion)
98 99 100 101 102
        return false;
    if (p1.includePaths != p2.includePaths)
        return false;
    return p1.frameworkPaths == p2.frameworkPaths;
}
103

104
} // namespace CppTools
105

106 107
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
108 109
using namespace CPlusPlus;

110
#ifdef QTCREATOR_WITH_DUMP_AST
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 142 143 144 145 146 147 148 149

#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
150
#endif // QTCREATOR_WITH_DUMP_AST
151

con's avatar
con committed
152 153
static const char pp_configuration[] =
    "# 1 \"<configuration>\"\n"
154
    "#define Q_CREATOR_RUN 1\n"
con's avatar
con committed
155 156 157 158 159 160
    "#define __cplusplus 1\n"
    "#define __extension__\n"
    "#define __context__\n"
    "#define __range__\n"
    "#define   restrict\n"
    "#define __restrict\n"
161
    "#define __restrict__\n"
con's avatar
con committed
162

163 164 165 166
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

167 168
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
169 170
    // ### add macros for win32
    "#define __cdecl\n"
171
    "#define __stdcall\n"
con's avatar
con committed
172 173 174 175 176
    "#define QT_WA(x) x\n"
    "#define CALLBACK\n"
    "#define STDMETHODCALLTYPE\n"
    "#define __RPC_FAR\n"
    "#define __declspec(a)\n"
177 178 179
    "#define STDMETHOD(method) virtual HRESULT STDMETHODCALLTYPE method\n"
    "#define __try try\n"
    "#define __except catch\n"
180 181 182
    "#define __finally\n"
    "#define __inline inline\n"
    "#define __forceinline inline\n";
con's avatar
con committed
183

184
QStringList CppModelManager::timeStampModifiedFiles(const QList<Document::Ptr> documentsToCheck)
185 186 187
{
    QStringList sourceFiles;

188
    foreach (const Document::Ptr doc, documentsToCheck) {
189 190
        const QDateTime lastModified = doc->lastModified();

191
        if (!lastModified.isNull()) {
192 193 194 195 196 197 198
            QFileInfo fileInfo(doc->fileName());

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

199 200 201 202 203 204 205 206 207 208 209 210
    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);
211 212
}

con's avatar
con committed
213 214
/*!
    \class CppTools::CppModelManager
215 216 217
    \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
218

219 220 221 222
    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
223 224
*/

225 226
QMutex CppModelManager::m_instanceMutex;
CppModelManager *CppModelManager::m_instance = 0;
227 228 229

CppModelManager *CppModelManager::instance()
{
230 231 232 233 234 235 236 237
    if (m_instance)
        return m_instance;

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

    return m_instance;
238 239
}

240
CppModelManager::CppModelManager(QObject *parent)
241
    : CppModelManagerInterface(parent)
242
    , m_indexingSupporter(0)
243
    , m_enableGC(true)
con's avatar
con committed
244
{
Erik Verbruggen's avatar
Erik Verbruggen committed
245 246 247 248 249
    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
250
    m_findReferences = new CppFindReferences(this);
251
    m_indexerEnabled = qgetenv("QTC_NO_CODE_INDEXER") != "1";
Roberto Raggi's avatar
Roberto Raggi committed
252

253 254
    m_dirty = true;

255 256 257 258
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

hjk's avatar
hjk committed
259 260
    QObject *sessionManager = ProjectExplorer::SessionManager::instance();
    connect(sessionManager, SIGNAL(projectAdded(ProjectExplorer::Project*)),
261
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
262
    connect(sessionManager, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
Robert Loehning's avatar
Robert Loehning committed
263
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
264
    connect(sessionManager, SIGNAL(aboutToLoadSession(QString)),
265
            this, SLOT(onAboutToLoadSession()));
hjk's avatar
hjk committed
266
    connect(sessionManager, SIGNAL(aboutToUnloadSession(QString)),
267
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
268

269 270 271
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

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

274
    m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
275 276
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
                m_modelManagerSupportFallback->id());
277 278
    addModelManagerSupport(m_modelManagerSupportFallback.data());

279
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
280 281 282
}

CppModelManager::~CppModelManager()
283
{
284
    delete m_internalIndexingSupport;
285
}
con's avatar
con committed
286

287
Snapshot CppModelManager::snapshot() const
288
{
289
    QMutexLocker locker(&m_snapshotMutex);
290 291
    return m_snapshot;
}
con's avatar
con committed
292

293 294
Document::Ptr CppModelManager::document(const QString &fileName) const
{
295
    QMutexLocker locker(&m_snapshotMutex);
296 297 298 299 300 301 302 303
    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)
{
304
    QMutexLocker locker(&m_snapshotMutex);
305 306 307 308 309 310 311 312 313 314

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

315 316
void CppModelManager::ensureUpdated()
{
317
    QMutexLocker locker(&m_projectMutex);
318
    if (!m_dirty)
319 320
        return;

321 322 323 324
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
325 326 327
    m_dirty = false;
}

328
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
329 330
{
    QStringList files;
331
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
332 333
    while (it.hasNext()) {
        it.next();
334
        const ProjectInfo pinfo = it.value();
335
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
336 337
            foreach (const ProjectFile &file, part->files)
                files += file.path;
338
        }
con's avatar
con committed
339
    }
340
    files.removeDuplicates();
con's avatar
con committed
341 342 343
    return files;
}

344
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
345 346
{
    QStringList includePaths;
347
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
348 349
    while (it.hasNext()) {
        it.next();
350
        const ProjectInfo pinfo = it.value();
351
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
352 353
            foreach (const QString &path, part->includePaths)
                includePaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
354
    }
355
    includePaths.removeDuplicates();
con's avatar
con committed
356 357 358
    return includePaths;
}

359
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
360 361
{
    QStringList frameworkPaths;
362
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
363 364
    while (it.hasNext()) {
        it.next();
365
        const ProjectInfo pinfo = it.value();
366
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
367 368
            foreach (const QString &path, part->frameworkPaths)
                frameworkPaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
369
    }
370
    frameworkPaths.removeDuplicates();
con's avatar
con committed
371 372 373
    return frameworkPaths;
}

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
static void addUnique(const QList<QByteArray> &defs, QByteArray *macros, QSet<QByteArray> *alreadyIn)
{
    Q_ASSERT(macros);
    Q_ASSERT(alreadyIn);

    foreach (const QByteArray &def, defs) {
        if (def.trimmed().isEmpty())
            continue;
        if (!alreadyIn->contains(def)) {
            macros->append(def);
            macros->append('\n');
            alreadyIn->insert(def);
        }
    }
}

390
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
391 392
{
    QByteArray macros;
393
    QSet<QByteArray> alreadyIn;
394
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
395 396
    while (it.hasNext()) {
        it.next();
397
        const ProjectInfo pinfo = it.value();
398
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
399 400
            addUnique(part->toolchainDefines.split('\n'), &macros, &alreadyIn);
            addUnique(part->projectDefines.split('\n'), &macros, &alreadyIn);
401 402
            if (!part->projectConfigFile.isEmpty())
                macros += readProjectConfigFile(part);
403
        }
con's avatar
con committed
404 405 406 407
    }
    return macros;
}

408
/// This function will acquire mutexes!
409
void CppModelManager::dumpModelManagerConfiguration(const QString &logFileId)
410
{
411 412 413 414
    const Snapshot globalSnapshot = snapshot();
    const QString globalSnapshotTitle
        = QString::fromLatin1("Global/Indexing Snapshot (%1 Documents)").arg(globalSnapshot.size());

415
    CppCodeModelInspector::Dumper dumper(globalSnapshot, logFileId);
416 417 418
    dumper.dumpProjectInfos(projectInfos());
    dumper.dumpSnapshot(globalSnapshot, globalSnapshotTitle, /*isGlobalSnapshot=*/ true);
    dumper.dumpWorkingCopy(workingCopy());
419
    ensureUpdated();
420
    dumper.dumpMergedEntities(m_includePaths, m_frameworkPaths, m_definedMacros);
421 422
}

423
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
424
{
425
    m_extraEditorSupports.insert(editorSupport);
426 427
}

428
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
429
{
430
    m_extraEditorSupports.remove(editorSupport);
431 432
}

433 434
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
435
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
436
{
437
    Q_ASSERT(textEditor);
438

439
    QMutexLocker locker(&m_cppEditorSupportsMutex);
440

441
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
442
    if (!editorSupport && isCppEditor(textEditor)) {
443 444
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
445 446 447 448
    }
    return editorSupport;
}

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
/// \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;
474
        delayedGC();
475 476 477
    }
}

478
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
479
{
480
    return m_findReferences->references(symbol, context);
481 482
}

483
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
484
{
485
    if (symbol->identifier())
486
        m_findReferences->findUsages(symbol, context);
487 488
}

489 490
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
491
                                   const QString &replacement)
492 493
{
    if (symbol->identifier())
494
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
495 496
}

Christian Kamm's avatar
Christian Kamm committed
497 498 499 500 501
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

502 503 504 505 506
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

507 508
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
509
    QMutexLocker snapshotLocker(&m_snapshotMutex);
510 511 512
    m_snapshot = newSnapshot;
}

513
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
514
{
515
    QList<CppEditorSupport *> cppEditorSupports;
516 517

    {
518 519
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
520 521
    }

522
    WorkingCopy workingCopy;
523
    foreach (const CppEditorSupport *editorSupport, cppEditorSupports) {
524 525
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
526 527
    }

528 529 530
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
531
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
532 533
    }

534
    // Add the project configuration file
535
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
536
    conf += definedMacros();
537
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
538 539 540 541

    return workingCopy;
}

542
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
543 544 545 546
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

547 548 549 550 551
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

552 553
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
554 555 556 557
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

558
    if (m_indexingSupporter)
559 560
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
561
}
con's avatar
con committed
562

563 564
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
565
    QMutexLocker locker(&m_projectMutex);
566
    return m_projectToProjectsInfo.values();
567 568 569 570
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
571
    QMutexLocker locker(&m_projectMutex);
572
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
573 574
}

575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
/// \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
601
{
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 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
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;
};

667 668 669
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
670
    m_projectFileToProjectPart.clear();
671 672 673
    m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
674 675
            m_projectFileToProjectPart[projectPart->projectFile] = projectPart;
            foreach (const ProjectFile &cxxFile, projectPart->files)
676
                m_fileToProjectParts[cxxFile.path].append(projectPart);
677

678 679 680 681
        }
    }
}

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

687 688 689
    QStringList filesToReindex;
    bool filesRemoved = false;

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

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

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

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

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

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

736
        // Update Project/ProjectInfo and File/ProjectPart table
737
        m_dirty = true;
738
        m_projectToProjectsInfo.insert(project, newProjectInfo);
739
        recalculateFileToProjectParts();
740

741 742 743
    } // Mutex scope

    // If requested, dump everything we got
744
    if (DumpProjectInfo)
745
        dumpModelManagerConfiguration(QLatin1String("updateProjectInfo"));
746

747 748 749 750 751
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

753 754
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
755 756
}

757 758 759 760 761
ProjectPart::Ptr CppModelManager::projectPartForProjectFile(const QString &projectFile) const
{
    return m_projectFileToProjectPart.value(projectFile);
}

762
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
763
{
764
    QMutexLocker locker(&m_projectMutex);
765 766
    return m_fileToProjectParts.value(fileName);
}
767

768 769 770
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(const QString &fileName) const
{
    QSet<ProjectPart::Ptr> parts;
771 772
    DependencyTable table;
    table.build(snapshot());
773
    const QStringList deps = table.filesDependingOn(fileName);
774 775
    foreach (const QString &dep, deps)
        parts.unite(QSet<ProjectPart::Ptr>::fromList(m_fileToProjectParts.value(dep)));
776

777
    return parts.values();
778
}
con's avatar
con committed
779

780 781 782 783
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

784
    part->projectDefines = m_definedMacros;
785 786 787 788 789 790 791 792 793 794
    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
795 796
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
797
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
798 799 800 801
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
802
    if (replaceDocument(doc))
803
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
804 805
}

806 807
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
808
    QMutexLocker locker(&m_projectMutex);
809 810 811
    m_dirty = true;
}

812 813
void CppModelManager::delayedGC()
{
814 815
    if (m_enableGC)
        m_delayedGcTimer->start(500);
816 817
}

con's avatar
con committed
818 819
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
820
    do {
821
        QMutexLocker locker(&m_projectMutex);
822
        m_dirty = true;
823
        m_projectToProjectsInfo.remove(project);
824
        recalculateFileToProjectParts();
825 826
    } while (0);

827 828 829 830 831 832 833
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
834 835 836
    GC();
}

837
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
838
{
839
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
840
    do {
841
        QMutexLocker locker(&m_projectMutex);
842
        m_projectToProjectsInfo.clear();
843
        recalculateFileToProjectParts();
844 845
        m_dirty = true;
    } while (0);
con's avatar
con committed
846 847
}

848 849 850 851 852
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
853 854
void CppModelManager::GC()
{
855 856 857
    if (!m_enableGC)
        return;

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
    // 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();
875
    QSet<QString> reachableFiles;
876 877 878 879
    // 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
880

881
    // Collect all files that are reachable from the project files
882
    while (!todo.isEmpty()) {
883
        const QString file = todo.last();
con's avatar
con committed
884 885
        todo.removeLast();

886
        if (reachableFiles.contains(file))
con's avatar
con committed
887
            continue;
888
        reachableFiles.insert(file);
con's avatar
con committed
889

890
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
891 892 893
            todo += doc->includedFiles();
    }

894 895
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
896 897 898 899
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

900
        if (reachableFiles.contains(fileName))
901 902
            newSnapshot.insert(it.value());
        else
903
            notReachableFiles.append(fileName);
con's avatar
con committed
904 905
    }

906 907
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
908
    replaceSnapshot(newSnapshot);
909
    emit gcFinished();
con's avatar
con committed
910
}
911

912 913 914 915 916
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

917
void CppModelManager::addModelManagerSupport(ModelManagerSupport *modelManagerSupport)
918
{
919 920 921 922
    Q_ASSERT(modelManagerSupport);
    m_idTocodeModelSupporter[modelManagerSupport->id()] = modelManagerSupport;
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    cms->setModelManagerSupports(m_idTocodeModelSupporter.values());
923
}
924

925 926
ModelManagerSupport *CppModelManager::modelManagerSupportForMimeType(const QString &mimeType) const
{
927 928 929
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    const QString &id = cms->modelManagerSupportId(mimeType);
    return m_idTocodeModelSupporter.value(id, m_modelManagerSupportFallback.data());
930 931
}

932
CppCompletionAssistProvider *CppModelManager::completionAssistProvider(Core::IEditor *editor) const
933
{
934 935 936
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->completionAssistProvider();
937 938
}