cppfindreferences.cpp 15.1 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
Roberto Raggi's avatar
Roberto Raggi committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
con's avatar
con committed
26
** contact the sales department at http://qt.nokia.com/contact.
Roberto Raggi's avatar
Roberto Raggi committed
27 28 29 30
**
**************************************************************************/

#include "cppfindreferences.h"
31
#include "cppmodelmanagerinterface.h"
Roberto Raggi's avatar
Roberto Raggi committed
32 33 34
#include "cpptoolsconstants.h"

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

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

#include <cplusplus/CppDocument.h>
53
#include <cplusplus/CppBindings.h>
54
#include <cplusplus/Overview.h>
Roberto Raggi's avatar
Roberto Raggi committed
55 56

#include <QtCore/QTime>
57
#include <QtCore/QTimer>
Roberto Raggi's avatar
Roberto Raggi committed
58
#include <QtCore/QtConcurrentRun>
59
#include <QtCore/QtConcurrentMap>
Roberto Raggi's avatar
Roberto Raggi committed
60
#include <QtCore/QDir>
61
#include <QtGui/QApplication>
Roberto Raggi's avatar
Roberto Raggi committed
62 63
#include <qtconcurrent/runextensions.h>

64 65
#include <functional>

Roberto Raggi's avatar
Roberto Raggi committed
66 67 68
using namespace CppTools::Internal;
using namespace CPlusPlus;

Christian Kamm's avatar
Christian Kamm committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82
static QString getSource(const QString &fileName,
                         const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy)
{
    if (workingCopy.contains(fileName)) {
        return workingCopy.source(fileName);
    } else {
        QFile file(fileName);
        if (! file.open(QFile::ReadOnly))
            return QString();

        return QTextStream(&file).readAll(); // ### FIXME
    }
}

83
namespace {
84

85
class ProcessFile: public std::unary_function<QString, QList<Usage> >
86
{
87
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy;
88
    const Snapshot snapshot;
Erik Verbruggen's avatar
Erik Verbruggen committed
89
    Document::Ptr symbolDocument;
90 91 92
    Symbol *symbol;

public:
93 94
    ProcessFile(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy,
                const Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
95
                Document::Ptr symbolDocument,
96
                Symbol *symbol)
Erik Verbruggen's avatar
Erik Verbruggen committed
97
        : workingCopy(workingCopy), snapshot(snapshot), symbolDocument(symbolDocument), symbol(symbol)
98 99 100 101 102 103 104
    { }

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

105
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
106 107 108 109 110
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }

Christian Kamm's avatar
Christian Kamm committed
111 112
        QByteArray source = snapshot.preprocessedCode(
                getSource(fileName, workingCopy), fileName);
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

        Document::Ptr doc = snapshot.documentFromSource(source, fileName);
        doc->tokenize();

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

            FindUsages process(doc, snapshot);
            process.setGlobalNamespaceBinding(bind(doc, snapshot));

            process(symbol);
            usages = process.usages();
        }

        return usages;
    }
};

132
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
133 134 135 136
{
    QFutureInterface<Usage> *future;

public:
137
    UpdateUI(QFutureInterface<Usage> *future): future(future) {}
138

139
    void operator()(QList<Usage> &, const QList<Usage> &usages)
140 141 142 143 144 145 146 147
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

148 149 150 151 152 153 154 155 156 157
} // end of anonymous namespace

CppFindReferences::CppFindReferences(CppTools::CppModelManagerInterface *modelManager)
    : QObject(modelManager),
      _modelManager(modelManager),
      _resultWindow(ExtensionSystem::PluginManager::instance()->getObject<Find::SearchResultWindow>())
{
    m_watcher.setPendingResultsLimit(1);
    connect(&m_watcher, SIGNAL(resultsReadyAt(int,int)), this, SLOT(displayResults(int,int)));
    connect(&m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
158 159 160 161 162 163 164 165

    m_updateDependencyTableTimer = new QTimer(this);
    m_updateDependencyTableTimer->setSingleShot(true);
    m_updateDependencyTableTimer->setInterval(2000);
    connect(m_updateDependencyTableTimer, SIGNAL(timeout()),
            this, SLOT(updateDependencyTable()));
    connect(modelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
            m_updateDependencyTableTimer, SLOT(start()));
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
}

CppFindReferences::~CppFindReferences()
{
}

QList<int> CppFindReferences::references(Symbol *symbol,
                                         Document::Ptr doc,
                                         const Snapshot& snapshot) const
{
    QList<int> references;

    FindUsages findUsages(doc, snapshot);
    findUsages.setGlobalNamespaceBinding(bind(doc, snapshot));
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

186
static void find_helper(QFutureInterface<Usage> &future,
187
                        const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
188
                        Snapshot snapshot,
Erik Verbruggen's avatar
Erik Verbruggen committed
189
                        Document::Ptr symbolDocument,
190
                        DependencyTable dependencyTable,
191
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
192 193 194
{
    QTime tm;
    tm.start();
195

Roberto Raggi's avatar
Roberto Raggi committed
196
    const Identifier *symbolId = symbol->identifier();
197 198
    Q_ASSERT(symbolId != 0);

Roberto Raggi's avatar
Roberto Raggi committed
199 200
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
    QStringList files(sourceFile);
201 202 203 204 205 206 207 208 209 210 211 212

    if (symbol->isClass() || symbol->isForwardClassDeclaration()) {
        foreach (const Document::Ptr &doc, snapshot) {
            if (doc->fileName() == sourceFile)
                continue;

            Control *control = doc->control();

            if (control->findIdentifier(symbolId->chars(), symbolId->size()))
                files.append(doc->fileName());
        }
    } else {
213
        files += dependencyTable.filesDependingOn(sourceFile);
214
    }
215
    files.removeDuplicates();
216
    //qDebug() << "done in:" << tm.elapsed() << "number of files to parse:" << files.size();
Roberto Raggi's avatar
Roberto Raggi committed
217 218 219

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

Erik Verbruggen's avatar
Erik Verbruggen committed
220
    ProcessFile process(workingCopy, snapshot, symbolDocument, symbol);
221
    UpdateUI reduce(&future);
222

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

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

228
static CPlusPlus::DependencyTable dependencyTable(DependencyTable previous, CPlusPlus::Snapshot snapshot)
229
{
230 231 232 233 234 235 236 237 238 239 240 241
    if (previous.isValidFor(snapshot))
        return previous;

    DependencyTable table;
    table.build(snapshot);
    return table;
}

void CppFindReferences::updateDependencyTable()
{
    m_depsFuture.cancel();
    m_depsFuture = QtConcurrent::run(&dependencyTable, m_deps, _modelManager->snapshot());
242 243
}

Erik Verbruggen's avatar
Erik Verbruggen committed
244
void CppFindReferences::findUsages(Document::Ptr symbolDocument, Symbol *symbol)
245
{
Roberto Raggi's avatar
Roberto Raggi committed
246 247 248 249 250
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));

Erik Verbruggen's avatar
Erik Verbruggen committed
251
    findAll_helper(symbolDocument, symbol);
252 253
}

Erik Verbruggen's avatar
Erik Verbruggen committed
254
void CppFindReferences::renameUsages(Document::Ptr symbolDocument, Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
255
{
Roberto Raggi's avatar
Roberto Raggi committed
256
    if (const Identifier *id = symbol->identifier()) {
257
        const QString textToReplace = QString::fromUtf8(id->chars(), id->size());
Roberto Raggi's avatar
Roberto Raggi committed
258

259 260
        Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchAndReplace);
        _resultWindow->setTextToReplace(textToReplace);
261

262 263
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
264

265 266 267
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

Erik Verbruggen's avatar
Erik Verbruggen committed
268
        findAll_helper(symbolDocument, symbol);
269
    }
270 271
}

Erik Verbruggen's avatar
Erik Verbruggen committed
272
void CppFindReferences::findAll_helper(Document::Ptr symbolDocument, Symbol *symbol)
273
{
274 275 276
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
277 278
    _resultWindow->popup(true);

279
    const Snapshot snapshot = _modelManager->snapshot();
280
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
281

Roberto Raggi's avatar
Roberto Raggi committed
282
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
283

284 285
    updateDependencyTable(); // ensure the dependency table is updated
    m_deps = m_depsFuture;
286

Roberto Raggi's avatar
Roberto Raggi committed
287 288
    QFuture<Usage> result;

289
    result = QtConcurrent::run(&find_helper, workingCopy, snapshot, symbolDocument, m_deps, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
290 291
    m_watcher.setFuture(result);

292
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
293
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
294 295 296 297

    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}

Roberto Raggi's avatar
Roberto Raggi committed
298 299 300
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
301 302
    Core::EditorManager::instance()->hideEditorInfoBar(QLatin1String("CppEditor.Rename"));

303 304 305 306
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
        _resultWindow->hide();
Roberto Raggi's avatar
Roberto Raggi committed
307 308 309
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
310
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
311
{
Roberto Raggi's avatar
Roberto Raggi committed
312 313 314 315 316 317 318 319
    for (int index = first; index != last; ++index) {
        Usage result = m_watcher.future().resultAt(index);
        _resultWindow->addResult(result.path,
                                 result.line,
                                 result.lineText,
                                 result.col,
                                 result.len);
    }
Roberto Raggi's avatar
Roberto Raggi committed
320 321 322 323
}

void CppFindReferences::searchFinished()
{
324
    _resultWindow->finishSearch();
Roberto Raggi's avatar
Roberto Raggi committed
325 326 327
    emit changed();
}

328
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
329
{
330
    TextEditor::BaseTextEditor::openEditorAt(item.fileName, item.lineNumber, item.searchTermStart);
Roberto Raggi's avatar
Roberto Raggi committed
331 332
}

Christian Kamm's avatar
Christian Kamm committed
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

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy;
    const Snapshot snapshot;
    const Macro &macro;

public:
    FindMacroUsesInFile(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy,
                        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,
                        const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
                        const Snapshot snapshot,
407
                        DependencyTable dependencyTable,
Christian Kamm's avatar
Christian Kamm committed
408 409 410 411
                        const Macro macro)
{
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
412
    files += dependencyTable.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
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
    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)
{
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

    _resultWindow->popup(true);

    connect(search, SIGNAL(activated(Find::SearchResultItem)),
            this, SLOT(openEditor(Find::SearchResultItem)));

    const Snapshot snapshot = _modelManager->snapshot();
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();

    // add the macro definition itself
    {
        // ### FIXME: Encoding?
        const QByteArray &source = getSource(macro.fileName(), workingCopy).toLatin1();
        _resultWindow->addResult(macro.fileName(), macro.line(),
                                 source.mid(macro.offset(), macro.length()), 0, macro.length());
    }

444 445
    updateDependencyTable(); // ensure the dependency table is updated
    m_deps = m_depsFuture;
446

Christian Kamm's avatar
Christian Kamm committed
447
    QFuture<Usage> result;
448
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, m_deps, macro);
Christian Kamm's avatar
Christian Kamm committed
449 450 451
    m_watcher.setFuture(result);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
452
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
453 454 455 456
                                                              CppTools::Constants::TASK_SEARCH);
    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}