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

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

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

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

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

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

64 65
static const bool DumpProjectInfo = qgetenv("QTC_DUMP_PROJECT_INFO") == "1";

66 67
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
68 69
using namespace CPlusPlus;

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

#include <cxxabi.h>

class DumpAST: protected ASTVisitor
{
public:
    int depth;

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

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

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

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

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

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

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

Roberto Raggi's avatar
Roberto Raggi committed
110
#endif // QTCREATOR_WITH_DUMP_AST
111

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

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

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

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

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

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

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

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

160 161 162
    return sourceFiles;
}

163 164 165 166 167 168 169 170 171 172 173 174
/*!
 * \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
175
    return new CppSourceProcessor(that->snapshot(), [that](const Document::Ptr &doc) {
176 177 178 179 180
        that->emitDocumentUpdated(doc);
        doc->releaseSourceAndAST();
    });
}

181 182 183 184 185 186 187 188 189
void CppModelManager::updateModifiedSourceFiles()
{
    const Snapshot snapshot = this->snapshot();
    QList<Document::Ptr> documentsToCheck;
    foreach (const Document::Ptr document, snapshot)
        documentsToCheck << document;

    const QStringList filesToUpdate = timeStampModifiedFiles(documentsToCheck);
    updateSourceFiles(filesToUpdate);
190 191
}

con's avatar
con committed
192 193
/*!
    \class CppTools::CppModelManager
194 195 196
    \brief The CppModelManager keeps tracks of the source files the code model is aware of.

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

198 199 200 201
    The snapshot is updated in case e.g.
        * New files are opened/edited (Editor integration)
        * A project manager pushes updated project information (Project integration)
        * Files are garbage collected
con's avatar
con committed
202 203
*/

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

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

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

    return m_instance;
217 218
}

219
CppModelManager::CppModelManager(QObject *parent)
220
    : CppModelManagerInterface(parent)
221
    , m_indexingSupporter(0)
222
    , m_enableGC(true)
con's avatar
con committed
223
{
Erik Verbruggen's avatar
Erik Verbruggen committed
224 225 226 227
    connect(this, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            this, SIGNAL(globalSnapshotChanged()));
    connect(this, SIGNAL(aboutToRemoveFiles(QStringList)),
            this, SIGNAL(globalSnapshotChanged()));
228 229
    connect(this, SIGNAL(sourceFilesRefreshed(QStringList)),
            this, SLOT(onSourceFilesRefreshed()));
Erik Verbruggen's avatar
Erik Verbruggen committed
230

Roberto Raggi's avatar
Roberto Raggi committed
231
    m_findReferences = new CppFindReferences(this);
232
    m_indexerEnabled = qgetenv("QTC_NO_CODE_INDEXER") != "1";
Roberto Raggi's avatar
Roberto Raggi committed
233

234 235
    m_dirty = true;

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

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

250 251 252
    connect(Core::ICore::instance(), SIGNAL(coreAboutToClose()),
            this, SLOT(onCoreAboutToClose()));

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

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

260
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
261 262 263
}

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

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

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

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

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

302
    m_projectFiles = internalProjectFiles();
303
    m_headerPaths = internalHeaderPaths();
304
    m_definedMacros = internalDefinedMacros();
305 306 307
    m_dirty = false;
}

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

324
ProjectPart::HeaderPaths CppModelManager::internalHeaderPaths() const
con's avatar
con committed
325
{
326
    ProjectPart::HeaderPaths headerPaths;
327
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
328 329
    while (it.hasNext()) {
        it.next();
330
        const ProjectInfo pinfo = it.value();
331 332 333 334 335 336 337 338
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            foreach (const ProjectPart::HeaderPath &path, part->headerPaths) {
                const ProjectPart::HeaderPath hp(CppSourceProcessor::cleanPath(path.path),
                                                 path.type);
                if (!headerPaths.contains(hp))
                    headerPaths += hp;
            }
        }
con's avatar
con committed
339
    }
340
    return headerPaths;
con's avatar
con committed
341 342
}

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
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);
        }
    }
}

359
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
360 361
{
    QByteArray macros;
362
    QSet<QByteArray> alreadyIn;
363
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projectToProjectsInfo);
con's avatar
con committed
364 365
    while (it.hasNext()) {
        it.next();
366
        const ProjectInfo pinfo = it.value();
367
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
368 369
            addUnique(part->toolchainDefines.split('\n'), &macros, &alreadyIn);
            addUnique(part->projectDefines.split('\n'), &macros, &alreadyIn);
370
            if (!part->projectConfigFile.isEmpty())
371
                macros += ProjectPart::readProjectConfigFile(part);
372
        }
con's avatar
con committed
373 374 375 376
    }
    return macros;
}

377
/// This function will acquire mutexes!
378
void CppModelManager::dumpModelManagerConfiguration(const QString &logFileId)
379
{
380 381 382 383
    const Snapshot globalSnapshot = snapshot();
    const QString globalSnapshotTitle
        = QString::fromLatin1("Global/Indexing Snapshot (%1 Documents)").arg(globalSnapshot.size());

384
    CppCodeModelInspector::Dumper dumper(globalSnapshot, logFileId);
385 386 387
    dumper.dumpProjectInfos(projectInfos());
    dumper.dumpSnapshot(globalSnapshot, globalSnapshotTitle, /*isGlobalSnapshot=*/ true);
    dumper.dumpWorkingCopy(workingCopy());
388
    ensureUpdated();
389
    dumper.dumpMergedEntities(m_headerPaths, m_definedMacros);
390 391
}

392
void CppModelManager::addExtraEditorSupport(AbstractEditorSupport *editorSupport)
393
{
394
    m_extraEditorSupports.insert(editorSupport);
395 396
}

397
void CppModelManager::removeExtraEditorSupport(AbstractEditorSupport *editorSupport)
398
{
399
    m_extraEditorSupports.remove(editorSupport);
400 401
}

402 403
/// \brief Returns the \c CppEditorSupport for the given text editor. It will
///        create one when none exists yet.
404
CppEditorSupport *CppModelManager::cppEditorSupport(TextEditor::BaseTextEditor *textEditor)
405
{
406
    Q_ASSERT(textEditor);
407

408
    QMutexLocker locker(&m_cppEditorSupportsMutex);
409

410
    CppEditorSupport *editorSupport = m_cppEditorSupports.value(textEditor, 0);
411
    if (!editorSupport && isCppEditor(textEditor)) {
412 413
        editorSupport = new CppEditorSupport(this, textEditor);
        m_cppEditorSupports.insert(textEditor, editorSupport);
414 415 416 417
    }
    return editorSupport;
}

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
/// \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;
443
        delayedGC();
444 445 446
    }
}

447
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
448
{
449
    return m_findReferences->references(symbol, context);
450 451
}

452
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
453
{
454
    if (symbol->identifier())
455
        m_findReferences->findUsages(symbol, context);
456 457
}

458 459
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
460
                                   const QString &replacement)
461 462
{
    if (symbol->identifier())
463
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
464 465
}

Christian Kamm's avatar
Christian Kamm committed
466 467 468 469 470
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

471 472 473 474 475
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

476 477
void CppModelManager::replaceSnapshot(const CPlusPlus::Snapshot &newSnapshot)
{
478
    QMutexLocker snapshotLocker(&m_snapshotMutex);
479 480 481
    m_snapshot = newSnapshot;
}

482
WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
483
{
484
    WorkingCopy workingCopy;
485 486

    foreach (const CppEditorSupport *editorSupport, cppEditorSupportList()) {
487 488
        workingCopy.insert(editorSupport->fileName(), editorSupport->contents(),
                           editorSupport->editorRevision());
con's avatar
con committed
489 490
    }

491 492 493
    QSetIterator<AbstractEditorSupport *> it(m_extraEditorSupports);
    while (it.hasNext()) {
        AbstractEditorSupport *es = it.next();
494
        workingCopy.insert(es->fileName(), es->contents(), es->revision());
495 496
    }

497
    // Add the project configuration file
498
    QByteArray conf = codeModelConfiguration();
con's avatar
con committed
499
    conf += definedMacros();
500
    workingCopy.insert(configurationFileName(), conf);
con's avatar
con committed
501 502 503 504

    return workingCopy;
}

505
WorkingCopy CppModelManager::workingCopy() const
506 507 508 509
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

510 511 512 513 514
QByteArray CppModelManager::codeModelConfiguration() const
{
    return QByteArray::fromRawData(pp_configuration, qstrlen(pp_configuration));
}

515 516
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles,
                                                 ProgressNotificationMode mode)
517 518 519 520
{
    if (sourceFiles.isEmpty() || !m_indexerEnabled)
        return QFuture<void>();

521
    if (m_indexingSupporter)
522 523
        m_indexingSupporter->refreshSourceFiles(sourceFiles, mode);
    return m_internalIndexingSupport->refreshSourceFiles(sourceFiles, mode);
524
}
con's avatar
con committed
525

526
QList<ProjectInfo> CppModelManager::projectInfos() const
527
{
528
    QMutexLocker locker(&m_projectMutex);
529
    return m_projectToProjectsInfo.values();
530 531
}

532
ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
533
{
534
    QMutexLocker locker(&m_projectMutex);
535
    return m_projectToProjectsInfo.value(project, ProjectInfo(project));
536 537
}

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
/// \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);
        }
    }
}

554 555 556 557 558 559
QList<CppEditorSupport *> CppModelManager::cppEditorSupportList() const
{
    QMutexLocker locker(&m_cppEditorSupportsMutex);
    return m_cppEditorSupports.values();
}

560 561 562 563 564 565 566 567 568 569
/// \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
570
{
571
public:
572 573
    ProjectInfoComparer(const ProjectInfo &oldProjectInfo,
                        const ProjectInfo &newProjectInfo)
574 575 576 577 578 579 580 581 582 583 584 585 586 587
        : 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()
588
            || m_new.headerPaths() != m_old.headerPaths();
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
    }

    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:
628
    const ProjectInfo &m_old;
629 630
    const QSet<QString> m_oldSourceFiles;

631
    const ProjectInfo &m_new;
632 633 634
    const QSet<QString> m_newSourceFiles;
};

635 636 637
/// Make sure that m_projectMutex is locked when calling this.
void CppModelManager::recalculateFileToProjectParts()
{
638
    m_projectFileToProjectPart.clear();
639 640 641
    m_fileToProjectParts.clear();
    foreach (const ProjectInfo &projectInfo, m_projectToProjectsInfo) {
        foreach (const ProjectPart::Ptr &projectPart, projectInfo.projectParts()) {
642 643
            m_projectFileToProjectPart[projectPart->projectFile] = projectPart;
            foreach (const ProjectFile &cxxFile, projectPart->files)
644
                m_fileToProjectParts[cxxFile.path].append(projectPart);
645

646 647 648 649
        }
    }
}

650 651 652
QFuture<void> CppModelManager::updateProjectInfo(const ProjectInfo &newProjectInfo)
{
    if (!newProjectInfo.isValid())
653
        return QFuture<void>();
654

655 656 657
    QStringList filesToReindex;
    bool filesRemoved = false;

658
    { // Only hold the mutex for a limited scope, so the dumping afterwards does not deadlock.
659 660 661 662
        QMutexLocker projectLocker(&m_projectMutex);

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

664
        // Check if we can avoid a full reindexing
665
        ProjectInfo oldProjectInfo = m_projectToProjectsInfo.value(project);
666
        if (oldProjectInfo.isValid()) {
667 668
            ProjectInfoComparer comparer(oldProjectInfo, newProjectInfo);
            if (comparer.nothingChanged())
669 670
                return QFuture<void>();

671 672 673 674 675 676 677 678 679
            // 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());
680
                }
681 682 683 684 685 686 687 688

            // 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();
689
            }
690 691 692 693 694 695 696 697 698 699 700 701

            // 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;
702 703
        }

704
        // Update Project/ProjectInfo and File/ProjectPart table
705
        m_dirty = true;
706
        m_projectToProjectsInfo.insert(project, newProjectInfo);
707
        recalculateFileToProjectParts();
708

709 710 711
    } // Mutex scope

    // If requested, dump everything we got
712
    if (DumpProjectInfo)
713
        dumpModelManagerConfiguration(QLatin1String("updateProjectInfo"));
714

715 716 717 718 719
    // Remove files from snapshot that are not reachable any more
    if (filesRemoved)
        GC();

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

721 722
    // Trigger reindexing
    return updateSourceFiles(filesToReindex, ForcedProgressNotification);
723 724
}

725 726 727 728 729
ProjectPart::Ptr CppModelManager::projectPartForProjectFile(const QString &projectFile) const
{
    return m_projectFileToProjectPart.value(projectFile);
}

730
QList<ProjectPart::Ptr> CppModelManager::projectPart(const QString &fileName) const
731
{
732
    QMutexLocker locker(&m_projectMutex);
733 734
    return m_fileToProjectParts.value(fileName);
}
735

736 737 738
QList<ProjectPart::Ptr> CppModelManager::projectPartFromDependencies(const QString &fileName) const
{
    QSet<ProjectPart::Ptr> parts;
739 740
    DependencyTable table;
    table.build(snapshot());
741
    const QStringList deps = table.filesDependingOn(fileName);
742 743
    foreach (const QString &dep, deps)
        parts.unite(QSet<ProjectPart::Ptr>::fromList(m_fileToProjectParts.value(dep)));
744

745
    return parts.values();
746
}
con's avatar
con committed
747

748 749 750 751
ProjectPart::Ptr CppModelManager::fallbackProjectPart() const
{
    ProjectPart::Ptr part(new ProjectPart);

752
    part->projectDefines = m_definedMacros;
753
    part->headerPaths = m_headerPaths;
754 755 756 757 758 759 760 761
    part->cVersion = ProjectPart::C11;
    part->cxxVersion = ProjectPart::CXX11;
    part->cxxExtensions = ProjectPart::AllExtensions;
    part->qtVersion = ProjectPart::Qt5;

    return part;
}

con's avatar
con committed
762 763
bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
764
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
765 766 767 768
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{
769
    if (replaceDocument(doc))
770
        emit documentUpdated(doc);
Roberto Raggi's avatar
Roberto Raggi committed
771 772
}

773 774
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
775
    QMutexLocker locker(&m_projectMutex);
776 777 778
    m_dirty = true;
}

779 780
void CppModelManager::delayedGC()
{
781 782
    if (m_enableGC)
        m_delayedGcTimer->start(500);
783 784
}

con's avatar
con committed
785 786
void CppModelManager::onAboutToRemoveProject(ProjectExplorer::Project *project)
{
787
    do {
788
        QMutexLocker locker(&m_projectMutex);
789
        m_dirty = true;
790
        m_projectToProjectsInfo.remove(project);
791
        recalculateFileToProjectParts();
792 793
    } while (0);

794 795 796
    delayedGC();
}

797 798 799 800 801 802 803 804
void CppModelManager::onSourceFilesRefreshed() const
{
    if (BuiltinIndexingSupport::isFindErrorsIndexingActive()) {
        QTimer::singleShot(1, QCoreApplication::instance(), SLOT(quit()));
        qDebug("FindErrorsIndexing: Done, requesting Qt Creator to quit.");
    }
}

805 806 807 808
void CppModelManager::onAboutToLoadSession()
{
    if (m_delayedGcTimer->isActive())
        m_delayedGcTimer->stop();
con's avatar
con committed
809 810 811
    GC();
}

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

823 824 825 826 827
void CppModelManager::onCoreAboutToClose()
{
    m_enableGC = false;
}

con's avatar
con committed
828 829
void CppModelManager::GC()
{
830 831 832
    if (!m_enableGC)
        return;

833 834
    // Collect files of CppEditorSupport and AbstractEditorSupport.
    QStringList filesInEditorSupports;
835
    foreach (const CppEditorSupport *cppEditorSupport, cppEditorSupportList())
836 837 838 839 840 841 842 843 844
        filesInEditorSupports << cppEditorSupport->fileName();

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

    Snapshot currentSnapshot = snapshot();
845
    QSet<QString> reachableFiles;
846 847 848 849
    // 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
850

851
    // Collect all files that are reachable from the project files
852
    while (!todo.isEmpty()) {
853
        const QString file = todo.last();
con's avatar
con committed
854 855
        todo.removeLast();

856
        if (reachableFiles.contains(file))
con's avatar
con committed
857
            continue;
858
        reachableFiles.insert(file);
con's avatar
con committed
859

860
        if (Document::Ptr doc = currentSnapshot.document(file))
con's avatar
con committed
861 862 863
            todo += doc->includedFiles();
    }

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

870
        if (reachableFiles.contains(fileName))
871 872
            newSnapshot.insert(it.value());
        else
873
            notReachableFiles.append(fileName);
con's avatar
con committed
874 875
    }

876 877
    // Announce removing files and replace the snapshot
    emit aboutToRemoveFiles(notReachableFiles);
878
    replaceSnapshot(newSnapshot);
879
    emit gcFinished();
con's avatar
con committed
880
}
881

882 883 884 885 886
void CppModelManager::finishedRefreshingSourceFiles(const QStringList &files)
{
    emit sourceFilesRefreshed(files);
}

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

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

902
CppCompletionAssistProvider *CppModelManager::completionAssistProvider(const QString &mimeType) const
903
{
904 905
    if (mimeType.isEmpty())
        return 0;
906

907 908
    ModelManagerSupport *cms = modelManagerSupportForMimeType(mimeType);
    QTC_ASSERT(cms, return 0);
909
    return cms->completionAssistProvider();
910 911
}

912 913
CppHighlightingSupport *CppModelManager::highlightingSupport(
        TextEditor::BaseTextDocument *baseTextDocument) const
914
{
915 916 917 918
    QTC_ASSERT(baseTextDocument, return 0);
    ModelManagerSupport *cms = modelManagerSupportForMimeType(baseTextDocument->mimeType());
    QTC_ASSERT(cms, return 0);
    return cms->highlightingSupport(baseTextDocument);
919 920
}

921
void CppModelManager::setIndexingSupport(CppIndexingSupport *indexingSupport)
922 923
{
    if (indexingSupport)
924 925 926 927 928 929
        m_indexingSupporter = indexingSupport;
}

CppIndexingSupport *CppModelManager::indexingSupport()
{
    return m_indexingSupporter ? m_indexingSupporter : m_internalIndexingSupport;
930 931
}

932 933 934 935 936 937
void CppModelManager::enableGarbageCollector(bool enable)
{
    m_delayedGcTimer->stop();
    m_enableGC = enable;
}

938
bool CppModelManager::setExtraDiagnostics(const QString &fileName,
939
                                          const QString &kind,
940 941
                                          const QList<Document::DiagnosticMessage> &diagnostics)
{
942
    foreach (CppEditorSupport *editorSupport, cppEditorSupportList()) {
943 944
        if (editorSupport->fileName() == fileName) {
            editorSupport->setExtraDiagnostics(kind, diagnostics);
945
            return true;
946
        }
947
    }
948
    return false;
949
}