cppmodelmanager.cpp 43.6 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
** 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
26
** contact the sales department at http://www.qtsoftware.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

Roberto Raggi's avatar
Roberto Raggi committed
30
#include <cplusplus/pp.h>
Roberto Raggi's avatar
Roberto Raggi committed
31
#include <cplusplus/CppBindings.h>
32
#include <cplusplus/Overview.h>
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
    void setWorkingCopy(const QMap<QString, QString> &workingCopy);
175 176 177
    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, QString *result);
    QString 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
    QStringList m_includePaths;
    QStringList m_systemIncludePaths;
215
    QMap<QString, QString> m_workingCopy;
216 217 218
    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
void CppPreprocessor::setWorkingCopy(const QMap<QString, QString> &workingCopy)
237
{ 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
    QSet<QByteArray> _types;
Roberto Raggi's avatar
Roberto Raggi committed
259
    QSet<QByteArray> _namespaceNames;
260

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

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

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

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

protected:
    using ASTVisitor::visit;

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
    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);

Roberto Raggi's avatar
Roberto Raggi committed
317 318 319 320
            if (Identifier *id = binding->identifier()) {
                _namespaceNames.insert(QByteArray(id->chars(), id->size()));
            }

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
            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;
    }

372 373 374 375 376 377 378 379
    virtual bool visit(TypenameTypeParameterAST *ast)
    {
        if (ast->name)
            addType(ast->name->name);

        return true;
    }

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
    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
395
                    translationUnit()->warning(ast->firstToken(), "`%s' is not a type name",
396 397 398 399 400 401 402
                                               qPrintable(oo(ast->name->name)));
                }
            }
        }
        return true;
    }

403 404 405 406 407 408 409
    virtual bool visit(ClassSpecifierAST *ast)
    {
        if (ast->base_clause) {
            unsigned line, col;
            getTokenStartPosition(ast->firstToken(), &line, &col);
            _context = lookupContext(line, col);
        }
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 458 459 460 461 462 463 464 465 466 467 468 469 470

        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");
                }
            }
        }
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
        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);
            }
        }
489 490 491 492 493 494

        return true;
    }

    virtual bool visit(UsingDirectiveAST *ast)
    {
495
        if (ast->symbol && ast->symbol->name() && _globalNamespaceBinding) {
496 497 498 499 500 501 502
            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
503
            if (! binding || ! binding->resolveNamespace(loc, ast->symbol->name())) {
504
                translationUnit()->warning(ast->name->firstToken(),
Roberto Raggi's avatar
Roberto Raggi committed
505
                                           "expected a namespace");
506 507 508
            }
        }

509 510 511
        return true;
    }

Roberto Raggi's avatar
Roberto Raggi committed
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
    virtual bool visit(QualifiedNameAST *ast)
    {
        if (ast->name) {
            QualifiedNameId *q = ast->name->asQualifiedNameId();
            for (unsigned i = 0; i < q->nameCount() - 1; ++i) {
                Name *name = q->nameAt(i);
                if (Identifier *id = name->identifier()) {
                    const QByteArray spell = QByteArray::fromRawData(id->chars(), id->size());
                    if (! (_namespaceNames.contains(spell) || _types.contains(spell))) {
                        translationUnit()->warning(ast->firstToken(),
                                                   "`%s' is not a namespace or class name",
                                                   spell.constData());
                    }
                }
            }
        }

        return true;
    }

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
    virtual bool visit(BinaryExpressionAST *ast)
    {
        if (ast->right_expression) {
            if (CastExpressionAST *right_cast_expr = ast->right_expression->asCastExpression()) {
                if (right_cast_expr->type_id) {
                    if (TypeIdAST *right_cast_type_id = right_cast_expr->type_id->asTypeId()) {
                        SpecifierAST *type_specifier = right_cast_type_id->type_specifier;
                        if (! right_cast_type_id->declarator && type_specifier && ! type_specifier->next &&
                                type_specifier->asNamedTypeSpecifier() && right_cast_expr->expression &&
                                right_cast_expr->expression->asUnaryExpression()) {
                            // this ast node is ambigious, e.g.
                            //   1 + (a) + b
                            // it can be parsed as
                            //   1 + ((a) + b)
                            // or
                            //   1 + (a) (+b)
                            accept(ast->left_expression);
                            accept(right_cast_expr->expression);
                            return false;
                        }
                    }
                }
            }
        }

        return true;
    }

560 561 562 563
    LookupContext lookupContext(unsigned line, unsigned column) const;

private:
    Process *_process;
564
    Document::Ptr _doc;
565
    LookupContext _context;
566
    NamespaceBindingPtr _globalNamespaceBinding;
567
    QList<bool> _qobjectStack;
568 569
};

570
class Process: public std::unary_function<Document::Ptr, void>
571 572
{
    QPointer<CppModelManager> _modelManager;
573
    Snapshot _snapshot;
574
    QMap<QString, QString> _workingCopy;
575
    Document::Ptr _doc;
576 577

public:
578 579
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
580
            const QMap<QString, QString> &workingCopy)
581 582 583
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
584 585
    { }

586 587 588 589
    LookupContext lookupContext(unsigned line, unsigned column) const
    { return lookupContext(_doc->findSymbolAt(line, column)); }

    LookupContext lookupContext(Symbol *symbol) const
590
    {
Roberto Raggi's avatar
Roberto Raggi committed
591
        LookupContext context(symbol, Document::create(QLatin1String("<none>")), _doc, _snapshot);
592 593 594 595 596 597
        return context;
    }

    void operator()(Document::Ptr doc)
    {
        _doc = doc;
598 599
        doc->parse();
        doc->check();
600 601

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

605
            // check for undefined symbols.
606 607
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
608

609
            checkUndefinedSymbols(doc->translationUnit()->ast(), this);
610 611
        }

612 613 614 615 616 617 618
        doc->releaseTranslationUnit();

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

619
LookupContext CheckUndefinedSymbols::lookupContext(unsigned line, unsigned column) const
620 621
{ return _process->lookupContext(line, column); }

622 623 624 625 626 627 628
} // end of anonymous namespace

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

630
void CppPreprocessor::resetEnvironment()
631 632 633 634
{
    env.reset();
    m_processed.clear();
}
635

636
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result)
637 638 639 640 641 642 643 644 645 646 647 648 649
{
    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
650
        return false;
651 652 653 654 655 656 657 658 659

    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
660 661
    }

662 663 664
    return false;
}

665
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type)
666 667 668
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
669
        QString contents;
670 671 672 673 674 675 676 677 678 679
        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);
680
        QString contents;
681 682
        if (includeFile(path, &contents)) {
            fileName = path;
con's avatar
con committed
683 684
            return contents;
        }
685
    }
con's avatar
con committed
686

687 688 689 690 691
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
692
        QString contents;
693 694 695
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
696
        }
697
    }
con's avatar
con committed
698

699 700 701 702 703 704
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
705
        QString contents;
706 707 708
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
709
        }
710 711 712 713 714 715
    }

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

717 718
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
719
            path += QLatin1Char('/');
720 721 722
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
723
            path = QDir::cleanPath(path);
724
            QString contents;
con's avatar
con committed
725 726 727 728 729
            if (includeFile(path, &contents)) {
                fileName = path;
                return contents;
            }
        }
730
    }
con's avatar
con committed
731

732 733 734
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
735

736 737 738
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
739
            QString contents;
740 741
            includeFile(fileName, &contents);
            return contents;
con's avatar
con committed
742 743 744
        }
    }

745
    //qDebug() << "**** file" << fileName << "not found!";
746
    return QString();
747
}
con's avatar
con committed
748

Roberto Raggi's avatar
Roberto Raggi committed
749
void CppPreprocessor::macroAdded(const Macro &macro)
750 751 752
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
753

Roberto Raggi's avatar
Roberto Raggi committed
754
    m_currentDoc->appendMacro(macro);
755
}
756

757
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
758
                                          const Macro &macro,
759 760
                                          const QByteArray &originalText,
                                          const QVector<MacroArgumentReference> &actuals)
761 762 763
{
    if (! m_currentDoc)
        return;
764

765
    //qDebug() << "start expanding:" << macro.name << "text:" << originalText;
766
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), actuals);
767
}
768

769
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
770 771 772
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
773

774 775
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
776

777 778 779 780
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
781

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

784
    if (m_processed.contains(fn))
785
        return;
con's avatar
con committed
786

787
    m_processed.insert(fn);
con's avatar
con committed
788

789
    foreach (const Document::Include &incl, doc->includes()) {
790 791 792
        QString includedFile = incl.fileName();

        if (Document::Ptr includedDoc = snapshot.value(includedFile))
793
            mergeEnvironment(includedDoc);
794 795
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
796
    }
con's avatar
con committed
797

798
    env.addMacros(doc->definedMacros());
799
}
con's avatar
con committed
800

801 802 803 804 805 806 807 808 809 810 811 812 813 814
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);
}

815 816
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type,
                                   unsigned line)
817 818 819 820
{
    if (fileName.isEmpty())
        return;

821
    QString contents = tryIncludeFile(fileName, type);
822 823

    if (m_currentDoc) {
824
        m_currentDoc->addIncludeFile(fileName, line);
825

826
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
827 828
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
829

830 831 832 833
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
834

835
            m_currentDoc->addDiagnosticMessage(d);
836

837
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
838
        }
839
    }
con's avatar
con committed
840

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

843 844 845 846 847
    Document::Ptr doc = snapshot.value(fileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
848

849
    doc = Document::create(fileName);
con's avatar
con committed
850

851
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
852

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

855
    doc->setSource(preprocessedCode);
856 857
    doc->tokenize();
    doc->releaseSource();
858

859
    snapshot.insert(doc->fileName(), doc);
860
    m_todo.remove(fileName);
con's avatar
con committed
861

862
    Process process(m_modelManager, snapshot, m_workingCopy);
863 864

    process(doc);
865 866

    (void) switchDocument(previousDoc);
867
}
con's avatar
con committed
868

869 870 871 872 873 874
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
875 876 877 878 879 880 881 882 883



/*!
    \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
884
    modified within Qt Creator.
con's avatar
con committed
885 886
*/

887 888
CppModelManager::CppModelManager(QObject *parent)
    : CppModelManagerInterface(parent)
con's avatar
con committed
889
{
Roberto Raggi's avatar
Roberto Raggi committed
890 891
    m_synchronizer.setCancelOnWait(true);

892
    m_core = Core::ICore::instance(); // FIXME
893 894
    m_dirty = true;

895
    ProjectExplorer::ProjectExplorerPlugin *pe =
896
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
897

898
    QTC_ASSERT(pe, return);
con's avatar
con committed
899

900
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
901
    QTC_ASSERT(session, return);
con's avatar
con committed
902

Roberto Raggi's avatar
Roberto Raggi committed
903 904 905 906 907 908
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

909 910 911
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
    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()
{ }

935
Snapshot CppModelManager::snapshot() const
936
{
937
    QMutexLocker locker(&protectSnapshot);
938 939
    return m_snapshot;
}
con's avatar
con committed
940

941 942 943 944 945 946
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

947 948 949 950
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
951 952 953
    m_dirty = false;
}

954
QStringList CppModelManager::internalProjectFiles() const
con's avatar
con committed
955 956 957 958 959 960 961 962
{
    QStringList files;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        files += pinfo.sourceFiles;
    }
963
    files.removeDuplicates();
con's avatar
con committed
964 965 966
    return files;
}

967
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
968 969 970 971 972 973 974 975
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
976
    includePaths.removeDuplicates();
con's avatar
con committed
977 978 979
    return includePaths;
}

980
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
981 982 983 984 985 986 987 988
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
989
    frameworkPaths.removeDuplicates();
con's avatar
con committed
990 991 992
    return frameworkPaths;
}

993
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
994 995 996 997 998 999 1000 1001 1002 1003 1004
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

1015
QMap<QString, QString> CppModelManager::buildWorkingCopyList()
con's avatar
con committed
1016
{
1017
    QMap<QString, QString> workingCopy;
con's avatar
con committed
1018 1019 1020 1021 1022 1023
    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();
1024
        workingCopy[fileName] = editorSupport->contents();
con's avatar
con committed
1025 1026
    }

1027 1028 1029 1030 1031 1032
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
        workingCopy[es->fileName()] = es->contents();
    }

con's avatar
con committed
1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
    // 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); }

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
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);
1066
    m_dirty = true;
1067
}
con's avatar
con committed
1068 1069 1070

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

1074 1075 1076 1077 1078 1079 1080 1081
        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
1082

Roberto Raggi's avatar
Roberto Raggi committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
        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
1094 1095
        m_synchronizer.addFuture(result);

con's avatar
con committed
1096 1097 1098
        if (sourceFiles.count() > 1) {
            m_core->progressManager()->addTask(result, tr("Indexing"),
                            CppTools::Constants::TASK_INDEX,
1099
                            Core::ProgressManager::CloseOnSuccess);
con's avatar
con committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117