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

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

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

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

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

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

62
namespace CppTools {
63

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

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

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

    return h;
}
76

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

95
} // namespace CppTools
96

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

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

#include <cxxabi.h>

class DumpAST: protected ASTVisitor
{
public:
    int depth;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return m_instance;
229 230
}

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

241 242
    m_dirty = true;

243
    ProjectExplorer::ProjectExplorerPlugin *pe = ProjectExplorer::ProjectExplorerPlugin::instance();
244
    QTC_ASSERT(pe, return);
con's avatar
con committed
245

246 247 248 249
    m_delayedGcTimer = new QTimer(this);
    m_delayedGcTimer->setSingleShot(true);
    connect(m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));

250
    ProjectExplorer::SessionManager *session = pe->session();
251 252 253
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

Robert Loehning's avatar
Robert Loehning committed
254 255
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
con's avatar
con committed
256

257 258 259
    connect(session, SIGNAL(aboutToLoadSession(QString)),
            this, SLOT(onAboutToLoadSession()));

260
    connect(session, SIGNAL(aboutToUnloadSession(QString)),
261
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
262

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

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

268 269
    m_completionFallback = new InternalCompletionAssistProvider;
    m_completionAssistProvider = m_completionFallback;
270
    ExtensionSystem::PluginManager::addObject(m_completionAssistProvider);
271 272
    m_highlightingFallback = new CppHighlightingSupportInternalFactory;
    m_highlightingFactory = m_highlightingFallback;
273
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
274 275 276
}

CppModelManager::~CppModelManager()
277
{
278
    ExtensionSystem::PluginManager::removeObject(m_completionAssistProvider);
279 280
    delete m_completionFallback;
    delete m_highlightingFallback;
281
    delete m_internalIndexingSupport;
282
}
con's avatar
con committed
283

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

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

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

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

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

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

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

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

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

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

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

450
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
451
{
452
    m_extraEditorSupports.insert(editorSupport);
453 454
}

455
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
456
{
457
    m_extraEditorSupports.remove(editorSupport);
458 459
}

460 461
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
462
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
463
{
464
    Q_ASSERT(textEditor);
465

466
    QMutexLocker locker(&m_cppEditorSupportsMutex);
467

468
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
469
    if (!editorSupport) {
470 471
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
472 473 474 475
    }
    return editorSupport;
}

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/// \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;
501
        delayedGC();
502 503 504
    }
}

505
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
506
{
507
    return m_findReferences->references(symbol, context);
508 509
}

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

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

Christian Kamm's avatar
Christian Kamm committed
524 525 526 527 528
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

529 530 531 532 533
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

534 535
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
536
    QMutexLocker snapshotLocker(&m_snapshotMutex);
537 538 539
    m_snapshot = newSnapshot;
}

540
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
541
{
542
    QList<CppEditorSupport *> cppEditorSupports;
543 544

    {
545 546
        QMutexLocker locker(&m_cppEditorSupportsMutex);
        cppEditorSupports = m_cppEditorSupports.values();
547 548
    }

549
    WorkingCopy workingCopy;
550
    foreach (const CppEditorSupport *editorSupport, cppEditorSupports) {
551 552
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
553 554
    }

555 556 557
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
558
        workingCopy.insert(es->fileName(), QString::fromUtf8(es->contents()));
559 560
    }

561
    // Add the project configuration file
con's avatar
con committed
562 563
    QByteArray conf(pp_configuration);
    conf += definedMacros();
564
    workingCopy.insert(configurationFileName(), QString::fromLocal8Bit(conf));
con's avatar
con committed
565 566 567 568

    return workingCopy;
}

569
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
570 571 572 573
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

574 575
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
576 577 578 579
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

580
    if (m_indexingSupporter)
581 582
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
583
}
con's avatar
con committed
584

585 586
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
587
    QMutexLocker locker(&m_projectMutex);
588
    return m_projectToProjectsInfo.values();
589 590 591 592
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
593
    QMutexLocker locker(&m_projectMutex);
594
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
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
/// \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
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 687 688 689 690 691
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())
692
        return QFuture<void>();
693

694 695 696
    QStringList filesToReindex;
    bool filesRemoved = false;

697
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
698 699 700 701
        QMutexLocker projectLocker(&m_projectMutex);

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

703
        // Check if we can avoid a full reindexing
704
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
705
        if (oldProjectInfo.isValid()) {
706 707
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
708 709
                return QFuture<void>();

710 711 712 713 714 715 716 717 718
            // 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());
719
                }
720 721 722 723 724 725 726 727

            // 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();
728
            }
729 730 731 732 733 734 735 736 737 738 739 740

            // 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;
741 742
        }

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

755 756 757
    } // Mutex scope

    // If requested, dump everything we got
758 759
    if (!qgetenv("QTCREATOR_DUMP_PROJECT_INFO").isEmpty())
        dumpModelManagerConfiguration();
760

761 762 763 764 765
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

767 768
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
769 770
}

771
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
772
{
773
    QList<ProjectPart::Ptr> parts = m_fileToProjectParts.value(fileName);
774 775 776 777 778
    if (!parts.isEmpty())
        return parts;

    DependencyTable table;
    table.build(snapshot());
779
    const QStringList deps = table.filesDependingOn(fileName);
780
    foreach (const QString &dep, deps) {
781
        parts = m_fileToProjectParts.value(dep);
782 783 784 785 786
        if (!parts.isEmpty())
            return parts;
    }

    return parts;
787
}
con's avatar
con committed
788 789 790

bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
791
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
792 793 794 795
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
796
    if (replaceDocument(doc))
797
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
798 799
}

800 801
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
802
    QMutexLocker locker(&m_projectMutex);
803 804 805
    m_dirty = true;
}

806 807 808 809 810
void CppModelManager::delayedGC()
{
    m_delayedGcTimer->start(500);
}

con's avatar
con committed
811 812
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
813
    do {
814
        QMutexLocker locker(&m_projectMutex);
815
        m_dirty = true;
816
        m_projectToProjectsInfo.remove(project);
817 818
    } while (0);

819 820 821 822 823 824 825
    delayedGC();
}

void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
826 827 828
    GC();
}

829
void CppModelManager::onAboutToUnloadSession()
con's avatar
con committed
830
{
831
    if (Core::ProgressManager *pm = Core::ICore::progressManager())
832
        pm->cancelTasks(QLatin1String(CppTools::Constants::TASK_INDEX));
833
    do {
834
        QMutexLocker locker(&m_projectMutex);
835
        m_projectToProjectsInfo.clear();
836 837
        m_dirty = true;
    } while (0);
con's avatar
con committed
838 839
}

840 841 842 843 844
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
845 846
void CppModelManager::GC()
{
847 848 849
    if (!m_enableGC)
        return;

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
    // 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();
867
    QSet<QString> reachableFiles;
868 869 870 871
    // 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
872

873
    // Collect all files that are reachable from the project files
874
    while (!todo.isEmpty()) {
875
        const QString file = todo.last();
con's avatar
con committed
876 877
        todo.removeLast();

878
        if (reachableFiles.contains(file))
con's avatar
con committed
879
            continue;
880
        reachableFiles.insert(file);
con's avatar
con committed
881

882
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
883 884 885
            todo += doc->includedFiles();
    }

886 887
    // Find out the files in the current snapshot that are not reachable from the project files
    QStringList notReachableFiles;
888 889 890 891
    Snapshot newSnapshot;
    for (Snapshot::const_iterator it = currentSnapshot.begin(); it != currentSnapshot.end(); ++it) {
        const QString fileName = it.key();

892
        if (reachableFiles.contains(fileName))
893 894
            newSnapshot.insert(it.value());
        else
895
            notReachableFiles.append(fileName);
con's avatar
con committed
896 897
    }

898 899
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
900
    replaceSnapshot(newSnapshot);
901
    emit gcFinished();
con's avatar
con committed
902
}
903

904 905 906 907 908
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

909 910
CppCompletionSupport *CppModelManager::completionSupport(Core::IEditor *editor) const
{
911
    if (TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor))
912
        return m_completionAssistProvider->completionSupport(textEditor);
913 914 915 916
    else
        return 0;
}

917
void CppModelManager::setCppCompletionAssistProvider(CppCompletionAssistProvider *completionAssistProvider)
918
{
919
    ExtensionSystem::PluginManager::removeObject(m_completionAssistProvider);