cppfindreferences.cpp 14.4 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1
2
3
4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
Roberto Raggi's avatar
Roberto Raggi committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
**
** 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
con's avatar
con committed
26
** contact the sales department at http://qt.nokia.com/contact.
Roberto Raggi's avatar
Roberto Raggi committed
27
28
29
30
**
**************************************************************************/

#include "cppfindreferences.h"
31
#include "cppmodelmanagerinterface.h"
Roberto Raggi's avatar
Roberto Raggi committed
32
33
34
#include "cpptoolsconstants.h"

#include <texteditor/basetexteditor.h>
35
#include <texteditor/basefilefind.h>
Roberto Raggi's avatar
Roberto Raggi committed
36
37
38
39
#include <find/searchresultwindow.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
#include <coreplugin/progressmanager/progressmanager.h>
40
#include <coreplugin/editormanager/editormanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
41
42
43
44
45
46
47
48
#include <coreplugin/icore.h>

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

#include <cplusplus/CppDocument.h>
53
#include <cplusplus/CppBindings.h>
54
#include <cplusplus/Overview.h>
Roberto Raggi's avatar
Roberto Raggi committed
55
56
57

#include <QtCore/QTime>
#include <QtCore/QtConcurrentRun>
58
#include <QtCore/QtConcurrentMap>
Roberto Raggi's avatar
Roberto Raggi committed
59
#include <QtCore/QDir>
60
#include <QtGui/QApplication>
Roberto Raggi's avatar
Roberto Raggi committed
61
62
#include <qtconcurrent/runextensions.h>

63
64
#include <functional>

Roberto Raggi's avatar
Roberto Raggi committed
65
66
67
using namespace CppTools::Internal;
using namespace CPlusPlus;

Christian Kamm's avatar
Christian Kamm committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
static QString getSource(const QString &fileName,
                         const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy)
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
        QFile file(fileName);
        if (! file.open(QFile::ReadOnly))
            return QString();

        return QTextStream(&file).readAll(); // ### FIXME
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
82
namespace {
83

Roberto Raggi's avatar
Roberto Raggi committed
84
class ProcessFile: public std::unary_function<QString, QList<Usage> >
85
{
86
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy;
87
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
88
    Document::Ptr symbolDocument;
89
90
91
    Symbol *symbol;

public:
92
93
    ProcessFile(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy,
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
94
                Document::Ptr symbolDocument,
95
                Symbol *symbol)
Erik Verbruggen's avatar
Erik Verbruggen committed
96
        : workingCopy(workingCopy), snapshot(snapshot), symbolDocument(symbolDocument), symbol(symbol)
97
98
99
100
101
102
103
    { }

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

104
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
105
106
107
108
109
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }

Christian Kamm's avatar
Christian Kamm committed
110
111
        QByteArray source = snapshot.preprocessedCode(
                getSource(fileName, workingCopy), fileName);
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

        Document::Ptr doc = snapshot.documentFromSource(source, fileName);
        doc->tokenize();

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

            FindUsages process(doc, snapshot);
            process.setGlobalNamespaceBinding(bind(doc, snapshot));

            process(symbol);
            usages = process.usages();
        }

        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
131
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
132
133
134
135
{
    QFutureInterface<Usage> *future;

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

138
    void operator()(QList<Usage> &, const QList<Usage> &usages)
139
140
141
142
143
144
145
146
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

Roberto Raggi's avatar
Roberto Raggi committed
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
} // end of anonymous namespace

CppFindReferences::CppFindReferences(CppTools::CppModelManagerInterface *modelManager)
    : QObject(modelManager),
      _modelManager(modelManager),
      _resultWindow(ExtensionSystem::PluginManager::instance()->getObject<Find::SearchResultWindow>())
{
    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()
{
}

QList<int> CppFindReferences::references(Symbol *symbol,
                                         Document::Ptr doc,
                                         const Snapshot& snapshot) const
{
    QList<int> references;

    FindUsages findUsages(doc, snapshot);
    findUsages.setGlobalNamespaceBinding(bind(doc, snapshot));
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

177
static void find_helper(QFutureInterface<Usage> &future,
178
                        const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
179
                        Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
180
                        Document::Ptr symbolDocument,
181
                        DependencyTable dependencyTable,
182
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
183
184
185
{
    QTime tm;
    tm.start();
186

Roberto Raggi's avatar
Roberto Raggi committed
187
    const Identifier *symbolId = symbol->identifier();
188
189
    Q_ASSERT(symbolId != 0);

Roberto Raggi's avatar
Cleanup    
Roberto Raggi committed
190
191
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
    QStringList files(sourceFile);
192
193
194
195
196
197
198
199
200
201
202
203

    if (symbol->isClass() || symbol->isForwardClassDeclaration()) {
        foreach (const Document::Ptr &doc, snapshot) {
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
204
        files += dependencyTable.filesDependingOn(sourceFile);
205
    }
206
    files.removeDuplicates();
207
    //qDebug() << "done in:" << tm.elapsed() << "number of files to parse:" << files.size();
Roberto Raggi's avatar
Roberto Raggi committed
208
209
210

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

Erik Verbruggen's avatar
Erik Verbruggen committed
211
    ProcessFile process(workingCopy, snapshot, symbolDocument, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
212
    UpdateUI reduce(&future);
213

214
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
215

Roberto Raggi's avatar
Roberto Raggi committed
216
217
218
    future.setProgressValue(files.size());
}

219
220
221
222
223
224
225
226
227
void CppFindReferences::updateDependencyTable(const Snapshot &snapshot)
{
    if (!m_deps.isValidFor(snapshot)) {
        DependencyTable newDeps;
        newDeps.build(snapshot);
        m_deps = newDeps;
    }
}

Erik Verbruggen's avatar
Erik Verbruggen committed
228
void CppFindReferences::findUsages(Document::Ptr symbolDocument, Symbol *symbol)
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)));

Erik Verbruggen's avatar
Erik Verbruggen committed
235
    findAll_helper(symbolDocument, symbol);
236
237
}

Erik Verbruggen's avatar
Erik Verbruggen committed
238
void CppFindReferences::renameUsages(Document::Ptr symbolDocument, Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
239
{
Roberto Raggi's avatar
Roberto Raggi committed
240
    if (const Identifier *id = symbol->identifier()) {
241
        const QString textToReplace = QString::fromUtf8(id->chars(), id->size());
Roberto Raggi's avatar
Roberto Raggi committed
242

243
244
        Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchAndReplace);
        _resultWindow->setTextToReplace(textToReplace);
245

246
247
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
248

249
250
251
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

Erik Verbruggen's avatar
Erik Verbruggen committed
252
        findAll_helper(symbolDocument, symbol);
253
    }
254
255
}

Erik Verbruggen's avatar
Erik Verbruggen committed
256
void CppFindReferences::findAll_helper(Document::Ptr symbolDocument, Symbol *symbol)
257
{
258
259
260
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
261
262
    _resultWindow->popup(true);

263
    const Snapshot snapshot = _modelManager->snapshot();
264
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
265

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

268
269
    updateDependencyTable(snapshot);

Roberto Raggi's avatar
Roberto Raggi committed
270
271
    QFuture<Usage> result;

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

    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
    Core::EditorManager::instance()->hideEditorInfoBar(QLatin1String("CppEditor.Rename"));

286
287
288
289
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
        _resultWindow->hide();
Roberto Raggi's avatar
Roberto Raggi committed
290
291
292
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
293
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
294
{
Roberto Raggi's avatar
Roberto Raggi committed
295
296
297
298
299
300
301
302
    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
303
304
305
306
}

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

311
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
312
{
313
    TextEditor::BaseTextEditor::openEditorAt(item.fileName, item.lineNumber, item.searchTermStart);
Roberto Raggi's avatar
Roberto Raggi committed
314
315
}

Christian Kamm's avatar
Christian Kamm committed
316
317
318
319
320
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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy;
    const Snapshot snapshot;
    const Macro &macro;

public:
    FindMacroUsesInFile(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy,
                        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,
                        const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
                        const Snapshot snapshot,
390
                        DependencyTable dependencyTable,
Christian Kamm's avatar
Christian Kamm committed
391
392
393
394
                        const Macro macro)
{
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
395
    files += dependencyTable.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
    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();
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();

    // 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());
    }

427
428
    updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
429
    QFuture<Usage> result;
430
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, m_deps, macro);
Christian Kamm's avatar
Christian Kamm committed
431
432
433
434
435
436
437
438
    m_watcher.setFuture(result);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching..."),
                                                              CppTools::Constants::TASK_SEARCH);
    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}