cppfindreferences.cpp 26.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Roberto Raggi's avatar
Roberto Raggi committed
2
**
3
** Copyright (C) 2013 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 "ModelManagerInterface.h"
Roberto Raggi's avatar
Roberto Raggi committed
34

35 36 37 38 39
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/icore.h>
#include <coreplugin/infobar.h>
#include <coreplugin/progressmanager/futureprogress.h>
#include <coreplugin/progressmanager/progressmanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
40
#include <find/searchresultwindow.h>
41 42 43
#include <texteditor/basefilefind.h>
#include <texteditor/basetexteditor.h>

Roberto Raggi's avatar
Roberto Raggi committed
44 45
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
46
#include <utils/fileutils.h>
47
#include <utils/qtcassert.h>
48 49
#include <utils/runextensions.h>
#include <utils/textfileformat.h>
Roberto Raggi's avatar
Roberto Raggi committed
50

51 52 53
#include <cplusplus/AST.h>
#include <cplusplus/ASTVisitor.h>
#include <cplusplus/Control.h>
Roberto Raggi's avatar
Roberto Raggi committed
54
#include <cplusplus/CppDocument.h>
55
#include <cplusplus/FindUsages.h>
56 57 58 59 60 61
#include <cplusplus/Literals.h>
#include <cplusplus/Names.h>
#include <cplusplus/Overview.h>
#include <cplusplus/Scope.h>
#include <cplusplus/Symbols.h>
#include <cplusplus/TranslationUnit.h>
Roberto Raggi's avatar
Roberto Raggi committed
62

63 64 65 66 67 68
#include <QTime>
#include <QTimer>
#include <QtConcurrentRun>
#include <QtConcurrentMap>
#include <QDir>
#include <QApplication>
Roberto Raggi's avatar
Roberto Raggi committed
69

70 71
#include <functional>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CppFindReferences::~CppFindReferences()
{
}

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

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

    return references;
}

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

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

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

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

            Control *control = doc->control();

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

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

230
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol, &future);
Roberto Raggi's avatar
Roberto Raggi committed
231
    UpdateUI reduce(&future);
232 233 234
    // 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();
235
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
236
    QThreadPool::globalInstance()->reserveThread();
Roberto Raggi's avatar
Roberto Raggi committed
237 238 239
    future.setProgressValue(files.size());
}

240 241 242 243 244 245 246 247 248 249
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)
250
{
251
    Overview overview;
252
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
253
                                                QString(),
254
                                                overview.prettyName(context.fullyQualifiedName(symbol)),
255 256 257 258
                                                replace ? Find::SearchResultWindow::SearchAndReplace
                                                        : Find::SearchResultWindow::SearchOnly,
                                                QLatin1String("CppEditor"));
    search->setTextToReplace(replacement);
259 260
    connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>,bool)),
            SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>,bool)));
261
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
262 263 264 265 266 267 268
    search->setSearchAgainSupported(true);
    connect(search, SIGNAL(searchAgainRequested()), this, SLOT(searchAgain()));
    CppFindReferencesParameters parameters;
    parameters.context = context;
    parameters.symbol = symbol;
    search->setUserData(qVariantFromValue(parameters));
    findAll_helper(search);
269 270
}

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

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

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

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

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

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

317 318 319 320 321
void CppFindReferences::searchAgain()
{
    Find::SearchResult *search = qobject_cast<Find::SearchResult *>(sender());
    CppFindReferencesParameters parameters = search->userData().value<CppFindReferencesParameters>();
    Snapshot snapshot = CppModelManagerInterface::instance()->snapshot();
Eike Ziller's avatar
Eike Ziller committed
322
    search->restart();
323
    if (!findSymbol(&parameters, snapshot)) {
Eike Ziller's avatar
Eike Ziller committed
324
        search->finishSearch(false);
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        return;
    }
    search->setUserData(qVariantFromValue(parameters));
    findAll_helper(search);
}

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

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

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

bool CppFindReferences::findSymbol(CppFindReferencesParameters *parameters,
                                      const Snapshot &snapshot)
{
    QString symbolFile = QLatin1String(parameters->symbol->fileName());
454
    if (!snapshot.contains(symbolFile))
455 456 457 458 459 460
        return false;

    Document::Ptr newSymbolDocument = snapshot.document(symbolFile);
    // document is not parsed and has no bindings yet, do it
    QString source = getSource(newSymbolDocument->fileName(), _modelManager->workingCopy());
    Document::Ptr doc =
461
            snapshot.preprocessedDocument(source, newSymbolDocument->fileName());
462 463 464
    doc->check();

    // construct id of old symbol
465
    QList<QByteArray> uid;
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
    Symbol *current = parameters->symbol;
    do {
        uid.prepend(idForSymbol(current));
        current = current->enclosingScope();
    } while (current);
    // find matching symbol in new document and return the new parameters
    SymbolFinder finder(uid);
    finder.accept(doc->globalNamespace());
    if (finder.result()) {
        parameters->symbol = finder.result();
        parameters->context = LookupContext(doc, snapshot);
        return true;
    }
    return false;
}

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

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

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

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

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

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

namespace {

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

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

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

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

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

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

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

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

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

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

        if (lineStart)
610
            *lineStart = lineBegin;
Christian Kamm's avatar
Christian Kamm committed
611

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

} // end of anonymous namespace

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

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

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

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

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

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

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

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

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

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

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

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

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

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
DependencyTable CppFindReferences::updateDependencyTable(CPlusPlus::Snapshot snapshot)
{
    DependencyTable oldDeps = dependencyTable();
    if (oldDeps.isValidFor(snapshot))
        return oldDeps;

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

DependencyTable CppFindReferences::dependencyTable() const
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    return m_deps;
}

void CppFindReferences::setDependencyTable(const CPlusPlus::DependencyTable &newTable)
{
    QMutexLocker locker(&m_depsLock);
    Q_UNUSED(locker);
    m_deps = newTable;
}
723 724 725 726 727 728 729 730

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