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

#include "cppfindreferences.h"
#include "cpptoolsconstants.h"

#include <texteditor/basetexteditor.h>
34
#include <texteditor/basefilefind.h>
Roberto Raggi's avatar
Roberto Raggi committed
35 36 37
#include <find/searchresultwindow.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
38
#include <utils/fileutils.h>
39
#include <utils/qtcassert.h>
Roberto Raggi's avatar
Roberto Raggi committed
40
#include <coreplugin/progressmanager/progressmanager.h>
41
#include <coreplugin/progressmanager/futureprogress.h>
42
#include <coreplugin/editormanager/editormanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
43
#include <coreplugin/icore.h>
44
#include <coreplugin/infobar.h>
Roberto Raggi's avatar
Roberto Raggi committed
45 46 47 48 49 50 51

#include <ASTVisitor.h>
#include <AST.h>
#include <Control.h>
#include <Literals.h>
#include <TranslationUnit.h>
#include <Symbols.h>
52 53
#include <Names.h>
#include <Scope.h>
Roberto Raggi's avatar
Roberto Raggi committed
54

55
#include <cpptools/ModelManagerInterface.h>
Roberto Raggi's avatar
Roberto Raggi committed
56
#include <cplusplus/CppDocument.h>
57
#include <cplusplus/Overview.h>
58
#include <cplusplus/FindUsages.h>
Roberto Raggi's avatar
Roberto Raggi committed
59

60 61 62 63 64 65
#include <QTime>
#include <QTimer>
#include <QtConcurrentRun>
#include <QtConcurrentMap>
#include <QDir>
#include <QApplication>
66
#include <utils/runextensions.h>
67
#include <utils/textfileformat.h>
Roberto Raggi's avatar
Roberto Raggi committed
68

69 70
#include <functional>

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

Christian Kamm's avatar
Christian Kamm committed
74
static QString getSource(const QString &fileName,
75
                         const CppModelManagerInterface::WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
76 77 78 79
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
80 81 82 83 84 85 86 87
        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
88

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CppFindReferences::~CppFindReferences()
{
}

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

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

    return references;
}

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

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

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

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

            Control *control = doc->control();

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

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

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

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

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

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

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

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

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

Roberto Raggi's avatar
Roberto Raggi committed
307 308 309
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
310 311 312
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    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 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 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
        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:
    SymbolFinder(const QStringList &uid) : m_uid(uid), m_index(0), m_result(0) { }
    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:
    QStringList m_uid;
    int m_index;
    Symbol *m_result;
};
}

bool CppFindReferences::findSymbol(CppFindReferencesParameters *parameters,
                                      const Snapshot &snapshot)
{
    QString symbolFile = QLatin1String(parameters->symbol->fileName());
    if (!snapshot.contains(symbolFile)) {
        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());
    const QByteArray &preprocessedCode =
            snapshot.preprocessedCode(source, newSymbolDocument->fileName());
    Document::Ptr doc =
            snapshot.documentFromSource(preprocessedCode, newSymbolDocument->fileName());
    doc->check();

    // construct id of old symbol
    QStringList uid;
    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
485
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
486
{
487 488 489 490 491
    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();
492 493
        return;
    }
Roberto Raggi's avatar
Roberto Raggi committed
494
    for (int index = first; index != last; ++index) {
495 496 497 498 499 500
        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
501
    }
Roberto Raggi's avatar
Roberto Raggi committed
502 503 504 505
}

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

513 514
void CppFindReferences::cancel()
{
515 516 517 518 519
    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();
520 521
}

522 523 524 525 526 527 528 529 530 531
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);
}

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

Christian Kamm's avatar
Christian Kamm committed
545 546 547 548 549

namespace {

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

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

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
566 567
        if (future->isPaused())
            future->waitForResume();
568 569
        if (future->isCanceled())
            return usages;
Christian Kamm's avatar
Christian Kamm committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584

        const Document::Ptr &doc = snapshot.document(fileName);
        QByteArray source;

        foreach (const Document::MacroUse &use, doc->macroUses()) {
            const Macro &useMacro = use.macro();
            if (useMacro.line() == macro.line()
                && useMacro.fileName() == macro.fileName())
                {
                if (source.isEmpty())
                    source = getSource(fileName, workingCopy).toLatin1(); // ### FIXME: Encoding?

                unsigned lineStart;
                const QString &lineSource = matchingLine(use.begin(), source, &lineStart);
                usages.append(Usage(fileName, lineSource, use.beginLine(),
585
                                    use.begin() - lineStart, useMacro.name().length()));
Christian Kamm's avatar
Christian Kamm committed
586 587 588
            }
        }

589 590
        if (future->isPaused())
            future->waitForResume();
Christian Kamm's avatar
Christian Kamm committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
        return usages;
    }

    // ### FIXME: Pretty close to FindUsages::matchingLine.
    static QString matchingLine(unsigned position, const QByteArray &source,
                                unsigned *lineStart = 0)
    {
        const char *beg = source.constData();
        const char *start = beg + position;
        for (; start != beg - 1; --start) {
            if (*start == '\n')
                break;
        }

        ++start;

        const char *end = start + 1;
        for (; *end; ++end) {
            if (*end == '\n')
                break;
        }

        if (lineStart)
            *lineStart = start - beg;

        // ### FIXME: Encoding?
        const QString matchingLine = QString::fromUtf8(start, end - start);
        return matchingLine;
    }
};

} // end of anonymous namespace

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

Christian Kamm's avatar
Christian Kamm committed
633 634
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
635
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
636 637 638 639
    files.removeDuplicates();

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

640
    FindMacroUsesInFile process(workingCopy, snapshot, macro, &future);
Christian Kamm's avatar
Christian Kamm committed
641
    UpdateUI reduce(&future);
642 643 644
    // 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
645
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
646
    QThreadPool::globalInstance()->reserveThread();
Christian Kamm's avatar
Christian Kamm committed
647 648 649 650
    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
651 652 653 654 655
{
    findMacroUses(macro, QString(), false);
}

void CppFindReferences::findMacroUses(const Macro &macro, const QString &replacement, bool replace)
Christian Kamm's avatar
Christian Kamm committed
656
{
657
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(
658 659 660
                tr("C++ Macro Usages:"),
                QString(),
                macro.name(),
661 662 663 664 665 666 667
                replace ? Find::SearchResultWindow::SearchAndReplace
                        : Find::SearchResultWindow::SearchOnly,
                QLatin1String("CppEditor"));

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

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

671
    connect(search, SIGNAL(activated(Find::SearchResultItem)),
Christian Kamm's avatar
Christian Kamm committed
672
            this, SLOT(openEditor(Find::SearchResultItem)));
673
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
674
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
Christian Kamm's avatar
Christian Kamm committed
675 676

    const Snapshot snapshot = _modelManager->snapshot();
677
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
678 679 680 681 682

    // add the macro definition itself
    {
        // ### FIXME: Encoding?
        const QByteArray &source = getSource(macro.fileName(), workingCopy).toLatin1();
683 684 685 686 687
        int lineBegin = source.lastIndexOf('\n', macro.offset()) + 1;
        int lineEnd = source.indexOf('\n', macro.offset());
        if (lineEnd == -1)
            lineEnd = source.length();
        const QByteArray line = source.mid(lineBegin, lineEnd - lineBegin);
688
        search->addResult(macro.fileName(), macro.line(), line,
689
                          line.indexOf(macro.name()), macro.name().length());
Christian Kamm's avatar
Christian Kamm committed
690 691 692
    }

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

hjk's avatar
hjk committed
696
    Core::ProgressManager *progressManager = Core::ICore::progressManager();
697
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
698
                                                              CppTools::Constants::TASK_SEARCH);
699
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
Christian Kamm's avatar
Christian Kamm committed
700 701
}

702 703 704 705 706 707
void CppFindReferences::renameMacroUses(const Macro &macro, const QString &replacement)
{
    const QString textToReplace = replacement.isEmpty() ? macro.name() : replacement;
    findMacroUses(macro, textToReplace, true);
}

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
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;
}
733 734 735 736 737 738 739 740

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
741
    watcher->setFuture(future);
742
}