cppmodelmanager.cpp 45 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"

153
154
    "#define __builtin_va_arg(a,b) ((b)0)\n"

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

167
168
169
namespace CppTools {
namespace Internal {

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

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

182
    void run(const QString &fileName);
con's avatar
con committed
183

184
185
    void resetEnvironment();

186
187
188
    const QSet<QString> &todo() const
    { return m_todo; }

189
190
191
public: // attributes
    Snapshot snapshot;

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

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

198
    void mergeEnvironment(CPlusPlus::Document::Ptr doc);
con's avatar
con committed
199

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

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

226
227
} // namespace Internal
} // namespace CppTools
228

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

CppPreprocessor::~CppPreprocessor()
236
{ }
con's avatar
con committed
237

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

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

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

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

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

253
254
255

namespace {

256
257
class Process;

258
class CheckUndefinedSymbols: protected ASTVisitor
259
{
260
    QSet<QByteArray> _types;
Roberto Raggi's avatar
Roberto Raggi committed
261
    QSet<QByteArray> _namespaceNames;
262

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

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

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

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

protected:
    using ASTVisitor::visit;

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
    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
319
320
321
322
            if (Identifier *id = binding->identifier()) {
                _namespaceNames.insert(QByteArray(id->chars(), id->size()));
            }

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

374
    virtual bool visit(TypenameTypeParameterAST *ast)
375
376
377
378
379
380
381
382
    {
        if (NameAST *nameAst = ast->name)
            addType(nameAst->name);

        return true;
    }

    virtual bool visit(TemplateTypeParameterAST *ast)
383
384
385
386
387
388
389
    {
        if (ast->name)
            addType(ast->name->name);

        return true;
    }

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
    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
405
                    translationUnit()->warning(ast->firstToken(), "`%s' is not a type name",
406
407
408
409
410
411
412
                                               qPrintable(oo(ast->name->name)));
                }
            }
        }
        return true;
    }

413
414
415
416
417
418
419
    virtual bool visit(ClassSpecifierAST *ast)
    {
        if (ast->base_clause) {
            unsigned line, col;
            getTokenStartPosition(ast->firstToken(), &line, &col);
            _context = lookupContext(line, col);
        }
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
471
472
473
474
475
476
477
478
479
480

        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");
                }
            }
        }
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
        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);
            }
        }
499
500
501
502
503
504

        return true;
    }

    virtual bool visit(UsingDirectiveAST *ast)
    {
505
        if (ast->symbol && ast->symbol->name() && _globalNamespaceBinding) {
506
507
508
509
510
511
512
            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
513
            if (! binding || ! binding->resolveNamespace(loc, ast->symbol->name())) {
514
                translationUnit()->warning(ast->name->firstToken(),
Roberto Raggi's avatar
Roberto Raggi committed
515
                                           "expected a namespace");
516
517
518
            }
        }

519
520
521
        return true;
    }

Roberto Raggi's avatar
Roberto Raggi committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
    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;
    }

542
    virtual bool visit(CastExpressionAST *ast)
543
    {
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        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;
558
559
560
561
562
563
564
                }
            }
        }

        return true;
    }

565
566
567
568
569
570
571
572
573
574
575
    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;
576
577
578
579
580
581
582
583
                } else if (type_id->declarator
                           &&   type_id->declarator->postfix_declarators
                           && ! type_id->declarator->postfix_declarators->next
                           &&   type_id->declarator->postfix_declarators->asArrayDeclarator() != 0) {
                    // this sizeof expression is ambiguos, e.g.
                    // sizeof(a[10])
                    //   `a' can be a typeid or an expression.
                    return false;
584
585
586
587
588
589
590
                }
            }
        }

        return true;
    }

591
592
593
594
    LookupContext lookupContext(unsigned line, unsigned column) const;

private:
    Process *_process;
595
    Document::Ptr _doc;
596
    LookupContext _context;
597
    NamespaceBindingPtr _globalNamespaceBinding;
598
    QList<bool> _qobjectStack;
599
600
};

601
class Process: public std::unary_function<Document::Ptr, void>
602
603
{
    QPointer<CppModelManager> _modelManager;
604
    Snapshot _snapshot;
605
    QMap<QString, QString> _workingCopy;
606
    Document::Ptr _doc;
607
608

public:
609
610
    Process(QPointer<CppModelManager> modelManager,
            Snapshot snapshot,
611
            const QMap<QString, QString> &workingCopy)
612
613
614
        : _modelManager(modelManager),
          _snapshot(snapshot),
          _workingCopy(workingCopy)
615
616
    { }

617
618
619
620
    LookupContext lookupContext(unsigned line, unsigned column) const
    { return lookupContext(_doc->findSymbolAt(line, column)); }

    LookupContext lookupContext(Symbol *symbol) const
621
    {
Roberto Raggi's avatar
Roberto Raggi committed
622
        LookupContext context(symbol, Document::create(QLatin1String("<none>")), _doc, _snapshot);
623
624
625
626
627
628
        return context;
    }

    void operator()(Document::Ptr doc)
    {
        _doc = doc;
629
630
631
632
633
634

        Document::CheckMode mode = Document::FastCheck;

        if (_workingCopy.contains(doc->fileName()))
            mode = Document::FullCheck;

635
        doc->parse();
636
        doc->check(mode);
637

638
        if (mode == Document::FullCheck) {
Roberto Raggi's avatar
Roberto Raggi committed
639
640
641
            // run the binding pass
            NamespaceBindingPtr ns = bind(doc, _snapshot);

642
            // check for undefined symbols.
643
644
            CheckUndefinedSymbols checkUndefinedSymbols(doc);
            checkUndefinedSymbols.setGlobalNamespaceBinding(ns);
645

646
            checkUndefinedSymbols(doc->translationUnit()->ast(), this);
647
648
        }

649
650
651
652
653
654
655
        doc->releaseTranslationUnit();

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

656
LookupContext CheckUndefinedSymbols::lookupContext(unsigned line, unsigned column) const
657
658
{ return _process->lookupContext(line, column); }

659
660
661
662
663
664
665
} // end of anonymous namespace

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

667
void CppPreprocessor::resetEnvironment()
668
669
670
671
{
    env.reset();
    m_processed.clear();
}
672

673
bool CppPreprocessor::includeFile(const QString &absoluteFilePath, QString *result)
674
675
676
677
678
679
680
681
682
683
684
685
686
{
    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
687
        return false;
688
689
690
691
692
693
694
695
696

    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
697
698
    }

699
700
701
    return false;
}

702
QString CppPreprocessor::tryIncludeFile(QString &fileName, IncludeType type)
703
704
705
{
    QFileInfo fileInfo(fileName);
    if (fileName == QLatin1String(pp_configuration_file) || fileInfo.isAbsolute()) {
706
        QString contents;
707
708
709
710
711
712
713
714
715
716
        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);
717
        QString contents;
718
719
        if (includeFile(path, &contents)) {
            fileName = path;
con's avatar
con committed
720
721
            return contents;
        }
722
    }
con's avatar
con committed
723

724
725
726
727
728
    foreach (const QString &includePath, m_includePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
729
        QString contents;
730
731
732
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
733
        }
734
    }
con's avatar
con committed
735

736
737
738
739
740
741
    // look in the system include paths
    foreach (const QString &includePath, m_systemIncludePaths) {
        QString path = includePath;
        path += QLatin1Char('/');
        path += fileName;
        path = QDir::cleanPath(path);
742
        QString contents;
743
744
745
        if (includeFile(path, &contents)) {
            fileName = path;
            return contents;
con's avatar
con committed
746
        }
747
748
749
750
751
752
    }

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

754
755
        foreach (const QString &frameworkPath, m_frameworkPaths) {
            QString path = frameworkPath;
con's avatar
con committed
756
            path += QLatin1Char('/');
757
758
759
            path += frameworkName;
            path += QLatin1String(".framework/Headers/");
            path += name;
760
            path = QDir::cleanPath(path);
761
            QString contents;
con's avatar
con committed
762
763
764
765
766
            if (includeFile(path, &contents)) {
                fileName = path;
                return contents;
            }
        }
767
    }
con's avatar
con committed
768

769
770
771
    QString path = fileName;
    if (path.at(0) != QLatin1Char('/'))
        path.prepend(QLatin1Char('/'));
con's avatar
con committed
772

773
774
775
    foreach (const QString &projectFile, m_projectFiles) {
        if (projectFile.endsWith(path)) {
            fileName = projectFile;
776
            QString contents;
777
778
            includeFile(fileName, &contents);
            return contents;
con's avatar
con committed
779
780
781
        }
    }

782
    //qDebug() << "**** file" << fileName << "not found!";
783
    return QString();
784
}
con's avatar
con committed
785

Roberto Raggi's avatar
Roberto Raggi committed
786
void CppPreprocessor::macroAdded(const Macro &macro)
787
788
789
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
790

Roberto Raggi's avatar
Roberto Raggi committed
791
    m_currentDoc->appendMacro(macro);
792
}
793

794
void CppPreprocessor::startExpandingMacro(unsigned offset,
Roberto Raggi's avatar
Roberto Raggi committed
795
                                          const Macro &macro,
796
797
                                          const QByteArray &originalText,
                                          const QVector<MacroArgumentReference> &actuals)
798
799
800
{
    if (! m_currentDoc)
        return;
801

802
    //qDebug() << "start expanding:" << macro.name << "text:" << originalText;
803
    m_currentDoc->addMacroUse(macro, offset, originalText.length(), actuals);
804
}
805

806
void CppPreprocessor::stopExpandingMacro(unsigned, const Macro &)
807
808
809
{
    if (! m_currentDoc)
        return;
con's avatar
con committed
810

811
812
    //qDebug() << "stop expanding:" << macro.name;
}
con's avatar
con committed
813

814
815
816
817
void CppPreprocessor::mergeEnvironment(Document::Ptr doc)
{
    if (! doc)
        return;
con's avatar
con committed
818

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

821
    if (m_processed.contains(fn))
822
        return;
con's avatar
con committed
823

824
    m_processed.insert(fn);
con's avatar
con committed
825

826
    foreach (const Document::Include &incl, doc->includes()) {
827
828
829
        QString includedFile = incl.fileName();

        if (Document::Ptr includedDoc = snapshot.value(includedFile))
830
            mergeEnvironment(includedDoc);
831
832
        else
            run(includedFile);
Roberto Raggi's avatar
Roberto Raggi committed
833
    }
con's avatar
con committed
834

835
    env.addMacros(doc->definedMacros());
836
}
con's avatar
con committed
837

838
839
840
841
842
843
844
845
846
847
848
849
850
851
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);
}

852
853
void CppPreprocessor::sourceNeeded(QString &fileName, IncludeType type,
                                   unsigned line)
854
855
856
857
{
    if (fileName.isEmpty())
        return;

858
    QString contents = tryIncludeFile(fileName, type);
859
860

    if (m_currentDoc) {
861
        m_currentDoc->addIncludeFile(fileName, line);
862

863
        if (contents.isEmpty() && ! QFileInfo(fileName).isAbsolute()) {
864
865
            QString msg = QCoreApplication::translate(
                    "CppPreprocessor", "%1: No such file or directory").arg(fileName);
866

867
868
869
870
            Document::DiagnosticMessage d(Document::DiagnosticMessage::Warning,
                                          m_currentDoc->fileName(),
                                          env.currentLine, /*column = */ 0,
                                          msg);
871

872
            m_currentDoc->addDiagnosticMessage(d);
873

874
            //qWarning() << "file not found:" << fileName << m_currentDoc->fileName() << env.current_line;
con's avatar
con committed
875
        }
876
    }
con's avatar
con committed
877

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

880
881
882
883
884
    Document::Ptr doc = snapshot.value(fileName);
    if (doc) {
        mergeEnvironment(doc);
        return;
    }
con's avatar
con committed
885

886
    doc = Document::create(fileName);
con's avatar
con committed
887

888
    Document::Ptr previousDoc = switchDocument(doc);
con's avatar
con committed
889

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

892
    doc->setSource(preprocessedCode);
893
894
    doc->tokenize();
    doc->releaseSource();
895

896
    snapshot.insert(doc->fileName(), doc);
897
    m_todo.remove(fileName);
con's avatar
con committed
898

899
    Process process(m_modelManager, snapshot, m_workingCopy);
900
901

    process(doc);
902
903

    (void) switchDocument(previousDoc);
904
}
con's avatar
con committed
905

906
907
908
909
910
911
Document::Ptr CppPreprocessor::switchDocument(Document::Ptr doc)
{
    Document::Ptr previousDoc = m_currentDoc;
    m_currentDoc = doc;
    return previousDoc;
}
con's avatar
con committed
912
913
914
915
916
917
918
919
920



/*!
    \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
921
    modified within Qt Creator.
con's avatar
con committed
922
923
*/

924
925
CppModelManager::CppModelManager(QObject *parent)
    : CppModelManagerInterface(parent)
con's avatar
con committed
926
{
Roberto Raggi's avatar
Roberto Raggi committed
927
928
    m_synchronizer.setCancelOnWait(true);

929
    m_core = Core::ICore::instance(); // FIXME
930
931
    m_dirty = true;

932
    ProjectExplorer::ProjectExplorerPlugin *pe =
933
       ProjectExplorer::ProjectExplorerPlugin::instance();
con's avatar
con committed
934

935
    QTC_ASSERT(pe, return);
con's avatar
con committed
936

937
    ProjectExplorer::SessionManager *session = pe->session();
hjk's avatar
hjk committed
938
    QTC_ASSERT(session, return);
con's avatar
con committed
939

Roberto Raggi's avatar
Roberto Raggi committed
940
941
942
943
944
945
    m_updateEditorSelectionsTimer = new QTimer(this);
    m_updateEditorSelectionsTimer->setInterval(500);
    m_updateEditorSelectionsTimer->setSingleShot(true);
    connect(m_updateEditorSelectionsTimer, SIGNAL(timeout()),
            this, SLOT(updateEditorSelections()));

946
947
948
    connect(session, SIGNAL(projectAdded(ProjectExplorer::Project*)),
            this, SLOT(onProjectAdded(ProjectExplorer::Project*)));

con's avatar
con committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
    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()
{ }

972
Snapshot CppModelManager::snapshot() const
973
{
974
    QMutexLocker locker(&protectSnapshot);
975
976
    return m_snapshot;
}
con's avatar
con committed
977

978
979
980
981
982
983
void CppModelManager::ensureUpdated()
{
    QMutexLocker locker(&mutex);
    if (! m_dirty)
        return;

984
985
986
987
    m_projectFiles = internalProjectFiles();
    m_includePaths = internalIncludePaths();
    m_frameworkPaths = internalFrameworkPaths();
    m_definedMacros = internalDefinedMacros();
988
989
990
    m_dirty = false;
}

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

1004
QStringList CppModelManager::internalIncludePaths() const
con's avatar
con committed
1005
1006
1007
1008
1009
1010
1011
1012
{
    QStringList includePaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        includePaths += pinfo.includePaths;
    }
1013
    includePaths.removeDuplicates();
con's avatar
con committed
1014
1015
1016
    return includePaths;
}

1017
QStringList CppModelManager::internalFrameworkPaths() const
con's avatar
con committed
1018
1019
1020
1021
1022
1023
1024
1025
{
    QStringList frameworkPaths;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        frameworkPaths += pinfo.frameworkPaths;
    }
1026
    frameworkPaths.removeDuplicates();
con's avatar
con committed
1027
1028
1029
    return frameworkPaths;
}

1030
QByteArray CppModelManager::internalDefinedMacros() const
con's avatar
con committed
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
{
    QByteArray macros;
    QMapIterator<ProjectExplorer::Project *, ProjectInfo> it(m_projects);
    while (it.hasNext()) {
        it.next();
        ProjectInfo pinfo = it.value();
        macros += pinfo.defines;
    }
    return macros;
}

1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
void CppModelManager::addEditorSupport(AbstractEditorSupport *editorSupport)
{
    m_addtionalEditorSupport.insert(editorSupport);
}

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

1052
QMap<QString, QString> CppModelManager::buildWorkingCopyList()
con's avatar
con committed
1053
{
1054
    QMap<QString, QString> workingCopy;
con's avatar
con committed
1055
1056
1057
1058
1059
1060
    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();
1061
        workingCopy[fileName] = editorSupport->contents();
con's avatar
con committed
1062
1063
    }

1064
1065
1066
1067
1068
1069
    QSetIterator<AbstractEditorSupport *> jt(m_addtionalEditorSupport);
    while (jt.hasNext()) {
        AbstractEditorSupport *es =  jt.next();
        workingCopy[es->fileName()] = es->contents();
    }

con's avatar
con committed
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
    // 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); }

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
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);
1103
    m_dirty = true;
1104
}
con's avatar
con committed
1105
1106
1107

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

1111
1112
1113
1114
1115
1116
1117
1118
        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
1119

Roberto Raggi's avatar
Roberto Raggi committed
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
        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
1131
1132
        m_synchronizer.addFuture(result);

con's avatar
con committed
1133
1134
1135
        if (sourceFiles.count() > 1) {
            m_core->progressManager()->addTask(result, tr("Indexing"),
                            CppTools::Constants::TASK_INDEX,
1136
                            Core::ProgressManager::CloseOnSuccess);
con's avatar
con committed
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
        }
        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
1155
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166

        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
1167
        QTC_ASSERT(textEditor, return);
con's avatar
con committed
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187

        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();
1188
1189
1190
1191
1192

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

con's avatar
con committed
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
    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;

1206
            foreach (const Document::Block &block, doc->skippedBlocks()) {
con's avatar
con committed
1207
1208
1209
1210
1211
                blockRanges.append(TextEditor::BaseTextEditor::BlockRange(block.begin(), block.end()));
            }

            QList<QTextEdit::ExtraSelection> selections;

1212
1213
1214
1215
1216
1217
#ifdef QTCREATOR_WITH_MACRO_HIGHLIGHTING
            // set up the format for the macros
            QTextCharFormat macroFormat;
            macroFormat.setUnderlineStyle(QTextCharFormat::SingleUnderline);

            QTextCursor c = ed->textCursor();
1218
            foreach (const Document::MacroUse &block, doc->macroUses()) {
1219
1220
1221
1222
1223
1224
1225
1226
1227
                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