cppmodelmanager.cpp 41.1 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
hjk's avatar
hjk committed
3 4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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

Roberto Raggi's avatar
Roberto Raggi committed
30
#include <cplusplus/pp.h>
31
#include <cplusplus/Overview.h>
con's avatar
con committed
32

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

44
#include <functional>
45
#include <QtConcurrentRun>
46 47 48 49 50 51 52 53 54 55 56 57 58
#include <QFutureSynchronizer>
#include <utils/runextensions.h>
#include <texteditor/itexteditor.h>
#include <texteditor/basetexteditor.h>
#include <projectexplorer/project.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
#include <coreplugin/icore.h>
#include <coreplugin/mimedatabase.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/progressmanager/progressmanager.h>
#include <extensionsystem/pluginmanager.h>
59

60
#include <utils/hostosinfo.h>
hjk's avatar
hjk committed
61 62
#include <utils/qtcassert.h>

con's avatar
con committed
63 64 65 66 67 68 69 70
#include <TranslationUnit.h>
#include <AST.h>
#include <Scope.h>
#include <Literals.h>
#include <Symbols.h>
#include <Names.h>
#include <NameVisitor.h>
#include <TypeVisitor.h>
71
#include <ASTVisitor.h>
con's avatar
con committed
72 73
#include <Lexer.h>
#include <Token.h>
74 75
#include <Parser.h>
#include <Control.h>
76
#include <CoreTypes.h>
con's avatar
con committed
77

78 79 80 81 82
#include <QCoreApplication>
#include <QDebug>
#include <QMutexLocker>
#include <QTime>
#include <QTimer>
83
#include <QtConcurrentMap>
84

85
#include <QTextBlock>
86

87 88
#include <iostream>
#include <sstream>
hjk's avatar
hjk committed
89

90
namespace CPlusPlus {
91

92 93
uint qHash(const CppModelManagerInterface::ProjectPart &p)
{
94
    uint h = qHash(p.defines) ^ p.language ^ p.qtVersion;
95 96 97 98 99 100 101 102 103

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

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

    return h;
}
104

105 106 107 108 109 110 111
bool operator==(const CppModelManagerInterface::ProjectPart &p1,
                const CppModelManagerInterface::ProjectPart &p2)
{
    if (p1.defines != p2.defines)
        return false;
    if (p1.language != p2.language)
        return false;
112
    if (p1.qtVersion!= p2.qtVersion)
113 114 115 116 117
        return false;
    if (p1.includePaths != p2.includePaths)
        return false;
    return p1.frameworkPaths == p2.frameworkPaths;
}
118

119 120
} // namespace CPlusPlus

121 122
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
123 124
using namespace CPlusPlus;

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
#if defined(QTCREATOR_WITH_DUMP_AST) && defined(Q_CC_GNU)

#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
165
#endif // QTCREATOR_WITH_DUMP_AST
166

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

177 178 179 180
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

181 182
    "#define __builtin_va_arg(a,b) ((b)0)\n"

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

198
CppPreprocessor::CppPreprocessor(QPointer<CppModelManager> modelManager, bool dumpFileNameWhileParsing)
199 200
    : snapshot(modelManager->snapshot()),
      m_modelManager(modelManager),
201
      m_dumpFileNameWhileParsing(dumpFileNameWhileParsing),
202 203
      preprocess(this, &env),
      m_revision(0)
204 205 206
{
    preprocess.setKeepComments(true);
}
Roberto Raggi's avatar
Roberto Raggi committed
207 208

CppPreprocessor::~CppPreprocessor()
209
{ }
con's avatar
con committed
210

211 212 213
void CppPreprocessor::setRevision(unsigned revision)
{ m_revision = revision; }

214
void CppPreprocessor::setWorkingCopy(const CppModelManagerInterface::WorkingCopy &workingCopy)
215
{ m_workingCopy = workingCopy; }
con's avatar
con committed
216

217
void CppPreprocessor::setIncludePaths(const QStringList &includePaths)
218 219 220 221
{
    m_includePaths.clear();

    for (int i = 0; i < includePaths.size(); ++i) {
222
        const QString &path = includePaths.at(i);
223

224 225 226 227 228 229 230 231 232 233 234 235
        if (Utils::HostOsInfo::isMacHost()) {
            if (i + 1 < includePaths.size() && path.endsWith(QLatin1String(".framework/Headers"))) {
                const QFileInfo pathInfo(path);
                const QFileInfo frameworkFileInfo(pathInfo.path());
                const QString frameworkName = frameworkFileInfo.baseName();

                const QFileInfo nextIncludePath = includePaths.at(i + 1);
                if (nextIncludePath.fileName() == frameworkName) {
                    // We got a QtXXX.framework/Headers followed by $QTDIR/include/QtXXX.
                    // In this case we prefer to include files from $QTDIR/include/QtXXX.
                    continue;
                }
236 237
            }
        }
238
        m_includePaths.append(cleanPath(path));
239 240
    }
}
241 242

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
{
    m_frameworkPaths.clear();

    foreach (const QString &frameworkPath, frameworkPaths) {
        addFrameworkPath(frameworkPath);
    }
}

// Add the given framework path, and expand private frameworks.
//
// Example:
//  <framework-path>/ApplicationServices.framework
// has private frameworks in:
//  <framework-path>/ApplicationServices.framework/Frameworks
// if the "Frameworks" folder exists inside the top level framework.
void CppPreprocessor::addFrameworkPath(const QString &frameworkPath)
{
    // The algorithm below is a bit too eager, but that's because we're not getting
    // in the frameworks we're linking against. If we would have that, then we could
    // add only those private frameworks.
263 264 265
    QString cleanFrameworkPath = cleanPath(frameworkPath);
    if (!m_frameworkPaths.contains(cleanFrameworkPath))
        m_frameworkPaths.append(cleanFrameworkPath);
266

267
    const QDir frameworkDir(cleanFrameworkPath);
268 269 270 271 272
    const QStringList filter = QStringList() << QLatin1String("*.framework");
    foreach (const QFileInfo &framework, frameworkDir.entryInfoList(filter)) {
        if (!framework.isDir())
            continue;
        const QFileInfo privateFrameworks(framework.absoluteFilePath(), QLatin1String("Frameworks"));
273
        if (privateFrameworks.exists() && privateFrameworks.isDir())
274 275 276
            addFrameworkPath(privateFrameworks.absoluteFilePath());
    }
}
con's avatar
con committed
277

278 279 280
void CppPreprocessor::setProjectFiles(const QStringList &files)
{ m_projectFiles = files; }

281 282 283
void CppPreprocessor::setTodo(const QStringList &files)
{ m_todo = QSet<QString>::fromList(files); }

Wolfgang Beck's avatar
Wolfgang Beck committed
284
namespace {
285
class Process: public std::unary_function<Document::Ptr, void>
286 287
{
    QPointer<CppModelManager> _modelManager;
288 289
    Snapshot _snapshot;
    Document::Ptr _doc;
Roberto Raggi's avatar
Roberto Raggi committed
290
    Document::CheckMode _mode;
291 292

public:
293
    Process(QPointer<CppModelManager> modelManager,
Roberto Raggi's avatar
Roberto Raggi committed
294 295
            Document::Ptr doc,
            const Snapshot &snapshot,
296
            const CppModelManager::WorkingCopy &workingCopy)
297 298
        : _modelManager(modelManager),
          _snapshot(snapshot),
Roberto Raggi's avatar
Roberto Raggi committed
299 300
          _doc(doc),
          _mode(Document::FastCheck)
301
    {
302

Roberto Raggi's avatar
Roberto Raggi committed
303 304 305
        if (workingCopy.contains(_doc->fileName()))
            _mode = Document::FullCheck;
    }
306

Roberto Raggi's avatar
Roberto Raggi committed
307 308 309
    void operator()()
    {
        _doc->check(_mode);
310

311
        if (_modelManager)
312
            _modelManager->emitDocumentUpdated(_doc);
313 314

        _doc->releaseSourceAndAST();
315 316 317 318 319 320 321
    }
};
} // end of anonymous namespace

void CppPreprocessor::run(const QString &fileName)
{
    QString absoluteFilePath = fileName;
322
    sourceNeeded(0, absoluteFilePath, IncludeGlobal);
323
}
324

325
void CppPreprocessor::resetEnvironment()
326 327 328 329
{
    env.reset();
    m_processed.clear();
}
330

331
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result, unsigned *revision)
332
{
333
    if (absoluteFilePath.isEmpty() || m_included.contains(absoluteFilePath))
334 335 336 337
        return true;

    if (m_workingCopy.contains(absoluteFilePath)) {
        m_included.insert(absoluteFilePath);
338 339 340
        const QPair<QString, unsigned> r = m_workingCopy.get(absoluteFilePath);
        *result = r.first;
        *revision = r.second;
341 342 343 344 345
        return true;
    }

    QFileInfo fileInfo(absoluteFilePath);
    if (! fileInfo.isFile())
con's avatar
con committed
346
        return false;
347 348

    QFile file(absoluteFilePath);
349
    if (file.open(QFile::ReadOnly | QFile::Text)) {
350
        m_included.insert(absoluteFilePath);
351
        QTextCodec *defaultCodec = Core::EditorManager::instance()->defaultTextCodec();
352
        QTextStream stream(&file);
353 354 355
        stream.setCodec(defaultCodec);
        if (result)
            *result = stream.readAll();
356 357
        file.close();
        return true;
con's avatar
con committed
358 359
    }

360 361 362
    return false;
}

363
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type, unsigned *revision)
Roberto Raggi's avatar
Roberto Raggi committed
364 365 366 367 368 369 370 371 372 373 374 375 376
{
    if (type == IncludeGlobal) {
        const QString fn = m_fileNameCache.value(fileName);

        if (! fn.isEmpty()) {
            fileName = fn;

            if (revision)
                *revision = 0;

            return QString();
        }

377 378
        const QString originalFileName = fileName;
        const QString contents = tryIncludeFile_helper(fileName, type, revision);
Roberto Raggi's avatar
Roberto Raggi committed
379
        m_fileNameCache.insert(originalFileName, fileName);
380 381 382 383 384
        return contents;
    }

    // IncludeLocal, IncludeNext
    return tryIncludeFile_helper(fileName, type, revision);
Roberto Raggi's avatar
Roberto Raggi committed
385 386
}

387
QString CppPreprocessor::cleanPath(const QString &path)
388
{
389 390 391 392 393
    QString result = QDir::cleanPath(path);
    const QChar slash(QLatin1Char('/'));
    if (!result.endsWith(slash))
        result.append(slash);
    return result;
394 395
}

Roberto Raggi's avatar
Roberto Raggi committed
396
QString CppPreprocessor::tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision)
397 398
{
    QFileInfo fileInfo(fileName);
399
    if (fileName == Preprocessor::configurationFileName || fileInfo.isAbsolute()) {
400
        QString contents;
401
        includeFile(fileName, &contents, revision);
402 403 404 405 406
        return contents;
    }

    if (type == IncludeLocal && m_currentDoc) {
        QFileInfo currentFileInfo(m_currentDoc->fileName());
407
        QString path = cleanPath(currentFileInfo.absolutePath()) + fileName;
408
        QString contents;
409
        if (includeFile(path, &contents, revision)) {
410
            fileName = path;
con's avatar
con committed
411 412
            return contents;
        }
413
    }
con's avatar
con committed
414

415
    foreach (const QString &includePath, m_includePaths) {
416
        QString path = includePath + fileName;
417
        QString contents;
418
        if (includeFile(path, &contents, revision)) {
419 420
            fileName = path;
            return contents;
con's avatar
con committed
421
        }
422 423 424 425 426
    }

    int index = fileName.indexOf(QLatin1Char('/'));
    if (index != -1) {
        QString frameworkName = fileName.left(index);
427
        QString name = frameworkName + QLatin1String(".framework/Headers/") + fileName.mid(index + 1);
con's avatar
con committed
428

429
        foreach (const QString &frameworkPath, m_frameworkPaths) {
430
            QString path = frameworkPath + name;
431
            QString contents;
432
            if (includeFile(path, &contents, revision)) {
con's avatar
con committed
433 434 435 436
                fileName = path;
                return contents;
            }
        }
437
    }
con's avatar
con committed
438

439
    //qDebug() << "**** file" << fileName << "not found!";
440
    return QString();
441
}
con's avatar
con committed
442

Roberto Raggi's avatar
Roberto Raggi committed
443
void CppPreprocessor::macroAdded(const Macro &macro)
444 445 446
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
447

Roberto Raggi's avatar
Roberto Raggi committed
448
    m_currentDoc->appendMacro(macro);
449
}
450

451 452 453 454 455 456 457
static inline const Macro revision(const CppModelManagerInterface::WorkingCopy &s, const Macro &macro)
{
    Macro newMacro(macro);
    newMacro.setFileRevision(s.get(macro.fileName()).second);
    return newMacro;
}

458
void CppPreprocessor::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro &macro)
Christian Kamm's avatar
Christian Kamm committed
459 460 461 462
{
    if (! m_currentDoc)
        return;

463
    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line,
464
                              QVector<MacroArgumentReference>());
Christian Kamm's avatar
Christian Kamm committed
465 466
}

467
void CppPreprocessor::failedMacroDefinitionCheck(unsigned offset, const ByteArrayRef &name)
Christian Kamm's avatar
Christian Kamm committed
468 469 470 471
{
    if (! m_currentDoc)
        return;

472
    m_currentDoc->addUndefinedMacroUse(QByteArray(name.start(), name.size()), offset);
Christian Kamm's avatar
Christian Kamm committed
473 474
}

475 476 477 478 479
void CppPreprocessor::notifyMacroReference(unsigned offset, unsigned line, const Macro &macro)
{
    if (! m_currentDoc)
        return;

480
    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line,
481 482 483 484
                              QVector<MacroArgumentReference>());
}

void CppPreprocessor::startExpandingMacro(unsigned offset, unsigned line,
Roberto Raggi's avatar
Roberto Raggi committed
485
                                          const Macro &macro,
486
                                          const QVector<MacroArgumentReference> &actuals)
487 488 489
{
    if (! m_currentDoc)
        return;
490

491
    m_currentDoc->addMacroUse(revision(m_workingCopy, macro), offset, macro.name().length(), line, actuals);
492
}
493

494
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
495 496 497
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
498

499 500
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
501

502 503 504 505
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
506

507
    const QString fn = doc->fileName();
con's avatar
con committed
508

509
    if (m_processed.contains(fn))
510
        return;
con's avatar
con committed
511

512
    m_processed.insert(fn);
con's avatar
con committed
513

514
    foreach (const Document::Include &incl, doc->includes()) {
515 516
        QString includedFile = incl.fileName();

517
        if (Document::Ptr includedDoc = snapshot.document(includedFile))
518
            mergeEnvironment(includedDoc);
519 520
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
521
    }
con's avatar
con committed
522

523
    env.addMacros(doc->definedMacros());
524
}
con's avatar
con committed
525

526 527 528 529 530 531 532 533 534 535 536 537 538 539
void CppPreprocessor::startSkippingBlocks(unsigned offset)
{
    //qDebug() << "start skipping blocks:" << offset;
    if (m_currentDoc)
        m_currentDoc->startSkippingBlocks(offset);
}

void CppPreprocessor::stopSkippingBlocks(unsigned offset)
{
    //qDebug() << "stop skipping blocks:" << offset;
    if (m_currentDoc)
        m_currentDoc->stopSkippingBlocks(offset);
}

540
void CppPreprocessor::sourceNeeded(unsigned line, QString &fileName, IncludeType type)
541 542 543 544
{
    if (fileName.isEmpty())
        return;

545 546
    unsigned editorRevision = 0;
    QString contents = tryIncludeFile(fileName, type, &editorRevision);
547
    fileName = QDir::cleanPath(fileName);
548
    if (m_currentDoc) {
549
        m_currentDoc->addIncludeFile(fileName, line);
550

551
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
552 553
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
554

555 556
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
557
                                          line, /*column = */ 0,
558
                                          msg);
559

560
            m_currentDoc->addDiagnosticMessage(d);
561

562
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
563
        }
564
    }
con's avatar
con committed
565

566 567
    if (m_dumpFileNameWhileParsing) {
        qDebug() << "Parsing file:" << fileName
568
//             << "contents:" << contents.size()
569 570
                    ;
    }
con's avatar
con committed
571

572
    Document::Ptr doc = snapshot.document(fileName);
573 574 575 576
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
577

578
    doc = Document::create(fileName);
579
    doc->setRevision(m_revision);
580
    doc->setEditorRevision(editorRevision);
con's avatar
con committed
581

582 583 584 585
    QFileInfo info(fileName);
    if (info.exists())
        doc->setLastModified(info.lastModified());

586
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
587

588
    const QByteArray preprocessedCode = preprocess.run(fileName, contents);
con's avatar
con committed
589

590 591
//    { QByteArray b(preprocessedCode); b.replace("\n", "<<<\n"); qDebug("Preprocessed code for \"%s\": [[%s]]", fileName.toUtf8().constData(), b.constData()); }

592
    doc->setUtf8Source(preprocessedCode);
593
    doc->keepSourceAndAST();
594
    doc->tokenize();
595

596
    snapshot.insert(doc);
597
    m_todo.remove(fileName);
con's avatar
con committed
598

Roberto Raggi's avatar
Roberto Raggi committed
599
    Process process(m_modelManager, doc, snapshot, m_workingCopy);
600

Roberto Raggi's avatar
Roberto Raggi committed
601
    process();
602 603

    (void) switchDocument(previousDoc);
604
}
con's avatar
con committed
605

606 607 608 609 610 611
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
612

613
void CppModelManager::updateModifiedSourceFiles()
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
{
    const Snapshot snapshot = this->snapshot();
    QStringList sourceFiles;

    foreach (const Document::Ptr doc, snapshot) {
        const QDateTime lastModified = doc->lastModified();

        if (! lastModified.isNull()) {
            QFileInfo fileInfo(doc->fileName());

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

    updateSourceFiles(sourceFiles);
}

con's avatar
con committed
632 633 634 635 636 637
/*!
    \class CppTools::CppModelManager
    \brief The CppModelManager keeps track of one CppCodeModel instance
           for each project and all related CppCodeModelPart instances.

    It also takes care of updating the code models when C++ files are
638
    modified within Qt Creator.
con's avatar
con committed
639 640
*/

641 642 643 644 645 646 647 648
QMutex CppModelManager::m_modelManagerMutex;
CppModelManager *CppModelManager::m_modelManagerInstance = 0;

CppModelManager *CppModelManager::instance()
{
    if (m_modelManagerInstance)
        return m_modelManagerInstance;
    QMutexLocker locker(&m_modelManagerMutex);
649
    if (!m_modelManagerInstance)
650 651 652 653
        m_modelManagerInstance = new CppModelManager;
    return m_modelManagerInstance;
}

654
CppModelManager::CppModelManager(QObject *parent)
655
    : CppModelManagerInterface(parent)
656 657 658
    , m_completionAssistProvider(0)
    , m_highlightingFactory(0)
    , m_indexingSupporter(0)
con's avatar
con committed
659
{
Roberto Raggi's avatar
Roberto Raggi committed
660
    m_findReferences = new CppFindReferences(this);
661
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
662

663 664
    m_dirty = true;

665
    ProjectExplorer::ProjectExplorerPlugin *pe =
666
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
667

668
    QTC_ASSERT(pe, return);
con's avatar
con committed
669

670
    ProjectExplorer::SessionManager *session = pe->session();
Roberto Raggi's avatar
Roberto Raggi committed
671 672 673 674 675 676
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

677 678 679
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

Robert Loehning's avatar
Robert Loehning committed
680 681
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project*)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project*)));
con's avatar
con committed
682

683
    connect(session, SIGNAL(aboutToUnloadSession(QString)),
684
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
685 686 687 688 689 690

    qRegisterMetaType<CPlusPlus::Document::Ptr>("CPlusPlus::Document::Ptr");

    // thread connections
    connect(this, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            this, SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)));
691 692
    connect(this, SIGNAL(extraDiagnosticsUpdated(QString)),
            this, SLOT(onExtraDiagnosticsUpdated(QString)));
con's avatar
con committed
693 694

    // Listen for editor closed and opened events so that we can keep track of changing files
Robert Loehning's avatar
Robert Loehning committed
695 696
    connect(Core::ICore::editorManager(), SIGNAL(editorOpened(Core::IEditor*)),
        this, SLOT(editorOpened(Core::IEditor*)));
con's avatar
con committed
697

Robert Loehning's avatar
Robert Loehning committed
698 699
    connect(Core::ICore::editorManager(), SIGNAL(editorAboutToClose(Core::IEditor*)),
        this, SLOT(editorAboutToClose(Core::IEditor*)));
700

701 702
    m_completionFallback = new InternalCompletionAssistProvider;
    m_completionAssistProvider = m_completionFallback;
703
    ExtensionSystem::PluginManager::addObject(m_completionAssistProvider);
704 705
    m_highlightingFallback = new CppHighlightingSupportInternalFactory;
    m_highlightingFactory = m_highlightingFallback;
706
    m_internalIndexingSupport = new BuiltinIndexingSupport;
con's avatar
con committed
707 708 709
}

CppModelManager::~CppModelManager()
710
{
711
    ExtensionSystem::PluginManager::removeObject(m_completionAssistProvider);
712 713
    delete m_completionFallback;
    delete m_highlightingFallback;
714
    delete m_internalIndexingSupport;
715
}
con's avatar
con committed
716

717
Snapshot CppModelManager::snapshot() const
718
{
719
    QMutexLocker locker(&protectSnapshot);
720 721
    return m_snapshot;
}
con's avatar
con committed
722

723 724 725 726 727 728
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

729 730 731 732
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
733 734 735
    m_dirty = false;
}

736
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
737 738 739 740 741 742
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
743 744
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            files += part->headerFiles;
745
            files += part->sourceFiles;
746 747
            files += part->objcSourceFiles;
        }
con's avatar
con committed
748
    }
749
    files.removeDuplicates();
con's avatar
con committed
750 751 752
    return files;
}

753
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
754 755 756 757 758 759
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
760
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
761 762
            foreach (const QString &path, part->includePaths)
                includePaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
763
    }
764
    includePaths.removeDuplicates();
con's avatar
con committed
765 766 767
    return includePaths;
}

768
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
769 770 771 772 773 774
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
775
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts())
776 777
            foreach (const QString &path, part->frameworkPaths)
                frameworkPaths.append(CppPreprocessor::cleanPath(path));
con's avatar
con committed
778
    }
779
    frameworkPaths.removeDuplicates();
con's avatar
con committed
780 781 782
    return frameworkPaths;
}

783
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
784 785
{
    QByteArray macros;
786
    QSet<QByteArray> alreadyIn;
con's avatar
con committed
787 788 789 790
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
791 792 793 794 795 796 797 798 799 800
        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
801 802 803 804
    }
    return macros;
}

805 806 807 808 809 810 811 812 813
/// This method will aquire the mutex!
void CppModelManager::dumpModelManagerConfiguration()
{
    // Tons of debug output...
    qDebug()<<"========= CppModelManager::dumpModelManagerConfiguration ======";
    foreach (const ProjectInfo &pinfo, m_projects.values()) {
        qDebug()<<" for project:"<< pinfo.project().data()->document()->fileName();
        foreach (const ProjectPart::Ptr &part, pinfo.projectParts()) {
            qDebug() << "=== part ===";
814 815 816 817 818 819 820 821 822 823
            const char* lang;
            switch (part->language) {
            case ProjectPart::CXX: lang = "C++"; break;
            case ProjectPart::CXX11: lang = "C++11"; break;
            case ProjectPart::C89: lang = "C89"; break;
            case ProjectPart::C99: lang = "C99"; break;
            default: lang = "INVALID";
            }

            qDebug() << "language:" << lang;
824 825 826 827 828
            qDebug() << "Qt version:" << part->qtVersion;
            qDebug() << "precompiled header:" << part->precompiledHeaders;
            qDebug() << "defines:" << part->defines;
            qDebug() << "includes:" << part->includePaths;
            qDebug() << "frameworkPaths:" << part->frameworkPaths;
829
            qDebug() << "headers:" << part->headerFiles;
830
            qDebug() << "sources:" << part->sourceFiles;
831
            qDebug() << "objc sources:" << part->objcSourceFiles;
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
            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;
    qDebug()<<"========= End of dump ======";
}

848 849 850 851 852 853 854 855 856 857
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

void CppModelManager::removeEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.remove(editorSupport);
}

858
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
859
{
860
    return m_findReferences->references(symbol, context);
861 862
}

863
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
864
{
865
    if (symbol->identifier())
866
        m_findReferences->findUsages(symbol, context);
867 868
}

869 870
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                   const QString &replacement)
871 872
{
    if (symbol->identifier())
873
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
874 875
}

Christian Kamm's avatar
Christian Kamm committed
876 877 878 879 880
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

881 882 883 884 885
void CppModelManager::renameMacroUsages(const CPlusPlus::Macro &macro, const QString &replacement)
{
    m_findReferences->renameMacroUses(macro, replacement);
}

886
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
887
{
888
    WorkingCopy workingCopy;
con's avatar
con committed
889 890 891 892 893
    QMapIterator<TextEditor::ITextEditor *, CppEditorSupport *> it(m_editorSupport);
    while (it.hasNext()) {
        it.next();
        TextEditor::ITextEditor *textEditor = it.key();
        CppEditorSupport *editorSupport = it.value();
894
        QString fileName = textEditor->document()->fileName();
895
        workingCopy.insert(fileName, editorSupport->contents(), editorSupport->editorRevision());
con's avatar
con committed
896 897
    }

898 899 900
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
901
        workingCopy.insert(es->fileName(), QString::fromUtf8(es->contents()));
902 903
    }

con's avatar
con committed
904 905 906
    // add the project configuration file
    QByteArray conf(pp_configuration);
    conf += definedMacros();
907
    workingCopy.insert(configurationFileName(), QString::fromUtf8(conf));
con's avatar
con committed
908 909 910 911

    return workingCopy;
}

912
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
913 914 915 916
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

dt's avatar
dt committed
917
QFuture<