cppmodelmanager.cpp 37.5 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6 7 8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
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 26
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
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>
con's avatar
con committed
32 33 34 35 36

#include "cppmodelmanager.h"
#include "cpptoolsconstants.h"
#include "cpptoolseditorsupport.h"

37 38
#include <functional>
#include <QtConcurrentRun>
Roberto Raggi's avatar
Roberto Raggi committed
39
#include <QFutureSynchronizer>
con's avatar
con committed
40
#include <qtconcurrent/runextensions.h>
41

con's avatar
con committed
42 43 44 45 46 47 48 49 50 51
#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>
52
#include <coreplugin/mimedatabase.h>
con's avatar
con committed
53
#include <coreplugin/editormanager/editormanager.h>
54
#include <coreplugin/progressmanager/progressmanager.h>
con's avatar
con committed
55

hjk's avatar
hjk committed
56 57
#include <utils/qtcassert.h>

con's avatar
con committed
58 59 60 61 62 63 64 65 66
#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>
67 68
#include <ASTVisitor.h>
#include <PrettyPrinter.h>
con's avatar
con committed
69 70 71
#include <Lexer.h>
#include <Token.h>

72 73
#include <cplusplus/LookupContext.h>

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

83 84
using namespace CppTools;
using namespace CppTools::Internal;
con's avatar
con committed
85 86
using namespace CPlusPlus;

87 88 89 90 91 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
#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
127
#endif // QTCREATOR_WITH_DUMP_AST
128

con's avatar
con committed
129 130 131 132 133 134 135 136 137 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 __GNUC_MINOR__ 0\n"
    "#define __GNUC__ 4\n"
    "#define __GNUG__ 4\n"
    "#define __STDC_HOSTED__ 1\n"
    "#define __VERSION__ \"4.0.1 (fake)\"\n"
    "#define __cplusplus 1\n"

    "#define __extension__\n"
    "#define __context__\n"
    "#define __range__\n"
    "#define __asm(a...)\n"
    "#define __asm__(a...)\n"
    "#define   restrict\n"
    "#define __restrict\n"

148 149 150 151
    "#define __complex__\n"
    "#define __imag__\n"
    "#define __real__\n"

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

164 165 166
namespace CppTools {
namespace Internal {

167
class CppPreprocessor: public CPlusPlus::Client
con's avatar
con committed
168 169
{
public:
170
    CppPreprocessor(QPointer<CppModelManager> modelManager);
Roberto Raggi's avatar
Roberto Raggi committed
171
    virtual ~CppPreprocessor();
con's avatar
con committed
172

173 174 175 176
    void setWorkingCopy(const QMap<QString, QByteArray> &workingCopy);
    void setIncludePaths(const QStringList &includePaths);
    void setFrameworkPaths(const QStringList &frameworkPaths);
    void setProjectFiles(const QStringList &files);
177 178
    void setTodo(const QStringList &files);

179
    void run(const QString &fileName);
con's avatar
con committed
180

181 182
    void resetEnvironment();

183 184 185
    const QSet<QString> &todo() const
    { return m_todo; }

186 187 188
public: // attributes
    Snapshot snapshot;

189 190
protected:
    CPlusPlus::Document::Ptr switchDocument(CPlusPlus::Document::Ptr doc);
con's avatar
con committed
191

192 193
    bool includeFile(const QString &absoluteFilePath, QByteArray *result);
    QByteArray tryIncludeFile(QString &fileName, IncludeType type);
con's avatar
con committed
194

195
    void mergeEnvironment(CPlusPlus::Document::Ptr doc);
con's avatar
con committed
196

Roberto Raggi's avatar
Roberto Raggi committed
197
    virtual void macroAdded(const Macro &macro);
198
    virtual void startExpandingMacro(unsigned offset,
199
                                     const Macro &macro,
200 201
                                     const QByteArray &originalText,
                                     const QVector<MacroArgumentReference> &actuals);
202
    virtual void stopExpandingMacro(unsigned offset, const Macro &macro);
203 204
    virtual void startSkippingBlocks(unsigned offset);
    virtual void stopSkippingBlocks(unsigned offset);
205 206
    virtual void sourceNeeded(QString &fileName, IncludeType type,
                              unsigned line);
con's avatar
con committed
207

208 209
private:
    QPointer<CppModelManager> m_modelManager;
210
    Environment env;
Roberto Raggi's avatar
Roberto Raggi committed
211
    Preprocessor preprocess;
212 213 214 215 216 217
    QStringList m_includePaths;
    QStringList m_systemIncludePaths;
    QMap<QString, QByteArray> m_workingCopy;
    QStringList m_projectFiles;
    QStringList m_frameworkPaths;
    QSet<QString> m_included;
218
    Document::Ptr m_currentDoc;
219
    QSet<QString> m_todo;
220
    QSet<QString> m_processed;
221
};
con's avatar
con committed
222

223 224
} // namespace Internal
} // namespace CppTools
225

226
CppPreprocessor::CppPreprocessor(QPointer<CppModelManager> modelManager)
227 228
    : snapshot(modelManager->snapshot()),
      m_modelManager(modelManager),
Roberto Raggi's avatar
Roberto Raggi committed
229
      preprocess(this, &env)
230
{ }
Roberto Raggi's avatar
Roberto Raggi committed
231 232

CppPreprocessor::~CppPreprocessor()
233
{ }
con's avatar
con committed
234

235 236
void CppPreprocessor::setWorkingCopy(const QMap<QString, QByteArray> &workingCopy)
{ m_workingCopy = workingCopy; }
con's avatar
con committed
237

238 239 240 241 242
void CppPreprocessor::setIncludePaths(const QStringList &includePaths)
{ m_includePaths = includePaths; }

void CppPreprocessor::setFrameworkPaths(const QStringList &frameworkPaths)
{ m_frameworkPaths = frameworkPaths; }
con's avatar
con committed
243

244 245 246
void CppPreprocessor::setProjectFiles(const QStringList &files)
{ m_projectFiles = files; }

247 248 249
void CppPreprocessor::setTodo(const QStringList &files)
{ m_todo = QSet<QString>::fromList(files); }

250 251 252

namespace {

253 254
class Process;

255
class CheckUndefinedSymbols: protected ASTVisitor
256 257
{
public:
258 259
    CheckUndefinedSymbols(Document::Ptr doc)
        : ASTVisitor(doc->control()), _process(0), _doc(doc)
260 261
    { }

262 263 264
    void setGlobalNamespaceBinding(NamespaceBindingPtr globalNamespaceBinding)
    { _globalNamespaceBinding = globalNamespaceBinding; }

265 266 267 268 269 270 271 272 273 274 275 276 277
    void operator()(AST *ast, Process *process)
    { _process = process; accept(ast); }

protected:
    using ASTVisitor::visit;

    virtual bool visit(ClassSpecifierAST *ast)
    {
        if (ast->base_clause) {
            unsigned line, col;
            getTokenStartPosition(ast->firstToken(), &line, &col);
            _context = lookupContext(line, col);
        }
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338

        bool hasQ_OBJECT_CHECK = false;

        if (ast->symbol) {
            Class *klass = ast->symbol->asClass();

            for (unsigned i = 0; i < klass->memberCount(); ++i) {
                Symbol *symbol = klass->memberAt(i);

                if (symbol->name() && symbol->name()->isNameId()) {
                    NameId *nameId = symbol->name()->asNameId();

                    if (! qstrcmp(nameId->identifier()->chars(), "qt_check_for_QOBJECT_macro")) {
                        hasQ_OBJECT_CHECK = true;
                        break;
                    }
                }
            }
        }

        _qobjectStack.append(hasQ_OBJECT_CHECK);

        return true;
    }

    virtual void endVisit(ClassSpecifierAST *)
    { _qobjectStack.removeLast(); }

    bool qobjectCheck() const
    {
        if (_qobjectStack.isEmpty())
            return false;

        return _qobjectStack.last();
    }

    virtual bool visit(FunctionDefinitionAST *ast)
    {
        if (ast->symbol) {
            Function *fun = ast->symbol->asFunction();
            if ((fun->isSignal() || fun->isSlot()) && ! qobjectCheck()) {
                translationUnit()->warning(ast->firstToken(),
                                           "you forgot the Q_OBJECT macro");
            }
        }
        return true;
    }

    virtual bool visit(SimpleDeclarationAST *ast)
    {
        const bool check = qobjectCheck();
        for (List<Declaration *> *it = ast->symbols; it; it = it->next) {
            Declaration *decl = it->value;

            if (Function *fun = decl->type()->asFunctionType()) {
                if ((fun->isSignal() || fun->isSlot()) && ! check) {
                    translationUnit()->warning(ast->firstToken(),
                                               "you forgot the Q_OBJECT macro");
                }
            }
        }
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
        return true;
    }

    virtual bool visit(BaseSpecifierAST *base)
    {
        if (base->name) {
            const QList<Symbol *> symbols = _context.resolveClass(base->name->name);

            if (symbols.isEmpty()) {
                const char *token = "after `:'";

                if (base->comma_token)
                    token = "after `,'";

                translationUnit()->warning(base->name->firstToken(),
                                           "expected class-name %s token", token);
            }
        }
357 358 359 360 361 362

        return true;
    }

    virtual bool visit(UsingDirectiveAST *ast)
    {
363
        if (ast->symbol && ast->symbol->name() && _globalNamespaceBinding) {
364 365 366 367 368 369 370
            const Location loc = Location(ast->symbol);

            NamespaceBinding *binding = _globalNamespaceBinding.data();

            if (Scope *enclosingNamespaceScope = ast->symbol->enclosingNamespaceScope())
                binding = NamespaceBinding::find(enclosingNamespaceScope->owner()->asNamespace(), binding);

Roberto Raggi's avatar
cleanup  
Roberto Raggi committed
371
            if (! binding || ! binding->resolveNamespace(loc, ast->symbol->name())) {
372 373 374 375 376
                translationUnit()->warning(ast->name->firstToken(),
                                           "expected a namespace after `=' token");
            }
        }

377 378 379 380 381 382 383
        return true;
    }

    LookupContext lookupContext(unsigned line, unsigned column) const;

private:
    Process *_process;
384
    Document::Ptr _doc;
385
    LookupContext _context;
386
    NamespaceBindingPtr _globalNamespaceBinding;
387
    QList<bool> _qobjectStack;
388 389
};

390
class Process: public std::unary_function<Document::Ptr, void>
391 392
{
    QPointer<CppModelManager> _modelManager;
393 394 395
    Snapshot _snapshot;
    QMap<QString, QByteArray> _workingCopy;
    Document::Ptr _doc;
396 397

public:
398 399 400 401 402 403
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
            const QMap<QString, QByteArray> &workingCopy)
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
404 405
    { }

406 407 408 409
    LookupContext lookupContext(unsigned line, unsigned column) const
    { return lookupContext(_doc->findSymbolAt(line, column)); }

    LookupContext lookupContext(Symbol *symbol) const
410
    {
411 412 413 414 415 416 417
        LookupContext context(symbol, Document::create("<none>"), _doc, _snapshot);
        return context;
    }

    void operator()(Document::Ptr doc)
    {
        _doc = doc;
418 419
        doc->parse();
        doc->check();
420 421

        if (_workingCopy.contains(doc->fileName())) {
Roberto Raggi's avatar
Roberto Raggi committed
422 423 424
            // run the binding pass
            NamespaceBindingPtr ns = bind(doc, _snapshot);

425
            // check for undefined symbols.
426 427
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
428

429
            checkUndefinedSymbols(doc->translationUnit()->ast(), this);
430 431
        }

432 433 434 435 436 437 438
        doc->releaseTranslationUnit();

        if (_modelManager)
            _modelManager->emitDocumentUpdated(doc); // ### TODO: compress
    }
};

439
LookupContext CheckUndefinedSymbols::lookupContext(unsigned line, unsigned column) const
440 441
{ return _process->lookupContext(line, column); }

442 443 444 445 446 447 448
} // end of anonymous namespace

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

450
void CppPreprocessor::resetEnvironment()
451 452 453 454
{
    env.reset();
    m_processed.clear();
}
455

456 457 458 459 460 461 462 463 464 465 466 467 468 469
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QByteArray *result)
{
    if (absoluteFilePath.isEmpty() || m_included.contains(absoluteFilePath)) {
        return true;
    }

    if (m_workingCopy.contains(absoluteFilePath)) {
        m_included.insert(absoluteFilePath);
        *result = m_workingCopy.value(absoluteFilePath);
        return true;
    }

    QFileInfo fileInfo(absoluteFilePath);
    if (! fileInfo.isFile())
con's avatar
con committed
470
        return false;
471 472 473 474 475 476 477 478 479

    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
480 481
    }

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
    return false;
}

QByteArray CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type)
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
        QByteArray contents;
        includeFile(fileName, &contents);
        return contents;
    }

    if (type == IncludeLocal && m_currentDoc) {
        QFileInfo currentFileInfo(m_currentDoc->fileName());
        QString path = currentFileInfo.absolutePath();
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
        QByteArray contents;
        if (includeFile(path, &contents)) {
            fileName = path;
con's avatar
con committed
503 504
            return contents;
        }
505
    }
con's avatar
con committed
506

507 508 509 510 511 512 513 514 515
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
        QByteArray contents;
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
516
        }
517
    }
con's avatar
con committed
518

519 520 521 522 523 524 525 526 527 528
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
        QByteArray contents;
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
529
        }
530 531 532 533 534 535
    }

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

537 538
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
539
            path += QLatin1Char('/');
540 541 542
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
543
            path = QDir::cleanPath(path);
con's avatar
con committed
544 545 546 547 548 549
            QByteArray contents;
            if (includeFile(path, &contents)) {
                fileName = path;
                return contents;
            }
        }
550
    }
con's avatar
con committed
551

552 553 554
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
555

556 557 558 559 560 561
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
            QByteArray contents;
            includeFile(fileName, &contents);
            return contents;
con's avatar
con committed
562 563 564
        }
    }

565 566 567
    //qDebug() << "**** file" << fileName << "not found!";
    return QByteArray();
}
con's avatar
con committed
568

Roberto Raggi's avatar
Roberto Raggi committed
569
void CppPreprocessor::macroAdded(const Macro &macro)
570 571 572
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
573

Roberto Raggi's avatar
Roberto Raggi committed
574
    m_currentDoc->appendMacro(macro);
575
}
576

577
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
578
                                          const Macro &macro,
579 580
                                          const QByteArray &originalText,
                                          const QVector<MacroArgumentReference> &actuals)
581 582 583
{
    if (! m_currentDoc)
        return;
584

585
    //qDebug() << "start expanding:" << macro.name << "text:" << originalText;
586
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), actuals);
587
}
588

589
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
590 591 592
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
593

594 595
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
596

597 598 599 600
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
601

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

604
    if (m_processed.contains(fn))
605
        return;
con's avatar
con committed
606

607
    m_processed.insert(fn);
con's avatar
con committed
608

609
    foreach (const Document::Include &incl, doc->includes()) {
610 611 612
        QString includedFile = incl.fileName();

        if (Document::Ptr includedDoc = snapshot.value(includedFile))
613
            mergeEnvironment(includedDoc);
614 615
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
616
    }
con's avatar
con committed
617

618
    env.addMacros(doc->definedMacros());
619
}
con's avatar
con committed
620

621 622 623 624 625 626 627 628 629 630 631 632 633 634
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);
}

635 636
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type,
                                   unsigned line)
637 638 639 640 641 642 643
{
    if (fileName.isEmpty())
        return;

    QByteArray contents = tryIncludeFile(fileName, type);

    if (m_currentDoc) {
644
        m_currentDoc->addIncludeFile(fileName, line);
645

646
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
647 648
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
649

650 651 652 653
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
654

655
            m_currentDoc->addDiagnosticMessage(d);
656

657
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
658
        }
659
    }
con's avatar
con committed
660

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

663 664 665 666 667
    Document::Ptr doc = snapshot.value(fileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
668

669
    doc = Document::create(fileName);
con's avatar
con committed
670

671
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
672

Roberto Raggi's avatar
Roberto Raggi committed
673
    const QByteArray preprocessedCode = preprocess(fileName.toUtf8(), contents);
con's avatar
con committed
674

675
    doc->setSource(preprocessedCode);
676 677
    doc->tokenize();
    doc->releaseSource();
678

679
    snapshot.insert(doc->fileName(), doc);
680
    m_todo.remove(fileName);
con's avatar
con committed
681

682
    Process process(m_modelManager, snapshot, m_workingCopy);
683 684

    process(doc);
685 686

    (void) switchDocument(previousDoc);
687
}
con's avatar
con committed
688

689 690 691 692 693 694
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
695 696 697 698 699 700 701 702 703



/*!
    \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
704
    modified within Qt Creator.
con's avatar
con committed
705 706
*/

707 708
CppModelManager::CppModelManager(QObject *parent)
    : CppModelManagerInterface(parent)
con's avatar
con committed
709
{
Roberto Raggi's avatar
Roberto Raggi committed
710 711
    m_synchronizer.setCancelOnWait(true);

712
    m_core = Core::ICore::instance(); // FIXME
713 714
    m_dirty = true;

715
    ProjectExplorer::ProjectExplorerPlugin *pe =
716
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
717

718
    QTC_ASSERT(pe, return);
con's avatar
con committed
719

720
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
721
    QTC_ASSERT(session, return);
con's avatar
con committed
722

Roberto Raggi's avatar
Roberto Raggi committed
723 724 725 726 727 728
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

729 730 731
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
    connect(session, SIGNAL(aboutToRemoveProject(ProjectExplorer::Project *)),
            this, SLOT(onAboutToRemoveProject(ProjectExplorer::Project *)));

    connect(session, SIGNAL(sessionUnloaded()),
            this, SLOT(onSessionUnloaded()));

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

755
Snapshot CppModelManager::snapshot() const
756
{
757
    QMutexLocker locker(&protectSnapshot);
758 759
    return m_snapshot;
}
con's avatar
con committed
760

761 762 763 764 765 766
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

767 768 769 770
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
771 772 773
    m_dirty = false;
}

774
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
775 776 777 778 779 780 781 782
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
783
    files.removeDuplicates();
con's avatar
con committed
784 785 786
    return files;
}

787
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
788 789 790 791 792 793 794 795
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
796
    includePaths.removeDuplicates();
con's avatar
con committed
797 798 799
    return includePaths;
}

800
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
801 802 803 804 805 806 807 808
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
809
    frameworkPaths.removeDuplicates();
con's avatar
con committed
810 811 812
    return frameworkPaths;
}

813
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
814 815 816 817 818 819 820 821 822 823 824
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

825 826 827 828 829 830 831 832 833 834
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

835
QMap<QString, QByteArray> CppModelManager::buildWorkingCopyList()
con's avatar
con committed
836 837 838 839 840 841 842 843
{
    QMap<QString, QByteArray> workingCopy;
    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();
844
        workingCopy[fileName] = editorSupport->contents();
con's avatar
con committed
845 846
    }

847 848 849 850 851 852
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
        workingCopy[es->fileName()] = es->contents();
    }

con's avatar
con committed
853 854 855 856 857 858 859 860 861 862 863
    // add the project configuration file
    QByteArray conf(pp_configuration);
    conf += definedMacros();
    workingCopy[pp_configuration_file] = conf;

    return workingCopy;
}

void CppModelManager::updateSourceFiles(const QStringList &sourceFiles)
{ (void) refreshSourceFiles(sourceFiles); }

864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
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);
886
    m_dirty = true;
887
}
con's avatar
con committed
888 889 890

QFuture<void> CppModelManager::refreshSourceFiles(const QStringList &sourceFiles)
{
891
    if (! sourceFiles.isEmpty() && qgetenv("QTCREATOR_NO_CODE_INDEXER").isNull()) {
con's avatar
con committed
892 893
        const QMap<QString, QByteArray> workingCopy = buildWorkingCopyList();

894 895 896 897 898 899 900 901
        CppPreprocessor *preproc = new CppPreprocessor(this);
        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
902

Roberto Raggi's avatar
Roberto Raggi committed
903 904 905 906 907 908 909 910 911 912 913
        if (m_synchronizer.futures().size() > 10) {
            QList<QFuture<void> > futures = m_synchronizer.futures();

            m_synchronizer.clearFutures();

            foreach (QFuture<void> future, futures) {
                if (! (future.isFinished() || future.isCanceled()))
                    m_synchronizer.addFuture(future);
            }
        }

Roberto Raggi's avatar
Roberto Raggi committed
914 915
        m_synchronizer.addFuture(result);

con's avatar
con committed
916 917 918
        if (sourceFiles.count() > 1) {
            m_core->progressManager()->addTask(result, tr("Indexing"),
                            CppTools::Constants::TASK_INDEX,
919
                            Core::ProgressManager::CloseOnSuccess);
con's avatar
con committed
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937
        }
        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
938
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
939 940 941 942 943 944 945 946 947 948 949

        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
950
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
951 952 953 954 955 956 957 958 959 960 961 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
{
    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();
971 972 973 974 975

    protectSnapshot.lock();
    m_snapshot.insert(doc);
    protectSnapshot.unlock();

con's avatar
con committed
976 977 978 979 980 981 982 983 984 985 986 987 988
    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;

989
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
990 991 992 993 994
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

995 996 997 998 999 1000
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1001
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1002 1003 1004 1005 1006 1007 1008 1009 1010
                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
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
            // 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);

1021
#ifdef QTCREATOR_WITH_ADVANCED_HIGHLIGHTER
1022
            QSet<QPair<unsigned, unsigned> > lines;
1023
            foreach (const Document::DiagnosticMessage &m, doc->diagnosticMessages()) {
con's avatar
con committed
1024 1025
                if (m.fileName() != fileName)
                    continue;
1026 1027 1028 1029

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

                if (lines.contains(coordinates))
con's avatar
con committed
1030 1031
                    continue;

1032
                lines.insert(coordinates);
con's avatar
con committed
1033 1034 1035 1036 1037 1038 1039 1040

                QTextEdit::ExtraSelection sel;
                if (m.isWarning())
                    sel.format = warningFormat;
                else
                    sel.format = errorFormat;

                QTextCursor c(ed->document()->findBlockByNumber(m.line() - 1));
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054

                // ### check for generated tokens.

                int column = m.column();

                if (column > c.block().length()) {
                    column = 0;

                    const QString text = c.block().text();
                    for (int i = 0; i < text.size(); ++i) {
                        if (! text.at(i).isSpace()) {
                            ++column;
                            break;
                        }
con's avatar
con committed
1055 1056
                    }
                }
1057 1058 1059 1060 1061 1062

                if (column != 0)
                    --column;

                c.setPosition(c.position() + column);
                c.movePosition(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
con's avatar
con committed
1063 1064 1065
                sel.cursor = c;
                selections.append(sel);
            }
1066 1067 1068 1069 1070 1071 1072 1073 1074
#else
            QSet<int> lines;
            foreach (const Document::DiagnosticMessage &m, doc->diagnosticMessages()) {
                if (m.fileName() != fileName)
                    continue;
                else if (lines.contains(m.line()))
                    continue;

                lines.insert(m.line());
Roberto Raggi's avatar
Roberto Raggi committed
1075

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
                QTextEdit::ExtraSelection sel;
                if (m.isWarning())
                    sel.format = warningFormat;
                else
                    sel.format = errorFormat;

                QTextCursor c(ed->document()->findBlockByNumber(m.line() - 1));
                const QString text = c.block().text();
                for (int i = 0; i < text.size(); ++i) {
                    if (! text.at(i).isSpace()) {
                        c.setPosition(c.position() + i);
                        break;
                    }
                }
                c.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);
                sel.cursor = c;
                selections.append(sel);
            }
#endif
Roberto Raggi's avatar
Roberto Raggi committed
1095
            QList<Editor> todo;
1096
            foreach (const Editor &e, todo) {
1097
                if (e.textEditor != textEditor)
Roberto Raggi's avatar
Roberto Raggi committed
1098 1099 1100 1101
                    todo.append(e);
            }

            Editor e;
1102
            e.textEditor = textEditor;
Roberto Raggi's avatar
Roberto Raggi committed
1103
            e.selections = selections;
1104
            e.ifdefedOutBlocks = blockRanges;
Roberto Raggi's avatar
Roberto Raggi committed
1105 1106 1107
            todo.append(e);
            m_todo = todo;
            postEditorUpdate();
con's avatar
con committed
1108 1109 1110 1111 1112
            break;
        }
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
1113 1114 1115 1116 1117 1118 1119
void CppModelManager::postEditorUpdate()
{
    m_updateEditorSelectionsTimer->start(500);
}

void CppModelManager::updateEditorSelections()
{
1120
    foreach (const Editor &ed, m_todo) {
1121
        if (! ed.textEditor)
Roberto Raggi's avatar
Roberto Raggi committed
1122 1123
            continue;

1124 1125 1126 1127 1128 1129 1130
        TextEditor::ITextEditor *textEditor = ed.textEditor;
        TextEditor::BaseTextEditor *editor = qobject_cast<TextEditor::BaseTextEditor *>(textEditor->widget());
        if (! editor)
            continue;

        editor->setExtraSelections(TextEditor::BaseTextEditor::CodeWarningsSelection,
                                   ed.selections);
1131

1132
        editor->setIfdefedOutBlocks(ed.ifdefedOutBlocks);
Roberto Raggi's avatar
Roberto Raggi committed
1133 1134 1135
    }

    m_todo.clear();
1136

Roberto Raggi's avatar
Roberto Raggi committed
1137 1138
}

1139 1140
void CppModelManager::onProjectAdded(ProjectExplorer::Project *)
{
1141
    QMutexLocker locker(&mutex);
1142 1143 1144
    m_dirty = true;
}

con's avatar
con committed