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

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

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

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

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

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

63
namespace CppTools {
64

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

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

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

    return h;
}
78

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

99
} // namespace CppTools
100

101 102
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
103 104
using namespace CPlusPlus;

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

#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
145
#endif // QTCREATOR_WITH_DUMP_AST
146

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

158 159 160 161
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

162 163
    "#define __builtin_va_arg(a,b) ((b)0)\n"

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

179
QStringList CppModelManager::timeStampModifiedFiles(const QList<Document::Ptr> documentsToCheck)
180 181 182
{
    QStringList sourceFiles;

183
    foreach (const Document::Ptr doc, documentsToCheck) {
184 185
        const QDateTime lastModified = doc->lastModified();

186
        if (!lastModified.isNull()) {
187 188 189 190 191 192 193
            QFileInfo fileInfo(doc->fileName());

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

194 195 196 197 198 199 200 201 202 203 204 205
    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);
206 207
}

con's avatar
con committed
208 209
/*!
    \class CppTools::CppModelManager
210 211 212
    \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
213

214 215 216 217
    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
218 219
*/

220 221
QMutex CppModelManager::m_instanceMutex;
CppModelManager *CppModelManager::m_instance = 0;
222 223 224

CppModelManager *CppModelManager::instance()
{
225 226 227 228 229 230 231 232
    if (m_instance)
        return m_instance;

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

    return m_instance;
233 234
}

235
CppModelManager::CppModelManager(QObject *parent)
236
    : CppModelManagerInterface(parent)
237
    , m_indexingSupporter(0)
238
    , m_enableGC(true)
con's avatar
con committed
239
{
240 241 242 243 244
    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
245
    m_findReferences = new CppFindReferences(this);
246
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
247

248 249
    m_dirty = true;

250 251 252 253
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

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

264 265 266
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

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

269
    m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
270 271
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
                m_modelManagerSupportFallback->id());
272 273
    addModelManagerSupport(m_modelManagerSupportFallback.data());

274
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
275 276 277
}

CppModelManager::~CppModelManager()
278
{
279
    delete m_internalIndexingSupport;
280
}
con's avatar
con committed
281

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

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

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

310 311
void CppModelManager::ensureUpdated()
{
312
    QMutexLocker locker(&m_projectMutex);
313
    if (!m_dirty)
314 315
        return;

316 317 318 319
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
320 321 322
    m_dirty = false;
}

323
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
324 325
{
    QStringList files;
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 332
            foreach (const ProjectFile &file, part->files)
                files += file.path;
333
        }
con's avatar
con committed
334
    }
335
    files.removeDuplicates();
con's avatar
con committed
336 337 338
    return files;
}

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

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

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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);
        }
    }
}

385
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
386 387
{
    QByteArray macros;
388
    QSet<QByteArray> alreadyIn;
389
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
390 391
    while (it.hasNext()) {
        it.next();
392
        const ProjectInfo pinfo = it.value();
393
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
394 395
            addUnique(part->toolchainDefines.split('\n'), &macros, &alreadyIn);
            addUnique(part->projectDefines.split('\n'), &macros, &alreadyIn);
396
        }
con's avatar
con committed
397 398 399 400
    }
    return macros;
}

401
/// This function will aquire the mutex!
402 403 404
void CppModelManager::dumpModelManagerConfiguration()
{
    // Tons of debug output...
405 406
    qDebug() << "========= CppModelManager::dumpModelManagerConfiguration ======";
    foreach (const ProjectInfo &pinfo, m_projectToProjectsInfo) {
407
        qDebug() << " for project:"<< pinfo.project().data()->projectFilePath();
408 409
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            qDebug() << "=== part ===";
410 411 412 413 414 415 416
            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";
            }
417
            const char* cxxVersion;
418
            switch (part->cxxVersion) {
419 420
            case ProjectPart::CXX98: cxxVersion = "CXX98"; break;
            case ProjectPart::CXX11: cxxVersion = "CXX11"; break;
421 422
            default: cxxVersion = "INVALID";
            }
423 424 425 426 427 428 429
            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");
430
            if (part->cxxExtensions & ProjectPart::OpenMPExtensions)
431
                cxxExtensions << QLatin1String("OpenMP");
432

433 434 435
            qDebug() << "cVersion:" << cVersion;
            qDebug() << "cxxVersion:" << cxxVersion;
            qDebug() << "cxxExtensions:" << cxxExtensions;
436 437
            qDebug() << "Qt version:" << part->qtVersion;
            qDebug() << "precompiled header:" << part->precompiledHeaders;
438 439
            qDebug() << "toolchain defines:" << part->toolchainDefines;
            qDebug() << "project defines:" << part->projectDefines;
440 441
            qDebug() << "includes:" << part->includePaths;
            qDebug() << "frameworkPaths:" << part->frameworkPaths;
442
            qDebug() << "files:" << part->files;
443 444 445 446 447 448 449 450 451 452 453 454 455
            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;
456
    qDebug() << "========= End of dump ======";
457 458
}

459
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
460
{
461
    m_extraEditorSupports.insert(editorSupport);
462 463
}

464
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
465
{
466
    m_extraEditorSupports.remove(editorSupport);
467 468
}

469 470
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
471
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
472
{
473
    Q_ASSERT(textEditor);
474

475
    QMutexLocker locker(&m_cppEditorSupportsMutex);
476

477
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
478
    if (!editorSupport && isCppEditor(textEditor)) {
479 480
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
481 482 483 484
    }
    return editorSupport;
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
/// \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;
510
        delayedGC();
511 512 513
    }
}

514
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
515
{
516
    return m_findReferences->references(symbol, context);
517 518
}

519
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
520
{
521
    if (symbol->identifier())
522
        m_findReferences->findUsages(symbol, context);
523 524
}

525 526
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
527
                                   const QString &replacement)
528 529
{
    if (symbol->identifier())
530
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
531 532
}

Christian Kamm's avatar
Christian Kamm committed
533 534 535 536 537
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

538 539 540 541 542
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

543 544
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
545
    QMutexLocker snapshotLocker(&m_snapshotMutex);
546 547 548
    m_snapshot = newSnapshot;
}

549
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
550
{
551
    QList<CppEditorSupport *> cppEditorSupports;
552 553

    {
554 555
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
556 557
    }

558
    WorkingCopy workingCopy;
559
    foreach (const CppEditorSupport *editorSupport, cppEditorSupports) {
560 561
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
562 563
    }

564 565 566
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
567
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
568 569
    }

570
    // Add the project configuration file
571
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
572
    conf += definedMacros();
573
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
574 575 576 577

    return workingCopy;
}

578
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
579 580 581 582
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

583 584 585 586 587
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

588 589
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
590 591 592 593
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

594
    if (m_indexingSupporter)
595 596
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
597
}
con's avatar
con committed
598

599 600
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
601
    QMutexLocker locker(&m_projectMutex);
602
    return m_projectToProjectsInfo.values();
603 604 605 606
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
607
    QMutexLocker locker(&m_projectMutex);
608
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
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
/// \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
637
{
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
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;
};

703 704 705 706 707 708 709 710 711 712 713 714 715
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
    m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
            foreach (const ProjectFile &cxxFile, projectPart->files) {
                m_fileToProjectParts[cxxFile.path].append(projectPart);
            }
        }
    }
}

716 717 718
QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
719
        return QFuture<void>();
720

721 722 723
    QStringList filesToReindex;
    bool filesRemoved = false;

724
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
725 726 727 728
        QMutexLocker projectLocker(&m_projectMutex);

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

730
        // Check if we can avoid a full reindexing
731
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
732
        if (oldProjectInfo.isValid()) {
733 734
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
735 736
                return QFuture<void>();

737 738 739 740 741 742 743 744 745
            // 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());
746
                }
747 748 749 750 751 752 753 754

            // 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();
755
            }
756 757 758 759 760 761 762 763 764 765 766 767

            // 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;
768 769
        }

770
        // Update Project/ProjectInfo and File/ProjectPart table
771
        m_dirty = true;
772
        m_projectToProjectsInfo.insert(project, newProjectInfo);
773
        recalculateFileToProjectParts();
774

775 776 777
    } // Mutex scope

    // If requested, dump everything we got
778 779
    if (!qgetenv("QTCREATOR_DUMP_PROJECT_INFO").isEmpty())
        dumpModelManagerConfiguration();
780

781 782 783 784 785
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

787 788
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
789 790
}

791
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
792
{
793 794
    return m_fileToProjectParts.value(fileName);
}
795

796 797 798
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(const QString &fileName) const
{
    QSet<ProjectPart::Ptr> parts;
799 800
    DependencyTable table;
    table.build(snapshot());
801
    const QStringList deps = table.filesDependingOn(fileName);
802 803
    foreach (const QString &dep, deps)
        parts.unite(QSet<ProjectPart::Ptr>::fromList(m_fileToProjectParts.value(dep)));
804

805
    return parts.values();
806
}
con's avatar
con committed
807

808 809 810 811
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

812
    part->projectDefines = m_definedMacros;
813 814 815 816 817 818 819 820 821 822
    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
823 824
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
825
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
826 827 828 829
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
830
    if (replaceDocument(doc))
831
        emit documentUpdated(doc);
832 833
}

834 835
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
836
    QMutexLocker locker(&m_projectMutex);
837 838 839
    m_dirty = true;
}

840 841 842 843 844
void CppModelManager::delayedGC()
{
    m_delayedGcTimer->start(500);
}

con's avatar
con committed
845 846
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
847
    do {
848
        QMutexLocker locker(&m_projectMutex);
849
        m_dirty = true;
850
        m_projectToProjectsInfo.remove(project);
851
        recalculateFileToProjectParts();
852 853
    } while (0);

854 855 856 857 858 859 860
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
861 862 863
    GC();
}

864
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
865
{
866
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
867
    do {
868
        QMutexLocker locker(&m_projectMutex);
869
        m_projectToProjectsInfo.clear();
870
        recalculateFileToProjectParts();
871 872
        m_dirty = true;
    } while (0);
con's avatar
con committed
873 874
}

875 876 877 878 879
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
880 881
void CppModelManager::GC()
{
882 883 884
    if (!m_enableGC)
        return;

885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
    // 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();
902
    QSet<QString> reachableFiles;
903 904 905 906
    // 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
907

908
    // Collect all files that are reachable from the project files
909
    while (!todo.isEmpty()) {
910
        const QString file = todo.last();
con's avatar
con committed
911 912
        todo.removeLast();

913
        if (reachableFiles.contains(file))
con's avatar
con committed
914
            continue;
915
        reachableFiles.insert(file);
con's avatar
con committed
916

917
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
918 919 920
            todo += doc->includedFiles();
    }

921 922
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
923 924 925 926
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

927
        if (reachableFiles.contains(fileName))
928 929
            newSnapshot.insert(it.value());
        else
930
            notReachableFiles.append(fileName);
con's avatar
con committed
931 932
    }

933 934
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
935
    replaceSnapshot(newSnapshot);
936
    emit gcFinished();
con's avatar
con committed
937
}
938

939 940 941 942 943
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

944
void CppModelManager::addModelManagerSupport(ModelManagerSupport *modelManagerSupport)
945
{
946 947 948 949
    Q_ASSERT(modelManagerSupport);
    m_idTocodeModelSupporter[modelManagerSupport->id()] = modelManagerSupport;
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    cms->setModelManagerSupports(m_idTocodeModelSupporter.values());
950
}
951

952 953
ModelManagerSupport *CppModelManager::modelManagerSupportForMimeType(const QString &mimeType) const
{
954 955 956
    QSharedPointer<CppCodeModelSettings> cms = CppToolsPlugin::instance()->codeModelSettings();
    const QString &id = cms->modelManagerSupportId(mimeType);
    return m_idTocodeModelSupporter.value(id, m_modelManagerSupportFallback.data());
957 958
}

959
CppCompletionAssistProvider *CppModelManager::completionAssistProvider(Core::IEditor *editor) const
960
{
961 962 963
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->completionAssistProvider();
964 965
}

966 967
CppHighlightingSupport *CppModelManager::highlightingSupport(Core::IEditor *editor) const
{
968 969
    TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
    if (!textEditor)
970
        return 0;
971

972 973 974
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->highlightingSupport(textEditor);
975 976
}

977
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
978 979
{
    if (indexingSupport)
980 981 982 983 984 985
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
986 987
}

988 989
void CppModelManager::setExtraDiagnostics(const QString &fileName,
                                          const QString &kind,
990 991
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
992
    QList<CppEditorSupport *> cppEditorSupports;
993

994
    {
995 996
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
997 998
    }

999 1000 1001
    foreach (CppEditorSupport *editorSupport, cppEditorSupports) {
        if (editorSupport->fileName() == fileName) {
            editorSupport->setExtraDiagnostics(kind, diagnostics);
1002 1003
            break;
        }
1004 1005
    }
}
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

void CppModelManager::setIfdefedOutBlocks(const QString &fileName,
                                          const QList<TextEditor::BlockRange> &ifdeffedOutBlocks)
{
    QList<CppEditorSupport *> cppEditorSupports;

    {
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
    }

    foreach (CppEditorSupport *editorSupport, cppEditorSupports) {
        if (editorSupport->fileName() == fileName) {
            editorSupport->setIfdefedOutBlocks(ifdeffedOutBlocks);
            break;
        }
    }
}