cppmodelmanager.cpp 30.7 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
#include "cppsourceprocessor.h"
41
#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 67
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
68 69
using namespace CPlusPlus;

70
#ifdef QTCREATOR_WITH_DUMP_AST
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

#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
110
#endif // QTCREATOR_WITH_DUMP_AST
111

con's avatar
con committed
112 113
static const char pp_configuration[] =
    "# 1 \"<configuration>\"\n"
114
    "#define Q_CREATOR_RUN 1\n"
con's avatar
con committed
115 116 117 118 119 120
    "#define __cplusplus 1\n"
    "#define __extension__\n"
    "#define __context__\n"
    "#define __range__\n"
    "#define   restrict\n"
    "#define __restrict\n"
121
    "#define __restrict__\n"
con's avatar
con committed
122

123 124 125 126
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

127 128
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
129 130
    // ### add macros for win32
    "#define __cdecl\n"
131
    "#define __stdcall\n"
132
    "#define __thiscall\n"
con's avatar
con committed
133 134 135 136 137
    "#define QT_WA(x) x\n"
    "#define CALLBACK\n"
    "#define STDMETHODCALLTYPE\n"
    "#define __RPC_FAR\n"
    "#define __declspec(a)\n"
138 139 140
    "#define STDMETHOD(method) virtual HRESULT STDMETHODCALLTYPE method\n"
    "#define __try try\n"
    "#define __except catch\n"
141 142 143
    "#define __finally\n"
    "#define __inline inline\n"
    "#define __forceinline inline\n";
con's avatar
con committed
144

145
QStringList CppModelManager::timeStampModifiedFiles(const QList<Document::Ptr> &documentsToCheck)
146 147 148
{
    QStringList sourceFiles;

149
    foreach (const Document::Ptr doc, documentsToCheck) {
150 151
        const QDateTime lastModified = doc->lastModified();

152
        if (!lastModified.isNull()) {
153 154 155 156 157 158 159
            QFileInfo fileInfo(doc->fileName());

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

160 161 162
    return sourceFiles;
}

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
/*!
 * \brief createSourceProcessor Create a new source processor, which will signal the
 * model manager when a document has been processed.
 *
 * Indexed file is truncated version of fully parsed document: copy of source
 * code and full AST will be dropped when indexing is done.
 *
 * \return a new source processor object, which the caller needs to delete when finished.
 */
CppSourceProcessor *CppModelManager::createSourceProcessor()
{
    CppModelManager *that = instance();
    return new CppSourceProcessor(that->snapshot(), [=](const Document::Ptr &doc) {
        that->emitDocumentUpdated(doc);
        doc->releaseSourceAndAST();
    });
}

181 182 183 184 185 186 187 188 189
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);
190 191
}

con's avatar
con committed
192 193
/*!
    \class CppTools::CppModelManager
194 195 196
    \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
197

198 199 200 201
    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
202 203
*/

204 205
QMutex CppModelManager::m_instanceMutex;
CppModelManager *CppModelManager::m_instance = 0;
206 207 208

CppModelManager *CppModelManager::instance()
{
209 210 211 212 213 214 215 216
    if (m_instance)
        return m_instance;

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

    return m_instance;
217 218
}

219
CppModelManager::CppModelManager(QObject *parent)
220
    : CppModelManagerInterface(parent)
221
    , m_indexingSupporter(0)
222
    , m_enableGC(true)
con's avatar
con committed
223
{
Erik Verbruggen's avatar
Erik Verbruggen committed
224 225 226 227 228
    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
229
    m_findReferences = new CppFindReferences(this);
230
    m_indexerEnabled = qgetenv("QTC_NO_CODE_INDEXER") != "1";
Roberto Raggi's avatar
Roberto Raggi committed
231

232 233
    m_dirty = true;

234 235 236 237
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

hjk's avatar
hjk committed
238 239
    QObject *sessionManager = ProjectExplorer::SessionManager::instance();
    connect(sessionManager, SIGNAL(projectAdded(ProjectExplorer::Project*)),
240
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
241
    connect(sessionManager, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
Robert Loehning's avatar
Robert Loehning committed
242
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
243
    connect(sessionManager, SIGNAL(aboutToLoadSession(QString)),
244
            this, SLOT(onAboutToLoadSession()));
hjk's avatar
hjk committed
245
    connect(sessionManager, SIGNAL(aboutToUnloadSession(QString)),
246
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
247

248 249 250
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

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

253
    m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
254 255
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
                m_modelManagerSupportFallback->id());
256 257
    addModelManagerSupport(m_modelManagerSupportFallback.data());

258
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
259 260 261
}

CppModelManager::~CppModelManager()
262
{
263
    delete m_internalIndexingSupport;
264
}
con's avatar
con committed
265

266
Snapshot CppModelManager::snapshot() const
267
{
268
    QMutexLocker locker(&m_snapshotMutex);
269 270
    return m_snapshot;
}
con's avatar
con committed
271

272 273
Document::Ptr CppModelManager::document(const QString &fileName) const
{
274
    QMutexLocker locker(&m_snapshotMutex);
275 276 277 278 279 280 281 282
    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)
{
283
    QMutexLocker locker(&m_snapshotMutex);
284 285 286 287 288 289 290 291 292 293

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

294 295
void CppModelManager::ensureUpdated()
{
296
    QMutexLocker locker(&m_projectMutex);
297
    if (!m_dirty)
298 299
        return;

300 301 302 303
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
304 305 306
    m_dirty = false;
}

307
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
308 309
{
    QStringList files;
310
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
311 312
    while (it.hasNext()) {
        it.next();
313
        const ProjectInfo pinfo = it.value();
314
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
315 316
            foreach (const ProjectFile &file, part->files)
                files += file.path;
317
        }
con's avatar
con committed
318
    }
319
    files.removeDuplicates();
con's avatar
con committed
320 321 322
    return files;
}

323
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
324 325
{
    QStringList includePaths;
326
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
327 328
    while (it.hasNext()) {
        it.next();
329
        const ProjectInfo pinfo = it.value();
330
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
331
            foreach (const QString &path, part->includePaths)
332
                includePaths.append(CppSourceProcessor::cleanPath(path));
con's avatar
con committed
333
    }
334
    includePaths.removeDuplicates();
con's avatar
con committed
335 336 337
    return includePaths;
}

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

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
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);
        }
    }
}

369
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
370 371
{
    QByteArray macros;
372
    QSet<QByteArray> alreadyIn;
373
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
374 375
    while (it.hasNext()) {
        it.next();
376
        const ProjectInfo pinfo = it.value();
377
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
378 379
            addUnique(part->toolchainDefines.split('\n'), &macros, &alreadyIn);
            addUnique(part->projectDefines.split('\n'), &macros, &alreadyIn);
380 381
            if (!part->projectConfigFile.isEmpty())
                macros += readProjectConfigFile(part);
382
        }
con's avatar
con committed
383 384 385 386
    }
    return macros;
}

387
/// This function will acquire mutexes!
388
void CppModelManager::dumpModelManagerConfiguration(const QString &logFileId)
389
{
390 391 392 393
    const Snapshot globalSnapshot = snapshot();
    const QString globalSnapshotTitle
        = QString::fromLatin1("Global/Indexing Snapshot (%1 Documents)").arg(globalSnapshot.size());

394
    CppCodeModelInspector::Dumper dumper(globalSnapshot, logFileId);
395 396 397
    dumper.dumpProjectInfos(projectInfos());
    dumper.dumpSnapshot(globalSnapshot, globalSnapshotTitle, /*isGlobalSnapshot=*/ true);
    dumper.dumpWorkingCopy(workingCopy());
398
    ensureUpdated();
399
    dumper.dumpMergedEntities(m_includePaths, m_frameworkPaths, m_definedMacros);
400 401
}

402
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
403
{
404
    m_extraEditorSupports.insert(editorSupport);
405 406
}

407
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
408
{
409
    m_extraEditorSupports.remove(editorSupport);
410 411
}

412 413
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
414
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
415
{
416
    Q_ASSERT(textEditor);
417

418
    QMutexLocker locker(&m_cppEditorSupportsMutex);
419

420
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
421
    if (!editorSupport && isCppEditor(textEditor)) {
422 423
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
424 425 426 427
    }
    return editorSupport;
}

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

457
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
458
{
459
    return m_findReferences->references(symbol, context);
460 461
}

462
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
463
{
464
    if (symbol->identifier())
465
        m_findReferences->findUsages(symbol, context);
466 467
}

468 469
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
470
                                   const QString &replacement)
471 472
{
    if (symbol->identifier())
473
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
474 475
}

Christian Kamm's avatar
Christian Kamm committed
476 477 478 479 480
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

481 482 483 484 485
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

486 487
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
488
    QMutexLocker snapshotLocker(&m_snapshotMutex);
489 490 491
    m_snapshot = newSnapshot;
}

492
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
493
{
494
    WorkingCopy workingCopy;
495 496

    foreach (const CppEditorSupport *editorSupport, cppEditorSupportList()) {
497 498
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
499 500
    }

501 502 503
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
504
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
505 506
    }

507
    // Add the project configuration file
508
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
509
    conf += definedMacros();
510
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
511 512 513 514

    return workingCopy;
}

515
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
516 517 518 519
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

520 521 522 523 524
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

525 526
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
527 528 529 530
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

531
    if (m_indexingSupporter)
532 533
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
534
}
con's avatar
con committed
535

536 537
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
538
    QMutexLocker locker(&m_projectMutex);
539
    return m_projectToProjectsInfo.values();
540 541 542 543
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
544
    QMutexLocker locker(&m_projectMutex);
545
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
546 547
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
/// \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);
        }
    }
}

564 565 566 567 568 569
QList<CppEditorSupport *> CppModelManager::cppEditorSupportList() const
{
    QMutexLocker locker(&m_cppEditorSupportsMutex);
    return m_cppEditorSupports.values();
}

570 571 572 573 574 575 576 577 578 579
/// \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
580
{
581 582 583 584 585 586 587 588 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 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
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;
};

646 647 648
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
649
    m_projectFileToProjectPart.clear();
650 651 652
    m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
653 654
            m_projectFileToProjectPart[projectPart->projectFile] = projectPart;
            foreach (const ProjectFile &cxxFile, projectPart->files)
655
                m_fileToProjectParts[cxxFile.path].append(projectPart);
656

657 658 659 660
        }
    }
}

661 662 663
QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
664
        return QFuture<void>();
665

666 667 668
    QStringList filesToReindex;
    bool filesRemoved = false;

669
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
670 671 672 673
        QMutexLocker projectLocker(&m_projectMutex);

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

675
        // Check if we can avoid a full reindexing
676
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
677
        if (oldProjectInfo.isValid()) {
678 679
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
680 681
                return QFuture<void>();

682 683 684 685 686 687 688 689 690
            // 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());
691
                }
692 693 694 695 696 697 698 699

            // 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();
700
            }
701 702 703 704 705 706 707 708 709 710 711 712

            // 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;
713 714
        }

715
        // Update Project/ProjectInfo and File/ProjectPart table
716
        m_dirty = true;
717
        m_projectToProjectsInfo.insert(project, newProjectInfo);
718
        recalculateFileToProjectParts();
719

720 721 722
    } // Mutex scope

    // If requested, dump everything we got
723
    if (DumpProjectInfo)
724
        dumpModelManagerConfiguration(QLatin1String("updateProjectInfo"));
725

726 727 728 729 730
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

732 733
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
734 735
}

736 737 738 739 740
ProjectPart::Ptr CppModelManager::projectPartForProjectFile(const QString &projectFile) const
{
    return m_projectFileToProjectPart.value(projectFile);
}

741
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
742
{
743
    QMutexLocker locker(&m_projectMutex);
744 745
    return m_fileToProjectParts.value(fileName);
}
746

747 748 749
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(const QString &fileName) const
{
    QSet<ProjectPart::Ptr> parts;
750 751
    DependencyTable table;
    table.build(snapshot());
752
    const QStringList deps = table.filesDependingOn(fileName);
753 754
    foreach (const QString &dep, deps)
        parts.unite(QSet<ProjectPart::Ptr>::fromList(m_fileToProjectParts.value(dep)));
755

756
    return parts.values();
757
}
con's avatar
con committed
758

759 760 761 762
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

763
    part->projectDefines = m_definedMacros;
764 765 766 767 768 769 770 771 772 773
    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
774 775
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
776
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
777 778 779 780
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
781
    if (replaceDocument(doc))
782
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
783 784
}

785 786
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
787
    QMutexLocker locker(&m_projectMutex);
788 789 790
    m_dirty = true;
}

791 792
void CppModelManager::delayedGC()
{
793 794
    if (m_enableGC)
        m_delayedGcTimer->start(500);
795 796
}

con's avatar
con committed
797 798
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
799
    do {
800
        QMutexLocker locker(&m_projectMutex);
801
        m_dirty = true;
802
        m_projectToProjectsInfo.remove(project);
803
        recalculateFileToProjectParts();
804 805
    } while (0);

806 807 808 809 810 811 812
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
813 814 815
    GC();
}

816
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
817
{
818
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
819
    do {
820
        QMutexLocker locker(&m_projectMutex);
821
        m_projectToProjectsInfo.clear();
822
        recalculateFileToProjectParts();
823 824
        m_dirty = true;
    } while (0);
con's avatar
con committed
825 826
}

827 828 829 830 831
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
832 833
void CppModelManager::GC()
{
834 835 836
    if (!m_enableGC)
        return;

837 838
    // Collect files of CppEditorSupport and AbstractEditorSupport.
    QStringList filesInEditorSupports;
839
    foreach (const CppEditorSupport *cppEditorSupport, cppEditorSupportList())
840 841 842 843 844 845 846 847 848
        filesInEditorSupports << cppEditorSupport->fileName();

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

    Snapshot currentSnapshot = snapshot();
849
    QSet<QString> reachableFiles;
850 851 852 853
    // 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
854

855
    // Collect all files that are reachable from the project files
856
    while (!todo.isEmpty()) {
857
        const QString file = todo.last();
con's avatar
con committed
858 859
        todo.removeLast();

860
        if (reachableFiles.contains(file))
con's avatar
con committed
861
            continue;
862
        reachableFiles.insert(file);
con's avatar
con committed
863

864
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
865 866 867
            todo += doc->includedFiles();
    }

868 869
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
870 871 872 873
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

874
        if (reachableFiles.contains(fileName))
875 876
            newSnapshot.insert(it.value());
        else
877
            notReachableFiles.append(fileName);
con's avatar
con committed
878 879
    }

880 881
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
882
    replaceSnapshot(newSnapshot);
883
    emit gcFinished();
con's avatar
con committed
884
}
885

886 887 888 889 890
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

891
void CppModelManager::addModelManagerSupport(ModelManagerSupport *modelManagerSupport)
892
{
893 894 895 896
    Q_ASSERT(modelManagerSupport);
    m_idTocodeModelSupporter[modelManagerSupport->id()] = modelManagerSupport;
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    cms->setModelManagerSupports(m_idTocodeModelSupporter.values());
897
}
898

899 900
ModelManagerSupport *CppModelManager::modelManagerSupportForMimeType(const QString &mimeType) const
{
901 902 903
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    const QString &id = cms->modelManagerSupportId(mimeType);
    return m_idTocodeModelSupporter.value(id, m_modelManagerSupportFallback.data());
904 905
}

906
CppCompletionAssistProvider *CppModelManager::completionAssistProvider(const QString &mimeType) const
907
{
908 909
    if (mimeType.isEmpty())
        return 0;
910

911 912
    ModelManagerSupport *cms = modelManagerSupportForMimeType(mimeType);
    QTC_ASSERT(cms, return 0);
913
    return cms->completionAssistProvider();
914 915
}

916 917
CppHighlightingSupport *CppModelManager::highlightingSupport(
        TextEditor::BaseTextDocument *baseTextDocument) const
918
{
919 920 921 922
    QTC_ASSERT(baseTextDocument, return 0);
    ModelManagerSupport *cms = modelManagerSupportForMimeType(baseTextDocument->mimeType());
    QTC_ASSERT(cms, return 0);
    return cms->highlightingSupport(baseTextDocument);
923 924
}

925
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
926 927
{
    if (indexingSupport)
928 929 930 931 932 933
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
934 935
}

936 937 938 939 940 941
void CppModelManager::enableGarbageCollector(bool enable)
{
    m_delayedGcTimer->stop();
    m_enableGC = enable;
}

942
bool CppModelManager::setExtraDiagnostics(const QString &fileName,
943
                                          const QString &kind,
944 945
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
946
    foreach (CppEditorSupport *editorSupport, cppEditorSupportList()) {
947 948
        if (editorSupport->fileName() == fileName) {
            editorSupport->setExtraDiagnostics(kind, diagnostics);
949
            return true;
950
        }
951
    }
952
    return false;
953
}
954 955 956 957

void CppModelManager::setIfdefedOutBlocks(const QString &fileName,
                                          const QList<TextEditor::BlockRange> &ifdeffedOutBlocks)
{
958
    foreach (CppEditorSupport *editorSupport, cppEditorSupportList()) {
959 960 961 962 963 964
        if (editorSupport->fileName() == fileName) {
            editorSupport->setIfdefedOutBlocks(ifdeffedOutBlocks);
            break;
        }
    }
}