cppfindreferences.cpp 25.1 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
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
** 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
12 13 14
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
Roberto Raggi's avatar
Roberto Raggi committed
15
**
16 17 18 19 20 21 22
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
con's avatar
con committed
23
**
hjk's avatar
hjk committed
24
****************************************************************************/
Roberto Raggi's avatar
Roberto Raggi committed
25 26

#include "cppfindreferences.h"
27

Roberto Raggi's avatar
Roberto Raggi committed
28
#include "cpptoolsconstants.h"
29
#include "cppmodelmanager.h"
30
#include "cppworkingcopy.h"
Roberto Raggi's avatar
Roberto Raggi committed
31

32
#include <coreplugin/editormanager/editormanager.h>
33 34 35 36 37
#include <coreplugin/icore.h>
#include <coreplugin/progressmanager/futureprogress.h>
#include <coreplugin/progressmanager/progressmanager.h>
#include <texteditor/basefilefind.h>

38
#include <utils/algorithm.h>
39
#include <utils/qtcassert.h>
40 41
#include <utils/runextensions.h>
#include <utils/textfileformat.h>
Roberto Raggi's avatar
Roberto Raggi committed
42

43
#include <cplusplus/Overview.h>
44 45
#include <QtConcurrentMap>
#include <QDir>
Roberto Raggi's avatar
Roberto Raggi committed
46

47 48
#include <functional>

49
using namespace Core;
Roberto Raggi's avatar
Roberto Raggi committed
50
using namespace CppTools::Internal;
51
using namespace CppTools;
Roberto Raggi's avatar
Roberto Raggi committed
52 53
using namespace CPlusPlus;

54
static QByteArray getSource(const Utils::FileName &fileName,
55
                            const WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
56 57 58 59
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
60 61 62
        QString fileContents;
        Utils::TextFileFormat format;
        QString error;
63
        QTextCodec *defaultCodec = EditorManager::defaultTextCodec();
64
        Utils::TextFileFormat::ReadResult result = Utils::TextFileFormat::readFile(
65
                    fileName.toString(), defaultCodec, &fileContents, &format, &error);
66 67
        if (result != Utils::TextFileFormat::ReadSuccess)
            qWarning() << "Could not read " << fileName << ". Error: " << error;
Christian Kamm's avatar
Christian Kamm committed
68

69
        return fileContents.toUtf8();
Christian Kamm's avatar
Christian Kamm committed
70 71 72
    }
}

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
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;
96
        temp.append(pretty.prettyType(symbol->type()).toUtf8());
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 129 130 131 132 133 134 135 136 137 138 139
        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;
140 141
        Scope::iterator it = scope->memberBegin();
        while (it != scope->memberEnd() && *it != symbol) {
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
            Symbol *val = *it;
            ++it;
            if (val->identifier() || typeId(val) != uid)
                continue;
            ++count;
        }
        uid.append(QString::number(count).toLocal8Bit());
    }
    return uid;
}

static QList<QByteArray> fullIdForSymbol(Symbol *symbol)
{
    QList<QByteArray> uid;
    Symbol *current = symbol;
    do {
        uid.prepend(idForSymbol(current));
        current = current->enclosingScope();
    } while (current);
    return uid;
}

Roberto Raggi's avatar
Roberto Raggi committed
164
namespace {
165

Roberto Raggi's avatar
Roberto Raggi committed
166
class ProcessFile: public std::unary_function<QString, QList<Usage> >
167
{
168
    const WorkingCopy workingCopy;
169
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
170
    Document::Ptr symbolDocument;
171
    Symbol *symbol;
172
    QFutureInterface<Usage> *future;
173 174

public:
175
    ProcessFile(const WorkingCopy &workingCopy,
176
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
177
                Document::Ptr symbolDocument,
178 179 180 181 182 183 184
                Symbol *symbol,
                QFutureInterface<Usage> *future)
        : workingCopy(workingCopy),
          snapshot(snapshot),
          symbolDocument(symbolDocument),
          symbol(symbol),
          future(future)
185 186
    { }

187
    QList<Usage> operator()(const Utils::FileName &fileName)
188 189
    {
        QList<Usage> usages;
190 191
        if (future->isPaused())
            future->waitForResume();
192 193
        if (future->isCanceled())
            return usages;
194 195
        const Identifier *symbolId = symbol->identifier();

196
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
197
            Control *control = previousDoc->control();
198
            if (!control->findIdentifier(symbolId->chars(), symbolId->size()))
199 200
                return usages; // skip this document, it's not using symbolId.
        }
201
        Document::Ptr doc;
202
        const QByteArray unpreprocessedSource = getSource(fileName, workingCopy);
203

204
        if (symbolDocument && fileName == Utils::FileName::fromString(symbolDocument->fileName())) {
205
            doc = symbolDocument;
206
        } else {
207
            doc = snapshot.preprocessedDocument(unpreprocessedSource, fileName);
208 209
            doc->tokenize();
        }
210 211 212

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

216
            FindUsages process(unpreprocessedSource, doc, snapshot);
217
            process(symbol);
218

219 220 221
            usages = process.usages();
        }

222 223
        if (future->isPaused())
            future->waitForResume();
224 225 226 227
        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
228
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
229 230 231 232
{
    QFutureInterface<Usage> *future;

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

235
    void operator()(QList<Usage> &, const QList<Usage> &usages)
236 237 238 239 240 241 242 243
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

Roberto Raggi's avatar
Roberto Raggi committed
244 245
} // end of anonymous namespace

246
CppFindReferences::CppFindReferences(CppModelManager *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
247
    : QObject(modelManager),
Erik Verbruggen's avatar
Erik Verbruggen committed
248
      m_modelManager(modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
249 250 251 252 253 254 255
{
}

CppFindReferences::~CppFindReferences()
{
}

256
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
Roberto Raggi's avatar
Roberto Raggi committed
257 258 259
{
    QList<int> references;

260
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
261 262 263 264 265 266
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

267
static void find_helper(QFutureInterface<Usage> &future,
268
                        const WorkingCopy workingCopy,
269
                        const LookupContext context,
270
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
271
{
Roberto Raggi's avatar
Roberto Raggi committed
272
    const Identifier *symbolId = symbol->identifier();
273
    QTC_ASSERT(symbolId != 0, return);
274

275 276
    const Snapshot snapshot = context.snapshot();

277 278
    const Utils::FileName sourceFile = Utils::FileName::fromUtf8(symbol->fileName(),
                                                                 symbol->fileNameLength());
279
    Utils::FileNameList files {sourceFile};
280

281 282 283 284 285
    if (symbol->isClass()
        || symbol->isForwardClassDeclaration()
        || (symbol->enclosingScope()
            && !symbol->isStatic()
            && symbol->enclosingScope()->isNamespace())) {
286 287 288
        const Snapshot snapshotFromContext = context.snapshot();
        for (auto i = snapshotFromContext.begin(), ei = snapshotFromContext.end(); i != ei; ++i) {
            if (i.key() == sourceFile)
289 290
                continue;

291
            const Control *control = i.value()->control();
292 293

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
294
                files.append(i.key());
295 296
        }
    } else {
297
        files += snapshot.filesDependingOn(sourceFile);
298
    }
299
    files = Utils::filteredUnique(files);
Roberto Raggi's avatar
Roberto Raggi committed
300 301 302

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

303
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol, &future);
Roberto Raggi's avatar
Roberto Raggi committed
304
    UpdateUI reduce(&future);
305 306 307
    // 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();
308
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
309
    QThreadPool::globalInstance()->reserveThread();
Roberto Raggi's avatar
Roberto Raggi committed
310 311 312
    future.setProgressValue(files.size());
}

313
void CppFindReferences::findUsages(Symbol *symbol, const LookupContext &context)
314 315 316 317
{
    findUsages(symbol, context, QString(), false);
}

318 319
void CppFindReferences::findUsages(Symbol *symbol,
                                   const LookupContext &context,
320 321
                                   const QString &replacement,
                                   bool replace)
322
{
323
    Overview overview;
324
    SearchResult *search = SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
325
                                                QString(),
326
                                                overview.prettyName(context.fullyQualifiedName(symbol)),
327 328 329
                                                replace ? SearchResultWindow::SearchAndReplace
                                                        : SearchResultWindow::SearchOnly,
                                                SearchResultWindow::PreserveCaseDisabled,
330 331
                                                QLatin1String("CppEditor"));
    search->setTextToReplace(replacement);
332 333 334
    connect(search, &SearchResult::replaceButtonClicked,
            this, &CppFindReferences::onReplaceButtonClicked);
    connect(search, &SearchResult::paused, this, &CppFindReferences::setPaused);
335
    search->setSearchAgainSupported(true);
336
    connect(search, &SearchResult::searchAgainRequested, this, &CppFindReferences::searchAgain);
337
    CppFindReferencesParameters parameters;
338 339
    parameters.symbolId = fullIdForSymbol(symbol);
    parameters.symbolFileName = QByteArray(symbol->fileName());
340
    search->setUserData(qVariantFromValue(parameters));
341
    findAll_helper(search, symbol, context);
342 343
}

344
void CppFindReferences::renameUsages(Symbol *symbol, const LookupContext &context,
345
                                     const QString &replacement)
Roberto Raggi's avatar
Roberto Raggi committed
346
{
Roberto Raggi's avatar
Roberto Raggi committed
347
    if (const Identifier *id = symbol->identifier()) {
348 349
        const QString textToReplace = replacement.isEmpty()
                ? QString::fromUtf8(id->chars(), id->size()) : replacement;
350
        findUsages(symbol, context, textToReplace, true);
351
    }
352 353
}

354 355
void CppFindReferences::findAll_helper(SearchResult *search, Symbol *symbol,
                                       const LookupContext &context)
356
{
357
    if (!(symbol && symbol->identifier())) {
Eike Ziller's avatar
Eike Ziller committed
358
        search->finishSearch(false);
359
        return;
360
    }
361 362 363
    connect(search, &SearchResult::cancelled, this, &CppFindReferences::cancel);
    connect(search, &SearchResult::activated,
            this, &CppFindReferences::openEditor);
364

365
    SearchResultWindow::instance()->popup(IOutputPane::ModeSwitch | IOutputPane::WithFocus);
366
    const WorkingCopy workingCopy = m_modelManager->workingCopy();
Roberto Raggi's avatar
Roberto Raggi committed
367
    QFuture<Usage> result;
368 369
    result = Utils::runAsync(m_modelManager->sharedThreadPool(), find_helper,
                             workingCopy, context, symbol);
370 371
    createWatcher(result, search);

372
    FutureProgress *progress = ProgressManager::addTask(result, tr("Searching for Usages"),
373
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
374

375
    connect(progress, &FutureProgress::clicked, search, &SearchResult::popup);
Roberto Raggi's avatar
Roberto Raggi committed
376 377
}

Roberto Raggi's avatar
Roberto Raggi committed
378
void CppFindReferences::onReplaceButtonClicked(const QString &text,
379
                                               const QList<SearchResultItem> &items,
380
                                               bool preserveCase)
Roberto Raggi's avatar
Roberto Raggi committed
381
{
382
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items, preserveCase);
383
    if (!fileNames.isEmpty()) {
384
        m_modelManager->updateSourceFiles(fileNames.toSet());
385
        SearchResultWindow::instance()->hide();
Roberto Raggi's avatar
Roberto Raggi committed
386 387 388
    }
}

389 390
void CppFindReferences::searchAgain()
{
391
    SearchResult *search = qobject_cast<SearchResult *>(sender());
392
    CppFindReferencesParameters parameters = search->userData().value<CppFindReferencesParameters>();
393
    Snapshot snapshot = CppModelManager::instance()->snapshot();
Eike Ziller's avatar
Eike Ziller committed
394
    search->restart();
395 396 397
    LookupContext context;
    Symbol *symbol = findSymbol(parameters, snapshot, &context);
    if (!symbol) {
Eike Ziller's avatar
Eike Ziller committed
398
        search->finishSearch(false);
399 400
        return;
    }
401
    findAll_helper(search, symbol, context);
402 403 404
}

namespace {
405
class UidSymbolFinder : public SymbolVisitor
406 407
{
public:
408
    UidSymbolFinder(const QList<QByteArray> &uid) : m_uid(uid), m_index(0), m_result(0) { }
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
    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:
437
    QList<QByteArray> m_uid;
438 439 440 441 442
    int m_index;
    Symbol *m_result;
};
}

443
Symbol *CppFindReferences::findSymbol(const CppFindReferencesParameters &parameters,
444
                                      const Snapshot &snapshot, LookupContext *context)
445
{
446 447
    QTC_ASSERT(context, return 0);
    QString symbolFile = QLatin1String(parameters.symbolFileName);
448
    if (!snapshot.contains(symbolFile))
449
        return 0;
450 451 452

    Document::Ptr newSymbolDocument = snapshot.document(symbolFile);
    // document is not parsed and has no bindings yet, do it
453 454
    QByteArray source = getSource(Utils::FileName::fromString(newSymbolDocument->fileName()),
                                  m_modelManager->workingCopy());
455
    Document::Ptr doc =
456
            snapshot.preprocessedDocument(source, newSymbolDocument->fileName());
457 458 459
    doc->check();

    // find matching symbol in new document and return the new parameters
460
    UidSymbolFinder finder(parameters.symbolId);
461 462
    finder.accept(doc->globalNamespace());
    if (finder.result()) {
463 464
        *context = LookupContext(doc, snapshot);
        return finder.result();
465
    }
466
    return 0;
467 468
}

Roberto Raggi's avatar
Roberto Raggi committed
469
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
470
{
471
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
472
    SearchResult *search = m_watchers.value(watcher);
473 474 475
    if (!search) {
        // search was deleted while it was running
        watcher->cancel();
476 477
        return;
    }
Roberto Raggi's avatar
Roberto Raggi committed
478
    for (int index = first; index != last; ++index) {
479 480 481 482 483 484
        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
485
    }
Roberto Raggi's avatar
Roberto Raggi committed
486 487 488 489
}

void CppFindReferences::searchFinished()
{
490
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
491
    SearchResult *search = m_watchers.value(watcher);
492
    if (search)
Eike Ziller's avatar
Eike Ziller committed
493
        search->finishSearch(watcher->isCanceled());
494
    m_watchers.remove(watcher);
Erik Verbruggen's avatar
Erik Verbruggen committed
495
    watcher->deleteLater();
Roberto Raggi's avatar
Roberto Raggi committed
496 497
}

498 499
void CppFindReferences::cancel()
{
500
    SearchResult *search = qobject_cast<SearchResult *>(sender());
501 502 503 504
    QTC_ASSERT(search, return);
    QFutureWatcher<Usage> *watcher = m_watchers.key(search);
    QTC_ASSERT(watcher, return);
    watcher->cancel();
505 506
}

507 508
void CppFindReferences::setPaused(bool paused)
{
509
    SearchResult *search = qobject_cast<SearchResult *>(sender());
510 511 512 513 514 515 516
    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);
}

517
void CppFindReferences::openEditor(const SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
518
{
519
    if (item.path.size() > 0) {
520
        EditorManager::openEditorAt(QDir::fromNativeSeparators(item.path.first()),
Eike Ziller's avatar
Eike Ziller committed
521
                                              item.lineNumber, item.textMarkPos);
522
    } else {
523
        EditorManager::openEditor(QDir::fromNativeSeparators(item.text));
524
    }
Roberto Raggi's avatar
Roberto Raggi committed
525 526
}

Christian Kamm's avatar
Christian Kamm committed
527 528 529 530 531

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
532
    const WorkingCopy workingCopy;
Christian Kamm's avatar
Christian Kamm committed
533 534
    const Snapshot snapshot;
    const Macro &macro;
535
    QFutureInterface<Usage> *future;
Christian Kamm's avatar
Christian Kamm committed
536 537

public:
538
    FindMacroUsesInFile(const WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
539
                        const Snapshot snapshot,
540 541 542
                        const Macro &macro,
                        QFutureInterface<Usage> *future)
        : workingCopy(workingCopy), snapshot(snapshot), macro(macro), future(future)
Christian Kamm's avatar
Christian Kamm committed
543 544
    { }

545
    QList<Usage> operator()(const Utils::FileName &fileName)
Christian Kamm's avatar
Christian Kamm committed
546 547
    {
        QList<Usage> usages;
548
        Document::Ptr doc = snapshot.document(fileName);
549
        QByteArray source;
550

551
restart_search:
552 553
        if (future->isPaused())
            future->waitForResume();
554 555
        if (future->isCanceled())
            return usages;
Christian Kamm's avatar
Christian Kamm committed
556

557
        usages.clear();
Christian Kamm's avatar
Christian Kamm committed
558 559
        foreach (const Document::MacroUse &use, doc->macroUses()) {
            const Macro &useMacro = use.macro();
560 561

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

565 566 567
                if (macro.fileRevision() > useMacro.fileRevision()) {
                    // yes, it is outdated, so re-preprocess and start from scratch for this file.
                    doc = snapshot.preprocessedDocument(source, fileName);
568 569
                    usages.clear();
                    goto restart_search;
570 571
                }

Andre Hartmann's avatar
Andre Hartmann committed
572
                if (macro.name() == useMacro.name()) {
573 574
                    unsigned column;
                    const QString &lineSource = matchingLine(use.bytesBegin(), source, &column);
575
                    usages.append(Usage(fileName.toString(), lineSource, use.beginLine(), column,
576
                                        useMacro.nameToQString().size()));
Andre Hartmann's avatar
Andre Hartmann committed
577
                }
Christian Kamm's avatar
Christian Kamm committed
578 579 580
            }
        }

581 582
        if (future->isPaused())
            future->waitForResume();
Christian Kamm's avatar
Christian Kamm committed
583 584 585
        return usages;
    }

586 587
    static QString matchingLine(unsigned bytesOffsetOfUseStart, const QByteArray &utf8Source,
                                unsigned *columnOfUseStart = 0)
Christian Kamm's avatar
Christian Kamm committed
588
    {
589 590
        int lineBegin = utf8Source.lastIndexOf('\n', bytesOffsetOfUseStart) + 1;
        int lineEnd = utf8Source.indexOf('\n', bytesOffsetOfUseStart);
591
        if (lineEnd == -1)
592 593 594 595 596 597 598 599 600 601 602
            lineEnd = utf8Source.length();

        if (columnOfUseStart) {
            *columnOfUseStart = 0;
            const char *startOfUse = utf8Source.constData() + bytesOffsetOfUseStart;
            QTC_ASSERT(startOfUse < utf8Source.constData() + lineEnd, return QString());
            const char *currentSourceByte = utf8Source.constData() + lineBegin;
            unsigned char yychar = *currentSourceByte;
            while (currentSourceByte != startOfUse)
                Lexer::yyinp_utf8(currentSourceByte, yychar, *columnOfUseStart);
        }
Christian Kamm's avatar
Christian Kamm committed
603

604 605
        const QByteArray matchingLine = utf8Source.mid(lineBegin, lineEnd - lineBegin);
        return QString::fromUtf8(matchingLine, matchingLine.size());
Christian Kamm's avatar
Christian Kamm committed
606 607 608 609 610 611
    }
};

} // end of anonymous namespace

static void findMacroUses_helper(QFutureInterface<Usage> &future,
612
                                 const WorkingCopy workingCopy,
613 614
                                 const Snapshot snapshot,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
615
{
616
    const Utils::FileName sourceFile = Utils::FileName::fromString(macro.fileName());
617 618
    Utils::FileNameList files {sourceFile};
    files = Utils::filteredUnique(files + snapshot.filesDependingOn(sourceFile));
Christian Kamm's avatar
Christian Kamm committed
619 620

    future.setProgressRange(0, files.size());
621
    FindMacroUsesInFile process(workingCopy, snapshot, macro, &future);
Christian Kamm's avatar
Christian Kamm committed
622
    UpdateUI reduce(&future);
623 624 625
    // 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
626
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
627
    QThreadPool::globalInstance()->reserveThread();
Christian Kamm's avatar
Christian Kamm committed
628 629 630 631
    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
632 633 634 635 636
{
    findMacroUses(macro, QString(), false);
}

void CppFindReferences::findMacroUses(const Macro &macro, const QString &replacement, bool replace)
Christian Kamm's avatar
Christian Kamm committed
637
{
638
    SearchResult *search = SearchResultWindow::instance()->startNewSearch(
639 640
                tr("C++ Macro Usages:"),
                QString(),
641
                macro.nameToQString(),
642 643 644
                replace ? SearchResultWindow::SearchAndReplace
                        : SearchResultWindow::SearchOnly,
                SearchResultWindow::PreserveCaseDisabled,
645 646 647
                QLatin1String("CppEditor"));

    search->setTextToReplace(replacement);
648 649
    connect(search, &SearchResult::replaceButtonClicked,
            this, &CppFindReferences::onReplaceButtonClicked);
Christian Kamm's avatar
Christian Kamm committed
650

651
    SearchResultWindow::instance()->popup(IOutputPane::ModeSwitch | IOutputPane::WithFocus);
Christian Kamm's avatar
Christian Kamm committed
652

653 654 655 656
    connect(search, &SearchResult::activated,
            this, &CppFindReferences::openEditor);
    connect(search, &SearchResult::cancelled, this, &CppFindReferences::cancel);
    connect(search, &SearchResult::paused, this, &CppFindReferences::setPaused);
Christian Kamm's avatar
Christian Kamm committed
657

Erik Verbruggen's avatar
Erik Verbruggen committed
658
    const Snapshot snapshot = m_modelManager->snapshot();
659
    const WorkingCopy workingCopy = m_modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
660 661 662

    // add the macro definition itself
    {
663 664
        const QByteArray &source = getSource(Utils::FileName::fromString(macro.fileName()),
                                             workingCopy);
665 666 667 668 669
        unsigned column;
        const QString line = FindMacroUsesInFile::matchingLine(macro.bytesOffset(), source,
                                                               &column);
        search->addResult(macro.fileName(), macro.line(), line, column,
                          macro.nameToQString().length());
Christian Kamm's avatar
Christian Kamm committed
670 671 672
    }

    QFuture<Usage> result;
673 674
    result = Utils::runAsync(m_modelManager->sharedThreadPool(), findMacroUses_helper,
                             workingCopy, snapshot, macro);
675
    createWatcher(result, search);
Christian Kamm's avatar
Christian Kamm committed
676

677
    FutureProgress *progress = ProgressManager::addTask(result, tr("Searching for Usages"),
678
                                                              CppTools::Constants::TASK_SEARCH);
679
    connect(progress, &FutureProgress::clicked, search, &SearchResult::popup);
Christian Kamm's avatar
Christian Kamm committed
680 681
}

682 683
void CppFindReferences::renameMacroUses(const Macro &macro, const QString &replacement)
{
684
    const QString textToReplace = replacement.isEmpty() ? macro.nameToQString() : replacement;
685 686 687
    findMacroUses(macro, textToReplace, true);
}

688
void CppFindReferences::createWatcher(const QFuture<Usage> &future, SearchResult *search)
689 690 691
{
    QFutureWatcher<Usage> *watcher = new QFutureWatcher<Usage>();
    watcher->setPendingResultsLimit(1);
692 693
    connect(watcher, &QFutureWatcherBase::resultsReadyAt, this, &CppFindReferences::displayResults);
    connect(watcher, &QFutureWatcherBase::finished, this, &CppFindReferences::searchFinished);
694
    m_watchers.insert(watcher, search);
Eike Ziller's avatar
Eike Ziller committed
695
    watcher->setFuture(future);
696
}