cppmodelmanager.cpp 41.5 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>
31
#include <cplusplus/Overview.h>
con's avatar
con committed
32 33

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

40 41
#include <functional>
#include <QtConcurrentRun>
Wolfgang Beck's avatar
Wolfgang Beck committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
#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
59

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

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

76
#include <QtCore/QCoreApplication>
hjk's avatar
hjk committed
77 78 79
#include <QtCore/QDebug>
#include <QtCore/QMutexLocker>
#include <QtCore/QTime>
Roberto Raggi's avatar
Roberto Raggi committed
80
#include <QtCore/QTimer>
81
#include <QtConcurrentMap>
82 83 84

#include <QtGui/QTextBlock>

85 86
#include <iostream>
#include <sstream>
hjk's avatar
hjk committed
87

88 89
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
90 91
using namespace CPlusPlus;

92 93 94 95 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
#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
132
#endif // QTCREATOR_WITH_DUMP_AST
133

con's avatar
con committed
134 135 136 137 138 139 140 141 142 143
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"
144
    "#define __restrict__\n"
con's avatar
con committed
145

146 147 148 149
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

150 151
    "#define __builtin_va_arg(a,b) ((b)0)\n"

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

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

173 174 175 176 177 178 179 180 181
#else

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

Roberto Raggi's avatar
Roberto Raggi committed
182
CppPreprocessor::~CppPreprocessor()
183
{ }
con's avatar
con committed
184

185 186 187
void CppPreprocessor::setRevision(unsigned revision)
{ m_revision = revision; }

188
void CppPreprocessor::setWorkingCopy(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy)
189
{ m_workingCopy = workingCopy; }
con's avatar
con committed
190

191
void CppPreprocessor::setIncludePaths(const QStringList &includePaths)
192 193 194 195
{
    m_includePaths.clear();

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

#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
    }
}
217 218

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
219 220 221 222 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
{
    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
254

255 256 257
void CppPreprocessor::setProjectFiles(const QStringList &files)
{ m_projectFiles = files; }

258 259 260
void CppPreprocessor::setTodo(const QStringList &files)
{ m_todo = QSet<QString>::fromList(files); }

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

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

Roberto Raggi's avatar
Roberto Raggi committed
281 282 283
        if (workingCopy.contains(_doc->fileName()))
            _mode = Document::FullCheck;
    }
284

Roberto Raggi's avatar
Roberto Raggi committed
285 286 287 288
    void operator()()
    {
        _doc->check(_mode);
        _doc->releaseTranslationUnit();
289 290

        if (_modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
291
            _modelManager->emitDocumentUpdated(_doc); // ### TODO: compress
292 293 294
    }
};
} // end of anonymous namespace
Wolfgang Beck's avatar
Wolfgang Beck committed
295
#endif
296 297 298 299 300 301

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

303
void CppPreprocessor::resetEnvironment()
304 305 306 307
{
    env.reset();
    m_processed.clear();
}
308

309
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result, unsigned *revision)
310
{
311
    if (absoluteFilePath.isEmpty() || m_included.contains(absoluteFilePath))
312 313 314 315
        return true;

    if (m_workingCopy.contains(absoluteFilePath)) {
        m_included.insert(absoluteFilePath);
316 317 318
        const QPair<QString, unsigned> r = m_workingCopy.get(absoluteFilePath);
        *result = r.first;
        *revision = r.second;
319 320 321 322 323
        return true;
    }

    QFileInfo fileInfo(absoluteFilePath);
    if (! fileInfo.isFile())
con's avatar
con committed
324
        return false;
325 326 327 328 329 330 331 332 333

    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
334 335
    }

336 337 338
    return false;
}

339
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type, unsigned *revision)
Roberto Raggi's avatar
Roberto Raggi committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
{
    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)
362 363 364
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
365
        QString contents;
366
        includeFile(fileName, &contents, revision);
367 368 369 370 371 372 373 374 375
        return contents;
    }

    if (type == IncludeLocal && m_currentDoc) {
        QFileInfo currentFileInfo(m_currentDoc->fileName());
        QString path = currentFileInfo.absolutePath();
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
376
        QString contents;
377
        if (includeFile(path, &contents, revision)) {
378
            fileName = path;
con's avatar
con committed
379 380
            return contents;
        }
381
    }
con's avatar
con committed
382

383 384
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
385 386 387
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
388
        QString contents;
389
        if (includeFile(path, &contents, revision)) {
390 391
            fileName = path;
            return contents;
con's avatar
con committed
392
        }
393
    }
con's avatar
con committed
394

395 396 397 398 399 400
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        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 407 408 409 410 411
    }

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

413 414
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
415
            path += QLatin1Char('/');
416 417 418
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
419
            path = QDir::cleanPath(path);
420
            QString contents;
421
            if (includeFile(path, &contents, revision)) {
con's avatar
con committed
422 423 424 425
                fileName = path;
                return contents;
            }
        }
426
    }
con's avatar
con committed
427

428 429 430
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
431

432 433 434
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
435
            QString contents;
436
            includeFile(fileName, &contents, revision);
437
            return contents;
con's avatar
con committed
438 439 440
        }
    }

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

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

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

Christian Kamm's avatar
Christian Kamm committed
453 454 455 456 457
void CppPreprocessor::passedMacroDefinitionCheck(unsigned offset, const Macro &macro)
{
    if (! m_currentDoc)
        return;

458
    m_currentDoc->addMacroUse(macro, offset, macro.name().length(), env.currentLine,
Christian Kamm's avatar
Christian Kamm committed
459 460 461 462 463 464 465 466 467 468 469
                              QVector<MacroArgumentReference>(), true);
}

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

    m_currentDoc->addUndefinedMacroUse(name, offset);
}

470
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
471
                                          const Macro &macro,
472
                                          const QByteArray &originalText,
Christian Kamm's avatar
Christian Kamm committed
473
                                          bool inCondition,
474
                                          const QVector<MacroArgumentReference> &actuals)
475 476 477
{
    if (! m_currentDoc)
        return;
478

Christian Kamm's avatar
Christian Kamm committed
479
    //qDebug() << "start expanding:" << macro.name() << "text:" << originalText;
480 481
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), env.currentLine,
                              actuals, inCondition);
482
}
483

484
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
485 486 487
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
488

489 490
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
491

492 493 494 495
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
496

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

499
    if (m_processed.contains(fn))
500
        return;
con's avatar
con committed
501

502
    m_processed.insert(fn);
con's avatar
con committed
503

504
    foreach (const Document::Include &incl, doc->includes()) {
505 506
        QString includedFile = incl.fileName();

507
        if (Document::Ptr includedDoc = snapshot.document(includedFile))
508
            mergeEnvironment(includedDoc);
509 510
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
511
    }
con's avatar
con committed
512

513
    env.addMacros(doc->definedMacros());
514
}
con's avatar
con committed
515

516 517 518 519 520 521 522 523 524 525 526 527 528 529
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);
}

530
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type, unsigned line)
531 532 533 534
{
    if (fileName.isEmpty())
        return;

535 536
    unsigned editorRevision = 0;
    QString contents = tryIncludeFile(fileName, type, &editorRevision);
537
    fileName = QDir::cleanPath(fileName);
538
    if (m_currentDoc) {
539
        m_currentDoc->addIncludeFile(fileName, line);
540

541
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
542 543
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
544

545 546 547 548
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
549

550
            m_currentDoc->addDiagnosticMessage(d);
551

552
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
553
        }
554
    }
con's avatar
con committed
555

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

558
    Document::Ptr doc = snapshot.document(fileName);
559 560 561 562
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
563

564
    doc = Document::create(fileName);
565
    doc->setRevision(m_revision);
566
    doc->setEditorRevision(editorRevision);
con's avatar
con committed
567

568 569 570 571
    QFileInfo info(fileName);
    if (info.exists())
        doc->setLastModified(info.lastModified());

572
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
573

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

576
    doc->setSource(preprocessedCode);
577 578
    doc->tokenize();
    doc->releaseSource();
579

580
    snapshot.insert(doc);
581
    m_todo.remove(fileName);
con's avatar
con committed
582

583
#ifndef ICHECK_BUILD
Roberto Raggi's avatar
Roberto Raggi committed
584
    Process process(m_modelManager, doc, snapshot, m_workingCopy);
585

Roberto Raggi's avatar
Roberto Raggi committed
586
    process();
587 588

    (void) switchDocument(previousDoc);
589 590 591 592 593
#else
    Document::CheckMode mode = Document::FastCheck;
    mode = Document::FullCheck;
    doc->parse();
    doc->check(mode);
Erik Verbruggen's avatar
Erik Verbruggen committed
594 595

    (void) switchDocument(previousDoc);
596
#endif
597
}
con's avatar
con committed
598

599 600 601 602 603 604
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
605

606
#ifndef ICHECK_BUILD
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
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);
}

626 627 628 629 630 631 632
CppTools::CppModelManagerInterface *CppTools::CppModelManagerInterface::instance()
{
    ExtensionSystem::PluginManager *pluginManager = ExtensionSystem::PluginManager::instance();
    return pluginManager->getObject<CppTools::CppModelManagerInterface>();

}

con's avatar
con committed
633 634 635 636 637 638 639

/*!
    \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
640
    modified within Qt Creator.
con's avatar
con committed
641 642
*/

643
CppModelManager::CppModelManager(QObject *parent)
644
    : CppModelManagerInterface(parent)
con's avatar
con committed
645
{
Roberto Raggi's avatar
Roberto Raggi committed
646
    m_findReferences = new CppFindReferences(this);
647
    m_indexerEnabled = qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull();
Roberto Raggi's avatar
Roberto Raggi committed
648

649
    m_revision = 0;
Roberto Raggi's avatar
Roberto Raggi committed
650 651
    m_synchronizer.setCancelOnWait(true);

652
    m_core = Core::ICore::instance(); // FIXME
653 654
    m_dirty = true;

655
    ProjectExplorer::ProjectExplorerPlugin *pe =
656
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
657

658
    QTC_ASSERT(pe, return);
con's avatar
con committed
659

660
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
661
    QTC_ASSERT(session, return);
con's avatar
con committed
662

Roberto Raggi's avatar
Roberto Raggi committed
663 664 665 666 667 668
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

669 670 671
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
672 673 674
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project *)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project *)));

675 676
    connect(session, SIGNAL(aboutToUnloadSession()),
            this, SLOT(onAboutToUnloadSession()));
con's avatar
con committed
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694

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

695
Snapshot CppModelManager::snapshot() const
696
{
697
    QMutexLocker locker(&protectSnapshot);
698 699
    return m_snapshot;
}
con's avatar
con committed
700

701 702 703 704 705 706
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

707 708 709 710
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
711 712 713
    m_dirty = false;
}

714
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
715 716 717 718 719 720 721 722
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
723
    files.removeDuplicates();
con's avatar
con committed
724 725 726
    return files;
}

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

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

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

765
void CppModelManager::setIncludesInPaths(const QMap<QString, QStringList> &includesInPaths)
766 767 768 769 770 771 772 773 774
{
    QMutexLocker locker(&mutex);
    QMapIterator<QString, QStringList> i(includesInPaths);
    while (i.hasNext()) {
        i.next();
        m_includesInPaths.insert(i.key(), i.value());
    }
}

775 776 777 778 779 780 781 782 783 784
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

785
QList<int> CppModelManager::references(CPlusPlus::Symbol *symbol, const LookupContext &context)
786
{
787
    return m_findReferences->references(symbol, context);
788 789
}

790
void CppModelManager::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
Roberto Raggi's avatar
Roberto Raggi committed
791
{
792
    if (symbol->identifier())
793
        m_findReferences->findUsages(symbol, context);
794 795
}

796 797
void CppModelManager::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                   const QString &replacement)
798 799
{
    if (symbol->identifier())
800
        m_findReferences->renameUsages(symbol, context, replacement);
Roberto Raggi's avatar
Roberto Raggi committed
801 802
}

Christian Kamm's avatar
Christian Kamm committed
803 804 805 806 807
void CppModelManager::findMacroUsages(const CPlusPlus::Macro &macro)
{
    m_findReferences->findMacroUses(macro);
}

808
CppModelManager::WorkingCopy CppModelManager::buildWorkingCopyList()
con's avatar
con committed
809
{
810
    WorkingCopy workingCopy;
con's avatar
con committed
811 812 813 814 815 816
    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();
817
        workingCopy.insert(fileName, editorSupport->contents(), editorSupport->editorRevision());
con's avatar
con committed
818 819
    }

820 821 822
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
823
        workingCopy.insert(es->fileName(), es->contents());
824 825
    }

con's avatar
con committed
826 827 828
    // add the project configuration file
    QByteArray conf(pp_configuration);
    conf += definedMacros();
829
    workingCopy.insert(pp_configuration_file, conf);
con's avatar
con committed
830 831 832 833

    return workingCopy;
}

834
CppModelManager::WorkingCopy CppModelManager::workingCopy() const
835 836 837 838
{
    return const_cast<CppModelManager *>(this)->buildWorkingCopyList();
}

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

842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
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);
864
    m_dirty = true;
865

866
    if (m_indexerEnabled) {
867 868 869
        QFuture<void> result = QtConcurrent::run(&CppModelManager::updateIncludesInPaths,
                                                 this,
                                                 pinfo.includePaths,
870
                                                 pinfo.frameworkPaths,
871 872 873 874
                                                 m_headerSuffixes);

        if (pinfo.includePaths.size() > 1) {
            m_core->progressManager()->addTask(result, tr("Scanning"),
875
                                               CppTools::Constants::TASK_INDEX);
876
        }
877 878 879 880 881 882 883
    }
}

QStringList CppModelManager::includesInPath(const QString &path) const
{
    QMutexLocker locker(&mutex);
    return m_includesInPaths.value(path);
884
}
con's avatar
con committed
885 886 887

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

891
        CppPreprocessor *preproc = new CppPreprocessor(this);
892
        preproc->setRevision(++m_revision);
893 894 895 896 897 898 899
        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
900

Roberto Raggi's avatar
Roberto Raggi committed
901 902 903 904 905
        if (m_synchronizer.futures().size() > 10) {
            QList<QFuture<void> > futures = m_synchronizer.futures();

            m_synchronizer.clearFutures();

906
            foreach (const QFuture<void> &future, futures) {
Roberto Raggi's avatar
Roberto Raggi committed
907 908 909 910 911
                if (! (future.isFinished() || future.isCanceled()))
                    m_synchronizer.addFuture(future);
            }
        }

Roberto Raggi's avatar
Roberto Raggi committed
912 913
        m_synchronizer.addFuture(result);

914
        if (sourceFiles.count() > 1) {
con's avatar
con committed
915
            m_core->progressManager()->addTask(result, tr("Parsing"),
916
                            CppTools::Constants::TASK_INDEX);
con's avatar
con committed
917
        }
918

con's avatar
con committed
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
        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
936
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
937 938 939 940 941 942 943 944 945 946 947

        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
948
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
949 950 951 952 953 954 955 956 957

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

bool CppModelManager::isCppEditor(Core::IEditor *editor) const
{
958
    return editor->context().contains(ProjectExplorer::Constants::LANG_CXX);
con's avatar
con committed
959 960 961
}

void CppModelManager::emitDocumentUpdated(Document::Ptr doc)
962 963 964
{
    emit documentUpdated(doc);
}
con's avatar
con committed
965 966 967 968

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

970 971
    bool outdated = false;

972
    protectSnapshot.lock();
973

974
    Document::Ptr previous = m_snapshot.document(fileName);
975 976 977 978 979 980

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

981 982
    protectSnapshot.unlock();

983 984 985
    if (outdated)
        return;

con's avatar
con committed
986 987 988 989 990 991 992 993 994 995 996 997 998
    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;

999
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
1000 1001 1002 1003 1004
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

1005 1006 1007 1008 1009 1010
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1011
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1012 1013 1014 1015 1016 1017 1018 1019 1020
                QTextEdit::ExtraSelection sel;
                sel.cursor = c;
                sel.cursor.setPosition(block.begin());
                sel.cursor.setPosition(block.end(), QTextCursor::KeepAnchor);