cppfindreferences.cpp 16.5 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>
Roberto Raggi's avatar
Roberto Raggi committed
42
#include <coreplugin/progressmanager/progressmanager.h>
43
#include <coreplugin/progressmanager/futureprogress.h>
44
#include <coreplugin/editormanager/editormanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
45
#include <coreplugin/icore.h>
46
#include <coreplugin/infobar.h>
Roberto Raggi's avatar
Roberto Raggi committed
47 48 49 50 51 52 53

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

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

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

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
        Utils::FileReader reader;
82
        if (!reader.fetch(fileName, QFile::Text)) // ### FIXME error reporting
Christian Kamm's avatar
Christian Kamm committed
83 84
            return QString();

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

Roberto Raggi's avatar
Roberto Raggi committed
89
namespace {
90

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

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

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

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

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

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

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

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

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

        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
144
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
145 146 147 148
{
    QFutureInterface<Usage> *future;

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

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

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

Roberto Raggi's avatar
Roberto Raggi committed
160 161
} // end of anonymous namespace

162
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
163
    : QObject(modelManager),
164
      _modelManager(modelManager)
Roberto Raggi's avatar
Roberto Raggi committed
165 166 167 168 169 170 171 172 173 174
{
    m_watcher.setPendingResultsLimit(1);
    connect(&m_watcher, SIGNAL(resultsReadyAt(int,int)), this, SLOT(displayResults(int,int)));
    connect(&m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
}

CppFindReferences::~CppFindReferences()
{
}

175
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
Roberto Raggi's avatar
Roberto Raggi committed
176 177 178
{
    QList<int> references;

179
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
180 181 182 183 184 185
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

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

195 196
    const Snapshot snapshot = context.snapshot();

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

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

            Control *control = doc->control();

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

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

219
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol);
Roberto Raggi's avatar
Roberto Raggi committed
220
    UpdateUI reduce(&future);
221

222
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
223

Roberto Raggi's avatar
Roberto Raggi committed
224 225 226
    future.setProgressValue(files.size());
}

227
void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
228
{
229
    Overview overview;
230 231 232 233
    m_currentSearch = Find::SearchResultWindow::instance()->startNewSearch(tr("C++ Usages:"),
                                                QString(),
                                                overview(context.fullyQualifiedName(symbol)),
                                                Find::SearchResultWindow::SearchOnly);
234
    connect(m_currentSearch, SIGNAL(activated(Find::SearchResultItem)),
Roberto Raggi's avatar
Roberto Raggi committed
235 236
            this, SLOT(openEditor(Find::SearchResultItem)));

237
    findAll_helper(symbol, context);
238 239
}

240 241
void CppFindReferences::renameUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context,
                                     const QString &replacement)
Roberto Raggi's avatar
Roberto Raggi committed
242
{
Roberto Raggi's avatar
Roberto Raggi committed
243
    if (const Identifier *id = symbol->identifier()) {
244 245
        const QString textToReplace = replacement.isEmpty()
                ? QString::fromUtf8(id->chars(), id->size()) : replacement;
Roberto Raggi's avatar
Roberto Raggi committed
246

247
        Overview overview;
248 249 250 251 252
        m_currentSearch = Find::SearchResultWindow::instance()->startNewSearch(
                    tr("C++ Usages:"),
                    QString(),
                    overview(context.fullyQualifiedName(symbol)),
                    Find::SearchResultWindow::SearchAndReplace, QLatin1String("CppEditor"));
253
        m_currentSearch->setTextToReplace(textToReplace);
254

255
        connect(m_currentSearch, SIGNAL(activated(Find::SearchResultItem)),
256
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
257

258
        connect(m_currentSearch, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
259 260
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

261
        findAll_helper(symbol, context);
262
    }
263 264
}

265
void CppFindReferences::findAll_helper(Symbol *symbol, const LookupContext &context)
266
{
267 268 269
    if (! (symbol && symbol->identifier()))
        return;

270
    Find::SearchResultWindow::instance()->popup(true);
Roberto Raggi's avatar
Roberto Raggi committed
271

272
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
273

Roberto Raggi's avatar
Roberto Raggi committed
274
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
275 276 277

    QFuture<Usage> result;

278
    result = QtConcurrent::run(&find_helper, workingCopy, context, this, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
279
    m_watcher.setFuture(result);
280
    connect(m_currentSearch, SIGNAL(cancelled()), this, SLOT(cancel()));
281
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
282
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
283

284
    connect(progress, SIGNAL(clicked()), Find::SearchResultWindow::instance(), SLOT(popup()));
Roberto Raggi's avatar
Roberto Raggi committed
285 286
}

Roberto Raggi's avatar
Roberto Raggi committed
287 288 289
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
290 291 292
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
293
        Find::SearchResultWindow::instance()->hide();
Roberto Raggi's avatar
Roberto Raggi committed
294 295 296
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
297
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
298
{
299 300 301 302
    if (!m_currentSearch) {
        m_watcher.cancel();
        return;
    }
Roberto Raggi's avatar
Roberto Raggi committed
303 304
    for (int index = first; index != last; ++index) {
        Usage result = m_watcher.future().resultAt(index);
305
        m_currentSearch->addResult(result.path,
Roberto Raggi's avatar
Roberto Raggi committed
306 307 308 309 310
                                 result.line,
                                 result.lineText,
                                 result.col,
                                 result.len);
    }
Roberto Raggi's avatar
Roberto Raggi committed
311 312 313 314
}

void CppFindReferences::searchFinished()
{
315 316
    if (m_currentSearch)
        m_currentSearch->finishSearch();
317
    m_currentSearch = 0;
Roberto Raggi's avatar
Roberto Raggi committed
318 319 320
    emit changed();
}

321 322 323 324 325
void CppFindReferences::cancel()
{
    m_watcher.cancel();
}

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 434 435 436 437
    m_currentSearch = Find::SearchResultWindow::instance()->startNewSearch(
                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(m_currentSearch, SIGNAL(activated(Find::SearchResultItem)),
Christian Kamm's avatar
Christian Kamm committed
442 443 444
            this, SLOT(openEditor(Find::SearchResultItem)));

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

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

    QFuture<Usage> result;
456
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
Christian Kamm's avatar
Christian Kamm committed
457
    m_watcher.setFuture(result);
458
    connect(m_currentSearch, SIGNAL(cancelled()), this, SLOT(cancel()));
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;
}