cppfindreferences.cpp 26.3 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;
}

167
namespace {
168

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;
    }
};

231
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
232 233 234 235
{
    QFutureInterface<Usage> *future;

public:
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);
    }
};

247 248
} // end of anonymous namespace

249
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
250
    : QObject(modelManager),
251
      m_modelManager(modelManager)
252
{
253
    connect(modelManager, SIGNAL(globalSnapshotChanged()), this, SLOT(flushDependencyTable()));
254 255 256 257 258 259
}

CppFindReferences::~CppFindReferences()
{
}

260
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
261 262 263
{
    QList<int> references;

264
    FindUsages findUsages(context);
265 266 267 268 269 270
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

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

280 281
    const Snapshot snapshot = context.snapshot();

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

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

            Control *control = doc->control();

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

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

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

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

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

359
void CppFindReferences::findAll_helper(Core::SearchResult *search, CPlusPlus::Symbol *symbol,
360
                                       const CPlusPlus::LookupContext &context)
361
{
362
    if (!(symbol && symbol->identifier())) {
363
        search->finishSearch(false);
364
        return;
365 366
    }
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
367 368
    connect(search, SIGNAL(activated(Core::SearchResultItem)),
            this, SLOT(openEditor(Core::SearchResultItem)));
369

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

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

379
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Roberto Raggi's avatar
Roberto Raggi committed
380 381
}

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

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

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

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

    Document::Ptr newSymbolDocument = snapshot.document(symbolFile);
    // document is not parsed and has no bindings yet, do it
457
    QByteArray source = getSource(newSymbolDocument->fileName(), m_modelManager->workingCopy());
458
    Document::Ptr doc =
459
            snapshot.preprocessedDocument(source, newSymbolDocument->fileName());
460 461 462
    doc->check();

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

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

void CppFindReferences::searchFinished()
{
493
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
494
    Core::SearchResult *search = m_watchers.value(watcher);
495
    if (search)
496
        search->finishSearch(watcher->isCanceled());
497
    m_watchers.remove(watcher);
498
    watcher->deleteLater();
Roberto Raggi's avatar
Roberto Raggi committed
499 500
}

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

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

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

Christian Kamm's avatar
Christian Kamm committed
530 531 532 533 534

namespace {

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

public:
541
    FindMacroUsesInFile(const WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
542
                        const Snapshot snapshot,
543 544 545
                        const Macro &macro,
                        QFutureInterface<Usage> *future)
        : workingCopy(workingCopy), snapshot(snapshot), macro(macro), future(future)
Christian Kamm's avatar
Christian Kamm committed
546 547 548 549 550
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
551
        Document::Ptr doc = snapshot.document(fileName);
552
        QByteArray source;
553

554
restart_search:
555 556
        if (future->isPaused())
            future->waitForResume();
557 558
        if (future->isCanceled())
            return usages;
Christian Kamm's avatar
Christian Kamm committed
559

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

            if (useMacro.fileName() == macro.fileName()) { // Check if this is a match, but possibly against an outdated document.
565 566 567
                if (source.isEmpty())
                    source = getSource(fileName, workingCopy);

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

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

584 585
        if (future->isPaused())
            future->waitForResume();
Christian Kamm's avatar
Christian Kamm committed
586 587 588
        return usages;
    }

589 590
    static QString matchingLine(unsigned bytesOffsetOfUseStart, const QByteArray &utf8Source,
                                unsigned *columnOfUseStart = 0)
Christian Kamm's avatar
Christian Kamm committed
591
    {
592 593
        int lineBegin = utf8Source.lastIndexOf('\n', bytesOffsetOfUseStart) + 1;
        int lineEnd = utf8Source.indexOf('\n', bytesOffsetOfUseStart);
594
        if (lineEnd == -1)
595 596 597 598 599 600 601 602 603 604 605
            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
606

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

} // end of anonymous namespace

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

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

    future.setProgressRange(0, files.size());
629
    FindMacroUsesInFile process(workingCopy, snapshot, macro, &future);
Christian Kamm's avatar
Christian Kamm committed
630
    UpdateUI reduce(&future);
631 632 633
    // 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
634
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
635
    QThreadPool::globalInstance()->reserveThread();
Christian Kamm's avatar
Christian Kamm committed
636 637 638 639
    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
640 641 642 643 644
{
    findMacroUses(macro, QString(), false);
}

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

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

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

661 662
    connect(search, SIGNAL(activated(Core::SearchResultItem)),
            this, SLOT(openEditor(Core::SearchResultItem)));
663
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
664
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
Christian Kamm's avatar
Christian Kamm committed
665

666
    const Snapshot snapshot = m_modelManager->snapshot();
667
    const WorkingCopy workingCopy = m_modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
668 669 670

    // add the macro definition itself
    {
671
        const QByteArray &source = getSource(macro.fileName(), workingCopy);
672 673 674 675 676
        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
677 678 679
    }

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

683
    FutureProgress *progress = ProgressManager::addTask(result, tr("Searching for Usages"),
684
                                                              CppTools::Constants::TASK_SEARCH);
685
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Christian Kamm's avatar
Christian Kamm committed
686 687
}

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

694 695 696 697 698 699 700 701 702 703 704 705
DependencyTable CppFindReferences::updateDependencyTable(CPlusPlus::Snapshot snapshot)
{
    DependencyTable oldDeps = dependencyTable();
    if (oldDeps.isValidFor(snapshot))
        return oldDeps;

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

706 707 708 709 710 711 712
void CppFindReferences::flushDependencyTable()
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    m_deps = DependencyTable();
}

713 714 715 716 717 718 719 720 721 722 723 724 725
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;
}
726

727
void CppFindReferences::createWatcher(const QFuture<Usage> &future, Core::SearchResult *search)
728 729 730 731 732 733
{
    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
734
    watcher->setFuture(future);
735
}