cppfindreferences.cpp 26 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"
Roberto Raggi's avatar
Roberto Raggi committed
34

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

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

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

49 50
#include <functional>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

248
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
249
    : QObject(modelManager),
Erik Verbruggen's avatar
Erik Verbruggen committed
250
      m_modelManager(modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
251
{
Erik Verbruggen's avatar
Erik Verbruggen committed
252
    connect(modelManager, SIGNAL(globalSnapshotChanged()), this, SLOT(flushDependencyTable()));
Roberto Raggi's avatar
Roberto Raggi committed
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 CppModelManagerInterface::WorkingCopy workingCopy,
272
                        const LookupContext context,
273
                        CppFindReferences *findRefs,
274
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
275
{
Roberto Raggi's avatar
Roberto Raggi committed
276
    const Identifier *symbolId = symbol->identifier();
277
    QTC_ASSERT(symbolId != 0, return);
278

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

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

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

            Control *control = doc->control();

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

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

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

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

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

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

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

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

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

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

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

namespace {
class SymbolFinder : public SymbolVisitor
{
public:
411
    SymbolFinder(const QList<QByteArray> &uid) : m_uid(uid), m_index(0), m_result(0) { }
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
    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:
440
    QList<QByteArray> m_uid;
441 442 443 444 445
    int m_index;
    Symbol *m_result;
};
}

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

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

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

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

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

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

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

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

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

namespace {

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

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

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

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

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

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

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

Andre Hartmann's avatar
Andre Hartmann committed
574 575
                if (macro.name() == useMacro.name()) {
                    unsigned lineStart;
576 577
                    const QByteArray &lineSource = matchingLine(use.begin(), source, &lineStart);
                    usages.append(Usage(fileName, QString::fromUtf8(lineSource), use.beginLine(),
Andre Hartmann's avatar
Andre Hartmann committed
578 579
                                        use.begin() - lineStart, useMacro.name().length()));
                }
Christian Kamm's avatar
Christian Kamm committed
580 581 582
            }
        }

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

588 589
    static QByteArray matchingLine(unsigned position, const QByteArray &source,
                                   unsigned *lineStart = 0)
Christian Kamm's avatar
Christian Kamm committed
590
    {
591 592
        int lineBegin = source.lastIndexOf('\n', position) + 1;
        int lineEnd = source.indexOf('\n', position);
593 594
        if (lineEnd == -1)
            lineEnd = source.length();
Christian Kamm's avatar
Christian Kamm committed
595 596

        if (lineStart)
597
            *lineStart = lineBegin;
Christian Kamm's avatar
Christian Kamm committed
598

599
        const QByteArray matchingLine = source.mid(lineBegin, lineEnd - lineBegin);
Christian Kamm's avatar
Christian Kamm committed
600 601 602 603 604 605 606
        return matchingLine;
    }
};

} // end of anonymous namespace

static void findMacroUses_helper(QFutureInterface<Usage> &future,
607
                                 const CppModelManagerInterface::WorkingCopy workingCopy,
608 609 610
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
611
{
612 613 614
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
615 616
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
617
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
618 619 620
    files.removeDuplicates();

    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
    Core::SearchResult *search = Core::SearchResultWindow::instance()->startNewSearch(
639 640
                tr("C++ Macro Usages:"),
                QString(),
641
                QString::fromUtf8(macro.name()),
642 643
                replace ? Core::SearchResultWindow::SearchAndReplace
                        : Core::SearchResultWindow::SearchOnly,
644
                Core::SearchResultWindow::PreserveCaseDisabled,
645 646 647
                QLatin1String("CppEditor"));

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

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

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

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

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

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

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

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

686 687 688 689 690 691 692 693 694 695 696 697
DependencyTable CppFindReferences::updateDependencyTable(CPlusPlus::Snapshot snapshot)
{
    DependencyTable oldDeps = dependencyTable();
    if (oldDeps.isValidFor(snapshot))
        return oldDeps;

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

Erik Verbruggen's avatar
Erik Verbruggen committed
698 699 700 701 702 703 704
void CppFindReferences::flushDependencyTable()
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    m_deps = DependencyTable();
}

705 706 707 708 709 710 711 712 713 714 715 716 717
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;
}
718

719
void CppFindReferences::createWatcher(const QFuture<Usage> &future, Core::SearchResult *search)
720 721 722 723 724 725
{
    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
726
    watcher->setFuture(future);
727
}