cppmodelmanager.cpp 43.9 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
    virtual bool visit(CastExpressionAST *ast)
533
    {
534 535 536 537 538 539 540 541 542 543 544 545 546 547
        if (ast->lparen_token && ast->type_id && ast->rparen_token && ast->expression) {
            if (TypeIdAST *cast_type_id = ast->type_id->asTypeId()) {
                SpecifierAST *type_specifier = cast_type_id->type_specifier;
                if (! cast_type_id->declarator && type_specifier && ! type_specifier->next &&
                    type_specifier->asNamedTypeSpecifier() && ast->expression &&
                    ast->expression->asUnaryExpression()) {
                    // this ast node is ambigious, e.g.
                    //   (a) + b
                    // it can be parsed as
                    //   ((a) + b)
                    // or
                    //   (a) (+b)
                    accept(ast->expression);
                    return false;
548 549 550 551 552 553 554
                }
            }
        }

        return true;
    }

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    virtual bool visit(SizeofExpressionAST *ast)
    {
        if (ast->lparen_token && ast->expression && ast->rparen_token) {
            if (TypeIdAST *type_id = ast->expression->asTypeId()) {
                SpecifierAST *type_specifier = type_id->type_specifier;
                if (! type_id->declarator && type_specifier && ! type_specifier->next &&
                    type_specifier->asNamedTypeSpecifier()) {
                    // this sizeof expression is ambiguos, e.g.
                    // sizeof (a)
                    //   `a' can be a typeid or a nested-expression.
                    return false;
                }
            }
        }

        return true;
    }

573 574 575 576
    LookupContext lookupContext(unsigned line, unsigned column) const;

private:
    Process *_process;
577
    Document::Ptr _doc;
578
    LookupContext _context;
579
    NamespaceBindingPtr _globalNamespaceBinding;
580
    QList<bool> _qobjectStack;
581 582
};

583
class Process: public std::unary_function<Document::Ptr, void>
584 585
{
    QPointer<CppModelManager> _modelManager;
586
    Snapshot _snapshot;
587
    QMap<QString, QString> _workingCopy;
588
    Document::Ptr _doc;
589 590

public:
591 592
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
593
            const QMap<QString, QString> &workingCopy)
594 595 596
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
597 598
    { }

599 600 601 602
    LookupContext lookupContext(unsigned line, unsigned column) const
    { return lookupContext(_doc->findSymbolAt(line, column)); }

    LookupContext lookupContext(Symbol *symbol) const
603
    {
Roberto Raggi's avatar
Roberto Raggi committed
604
        LookupContext context(symbol, Document::create(QLatin1String("<none>")), _doc, _snapshot);
605 606 607 608 609 610
        return context;
    }

    void operator()(Document::Ptr doc)
    {
        _doc = doc;
611 612
        doc->parse();
        doc->check();
613 614

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

618
            // check for undefined symbols.
619 620
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
621

622
            checkUndefinedSymbols(doc->translationUnit()->ast(), this);
623 624
        }

625 626 627 628 629 630 631
        doc->releaseTranslationUnit();

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

632
LookupContext CheckUndefinedSymbols::lookupContext(unsigned line, unsigned column) const
633 634
{ return _process->lookupContext(line, column); }

635 636 637 638 639 640 641
} // end of anonymous namespace

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

643
void CppPreprocessor::resetEnvironment()
644 645 646 647
{
    env.reset();
    m_processed.clear();
}
648

649
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result)
650 651 652 653 654 655 656 657 658 659 660 661 662
{
    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
663
        return false;
664 665 666 667 668 669 670 671 672

    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
673 674
    }

675 676 677
    return false;
}

678
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type)
679 680 681
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
682
        QString contents;
683 684 685 686 687 688 689 690 691 692
        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);
693
        QString contents;
694 695
        if (includeFile(path, &contents)) {
            fileName = path;
con's avatar
con committed
696 697
            return contents;
        }
698
    }
con's avatar
con committed
699

700 701 702 703 704
    foreach (const QString &includePath, m_includePaths) {
        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
    }
con's avatar
con committed
711

712 713 714 715 716 717
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
718
        QString contents;
719 720 721
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
722
        }
723 724 725 726 727 728
    }

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

730 731
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
732
            path += QLatin1Char('/');
733 734 735
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
736
            path = QDir::cleanPath(path);
737
            QString contents;
con's avatar
con committed
738 739 740 741 742
            if (includeFile(path, &contents)) {
                fileName = path;
                return contents;
            }
        }
743
    }
con's avatar
con committed
744

745 746 747
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
748

749 750 751
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
752
            QString contents;
753 754
            includeFile(fileName, &contents);
            return contents;
con's avatar
con committed
755 756 757
        }
    }

758
    //qDebug() << "**** file" << fileName << "not found!";
759
    return QString();
760
}
con's avatar
con committed
761

Roberto Raggi's avatar
Roberto Raggi committed
762
void CppPreprocessor::macroAdded(const Macro &macro)
763 764 765
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
766

Roberto Raggi's avatar
Roberto Raggi committed
767
    m_currentDoc->appendMacro(macro);
768
}
769

770
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
771
                                          const Macro &macro,
772 773
                                          const QByteArray &originalText,
                                          const QVector<MacroArgumentReference> &actuals)
774 775 776
{
    if (! m_currentDoc)
        return;
777

778
    //qDebug() << "start expanding:" << macro.name << "text:" << originalText;
779
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), actuals);
780
}
781

782
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
783 784 785
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
786

787 788
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
789

790 791 792 793
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
794

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

797
    if (m_processed.contains(fn))
798
        return;
con's avatar
con committed
799

800
    m_processed.insert(fn);
con's avatar
con committed
801

802
    foreach (const Document::Include &incl, doc->includes()) {
803 804 805
        QString includedFile = incl.fileName();

        if (Document::Ptr includedDoc = snapshot.value(includedFile))
806
            mergeEnvironment(includedDoc);
807 808
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
809
    }
con's avatar
con committed
810

811
    env.addMacros(doc->definedMacros());
812
}
con's avatar
con committed
813

814 815 816 817 818 819 820 821 822 823 824 825 826 827
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);
}

828 829
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type,
                                   unsigned line)
830 831 832 833
{
    if (fileName.isEmpty())
        return;

834
    QString contents = tryIncludeFile(fileName, type);
835 836

    if (m_currentDoc) {
837
        m_currentDoc->addIncludeFile(fileName, line);
838

839
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
840 841
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
842

843 844 845 846
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
847

848
            m_currentDoc->addDiagnosticMessage(d);
849

850
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
851
        }
852
    }
con's avatar
con committed
853

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

856 857 858 859 860
    Document::Ptr doc = snapshot.value(fileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
861

862
    doc = Document::create(fileName);
con's avatar
con committed
863

864
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
865

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

868
    doc->setSource(preprocessedCode);
869 870
    doc->tokenize();
    doc->releaseSource();
871

872
    snapshot.insert(doc->fileName(), doc);
873
    m_todo.remove(fileName);
con's avatar
con committed
874

875
    Process process(m_modelManager, snapshot, m_workingCopy);
876 877

    process(doc);
878 879

    (void) switchDocument(previousDoc);
880
}
con's avatar
con committed
881

882 883 884 885 886 887
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
888 889 890 891 892 893 894 895 896



/*!
    \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
897
    modified within Qt Creator.
con's avatar
con committed
898 899
*/

900 901
CppModelManager::CppModelManager(QObject *parent)
    : CppModelManagerInterface(parent)
con's avatar
con committed
902
{
Roberto Raggi's avatar
Roberto Raggi committed
903 904
    m_synchronizer.setCancelOnWait(true);

905
    m_core = Core::ICore::instance(); // FIXME
906 907
    m_dirty = true;

908
    ProjectExplorer::ProjectExplorerPlugin *pe =
909
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
910

911
    QTC_ASSERT(pe, return);
con's avatar
con committed
912

913
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
914
    QTC_ASSERT(session, return);
con's avatar
con committed
915

Roberto Raggi's avatar
Roberto Raggi committed
916 917 918 919 920 921
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

922 923 924
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
    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()
{ }

948
Snapshot CppModelManager::snapshot() const
949
{
950
    QMutexLocker locker(&protectSnapshot);
951 952
    return m_snapshot;
}
con's avatar
con committed
953

954 955 956 957 958 959
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

960 961 962 963
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
964 965 966
    m_dirty = false;
}

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

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

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

1006
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

1028
QMap<QString, QString> CppModelManager::buildWorkingCopyList()
con's avatar
con committed
1029
{
1030
    QMap<QString, QString> workingCopy;
con's avatar
con committed
1031 1032 1033 1034 1035 1036
    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();
1037
        workingCopy[fileName] = editorSupport->contents();
con's avatar
con committed
1038 1039
    }

1040 1041 1042 1043