basefilefind.cpp 14 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
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).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
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.
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
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
34
#include "basefilefind.h"

35
#include <coreplugin/icore.h>
36
#include <coreplugin/progressmanager/progressmanager.h>
37
#include <coreplugin/progressmanager/futureprogress.h>
con's avatar
con committed
38
#include <coreplugin/editormanager/editormanager.h>
39
#include <coreplugin/filemanager.h>
con's avatar
con committed
40
#include <find/textfindconstants.h>
41
#include <find/searchresultwindow.h>
con's avatar
con committed
42
43
#include <texteditor/itexteditor.h>
#include <texteditor/basetexteditor.h>
44
#include <utils/stylehelper.h>
45
#include <utils/fileutils.h>
con's avatar
con committed
46

47
#include <QtCore/QDebug>
con's avatar
con committed
48
#include <QtCore/QDirIterator>
49
#include <QtCore/QSettings>
50
#include <QtGui/QFileDialog>
51
#include <QtGui/QCheckBox>
52
53
#include <QtGui/QComboBox>
#include <QtGui/QLabel>
54
#include <QtGui/QMainWindow>
con's avatar
con committed
55
#include <QtGui/QPushButton>
56
#include <QtGui/QTextBlock>
con's avatar
con committed
57

58
using namespace Utils;
con's avatar
con committed
59
60
61
using namespace Find;
using namespace TextEditor;

62
63
BaseFileFind::BaseFileFind(SearchResultWindow *resultWindow)
  : m_resultWindow(resultWindow),
con's avatar
con committed
64
65
    m_isSearching(false),
    m_resultLabel(0),
66
    m_filterCombo(0)
con's avatar
con committed
67
68
69
70
71
72
73
74
75
76
77
{
    m_watcher.setPendingResultsLimit(1);
    connect(&m_watcher, SIGNAL(resultReadyAt(int)), this, SLOT(displayResult(int)));
    connect(&m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
}

bool BaseFileFind::isEnabled() const
{
    return !m_isSearching;
}

dt's avatar
dt committed
78
79
80
81
82
83
84
85
86
87
bool BaseFileFind::canCancel() const
{
    return m_isSearching;
}

void BaseFileFind::cancel()
{
    m_watcher.cancel();
}

con's avatar
con committed
88
89
90
91
QStringList BaseFileFind::fileNameFilters() const
{
    QStringList filters;
    if (m_filterCombo && !m_filterCombo->currentText().isEmpty()) {
92
        const QStringList parts = m_filterCombo->currentText().split(QLatin1Char(','));
con's avatar
con committed
93
        foreach (const QString &part, parts) {
94
            const QString filter = part.trimmed();
con's avatar
con committed
95
96
97
98
99
100
101
102
            if (!filter.isEmpty()) {
                filters << filter;
            }
        }
    }
    return filters;
}

103
void BaseFileFind::findAll(const QString &txt, Find::FindFlags findFlags)
con's avatar
con committed
104
105
106
{
    m_isSearching = true;
    emit changed();
con's avatar
con committed
107
    if (m_filterCombo)
108
        updateComboEntries(m_filterCombo, true);
109
    m_watcher.setFuture(QFuture<FileSearchResultList>());
110
111
    SearchResult *result = m_resultWindow->startNewSearch();
    connect(result, SIGNAL(activated(Find::SearchResultItem)), this, SLOT(openEditor(Find::SearchResultItem)));
con's avatar
con committed
112
    m_resultWindow->popup(true);
113
    if (findFlags & Find::FindRegularExpression) {
114
115
116
117
118
119
        m_watcher.setFuture(Utils::findInFilesRegExp(txt, files(),
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    } else {
        m_watcher.setFuture(Utils::findInFiles(txt, files(),
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    }
120
    Core::FutureProgress *progress =
121
        Core::ICore::instance()->progressManager()->addTask(m_watcher.future(),
Robert Loehning's avatar
Robert Loehning committed
122
                                                                        tr("Search"),
123
                                                                        Constants::TASK_SEARCH);
con's avatar
con committed
124
125
126
127
    progress->setWidget(createProgressWidget());
    connect(progress, SIGNAL(clicked()), m_resultWindow, SLOT(popup()));
}

128
void BaseFileFind::replaceAll(const QString &txt, Find::FindFlags findFlags)
129
130
131
132
{
    m_isSearching = true;
    emit changed();
    if (m_filterCombo)
133
        updateComboEntries(m_filterCombo, true);
134
    m_watcher.setFuture(QFuture<FileSearchResultList>());
135
136
    SearchResult *result = m_resultWindow->startNewSearch(
            SearchResultWindow::SearchAndReplace, QLatin1String("TextEditor"));
137
138
139
140
    connect(result, SIGNAL(activated(Find::SearchResultItem)), this, SLOT(openEditor(Find::SearchResultItem)));
    connect(result, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
            this, SLOT(doReplace(QString,QList<Find::SearchResultItem>)));
    m_resultWindow->popup(true);
141
    if (findFlags & Find::FindRegularExpression) {
142
143
144
145
146
147
        m_watcher.setFuture(Utils::findInFilesRegExp(txt, files(),
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    } else {
        m_watcher.setFuture(Utils::findInFiles(txt, files(),
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    }
148
149
    Core::FutureProgress *progress =
        Core::ICore::instance()->progressManager()->addTask(m_watcher.future(),
Robert Loehning's avatar
Robert Loehning committed
150
                                                                        tr("Search"),
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
                                                                        Constants::TASK_SEARCH);
    progress->setWidget(createProgressWidget());
    connect(progress, SIGNAL(clicked()), m_resultWindow, SLOT(popup()));
}

void BaseFileFind::doReplace(const QString &text,
                               const QList<Find::SearchResultItem> &items)
{
    QStringList files = replaceAll(text, items);
    Core::FileManager *fileManager = Core::ICore::instance()->fileManager();
    if (!files.isEmpty()) {
        fileManager->notifyFilesChangedInternally(files);
        m_resultWindow->hide();
    }
}

con's avatar
con committed
167
void BaseFileFind::displayResult(int index) {
168
169
170
171
    Utils::FileSearchResultList results = m_watcher.future().resultAt(index);
    QList<Find::SearchResultItem> items; // this conversion is stupid...
    foreach (const Utils::FileSearchResult &result, results) {
        Find::SearchResultItem item;
172
        item.path = QStringList() << QDir::toNativeSeparators(result.fileName);
173
        item.lineNumber = result.lineNumber;
174
175
176
177
        item.text = result.matchingLine;
        item.textMarkLength = result.matchLength;
        item.textMarkPos = result.matchStart;
        item.useTextEditorFont = true;
178
179
180
        item.userData = result.regexpCapturedTexts;
        items << item;
    }
181
    m_resultWindow->addResults(items, Find::SearchResultWindow::AddOrdered);
con's avatar
con committed
182
183
184
185
186
187
    if (m_resultLabel)
        m_resultLabel->setText(tr("%1 found").arg(m_resultWindow->numberOfResults()));
}

void BaseFileFind::searchFinished()
{
188
    m_resultWindow->finishSearch();
con's avatar
con committed
189
190
191
192
193
194
195
196
    m_isSearching = false;
    m_resultLabel = 0;
    emit changed();
}

QWidget *BaseFileFind::createProgressWidget()
{
    m_resultLabel = new QLabel;
197
    m_resultLabel->setAlignment(Qt::AlignCenter);
con's avatar
con committed
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
    // ### TODO this setup should be done by style
    QFont f = m_resultLabel->font();
    f.setBold(true);
    f.setPointSizeF(StyleHelper::sidebarFontSize());
    m_resultLabel->setFont(f);
    m_resultLabel->setPalette(StyleHelper::sidebarFontPalette(m_resultLabel->palette()));
    m_resultLabel->setText(tr("%1 found").arg(m_resultWindow->numberOfResults()));
    return m_resultLabel;
}

QWidget *BaseFileFind::createPatternWidget()
{
    QString filterToolTip = tr("List of comma separated wildcard filters");
    m_filterCombo = new QComboBox;
    m_filterCombo->setEditable(true);
    m_filterCombo->setModel(&m_filterStrings);
    m_filterCombo->setMaxCount(10);
    m_filterCombo->setMinimumContentsLength(10);
    m_filterCombo->setSizeAdjustPolicy(QComboBox::AdjustToMinimumContentsLengthWithIcon);
    m_filterCombo->setInsertPolicy(QComboBox::InsertAtBottom);
    m_filterCombo->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
    m_filterCombo->setToolTip(filterToolTip);
    syncComboWithSettings(m_filterCombo, m_filterSetting);
    return m_filterCombo;
}

void BaseFileFind::writeCommonSettings(QSettings *settings)
{
    settings->setValue("filters", m_filterStrings.stringList());
    if (m_filterCombo)
        settings->setValue("currentFilter", m_filterCombo->currentText());
}

void BaseFileFind::readCommonSettings(QSettings *settings, const QString &defaultFilter)
{
    QStringList filters = settings->value("filters").toStringList();
    m_filterSetting = settings->value("currentFilter").toString();
    if (filters.isEmpty())
        filters << defaultFilter;
    if (m_filterSetting.isEmpty())
        m_filterSetting = filters.first();
    m_filterStrings.setStringList(filters);
con's avatar
con committed
240
241
    if (m_filterCombo)
        syncComboWithSettings(m_filterCombo, m_filterSetting);
con's avatar
con committed
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
}

void BaseFileFind::syncComboWithSettings(QComboBox *combo, const QString &setting)
{
    if (!combo)
        return;
    int index = combo->findText(setting);
    if (index < 0)
        combo->setEditText(setting);
    else
        combo->setCurrentIndex(index);
}

void BaseFileFind::updateComboEntries(QComboBox *combo, bool onTop)
{
    int index = combo->findText(combo->currentText());
    if (index < 0) {
        if (onTop) {
            combo->insertItem(0, combo->currentText());
        } else {
            combo->addItem(combo->currentText());
        }
        combo->setCurrentIndex(combo->findText(combo->currentText()));
    }
}

268
void BaseFileFind::openEditor(const Find::SearchResultItem &item)
con's avatar
con committed
269
{
270
    if (item.path.size() > 0) {
271
        TextEditor::BaseTextEditorWidget::openEditorAt(QDir::fromNativeSeparators(item.path.first()), item.lineNumber, item.textMarkPos,
272
                                                 QString(), Core::EditorManager::ModeSwitch);
273
    } else {
274
        Core::EditorManager::instance()->openEditor(item.text, QString(), Core::EditorManager::ModeSwitch);
275
    }
con's avatar
con committed
276
}
277

con's avatar
con committed
278
// #pragma mark Static methods
279
280
281

static void applyChanges(QTextDocument *doc, const QString &text, const QList<Find::SearchResultItem> &items)
{
282
    QList<QPair<QTextCursor, QString> > changes;
283
284
285
286
287

    foreach (const Find::SearchResultItem &item, items) {
        const int blockNumber = item.lineNumber - 1;
        QTextCursor tc(doc->findBlockByNumber(blockNumber));

288
        const int cursorPosition = tc.position() + item.textMarkPos;
289
290

        int cursorIndex = 0;
291
292
        for (; cursorIndex < changes.size(); ++cursorIndex) {
            const QTextCursor &otherTc = changes.at(cursorIndex).first;
293

294
            if (otherTc.position() == cursorPosition)
295
296
297
                break;
        }

298
        if (cursorIndex != changes.size())
299
300
301
            continue; // skip this change.

        tc.setPosition(cursorPosition);
302
        tc.setPosition(tc.position() + item.textMarkLength,
303
                       QTextCursor::KeepAnchor);
304
305
306
307
308
309
        QString substitutionText;
        if (item.userData.canConvert<QStringList>() && !item.userData.toStringList().isEmpty())
            substitutionText = Utils::expandRegExpReplacement(text, item.userData.toStringList());
        else
            substitutionText = text;
        changes.append(QPair<QTextCursor, QString>(tc, substitutionText));
310
311
    }

312
313
314
315
    for (int i = 0; i < changes.size(); ++i) {
        QPair<QTextCursor, QString> &cursor = changes[i];
        cursor.first.insertText(cursor.second);
    }
316
317
318
319
320
}

QStringList BaseFileFind::replaceAll(const QString &text,
                               const QList<Find::SearchResultItem> &items)
{
321
    if (items.isEmpty())
322
323
324
325
326
        return QStringList();

    QHash<QString, QList<Find::SearchResultItem> > changes;

    foreach (const Find::SearchResultItem &item, items)
327
        changes[QDir::fromNativeSeparators(item.path.first())].append(item);
328
329
330
331
332
333
334
335

    Core::EditorManager *editorManager = Core::EditorManager::instance();

    QHashIterator<QString, QList<Find::SearchResultItem> > it(changes);
    while (it.hasNext()) {
        it.next();

        const QString fileName = it.key();
336
        const QList<Find::SearchResultItem> changeItems = it.value();
337
338

        const QList<Core::IEditor *> editors = editorManager->editorsForFileName(fileName);
339
        TextEditor::BaseTextEditorWidget *textEditor = 0;
340
        foreach (Core::IEditor *editor, editors) {
341
            textEditor = qobject_cast<TextEditor::BaseTextEditorWidget *>(editor->widget());
342
343
344
345
346
347
348
            if (textEditor != 0)
                break;
        }

        if (textEditor != 0) {
            QTextCursor tc = textEditor->textCursor();
            tc.beginEditBlock();
349
            applyChanges(textEditor->document(), text, changeItems);
350
351
            tc.endEditBlock();
        } else {
352
353
            Utils::FileReader reader;
            if (reader.fetch(fileName, Core::ICore::instance()->mainWindow())) {
354
355
356
357
358
359
360
                // Keep track of line ending since QTextDocument is '\n' based.
                bool convertLineEnding = false;
                const QByteArray &data = reader.data();
                const int lf = data.indexOf('\n');
                if (lf > 0 && data.at(lf - 1) == '\r')
                    convertLineEnding = true;

361
                QTextDocument doc;
362
                // ### set the encoding
363
                doc.setPlainText(QString::fromLocal8Bit(data));
364
                applyChanges(&doc, text, changeItems);
365
366
367
368
                QString plainText = doc.toPlainText();

                if (convertLineEnding)
                    plainText.replace(QLatin1Char('\n'), QLatin1String("\r\n"));
369

370
371
372
                Utils::FileSaver saver(fileName);
                if (!saver.hasError()) {
                    QTextStream stream(saver.file());
373
                    // ### set the encoding
374
                    stream << plainText;
375
                    saver.setResult(&stream);
376
                }
377
                saver.finalize(Core::ICore::instance()->mainWindow());
378
379
380
381
382
383
            }
        }
    }

    return changes.keys();
}