basefilefind.cpp 16.6 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
#include "basefilefind.h"
31
#include "basefilefind_p.h"
con's avatar
con committed
32

33
#include <aggregation/aggregate.h>
34
#include <coreplugin/icore.h>
35
#include <coreplugin/progressmanager/progressmanager.h>
36
#include <coreplugin/progressmanager/futureprogress.h>
37
#include <coreplugin/dialogs/readonlyfilesdialog.h>
38
#include <coreplugin/documentmanager.h>
39
40
#include <find/ifindsupport.h>
#include <texteditor/itexteditor.h>
41
#include <texteditor/refactoringchanges.h>
42
#include <utils/stylehelper.h>
43
#include <utils/qtcassert.h>
44
#include <utils/filesearch.h>
con's avatar
con committed
45

46
47
48
49
#include <QDebug>
#include <QSettings>
#include <QHash>
#include <QPair>
50
51
52
#include <QStringListModel>
#include <QFutureWatcher>
#include <QPointer>
53
#include <QComboBox>
54
#include <QLabel>
55
#include <QLabel>
con's avatar
con committed
56

57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
namespace TextEditor {
namespace Internal {
class BaseFileFindPrivate {
public:
    BaseFileFindPrivate() : m_resultLabel(0), m_filterCombo(0) {}

    QMap<QFutureWatcher<Utils::FileSearchResultList> *, QPointer<Find::SearchResult> > m_watchers;
    QPointer<Find::IFindSupport> m_currentFindSupport;

    QLabel *m_resultLabel;
    QStringListModel m_filterStrings;
    QString m_filterSetting;
    QPointer<QComboBox> m_filterCombo;
};
} // namespace Internal
} // namespace TextEditor

74
using namespace Utils;
con's avatar
con committed
75
76
using namespace Find;
using namespace TextEditor;
77
using namespace TextEditor::Internal;
con's avatar
con committed
78

79
80

BaseFileFind::BaseFileFind() : d(new BaseFileFindPrivate)
con's avatar
con committed
81
82
83
{
}

84
85
BaseFileFind::~BaseFileFind()
{
86
    delete d;
87
88
}

con's avatar
con committed
89
90
bool BaseFileFind::isEnabled() const
{
91
    return true;
con's avatar
con committed
92
93
}

dt's avatar
dt committed
94
95
void BaseFileFind::cancel()
{
96
97
    SearchResult *search = qobject_cast<SearchResult *>(sender());
    QTC_ASSERT(search, return);
98
    QFutureWatcher<FileSearchResultList> *watcher = d->m_watchers.key(search);
99
100
    QTC_ASSERT(watcher, return);
    watcher->cancel();
dt's avatar
dt committed
101
102
}

103
104
105
106
void BaseFileFind::setPaused(bool paused)
{
    SearchResult *search = qobject_cast<SearchResult *>(sender());
    QTC_ASSERT(search, return);
107
    QFutureWatcher<FileSearchResultList> *watcher = d->m_watchers.key(search);
108
109
110
111
112
    QTC_ASSERT(watcher, return);
    if (!paused || watcher->isRunning()) // guard against pausing when the search is finished
        watcher->setPaused(paused);
}

con's avatar
con committed
113
114
115
QStringList BaseFileFind::fileNameFilters() const
{
    QStringList filters;
116
117
    if (d->m_filterCombo && !d->m_filterCombo->currentText().isEmpty()) {
        const QStringList parts = d->m_filterCombo->currentText().split(QLatin1Char(','));
con's avatar
con committed
118
        foreach (const QString &part, parts) {
119
            const QString filter = part.trimmed();
120
            if (!filter.isEmpty())
con's avatar
con committed
121
122
123
124
125
126
                filters << filter;
        }
    }
    return filters;
}

127
128
void BaseFileFind::runNewSearch(const QString &txt, Find::FindFlags findFlags,
                                    SearchResultWindow::SearchMode searchMode)
con's avatar
con committed
129
{
130
131
132
    d->m_currentFindSupport = 0;
    if (d->m_filterCombo)
        updateComboEntries(d->m_filterCombo, true);
133
    SearchResult *search = Find::SearchResultWindow::instance()->startNewSearch(label(),
134
135
                           toolTip().arg(Find::IFindFilter::descriptionForFindFlags(findFlags)),
                           txt, searchMode, QString::fromLatin1("TextEditor"));
136
    search->setTextToReplace(txt);
137
138
139
140
141
142
143
    search->setSearchAgainSupported(true);
    FileFindParameters parameters;
    parameters.text = txt;
    parameters.flags = findFlags;
    parameters.nameFilters = fileNameFilters();
    parameters.additionalParameters = additionalParameters();
    search->setUserData(qVariantFromValue(parameters));
144
    connect(search, SIGNAL(activated(Find::SearchResultItem)), this, SLOT(openEditor(Find::SearchResultItem)));
145
    if (searchMode == SearchResultWindow::SearchAndReplace) {
146
147
        connect(search, SIGNAL(replaceButtonClicked(QString,QList<Find::SearchResultItem>,bool)),
                this, SLOT(doReplace(QString,QList<Find::SearchResultItem>,bool)));
148
    }
149
    connect(search, SIGNAL(visibilityChanged(bool)), this, SLOT(hideHighlightAll(bool)));
150
    connect(search, SIGNAL(cancelled()), this, SLOT(cancel()));
151
    connect(search, SIGNAL(paused(bool)), this, SLOT(setPaused(bool)));
152
    connect(search, SIGNAL(searchAgainRequested()), this, SLOT(searchAgain()));
153
154
155
    connect(this, SIGNAL(enabledChanged(bool)), search, SIGNAL(requestEnabledCheck()));
    connect(search, SIGNAL(requestEnabledCheck()), this, SLOT(recheckEnabled()));

156
157
158
159
160
161
    runSearch(search);
}

void BaseFileFind::runSearch(Find::SearchResult *search)
{
    FileFindParameters parameters = search->userData().value<FileFindParameters>();
162
163
    CountingLabel *label = new CountingLabel;
    connect(search, SIGNAL(countChanged(int)), label, SLOT(updateCount(int)));
164
165
    CountingLabel *statusLabel = new CountingLabel;
    connect(search, SIGNAL(countChanged(int)), statusLabel, SLOT(updateCount(int)));
166
    Find::SearchResultWindow::instance()->popup(Core::IOutputPane::Flags(Core::IOutputPane::ModeSwitch | Core::IOutputPane::WithFocus));
167
    QFutureWatcher<FileSearchResultList> *watcher = new QFutureWatcher<FileSearchResultList>();
168
    d->m_watchers.insert(watcher, search);
169
170
171
172
173
174
175
    watcher->setPendingResultsLimit(1);
    connect(watcher, SIGNAL(resultReadyAt(int)), this, SLOT(displayResult(int)));
    connect(watcher, SIGNAL(finished()), this, SLOT(searchFinished()));
    if (parameters.flags & Find::FindRegularExpression) {
        watcher->setFuture(Utils::findInFilesRegExp(parameters.text,
            files(parameters.nameFilters, parameters.additionalParameters),
            textDocumentFlagsForFindFlags(parameters.flags),
176
            ITextEditor::openedTextDocumentContents()));
177
    } else {
178
179
180
        watcher->setFuture(Utils::findInFiles(parameters.text,
            files(parameters.nameFilters, parameters.additionalParameters),
            textDocumentFlagsForFindFlags(parameters.flags),
181
            ITextEditor::openedTextDocumentContents()));
182
    }
183
    Core::FutureProgress *progress =
hjk's avatar
hjk committed
184
        Core::ICore::progressManager()->addTask(watcher->future(),
Robert Loehning's avatar
Robert Loehning committed
185
                                                                        tr("Search"),
186
                                                                        QLatin1String(Constants::TASK_SEARCH));
187
    progress->setWidget(label);
188
    progress->setStatusBarWidget(statusLabel);
189
    connect(progress, SIGNAL(clicked()), search, SLOT(popup()));
con's avatar
con committed
190
191
}

192
193
194
195
196
void BaseFileFind::findAll(const QString &txt, Find::FindFlags findFlags)
{
    runNewSearch(txt, findFlags, SearchResultWindow::SearchOnly);
}

197
void BaseFileFind::replaceAll(const QString &txt, Find::FindFlags findFlags)
198
{
199
    runNewSearch(txt, findFlags, SearchResultWindow::SearchAndReplace);
200
201
202
}

void BaseFileFind::doReplace(const QString &text,
203
204
                             const QList<Find::SearchResultItem> &items,
                             bool preserveCase)
205
{
206
    QStringList files = replaceAll(text, items, preserveCase);
207
    if (!files.isEmpty()) {
208
        Core::DocumentManager::notifyFilesChangedInternally(files);
209
        Find::SearchResultWindow::instance()->hide();
210
211
212
    }
}

con's avatar
con committed
213
void BaseFileFind::displayResult(int index) {
214
215
    QFutureWatcher<FileSearchResultList> *watcher =
            static_cast<QFutureWatcher<FileSearchResultList> *>(sender());
216
    SearchResult *search = d->m_watchers.value(watcher);
217
218
219
    if (!search) {
        // search was removed from search history while the search is running
        watcher->cancel();
220
221
        return;
    }
222
    Utils::FileSearchResultList results = watcher->resultAt(index);
223
    QList<Find::SearchResultItem> items;
224
225
    foreach (const Utils::FileSearchResult &result, results) {
        Find::SearchResultItem item;
226
        item.path = QStringList() << QDir::toNativeSeparators(result.fileName);
227
        item.lineNumber = result.lineNumber;
228
229
230
231
        item.text = result.matchingLine;
        item.textMarkLength = result.matchLength;
        item.textMarkPos = result.matchStart;
        item.useTextEditorFont = true;
232
233
234
        item.userData = result.regexpCapturedTexts;
        items << item;
    }
235
    search->addResults(items, Find::SearchResult::AddOrdered);
con's avatar
con committed
236
237
238
239
}

void BaseFileFind::searchFinished()
{
240
241
    QFutureWatcher<FileSearchResultList> *watcher =
            static_cast<QFutureWatcher<FileSearchResultList> *>(sender());
242
    SearchResult *search = d->m_watchers.value(watcher);
243
    if (search)
Eike Ziller's avatar
Eike Ziller committed
244
        search->finishSearch(watcher->isCanceled());
245
    d->m_watchers.remove(watcher);
246
    watcher->deleteLater();
con's avatar
con committed
247
248
249
250
251
}

QWidget *BaseFileFind::createPatternWidget()
{
    QString filterToolTip = tr("List of comma separated wildcard filters");
252
253
254
255
256
257
258
259
260
261
262
    d->m_filterCombo = new QComboBox;
    d->m_filterCombo->setEditable(true);
    d->m_filterCombo->setModel(&d->m_filterStrings);
    d->m_filterCombo->setMaxCount(10);
    d->m_filterCombo->setMinimumContentsLength(10);
    d->m_filterCombo->setSizeAdjustPolicy(QComboBox::AdjustToMinimumContentsLengthWithIcon);
    d->m_filterCombo->setInsertPolicy(QComboBox::InsertAtBottom);
    d->m_filterCombo->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
    d->m_filterCombo->setToolTip(filterToolTip);
    syncComboWithSettings(d->m_filterCombo, d->m_filterSetting);
    return d->m_filterCombo;
con's avatar
con committed
263
264
265
266
}

void BaseFileFind::writeCommonSettings(QSettings *settings)
{
267
268
269
    settings->setValue(QLatin1String("filters"), d->m_filterStrings.stringList());
    if (d->m_filterCombo)
        settings->setValue(QLatin1String("currentFilter"), d->m_filterCombo->currentText());
con's avatar
con committed
270
271
272
273
}

void BaseFileFind::readCommonSettings(QSettings *settings, const QString &defaultFilter)
{
274
    QStringList filters = settings->value(QLatin1String("filters")).toStringList();
275
    d->m_filterSetting = settings->value(QLatin1String("currentFilter")).toString();
con's avatar
con committed
276
277
    if (filters.isEmpty())
        filters << defaultFilter;
278
279
280
281
282
    if (d->m_filterSetting.isEmpty())
        d->m_filterSetting = filters.first();
    d->m_filterStrings.setStringList(filters);
    if (d->m_filterCombo)
        syncComboWithSettings(d->m_filterCombo, d->m_filterSetting);
con's avatar
con committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
}

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) {
300
        if (onTop)
con's avatar
con committed
301
            combo->insertItem(0, combo->currentText());
302
        else
con's avatar
con committed
303
304
305
306
307
            combo->addItem(combo->currentText());
        combo->setCurrentIndex(combo->findText(combo->currentText()));
    }
}

308
void BaseFileFind::openEditor(const Find::SearchResultItem &item)
con's avatar
con committed
309
{
310
311
    SearchResult *result = qobject_cast<SearchResult *>(sender());
    Core::IEditor *openedEditor = 0;
312
    if (item.path.size() > 0) {
313
314
        openedEditor = Core::EditorManager::openEditorAt(QDir::fromNativeSeparators(item.path.first()),
                                                         item.lineNumber,
Eike Ziller's avatar
Eike Ziller committed
315
                                                         item.textMarkPos);
316
    } else {
Eike Ziller's avatar
Eike Ziller committed
317
        openedEditor = Core::EditorManager::openEditor(QDir::fromNativeSeparators(item.text));
318
    }
319
320
321
    if (d->m_currentFindSupport)
        d->m_currentFindSupport->clearResults();
    d->m_currentFindSupport = 0;
322
323
324
325
326
    if (!openedEditor)
        return;
    // highlight results
    if (IFindSupport *findSupport = Aggregation::query<IFindSupport>(openedEditor->widget())) {
        if (result) {
327
            FileFindParameters parameters = result->userData().value<FileFindParameters>();
328
329
            d->m_currentFindSupport = findSupport;
            d->m_currentFindSupport->highlightAll(parameters.text, parameters.flags);
330
        }
331
    }
con's avatar
con committed
332
}
333

334
335
void BaseFileFind::hideHighlightAll(bool visible)
{
336
337
    if (!visible && d->m_currentFindSupport)
        d->m_currentFindSupport->clearResults();
338
339
}

340
341
342
void BaseFileFind::searchAgain()
{
    SearchResult *search = qobject_cast<SearchResult *>(sender());
Eike Ziller's avatar
Eike Ziller committed
343
    search->restart();
344
345
346
    runSearch(search);
}

347
348
349
350
351
352
353
354
void BaseFileFind::recheckEnabled()
{
    SearchResult *search = qobject_cast<SearchResult *>(sender());
    if (!search)
        return;
    search->setSearchAgainEnabled(isEnabled());
}

355
QStringList BaseFileFind::replaceAll(const QString &text,
356
357
                                     const QList<Find::SearchResultItem> &items,
                                     bool preserveCase)
358
{
359
    if (items.isEmpty())
360
361
        return QStringList();

362
    RefactoringChanges refactoring;
363

364
    QHash<QString, QList<Find::SearchResultItem> > changes;
365
    foreach (const Find::SearchResultItem &item, items)
366
        changes[QDir::fromNativeSeparators(item.path.first())].append(item);
367

368
    // Checking for files without write permissions
369
    QHashIterator<QString, QList<Find::SearchResultItem> > it(changes);
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
    QSet<QString> roFiles;
    while (it.hasNext()) {
        it.next();
        const QFileInfo fileInfo(it.key());
        if (!fileInfo.isWritable())
            roFiles.insert(it.key());
    }

    // Query the user for permissions
    if (!roFiles.isEmpty()) {
        Core::Internal::ReadOnlyFilesDialog roDialog(roFiles.toList(),
                                                     Core::ICore::instance()->mainWindow());
        roDialog.setShowFailWarning(true, tr("Aborting replace."));
        if (roDialog.exec() == Core::Internal::ReadOnlyFilesDialog::RO_Cancel)
            return QStringList();
    }

    it.toFront();
388
389
390
    while (it.hasNext()) {
        it.next();
        const QString fileName = it.key();
391
        const QList<Find::SearchResultItem> changeItems = it.value();
392

393
394
395
396
397
398
399
400
401
402
        ChangeSet changeSet;
        RefactoringFilePtr file = refactoring.file(fileName);
        QSet<QPair<int, int> > processed;
        foreach (const Find::SearchResultItem &item, changeItems) {
            const QPair<int, int> &p = qMakePair(item.lineNumber, item.textMarkPos);
            if (processed.contains(p))
                continue;
            processed.insert(p);

            QString replacement;
403
            if (item.userData.canConvert<QStringList>() && !item.userData.toStringList().isEmpty()) {
404
                replacement = Utils::expandRegExpReplacement(text, item.userData.toStringList());
405
406
407
408
409
            } else if (preserveCase) {
                const QString originalText = (item.textMarkLength == 0) ? item.text
                                                                        : item.text.mid(item.textMarkPos, item.textMarkLength);
                replacement = Utils::matchCaseReplacement(originalText, text);
            } else {
410
                replacement = text;
411
            }
412
413
414
415
416

            const int start = file->position(item.lineNumber, item.textMarkPos + 1);
            const int end = file->position(item.lineNumber,
                                           item.textMarkPos + item.textMarkLength + 1);
            changeSet.replace(start, end, replacement);
417
        }
418
419
        file->setChangeSet(changeSet);
        file->apply();
420
421
422
423
    }

    return changes.keys();
}
424

425
426
427
428
429
QVariant BaseFileFind::getAdditionalParameters(SearchResult *search)
{
    return search->userData().value<FileFindParameters>().additionalParameters;
}

430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
CountingLabel::CountingLabel()
{
    setAlignment(Qt::AlignCenter);
    // ### TODO this setup should be done by style
    QFont f = font();
    f.setBold(true);
    f.setPointSizeF(StyleHelper::sidebarFontSize());
    setFont(f);
    setPalette(StyleHelper::sidebarFontPalette(palette()));
    updateCount(0);
}

void CountingLabel::updateCount(int count)
{
    setText(tr("%1 found").arg(count));
}