cppfindreferences.cpp 15.4 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
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.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 29
** If you have questions regarding the use of this file, please contact
** 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 41
#include <find/searchresultwindow.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/filesearch.h>
#include <coreplugin/progressmanager/progressmanager.h>
42
#include <coreplugin/progressmanager/futureprogress.h>
43
#include <coreplugin/editormanager/editormanager.h>
Roberto Raggi's avatar
Roberto Raggi committed
44 45 46 47 48 49 50 51
#include <coreplugin/icore.h>

#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 <cplusplus/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

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

68 69
#include <functional>

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

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

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

87
namespace {
88

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

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

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

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

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

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

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

132
            FindUsages process(unpreprocessedSource.toUtf8(), doc, snapshot);
133
            process(symbol);
134

135 136 137 138 139 140 141
            usages = process.usages();
        }

        return usages;
    }
};

142
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
143 144 145 146
{
    QFutureInterface<Usage> *future;

public:
147
    UpdateUI(QFutureInterface<Usage> *future): future(future) {}
148

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

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

158 159
} // end of anonymous namespace

160
CppFindReferences::CppFindReferences(CppModelManagerInterface *modelManager)
161 162
    : QObject(modelManager),
      _modelManager(modelManager),
163
      _resultWindow(Find::SearchResultWindow::instance())
164 165 166 167 168 169 170 171 172 173
{
    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()
{
}

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

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

    return references;
}

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

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

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

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

            Control *control = doc->control();

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

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

218
    ProcessFile process(workingCopy, snapshot, context.thisDocument(), symbol);
219
    UpdateUI reduce(&future);
220

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

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

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

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

233
    findAll_helper(symbol, context);
234 235
}

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

243 244
        Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchAndReplace);
        _resultWindow->setTextToReplace(textToReplace);
245

246 247
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
248

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

252
        findAll_helper(symbol, context);
253
    }
254 255
}

256
void CppFindReferences::findAll_helper(Symbol *symbol, const LookupContext &context)
257
{
258 259 260
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
261 262
    _resultWindow->popup(true);

263
    const CppModelManagerInterface::WorkingCopy workingCopy = _modelManager->workingCopy();
264

Roberto Raggi's avatar
Roberto Raggi committed
265
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
266 267 268

    QFuture<Usage> result;

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

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

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

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

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

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

void CppFindReferences::searchFinished()
{
304
    _resultWindow->finishSearch();
Roberto Raggi's avatar
Roberto Raggi committed
305 306 307
    emit changed();
}

308
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
309
{
310
    if (item.path.size() > 0) {
311
        TextEditor::BaseTextEditorWidget::openEditorAt(item.path.first(), item.lineNumber, item.textMarkPos,
312 313
                                                 QString(),
                                                 Core::EditorManager::ModeSwitch);
314
    } else {
315
        Core::EditorManager::instance()->openEditor(item.text, QString(), Core::EditorManager::ModeSwitch);
316
    }
Roberto Raggi's avatar
Roberto Raggi committed
317 318
}

Christian Kamm's avatar
Christian Kamm committed
319 320 321 322 323

namespace {

class FindMacroUsesInFile: public std::unary_function<QString, QList<Usage> >
{
324
    const CppModelManagerInterface::WorkingCopy workingCopy;
Christian Kamm's avatar
Christian Kamm committed
325 326 327 328
    const Snapshot snapshot;
    const Macro &macro;

public:
329
    FindMacroUsesInFile(const CppModelManagerInterface::WorkingCopy &workingCopy,
Christian Kamm's avatar
Christian Kamm committed
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
                        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,
391
                                 const CppModelManagerInterface::WorkingCopy workingCopy,
392 393 394
                                 const Snapshot snapshot,
                                 CppFindReferences *findRefs,
                                 const Macro macro)
Christian Kamm's avatar
Christian Kamm committed
395
{
396 397 398
    // ensure the dependency table is updated
    DependencyTable dependencies = findRefs->updateDependencyTable(snapshot);

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

    // 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;
434
    result = QtConcurrent::run(&findMacroUses_helper, workingCopy, snapshot, this, macro);
Christian Kamm's avatar
Christian Kamm committed
435 436 437
    m_watcher.setFuture(result);

    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
438
    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching"),
Christian Kamm's avatar
Christian Kamm committed
439 440 441 442
                                                              CppTools::Constants::TASK_SEARCH);
    connect(progress, SIGNAL(clicked()), _resultWindow, SLOT(popup()));
}

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