cppmodelmanager.cpp 35.3 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
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
** 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
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

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

33
#include "abstracteditorsupport.h"
34
#include "builtinindexingsupport.h"
35
#include "cppcodemodelinspectordumper.h"
36
#include "cppcodemodelsettings.h"
37
#include "cppfindreferences.h"
38
#include "cppindexingsupport.h"
39
#include "cppmodelmanagersupportinternal.h"
40
#include "cpprefactoringchanges.h"
41
#include "cppsourceprocessor.h"
42
#include "cpptoolsconstants.h"
43
#include "cpptoolsplugin.h"
44
#include "editordocumenthandle.h"
con's avatar
con committed
45

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

55 56 57 58
#include <QCoreApplication>
#include <QDebug>
#include <QMutexLocker>
#include <QTextBlock>
59
#include <QTimer>
60

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

67 68
Q_DECLARE_METATYPE(QSet<QString>)

69 70
static const bool DumpProjectInfo = qgetenv("QTC_DUMP_PROJECT_INFO") == "1";

71 72
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
73 74
using namespace CPlusPlus;

75
#ifdef QTCREATOR_WITH_DUMP_AST
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

#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
115
#endif // QTCREATOR_WITH_DUMP_AST
116

117 118 119 120 121 122 123 124 125 126 127
namespace CppTools {
namespace Internal {

static QMutex m_instanceMutex;
static CppModelManager *m_instance;

class CppModelManagerPrivate
{
public:
    // Snapshot
    mutable QMutex m_snapshotMutex;
128
    Snapshot m_snapshot;
129 130 131 132

    // Project integration
    mutable QMutex m_projectMutex;
    QMap<ProjectExplorer::Project *, ProjectInfo> m_projectToProjectsInfo;
133 134
    QMap<Utils::FileName, QList<ProjectPart::Ptr> > m_fileToProjectParts;
    QMap<QString, ProjectPart::Ptr> m_projectFileToProjectPart;
135 136 137 138 139 140 141
    // The members below are cached/(re)calculated from the projects and/or their project parts
    bool m_dirty;
    QStringList m_projectFiles;
    ProjectPart::HeaderPaths m_headerPaths;
    QByteArray m_definedMacros;

    // Editor integration
142 143
    mutable QMutex m_cppEditorDocumentsMutex;
    QMap<QString, CppEditorDocumentHandle *> m_cppEditorDocuments;
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
    QSet<AbstractEditorSupport *> m_extraEditorSupports;

    // Completion & highlighting
    QHash<QString, ModelManagerSupport *> m_idTocodeModelSupporter;
    QScopedPointer<ModelManagerSupport> m_modelManagerSupportFallback;

    // Indexing
    CppIndexingSupport *m_indexingSupporter;
    CppIndexingSupport *m_internalIndexingSupport;
    bool m_indexerEnabled;

    CppFindReferences *m_findReferences;

    bool m_enableGC;
    QTimer m_delayedGcTimer;
};

} // namespace Internal

const char pp_configuration[] =
con's avatar
con committed
164
    "# 1 \"<configuration>\"\n"
165
    "#define Q_CREATOR_RUN 1\n"
con's avatar
con committed
166 167 168 169 170 171
    "#define __cplusplus 1\n"
    "#define __extension__\n"
    "#define __context__\n"
    "#define __range__\n"
    "#define   restrict\n"
    "#define __restrict\n"
172
    "#define __restrict__\n"
con's avatar
con committed
173

174 175 176 177
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

178 179
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
180 181
    // ### add macros for win32
    "#define __cdecl\n"
182
    "#define __stdcall\n"
183
    "#define __thiscall\n"
con's avatar
con committed
184 185 186 187 188
    "#define QT_WA(x) x\n"
    "#define CALLBACK\n"
    "#define STDMETHODCALLTYPE\n"
    "#define __RPC_FAR\n"
    "#define __declspec(a)\n"
189 190 191
    "#define STDMETHOD(method) virtual HRESULT STDMETHODCALLTYPE method\n"
    "#define __try try\n"
    "#define __except catch\n"
192 193 194
    "#define __finally\n"
    "#define __inline inline\n"
    "#define __forceinline inline\n";
con's avatar
con committed
195

196
QSet<QString> CppModelManager::timeStampModifiedFiles(const QList<Document::Ptr> &documentsToCheck)
197
{
198
    QSet<QString> sourceFiles;
199

200
    foreach (const Document::Ptr doc, documentsToCheck) {
201 202
        const QDateTime lastModified = doc->lastModified();

203
        if (!lastModified.isNull()) {
204 205 206
            QFileInfo fileInfo(doc->fileName());

            if (fileInfo.exists() && fileInfo.lastModified() != lastModified)
207
                sourceFiles.insert(doc->fileName());
208 209 210
        }
    }

211 212 213
    return sourceFiles;
}

214 215 216 217 218 219 220 221 222 223 224 225
/*!
 * \brief createSourceProcessor Create a new source processor, which will signal the
 * model manager when a document has been processed.
 *
 * Indexed file is truncated version of fully parsed document: copy of source
 * code and full AST will be dropped when indexing is done.
 *
 * \return a new source processor object, which the caller needs to delete when finished.
 */
CppSourceProcessor *CppModelManager::createSourceProcessor()
{
    CppModelManager *that = instance();
Orgad Shaneh's avatar
Orgad Shaneh committed
226
    return new CppSourceProcessor(that->snapshot(), [that](const Document::Ptr &doc) {
227 228 229 230 231
        that->emitDocumentUpdated(doc);
        doc->releaseSourceAndAST();
    });
}

232 233 234 235 236 237 238
QString CppModelManager::editorConfigurationFileName()
{
    return QLatin1String("<per-editor-defines>");
}

QString CppModelManager::configurationFileName()
{
239
    return Preprocessor::configurationFileName;
240 241
}

242 243 244 245 246 247 248
void CppModelManager::updateModifiedSourceFiles()
{
    const Snapshot snapshot = this->snapshot();
    QList<Document::Ptr> documentsToCheck;
    foreach (const Document::Ptr document, snapshot)
        documentsToCheck << document;

249
    updateSourceFiles(timeStampModifiedFiles(documentsToCheck));
250 251
}

con's avatar
con committed
252 253
/*!
    \class CppTools::CppModelManager
254 255 256
    \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
257

258 259 260 261
    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
262 263
*/

264 265
CppModelManager *CppModelManager::instance()
{
266 267 268 269 270 271 272 273
    if (m_instance)
        return m_instance;

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

    return m_instance;
274 275
}

276
CppModelManager::CppModelManager(QObject *parent)
277
    : CppModelManagerBase(parent), d(new CppModelManagerPrivate)
con's avatar
con committed
278
{
279 280 281
    d->m_indexingSupporter = 0;
    d->m_enableGC = true;

282
    qRegisterMetaType<QSet<QString> >();
283
    connect(this, SIGNAL(sourceFilesRefreshed(QSet<QString>)),
284
            this, SLOT(onSourceFilesRefreshed()));
Erik Verbruggen's avatar
Erik Verbruggen committed
285

286 287
    d->m_findReferences = new CppFindReferences(this);
    d->m_indexerEnabled = qgetenv("QTC_NO_CODE_INDEXER") != "1";
Roberto Raggi's avatar
Roberto Raggi committed
288

289
    d->m_dirty = true;
290

291 292 293
    d->m_delayedGcTimer.setObjectName(QLatin1String("CppModelManager::m_delayedGcTimer"));
    d->m_delayedGcTimer.setSingleShot(true);
    connect(&d->m_delayedGcTimer, SIGNAL(timeout()), this, SLOT(GC()));
294

hjk's avatar
hjk committed
295 296
    QObject *sessionManager = ProjectExplorer::SessionManager::instance();
    connect(sessionManager, SIGNAL(projectAdded(ProjectExplorer::Project*)),
297
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
298
    connect(sessionManager, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
Robert Loehning's avatar
Robert Loehning committed
299
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
hjk's avatar
hjk committed
300
    connect(sessionManager, SIGNAL(aboutToLoadSession(QString)),
301
            this, SLOT(onAboutToLoadSession()));
hjk's avatar
hjk committed
302
    connect(sessionManager, SIGNAL(aboutToUnloadSession(QString)),
303
            this, SLOT(onAboutToUnloadSession()));
304 305 306 307

    connect(Core::EditorManager::instance(), &Core::EditorManager::currentEditorChanged,
            this, &CppModelManager::onCurrentEditorChanged);

308 309
    connect(Core::DocumentManager::instance(), &Core::DocumentManager::allDocumentsRenamed,
            this, &CppModelManager::renameIncludes);
con's avatar
con committed
310

311 312 313
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

con's avatar
con committed
314
    qRegisterMetaType<CPlusPlus::Document::Ptr>("CPlusPlus::Document::Ptr");
315
    qRegisterMetaType<QList<Document::DiagnosticMessage>>(
316
                "QList<CPlusPlus::Document::DiagnosticMessage>");
con's avatar
con committed
317

318
    d->m_modelManagerSupportFallback.reset(new ModelManagerSupportInternal);
319
    CppToolsPlugin::instance()->codeModelSettings()->setDefaultId(
320 321
                d->m_modelManagerSupportFallback->id());
    addModelManagerSupport(d->m_modelManagerSupportFallback.data());
322

323
    d->m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
324 325 326
}

CppModelManager::~CppModelManager()
327
{
328
    delete d->m_internalIndexingSupport;
329
    delete d;
330
}
con's avatar
con committed
331

332
Snapshot CppModelManager::snapshot() const
333
{
334 335
    QMutexLocker locker(&d->m_snapshotMutex);
    return d->m_snapshot;
336
}
con's avatar
con committed
337

338 339
Document::Ptr CppModelManager::document(const QString &fileName) const
{
340 341
    QMutexLocker locker(&d->m_snapshotMutex);
    return d->m_snapshot.document(fileName);
342 343 344 345 346 347 348
}

/// Replace the document in the snapshot.
///
/// \returns true if successful, false if the new document is out-dated.
bool CppModelManager::replaceDocument(Document::Ptr newDoc)
{
349
    QMutexLocker locker(&d->m_snapshotMutex);
350

351
    Document::Ptr previous = d->m_snapshot.document(newDoc->fileName());
352 353 354 355
    if (previous && (newDoc->revision() != 0 && newDoc->revision() < previous->revision()))
        // the new document is outdated
        return false;

356
    d->m_snapshot.insert(newDoc);
357 358 359
    return true;
}

360 361
void CppModelManager::ensureUpdated()
{
362 363
    QMutexLocker locker(&d->m_projectMutex);
    if (!d->m_dirty)
364 365
        return;

366 367 368 369
    d->m_projectFiles = internalProjectFiles();
    d->m_headerPaths = internalHeaderPaths();
    d->m_definedMacros = internalDefinedMacros();
    d->m_dirty = false;
370 371
}

372
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
373 374
{
    QStringList files;
375
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(d->m_projectToProjectsInfo);
con's avatar
con committed
376 377
    while (it.hasNext()) {
        it.next();
378
        const ProjectInfo pinfo = it.value();
379
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
380 381
            foreach (const ProjectFile &file, part->files)
                files += file.path;
382
        }
con's avatar
con committed
383
    }
384
    files.removeDuplicates();
con's avatar
con committed
385 386 387
    return files;
}

388
ProjectPart::HeaderPaths CppModelManager::internalHeaderPaths() const
con's avatar
con committed
389
{
390
    ProjectPart::HeaderPaths headerPaths;
391
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(d->m_projectToProjectsInfo);
con's avatar
con committed
392 393
    while (it.hasNext()) {
        it.next();
394
        const ProjectInfo pinfo = it.value();
395 396
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            foreach (const ProjectPart::HeaderPath &path, part->headerPaths) {
397
                const ProjectPart::HeaderPath hp(QDir::cleanPath(path.path), path.type);
398 399 400 401
                if (!headerPaths.contains(hp))
                    headerPaths += hp;
            }
        }
con's avatar
con committed
402
    }
403
    return headerPaths;
con's avatar
con committed
404 405
}

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
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);
        }
    }
}

422
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
423 424
{
    QByteArray macros;
425
    QSet<QByteArray> alreadyIn;
426
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(d->m_projectToProjectsInfo);
con's avatar
con committed
427 428
    while (it.hasNext()) {
        it.next();
429
        const ProjectInfo pinfo = it.value();
430
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
431 432
            addUnique(part->toolchainDefines.split('\n'), &macros, &alreadyIn);
            addUnique(part->projectDefines.split('\n'), &macros, &alreadyIn);
433
            if (!part->projectConfigFile.isEmpty())
434
                macros += ProjectPart::readProjectConfigFile(part);
435
        }
con's avatar
con committed
436 437 438 439
    }
    return macros;
}

440
/// This function will acquire mutexes!
441
void CppModelManager::dumpModelManagerConfiguration(const QString &logFileId)
442
{
443 444 445 446
    const Snapshot globalSnapshot = snapshot();
    const QString globalSnapshotTitle
        = QString::fromLatin1("Global/Indexing Snapshot (%1 Documents)").arg(globalSnapshot.size());

447
    CppCodeModelInspector::Dumper dumper(globalSnapshot, logFileId);
448 449 450
    dumper.dumpProjectInfos(projectInfos());
    dumper.dumpSnapshot(globalSnapshot, globalSnapshotTitle, /*isGlobalSnapshot=*/ true);
    dumper.dumpWorkingCopy(workingCopy());
451
    ensureUpdated();
452
    dumper.dumpMergedEntities(d->m_headerPaths, d->m_definedMacros);
453 454
}

455
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
456
{
457
    d->m_extraEditorSupports.insert(editorSupport);
458 459
}

460
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
461
{
462
    d->m_extraEditorSupports.remove(editorSupport);
463 464
}

465
CppEditorDocumentHandle *CppModelManager::cppEditorDocument(const QString &filePath) const
466
{
467 468
    if (filePath.isEmpty())
        return 0;
469

470 471
    QMutexLocker locker(&d->m_cppEditorDocumentsMutex);
    return d->m_cppEditorDocuments.value(filePath, 0);
472 473
}

474
void CppModelManager::registerCppEditorDocument(CppEditorDocumentHandle *editorDocument)
475
{
476 477 478
    QTC_ASSERT(editorDocument, return);
    const QString filePath = editorDocument->filePath();
    QTC_ASSERT(!filePath.isEmpty(), return);
479

480 481 482
    QMutexLocker locker(&d->m_cppEditorDocumentsMutex);
    QTC_ASSERT(d->m_cppEditorDocuments.value(filePath, 0) == 0, return);
    d->m_cppEditorDocuments.insert(filePath, editorDocument);
483
}
484

485
void CppModelManager::unregisterCppEditorDocument(const QString &filePath)
486 487
{
    QTC_ASSERT(!filePath.isEmpty(), return);
488

489 490
    static short closedCppDocuments = 0;
    int openCppDocuments = 0;
491

492
    {
493 494 495 496
        QMutexLocker locker(&d->m_cppEditorDocumentsMutex);
        QTC_ASSERT(d->m_cppEditorDocuments.value(filePath, 0), return);
        QTC_CHECK(d->m_cppEditorDocuments.remove(filePath) == 1);
        openCppDocuments = d->m_cppEditorDocuments.size();
497 498
    }

499 500 501
    ++closedCppDocuments;
    if (openCppDocuments == 0 || closedCppDocuments == 5) {
        closedCppDocuments = 0;
502
        delayedGC();
503 504 505
    }
}

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

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

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

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

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

535
void CppModelManager::replaceSnapshot(const Snapshot &newSnapshot)
536
{
537 538
    QMutexLocker snapshotLocker(&d->m_snapshotMutex);
    d->m_snapshot = newSnapshot;
539 540
}

541
WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
542
{
543
    WorkingCopy workingCopy;
544

545 546 547 548 549
    foreach (const CppEditorDocumentHandle *cppEditorDocument, cppEditorDocuments()) {
        workingCopy.insert(cppEditorDocument->filePath(),
                           cppEditorDocument->contents(),
                           cppEditorDocument->revision());
    }
con's avatar
con committed
550

551
    QSetIterator<AbstractEditorSupport *> it(d->m_extraEditorSupports);
552 553
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
554
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
555 556
    }

557
    // Add the project configuration file
558
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
559
    conf += definedMacros();
560
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
561 562 563 564

    return workingCopy;
}

565
WorkingCopy CppModelManager::workingCopy() const
566 567 568 569
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

570 571 572 573 574
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

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

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

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

592
ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
593
{
594
    QMutexLocker locker(&d->m_projectMutex);
595
    return d->m_projectToProjectsInfo.value(project, ProjectInfo());
596 597
}

598 599 600 601 602 603
/// \brief Remove all files and their includes (recursively) of given ProjectInfo from the snapshot.
void CppModelManager::removeProjectInfoFilesAndIncludesFromSnapshot(const ProjectInfo &projectInfo)
{
    if (!projectInfo.isValid())
        return;

604
    QMutexLocker snapshotLocker(&d->m_snapshotMutex);
605 606
    foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
        foreach (const ProjectFile &cxxFile, projectPart->files) {
607 608 609
            foreach (const QString &fileName, d->m_snapshot.allIncludesForDocument(cxxFile.path))
                d->m_snapshot.remove(fileName);
            d->m_snapshot.remove(cxxFile.path);
610 611 612 613
        }
    }
}

614
QList<CppEditorDocumentHandle *> CppModelManager::cppEditorDocuments() const
615
{
616 617
    QMutexLocker locker(&d->m_cppEditorDocumentsMutex);
    return d->m_cppEditorDocuments.values();
618 619
}

620 621 622
/// \brief Remove all given files from the snapshot.
void CppModelManager::removeFilesFromSnapshot(const QSet<QString> &filesToRemove)
{
623
    QMutexLocker snapshotLocker(&d->m_snapshotMutex);
624 625
    QSetIterator<QString> i(filesToRemove);
    while (i.hasNext())
626
        d->m_snapshot.remove(i.next());
627 628 629
}

class ProjectInfoComparer
630
{
631
public:
632 633
    ProjectInfoComparer(const ProjectInfo &oldProjectInfo,
                        const ProjectInfo &newProjectInfo)
634
        : m_old(oldProjectInfo)
635
        , m_oldSourceFiles(oldProjectInfo.sourceFiles())
636
        , m_new(newProjectInfo)
637
        , m_newSourceFiles(newProjectInfo.sourceFiles())
638 639
    {}

640 641 642
    bool definesChanged() const { return m_new.definesChanged(m_old); }
    bool configurationChanged() const { return m_new.configurationChanged(m_old); }
    bool configurationOrFilesChanged() const { return m_new.configurationOrFilesChanged(m_old); }
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

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

672
        return CppModelManager::timeStampModifiedFiles(documentsToCheck);
673 674 675
    }

private:
676
    const ProjectInfo &m_old;
677 678
    const QSet<QString> m_oldSourceFiles;

679
    const ProjectInfo &m_new;
680 681 682
    const QSet<QString> m_newSourceFiles;
};

683 684 685
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
686 687 688
    d->m_projectFileToProjectPart.clear();
    d->m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, d->m_projectToProjectsInfo) {
689
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
690
            d->m_projectFileToProjectPart[projectPart->projectFile] = projectPart;
691
            foreach (const ProjectFile &cxxFile, projectPart->files)
692 693
                d->m_fileToProjectParts[Utils::FileName::fromString(cxxFile.path)].append(
                            projectPart);
694

695 696 697 698
        }
    }
}

699
void CppModelManager::updateCppEditorDocuments() const
700
{
701 702
    // Refresh visible documents
    QSet<Core::IDocument *> visibleCppEditorDocuments;
703
    foreach (Core::IEditor *editor, Core::EditorManager::visibleEditors()) {
704
        if (Core::IDocument *document = editor->document()) {
705 706
            const QString filePath = document->filePath().toString();
            if (CppEditorDocumentHandle *theCppEditorDocument = cppEditorDocument(filePath)) {
707
                visibleCppEditorDocuments.insert(document);
708
                theCppEditorDocument->processor()->run();
709
            }
710 711 712
        }
    }

713 714 715 716 717
    // Mark invisible documents dirty
    QSet<Core::IDocument *> invisibleCppEditorDocuments
        = Core::DocumentModel::openedDocuments().toSet();
    invisibleCppEditorDocuments.subtract(visibleCppEditorDocuments);
    foreach (Core::IDocument *document, invisibleCppEditorDocuments) {
718 719 720
        const QString filePath = document->filePath().toString();
        if (CppEditorDocumentHandle *theCppEditorDocument = cppEditorDocument(filePath))
            theCppEditorDocument->setNeedsRefresh(true);
721 722 723
    }
}

724 725 726
QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
727
        return QFuture<void>();
728

729
    QSet<QString> filesToReindex;
730 731
    bool filesRemoved = false;

732
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
733
        QMutexLocker projectLocker(&d->m_projectMutex);
734 735

        ProjectExplorer::Project *project = newProjectInfo.project().data();
736
        const QSet<QString> newSourceFiles = newProjectInfo.sourceFiles();
737

738
        // Check if we can avoid a full reindexing
739
        ProjectInfo oldProjectInfo = d->m_projectToProjectsInfo.value(project);
740
        if (oldProjectInfo.isValid()) {
741
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
742 743 744 745

            if (!comparer.configurationOrFilesChanged()) {
                // Some other attached data might have changed
                d->m_projectToProjectsInfo.insert(project, newProjectInfo);
746
                return QFuture<void>();
747
            }
748

749 750 751
            // If the project configuration changed, do a full reindexing
            if (comparer.configurationChanged()) {
                removeProjectInfoFilesAndIncludesFromSnapshot(oldProjectInfo);
752
                filesToReindex.unite(newSourceFiles);
753 754 755

                // The "configuration file" includes all defines and therefore should be updated
                if (comparer.definesChanged()) {
756 757
                    QMutexLocker snapshotLocker(&d->m_snapshotMutex);
                    d->m_snapshot.remove(configurationFileName());
758
                }
759 760 761 762

            // Otherwise check for added and modified files
            } else {
                const QSet<QString> addedFiles = comparer.addedFiles();
763
                filesToReindex.unite(addedFiles);
764 765

                const QSet<QString> modifiedFiles = comparer.timeStampModifiedFiles(snapshot());
766
                filesToReindex.unite(modifiedFiles);
767
            }
768 769 770 771 772 773 774 775 776 777 778

            // 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 {
779
            filesToReindex.unite(newSourceFiles);
780 781
        }

782
        // Update Project/ProjectInfo and File/ProjectPart table
783 784
        d->m_dirty = true;
        d->m_projectToProjectsInfo.insert(project, newProjectInfo);
785
        recalculateFileToProjectParts();
786

787 788 789
    } // Mutex scope

    // If requested, dump everything we got
790
    if (DumpProjectInfo)
791
        dumpModelManagerConfiguration(QLatin1String("updateProjectInfo"));
792

793 794 795 796 797
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

799 800 801 802
    // Ideally, we would update all the editor documents that depend on the 'filesToReindex'.
    // However, on e.g. a session restore first the editor documents are created and then the
    // project updates come in. That is, there are no reasonable dependency tables based on
    // resolved includes that we could rely on.
803
    updateCppEditorDocuments();
804

805 806
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
807 808
}

809 810
ProjectPart::Ptr CppModelManager::projectPartForProjectFile(const QString &projectFile) const
{
811
    return d->m_projectFileToProjectPart.value(projectFile);
812 813
}

814
QList<ProjectPart::Ptr> CppModelManager::projectPart(const Utils::FileName &fileName) const
815
{
816 817
    QMutexLocker locker(&d->m_projectMutex);
    return d->m_fileToProjectParts.value(fileName);
818
}
819

820 821
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(
        const Utils::FileName &fileName) const
822 823
{
    QSet<ProjectPart::Ptr> parts;
824
    const Utils::FileNameList deps = snapshot().filesDependingOn(fileName);
825

826 827
    QMutexLocker locker(&d->m_projectMutex);
    foreach (const Utils::FileName &dep, deps) {
828
        parts.unite(QSet<ProjectPart::Ptr>::fromList(d->m_fileToProjectParts.value(dep)));
829
    }
830

831
    return parts.values();