cppmodelmanager.cpp 41.9 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
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
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
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

Roberto Raggi's avatar
Roberto Raggi committed
34
#include <cplusplus/pp.h>
35
#include <cplusplus/Overview.h>
con's avatar
con committed
36 37

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

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

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

con's avatar
con committed
66 67 68 69 70 71 72 73
#include <TranslationUnit.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 <QtCore/QCoreApplication>
hjk's avatar
hjk committed
81 82 83
#include <QtCore/QDebug>
#include <QtCore/QMutexLocker>
#include <QtCore/QTime>
Roberto Raggi's avatar
Roberto Raggi committed
84
#include <QtCore/QTimer>
85
#include <QtConcurrentMap>
86 87 88

#include <QtGui/QTextBlock>

89 90
#include <iostream>
#include <sstream>
hjk's avatar
hjk committed
91

92 93
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
94 95
using namespace CPlusPlus;

96 97 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
#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
136
#endif // QTCREATOR_WITH_DUMP_AST
137

con's avatar
con committed
138 139 140 141 142 143 144 145 146 147
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"
148
    "#define __restrict__\n"
con's avatar
con committed
149

150 151 152 153
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

154 155
    "#define __builtin_va_arg(a,b) ((b)0)\n"

con's avatar
con committed
156 157
    // ### add macros for win32
    "#define __cdecl\n"
158
    "#define __stdcall\n"
con's avatar
con committed
159 160 161 162 163 164 165 166 167 168
    "#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";

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

177 178 179 180 181 182 183 184 185
#else

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

Roberto Raggi's avatar
Roberto Raggi committed
186
CppPreprocessor::~CppPreprocessor()
187
{ }
con's avatar
con committed
188

189 190 191
void CppPreprocessor::setRevision(unsigned revision)
{ m_revision = revision; }

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

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

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

#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
    }
}
221 222

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
223 224 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
{
    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
258

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

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

265
#ifndef ICHECK_BUILD
Wolfgang Beck's avatar
Wolfgang Beck committed
266
namespace {
267
class Process: public std::unary_function<Document::Ptr, void>
268 269
{
    QPointer<CppModelManager> _modelManager;
270 271
    Snapshot _snapshot;
    Document::Ptr _doc;
Roberto Raggi's avatar
Roberto Raggi committed
272
    Document::CheckMode _mode;
273 274

public:
275
    Process(QPointer<CppModelManager> modelManager,
Roberto Raggi's avatar
Roberto Raggi committed
276 277
            Document::Ptr doc,
            const Snapshot &snapshot,
278
            const CppModelManager::WorkingCopy &workingCopy)
279 280
        : _modelManager(modelManager),
          _snapshot(snapshot),
Roberto Raggi's avatar
Roberto Raggi committed
281 282
          _doc(doc),
          _mode(Document::FastCheck)
283
    {
284

Roberto Raggi's avatar
Roberto Raggi committed
285 286 287
        if (workingCopy.contains(_doc->fileName()))
            _mode = Document::FullCheck;
    }
288

Roberto Raggi's avatar
Roberto Raggi committed
289 290 291 292
    void operator()()
    {
        _doc->check(_mode);
        _doc->releaseTranslationUnit();
293

294 295 296
        if (_mode == Document::FastCheck)
            _doc->control()->squeeze();

297
        if (_modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
298
            _modelManager->emitDocumentUpdated(_doc); // ### TODO: compress
299 300 301
    }
};
} // end of anonymous namespace
Wolfgang Beck's avatar
Wolfgang Beck committed
302
#endif
303 304 305 306 307 308

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

310
void CppPreprocessor::resetEnvironment()
311 312 313 314
{
    env.reset();
    m_processed.clear();
}
315

316
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result, unsigned *revision)
317
{
318
    if (absoluteFilePath.isEmpty() || m_included.contains(absoluteFilePath))
319 320 321 322
        return true;

    if (m_workingCopy.contains(absoluteFilePath)) {
        m_included.insert(absoluteFilePath);
323 324 325
        const QPair<QString, unsigned> r = m_workingCopy.get(absoluteFilePath);
        *result = r.first;
        *revision = r.second;
326 327 328 329 330
        return true;
    }

    QFileInfo fileInfo(absoluteFilePath);
    if (! fileInfo.isFile())
con's avatar
con committed
331
        return false;
332 333 334 335 336 337 338 339 340

    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
341 342
    }

343 344 345
    return false;
}

346
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type, unsigned *revision)
Roberto Raggi's avatar
Roberto Raggi committed
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
{
    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;
}

368 369 370 371 372 373
static inline void appendDirSeparatorIfNeeded(QString &path)
{
    if (!path.endsWith(QLatin1Char('/'), Qt::CaseInsensitive))
        path += QLatin1Char('/');
}

Roberto Raggi's avatar
Roberto Raggi committed
374
QString CppPreprocessor::tryIncludeFile_helper(QString &fileName, IncludeType type, unsigned *revision)
375 376 377
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
378
        QString contents;
379
        includeFile(fileName, &contents, revision);
380 381 382 383 384 385
        return contents;
    }

    if (type == IncludeLocal && m_currentDoc) {
        QFileInfo currentFileInfo(m_currentDoc->fileName());
        QString path = currentFileInfo.absolutePath();
386
        appendDirSeparatorIfNeeded(path);
387 388
        path += fileName;
        path = QDir::cleanPath(path);
389
        QString contents;
390
        if (includeFile(path, &contents, revision)) {
391
            fileName = path;
con's avatar
con committed
392 393
            return contents;
        }
394
    }
con's avatar
con committed
395

396 397
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
398
        appendDirSeparatorIfNeeded(path);
399 400
        path += fileName;
        path = QDir::cleanPath(path);
401
        QString contents;
402
        if (includeFile(path, &contents, revision)) {
403 404
            fileName = path;
            return contents;
con's avatar
con committed
405
        }
406
    }
con's avatar
con committed
407

408 409 410
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
411
        appendDirSeparatorIfNeeded(path);
412 413
        path += fileName;
        path = QDir::cleanPath(path);
414
        QString contents;
415
        if (includeFile(path, &contents, revision)) {
416 417
            fileName = path;
            return contents;
con's avatar
con committed
418
        }
419 420 421 422 423 424
    }

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

426 427
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
428
            appendDirSeparatorIfNeeded(path);
429 430 431
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
432
            path = QDir::cleanPath(path);
433
            QString contents;
434
            if (includeFile(path, &contents, revision)) {
con's avatar
con committed
435 436 437 438
                fileName = path;
                return contents;
            }
        }
439
    }
con's avatar
con committed
440

441 442 443
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
444

445 446 447
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
448
            QString contents;
449
            includeFile(fileName, &contents, revision);
450
            return contents;
con's avatar
con committed
451 452 453
        }
    }

454
    //qDebug() << "**** file" << fileName << "not found!";
455
    return QString();
456
}
con's avatar
con committed
457

Roberto Raggi's avatar
Roberto Raggi committed
458
void CppPreprocessor::macroAdded(const Macro &macro)
459 460 461
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
462

Roberto Raggi's avatar
Roberto Raggi committed
463
    m_currentDoc->appendMacro(macro);
464
}
465

Christian Kamm's avatar
Christian Kamm committed
466 467 468 469 470
void CppPreprocessor::passedMacroDefinitionCheck(unsigned offset, const Macro &macro)
{
    if (! m_currentDoc)
        return;

471
    m_currentDoc->addMacroUse(macro, offset, macro.name().length(), env.currentLine,
Christian Kamm's avatar
Christian Kamm committed
472 473 474 475 476 477 478 479 480 481 482
                              QVector<MacroArgumentReference>(), true);
}

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

    m_currentDoc->addUndefinedMacroUse(name, offset);
}

483
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
484
                                          const Macro &macro,
485
                                          const QByteArray &originalText,
Christian Kamm's avatar
Christian Kamm committed
486
                                          bool inCondition,
487
                                          const QVector<MacroArgumentReference> &actuals)
488 489 490
{
    if (! m_currentDoc)
        return;
491

Christian Kamm's avatar
Christian Kamm committed
492
    //qDebug() << "start expanding:" << macro.name() << "text:" << originalText;
493 494
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), env.currentLine,
                              actuals, inCondition);
495
}
496

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

502 503
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
504

505 506 507 508
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
509

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

512
    if (m_processed.contains(fn))
513
        return;
con's avatar
con committed
514

515
    m_processed.insert(fn);
con's avatar
con committed
516

517
    foreach (const Document::Include &incl, doc->includes()) {
518 519
        QString includedFile = incl.fileName();

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

526
    env.addMacros(doc->definedMacros());
527
}
con's avatar
con committed
528

529 530 531 532 533 534 535 536 537 538 539 540 541 542
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);
}

543
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type, unsigned line)
544 545 546 547
{
    if (fileName.isEmpty())
        return;

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

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

558 559 560 561
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
562

563
            m_currentDoc->addDiagnosticMessage(d);
564

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

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

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

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

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

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

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

589
    doc->setSource(preprocessedCode);
590 591
    doc->tokenize();
    doc->releaseSource();
592

593
    snapshot.insert(doc);
594
    m_todo.remove(fileName);
con's avatar
con committed
595

596
#ifndef ICHECK_BUILD
Roberto Raggi's avatar
Roberto Raggi committed
597
    Process process(m_modelManager, doc, snapshot, m_workingCopy);
598

Roberto Raggi's avatar
Roberto Raggi committed
599
    process();
600 601

    (void) switchDocument(previousDoc);
602 603 604 605 606
#else
    Document::CheckMode mode = Document::FastCheck;
    mode = Document::FullCheck;
    doc->parse();
    doc->check(mode);
Erik Verbruggen's avatar
Erik Verbruggen committed
607 608

    (void) switchDocument(previousDoc);
609
#endif
610
}
con's avatar
con committed
611

612 613 614 615 616 617
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
618

619
#ifndef ICHECK_BUILD
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
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);
}

639 640 641 642 643 644 645
CppTools::CppModelManagerInterface *CppTools::CppModelManagerInterface::instance()
{
    ExtensionSystem::PluginManager *pluginManager = ExtensionSystem::PluginManager::instance();
    return pluginManager->getObject<CppTools::CppModelManagerInterface>();

}

con's avatar
con committed
646 647 648 649 650 651 652

/*!
    \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
653
    modified within Qt Creator.
con's avatar
con committed
654 655
*/

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

662
    m_revision = 0;
Roberto Raggi's avatar
Roberto Raggi committed
663 664
    m_synchronizer.setCancelOnWait(true);

665
    m_core = Core::ICore::instance(); // FIXME
666 667
    m_dirty = true;

668
    ProjectExplorer::ProjectExplorerPlugin *pe =
669
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
670

671
    QTC_ASSERT(pe, return);
con's avatar
con committed
672

673
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
674
    QTC_ASSERT(session, return);
con's avatar
con committed
675

Roberto Raggi's avatar
Roberto Raggi committed
676 677 678 679 680 681
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

682 683 684
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
685 686 687
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project *)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project *)));

688 689
    connect(session, SIGNAL(aboutToUnloadSession()),
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

    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()
{ }

708
Snapshot CppModelManager::snapshot() const
709
{
710
    QMutexLocker locker(&protectSnapshot);
711 712
    return m_snapshot;
}
con's avatar
con committed
713

714 715 716 717 718 719
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

720 721 722 723
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
724 725 726
    m_dirty = false;
}

727
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
728 729 730 731 732 733 734 735
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
736
    files.removeDuplicates();
con's avatar
con committed
737 738 739
    return files;
}

740
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
741 742 743 744 745 746 747 748
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
749
    includePaths.removeDuplicates();
con's avatar
con committed
750 751 752
    return includePaths;
}

753
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
754 755 756 757 758 759 760 761
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
762
    frameworkPaths.removeDuplicates();
con's avatar
con committed
763 764 765
    return frameworkPaths;
}

766
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
767 768 769 770 771 772 773 774 775 776 777
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

778
void CppModelManager::setIncludesInPaths(const QMap<QString, QStringList> &includesInPaths)
779 780 781 782 783 784 785 786 787
{
    QMutexLocker locker(&mutex);
    QMapIterator<QString, QStringList> i(includesInPaths);
    while (i.hasNext()) {
        i.next();
        m_includesInPaths.insert(i.key(), i.value());
    }
}

788 789 790 791 792 793 794 795 796 797
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

798
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
799
{
800
    return m_findReferences->references(symbol, context);
801 802
}

803
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
804
{
805
    if (symbol->identifier())
806
        m_findReferences->findUsages(symbol, context);
807 808
}

809 810
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                   const QString &replacement)
811 812
{
    if (symbol->identifier())
813
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
814 815
}

Christian Kamm's avatar
Christian Kamm committed
816 817 818 819 820
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

821
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
822
{
823
    WorkingCopy workingCopy;
con's avatar
con committed
824 825 826 827 828 829
    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();
830
        workingCopy.insert(fileName, editorSupport->contents(), editorSupport->editorRevision());
con's avatar
con committed
831 832
    }

833 834 835
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
836
        workingCopy.insert(es->fileName(), es->contents());
837 838
    }

con's avatar
con committed
839 840 841
    // add the project configuration file
    QByteArray conf(pp_configuration);
    conf += definedMacros();
842
    workingCopy.insert(pp_configuration_file, conf);
con's avatar
con committed
843 844 845 846

    return workingCopy;
}

847
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
848 849 850 851
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

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

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
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);
877
    m_dirty = true;
878

879
    if (m_indexerEnabled) {
880 881 882
        QFuture<void> result = QtConcurrent::run(&CppModelManager::updateIncludesInPaths,
                                                 this,
                                                 pinfo.includePaths,
883
                                                 pinfo.frameworkPaths,
884 885 886 887
                                                 m_headerSuffixes);

        if (pinfo.includePaths.size() > 1) {
            m_core->progressManager()->addTask(result, tr("Scanning"),
888
                                               CppTools::Constants::TASK_INDEX);
889
        }
890 891 892 893 894 895 896
    }
}

QStringList CppModelManager::includesInPath(const QString &path) const
{
    QMutexLocker locker(&mutex);
    return m_includesInPaths.value(path);
897
}
con's avatar
con committed
898 899 900

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

904
        CppPreprocessor *preproc = new CppPreprocessor(this);
905
        preproc->setRevision(++m_revision);
906 907 908 909 910 911 912
        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
913

Roberto Raggi's avatar
Roberto Raggi committed
914 915 916 917 918
        if (m_synchronizer.futures().size() > 10) {
            QList<QFuture<void> > futures = m_synchronizer.futures();

            m_synchronizer.clearFutures();

919
            foreach (const QFuture<void> &future, futures) {
Roberto Raggi's avatar
Roberto Raggi committed
920 921 922 923 924
                if (! (future.isFinished() || future.isCanceled()))
                    m_synchronizer.addFuture(future);
            }
        }

Roberto Raggi's avatar
Roberto Raggi committed
925 926
        m_synchronizer.addFuture(result);

927
        if (sourceFiles.count() > 1) {
con's avatar
con committed
928
            m_core->progressManager()->addTask(result, tr("Parsing"),
929
                            CppTools::Constants::TASK_INDEX);
con's avatar
con committed
930
        }
931

con's avatar
con committed
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
        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
949
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
950 951 952 953 954 955 956 957 958 959 960

        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
961
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
962 963 964 965 966 967 968 969 970

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

bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
971
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
972 973 974
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
975 976 977
{
    emit documentUpdated(doc);
}
con's avatar
con committed
978 979 980 981

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

983 984
    bool outdated = false;

985
    protectSnapshot.lock();
986

987
    Document::Ptr previous = m_snapshot.document(fileName);
988 989 990 991 992 993

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

994 995
    protectSnapshot.unlock();

996 997 998
    if (outdated)
        return;

con's avatar
con committed
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
    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;

1012
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
1013 1014 1015 1016 1017
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

1018 1019 1020 1021 1022 1023
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1024
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1025 1026 1027 1028 1029 1030 1031 1032 1033
                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
1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
            // 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);

1044
#ifdef QTCREATOR_WITH_ADVANCED_HIGHLIGHTER
1045
            QSet<QPair<unsigned, unsigned> > lines;
1046
            foreach (const Document::DiagnosticMessage &m, doc->diagnosticMessages()) {
con's avatar
con committed
1047 1048
                if (m.fileName() != fileName)
                    continue;
1049 1050 1051 1052

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

                if (lines.contains(coordinates))