cppfindreferences.cpp 15.5 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1
2
3
4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Roberto Raggi's avatar
Roberto Raggi committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
Roberto Raggi's avatar
Roberto Raggi committed
8
9
10
11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
Roberto Raggi's avatar
Roberto Raggi committed
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
Roberto Raggi's avatar
Roberto Raggi committed
30
31
32
33
34
35
36
**
**************************************************************************/

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

#include <texteditor/basetexteditor.h>
37
#include <texteditor/basefilefind.h>
Roberto Raggi's avatar
Roberto Raggi committed
38
39
40
#include <find/searchresultwindow.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
41
#include <utils/fileutils.h>
Roberto Raggi's avatar
Roberto Raggi committed
42
#include <coreplugin/progressmanager/progressmanager.h>
43
#include <coreplugin/progressmanager/futureprogress.h>
44
#include <coreplugin/editormanager/editormanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
45
#include <coreplugin/icore.h>
46
#include <coreplugin/infobar.h>
Roberto Raggi's avatar
Roberto Raggi committed
47
48
49
50
51
52
53

#include <ASTVisitor.h>
#include <AST.h>
#include <Control.h>
#include <Literals.h>
#include <TranslationUnit.h>
#include <Symbols.h>
54
55
#include <Names.h>
#include <Scope.h>
Roberto Raggi's avatar
Roberto Raggi committed
56

57
#include <cplusplus/ModelManagerInterface.h>
Roberto Raggi's avatar
Roberto Raggi committed
58
#include <cplusplus/CppDocument.h>
59
#include <cplusplus/Overview.h>
60
#include <cplusplus/FindUsages.h>
Roberto Raggi's avatar
Roberto Raggi committed
61
62

#include <QtCore/QTime>
63
#include <QtCore/QTimer>
Roberto Raggi's avatar
Roberto Raggi committed
64
#include <QtCore/QtConcurrentRun>
65
#include <QtCore/QtConcurrentMap>
Roberto Raggi's avatar
Roberto Raggi committed
66
#include <QtCore/QDir>
67
#include <QtGui/QApplication>
Roberto Raggi's avatar
Roberto Raggi committed
68
69
#include <qtconcurrent/runextensions.h>

70
71
#include <functional>

Roberto Raggi's avatar
Roberto Raggi committed
72
73
74
using namespace CppTools::Internal;
using namespace CPlusPlus;

Christian Kamm's avatar
Christian Kamm committed
75
static QString getSource(const QString &fileName,
76
                         const CppModelManagerInterface::WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
77
78
79
80
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
81
82
        Utils::FileReader reader;
        if (!reader.fetch(fileName)) // ### FIXME error reporting
Christian Kamm's avatar
Christian Kamm committed
83
84
            return QString();

85
        return QString::fromLocal8Bit(reader.data()); // ### FIXME encoding
Christian Kamm's avatar
Christian Kamm committed
86
87
88
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
89
namespace {
90

Roberto Raggi's avatar
Roberto Raggi committed
91
class ProcessFile: public std::unary_function<QString, QList<Usage> >
92
{
93
    const CppModelManagerInterface::WorkingCopy workingCopy;
94
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
95
    Document::Ptr symbolDocument;
96
97
98
    Symbol *symbol;

public:
99
    ProcessFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
100
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
101
                Document::Ptr symbolDocument,
102
                Symbol *symbol)
Erik Verbruggen's avatar
Erik Verbruggen committed
103
        : workingCopy(workingCopy), snapshot(snapshot), symbolDocument(symbolDocument), symbol(symbol)
104
105
106
107
108
109
110
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
        const Identifier *symbolId = symbol->identifier();

111
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
112
113
114
115
116
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }

117
118
        Document::Ptr doc;
        QByteArray source;
119
        const QString unpreprocessedSource = getSource(fileName, workingCopy);
120

121
122
123
        if (symbolDocument && fileName == symbolDocument->fileName())
            doc = symbolDocument;
        else {
124
            source = snapshot.preprocessedCode(unpreprocessedSource, fileName);
125
126
127
            doc = snapshot.documentFromSource(source, fileName);
            doc->tokenize();
        }
128
129
130

        Control *control = doc->control();
        if (control->findIdentifier(symbolId->chars(), symbolId->size()) != 0) {
131
132
            if (doc != symbolDocument)
                doc->check();
133

134
            FindUsages process(unpreprocessedSource.toUtf8(), doc, snapshot);
135
            process(symbol);
136

137
138
139
140
141
142
143
            usages = process.usages();
        }

        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
144
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
145
146
147
148
{
    QFutureInterface<Usage> *future;

public:
Roberto Raggi's avatar
Roberto Raggi committed
149
    UpdateUI(QFutureInterface<Usage> *future): future(future) {}
150

151
    void operator()(QList<Usage> &, const QList<Usage> &usages)
152
153
154
155
156
157
158
159
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

        future->setProgressValue(future->progressValue() + 1);
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
160
161
} // end of anonymous namespace

162
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
163
164
    : QObject(modelManager),
      _modelManager(modelManager),
165
      _resultWindow(Find::SearchResultWindow::instance())
Roberto Raggi's avatar
Roberto Raggi committed
166
167
168
169
170
171
172
173
174
175
{
    m_watcher.setPendingResultsLimit(1);
    connect(&m_watcher, SIGNAL(resultsReadyAt(int,int)), this, SLOT(displayResults(int,int)));
    connect(&m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
}

CppFindReferences::~CppFindReferences()
{
}

176
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
Roberto Raggi's avatar
Roberto Raggi committed
177
178
179
{
    QList<int> references;

180
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
181
182
183
184
185
186
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

187
static void find_helper(QFutureInterface<Usage> &future,
188
                        const CppModelManagerInterface::WorkingCopy workingCopy,
189
                        const LookupContext context,
190
                        CppFindReferences *findRefs,
191
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
192
{
Roberto Raggi's avatar
Roberto Raggi committed
193
    const Identifier *symbolId = symbol->identifier();
194
195
    Q_ASSERT(symbolId != 0);

196
197
    const Snapshot snapshot = context.snapshot();

Roberto Raggi's avatar
Cleanup  
Roberto Raggi committed
198
199
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
    QStringList files(sourceFile);
200

201
202
    if (symbol->isClass() || symbol->isForwardClassDeclaration() || (symbol->enclosingScope() && ! symbol->isStatic() &&
                                                                     symbol->enclosingScope()->isNamespace())) {
203
        foreach (const Document::Ptr &doc, context.snapshot()) {
204
205
206
207
208
209
210
211
212
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
213
        DependencyTable dependencyTable = findRefs->updateDependencyTable(snapshot);
214
        files += dependencyTable.filesDependingOn(sourceFile);
215
    }
216
    files.removeDuplicates();
Roberto Raggi's avatar
Roberto Raggi committed
217
218
219

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

220
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol);
Roberto Raggi's avatar
Roberto Raggi committed
221
    UpdateUI reduce(&future);
222

223
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
224

Roberto Raggi's avatar
Roberto Raggi committed
225
226
227
    future.setProgressValue(files.size());
}

228
void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
229
{
Roberto Raggi's avatar
Roberto Raggi committed
230
231
232
233
234
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));

235
    findAll_helper(symbol, context);
236
237
}

238
239
void CppFindReferences::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                     const QString &replacement)
Roberto Raggi's avatar
Roberto Raggi committed
240
{
Roberto Raggi's avatar
Roberto Raggi committed
241
    if (const Identifier *id = symbol->identifier()) {
242
243
        const QString textToReplace = replacement.isEmpty()
                ? QString::fromUtf8(id->chars(), id->size()) : replacement;
Roberto Raggi's avatar
Roberto Raggi committed
244

245
246
        Find::SearchResult *search = _resultWindow->startNewSearch(
                Find::SearchResultWindow::SearchAndReplace, QLatin1String("CppEditor"));
247
        _resultWindow->setTextToReplace(textToReplace);
248

249
250
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
251

252
253
254
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

255
        findAll_helper(symbol, context);
256
    }
257
258
}

259
void CppFindReferences::findAll_helper(Symbol *symbol, const LookupContext &context)
260
{
261
262
263
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
264
265
    _resultWindow->popup(true);

266
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
267

Roberto Raggi's avatar
Roberto Raggi committed
268
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
269
270
271

    QFuture<Usage> result;

272
    result = QtConcurrent::run(&find_helper, workingCopy, context, this, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
273
274
    m_watcher.setFuture(result);

275
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
276
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
277
278
279
280

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

Roberto Raggi's avatar
Roberto Raggi committed
281
282
283
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
284
285
286
287
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
        _resultWindow->hide();
Roberto Raggi's avatar
Roberto Raggi committed
288
289
290
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
291
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
292
{
Roberto Raggi's avatar
Roberto Raggi committed
293
294
295
296
297
298
299
300
    for (int index = first; index != last; ++index) {
        Usage result = m_watcher.future().resultAt(index);
        _resultWindow->addResult(result.path,
                                 result.line,
                                 result.lineText,
                                 result.col,
                                 result.len);
    }
Roberto Raggi's avatar
Roberto Raggi committed
301
302
303
304
}

void CppFindReferences::searchFinished()
{
305
    _resultWindow->finishSearch();
Roberto Raggi's avatar
Roberto Raggi committed
306
307
308
    emit changed();
}

309
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
310
{
311
    if (item.path.size() > 0) {
312
        TextEditor::BaseTextEditorWidget::openEditorAt(item.path.first(), item.lineNumber, item.textMarkPos,
313
314
                                                 QString(),
                                                 Core::EditorManager::ModeSwitch);
315
    } else {
316
        Core::EditorManager::instance()->openEditor(item.text, QString(), Core::EditorManager::ModeSwitch);
317
    }
Roberto Raggi's avatar
Roberto Raggi committed
318
319
}

Christian Kamm's avatar
Christian Kamm committed
320
321
322
323
324

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
325
    const CppModelManagerInterface::WorkingCopy workingCopy;
Christian Kamm's avatar
Christian Kamm committed
326
327
328
329
    const Snapshot snapshot;
    const Macro &macro;

public:
330
    FindMacroUsesInFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
                        const Snapshot snapshot,
                        const Macro &macro)
        : workingCopy(workingCopy), snapshot(snapshot), macro(macro)
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;

        const Document::Ptr &doc = snapshot.document(fileName);
        QByteArray source;

        foreach (const Document::MacroUse &use, doc->macroUses()) {
            const Macro &useMacro = use.macro();
            if (useMacro.line() == macro.line()
                && useMacro.fileName() == macro.fileName())
                {
                if (source.isEmpty())
                    source = getSource(fileName, workingCopy).toLatin1(); // ### FIXME: Encoding?

                unsigned lineStart;
                const QString &lineSource = matchingLine(use.begin(), source, &lineStart);
                usages.append(Usage(fileName, lineSource, use.beginLine(),
                                    use.begin() - lineStart, use.length()));
            }
        }

        return usages;
    }

    // ### FIXME: Pretty close to FindUsages::matchingLine.
    static QString matchingLine(unsigned position, const QByteArray &source,
                                unsigned *lineStart = 0)
    {
        const char *beg = source.constData();
        const char *start = beg + position;
        for (; start != beg - 1; --start) {
            if (*start == '\n')
                break;
        }

        ++start;

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

        if (lineStart)
            *lineStart = start - beg;

        // ### FIXME: Encoding?
        const QString matchingLine = QString::fromUtf8(start, end - start);
        return matchingLine;
    }
};

} // end of anonymous namespace

static void findMacroUses_helper(QFutureInterface<Usage> &future,
392
                                 const CppModelManagerInterface::WorkingCopy workingCopy,
393
394
395
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
396
{
397
398
399
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
400
401
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
402
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
    files.removeDuplicates();

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

    FindMacroUsesInFile process(workingCopy, snapshot, macro);
    UpdateUI reduce(&future);
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);

    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
{
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

    _resultWindow->popup(true);

    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));

    const Snapshot snapshot = _modelManager->snapshot();
424
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
425
426
427
428
429
430
431
432
433
434

    // add the macro definition itself
    {
        // ### FIXME: Encoding?
        const QByteArray &source = getSource(macro.fileName(), workingCopy).toLatin1();
        _resultWindow->addResult(macro.fileName(), macro.line(),
                                 source.mid(macro.offset(), macro.length()), 0, macro.length());
    }

    QFuture<Usage> result;
435
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
Christian Kamm's avatar
Christian Kamm committed
436
437
438
    m_watcher.setFuture(result);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
439
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
440
441
442
443
                                                              CppTools::Constants::TASK_SEARCH);
    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}

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
DependencyTable CppFindReferences::updateDependencyTable(CPlusPlus::Snapshot snapshot)
{
    DependencyTable oldDeps = dependencyTable();
    if (oldDeps.isValidFor(snapshot))
        return oldDeps;

    DependencyTable newDeps;
    newDeps.build(snapshot);
    setDependencyTable(newDeps);
    return newDeps;
}

DependencyTable CppFindReferences::dependencyTable() const
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    return m_deps;
}

void CppFindReferences::setDependencyTable(const CPlusPlus::DependencyTable &newTable)
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    m_deps = newTable;
}