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

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

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

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

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

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

63
namespace CppTools {
64

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

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

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

    return h;
}
77

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

96
} // namespace CppTools
97

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

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

#include <cxxabi.h>

class DumpAST: protected ASTVisitor
{
public:
    int depth;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return m_instance;
230 231
}

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

240 241
    m_dirty = true;

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

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

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

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

261
    m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
262 263
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
                m_modelManagerSupportFallback->id());
264 265
    addModelManagerSupport(m_modelManagerSupportFallback.data());

266
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
267 268 269
}

CppModelManager::~CppModelManager()
270
{
271
    delete m_internalIndexingSupport;
272
}
con's avatar
con committed
273

274
Snapshot CppModelManager::snapshot() const
275
{
276
    QMutexLocker locker(&m_snapshotMutex);
277 278
    return m_snapshot;
}
con's avatar
con committed
279

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

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

302 303
void CppModelManager::ensureUpdated()
{
304
    QMutexLocker locker(&m_projectMutex);
305
    if (!m_dirty)
306 307
        return;

308 309 310 311
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
312 313 314
    m_dirty = false;
}

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

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

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

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

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

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

440
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
441
{
442
    m_extraEditorSupports.insert(editorSupport);
443 444
}

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

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

456
    QMutexLocker locker(&m_cppEditorSupportsMutex);
457

458
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
459
    if (!editorSupport) {
460 461
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
462 463 464 465
    }
    return editorSupport;
}

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

495
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
496
{
497
    return m_findReferences->references(symbol, context);
498 499
}

500
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
501
{
502
    if (symbol->identifier())
503
        m_findReferences->findUsages(symbol, context);
504 505
}

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

Christian Kamm's avatar
Christian Kamm committed
514 515 516 517 518
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

519 520 521 522 523
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

524 525
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
526
    QMutexLocker snapshotLocker(&m_snapshotMutex);
527 528 529
    m_snapshot = newSnapshot;
}

530
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
531
{
532
    QList<CppEditorSupport *> cppEditorSupports;
533 534

    {
535 536
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
537 538
    }

539
    WorkingCopy workingCopy;
540
    foreach (const CppEditorSupport *editorSupport, cppEditorSupports) {
541 542
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
543 544
    }

545 546 547
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
548
        workingCopy.insert(es->fileName(), es->contents());
549 550
    }

551
    // Add the project configuration file
552
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
553
    conf += definedMacros();
554
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
555 556 557 558

    return workingCopy;
}

559
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
560 561 562 563
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

564 565 566 567 568
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

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

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

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

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
588
    QMutexLocker locker(&m_projectMutex);
589
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
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
/// \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
618
{
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
public:
    ProjectInfoComparer(const CppModelManager::ProjectInfo &oldProjectInfo,
                        const CppModelManager::ProjectInfo &newProjectInfo)
        : m_old(oldProjectInfo)
        , m_oldSourceFiles(oldProjectInfo.sourceFiles().toSet())
        , m_new(newProjectInfo)
        , m_newSourceFiles(newProjectInfo.sourceFiles().toSet())
    {}

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

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

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

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

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

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

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

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

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

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

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

689 690 691
    QStringList filesToReindex;
    bool filesRemoved = false;

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

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

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

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

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

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

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

750 751 752
    } // Mutex scope

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

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

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

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

766
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
767
{
768 769
    return m_fileToProjectParts.value(fileName);
}
770

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

780
    return parts.values();
781
}
con's avatar
con committed
782

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

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

    return part;
}

con's avatar
con committed
798 799
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
800
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
801 802 803 804
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
805
    if (replaceDocument(doc))
806
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
807 808
}

809 810
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
811
    QMutexLocker locker(&m_projectMutex);
812 813 814
    m_dirty = true;
}

815 816 817 818 819
void CppModelManager::delayedGC()
{
    m_delayedGcTimer->start(500);
}

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

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

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

838
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
839
{
840
    Core::ProgressManager::cancelTasks(CppTools::Constants::TASK_INDEX);
841
    do {
842
        QMutexLocker locker(&m_projectMutex);
843
        m_projectToProjectsInfo.clear();
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
}

939 940
CppHighlightingSupport *CppModelManager::highlightingSupport(Core::IEditor *editor) const
{
941 942
    TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
    if (!textEditor)
943
        return 0;
944

945 946 947
    ModelManagerSupport *cms = modelManagerSupportForMimeType(editor->document()->mimeType());

    return cms->highlightingSupport(textEditor);
948 949
}

950
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
951 952
{
    if (indexingSupport)
953 954 955 956 957 958
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
959 960
}

961 962
void CppModelManager::setExtraDiagnostics(const QString &fileName,
                                          const QString &kind,
963 964
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
965
    QList<CppEditorSupport *> cppEditorSupports;
966

967
    {
968 969
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
970 971
    }

972 973 974
    foreach (CppEditorSupport *editorSupport, cppEditorSupports) {
        if (editorSupport->fileName() == fileName) {
            editorSupport->setExtraDiagnostics(kind, diagnostics);
975 976
            break;
        }
977 978
    }
}
979 980