Refactor the search result widget to its own class.

To be used for switching between multiple search result lists.

Change-Id: I4cf62f7e5adf71bac7d4fdfed05d74cea4f3ca44
Rubber-stamped-by: Daniel Teske
Reviewed-on: http://codereview.qt.nokia.com/4255


Reviewed-by: Eike Ziller <eike.ziller@nokia.com>

src/plugins/find/find.pro

@@ -17,7 +17,8 @@ HEADERS += findtoolwindow.h \
     searchresulttreeitems.h \
     searchresulttreemodel.h \
     searchresulttreeview.h \
-    searchresultwindow.h
+    searchresultwindow.h \
+    searchresultwidget.h
 SOURCES += findtoolwindow.cpp \
     currentdocumentfind.cpp \
     basetextfind.cpp \
@@ -29,7 +30,10 @@ SOURCES += findtoolwindow.cpp \
     searchresulttreeview.cpp \
     searchresultwindow.cpp \
     ifindfilter.cpp \
-    ifindsupport.cpp
+    ifindsupport.cpp \
+    searchresultwidget.cpp
 FORMS += findwidget.ui \
     finddialog.ui
 RESOURCES += find.qrc
+
+

src/plugins/find/searchresultwidget.cpp

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (info@qt.nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at info@qt.nokia.com.
+**
+**************************************************************************/
+
+#include "searchresultwidget.h"
+#include "searchresulttreeview.h"
+#include "searchresulttreemodel.h"
+#include "searchresulttreeitems.h"
+
+#include "ifindsupport.h"
+
+#include <aggregation/aggregate.h>
+#include <coreplugin/icore.h>
+
+#include <QtCore/QDir>
+#include <QtCore/QSettings>
+#include <QtGui/QVBoxLayout>
+
+namespace Find {
+namespace Internal {
+
+class WideEnoughLineEdit : public QLineEdit {
+    Q_OBJECT
+public:
+    WideEnoughLineEdit(QWidget *parent):QLineEdit(parent){
+        connect(this, SIGNAL(textChanged(QString)),
+                this, SLOT(updateGeometry()));
+    }
+    ~WideEnoughLineEdit(){}
+    QSize sizeHint() const {
+        QSize sh = QLineEdit::minimumSizeHint();
+        sh.rwidth() += qMax(25 * fontMetrics().width(QLatin1Char('x')),
+                            fontMetrics().width(text()));
+        return sh;
+    }
+public slots:
+    void updateGeometry() { QLineEdit::updateGeometry(); }
+};
+
+class SearchResultFindSupport : public IFindSupport
+{
+    Q_OBJECT
+public:
+    SearchResultFindSupport(SearchResultTreeView *view)
+        : m_view(view),
+          m_incrementalWrappedState(false)
+    {
+    }
+
+    bool supportsReplace() const { return false; }
+
+    Find::FindFlags supportedFindFlags() const
+    {
+        return Find::FindBackward | Find::FindCaseSensitively
+                | Find::FindRegularExpression | Find::FindWholeWords;
+    }
+
+    void resetIncrementalSearch()
+    {
+        m_incrementalFindStart = QModelIndex();
+        m_incrementalWrappedState = false;
+    }
+
+    void clearResults() { }
+
+    QString currentFindString() const
+    {
+        return QString();
+    }
+
+    QString completedFindString() const
+    {
+        return QString();
+    }
+
+    void highlightAll(const QString &txt, Find::FindFlags findFlags)
+    {
+        Q_UNUSED(txt)
+        Q_UNUSED(findFlags)
+        return;
+    }
+
+    IFindSupport::Result findIncremental(const QString &txt, Find::FindFlags findFlags)
+    {
+        if (!m_incrementalFindStart.isValid()) {
+            m_incrementalFindStart = m_view->currentIndex();
+            m_incrementalWrappedState = false;
+        }
+        m_view->setCurrentIndex(m_incrementalFindStart);
+        bool wrapped = false;
+        IFindSupport::Result result = find(txt, findFlags, &wrapped);
+        if (wrapped != m_incrementalWrappedState) {
+            m_incrementalWrappedState = wrapped;
+            showWrapIndicator(m_view);
+        }
+        return result;
+    }
+
+    IFindSupport::Result findStep(const QString &txt, Find::FindFlags findFlags)
+    {
+        bool wrapped = false;
+        IFindSupport::Result result = find(txt, findFlags, &wrapped);
+        if (wrapped)
+            showWrapIndicator(m_view);
+        if (result == IFindSupport::Found) {
+            m_incrementalFindStart = m_view->currentIndex();
+            m_incrementalWrappedState = false;
+        }
+        return result;
+    }
+
+    IFindSupport::Result find(const QString &txt, Find::FindFlags findFlags, bool *wrapped)
+    {
+        if (wrapped)
+            *wrapped = false;
+        if (txt.isEmpty())
+            return IFindSupport::NotFound;
+        QModelIndex index;
+        if (findFlags & Find::FindRegularExpression) {
+            bool sensitive = (findFlags & Find::FindCaseSensitively);
+            index = m_view->model()->find(QRegExp(txt, (sensitive ? Qt::CaseSensitive : Qt::CaseInsensitive)),
+                                          m_view->currentIndex(),
+                                          Find::textDocumentFlagsForFindFlags(findFlags),
+                                          wrapped);
+        } else {
+            index = m_view->model()->find(txt,
+                                          m_view->currentIndex(),
+                                          Find::textDocumentFlagsForFindFlags(findFlags),
+                                          wrapped);
+        }
+        if (index.isValid()) {
+            m_view->setCurrentIndex(index);
+            m_view->scrollTo(index);
+            if (index.parent().isValid())
+                m_view->expand(index.parent());
+            return IFindSupport::Found;
+        }
+        return IFindSupport::NotFound;
+    }
+
+    void replace(const QString &before, const QString &after,
+        Find::FindFlags findFlags)
+    {
+        Q_UNUSED(before)
+        Q_UNUSED(after)
+        Q_UNUSED(findFlags)
+    }
+
+    bool replaceStep(const QString &before, const QString &after,
+        Find::FindFlags findFlags)
+    {
+        Q_UNUSED(before)
+        Q_UNUSED(after)
+        Q_UNUSED(findFlags)
+        return false;
+    }
+
+    int replaceAll(const QString &before, const QString &after,
+        Find::FindFlags findFlags)
+    {
+        Q_UNUSED(before)
+        Q_UNUSED(after)
+        Q_UNUSED(findFlags)
+        return 0;
+    }
+
+private:
+    SearchResultTreeView *m_view;
+    QModelIndex m_incrementalFindStart;
+    bool m_incrementalWrappedState;
+};
+
+} // Internal
+} // Find
+
+using namespace Find;
+using namespace Find::Internal;
+
+SearchResultWidget::SearchResultWidget(QWidget *parent) :
+    QWidget(parent),
+    m_count(0),
+    m_isShowingReplaceUI(false)
+{
+    QVBoxLayout *layout = new QVBoxLayout(this);
+    layout->setMargin(0);
+    layout->setSpacing(0);
+    setLayout(layout);
+
+    m_noMatchesFoundDisplay = new QListWidget(this);
+    m_noMatchesFoundDisplay->addItem(tr("No matches found!"));
+    m_noMatchesFoundDisplay->setFrameStyle(QFrame::NoFrame);
+    m_noMatchesFoundDisplay->hide();
+
+    m_searchResultTreeView = new Internal::SearchResultTreeView(this);
+    m_searchResultTreeView->setFrameStyle(QFrame::NoFrame);
+    m_searchResultTreeView->setAttribute(Qt::WA_MacShowFocusRect, false);
+    Aggregation::Aggregate * agg = new Aggregation::Aggregate;
+    agg->add(m_searchResultTreeView);
+    agg->add(new SearchResultFindSupport(m_searchResultTreeView));
+
+    layout->addWidget(m_noMatchesFoundDisplay);
+    layout->addWidget(m_searchResultTreeView);
+
+    m_infoBarDisplay.setTarget(layout, 0);
+    m_infoBarDisplay.setInfoBar(&m_infoBar);
+
+    m_replaceLabel = new QLabel(tr("Replace with:"), parent);
+    m_replaceLabel->setContentsMargins(12, 0, 5, 0);
+    m_replaceTextEdit = new WideEnoughLineEdit(parent);
+    m_replaceButton = new QToolButton(parent);
+    m_replaceButton->setToolTip(tr("Replace all occurrences"));
+    m_replaceButton->setText(tr("Replace"));
+    m_replaceButton->setToolButtonStyle(Qt::ToolButtonTextOnly);
+    m_replaceButton->setAutoRaise(true);
+    m_replaceTextEdit->setTabOrder(m_replaceTextEdit, m_searchResultTreeView);
+    setShowReplaceUI(false);
+
+    connect(m_searchResultTreeView, SIGNAL(jumpToSearchResult(SearchResultItem)),
+            this, SLOT(handleJumpToSearchResult(SearchResultItem)));
+    connect(m_replaceTextEdit, SIGNAL(returnPressed()), this, SLOT(handleReplaceButton()));
+    connect(m_replaceButton, SIGNAL(clicked()), this, SLOT(handleReplaceButton()));
+}
+
+void SearchResultWidget::addResult(const QString &fileName, int lineNumber, const QString &rowText,
+    int searchTermStart, int searchTermLength, const QVariant &userData)
+{
+    SearchResultItem item;
+    item.path = QStringList() << QDir::toNativeSeparators(fileName);
+    item.lineNumber = lineNumber;
+    item.text = rowText;
+    item.textMarkPos = searchTermStart;
+    item.textMarkLength = searchTermLength;
+    item.useTextEditorFont = true;
+    item.userData = userData;
+    addResults(QList<SearchResultItem>() << item, SearchResult::AddOrdered);
+}
+
+void SearchResultWidget::addResults(const QList<SearchResultItem> &items, SearchResult::AddMode mode)
+{
+    bool firstItems = (m_count == 0);
+    m_count += items.size();
+    m_searchResultTreeView->addResults(items, mode);
+    if (firstItems) {
+        if (!m_dontAskAgainGroup.isEmpty() && showWarningMessage()) {
+            Core::InfoBarEntry info("warninglabel", tr("This change cannot be undone."));
+            info.setCustomButtonInfo(tr("Do not warn again"), this, SLOT(hideNoUndoWarning()));
+            m_infoBar.addInfo(info);
+        }
+
+        m_replaceTextEdit->setEnabled(true);
+        // We didn't have an item before, set the focus to the search widget or replace text edit
+        if (m_isShowingReplaceUI) {
+            m_replaceTextEdit->setFocus();
+            m_replaceTextEdit->selectAll();
+        } else {
+            m_searchResultTreeView->setFocus();
+        }
+        m_searchResultTreeView->selectionModel()->select(m_searchResultTreeView->model()->index(0, 0, QModelIndex()), QItemSelectionModel::Select);
+        emit navigateStateChanged();
+    }
+}
+
+int SearchResultWidget::count() const
+{
+    return m_count;
+}
+
+QString SearchResultWidget::dontAskAgainGroup() const
+{
+    return m_dontAskAgainGroup;
+}
+
+void SearchResultWidget::setDontAskAgainGroup(const QString &group)
+{
+    m_dontAskAgainGroup = group;
+}
+
+
+void SearchResultWidget::setTextToReplace(const QString &textToReplace)
+{
+    m_replaceTextEdit->setText(textToReplace);
+}
+
+QString SearchResultWidget::textToReplace() const
+{
+    return m_replaceTextEdit->text();
+}
+
+void SearchResultWidget::setShowReplaceUI(bool visible)
+{
+    m_searchResultTreeView->model()->setShowReplaceUI(visible);
+    m_replaceLabel->setVisible(visible);
+    m_replaceTextEdit->setVisible(visible);
+    m_replaceButton->setVisible(visible);
+    m_isShowingReplaceUI = visible;
+}
+
+bool SearchResultWidget::hasFocusInternally() const
+{
+    return m_searchResultTreeView->hasFocus() || (m_isShowingReplaceUI && m_replaceTextEdit->hasFocus());
+}
+
+void SearchResultWidget::setFocusInternally()
+{
+    if (m_count > 0) {
+        if (m_isShowingReplaceUI) {
+            if (!focusWidget() || focusWidget() == m_replaceTextEdit) {
+                m_replaceTextEdit->setFocus();
+                m_replaceTextEdit->selectAll();
+            } else {
+                m_searchResultTreeView->setFocus();
+            }
+        } else {
+            m_searchResultTreeView->setFocus();
+        }
+    }
+}
+
+bool SearchResultWidget::canFocusInternally() const
+{
+    return m_count > 0;
+}
+
+void SearchResultWidget::notifyVisibilityChanged(bool visible)
+{
+    emit visibilityChanged(visible);
+}
+
+void SearchResultWidget::setTextEditorFont(const QFont &font)
+{
+    m_searchResultTreeView->setTextEditorFont(font);
+}
+
+void SearchResultWidget::setAutoExpandResults(bool expand)
+{
+    m_searchResultTreeView->setAutoExpandResults(expand);
+}
+
+void SearchResultWidget::expandAll()
+{
+    m_searchResultTreeView->expandAll();
+}
+
+void SearchResultWidget::collapseAll()
+{
+    m_searchResultTreeView->collapseAll();
+}
+
+void SearchResultWidget::goToNext()
+{
+    if (m_count == 0)
+        return;
+    QModelIndex idx = m_searchResultTreeView->model()->next(m_searchResultTreeView->currentIndex());
+    if (idx.isValid()) {
+        m_searchResultTreeView->setCurrentIndex(idx);
+        m_searchResultTreeView->emitJumpToSearchResult(idx);
+    }
+}
+
+void SearchResultWidget::goToPrevious()
+{
+    if (!m_searchResultTreeView->model()->rowCount())
+        return;
+    QModelIndex idx = m_searchResultTreeView->model()->prev(m_searchResultTreeView->currentIndex());
+    if (idx.isValid()) {
+        m_searchResultTreeView->setCurrentIndex(idx);
+        m_searchResultTreeView->emitJumpToSearchResult(idx);
+    }
+}
+
+void SearchResultWidget::finishSearch()
+{
+    if (m_count > 0) {
+        m_replaceButton->setEnabled(true);
+    } else {
+        showNoMatchesFound();
+    }
+}
+
+void SearchResultWidget::clear()
+{
+    m_replaceTextEdit->setEnabled(false);
+    m_replaceButton->setEnabled(false);
+    m_replaceTextEdit->clear();
+    m_searchResultTreeView->clear();
+    m_count = 0;
+    m_noMatchesFoundDisplay->hide();
+    m_infoBar.clear();
+}
+
+void SearchResultWidget::showNoMatchesFound()
+{
+    m_replaceTextEdit->setEnabled(false);
+    m_replaceButton->setEnabled(false);
+    m_noMatchesFoundDisplay->show();
+}
+
+void SearchResultWidget::hideNoUndoWarning()
+{
+    setShowWarningMessage(false);
+    m_infoBar.clear();
+}
+
+void SearchResultWidget::handleJumpToSearchResult(const SearchResultItem &item)
+{
+    emit activated(item);
+}
+
+void SearchResultWidget::handleReplaceButton()
+{
+    // check if button is actually enabled, because this is also triggered
+    // by pressing return in replace line edit
+    if (m_replaceButton->isEnabled()) {
+        m_infoBar.clear();
+        emit replaceButtonClicked(m_replaceTextEdit->text(), checkedItems());
+    }
+}
+
+bool SearchResultWidget::showWarningMessage() const
+{
+    // read settings
+    QSettings *settings = Core::ICore::instance()->settings();
+    settings->beginGroup(m_dontAskAgainGroup);
+    settings->beginGroup(QLatin1String("Rename"));
+    const bool showWarningMessage = settings->value(QLatin1String("ShowWarningMessage"), true).toBool();
+    settings->endGroup();
+    settings->endGroup();
+    return showWarningMessage;
+}
+
+void SearchResultWidget::setShowWarningMessage(bool showWarningMessage)
+{
+    // write to settings
+    QSettings *settings = Core::ICore::instance()->settings();
+    settings->beginGroup(m_dontAskAgainGroup);
+    settings->beginGroup(QLatin1String("Rename"));
+    settings->setValue(QLatin1String("ShowWarningMessage"), showWarningMessage);
+    settings->endGroup();
+    settings->endGroup();
+}
+
+QList<SearchResultItem> SearchResultWidget::checkedItems() const
+{
+    QList<SearchResultItem> result;
+    Internal::SearchResultTreeModel *model = m_searchResultTreeView->model();
+    const int fileCount = model->rowCount(QModelIndex());
+    for (int i = 0; i < fileCount; ++i) {
+        QModelIndex fileIndex = model->index(i, 0, QModelIndex());
+        Internal::SearchResultTreeItem *fileItem = static_cast<Internal::SearchResultTreeItem *>(fileIndex.internalPointer());
+        Q_ASSERT(fileItem != 0);
+        for (int rowIndex = 0; rowIndex < fileItem->childrenCount(); ++rowIndex) {
+            QModelIndex textIndex = model->index(rowIndex, 0, fileIndex);
+            Internal::SearchResultTreeItem *rowItem = static_cast<Internal::SearchResultTreeItem *>(textIndex.internalPointer());
+            if (rowItem->checkState())
+                result << rowItem->item;
+        }
+    }
+    return result;
+}
+
+#include "searchresultwidget.moc"

src/plugins/find/searchresultwidget.h

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (info@qt.nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** 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.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at info@qt.nokia.com.
+**
+**************************************************************************/
+
+#ifndef SEARCHRESULTWIDGET_H
+#define SEARCHRESULTWIDGET_H
+
+#include "searchresultwindow.h"
+
+#include <coreplugin/infobar.h>
+
+#include <QtGui/QLabel>
+#include <QtGui/QLineEdit>
+#include <QtGui/QListWidget>
+#include <QtGui/QToolButton>
+#include <QtGui/QWidget>
+
+namespace Find {
+namespace Internal {
+
+class SearchResultTreeView;
+
+class SearchResultWidget : public QWidget
+{
+    Q_OBJECT
+public:
+    explicit SearchResultWidget(QWidget *parent = 0);
+
+    void addResult(const QString &fileName, int lineNumber, const QString &lineText,
+                   int searchTermStart, int searchTermLength, const QVariant &userData = QVariant());
+    void addResults(const QList<SearchResultItem> &items, SearchResult::AddMode mode);
+
+    int count() const;
+
+    QString dontAskAgainGroup() const;
+    void setDontAskAgainGroup(const QString &group);
+
+    void setTextToReplace(const QString &textToReplace);
+    QString textToReplace() const;
+    void setShowReplaceUI(bool visible);
+
+    bool hasFocusInternally() const;
+    void setFocusInternally();
+    bool canFocusInternally() const;
+
+    void notifyVisibilityChanged(bool visible);
+
+    void setTextEditorFont(const QFont &font);
+
+    void setAutoExpandResults(bool expand);
+    void expandAll();
+    void collapseAll();
+
+    void goToNext();
+    void goToPrevious();
+
+    // TODO: temporary
+    QList<QWidget*> toolBarWidgets() const { return QList<QWidget*>() << m_replaceLabel << m_replaceTextEdit << m_replaceButton; }
+
+public slots:
+    void finishSearch();
+    void clear();
+    void showNoMatchesFound();
+
+signals:
+    void activated(const Find::SearchResultItem &item);
+    void replaceButtonClicked(const QString &replaceText, const QList<Find::SearchResultItem> &checkedItems);
+    void visibilityChanged(bool visible);
+
+    void navigateStateChanged();
+
+private slots:
+    void hideNoUndoWarning();
+    void handleJumpToSearchResult(const SearchResultItem &item);
+    void handleReplaceButton();
+
+private:
+    bool showWarningMessage() const;
+    void setShowWarningMessage(bool showWarningMessage);
+    QList<SearchResultItem> checkedItems() const;
+
+    SearchResultTreeView *m_searchResultTreeView;
+    int m_count;
+    QString m_dontAskAgainGroup;
+    Core::InfoBar m_infoBar;
+    Core::InfoBarDisplay m_infoBarDisplay;
+    QListWidget *m_noMatchesFoundDisplay;
+    bool m_isShowingReplaceUI;
+    QLabel *m_replaceLabel;
+    QLineEdit *m_replaceTextEdit;
+    QToolButton *m_replaceButton;
+};
+
+} // Internal
+} // Find
+
+#endif // SEARCHRESULTWIDGET_H

src/plugins/find/searchresultwindow.h

@@ -49,6 +49,7 @@ namespace Find {
 namespace Internal {
     class SearchResultTreeView;
     struct SearchResultWindowPrivate;
+    class SearchResultWidget;
 }
 class SearchResultWindow;
 
@@ -110,9 +111,12 @@ signals:
     void replaceButtonClicked(const QString &replaceText, const QList<Find::SearchResultItem> &checkedItems);
     void visibilityChanged(bool visible);
 
-    friend class SearchResultWindow;
+private:
+    SearchResult(Internal::SearchResultWidget *widget);
+    friend class SearchResultWindow; // for the constructor
 
 private:
+    Internal::SearchResultWidget *m_widget;
     QVariant m_userData;
 };
 
@@ -137,7 +141,6 @@ public:
     QString displayName() const { return tr("Search Results"); }
     int priorityInStatusBar() const;
     void visibilityChanged(bool visible);
-    bool isEmpty() const;
     bool hasFocus();
     bool canFocus();
     void setFocus();
@@ -159,31 +162,13 @@ public slots:
 
 private slots:
     void handleExpandCollapseToolButton(bool checked);
-    void handleJumpToSearchResult(const SearchResultItem &item);
-    void handleReplaceButton();
-    void showNoMatchesFound();
-    void hideNoUndoWarning();
 
 private:
-    // TODO: move to the new SearchResultWidget
-    void addResult(const QString &fileName, int lineNumber, const QString &lineText,
-                   int searchTermStart, int searchTermLength, const QVariant &userData);
-    void addResults(const QList<SearchResultItem> &items, SearchResult::AddMode mode); // TODO: move to SearchResultWidget)
-    void finishSearch();
-    void setTextToReplace(const QString &textToReplace);
-    QString textToReplace() const;
-
-
-    void setShowReplaceUI(bool show);
     void readSettings();
     void writeSettings();
-    QList<SearchResultItem> checkedItems() const;
-    bool showWarningMessage() const;
-    void setShowWarningMessage(bool showWarningMessage);
 
     Internal::SearchResultWindowPrivate *d;
     static SearchResultWindow *m_instance;
-    friend class SearchResult;
 };
 
 } // namespace Find