cppmodelmanager.cpp 42.3 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

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

#include "cppmodelmanager.h"
Wolfgang Beck's avatar
Wolfgang Beck committed
36 37 38 39 40
#ifndef ICHECK_BUILD
#  include "cpptoolsconstants.h"
#  include "cpptoolseditorsupport.h"
#  include "cppfindreferences.h"
#endif
con's avatar
con committed
41

42 43
#include <functional>
#include <QtConcurrentRun>
Wolfgang Beck's avatar
Wolfgang Beck committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
#ifndef ICHECK_BUILD
#  include <QFutureSynchronizer>
#  include <qtconcurrent/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/uniqueidmanager.h>
#  include <coreplugin/mimedatabase.h>
#  include <coreplugin/editormanager/editormanager.h>
#  include <coreplugin/progressmanager/progressmanager.h>
#  include <extensionsystem/pluginmanager.h>
#else
#  include <QDir>
#endif
62

hjk's avatar
hjk committed
63 64
#include <utils/qtcassert.h>

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

80
#include <cplusplus/DeprecatedLookupContext.h>
81

82
#include <QtCore/QCoreApplication>
hjk's avatar
hjk committed
83 84 85
#include <QtCore/QDebug>
#include <QtCore/QMutexLocker>
#include <QtCore/QTime>
Roberto Raggi's avatar
Roberto Raggi committed
86
#include <QtCore/QTimer>
87
#include <QtConcurrentMap>
88 89 90

#include <QtGui/QTextBlock>

91 92
#include <iostream>
#include <sstream>
hjk's avatar
hjk committed
93

94 95
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
96 97
using namespace CPlusPlus;

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
#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
138
#endif // QTCREATOR_WITH_DUMP_AST
139

con's avatar
con committed
140 141 142 143 144 145 146 147 148 149
static const char pp_configuration_file[] = "<configuration>";

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"
150
    "#define __restrict__\n"
con's avatar
con committed
151

152 153 154 155
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

156 157
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
158 159
    // ### add macros for win32
    "#define __cdecl\n"
160
    "#define __stdcall\n"
con's avatar
con committed
161 162 163 164 165 166 167 168 169 170
    "#define QT_WA(x) x\n"
    "#define API\n"
    "#define WINAPI\n"
    "#define CALLBACK\n"
    "#define STDMETHODCALLTYPE\n"
    "#define __RPC_FAR\n"
    "#define APIENTRY\n"
    "#define __declspec(a)\n"
    "#define STDMETHOD(method) virtual HRESULT STDMETHODCALLTYPE method\n";

171
#ifndef ICHECK_BUILD
172
CppPreprocessor::CppPreprocessor(QPointer<CppModelManager> modelManager)
173 174
    : snapshot(modelManager->snapshot()),
      m_modelManager(modelManager),
175 176
      preprocess(this, &env),
      m_revision(0)
177
{ }
Roberto Raggi's avatar
Roberto Raggi committed
178

179 180 181 182 183 184 185 186 187
#else

CppPreprocessor::CppPreprocessor(QPointer<CPlusPlus::ParseManager> modelManager)
    : preprocess(this, &env),
      m_revision(0)
{
}
#endif

Roberto Raggi's avatar
Roberto Raggi committed
188
CppPreprocessor::~CppPreprocessor()
189
{ }
con's avatar
con committed
190

191 192 193
void CppPreprocessor::setRevision(unsigned revision)
{ m_revision = revision; }

194
void CppPreprocessor::setWorkingCopy(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy)
195
{ m_workingCopy = workingCopy; }
con's avatar
con committed
196

197
void CppPreprocessor::setIncludePaths(const QStringList &includePaths)
198 199 200 201
{
    m_includePaths.clear();

    for (int i = 0; i < includePaths.size(); ++i) {
202
        const QString &path = includePaths.at(i);
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222

#ifdef Q_OS_DARWIN
        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;
            }
        }
        m_includePaths.append(path);
#else
        m_includePaths.append(path);
#endif
    }
}
223 224

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
{
    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.
    if (!m_frameworkPaths.contains(frameworkPath)) {
        m_frameworkPaths.append(frameworkPath);
    }

    const QDir frameworkDir(frameworkPath);
    const QStringList filter = QStringList() << QLatin1String("*.framework");
    foreach (const QFileInfo &framework, frameworkDir.entryInfoList(filter)) {
        if (!framework.isDir())
            continue;
        const QFileInfo privateFrameworks(framework.absoluteFilePath(), QLatin1String("Frameworks"));
        if (privateFrameworks.exists() && privateFrameworks.isDir()) {
            addFrameworkPath(privateFrameworks.absoluteFilePath());
        }
    }
}
con's avatar
con committed
260

261 262 263
void CppPreprocessor::setProjectFiles(const QStringList &files)
{ m_projectFiles = files; }

264 265 266
void CppPreprocessor::setTodo(const QStringList &files)
{ m_todo = QSet<QString>::fromList(files); }

267
#ifndef ICHECK_BUILD
Wolfgang Beck's avatar
Wolfgang Beck committed
268
namespace {
269
class Process: public std::unary_function<Document::Ptr, void>
270 271
{
    QPointer<CppModelManager> _modelManager;
272
    Snapshot _snapshot;
273
    CppModelManager::WorkingCopy _workingCopy;
274
    Document::Ptr _doc;
275 276

public:
277 278
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
279
            const CppModelManager::WorkingCopy &workingCopy)
280 281 282
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
283 284
    { }

285 286 287
    void operator()(Document::Ptr doc)
    {
        _doc = doc;
288 289 290 291 292 293

        Document::CheckMode mode = Document::FastCheck;

        if (_workingCopy.contains(doc->fileName()))
            mode = Document::FullCheck;

Roberto Raggi's avatar
Roberto Raggi committed
294
        doc->check(mode);
295

Roberto Raggi's avatar
Roberto Raggi committed
296 297 298
        if (mode == Document::FullCheck) {
            // run the binding pass
            NamespaceBindingPtr ns = bind(doc, _snapshot);
299

Roberto Raggi's avatar
Roberto Raggi committed
300 301 302
            // check for undefined symbols.
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
303

Roberto Raggi's avatar
Roberto Raggi committed
304
            checkUndefinedSymbols(doc->translationUnit()->ast()); // ### FIXME
305 306
        }

307 308 309 310 311 312 313
        doc->releaseTranslationUnit();

        if (_modelManager)
            _modelManager->emitDocumentUpdated(doc); // ### TODO: compress
    }
};
} // end of anonymous namespace
Wolfgang Beck's avatar
Wolfgang Beck committed
314
#endif
315 316 317 318 319 320

void CppPreprocessor::run(const QString &fileName)
{
    QString absoluteFilePath = fileName;
    sourceNeeded(absoluteFilePath, IncludeGlobal, /*line = */ 0);
}
321

322
void CppPreprocessor::resetEnvironment()
323 324 325 326
{
    env.reset();
    m_processed.clear();
}
327

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

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

    QFileInfo fileInfo(absoluteFilePath);
    if (! fileInfo.isFile())
con's avatar
con committed
343
        return false;
344 345 346 347 348 349 350 351 352

    QFile file(absoluteFilePath);
    if (file.open(QFile::ReadOnly)) {
        m_included.insert(absoluteFilePath);
        QTextStream stream(&file);
        const QString contents = stream.readAll();
        *result = contents.toUtf8();
        file.close();
        return true;
con's avatar
con committed
353 354
    }

355 356 357
    return false;
}

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

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

            if (revision)
                *revision = 0;

            return QString();
        }
    }

    const QString originalFileName = fileName;
    const QString contents = tryIncludeFile_helper(fileName, type, revision);
    if (type == IncludeGlobal)
        m_fileNameCache.insert(originalFileName, fileName);
    return contents;
}

QString CppPreprocessor::tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision)
381 382 383
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
384
        QString contents;
385
        includeFile(fileName, &contents, revision);
386 387 388 389 390 391 392 393 394
        return contents;
    }

    if (type == IncludeLocal && m_currentDoc) {
        QFileInfo currentFileInfo(m_currentDoc->fileName());
        QString path = currentFileInfo.absolutePath();
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
395
        QString contents;
396
        if (includeFile(path, &contents, revision)) {
397
            fileName = path;
con's avatar
con committed
398 399
            return contents;
        }
400
    }
con's avatar
con committed
401

402 403
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
404 405 406
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
407
        QString contents;
408
        if (includeFile(path, &contents, revision)) {
409 410
            fileName = path;
            return contents;
con's avatar
con committed
411
        }
412
    }
con's avatar
con committed
413

414 415 416 417 418 419
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
420
        QString contents;
421
        if (includeFile(path, &contents, revision)) {
422 423
            fileName = path;
            return contents;
con's avatar
con committed
424
        }
425 426 427 428 429 430
    }

    int index = fileName.indexOf(QLatin1Char('/'));
    if (index != -1) {
        QString frameworkName = fileName.left(index);
        QString name = fileName.mid(index + 1);
con's avatar
con committed
431

432 433
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
434
            path += QLatin1Char('/');
435 436 437
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
438
            path = QDir::cleanPath(path);
439
            QString contents;
440
            if (includeFile(path, &contents, revision)) {
con's avatar
con committed
441 442 443 444
                fileName = path;
                return contents;
            }
        }
445
    }
con's avatar
con committed
446

447 448 449
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
450

451 452 453
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
454
            QString contents;
455
            includeFile(fileName, &contents, revision);
456
            return contents;
con's avatar
con committed
457 458 459
        }
    }

460
    //qDebug() << "**** file" << fileName << "not found!";
461
    return QString();
462
}
con's avatar
con committed
463

Roberto Raggi's avatar
Roberto Raggi committed
464
void CppPreprocessor::macroAdded(const Macro &macro)
465 466 467
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
468

Roberto Raggi's avatar
Roberto Raggi committed
469
    m_currentDoc->appendMacro(macro);
470
}
471

Christian Kamm's avatar
Christian Kamm committed
472 473 474 475 476
void CppPreprocessor::passedMacroDefinitionCheck(unsigned offset, const Macro &macro)
{
    if (! m_currentDoc)
        return;

477
    m_currentDoc->addMacroUse(macro, offset, macro.name().length(), env.currentLine,
Christian Kamm's avatar
Christian Kamm committed
478 479 480 481 482 483 484 485 486 487 488
                              QVector<MacroArgumentReference>(), true);
}

void CppPreprocessor::failedMacroDefinitionCheck(unsigned offset, const QByteArray &name)
{
    if (! m_currentDoc)
        return;

    m_currentDoc->addUndefinedMacroUse(name, offset);
}

489
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
490
                                          const Macro &macro,
491
                                          const QByteArray &originalText,
Christian Kamm's avatar
Christian Kamm committed
492
                                          bool inCondition,
493
                                          const QVector<MacroArgumentReference> &actuals)
494 495 496
{
    if (! m_currentDoc)
        return;
497

Christian Kamm's avatar
Christian Kamm committed
498
    //qDebug() << "start expanding:" << macro.name() << "text:" << originalText;
499 500
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), env.currentLine,
                              actuals, inCondition);
501
}
502

503
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
504 505 506
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
507

508 509
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
510

511 512 513 514
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
515

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

518
    if (m_processed.contains(fn))
519
        return;
con's avatar
con committed
520

521
    m_processed.insert(fn);
con's avatar
con committed
522

523
    foreach (const Document::Include &incl, doc->includes()) {
524 525
        QString includedFile = incl.fileName();

526
        if (Document::Ptr includedDoc = snapshot.document(includedFile))
527
            mergeEnvironment(includedDoc);
528 529
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
530
    }
con's avatar
con committed
531

532
    env.addMacros(doc->definedMacros());
533
}
con's avatar
con committed
534

535 536 537 538 539 540 541 542 543 544 545 546 547 548
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);
}

549
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type, unsigned line)
550 551 552 553
{
    if (fileName.isEmpty())
        return;

554 555
    unsigned editorRevision = 0;
    QString contents = tryIncludeFile(fileName, type, &editorRevision);
556
    fileName = QDir::cleanPath(fileName);
557
    if (m_currentDoc) {
558
        m_currentDoc->addIncludeFile(fileName, line);
559

560
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
561 562
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
563

564 565 566 567
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
568

569
            m_currentDoc->addDiagnosticMessage(d);
570

571
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
572
        }
573
    }
con's avatar
con committed
574

575
    //qDebug() << "parse file:" << fileName << "contents:" << contents.size();
con's avatar
con committed
576

577
    Document::Ptr doc = snapshot.document(fileName);
578 579 580 581
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
582

583
    doc = Document::create(fileName);
584
    doc->setRevision(m_revision);
585
    doc->setEditorRevision(editorRevision);
con's avatar
con committed
586

587 588 589 590
    QFileInfo info(fileName);
    if (info.exists())
        doc->setLastModified(info.lastModified());

591
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
592

593
    const QByteArray preprocessedCode = preprocess(fileName, contents);
con's avatar
con committed
594

595
    doc->setSource(preprocessedCode);
596 597
    doc->tokenize();
    doc->releaseSource();
598

599
    snapshot.insert(doc);
600
    m_todo.remove(fileName);
con's avatar
con committed
601

602
#ifndef ICHECK_BUILD
603
    Process process(m_modelManager, snapshot, m_workingCopy);
604 605

    process(doc);
606 607

    (void) switchDocument(previousDoc);
608 609 610 611 612
#else
    Document::CheckMode mode = Document::FastCheck;
    mode = Document::FullCheck;
    doc->parse();
    doc->check(mode);
Erik Verbruggen's avatar
Erik Verbruggen committed
613 614

    (void) switchDocument(previousDoc);
615
#endif
616
}
con's avatar
con committed
617

618 619 620 621 622 623
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
624

625
#ifndef ICHECK_BUILD
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
void CppTools::CppModelManagerInterface::updateModifiedSourceFiles()
{
    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);
}

645 646 647 648 649 650 651
CppTools::CppModelManagerInterface *CppTools::CppModelManagerInterface::instance()
{
    ExtensionSystem::PluginManager *pluginManager = ExtensionSystem::PluginManager::instance();
    return pluginManager->getObject<CppTools::CppModelManagerInterface>();

}

con's avatar
con committed
652 653 654 655 656 657 658

/*!
    \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
659
    modified within Qt Creator.
con's avatar
con committed
660 661
*/

662
CppModelManager::CppModelManager(QObject *parent)
663
    : CppModelManagerInterface(parent)
con's avatar
con committed
664
{
Roberto Raggi's avatar
Roberto Raggi committed
665
    m_findReferences = new CppFindReferences(this);
666
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
667

668
    m_revision = 0;
Roberto Raggi's avatar
Roberto Raggi committed
669 670
    m_synchronizer.setCancelOnWait(true);

671
    m_core = Core::ICore::instance(); // FIXME
672 673
    m_dirty = true;

674
    ProjectExplorer::ProjectExplorerPlugin *pe =
675
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
676

677
    QTC_ASSERT(pe, return);
con's avatar
con committed
678

679
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
680
    QTC_ASSERT(session, return);
con's avatar
con committed
681

Roberto Raggi's avatar
Roberto Raggi committed
682 683 684 685 686 687
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

688 689 690
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
691 692 693
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project *)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project *)));

694 695
    connect(session, SIGNAL(aboutToUnloadSession()),
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713

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

    // thread connections
    connect(this, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            this, SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)));

    // Listen for editor closed and opened events so that we can keep track of changing files
    connect(m_core->editorManager(), SIGNAL(editorOpened(Core::IEditor *)),
        this, SLOT(editorOpened(Core::IEditor *)));

    connect(m_core->editorManager(), SIGNAL(editorAboutToClose(Core::IEditor *)),
        this, SLOT(editorAboutToClose(Core::IEditor *)));
}

CppModelManager::~CppModelManager()
{ }

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

720 721 722 723 724 725
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

726 727 728 729
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
730 731 732
    m_dirty = false;
}

733
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
734 735 736 737 738 739 740 741
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
742
    files.removeDuplicates();
con's avatar
con committed
743 744 745
    return files;
}

746
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
747 748 749 750 751 752 753 754
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
755
    includePaths.removeDuplicates();
con's avatar
con committed
756 757 758
    return includePaths;
}

759
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
760 761 762 763 764 765 766 767
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
768
    frameworkPaths.removeDuplicates();
con's avatar
con committed
769 770 771
    return frameworkPaths;
}

772
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
773 774 775 776 777 778 779 780 781 782 783
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

784
void CppModelManager::setIncludesInPaths(const QMap<QString, QStringList> &includesInPaths)
785 786 787 788 789 790 791 792 793
{
    QMutexLocker locker(&mutex);
    QMapIterator<QString, QStringList> i(includesInPaths);
    while (i.hasNext()) {
        i.next();
        m_includesInPaths.insert(i.key(), i.value());
    }
}

794 795 796 797 798 799 800 801 802 803
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

804 805 806 807
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol,
                                       CPlusPlus::Document::Ptr doc,
                                       const CPlusPlus::Snapshot &snapshot)
{
808
    NamespaceBindingPtr glo = bind(doc, snapshot);
809
    return m_findReferences->references(DeprecatedLookupContext::canonicalSymbol(symbol, glo.data()), doc, snapshot);
810 811
}

Erik Verbruggen's avatar
Erik Verbruggen committed
812
void CppModelManager::findUsages(CPlusPlus::Document::Ptr symbolDocument, CPlusPlus::Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
813
{
814
    if (symbol->identifier())
Erik Verbruggen's avatar
Erik Verbruggen committed
815
        m_findReferences->findUsages(symbolDocument, symbol);
816 817
}

Erik Verbruggen's avatar
Erik Verbruggen committed
818
void CppModelManager::renameUsages(CPlusPlus::Document::Ptr symbolDocument, CPlusPlus::Symbol *symbol)
819 820
{
    if (symbol->identifier())
Erik Verbruggen's avatar
Erik Verbruggen committed
821
        m_findReferences->renameUsages(symbolDocument, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
822 823
}

Christian Kamm's avatar
Christian Kamm committed
824 825 826 827 828
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

829
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
830
{
831
    WorkingCopy workingCopy;
con's avatar
con committed
832 833 834 835 836 837
    QMapIterator<TextEditor::ITextEditor *, CppEditorSupport *> it(m_editorSupport);
    while (it.hasNext()) {
        it.next();
        TextEditor::ITextEditor *textEditor = it.key();
        CppEditorSupport *editorSupport = it.value();
        QString fileName = textEditor->file()->fileName();
838
        workingCopy.insert(fileName, editorSupport->contents(), editorSupport->editorRevision());
con's avatar
con committed
839 840
    }

841 842 843
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
844
        workingCopy.insert(es->fileName(), es->contents());
845 846
    }

con's avatar
con committed
847 848 849
    // add the project configuration file
    QByteArray conf(pp_configuration);
    conf += definedMacros();
850
    workingCopy.insert(pp_configuration_file, conf);
con's avatar
con committed
851 852 853 854

    return workingCopy;
}

855
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
856 857 858 859
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

dt's avatar
dt committed
860 861
QFuture<void> CppModelManager::updateSourceFiles(const QStringList &sourceFiles)
{ return refreshSourceFiles(sourceFiles); }
con's avatar
con committed
862

863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
QList<CppModelManager::ProjectInfo> CppModelManager::projectInfos() const
{
    QMutexLocker locker(&mutex);

    return m_projects.values();
}

CppModelManager::ProjectInfo CppModelManager::projectInfo(ProjectExplorer::Project *project) const
{
    QMutexLocker locker(&mutex);

    return m_projects.value(project, ProjectInfo(project));
}

void CppModelManager::updateProjectInfo(const ProjectInfo &pinfo)
{
    QMutexLocker locker(&mutex);

    if (! pinfo.isValid())
        return;

    m_projects.insert(pinfo.project, pinfo);
885
    m_dirty = true;
886

887
    if (m_indexerEnabled) {
888 889 890
        QFuture<void> result = QtConcurrent::run(&CppModelManager::updateIncludesInPaths,
                                                 this,
                                                 pinfo.includePaths,
891
                                                 pinfo.frameworkPaths,
892 893 894 895
                                                 m_headerSuffixes);

        if (pinfo.includePaths.size() > 1) {
            m_core->progressManager()->addTask(result, tr("Scanning"),
896
                                               CppTools::Constants::TASK_INDEX);
897
        }
898 899 900 901 902 903 904
    }
}

QStringList CppModelManager::includesInPath(const QString &path) const
{
    QMutexLocker locker(&mutex);
    return m_includesInPaths.value(path);
905
}
con's avatar
con committed
906 907 908

QFuture<void> CppModelManager::refreshSourceFiles(const QStringList &sourceFiles)
{
909
    if (! sourceFiles.isEmpty() && m_indexerEnabled) {
910
        const WorkingCopy workingCopy = buildWorkingCopyList();
con's avatar
con committed
911

912
        CppPreprocessor *preproc = new CppPreprocessor(this);
913
        preproc->setRevision(++m_revision);
914 915 916 917 918 919 920
        preproc->setProjectFiles(projectFiles());
        preproc->setIncludePaths(includePaths());
        preproc->setFrameworkPaths(frameworkPaths());
        preproc->setWorkingCopy(workingCopy);

        QFuture<void> result = QtConcurrent::run(&CppModelManager::parse,
                                                 preproc, sourceFiles);
con's avatar
con committed
921

Roberto Raggi's avatar
Roberto Raggi committed
922 923 924 925 926
        if (m_synchronizer.futures().size() > 10) {
            QList<QFuture<void> > futures = m_synchronizer.futures();

            m_synchronizer.clearFutures();

927
            foreach (const QFuture<void> &future, futures) {
Roberto Raggi's avatar
Roberto Raggi committed
928 929 930 931 932
                if (! (future.isFinished() || future.isCanceled()))
                    m_synchronizer.addFuture(future);
            }
        }

Roberto Raggi's avatar
Roberto Raggi committed
933 934
        m_synchronizer.addFuture(result);

935
        if (sourceFiles.count() > 1) {
con's avatar
con committed
936
            m_core->progressManager()->addTask(result, tr("Parsing"),
937
                            CppTools::Constants::TASK_INDEX);
con's avatar
con committed
938
        }
939

con's avatar
con committed
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
        return result;
    }
    return QFuture<void>();
}

/*!
    \fn    void CppModelManager::editorOpened(Core::IEditor *editor)
    \brief If a C++ editor is opened, the model manager listens to content changes
           in order to update the CppCodeModel accordingly. It also updates the
           CppCodeModel for the first time with this editor.

    \sa    void CppModelManager::editorContentsChanged()
 */
void CppModelManager::editorOpened(Core::IEditor *editor)
{
    if (isCppEditor(editor)) {
        TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
hjk's avatar
hjk committed
957
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
958 959 960 961 962 963 964 965 966 967 968

        CppEditorSupport *editorSupport = new CppEditorSupport(this);
        editorSupport->setTextEditor(textEditor);
        m_editorSupport[textEditor] = editorSupport;
    }
}

void CppModelManager::editorAboutToClose(Core::IEditor *editor)
{
    if (isCppEditor(editor)) {
        TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
hjk's avatar
hjk committed
969
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

        CppEditorSupport *editorSupport = m_editorSupport.value(textEditor);
        m_editorSupport.remove(textEditor);
        delete editorSupport;
    }
}

bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
    Core::UniqueIDManager *uidm = m_core->uniqueIDManager();
    const int uid = uidm->uniqueIdentifier(ProjectExplorer::Constants::LANG_CXX);
    return editor->context().contains(uid);
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
{ emit documentUpdated(doc); }

void CppModelManager::onDocumentUpdated(Document::Ptr doc)
{
    const QString fileName = doc->fileName();
990

991 992
    bool outdated = false;

993
    protectSnapshot.lock();
994

995
    Document::Ptr previous = m_snapshot.document(fileName);
996 997 998 999 1000 1001

    if (previous && (doc->revision() != 0 && doc->revision() < previous->revision()))
        outdated = true;
    else
        m_snapshot.insert(doc);

1002 1003
    protectSnapshot.unlock();

1004 1005 1006
    if (outdated)
        return;

con's avatar
con committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
    QList<Core::IEditor *> openedEditors = m_core->editorManager()->openedEditors();
    foreach (Core::IEditor *editor, openedEditors) {
        if (editor->file()->fileName() == fileName) {
            TextEditor::ITextEditor *textEditor = qobject_cast<TextEditor::ITextEditor *>(editor);
            if (! textEditor)
                continue;

            TextEditor::BaseTextEditor *ed = qobject_cast<TextEditor::BaseTextEditor *>(textEditor->widget());
            if (! ed)
                continue;

            QList<TextEditor::BaseTextEditor::BlockRange> blockRanges;

1020
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
1021 1022 1023 1024 1025
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

1026 1027 1028 1029 1030 1031
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1032
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1033 1034 1035 1036 1037 1038 1039 1040 1041
                QTextEdit::ExtraSelection sel;
                sel.cursor = c;
                sel.cursor.setPosition(block.begin());
                sel.cursor.setPosition(block.end(), QTextCursor::KeepAnchor);
                sel.format = macroFormat;
                selections.append(sel);
            }
#endif // QTCREATOR_WITH_MACRO_HIGHLIGHTING

con's avatar
con committed
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
            // set up the format for the errors
            QTextCharFormat errorFormat;
            errorFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
            errorFormat.setUnderlineColor(Qt::red);

            // set up the format for the warnings.
            QTextCharFormat warningFormat;
            warningFormat.setUnderlineStyle(QTextCharFormat::WaveUnderline);
            warningFormat.setUnderlineColor(Qt::darkYellow);

1052
#ifdef QTCREATOR_WITH_ADVANCED_HIGHLIGHTER
1053
            QSet<QPair<unsigned, unsigned> > lines;
1054
            foreach (const Document::DiagnosticMessage &m, doc->diagnosticMessages()) {
con's avatar
con committed
1055 1056
                if (m.fileName() != fileName)
                    continue;
1057 1058 1059 1060

                const QPair<unsigned, unsigned> coordinates = qMakePair(m.line(), m.column());

                if (lines.contains(coordinates))
con's avatar
con committed
1061 1062
                    continue;

1063
                lines.insert(coordinates);
con's avatar
con committed