cppfindreferences.cpp 25.1 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** 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

#include "cppfindreferences.h"
31

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

36
#include <coreplugin/editormanager/editormanager.h>
37 38 39 40 41
#include <coreplugin/icore.h>
#include <coreplugin/progressmanager/futureprogress.h>
#include <coreplugin/progressmanager/progressmanager.h>
#include <texteditor/basefilefind.h>

42
#include <utils/qtcassert.h>
43 44
#include <utils/runextensions.h>
#include <utils/textfileformat.h>
Roberto Raggi's avatar
Roberto Raggi committed
45

46
#include <cplusplus/Overview.h>
47 48
#include <QtConcurrentMap>
#include <QDir>
Roberto Raggi's avatar
Roberto Raggi committed
49

50 51
#include <functional>

52
using namespace Core;
Roberto Raggi's avatar
Roberto Raggi committed
53
using namespace CppTools::Internal;
54
using namespace CppTools;
Roberto Raggi's avatar
Roberto Raggi committed
55 56
using namespace CPlusPlus;

57
static QByteArray getSource(const QString &fileName,
58
                            const WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
59 60 61 62
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
63 64 65
        QString fileContents;
        Utils::TextFileFormat format;
        QString error;
66
        QTextCodec *defaultCodec = EditorManager::defaultTextCodec();
67 68 69 70
        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
71

72
        return fileContents.toUtf8();
Christian Kamm's avatar
Christian Kamm committed
73 74 75
    }
}

76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
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;
99
        temp.append(pretty.prettyType(symbol->type()).toUtf8());
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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
        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;
}

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
167
namespace {
168

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

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

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
193 194
        if (future->isPaused())
            future->waitForResume();
195 196
        if (future->isCanceled())
            return usages;
197 198
        const Identifier *symbolId = symbol->identifier();

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

207
        if (symbolDocument && fileName == symbolDocument->fileName()) {
208
            doc = symbolDocument;
209
        } else {
210
            doc = snapshot.preprocessedDocument(unpreprocessedSource, fileName);
211 212
            doc->tokenize();
        }
213 214 215

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

219
            FindUsages process(unpreprocessedSource, doc, snapshot);
220
            process(symbol);
221

222 223 224
            usages = process.usages();
        }

225 226
        if (future->isPaused())
            future->waitForResume();
227 228 229 230
        return usages;
    }
};

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

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

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

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

Roberto Raggi's avatar
Roberto Raggi committed
247 248
} // end of anonymous namespace

249
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
250
    : QObject(modelManager),
Erik Verbruggen's avatar
Erik Verbruggen committed
251
      m_modelManager(modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
252 253 254 255 256 257 258
{
}

CppFindReferences::~CppFindReferences()
{
}

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

263
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
264 265 266 267 268 269
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

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

278 279
    const Snapshot snapshot = context.snapshot();

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

283 284 285 286 287
    if (symbol->isClass()
        || symbol->isForwardClassDeclaration()
        || (symbol->enclosingScope()
            && !symbol->isStatic()
            && symbol->enclosingScope()->isNamespace())) {
288
        foreach (const Document::Ptr &doc, context.snapshot()) {
289 290 291 292 293 294 295 296 297
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
298
        files += snapshot.filesDependingOn(sourceFile);
299
    }
300
    files.removeDuplicates();
Roberto Raggi's avatar
Roberto Raggi committed
301 302 303

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

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

314 315 316 317 318 319 320 321 322 323
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)
324
{
325
    Overview overview;
326
    Core::SearchResult *search = Core::SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
327
                                                QString(),
328
                                                overview.prettyName(context.fullyQualifiedName(symbol)),
329 330
                                                replace ? Core::SearchResultWindow::SearchAndReplace
                                                        : Core::SearchResultWindow::SearchOnly,
331
                                                Core::SearchResultWindow::PreserveCaseDisabled,
332 333
                                                QLatin1String("CppEditor"));
    search->setTextToReplace(replacement);
334 335
    connect(search, SIGNAL(replaceButtonClicked(QString,QList<Core::SearchResultItem>,bool)),
            SLOT(onReplaceButtonClicked(QString,QList<Core::SearchResultItem>,bool)));
336
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
337 338 339
    search->setSearchAgainSupported(true);
    connect(search, SIGNAL(searchAgainRequested()), this, SLOT(searchAgain()));
    CppFindReferencesParameters parameters;
340 341
    parameters.symbolId = fullIdForSymbol(symbol);
    parameters.symbolFileName = QByteArray(symbol->fileName());
342
    search->setUserData(qVariantFromValue(parameters));
343
    findAll_helper(search, symbol, context);
344 345
}

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

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

367
    Core::SearchResultWindow::instance()->popup(IOutputPane::ModeSwitch | IOutputPane::WithFocus);
368
    const WorkingCopy workingCopy = m_modelManager->workingCopy();
Roberto Raggi's avatar
Roberto Raggi committed
369
    QFuture<Usage> result;
370
    result = QtConcurrent::run(&find_helper, workingCopy, context, symbol);
371 372
    createWatcher(result, search);

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

376
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Roberto Raggi's avatar
Roberto Raggi committed
377 378
}

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

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

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

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

    Document::Ptr newSymbolDocument = snapshot.document(symbolFile);
    // document is not parsed and has no bindings yet, do it
Erik Verbruggen's avatar
Erik Verbruggen committed
454
    QByteArray source = getSource(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
    SymbolFinder 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
    Core::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
    Core::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
    Core::SearchResult *search = qobject_cast<Core::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
    Core::SearchResult *search = qobject_cast<Core::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 Core::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 546 547
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        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 575 576
                    unsigned column;
                    const QString &lineSource = matchingLine(use.bytesBegin(), source, &column);
                    usages.append(Usage(fileName, lineSource, use.beginLine(), column,
                                        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 617
{
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
618
    files += snapshot.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
619 620 621
    files.removeDuplicates();

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

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

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

    search->setTextToReplace(replacement);
649 650
    connect(search, SIGNAL(replaceButtonClicked(QString,QList<Core::SearchResultItem>,bool)),
            SLOT(onReplaceButtonClicked(QString,QList<Core::SearchResultItem>,bool)));
Christian Kamm's avatar
Christian Kamm committed
651

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

654 655
    connect(search, SIGNAL(activated(Core::SearchResultItem)),
            this, SLOT(openEditor(Core::SearchResultItem)));
656
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
657
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
Christian Kamm's avatar
Christian Kamm committed
658

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

    // add the macro definition itself
    {
664
        const QByteArray &source = getSource(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
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, macro);
674
    createWatcher(result, search);
Christian Kamm's avatar
Christian Kamm committed
675

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

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

687
void CppFindReferences::createWatcher(const QFuture<Usage> &future, Core::SearchResult *search)
688 689 690 691 692 693
{
    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
694
    watcher->setFuture(future);
695
}