cppfindreferences.cpp 26.2 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
hjk's avatar
hjk committed
3
4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
Roberto Raggi's avatar
Roberto Raggi committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
Roberto Raggi's avatar
Roberto Raggi committed
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
Roberto Raggi's avatar
Roberto Raggi committed
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
Roberto Raggi's avatar
Roberto Raggi committed
29
30
31
32
33

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

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

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

55
#include <cpptools/ModelManagerInterface.h>
Roberto Raggi's avatar
Roberto Raggi committed
56
#include <cplusplus/CppDocument.h>
57
#include <cplusplus/Overview.h>
58
#include <cplusplus/FindUsages.h>
Roberto Raggi's avatar
Roberto Raggi committed
59

60
61
62
63
64
65
#include <QTime>
#include <QTimer>
#include <QtConcurrentRun>
#include <QtConcurrentMap>
#include <QDir>
#include <QApplication>
66
#include <utils/runextensions.h>
67
#include <utils/textfileformat.h>
Roberto Raggi's avatar
Roberto Raggi committed
68

69
70
#include <functional>

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

Christian Kamm's avatar
Christian Kamm committed
74
static QString getSource(const QString &fileName,
75
                         const CppModelManagerInterface::WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
76
77
78
79
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
80
81
82
83
84
85
86
87
        QString fileContents;
        Utils::TextFileFormat format;
        QString error;
        QTextCodec *defaultCodec = Core::EditorManager::instance()->defaultTextCodec();
        Utils::TextFileFormat::ReadResult result = Utils::TextFileFormat::readFile(
                    fileName, defaultCodec, &fileContents, &format, &error);
        if (result != Utils::TextFileFormat::ReadSuccess)
            qWarning() << "Could not read " << fileName << ". Error: " << error;
Christian Kamm's avatar
Christian Kamm committed
88

89
        return fileContents;
Christian Kamm's avatar
Christian Kamm committed
90
91
92
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
93
namespace {
94

Roberto Raggi's avatar
Roberto Raggi committed
95
class ProcessFile: public std::unary_function<QString, QList<Usage> >
96
{
97
    const CppModelManagerInterface::WorkingCopy workingCopy;
98
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
99
    Document::Ptr symbolDocument;
100
    Symbol *symbol;
101
    QFutureInterface<Usage> *future;
102
103

public:
104
    ProcessFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
105
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
106
                Document::Ptr symbolDocument,
107
108
109
110
111
112
113
                Symbol *symbol,
                QFutureInterface<Usage> *future)
        : workingCopy(workingCopy),
          snapshot(snapshot),
          symbolDocument(symbolDocument),
          symbol(symbol),
          future(future)
114
115
116
117
118
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
119
120
        if (future->isPaused())
            future->waitForResume();
121
122
        if (future->isCanceled())
            return usages;
123
124
        const Identifier *symbolId = symbol->identifier();

125
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
126
127
128
129
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }
130
        Document::Ptr doc;
131
        const QString unpreprocessedSource = getSource(fileName, workingCopy);
132

133
        if (symbolDocument && fileName == symbolDocument->fileName()) {
134
            doc = symbolDocument;
135
        } else {
136
            doc = snapshot.preprocessedDocument(unpreprocessedSource, fileName);
137
138
            doc->tokenize();
        }
139
140
141

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

145
            FindUsages process(unpreprocessedSource.toUtf8(), doc, snapshot);
146
            process(symbol);
147

148
149
150
            usages = process.usages();
        }

151
152
        if (future->isPaused())
            future->waitForResume();
153
154
155
156
        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
157
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
158
159
160
161
{
    QFutureInterface<Usage> *future;

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

164
    void operator()(QList<Usage> &, const QList<Usage> &usages)
165
166
167
168
169
170
171
172
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

Roberto Raggi's avatar
Roberto Raggi committed
173
174
} // end of anonymous namespace

175
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
176
    : QObject(modelManager),
177
      _modelManager(modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
178
179
180
181
182
183
184
{
}

CppFindReferences::~CppFindReferences()
{
}

185
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
Roberto Raggi's avatar
Roberto Raggi committed
186
187
188
{
    QList<int> references;

189
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
190
191
192
193
194
195
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

196
static void find_helper(QFutureInterface<Usage> &future,
197
                        const CppModelManagerInterface::WorkingCopy workingCopy,
198
                        const LookupContext context,
199
                        CppFindReferences *findRefs,
200
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
201
{
Roberto Raggi's avatar
Roberto Raggi committed
202
    const Identifier *symbolId = symbol->identifier();
203
    QTC_ASSERT(symbolId != 0, return);
204

205
206
    const Snapshot snapshot = context.snapshot();

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

210
211
    if (symbol->isClass() || symbol->isForwardClassDeclaration() || (symbol->enclosingScope() && ! symbol->isStatic() &&
                                                                     symbol->enclosingScope()->isNamespace())) {
212
        foreach (const Document::Ptr &doc, context.snapshot()) {
213
214
215
216
217
218
219
220
221
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
222
        DependencyTable dependencyTable = findRefs->updateDependencyTable(snapshot);
223
        files += dependencyTable.filesDependingOn(sourceFile);
224
    }
225
    files.removeDuplicates();
Roberto Raggi's avatar
Roberto Raggi committed
226
227
228

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

229
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol, &future);
Roberto Raggi's avatar
Roberto Raggi committed
230
    UpdateUI reduce(&future);
231
232
233
    // This thread waits for blockingMappedReduced to finish, so reduce the pool's used thread count
    // so the blockingMappedReduced can use one more thread, and increase it again afterwards.
    QThreadPool::globalInstance()->releaseThread();
234
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
235
    QThreadPool::globalInstance()->reserveThread();
Roberto Raggi's avatar
Roberto Raggi committed
236
237
238
    future.setProgressValue(files.size());
}

239
240
241
242
243
244
245
246
247
248
void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context)
{
    findUsages(symbol, context, QString(), false);
}

void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol,
                                   const CPlusPlus::LookupContext &context,
                                   const QString &replacement,
                                   bool replace)
249
{
250
    Overview overview;
251
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
252
                                                QString(),
253
                                                overview.prettyName(context.fullyQualifiedName(symbol)),
254
255
256
257
258
259
                                                replace ? Find::SearchResultWindow::SearchAndReplace
                                                        : Find::SearchResultWindow::SearchOnly,
                                                QLatin1String("CppEditor"));
    search->setTextToReplace(replacement);
    connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
            SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));
260
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
261
262
263
264
265
266
267
    search->setSearchAgainSupported(true);
    connect(search, SIGNAL(searchAgainRequested()), this, SLOT(searchAgain()));
    CppFindReferencesParameters parameters;
    parameters.context = context;
    parameters.symbol = symbol;
    search->setUserData(qVariantFromValue(parameters));
    findAll_helper(search);
268
269
}

270
271
void CppFindReferences::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                     const QString &replacement)
Roberto Raggi's avatar
Roberto Raggi committed
272
{
Roberto Raggi's avatar
Roberto Raggi committed
273
    if (const Identifier *id = symbol->identifier()) {
274
275
        const QString textToReplace = replacement.isEmpty()
                ? QString::fromUtf8(id->chars(), id->size()) : replacement;
276
        findUsages(symbol, context, textToReplace, true);
277
    }
278
279
}

280
void CppFindReferences::findAll_helper(Find::SearchResult *search)
281
{
282
283
    CppFindReferencesParameters parameters = search->userData().value<CppFindReferencesParameters>();
    if (!(parameters.symbol && parameters.symbol->identifier())) {
Eike Ziller's avatar
Eike Ziller committed
284
        search->finishSearch(false);
285
        return;
286
287
288
289
    }
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));
290

291
    Find::SearchResultWindow::instance()->popup(Core::IOutputPane::ModeSwitch | Core::IOutputPane::WithFocus);
292
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Roberto Raggi's avatar
Roberto Raggi committed
293
    QFuture<Usage> result;
294
295
    result = QtConcurrent::run(&find_helper, workingCopy,
                               parameters.context, this, parameters.symbol);
296
297
    createWatcher(result, search);

hjk's avatar
hjk committed
298
    Core::ProgressManager *progressManager = Core::ICore::progressManager();
299
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
300
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
301

302
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Roberto Raggi's avatar
Roberto Raggi committed
303
304
}

Roberto Raggi's avatar
Roberto Raggi committed
305
306
307
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
308
309
310
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
311
        Find::SearchResultWindow::instance()->hide();
Roberto Raggi's avatar
Roberto Raggi committed
312
313
314
    }
}

315
316
317
318
319
void CppFindReferences::searchAgain()
{
    Find::SearchResult *search = qobject_cast<Find::SearchResult *>(sender());
    CppFindReferencesParameters parameters = search->userData().value<CppFindReferencesParameters>();
    Snapshot snapshot = CppModelManagerInterface::instance()->snapshot();
Eike Ziller's avatar
Eike Ziller committed
320
    search->restart();
321
    if (!findSymbol(&parameters, snapshot)) {
Eike Ziller's avatar
Eike Ziller committed
322
        search->finishSearch(false);
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
390
391
392
393
394
395
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
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
        return;
    }
    search->setUserData(qVariantFromValue(parameters));
    findAll_helper(search);
}

static QByteArray typeId(Symbol *symbol)
{
    if (symbol->asEnum()) {
        return QByteArray("e");
    } else if (symbol->asFunction()) {
        return QByteArray("f");
    } else if (symbol->asNamespace()) {
        return QByteArray("n");
    } else if (symbol->asTemplate()) {
        return QByteArray("t");
    } else if (symbol->asNamespaceAlias()) {
        return QByteArray("na");
    } else if (symbol->asClass()) {
        return QByteArray("c");
    } else if (symbol->asBlock()) {
        return QByteArray("b");
    } else if (symbol->asUsingNamespaceDirective()) {
        return QByteArray("u");
    } else if (symbol->asUsingDeclaration()) {
        return QByteArray("ud");
    } else if (symbol->asDeclaration()) {
        QByteArray temp("d,");
        Overview pretty;
        temp.append(pretty.prettyType(symbol->type()).toLatin1());
        return temp;
    } else if (symbol->asArgument()) {
        return QByteArray("a");
    } else if (symbol->asTypenameArgument()) {
        return QByteArray("ta");
    } else if (symbol->asBaseClass()) {
        return QByteArray("bc");
    } else if (symbol->asForwardClassDeclaration()) {
        return QByteArray("fcd");
    } else if (symbol->asQtPropertyDeclaration()) {
        return QByteArray("qpd");
    } else if (symbol->asQtEnum()) {
        return QByteArray("qe");
    } else if (symbol->asObjCBaseClass()) {
        return QByteArray("ocbc");
    } else if (symbol->asObjCBaseProtocol()) {
        return QByteArray("ocbp");
    } else if (symbol->asObjCClass()) {
        return QByteArray("occ");
    } else if (symbol->asObjCForwardClassDeclaration()) {
        return QByteArray("ocfd");
    } else if (symbol->asObjCProtocol()) {
        return QByteArray("ocp");
    } else if (symbol->asObjCForwardProtocolDeclaration()) {
        return QByteArray("ocfpd");
    } else if (symbol->asObjCMethod()) {
        return QByteArray("ocm");
    } else if (symbol->asObjCPropertyDeclaration()) {
        return QByteArray("ocpd");
    }
    return QByteArray("unknown");
}

static QByteArray idForSymbol(Symbol *symbol)
{
    QByteArray uid(typeId(symbol));
    if (const Identifier *id = symbol->identifier()) {
        uid.append("|");
        uid.append(QByteArray(id->chars(), id->size()));
    } else if (Scope *scope = symbol->enclosingScope()) {
        // add the index of this symbol within its enclosing scope
        // (counting symbols without identifier of the same type)
        int count = 0;
        Scope::iterator it = scope->firstMember();
        while (it != scope->lastMember() && *it != symbol) {
            Symbol *val = *it;
            ++it;
            if (val->identifier() || typeId(val) != uid)
                continue;
            ++count;
        }
        uid.append(QString::number(count).toLocal8Bit());
    }
    return uid;
}

namespace {
class SymbolFinder : public SymbolVisitor
{
public:
    SymbolFinder(const QStringList &uid) : m_uid(uid), m_index(0), m_result(0) { }
    Symbol *result() const { return m_result; }

    bool preVisit(Symbol *symbol)
    {
        if (m_result)
            return false;
        int index = m_index;
        if (symbol->asScope())
            ++m_index;
        if (index >= m_uid.size())
            return false;
        if (idForSymbol(symbol) != m_uid.at(index))
            return false;
        if (index == m_uid.size() - 1) {
            // symbol found
            m_result = symbol;
            return false;
        }
        return true;
    }

    void postVisit(Symbol *symbol)
    {
        if (symbol->asScope())
            --m_index;
    }

private:
    QStringList m_uid;
    int m_index;
    Symbol *m_result;
};
}

bool CppFindReferences::findSymbol(CppFindReferencesParameters *parameters,
                                      const Snapshot &snapshot)
{
    QString symbolFile = QLatin1String(parameters->symbol->fileName());
    if (!snapshot.contains(symbolFile)) {
        return false;
    }

    Document::Ptr newSymbolDocument = snapshot.document(symbolFile);
    // document is not parsed and has no bindings yet, do it
    QString source = getSource(newSymbolDocument->fileName(), _modelManager->workingCopy());
    Document::Ptr doc =
460
            snapshot.preprocessedDocument(source, newSymbolDocument->fileName());
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
    doc->check();

    // construct id of old symbol
    QStringList uid;
    Symbol *current = parameters->symbol;
    do {
        uid.prepend(idForSymbol(current));
        current = current->enclosingScope();
    } while (current);
    // find matching symbol in new document and return the new parameters
    SymbolFinder finder(uid);
    finder.accept(doc->globalNamespace());
    if (finder.result()) {
        parameters->symbol = finder.result();
        parameters->context = LookupContext(doc, snapshot);
        return true;
    }
    return false;
}

Roberto Raggi's avatar
Roberto Raggi committed
481
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
482
{
483
484
485
486
487
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
    Find::SearchResult *search = m_watchers.value(watcher);
    if (!search) {
        // search was deleted while it was running
        watcher->cancel();
488
489
        return;
    }
Roberto Raggi's avatar
Roberto Raggi committed
490
    for (int index = first; index != last; ++index) {
491
492
493
494
495
496
        Usage result = watcher->future().resultAt(index);
        search->addResult(result.path,
                          result.line,
                          result.lineText,
                          result.col,
                          result.len);
Roberto Raggi's avatar
Roberto Raggi committed
497
    }
Roberto Raggi's avatar
Roberto Raggi committed
498
499
500
501
}

void CppFindReferences::searchFinished()
{
502
503
504
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
    Find::SearchResult *search = m_watchers.value(watcher);
    if (search)
Eike Ziller's avatar
Eike Ziller committed
505
        search->finishSearch(watcher->isCanceled());
506
    m_watchers.remove(watcher);
Roberto Raggi's avatar
Roberto Raggi committed
507
508
}

509
510
void CppFindReferences::cancel()
{
511
512
513
514
515
    Find::SearchResult *search = qobject_cast<Find::SearchResult *>(sender());
    QTC_ASSERT(search, return);
    QFutureWatcher<Usage> *watcher = m_watchers.key(search);
    QTC_ASSERT(watcher, return);
    watcher->cancel();
516
517
}

518
519
520
521
522
523
524
525
526
527
void CppFindReferences::setPaused(bool paused)
{
    Find::SearchResult *search = qobject_cast<Find::SearchResult *>(sender());
    QTC_ASSERT(search, return);
    QFutureWatcher<Usage> *watcher = m_watchers.key(search);
    QTC_ASSERT(watcher, return);
    if (!paused || watcher->isRunning()) // guard against pausing when the search is finished
        watcher->setPaused(paused);
}

528
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
529
{
530
    if (item.path.size() > 0) {
531
532
533
534
        TextEditor::BaseTextEditorWidget::openEditorAt(QDir::fromNativeSeparators(item.path.first()),
                                                       item.lineNumber, item.textMarkPos,
                                                       Core::Id(),
                                                       Core::EditorManager::ModeSwitch);
535
    } else {
hjk's avatar
hjk committed
536
537
        Core::EditorManager::openEditor(QDir::fromNativeSeparators(item.text),
                                        Core::Id(), Core::EditorManager::ModeSwitch);
538
    }
Roberto Raggi's avatar
Roberto Raggi committed
539
540
}

Christian Kamm's avatar
Christian Kamm committed
541
542
543
544
545

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
546
    const CppModelManagerInterface::WorkingCopy workingCopy;
Christian Kamm's avatar
Christian Kamm committed
547
548
    const Snapshot snapshot;
    const Macro &macro;
549
    QFutureInterface<Usage> *future;
Christian Kamm's avatar
Christian Kamm committed
550
551

public:
552
    FindMacroUsesInFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
553
                        const Snapshot snapshot,
554
555
556
                        const Macro &macro,
                        QFutureInterface<Usage> *future)
        : workingCopy(workingCopy), snapshot(snapshot), macro(macro), future(future)
Christian Kamm's avatar
Christian Kamm committed
557
558
559
560
561
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
562
563
564
565
        Document::Ptr doc = snapshot.document(fileName);
        QString source;

_Lrestart:
566
567
        if (future->isPaused())
            future->waitForResume();
568
569
        if (future->isCanceled())
            return usages;
Christian Kamm's avatar
Christian Kamm committed
570

571
        usages.clear();
Christian Kamm's avatar
Christian Kamm committed
572
573
        foreach (const Document::MacroUse &use, doc->macroUses()) {
            const Macro &useMacro = use.macro();
574
575

            if (useMacro.fileName() == macro.fileName()) { // Check if this is a match, but possibly against an outdated document.
Andre Hartmann's avatar
Andre Hartmann committed
576
577
578
                if (source.isEmpty())
                    source = getSource(fileName, workingCopy);

579
580
581
582
583
584
                if (macro.fileRevision() > useMacro.fileRevision()) {
                    // yes, it is outdated, so re-preprocess and start from scratch for this file.
                    doc = snapshot.preprocessedDocument(source, fileName);
                    goto _Lrestart;
                }

Andre Hartmann's avatar
Andre Hartmann committed
585
586
587
588
589
590
                if (macro.name() == useMacro.name()) {
                    unsigned lineStart;
                    const QString &lineSource = matchingLine(use.begin(), source, &lineStart);
                    usages.append(Usage(fileName, lineSource, use.beginLine(),
                                        use.begin() - lineStart, useMacro.name().length()));
                }
Christian Kamm's avatar
Christian Kamm committed
591
592
593
            }
        }

594
595
        if (future->isPaused())
            future->waitForResume();
Christian Kamm's avatar
Christian Kamm committed
596
597
598
        return usages;
    }

599
    static QString matchingLine(unsigned position, const QString &source,
Christian Kamm's avatar
Christian Kamm committed
600
601
                                unsigned *lineStart = 0)
    {
602
603
604
605
        int lineBegin = source.lastIndexOf(QLatin1Char('\n'), position) + 1;
        int lineEnd = source.indexOf(QLatin1Char('\n'), position);
        if (lineEnd == -1)
            lineEnd = source.length();
Christian Kamm's avatar
Christian Kamm committed
606
607

        if (lineStart)
608
            *lineStart = lineBegin;
Christian Kamm's avatar
Christian Kamm committed
609

610
        const QString matchingLine = source.mid(lineBegin, lineEnd - lineBegin);
Christian Kamm's avatar
Christian Kamm committed
611
612
613
614
615
616
617
        return matchingLine;
    }
};

} // end of anonymous namespace

static void findMacroUses_helper(QFutureInterface<Usage> &future,
618
                                 const CppModelManagerInterface::WorkingCopy workingCopy,
619
620
621
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
622
{
623
624
625
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
626
627
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
628
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
629
630
631
    files.removeDuplicates();

    future.setProgressRange(0, files.size());
632
    FindMacroUsesInFile process(workingCopy, snapshot, macro, &future);
Christian Kamm's avatar
Christian Kamm committed
633
    UpdateUI reduce(&future);
634
635
636
    // This thread waits for blockingMappedReduced to finish, so reduce the pool's used thread count
    // so the blockingMappedReduced can use one more thread, and increase it again afterwards.
    QThreadPool::globalInstance()->releaseThread();
Christian Kamm's avatar
Christian Kamm committed
637
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
638
    QThreadPool::globalInstance()->reserveThread();
Christian Kamm's avatar
Christian Kamm committed
639
640
641
642
    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
643
644
645
646
647
{
    findMacroUses(macro, QString(), false);
}

void CppFindReferences::findMacroUses(const Macro &macro, const QString &replacement, bool replace)
Christian Kamm's avatar
Christian Kamm committed
648
{
649
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(
650
651
652
                tr("C++ Macro Usages:"),
                QString(),
                macro.name(),
653
654
655
656
657
658
659
                replace ? Find::SearchResultWindow::SearchAndReplace
                        : Find::SearchResultWindow::SearchOnly,
                QLatin1String("CppEditor"));

    search->setTextToReplace(replacement);
    connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
            SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));
Christian Kamm's avatar
Christian Kamm committed
660

661
    Find::SearchResultWindow::instance()->popup(Core::IOutputPane::ModeSwitch | Core::IOutputPane::WithFocus);
Christian Kamm's avatar
Christian Kamm committed
662

663
    connect(search, SIGNAL(activated(Find::SearchResultItem)),
Christian Kamm's avatar
Christian Kamm committed
664
            this, SLOT(openEditor(Find::SearchResultItem)));
665
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
666
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
Christian Kamm's avatar
Christian Kamm committed
667
668

    const Snapshot snapshot = _modelManager->snapshot();
669
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
670
671
672

    // add the macro definition itself
    {
673
674
675
        const QString &source = getSource(macro.fileName(), workingCopy);
        unsigned lineStart;
        const QString line = FindMacroUsesInFile::matchingLine(macro.offset(), source, &lineStart);
676
        search->addResult(macro.fileName(), macro.line(), line,
677
                          macro.offset() - lineStart, macro.name().length());
Christian Kamm's avatar
Christian Kamm committed
678
679
680
    }

    QFuture<Usage> result;
681
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
682
    createWatcher(result, search);
Christian Kamm's avatar
Christian Kamm committed
683

hjk's avatar
hjk committed
684
    Core::ProgressManager *progressManager = Core::ICore::progressManager();
685
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
686
                                                              CppTools::Constants::TASK_SEARCH);
687
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Christian Kamm's avatar
Christian Kamm committed
688
689
}

690
691
692
693
694
695
void CppFindReferences::renameMacroUses(const Macro &macro, const QString &replacement)
{
    const QString textToReplace = replacement.isEmpty() ? macro.name() : replacement;
    findMacroUses(macro, textToReplace, true);
}

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
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;
}
721
722
723
724
725
726
727
728

void CppFindReferences::createWatcher(const QFuture<Usage> &future, Find::SearchResult *search)
{
    QFutureWatcher<Usage> *watcher = new QFutureWatcher<Usage>();
    watcher->setPendingResultsLimit(1);
    connect(watcher, SIGNAL(resultsReadyAt(int,int)), this, SLOT(displayResults(int,int)));
    connect(watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
    m_watchers.insert(watcher, search);
Eike Ziller's avatar
Eike Ziller committed
729
    watcher->setFuture(future);
730
}