cppfindreferences.cpp 16.7 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** 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.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://www.qtsoftware.com/contact.
**
**************************************************************************/

#include "cppfindreferences.h"
#include "cppmodelmanager.h"
#include "cpptoolsconstants.h"

#include <texteditor/basetexteditor.h>
#include <find/searchresultwindow.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/icore.h>

#include <ASTVisitor.h>
#include <AST.h>
#include <Control.h>
#include <Literals.h>
#include <TranslationUnit.h>
#include <Symbols.h>
47
48
#include <Names.h>
#include <Scope.h>
Roberto Raggi's avatar
Roberto Raggi committed
49
50
51
52

#include <cplusplus/CppDocument.h>
#include <cplusplus/ExpressionUnderCursor.h>
#include <cplusplus/ResolveExpression.h>
53
#include <cplusplus/Overview.h>
Roberto Raggi's avatar
Roberto Raggi committed
54
#include <cplusplus/TypeOfExpression.h>
55
#include <cplusplus/FastPreprocessor.h>
Roberto Raggi's avatar
Roberto Raggi committed
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

#include <QtCore/QTime>
#include <QtCore/QtConcurrentRun>
#include <QtCore/QDir>

#include <qtconcurrent/runextensions.h>

using namespace CppTools::Internal;
using namespace CPlusPlus;

namespace {

struct Process: protected ASTVisitor
{
public:
71
72
    Process(Document::Ptr doc, const Snapshot &snapshot,
            QFutureInterface<Core::Utils::FileSearchResult> *future)
Roberto Raggi's avatar
Roberto Raggi committed
73
74
75
76
            : ASTVisitor(doc->control()),
              _future(future),
              _doc(doc),
              _snapshot(snapshot),
77
78
79
80
81
              _source(_doc->source()),
              _sem(doc->control())
    {
        _snapshot.insert(_doc);
    }
Roberto Raggi's avatar
Roberto Raggi committed
82

83
    QList<int> operator()(Symbol *symbol, Identifier *id, AST *ast)
Roberto Raggi's avatar
Roberto Raggi committed
84
    {
85
        _references.clear();
86
        _declSymbol = symbol;
Roberto Raggi's avatar
Roberto Raggi committed
87
88
89
        _id = id;
        _exprDoc = Document::create("<references>");
        accept(ast);
90
        return _references;
Roberto Raggi's avatar
Roberto Raggi committed
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
128
    }

protected:
    using ASTVisitor::visit;

    QString matchingLine(const Token &tk) const
    {
        const char *beg = _source.constData();
        const char *cp = beg + tk.offset;
        for (; cp != beg - 1; --cp) {
            if (*cp == '\n')
                break;
        }

        ++cp;

        const char *lineEnd = cp + 1;
        for (; *lineEnd; ++lineEnd) {
            if (*lineEnd == '\n')
                break;
        }

        const QString matchingLine = QString::fromUtf8(cp, lineEnd - cp);
        return matchingLine;

    }

    void reportResult(unsigned tokenIndex)
    {
        const Token &tk = tokenAt(tokenIndex);
        const QString lineText = matchingLine(tk);

        unsigned line, col;
        getTokenStartPosition(tokenIndex, &line, &col);

        if (col)
            --col;  // adjust the column position.

129
        const int len = tk.f.length;
Roberto Raggi's avatar
Roberto Raggi committed
130

131
132
133
134
135
        if (_future)
            _future->reportResult(Core::Utils::FileSearchResult(QDir::toNativeSeparators(_doc->fileName()),
                                                                line, lineText, col, len));

        _references.append(tokenIndex);
Roberto Raggi's avatar
Roberto Raggi committed
136
137
    }

138
    bool checkCandidates(const QList<Symbol *> &candidates) const
Roberto Raggi's avatar
Roberto Raggi committed
139
    {
Roberto Raggi's avatar
Roberto Raggi committed
140
141
142
143
144
145
146
147
148
149
150
        if (Symbol *canonicalSymbol = LookupContext::canonicalSymbol(candidates)) {
#if 0
            qDebug() << "*** canonical symbol:" << canonicalSymbol->fileName()
                    << canonicalSymbol->line() << canonicalSymbol->column()
                    << "candidates:" << candidates.size();
#endif

            return isDeclSymbol(canonicalSymbol);
        }

        return false;
Roberto Raggi's avatar
Roberto Raggi committed
151
152
    }

153
    bool isDeclSymbol(Symbol *symbol) const
Roberto Raggi's avatar
Roberto Raggi committed
154
    {
155
156
        if (! symbol)
            return false;
Roberto Raggi's avatar
Roberto Raggi committed
157

158
159
160
161
162
163
164
165
166
        else if (symbol == _declSymbol)
            return true;

        else if (symbol->line() == _declSymbol->line() && symbol->column() == _declSymbol->column()) {
            if (! qstrcmp(symbol->fileName(), _declSymbol->fileName()))
                return true;
        }

        return false;
Roberto Raggi's avatar
Roberto Raggi committed
167
168
    }

169
    LookupContext currentContext(AST *ast) const
Roberto Raggi's avatar
Roberto Raggi committed
170
    {
171
172
173
        unsigned line, column;
        getTokenStartPosition(ast->firstToken(), &line, &column);
        Symbol *lastVisibleSymbol = _doc->findSymbolAt(line, column);
Roberto Raggi's avatar
Roberto Raggi committed
174
175
        LookupContext ctx(lastVisibleSymbol, _exprDoc, _doc, _snapshot);
        return ctx;
Roberto Raggi's avatar
Roberto Raggi committed
176
177
    }

Roberto Raggi's avatar
Roberto Raggi committed
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
    void ensureNameIsValid(NameAST *ast)
    {
        if (ast && ! ast->name)
            ast->name = _sem.check(ast, /*scope = */ 0);
    }

    virtual bool visit(MemInitializerAST *ast)
    {
        if (ast->name && ast->name->asSimpleName() != 0) {
            ensureNameIsValid(ast->name);

            SimpleNameAST *simple = ast->name->asSimpleName();
            if (identifier(simple->identifier_token) == _id) {
                LookupContext context = currentContext(ast);
                const QList<Symbol *> candidates = context.resolve(simple->name);
                if (checkCandidates(candidates))
                    reportResult(simple->identifier_token);
            }
        }
        accept(ast->expression);
        return false;
    }

Roberto Raggi's avatar
Roberto Raggi committed
201
202
203
204
205
206
    virtual bool visit(PostfixExpressionAST *ast)
    {
        _postfixExpressionStack.append(ast);
        return true;
    }

Roberto Raggi's avatar
Roberto Raggi committed
207
    virtual void endVisit(PostfixExpressionAST *)
Roberto Raggi's avatar
Roberto Raggi committed
208
209
210
211
212
213
    {
        _postfixExpressionStack.removeLast();
    }

    virtual bool visit(MemberAccessAST *ast)
    {
Roberto Raggi's avatar
Roberto Raggi committed
214
215
216
217
        if (ast->member_name) {
            if (SimpleNameAST *simple = ast->member_name->asSimpleName()) {
                if (identifier(simple->identifier_token) == _id) {
                    Q_ASSERT(! _postfixExpressionStack.isEmpty());
Roberto Raggi's avatar
Roberto Raggi committed
218

Roberto Raggi's avatar
Roberto Raggi committed
219
220
                    checkExpression(_postfixExpressionStack.last()->firstToken(),
                                    simple->identifier_token);
Roberto Raggi's avatar
Roberto Raggi committed
221

Roberto Raggi's avatar
Roberto Raggi committed
222
223
224
225
                    return false;
                }
            }
        }
Roberto Raggi's avatar
Roberto Raggi committed
226

Roberto Raggi's avatar
Roberto Raggi committed
227
228
        return true;
    }
Roberto Raggi's avatar
Roberto Raggi committed
229

Roberto Raggi's avatar
Roberto Raggi committed
230
231
232
233
    void checkExpression(unsigned startToken, unsigned endToken)
    {
        const unsigned begin = tokenAt(startToken).begin();
        const unsigned end = tokenAt(endToken).end();
Roberto Raggi's avatar
Roberto Raggi committed
234

Roberto Raggi's avatar
Roberto Raggi committed
235
        const QString expression = _source.mid(begin, end - begin);
Roberto Raggi's avatar
Roberto Raggi committed
236
        // qDebug() << "*** check expression:" << expression;
Roberto Raggi's avatar
Roberto Raggi committed
237

Roberto Raggi's avatar
Roberto Raggi committed
238
239
        TypeOfExpression typeofExpression;
        typeofExpression.setSnapshot(_snapshot);
Roberto Raggi's avatar
Roberto Raggi committed
240

Roberto Raggi's avatar
Roberto Raggi committed
241
242
243
        unsigned line, column;
        getTokenStartPosition(startToken, &line, &column);
        Symbol *lastVisibleSymbol = _doc->findSymbolAt(line, column);
Roberto Raggi's avatar
Roberto Raggi committed
244

Roberto Raggi's avatar
Roberto Raggi committed
245
246
        const QList<TypeOfExpression::Result> results =
                typeofExpression(expression, _doc, lastVisibleSymbol,
247
                                 TypeOfExpression::Preprocess);
Roberto Raggi's avatar
Roberto Raggi committed
248

Roberto Raggi's avatar
Roberto Raggi committed
249
        QList<Symbol *> candidates;
Roberto Raggi's avatar
Roberto Raggi committed
250

Roberto Raggi's avatar
Roberto Raggi committed
251
252
253
        foreach (TypeOfExpression::Result r, results) {
            FullySpecifiedType ty = r.first;
            Symbol *lastVisibleSymbol = r.second;
Roberto Raggi's avatar
Roberto Raggi committed
254

Roberto Raggi's avatar
Roberto Raggi committed
255
            candidates.append(lastVisibleSymbol);
Roberto Raggi's avatar
Roberto Raggi committed
256
257
        }

Roberto Raggi's avatar
Roberto Raggi committed
258
259
        if (checkCandidates(candidates))
            reportResult(endToken);
Roberto Raggi's avatar
Roberto Raggi committed
260
261
    }

Roberto Raggi's avatar
Roberto Raggi committed
262
263
    virtual bool visit(QualifiedNameAST *ast)
    {
Roberto Raggi's avatar
Roberto Raggi committed
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
        for (NestedNameSpecifierAST *nested_name_specifier = ast->nested_name_specifier;
             nested_name_specifier; nested_name_specifier = nested_name_specifier->next) {

            if (NameAST *class_or_namespace_name = nested_name_specifier->class_or_namespace_name) {
                SimpleNameAST *simple_name = class_or_namespace_name->asSimpleName();

                TemplateIdAST *template_id = 0;
                if (! simple_name) {
                    template_id = class_or_namespace_name->asTemplateId();

                    if (template_id) {
                        for (TemplateArgumentListAST *template_arguments = template_id->template_arguments;
                             template_arguments; template_arguments = template_arguments->next) {
                            accept(template_arguments->template_argument);
                        }
                    }
                }

                if (simple_name || template_id) {
                    const unsigned identifier_token = simple_name
                               ? simple_name->identifier_token
                               : template_id->identifier_token;

                    if (identifier(identifier_token) == _id)
                        checkExpression(ast->firstToken(), identifier_token);
                }
            }
        }

        if (ast->unqualified_name) {
            SimpleNameAST *simple_name = ast->unqualified_name->asSimpleName();

            TemplateIdAST *template_id = 0;
            if (! simple_name) {
                template_id = ast->unqualified_name->asTemplateId();

                if (template_id) {
                    for (TemplateArgumentListAST *template_arguments = template_id->template_arguments;
                         template_arguments; template_arguments = template_arguments->next) {
                        accept(template_arguments->template_argument);
                    }
                }
            }

            if (simple_name || template_id) {
                const unsigned identifier_token = simple_name
                        ? simple_name->identifier_token
                        : template_id->identifier_token;

                if (identifier(identifier_token) == _id)
                    checkExpression(ast->firstToken(), identifier_token);
            }
316
317
        }

Roberto Raggi's avatar
Roberto Raggi committed
318
319
320
321
322
323
324
        return false;
    }

    virtual bool visit(SimpleNameAST *ast)
    {
        Identifier *id = identifier(ast->identifier_token);
        if (id == _id) {
325
326
327
            LookupContext context = currentContext(ast);
            const QList<Symbol *> candidates = context.resolve(ast->name);
            if (checkCandidates(candidates))
Roberto Raggi's avatar
Roberto Raggi committed
328
                reportResult(ast->identifier_token);
329
330
331
        }

        return false;
Roberto Raggi's avatar
Roberto Raggi committed
332
333
    }

Roberto Raggi's avatar
Roberto Raggi committed
334
    virtual bool visit(DestructorNameAST *ast)
Roberto Raggi's avatar
Roberto Raggi committed
335
336
337
    {
        Identifier *id = identifier(ast->identifier_token);
        if (id == _id) {
338
339
340
341
            LookupContext context = currentContext(ast);
            const QList<Symbol *> candidates = context.resolve(ast->name);
            if (checkCandidates(candidates))
                reportResult(ast->identifier_token);
Roberto Raggi's avatar
Roberto Raggi committed
342
343
344
345
346
347
348
349
        }

        return false;
    }

    virtual bool visit(TemplateIdAST *ast)
    {
        Identifier *id = identifier(ast->identifier_token);
350
351
352
353
354
355
        if (id == _id) {
            LookupContext context = currentContext(ast);
            const QList<Symbol *> candidates = context.resolve(ast->name);
            if (checkCandidates(candidates))
                reportResult(ast->identifier_token);
        }
Roberto Raggi's avatar
Roberto Raggi committed
356

357
        return false;
Roberto Raggi's avatar
Roberto Raggi committed
358
359
360
    }

private:
361
    QFutureInterface<Core::Utils::FileSearchResult> *_future;
362
363
    Identifier *_id; // ### remove me
    Symbol *_declSymbol;
Roberto Raggi's avatar
Roberto Raggi committed
364
365
366
367
    Document::Ptr _doc;
    Snapshot _snapshot;
    QByteArray _source;
    Document::Ptr _exprDoc;
368
    Semantic _sem;
Roberto Raggi's avatar
Roberto Raggi committed
369
    QList<PostfixExpressionAST *> _postfixExpressionStack;
Roberto Raggi's avatar
Roberto Raggi committed
370
    QList<QualifiedNameAST *> _qualifiedNameStack;
371
    QList<int> _references;
Roberto Raggi's avatar
Roberto Raggi committed
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
};

} // end of anonymous namespace

CppFindReferences::CppFindReferences(CppModelManager *modelManager)
    : _modelManager(modelManager),
      _resultWindow(ExtensionSystem::PluginManager::instance()->getObject<Find::SearchResultWindow>())
{
    m_watcher.setPendingResultsLimit(1);
    connect(&m_watcher, SIGNAL(resultReadyAt(int)), this, SLOT(displayResult(int)));
    connect(&m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
}

CppFindReferences::~CppFindReferences()
{
}

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
QList<int> CppFindReferences::references(Symbol *symbol,
                                         Document::Ptr doc,
                                         const Snapshot& snapshot) const
{
    Identifier *id = 0;
    if (Identifier *symbolId = symbol->identifier())
        id = doc->control()->findIdentifier(symbolId->chars(), symbolId->size());

    QList<int> references;

    if (! id)
        return references;

    TranslationUnit *translationUnit = doc->translationUnit();
    Q_ASSERT(translationUnit != 0);

    Process process(doc, snapshot, /*future = */ 0);
    references = process(symbol, id, translationUnit->ast());

    return references;
}

Roberto Raggi's avatar
Roberto Raggi committed
411
static void find_helper(QFutureInterface<Core::Utils::FileSearchResult> &future,
412
                        const QMap<QString, QString> wl,
413
414
                        Snapshot snapshot,
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
415
416
417
{
    QTime tm;
    tm.start();
418

419
420
421
    Identifier *symbolId = symbol->identifier();
    Q_ASSERT(symbolId != 0);

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
422
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
423

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
424
425
    QStringList files(sourceFile);
    files += snapshot.dependsOn(sourceFile);
Roberto Raggi's avatar
Roberto Raggi committed
426
427
428
429
430
    qDebug() << "done in:" << tm.elapsed() << "number of files to parse:" << files.size();

    future.setProgressRange(0, files.size());

    for (int i = 0; i < files.size(); ++i) {
Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
431
432
        const QString &fileName = files.at(i);
        future.setProgressValueAndText(i, QFileInfo(fileName).fileName());
433

Roberto Raggi's avatar
Roberto Raggi committed
434
        if (Document::Ptr previousDoc = snapshot.value(fileName)) {
435
436
437
438
439
440
            Control *control = previousDoc->control();
            Identifier *id = control->findIdentifier(symbolId->chars(), symbolId->size());
            if (! id)
                continue; // skip this document, it's not using symbolId.
        }

441
442
443
444
445
446
447
448
449
450
451
452
453
454
        QByteArray source;

        if (wl.contains(fileName))
            source = snapshot.preprocessedCode(wl.value(fileName), fileName);
        else {
            QFile file(fileName);
            if (! file.open(QFile::ReadOnly))
                continue;

            const QString contents = QTextStream(&file).readAll(); // ### FIXME
            source = snapshot.preprocessedCode(contents, fileName);
        }

        Document::Ptr doc = snapshot.documentFromSource(source, fileName);
455
        doc->tokenize();
Roberto Raggi's avatar
Roberto Raggi committed
456
457

        Control *control = doc->control();
458
        if (Identifier *id = control->findIdentifier(symbolId->chars(), symbolId->size())) {
459
            TranslationUnit *unit = doc->translationUnit();
460
461
            Control *control = doc->control();

Roberto Raggi's avatar
Roberto Raggi committed
462
            FastMacroResolver fastMacroResolver(unit, snapshot);
463
464
465
466
467
468
            control->setMacroResolver(&fastMacroResolver);
            doc->parse();
            control->setMacroResolver(0);

            doc->check();

469
            Process process(doc, snapshot, &future);
470
            process(symbol, id, unit->ast());
471
        }
Roberto Raggi's avatar
Roberto Raggi committed
472
    }
473

Roberto Raggi's avatar
Roberto Raggi committed
474
475
476
    future.setProgressValue(files.size());
}

477
void CppFindReferences::findAll(Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
478
479
{
    _resultWindow->clearContents();
Roberto Raggi's avatar
Roberto Raggi committed
480
    _resultWindow->setShowReplaceUI(true);
Roberto Raggi's avatar
Roberto Raggi committed
481
482
    _resultWindow->popup(true);

483
484
485
    const Snapshot snapshot = _modelManager->snapshot();
    const QMap<QString, QString> wl = _modelManager->buildWorkingCopyList();

Roberto Raggi's avatar
Roberto Raggi committed
486
487
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();

488
    QFuture<Core::Utils::FileSearchResult> result = QtConcurrent::run(&find_helper, wl, snapshot, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
489
490
491
    m_watcher.setFuture(result);

    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching..."),
492
                                                              CppTools::Constants::TASK_SEARCH,
Roberto Raggi's avatar
Roberto Raggi committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
                                                              Core::ProgressManager::CloseOnSuccess);

    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}

void CppFindReferences::displayResult(int index)
{
    Core::Utils::FileSearchResult result = m_watcher.future().resultAt(index);
    Find::ResultWindowItem *item = _resultWindow->addResult(result.fileName,
                                                            result.lineNumber,
                                                            result.matchingLine,
                                                            result.matchStart,
                                                            result.matchLength);
    if (item)
        connect(item, SIGNAL(activated(const QString&,int,int)),
                this, SLOT(openEditor(const QString&,int,int)));
}

void CppFindReferences::searchFinished()
{
    emit changed();
}

void CppFindReferences::openEditor(const QString &fileName, int line, int column)
{
    TextEditor::BaseTextEditor::openEditorAt(fileName, line, column);
}