cppfindreferences.cpp 17.1 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Roberto Raggi's avatar
Roberto Raggi committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
Roberto Raggi's avatar
Roberto Raggi committed
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
Roberto Raggi's avatar
Roberto Raggi committed
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
Roberto Raggi's avatar
Roberto Raggi committed
30 31 32 33 34 35 36
**
**************************************************************************/

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

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

#include <ASTVisitor.h>
#include <AST.h>
#include <Control.h>
#include <Literals.h>
#include <TranslationUnit.h>
#include <Symbols.h>
55 56
#include <Names.h>
#include <Scope.h>
Roberto Raggi's avatar
Roberto Raggi committed
57

58
#include <cplusplus/ModelManagerInterface.h>
Roberto Raggi's avatar
Roberto Raggi committed
59
#include <cplusplus/CppDocument.h>
60
#include <cplusplus/Overview.h>
61
#include <cplusplus/FindUsages.h>
Roberto Raggi's avatar
Roberto Raggi committed
62 63

#include <QtCore/QTime>
64
#include <QtCore/QTimer>
Roberto Raggi's avatar
Roberto Raggi committed
65
#include <QtCore/QtConcurrentRun>
66
#include <QtCore/QtConcurrentMap>
Roberto Raggi's avatar
Roberto Raggi committed
67
#include <QtCore/QDir>
68
#include <QtGui/QApplication>
Roberto Raggi's avatar
Roberto Raggi committed
69 70
#include <qtconcurrent/runextensions.h>

71 72
#include <functional>

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

Christian Kamm's avatar
Christian Kamm committed
76
static QString getSource(const QString &fileName,
77
                         const CppModelManagerInterface::WorkingCopy &workingCopy)
Christian Kamm's avatar
Christian Kamm committed
78 79 80 81
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
82
        Utils::FileReader reader;
83
        if (!reader.fetch(fileName, QFile::Text)) // ### FIXME error reporting
Christian Kamm's avatar
Christian Kamm committed
84 85
            return QString();

86
        return QString::fromLocal8Bit(reader.data()); // ### FIXME encoding
Christian Kamm's avatar
Christian Kamm committed
87 88 89
    }
}

90
namespace {
91

92
class ProcessFile: public std::unary_function<QString, QList<Usage> >
93
{
94
    const CppModelManagerInterface::WorkingCopy workingCopy;
95
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
96
    Document::Ptr symbolDocument;
97 98 99
    Symbol *symbol;

public:
100
    ProcessFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
101
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
102
                Document::Ptr symbolDocument,
103
                Symbol *symbol)
Erik Verbruggen's avatar
Erik Verbruggen committed
104
        : workingCopy(workingCopy), snapshot(snapshot), symbolDocument(symbolDocument), symbol(symbol)
105 106 107 108 109 110 111
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;
        const Identifier *symbolId = symbol->identifier();

112
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
113 114 115 116 117
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }

118 119
        Document::Ptr doc;
        QByteArray source;
120
        const QString unpreprocessedSource = getSource(fileName, workingCopy);
121

122 123 124
        if (symbolDocument && fileName == symbolDocument->fileName())
            doc = symbolDocument;
        else {
125
            source = snapshot.preprocessedCode(unpreprocessedSource, fileName);
126 127 128
            doc = snapshot.documentFromSource(source, fileName);
            doc->tokenize();
        }
129 130 131

        Control *control = doc->control();
        if (control->findIdentifier(symbolId->chars(), symbolId->size()) != 0) {
132 133
            if (doc != symbolDocument)
                doc->check();
134

135
            FindUsages process(unpreprocessedSource.toUtf8(), doc, snapshot);
136
            process(symbol);
137

138 139 140 141 142 143 144
            usages = process.usages();
        }

        return usages;
    }
};

145
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
146 147 148 149
{
    QFutureInterface<Usage> *future;

public:
150
    UpdateUI(QFutureInterface<Usage> *future): future(future) {}
151

152
    void operator()(QList<Usage> &, const QList<Usage> &usages)
153 154 155 156 157 158 159 160
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

161 162
} // end of anonymous namespace

163
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
164
    : QObject(modelManager),
165
      _modelManager(modelManager)
166 167 168 169 170 171 172
{
}

CppFindReferences::~CppFindReferences()
{
}

173
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
174 175 176
{
    QList<int> references;

177
    FindUsages findUsages(context);
178 179 180 181 182 183
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

184
static void find_helper(QFutureInterface<Usage> &future,
185
                        const CppModelManagerInterface::WorkingCopy workingCopy,
186
                        const LookupContext context,
187
                        CppFindReferences *findRefs,
188
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
189
{
Roberto Raggi's avatar
Roberto Raggi committed
190
    const Identifier *symbolId = symbol->identifier();
191 192
    Q_ASSERT(symbolId != 0);

193 194
    const Snapshot snapshot = context.snapshot();

Roberto Raggi's avatar
Roberto Raggi committed
195 196
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
    QStringList files(sourceFile);
197

198 199
    if (symbol->isClass() || symbol->isForwardClassDeclaration() || (symbol->enclosingScope() && ! symbol->isStatic() &&
                                                                     symbol->enclosingScope()->isNamespace())) {
200
        foreach (const Document::Ptr &doc, context.snapshot()) {
201 202 203 204 205 206 207 208 209
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
210
        DependencyTable dependencyTable = findRefs->updateDependencyTable(snapshot);
211
        files += dependencyTable.filesDependingOn(sourceFile);
212
    }
213
    files.removeDuplicates();
Roberto Raggi's avatar
Roberto Raggi committed
214 215 216

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

217
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol);
218
    UpdateUI reduce(&future);
219
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
Roberto Raggi's avatar
Roberto Raggi committed
220 221 222
    future.setProgressValue(files.size());
}

223
void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
224
{
225
    Overview overview;
226
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
227 228 229
                                                QString(),
                                                overview(context.fullyQualifiedName(symbol)),
                                                Find::SearchResultWindow::SearchOnly);
230
    findAll_helper(search, symbol, context);
231 232
}

233 234
void CppFindReferences::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                     const QString &replacement)
Roberto Raggi's avatar
Roberto Raggi committed
235
{
Roberto Raggi's avatar
Roberto Raggi committed
236
    if (const Identifier *id = symbol->identifier()) {
237 238
        const QString textToReplace = replacement.isEmpty()
                ? QString::fromUtf8(id->chars(), id->size()) : replacement;
Roberto Raggi's avatar
Roberto Raggi committed
239

240
        Overview overview;
241
        Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(
242 243 244 245
                    tr("C++ Usages:"),
                    QString(),
                    overview(context.fullyQualifiedName(symbol)),
                    Find::SearchResultWindow::SearchAndReplace, QLatin1String("CppEditor"));
246
        search->setTextToReplace(textToReplace);
Roberto Raggi's avatar
Roberto Raggi committed
247

248
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
249 250
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

251
        findAll_helper(search, symbol, context);
252
    }
253 254
}

255 256
void CppFindReferences::findAll_helper(Find::SearchResult *search,
                                       Symbol *symbol, const LookupContext &context)
257
{
258 259
    if (! (symbol && symbol->identifier())) {
        search->finishSearch();
260
        return;
261 262 263 264
    }
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));
265

266
    Find::SearchResultWindow::instance()->popup(true);
267
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Roberto Raggi's avatar
Roberto Raggi committed
268
    QFuture<Usage> result;
269
    result = QtConcurrent::run(&find_helper, workingCopy, context, this, symbol);
270 271 272
    createWatcher(result, search);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
273
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
274
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
275

276
    connect(progress, SIGNAL(clicked()), Find::SearchResultWindow::instance(), SLOT(popup()));
Roberto Raggi's avatar
Roberto Raggi committed
277 278
}

Roberto Raggi's avatar
Roberto Raggi committed
279 280 281
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
282 283 284
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
285
        Find::SearchResultWindow::instance()->hide();
Roberto Raggi's avatar
Roberto Raggi committed
286 287 288
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
289
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
290
{
291 292 293 294 295
    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();
296 297
        return;
    }
Roberto Raggi's avatar
Roberto Raggi committed
298
    for (int index = first; index != last; ++index) {
299 300 301 302 303 304
        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
305
    }
Roberto Raggi's avatar
Roberto Raggi committed
306 307 308 309
}

void CppFindReferences::searchFinished()
{
310 311 312 313 314
    QFutureWatcher<Usage> *watcher = static_cast<QFutureWatcher<Usage> *>(sender());
    Find::SearchResult *search = m_watchers.value(watcher);
    if (search)
        search->finishSearch();
    m_watchers.remove(watcher);
Roberto Raggi's avatar
Roberto Raggi committed
315 316
}

317 318
void CppFindReferences::cancel()
{
319 320 321 322 323
    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();
324 325
}

326
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
327
{
328
    if (item.path.size() > 0) {
329
        TextEditor::BaseTextEditorWidget::openEditorAt(item.path.first(), item.lineNumber, item.textMarkPos,
hjk's avatar
hjk committed
330
                                                 Core::Id(),
331
                                                 Core::EditorManager::ModeSwitch);
332
    } else {
hjk's avatar
hjk committed
333
        Core::EditorManager::instance()->openEditor(item.text, Core::Id(), Core::EditorManager::ModeSwitch);
334
    }
Roberto Raggi's avatar
Roberto Raggi committed
335 336
}

Christian Kamm's avatar
Christian Kamm committed
337 338 339 340 341

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
342
    const CppModelManagerInterface::WorkingCopy workingCopy;
Christian Kamm's avatar
Christian Kamm committed
343 344 345 346
    const Snapshot snapshot;
    const Macro &macro;

public:
347
    FindMacroUsesInFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
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
                        const Snapshot snapshot,
                        const Macro &macro)
        : workingCopy(workingCopy), snapshot(snapshot), macro(macro)
    { }

    QList<Usage> operator()(const QString &fileName)
    {
        QList<Usage> usages;

        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(),
                                    use.begin() - lineStart, use.length()));
            }
        }

        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,
409
                                 const CppModelManagerInterface::WorkingCopy workingCopy,
410 411 412
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
413
{
414 415 416
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
417 418
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
419
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
420 421 422 423 424 425 426 427 428 429 430 431 432
    files.removeDuplicates();

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

    FindMacroUsesInFile process(workingCopy, snapshot, macro);
    UpdateUI reduce(&future);
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);

    future.setProgressValue(files.size());
}

void CppFindReferences::findMacroUses(const Macro &macro)
{
433
    Find::SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(
434 435 436 437
                tr("C++ Macro Usages:"),
                QString(),
                macro.name(),
                Find::SearchResultWindow::SearchOnly);
Christian Kamm's avatar
Christian Kamm committed
438

439
    Find::SearchResultWindow::instance()->popup(true);
Christian Kamm's avatar
Christian Kamm committed
440

441
    connect(search, SIGNAL(activated(Find::SearchResultItem)),
Christian Kamm's avatar
Christian Kamm committed
442
            this, SLOT(openEditor(Find::SearchResultItem)));
443
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
Christian Kamm's avatar
Christian Kamm committed
444 445

    const Snapshot snapshot = _modelManager->snapshot();
446
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
447 448 449 450 451

    // add the macro definition itself
    {
        // ### FIXME: Encoding?
        const QByteArray &source = getSource(macro.fileName(), workingCopy).toLatin1();
452 453
        search->addResult(macro.fileName(), macro.line(),
                          source.mid(macro.offset(), macro.length()), 0, macro.length());
Christian Kamm's avatar
Christian Kamm committed
454 455 456
    }

    QFuture<Usage> result;
457
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
458
    createWatcher(result, search);
Christian Kamm's avatar
Christian Kamm committed
459 460

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
461
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
462
                                                              CppTools::Constants::TASK_SEARCH);
463
    connect(progress, SIGNAL(clicked()), Find::SearchResultWindow::instance(), SLOT(popup()));
Christian Kamm's avatar
Christian Kamm committed
464 465
}

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
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;
}
491 492 493 494 495 496 497 498 499 500

void CppFindReferences::createWatcher(const QFuture<Usage> &future, Find::SearchResult *search)
{
    QFutureWatcher<Usage> *watcher = new QFutureWatcher<Usage>();
    watcher->setFuture(future);
    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);
}