basefilefind.cpp 15.3 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 <aggregation/aggregate.h>
36
#include <coreplugin/icore.h>
37
#include <coreplugin/progressmanager/progressmanager.h>
38
#include <coreplugin/progressmanager/futureprogress.h>
con's avatar
con committed
39
#include <coreplugin/editormanager/editormanager.h>
40
#include <coreplugin/editormanager/ieditor.h>
41
#include <coreplugin/filemanager.h>
con's avatar
con committed
42
43
44
#include <find/textfindconstants.h>
#include <texteditor/itexteditor.h>
#include <texteditor/basetexteditor.h>
45
#include <utils/stylehelper.h>
46
#include <utils/fileutils.h>
47
#include <utils/qtcassert.h>
con's avatar
con committed
48

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

61
using namespace Utils;
con's avatar
con committed
62
63
64
using namespace Find;
using namespace TextEditor;

65
66
67
BaseFileFind::BaseFileFind()
  : m_currentSearch(0),
    m_currentSearchCount(0),
68
    m_watcher(0),
con's avatar
con committed
69
70
    m_isSearching(false),
    m_resultLabel(0),
71
    m_filterCombo(0)
con's avatar
con committed
72
73
74
{
}

75
76
77
78
BaseFileFind::~BaseFileFind()
{
}

con's avatar
con committed
79
80
81
82
83
bool BaseFileFind::isEnabled() const
{
    return !m_isSearching;
}

dt's avatar
dt committed
84
85
void BaseFileFind::cancel()
{
86
87
    QTC_ASSERT(m_watcher, return);
    m_watcher->cancel();
dt's avatar
dt committed
88
89
}

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

105
106
void BaseFileFind::runNewSearch(const QString &txt, Find::FindFlags findFlags,
                                    SearchResultWindow::SearchMode searchMode)
con's avatar
con committed
107
108
{
    m_isSearching = true;
109
    m_currentFindSupport = 0;
con's avatar
con committed
110
    emit changed();
con's avatar
con committed
111
    if (m_filterCombo)
112
        updateComboEntries(m_filterCombo, true);
113
114
115
116
117
    delete m_watcher;
    m_watcher = new QFutureWatcher<FileSearchResultList>();
    m_watcher->setPendingResultsLimit(1);
    connect(m_watcher, SIGNAL(resultReadyAt(int)), this, SLOT(displayResult(int)));
    connect(m_watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
118
    m_currentSearchCount = 0;
119
120
121
    m_currentSearch = Find::SearchResultWindow::instance()->startNewSearch(label(),
                           toolTip().arg(Find::IFindFilter::descriptionForFindFlags(findFlags)),
                           txt, searchMode, QString::fromLatin1("TextEditor"));
122
    m_currentSearch->setTextToReplace(txt);
123
124
    QVariantList searchParameters;
    searchParameters << qVariantFromValue(txt) << qVariantFromValue(findFlags);
125
126
    m_currentSearch->setUserData(searchParameters);
    connect(m_currentSearch, SIGNAL(activated(Find::SearchResultItem)), this, SLOT(openEditor(Find::SearchResultItem)));
127
    if (searchMode == SearchResultWindow::SearchAndReplace) {
128
        connect(m_currentSearch, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>)),
129
130
                this, SLOT(doReplace(QString,QList<Find::SearchResultItem>)));
    }
131
132
    connect(m_currentSearch, SIGNAL(visibilityChanged(bool)), this, SLOT(hideHighlightAll(bool)));
    Find::SearchResultWindow::instance()->popup(true);
133
    if (findFlags & Find::FindRegularExpression) {
134
        m_watcher->setFuture(Utils::findInFilesRegExp(txt, files(),
135
136
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    } else {
137
        m_watcher->setFuture(Utils::findInFiles(txt, files(),
138
139
            textDocumentFlagsForFindFlags(findFlags), ITextEditor::openedTextEditorsContents()));
    }
140
    connect(m_currentSearch, SIGNAL(cancelled()), this, SLOT(cancel()));
141
    Core::FutureProgress *progress =
142
        Core::ICore::instance()->progressManager()->addTask(m_watcher->future(),
Robert Loehning's avatar
Robert Loehning committed
143
                                                                        tr("Search"),
144
                                                                        Constants::TASK_SEARCH);
con's avatar
con committed
145
    progress->setWidget(createProgressWidget());
146
    connect(progress, SIGNAL(clicked()), Find::SearchResultWindow::instance(), SLOT(popup()));
con's avatar
con committed
147
148
}

149
150
151
152
153
void BaseFileFind::findAll(const QString &txt, Find::FindFlags findFlags)
{
    runNewSearch(txt, findFlags, SearchResultWindow::SearchOnly);
}

154
void BaseFileFind::replaceAll(const QString &txt, Find::FindFlags findFlags)
155
{
156
    runNewSearch(txt, findFlags, SearchResultWindow::SearchAndReplace);
157
158
159
160
161
162
163
164
165
}

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);
166
        Find::SearchResultWindow::instance()->hide();
167
168
169
    }
}

con's avatar
con committed
170
void BaseFileFind::displayResult(int index) {
171
    if (!m_currentSearch) {
172
        m_watcher->cancel();
173
174
        return;
    }
175
    Utils::FileSearchResultList results = m_watcher->resultAt(index);
176
    QList<Find::SearchResultItem> items;
177
178
    foreach (const Utils::FileSearchResult &result, results) {
        Find::SearchResultItem item;
179
        item.path = QStringList() << QDir::toNativeSeparators(result.fileName);
180
        item.lineNumber = result.lineNumber;
181
182
183
184
        item.text = result.matchingLine;
        item.textMarkLength = result.matchLength;
        item.textMarkPos = result.matchStart;
        item.useTextEditorFont = true;
185
186
187
        item.userData = result.regexpCapturedTexts;
        items << item;
    }
188
189
    m_currentSearch->addResults(items, Find::SearchResult::AddOrdered);
    m_currentSearchCount += items.count();
con's avatar
con committed
190
    if (m_resultLabel)
191
        m_resultLabel->setText(tr("%1 found").arg(m_currentSearchCount));
con's avatar
con committed
192
193
194
195
}

void BaseFileFind::searchFinished()
{
196
197
    if (m_currentSearch)
        m_currentSearch->finishSearch();
198
    m_currentSearch = 0;
con's avatar
con committed
199
200
    m_isSearching = false;
    m_resultLabel = 0;
201
202
    m_watcher->deleteLater();
    m_watcher = 0;
con's avatar
con committed
203
204
205
206
207
208
    emit changed();
}

QWidget *BaseFileFind::createProgressWidget()
{
    m_resultLabel = new QLabel;
209
    m_resultLabel->setAlignment(Qt::AlignCenter);
con's avatar
con committed
210
211
212
213
214
215
    // ### 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()));
216
    m_resultLabel->setText(tr("%1 found").arg(m_currentSearchCount));
con's avatar
con committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
    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
252
253
    if (m_filterCombo)
        syncComboWithSettings(m_filterCombo, m_filterSetting);
con's avatar
con committed
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
}

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

280
void BaseFileFind::openEditor(const Find::SearchResultItem &item)
con's avatar
con committed
281
{
282
283
    SearchResult *result = qobject_cast<SearchResult *>(sender());
    Core::IEditor *openedEditor = 0;
284
    if (item.path.size() > 0) {
285
286
287
288
289
        openedEditor = TextEditor::BaseTextEditorWidget::openEditorAt(QDir::fromNativeSeparators(item.path.first()),
                                                                      item.lineNumber,
                                                                      item.textMarkPos,
                                                                      QString(),
                                                                      Core::EditorManager::ModeSwitch);
290
    } else {
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
        openedEditor = Core::EditorManager::instance()->openEditor(item.text, QString(),
                                                                   Core::EditorManager::ModeSwitch);
    }
    if (m_currentFindSupport)
        m_currentFindSupport->clearResults();
    m_currentFindSupport = 0;
    if (!openedEditor)
        return;
    // highlight results
    if (IFindSupport *findSupport = Aggregation::query<IFindSupport>(openedEditor->widget())) {
        if (result) {
            QVariantList userData = result->userData().value<QVariantList>();
            QTC_ASSERT(userData.size() != 0, return);
            m_currentFindSupport = findSupport;
            m_currentFindSupport->highlightAll(userData.at(0).toString(), userData.at(1).value<FindFlags>());
        }
307
    }
con's avatar
con committed
308
}
309

310
311
312
313
314
315
void BaseFileFind::hideHighlightAll(bool visible)
{
    if (!visible && m_currentFindSupport)
        m_currentFindSupport->clearResults();
}

con's avatar
con committed
316
// #pragma mark Static methods
317
318
319

static void applyChanges(QTextDocument *doc, const QString &text, const QList<Find::SearchResultItem> &items)
{
320
    QList<QPair<QTextCursor, QString> > changes;
321
322
323
324
325

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

326
        const int cursorPosition = tc.position() + item.textMarkPos;
327
328

        int cursorIndex = 0;
329
330
        for (; cursorIndex < changes.size(); ++cursorIndex) {
            const QTextCursor &otherTc = changes.at(cursorIndex).first;
331

332
            if (otherTc.position() == cursorPosition)
333
334
335
                break;
        }

336
        if (cursorIndex != changes.size())
337
338
339
            continue; // skip this change.

        tc.setPosition(cursorPosition);
340
        tc.setPosition(tc.position() + item.textMarkLength,
341
                       QTextCursor::KeepAnchor);
342
343
344
345
346
347
        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));
348
349
    }

350
351
352
353
    for (int i = 0; i < changes.size(); ++i) {
        QPair<QTextCursor, QString> &cursor = changes[i];
        cursor.first.insertText(cursor.second);
    }
354
355
356
357
358
}

QStringList BaseFileFind::replaceAll(const QString &text,
                               const QList<Find::SearchResultItem> &items)
{
359
    if (items.isEmpty())
360
361
362
363
364
        return QStringList();

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

    foreach (const Find::SearchResultItem &item, items)
365
        changes[QDir::fromNativeSeparators(item.path.first())].append(item);
366
367
368
369
370
371
372
373

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

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

        const QString fileName = it.key();
374
        const QList<Find::SearchResultItem> changeItems = it.value();
375
376

        const QList<Core::IEditor *> editors = editorManager->editorsForFileName(fileName);
377
        TextEditor::BaseTextEditorWidget *textEditor = 0;
378
        foreach (Core::IEditor *editor, editors) {
379
            textEditor = qobject_cast<TextEditor::BaseTextEditorWidget *>(editor->widget());
380
381
382
383
384
385
386
            if (textEditor != 0)
                break;
        }

        if (textEditor != 0) {
            QTextCursor tc = textEditor->textCursor();
            tc.beginEditBlock();
387
            applyChanges(textEditor->document(), text, changeItems);
388
389
            tc.endEditBlock();
        } else {
390
391
            Utils::FileReader reader;
            if (reader.fetch(fileName, Core::ICore::instance()->mainWindow())) {
392
393
394
395
396
397
398
                // 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;

399
                QTextDocument doc;
400
                // ### set the encoding
401
                doc.setPlainText(QString::fromLocal8Bit(data));
402
                applyChanges(&doc, text, changeItems);
403
404
405
406
                QString plainText = doc.toPlainText();

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

408
409
410
                Utils::FileSaver saver(fileName);
                if (!saver.hasError()) {
                    QTextStream stream(saver.file());
411
                    // ### set the encoding
412
                    stream << plainText;
413
                    saver.setResult(&stream);
414
                }
415
                saver.finalize(Core::ICore::instance()->mainWindow());
416
417
418
419
420
421
            }
        }
    }

    return changes.keys();
}