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

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

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

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

65 66
#include <functional>

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

Christian Kamm's avatar
Christian Kamm committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83
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
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
84
namespace {
85

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

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

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

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

112 113
        Document::Ptr doc;
        QByteArray source;
114

115 116 117 118 119 120 121
        if (symbolDocument && fileName == symbolDocument->fileName())
            doc = symbolDocument;
        else {
            source = snapshot.preprocessedCode(getSource(fileName, workingCopy), fileName);
            doc = snapshot.documentFromSource(source, fileName);
            doc->tokenize();
        }
122 123 124

        Control *control = doc->control();
        if (control->findIdentifier(symbolId->chars(), symbolId->size()) != 0) {
125 126
            if (doc != symbolDocument)
                doc->check();
127 128 129

            FindUsages process(doc, snapshot);
            process(symbol);
130

131 132 133 134 135 136 137
            usages = process.usages();
        }

        return usages;
    }
};

Roberto Raggi's avatar
Roberto Raggi committed
138
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
139 140 141 142
{
    QFutureInterface<Usage> *future;

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

145
    void operator()(QList<Usage> &, const QList<Usage> &usages)
146 147 148 149 150 151 152 153
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

Roberto Raggi's avatar
Roberto Raggi committed
154 155 156 157 158
} // end of anonymous namespace

CppFindReferences::CppFindReferences(CppTools::CppModelManagerInterface *modelManager)
    : QObject(modelManager),
      _modelManager(modelManager),
159
      _resultWindow(Find::SearchResultWindow::instance())
Roberto Raggi's avatar
Roberto Raggi committed
160 161 162 163 164 165 166 167 168 169
{
    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()
{
}

170
QList<int> CppFindReferences::references(Symbol *symbol, const LookupContext &context) const
Roberto Raggi's avatar
Roberto Raggi committed
171 172 173
{
    QList<int> references;

174
    FindUsages findUsages(context);
Roberto Raggi's avatar
Roberto Raggi committed
175 176 177 178 179 180
    findUsages(symbol);
    references = findUsages.references();

    return references;
}

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

190 191
    const Snapshot snapshot = context.snapshot();

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

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

            Control *control = doc->control();

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

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

214
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol);
Roberto Raggi's avatar
Roberto Raggi committed
215
    UpdateUI reduce(&future);
216

217
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
218

Roberto Raggi's avatar
Roberto Raggi committed
219 220 221
    future.setProgressValue(files.size());
}

222
void CppFindReferences::findUsages(CPlusPlus::Symbol *symbol, const CPlusPlus::LookupContext &context)
223
{
Roberto Raggi's avatar
Roberto Raggi committed
224 225 226 227 228
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

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

229
    findAll_helper(symbol, context);
230 231
}

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

239 240
        Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchAndReplace);
        _resultWindow->setTextToReplace(textToReplace);
241

242 243
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
244

245 246 247
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

248
        findAll_helper(symbol, context);
249
    }
250 251
}

252
void CppFindReferences::findAll_helper(Symbol *symbol, const LookupContext &context)
253
{
254 255 256
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
257 258
    _resultWindow->popup(true);

259
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
260

Roberto Raggi's avatar
Roberto Raggi committed
261
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
262 263 264

    QFuture<Usage> result;

265
    result = QtConcurrent::run(&find_helper, workingCopy, context, this, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
266 267
    m_watcher.setFuture(result);

268
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
269
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
270 271 272 273

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

Roberto Raggi's avatar
Roberto Raggi committed
274 275 276
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
277 278
    Core::EditorManager::instance()->hideEditorInfoBar(QLatin1String("CppEditor.Rename"));

279 280 281 282
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
        _resultWindow->hide();
Roberto Raggi's avatar
Roberto Raggi committed
283 284 285
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
286
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
287
{
Roberto Raggi's avatar
Roberto Raggi committed
288 289 290 291 292 293 294 295
    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
296 297 298 299
}

void CppFindReferences::searchFinished()
{
300
    _resultWindow->finishSearch();
Roberto Raggi's avatar
Roberto Raggi committed
301 302 303
    emit changed();
}

304
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
305
{
306 307 308 309 310
    if (item.path.size() > 0) {
        TextEditor::BaseTextEditor::openEditorAt(item.path.first(), item.lineNumber, item.textMarkPos);
    } else {
        Core::EditorManager::instance()->openEditor(item.text);
    }
Roberto Raggi's avatar
Roberto Raggi committed
311 312
}

Christian Kamm's avatar
Christian Kamm committed
313 314 315 316 317 318 319 320 321 322 323 324 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

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,
385 386 387 388
                                 const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
389
{
390 391 392
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

Christian Kamm's avatar
Christian Kamm committed
393 394
    const QString& sourceFile = macro.fileName();
    QStringList files(sourceFile);
395
    files += dependencies.filesDependingOn(sourceFile);
Christian Kamm's avatar
Christian Kamm committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
    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();
417
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
Christian Kamm's avatar
Christian Kamm committed
418 419 420 421 422 423 424 425 426 427

    // 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());
    }

    QFuture<Usage> result;
428
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
Christian Kamm's avatar
Christian Kamm committed
429 430 431
    m_watcher.setFuture(result);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
432
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
433 434 435 436
                                                              CppTools::Constants::TASK_SEARCH);
    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}

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
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;
}