cppmodelmanager.cpp 41.3 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>
32
#include <cplusplus/Overview.h>
con's avatar
con committed
33 34 35 36 37

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

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

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

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

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

73 74
#include <cplusplus/LookupContext.h>

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

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

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 127
#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
128
#endif // QTCREATOR_WITH_DUMP_AST
129

con's avatar
con committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
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"

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

con's avatar
con committed
153 154 155 156 157 158 159 160 161 162 163 164
    // ### 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";

165 166 167
namespace CppTools {
namespace Internal {

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

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

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

182 183
    void resetEnvironment();

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

187 188 189
public: // attributes
    Snapshot snapshot;

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

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

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

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

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

224 225
} // namespace Internal
} // namespace CppTools
226

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

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

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

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

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

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

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

251 252 253

namespace {

254 255
class Process;

256
class CheckUndefinedSymbols: protected ASTVisitor
257
{
258 259
    QSet<QByteArray> _types;

260
public:
261 262
    CheckUndefinedSymbols(Document::Ptr doc)
        : ASTVisitor(doc->control()), _process(0), _doc(doc)
263 264
    { }

265
    void setGlobalNamespaceBinding(NamespaceBindingPtr globalNamespaceBinding)
266 267 268 269 270 271 272 273 274
    {
        _globalNamespaceBinding = globalNamespaceBinding;
        _types.clear();

        if (_globalNamespaceBinding) {
            QSet<NamespaceBinding *> processed;
            buildTypeMap(_globalNamespaceBinding.data(), &processed);
        }
    }
275

276 277 278 279 280 281
    void operator()(AST *ast, Process *process)
    { _process = process; accept(ast); }

protected:
    using ASTVisitor::visit;

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 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
    void addType(Name *name)
    {
        if (! name)
            return;

        if (Identifier *id = name->identifier())
            _types.insert(QByteArray(id->chars(), id->size()));
    }

    void buildTypeMap(Class *klass)
    {
        addType(klass->name());

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

            if (Class *klass = member->asClass()) {
                buildTypeMap(klass);
            } else if (Enum *e = member->asEnum()) {
                addType(e->name());
            } else if (ForwardClassDeclaration *fwd = member->asForwardClassDeclaration()) {
                addType(fwd->name());
            } else if (Declaration *decl = member->asDeclaration()) {
                if (decl->isTypedef())
                    addType(decl->name());
            }
        }
    }

    void buildTypeMap(NamespaceBinding *binding, QSet<NamespaceBinding *> *processed)
    {
        if (! processed->contains(binding)) {
            processed->insert(binding);

            foreach (Namespace *ns, binding->symbols) {
                for (unsigned i = 0; i < ns->memberCount(); ++i) {
                    Symbol *member = ns->memberAt(i);

                    if (Class *klass = member->asClass()) {
                        buildTypeMap(klass);
                    } else if (Enum *e = member->asEnum()) {
                        addType(e->name());
                    } else if (ForwardClassDeclaration *fwd = member->asForwardClassDeclaration()) {
                        addType(fwd->name());
                    } else if (Declaration *decl = member->asDeclaration()) {
                        if (decl->isTypedef())
                            addType(decl->name());
                    }
                }
            }

            foreach (NamespaceBinding *childBinding, binding->children) {
                buildTypeMap(childBinding, processed);
            }
        }
    }

    QList<FunctionDeclaratorAST *> functionDeclarationStack;

    FunctionDeclaratorAST *currentFunctionDeclarator() const
    {
        if (functionDeclarationStack.isEmpty())
            return 0;

        return functionDeclarationStack.last();
    }

    virtual bool visit(FunctionDeclaratorAST *ast)
    {
        functionDeclarationStack.append(ast);

        return true;
    }

    virtual void endVisit(FunctionDeclaratorAST *)
    {
        functionDeclarationStack.removeLast();
    }

    virtual bool visit(TypeofSpecifierAST *ast)
    {
        accept(ast->next);
        return false;
    }

    virtual bool visit(NamedTypeSpecifierAST *ast)
    {
        if (ast->name) {
            if (! ast->name->name) {
                unsigned line, col;
                getTokenStartPosition(ast->firstToken(), &line, &col);
                // qWarning() << _doc->fileName() << line << col;
            } else if (Identifier *id = ast->name->name->identifier()) {
                if (! _types.contains(QByteArray::fromRawData(id->chars(), id->size()))) {
                    if (FunctionDeclaratorAST *functionDeclarator = currentFunctionDeclarator()) {
                        if (functionDeclarator->as_cpp_initializer)
                            return true;
                    }

                    Overview oo;
Roberto Raggi's avatar
Roberto Raggi committed
382
                    translationUnit()->warning(ast->firstToken(), "`%s' is not a type name",
383 384 385 386 387 388 389
                                               qPrintable(oo(ast->name->name)));
                }
            }
        }
        return true;
    }

390 391 392 393 394 395 396
    virtual bool visit(ClassSpecifierAST *ast)
    {
        if (ast->base_clause) {
            unsigned line, col;
            getTokenStartPosition(ast->firstToken(), &line, &col);
            _context = lookupContext(line, col);
        }
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

        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");
                }
            }
        }
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
        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);
            }
        }
476 477 478 479 480 481

        return true;
    }

    virtual bool visit(UsingDirectiveAST *ast)
    {
482
        if (ast->symbol && ast->symbol->name() && _globalNamespaceBinding) {
483 484 485 486 487 488 489
            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
490
            if (! binding || ! binding->resolveNamespace(loc, ast->symbol->name())) {
491 492 493 494 495
                translationUnit()->warning(ast->name->firstToken(),
                                           "expected a namespace after `=' token");
            }
        }

496 497 498 499 500 501 502
        return true;
    }

    LookupContext lookupContext(unsigned line, unsigned column) const;

private:
    Process *_process;
503
    Document::Ptr _doc;
504
    LookupContext _context;
505
    NamespaceBindingPtr _globalNamespaceBinding;
506
    QList<bool> _qobjectStack;
507 508
};

509
class Process: public std::unary_function<Document::Ptr, void>
510 511
{
    QPointer<CppModelManager> _modelManager;
512 513 514
    Snapshot _snapshot;
    QMap<QString, QByteArray> _workingCopy;
    Document::Ptr _doc;
515 516

public:
517 518 519 520 521 522
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
            const QMap<QString, QByteArray> &workingCopy)
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
523 524
    { }

525 526 527 528
    LookupContext lookupContext(unsigned line, unsigned column) const
    { return lookupContext(_doc->findSymbolAt(line, column)); }

    LookupContext lookupContext(Symbol *symbol) const
529
    {
530 531 532 533 534 535 536
        LookupContext context(symbol, Document::create("<none>"), _doc, _snapshot);
        return context;
    }

    void operator()(Document::Ptr doc)
    {
        _doc = doc;
537 538
        doc->parse();
        doc->check();
539 540

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

544
            // check for undefined symbols.
545 546
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
547

548
            checkUndefinedSymbols(doc->translationUnit()->ast(), this);
549 550
        }

551 552 553 554 555 556 557
        doc->releaseTranslationUnit();

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

558
LookupContext CheckUndefinedSymbols::lookupContext(unsigned line, unsigned column) const
559 560
{ return _process->lookupContext(line, column); }

561 562 563 564 565 566 567
} // end of anonymous namespace

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

569
void CppPreprocessor::resetEnvironment()
570 571 572 573
{
    env.reset();
    m_processed.clear();
}
574

575 576 577 578 579 580 581 582 583 584 585 586 587 588
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
589
        return false;
590 591 592 593 594 595 596 597 598

    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
599 600
    }

601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
    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
622 623
            return contents;
        }
624
    }
con's avatar
con committed
625

626 627 628 629 630 631 632 633 634
    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
635
        }
636
    }
con's avatar
con committed
637

638 639 640 641 642 643 644 645 646 647
    // 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
648
        }
649 650 651 652 653 654
    }

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

656 657
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
658
            path += QLatin1Char('/');
659 660 661
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
662
            path = QDir::cleanPath(path);
con's avatar
con committed
663 664 665 666 667 668
            QByteArray contents;
            if (includeFile(path, &contents)) {
                fileName = path;
                return contents;
            }
        }
669
    }
con's avatar
con committed
670

671 672 673
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
674

675 676 677 678 679 680
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
            QByteArray contents;
            includeFile(fileName, &contents);
            return contents;
con's avatar
con committed
681 682 683
        }
    }

684 685 686
    //qDebug() << "**** file" << fileName << "not found!";
    return QByteArray();
}
con's avatar
con committed
687

Roberto Raggi's avatar
Roberto Raggi committed
688
void CppPreprocessor::macroAdded(const Macro &macro)
689 690 691
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
692

Roberto Raggi's avatar
Roberto Raggi committed
693
    m_currentDoc->appendMacro(macro);
694
}
695

696
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
697
                                          const Macro &macro,
698 699
                                          const QByteArray &originalText,
                                          const QVector<MacroArgumentReference> &actuals)
700 701 702
{
    if (! m_currentDoc)
        return;
703

704
    //qDebug() << "start expanding:" << macro.name << "text:" << originalText;
705
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), actuals);
706
}
707

708
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
709 710 711
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
712

713 714
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
715

716 717 718 719
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
720

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

723
    if (m_processed.contains(fn))
724
        return;
con's avatar
con committed
725

726
    m_processed.insert(fn);
con's avatar
con committed
727

728
    foreach (const Document::Include &incl, doc->includes()) {
729 730 731
        QString includedFile = incl.fileName();

        if (Document::Ptr includedDoc = snapshot.value(includedFile))
732
            mergeEnvironment(includedDoc);
733 734
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
735
    }
con's avatar
con committed
736

737
    env.addMacros(doc->definedMacros());
738
}
con's avatar
con committed
739

740 741 742 743 744 745 746 747 748 749 750 751 752 753
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);
}

754 755
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type,
                                   unsigned line)
756 757 758 759 760 761 762
{
    if (fileName.isEmpty())
        return;

    QByteArray contents = tryIncludeFile(fileName, type);

    if (m_currentDoc) {
763
        m_currentDoc->addIncludeFile(fileName, line);
764

765
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
766 767
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
768

769 770 771 772
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
773

774
            m_currentDoc->addDiagnosticMessage(d);
775

776
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
777
        }
778
    }
con's avatar
con committed
779

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

782 783 784 785 786
    Document::Ptr doc = snapshot.value(fileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
787

788
    doc = Document::create(fileName);
con's avatar
con committed
789

790
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
791

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

794
    doc->setSource(preprocessedCode);
795 796
    doc->tokenize();
    doc->releaseSource();
797

798
    snapshot.insert(doc->fileName(), doc);
799
    m_todo.remove(fileName);
con's avatar
con committed
800

801
    Process process(m_modelManager, snapshot, m_workingCopy);
802 803

    process(doc);
804 805

    (void) switchDocument(previousDoc);
806
}
con's avatar
con committed
807

808 809 810 811 812 813
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
814 815 816 817 818 819 820 821 822



/*!
    \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
823
    modified within Qt Creator.
con's avatar
con committed
824 825
*/

826 827
CppModelManager::CppModelManager(QObject *parent)
    : CppModelManagerInterface(parent)
con's avatar
con committed
828
{
Roberto Raggi's avatar
Roberto Raggi committed
829 830
    m_synchronizer.setCancelOnWait(true);

831
    m_core = Core::ICore::instance(); // FIXME
832 833
    m_dirty = true;

834
    ProjectExplorer::ProjectExplorerPlugin *pe =
835
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
836

837
    QTC_ASSERT(pe, return);
con's avatar
con committed
838

839
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
840
    QTC_ASSERT(session, return);
con's avatar
con committed
841

Roberto Raggi's avatar
Roberto Raggi committed
842 843 844 845 846 847
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

848 849 850
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
    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()
{ }

874
Snapshot CppModelManager::snapshot() const
875
{
876
    QMutexLocker locker(&protectSnapshot);
877 878
    return m_snapshot;
}
con's avatar
con committed
879

880 881 882 883 884 885
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

886 887 888 889
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
890 891 892
    m_dirty = false;
}

893
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
894 895 896 897 898 899 900 901
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
902
    files.removeDuplicates();
con's avatar
con committed
903 904 905
    return files;
}

906
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
907 908 909 910 911 912 913 914
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
915
    includePaths.removeDuplicates();
con's avatar
con committed
916 917 918
    return includePaths;
}

919
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
920 921 922 923 924 925 926 927
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
928
    frameworkPaths.removeDuplicates();
con's avatar
con committed
929 930 931
    return frameworkPaths;
}

932
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
933 934 935 936 937 938 939 940 941 942 943
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

944 945 946 947 948 949 950 951 952 953
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

954
QMap<QString, QByteArray> CppModelManager::buildWorkingCopyList()
con's avatar
con committed
955 956 957 958 959 960 961 962
{
    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();
963
        workingCopy[fileName] = editorSupport->contents();
con's avatar
con committed
964 965
    }

966 967 968 969 970 971
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
        workingCopy[es->fileName()] = es->contents();
    }

con's avatar
con committed
972 973 974 975 976 977 978 979 980 981 982
    // 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); }

983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
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);
1005
    m_dirty = true;
1006
}
con's avatar
con committed
1007 1008 1009

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

1013 1014 1015 1016 1017 1018 1019 1020
        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
1021

Roberto Raggi's avatar
Roberto Raggi committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
        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
1033 1034
        m_synchronizer.addFuture(result);

con's avatar
con committed
1035 1036 1037
        if (sourceFiles.count() > 1) {
            m_core->progressManager()->addTask(result, tr("Indexing"),
                            CppTools::Constants::TASK_INDEX,
1038
                            Core::ProgressManager::CloseOnSuccess);
con's avatar
con committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
        }
        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
1057
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068

        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
1069
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089

        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();
1090 1091 1092 1093 1094

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

con's avatar
con committed
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
    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;

1108
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
1109 1110 1111 1112 1113
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

1114 1115 1116 1117 1118 1119
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1120
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1121 1122 1123 1124 1125 1126 1127 1128 1129
                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
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
            // 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);

1140
#ifdef QTCREATOR_WITH_ADVANCED_HIGHLIGHTER
1141
            QSet<QPair<unsigned, unsigned> > lines;
1142
            foreach (const Document::DiagnosticMessage &m, doc->diagnosticMessages()) {
con's avatar
con committed
1143 1144
                if (m.fileName() != fileName)
                    continue;
1145 1146 1147 1148

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

                if (lines.contains(coordinates))
con's avatar
con committed
1149 1150
                    continue;

1151
                lines.insert(coordinates);
con's avatar
con committed
1152 1153 1154 1155 1156 1157 1158 1159

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

                QTextCursor c(ed->document()->findBlockByNumber(m.line() - 1));
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173

                // ### 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
1174 1175
                    }
                }
1176 1177 1178 1179 1180 1181

                if (column != 0)
                    --column;

                c.setPosition(c.position() + column);
                c.movePosition(QTextCursor::EndOfWord, QTextCursor::KeepAnchor);
con's avatar
con committed
1182 1183 1184
                sel.cursor = c;
                selections.append(sel);
            }
1185 1186 1187