cppfindreferences.cpp 9.49 KB
Newer Older
Roberto Raggi's avatar
Roberto Raggi committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** 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 57

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

63 64
#include <functional>

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

68
namespace {
69

70
class ProcessFile: public std::unary_function<QString, QList<Usage> >
71
{
72
    const CppTools::CppModelManagerInterface::WorkingCopy workingCopy;
73 74 75 76
    const Snapshot snapshot;
    Symbol *symbol;

public:
77 78 79 80
    ProcessFile(const CppTools::CppModelManagerInterface::WorkingCopy &workingCopy,
                const Snapshot snapshot,
                Symbol *symbol)
        : workingCopy(workingCopy), snapshot(snapshot), symbol(symbol)
81 82 83 84 85 86 87
    { }

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

88
        if (Document::Ptr previousDoc = snapshot.document(fileName)) {
89 90 91 92 93 94 95
            Control *control = previousDoc->control();
            if (! control->findIdentifier(symbolId->chars(), symbolId->size()))
                return usages; // skip this document, it's not using symbolId.
        }

        QByteArray source;

96 97
        if (workingCopy.contains(fileName))
            source = snapshot.preprocessedCode(workingCopy.source(fileName), fileName);
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
        else {
            QFile file(fileName);
            if (! file.open(QFile::ReadOnly))
                return usages;

            const QString contents = QTextStream(&file).readAll(); // ### FIXME
            source = snapshot.preprocessedCode(contents, fileName);
        }

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

125
class UpdateUI: public std::binary_function<QList<Usage> &, QList<Usage>, void>
126 127 128 129
{
    QFutureInterface<Usage> *future;

public:
130
    UpdateUI(QFutureInterface<Usage> *future): future(future) {}
131

132
    void operator()(QList<Usage> &, const QList<Usage> &usages)
133 134 135 136 137 138 139 140
    {
        foreach (const Usage &u, usages)
            future->reportResult(u);

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

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
} // 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()));
}

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

171
static void find_helper(QFutureInterface<Usage> &future,
172
                        const CppTools::CppModelManagerInterface::WorkingCopy workingCopy,
173 174
                        Snapshot snapshot,
                        Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
175 176 177
{
    QTime tm;
    tm.start();
178

Roberto Raggi's avatar
Roberto Raggi committed
179
    const Identifier *symbolId = symbol->identifier();
180 181
    Q_ASSERT(symbolId != 0);

Roberto Raggi's avatar
Roberto Raggi committed
182 183
    const QString sourceFile = QString::fromUtf8(symbol->fileName(), symbol->fileNameLength());
    QStringList files(sourceFile);
184 185 186 187 188 189 190 191 192 193 194 195

    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 {
196
        files += snapshot.filesDependingOn(sourceFile);
197
    }
198
    files.removeDuplicates();
199
    //qDebug() << "done in:" << tm.elapsed() << "number of files to parse:" << files.size();
Roberto Raggi's avatar
Roberto Raggi committed
200 201 202

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

203
    ProcessFile process(workingCopy, snapshot, symbol);
204
    UpdateUI reduce(&future);
205

206
    QtConcurrent::blockingMappedReduced<QList<Usage> > (files, process, reduce);
207

Roberto Raggi's avatar
Roberto Raggi committed
208 209 210
    future.setProgressValue(files.size());
}

211 212
void CppFindReferences::findUsages(Symbol *symbol)
{
Roberto Raggi's avatar
Roberto Raggi committed
213 214 215 216 217
    Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchOnly);

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

218 219 220 221
    findAll_helper(symbol);
}

void CppFindReferences::renameUsages(Symbol *symbol)
Roberto Raggi's avatar
Roberto Raggi committed
222
{
Roberto Raggi's avatar
Roberto Raggi committed
223
    if (const Identifier *id = symbol->identifier()) {
224
        const QString textToReplace = QString::fromUtf8(id->chars(), id->size());
Roberto Raggi's avatar
Roberto Raggi committed
225

226 227
        Find::SearchResult *search = _resultWindow->startNewSearch(Find::SearchResultWindow::SearchAndReplace);
        _resultWindow->setTextToReplace(textToReplace);
228

229 230
        connect(search, SIGNAL(activated(Find::SearchResultItem)),
                this, SLOT(openEditor(Find::SearchResultItem)));
Roberto Raggi's avatar
Roberto Raggi committed
231

232 233 234 235 236
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
                SLOT(onReplaceButtonClicked(QString,QList<Find::SearchResultItem>)));

        findAll_helper(symbol);
    }
237 238 239 240
}

void CppFindReferences::findAll_helper(Symbol *symbol)
{
241 242 243
    if (! (symbol && symbol->identifier()))
        return;

Roberto Raggi's avatar
Roberto Raggi committed
244 245
    _resultWindow->popup(true);

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

Roberto Raggi's avatar
Roberto Raggi committed
249
    Core::ProgressManager *progressManager = Core::ICore::instance()->progressManager();
Roberto Raggi's avatar
Roberto Raggi committed
250 251 252

    QFuture<Usage> result;

253
    result = QtConcurrent::run(&find_helper, workingCopy, snapshot, symbol);
Roberto Raggi's avatar
Roberto Raggi committed
254 255 256
    m_watcher.setFuture(result);

    Core::FutureProgress *progress = progressManager->addTask(result, tr("Searching..."),
257
                                                              CppTools::Constants::TASK_SEARCH);
Roberto Raggi's avatar
Roberto Raggi committed
258 259 260 261

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

Roberto Raggi's avatar
Roberto Raggi committed
262 263 264
void CppFindReferences::onReplaceButtonClicked(const QString &text,
                                               const QList<Find::SearchResultItem> &items)
{
265 266
    Core::EditorManager::instance()->hideEditorInfoBar(QLatin1String("CppEditor.Rename"));

267 268 269 270
    const QStringList fileNames = TextEditor::BaseFileFind::replaceAll(text, items);
    if (!fileNames.isEmpty()) {
        _modelManager->updateSourceFiles(fileNames);
        _resultWindow->hide();
Roberto Raggi's avatar
Roberto Raggi committed
271 272 273
    }
}

Roberto Raggi's avatar
Roberto Raggi committed
274
void CppFindReferences::displayResults(int first, int last)
Roberto Raggi's avatar
Roberto Raggi committed
275
{
Roberto Raggi's avatar
Roberto Raggi committed
276 277 278 279 280 281 282 283
    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
284 285 286 287
}

void CppFindReferences::searchFinished()
{
288
    _resultWindow->finishSearch();
Roberto Raggi's avatar
Roberto Raggi committed
289 290 291
    emit changed();
}

292
void CppFindReferences::openEditor(const Find::SearchResultItem &item)
Roberto Raggi's avatar
Roberto Raggi committed
293
{
294
    TextEditor::BaseTextEditor::openEditorAt(item.fileName, item.lineNumber, item.searchTermStart);
Roberto Raggi's avatar
Roberto Raggi committed
295 296
}