Changeset 70231 in vbox for trunk/src/VBox/Frontends

Timestamp:

Dec 20, 2017 8:17:28 AM (7 years ago)

Author:

vboxsync

Message:

FE/Qt bugref:9072 Adding 'wrap around' and 'highlight all' functionalities to logviewer search

Location:

trunk/src/VBox/Frontends/VirtualBox/src/logviewer

Files:

• UIVMLogViewerSearchPanel.cpp (modified) (12 diffs)
• UIVMLogViewerSearchPanel.h (modified) (4 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/logviewer/UIVMLogViewerSearchPanel.cpp

@@ -49 +49 @@
     , m_pNextPrevButtons(0)
     , m_pCaseSensitiveCheckBox(0)
+    , m_pMatchWholeWordCheckBox(0)
+    , m_pHighlightAllCheckBox(0)
     , m_pWarningSpacer(0), m_pWarningIcon(0), m_pWarningLabel(0)
+    , m_iSearchPosition(0)
 {
     /* Prepare: */
@@ -71 +74 @@
     m_pNextPrevButtons->setEnabled(0, strSearchString.length());
     m_pNextPrevButtons->setEnabled(1, strSearchString.length());
-    /* Show/hide the warning as per search-string validity: */
-    toggleWarning(!strSearchString.length());
+
     /* If search-string is valid: */
     if (strSearchString.length())
-        search(true, true);
+    {
+        /* Reset the position to force the search restart from the document's beginnig: */
+        m_iSearchPosition = 0;
+        search(ForwardSearch);
+    }
     /* If search-string is not valid, reset cursor position: */
     else
@@ -92 +98 @@
 }
 
+void UIVMLogViewerSearchPanel::sltHighlightAllCheckBox()
+{
+    QPlainTextEdit *pTextEdit = m_pViewer->currentLogPage();
+    if (!pTextEdit) return;
+    QTextDocument *pDocument = pTextEdit->document();
+    if (!pDocument)
+        return;
+
+    if (m_pHighlightAllCheckBox->isChecked())
+    {
+        const QString &searchString = m_pSearchEditor->text();
+        if (searchString.isEmpty())
+            return;
+        highlightAll(pDocument, constructFindFlags(ForwardSearch), searchString);
+    }
+    else
+    {
+        pDocument->undo();
+    }
+}
+
 void UIVMLogViewerSearchPanel::prepare()
 {
@@ -112 +139 @@
         /* Configure main-layout: */
         m_pMainLayout->setContentsMargins(0, 0, 0, 0);
+        m_pMainLayout->setSpacing(4);
 
         /* Create close-button: */
@@ -167 +195 @@
         AssertPtrReturnVoid(m_pCaseSensitiveCheckBox);
         {
-            /* Configure focus for case-sensitive checkbox: */
-            setFocusProxy(m_pCaseSensitiveCheckBox);
             /* Configure font: */
 #ifdef VBOX_DARWIN_USE_NATIVE_CONTROLS
@@ -178 +204 @@
             m_pMainLayout->addWidget(m_pCaseSensitiveCheckBox);
         }
+
+        m_pMatchWholeWordCheckBox = new QCheckBox;
+        AssertPtrReturnVoid(m_pMatchWholeWordCheckBox);
+        {
+            /* Configure focus for case-sensitive checkbox: */
+            setFocusProxy(m_pMatchWholeWordCheckBox);
+            /* Configure font: */
+#ifdef VBOX_DARWIN_USE_NATIVE_CONTROLS
+            QFont font = m_pMatchWholeWordCheckBox->font();
+            font.setPointSize(::darwinSmallFontSize());
+            m_pMatchWholeWordCheckBox->setFont(font);
+#endif /* VBOX_DARWIN_USE_NATIVE_CONTROLS */
+            m_pMainLayout->addWidget(m_pMatchWholeWordCheckBox);
+        }
+
+        m_pHighlightAllCheckBox = new QCheckBox;
+        AssertPtrReturnVoid(m_pHighlightAllCheckBox);
+        {
+            /* Configure font: */
+#ifdef VBOX_DARWIN_USE_NATIVE_CONTROLS
+            QFont font = m_pHighlightAllCheckBox->font();
+            font.setPointSize(::darwinSmallFontSize());
+            m_pHighlightAllCheckBox->setFont(font);
+#endif /* VBOX_DARWIN_USE_NATIVE_CONTROLS */
+            /* Add case-sensitive checkbox to main-layout: */
+            m_pMainLayout->addWidget(m_pHighlightAllCheckBox);
+        }
+
 
         /* Create warning-spacer: */
@@ -233 +287 @@
             this, SLOT(findCurrent(const QString &)));
     connect(m_pNextPrevButtons, SIGNAL(clicked(int)), this, SLOT(find(int)));
+    connect(m_pHighlightAllCheckBox, &QCheckBox::stateChanged,
+            this, &UIVMLogViewerSearchPanel::sltHighlightAllCheckBox);
 }
 
@@ -242 +298 @@
     m_pSearchEditor->setToolTip(UIVMLogViewerWidget::tr("Enter a search string here"));
 
-    m_pNextPrevButtons->setTitle(0, UIVMLogViewerWidget::tr("&Previous"));
     m_pNextPrevButtons->setToolTip(0, UIVMLogViewerWidget::tr("Search for the previous occurrence of the string"));
-    m_pNextPrevButtons->setTitle(1, UIVMLogViewerWidget::tr("&Next"));
     m_pNextPrevButtons->setToolTip(1, UIVMLogViewerWidget::tr("Search for the next occurrence of the string"));
 
-    m_pCaseSensitiveCheckBox->setText(UIVMLogViewerWidget::tr("C&ase Sensitive"));
+    m_pCaseSensitiveCheckBox->setText(UIVMLogViewerWidget::tr("C&ase\nSensitive"));
     m_pCaseSensitiveCheckBox->setToolTip(UIVMLogViewerWidget::tr("Perform case sensitive search (when checked)"));
+
+    m_pMatchWholeWordCheckBox->setText(UIVMLogViewerWidget::tr("Ma&tch\nWhole Word"));
+    m_pMatchWholeWordCheckBox->setToolTip(UIVMLogViewerWidget::tr("Search matches only complete words when checked"));
+
+    m_pHighlightAllCheckBox->setText(UIVMLogViewerWidget::tr("Highlight\nAll"));
+    m_pHighlightAllCheckBox->setToolTip(UIVMLogViewerWidget::tr("All occurence of the search text are highlighted"));
 
     m_pWarningLabel->setText(UIVMLogViewerWidget::tr("String not found"));
@@ -259 +319 @@
         /* Process Enter press as 'search-next',
          * performed for any search panel widget: */
-    case Qt::Key_Enter:
-    case Qt::Key_Return:
-        {
-            if (pEvent->modifiers() == 0 ||
-                pEvent->modifiers() & Qt::KeypadModifier)
+        case Qt::Key_Enter:
+        case Qt::Key_Return:
             {
-                /* Animate click on 'Next' button: */
+                if (pEvent->modifiers() == 0 ||
+                    pEvent->modifiers() & Qt::KeypadModifier)
+                {
+                    /* Animate click on 'Next' button: */
                 m_pNextPrevButtons->animateClick(1);
                 return;
+                }
+                break;
             }
+        default:
             break;
-        }
-    default:
-        break;
     }
     /* Call to base-class: */
@@ -283 +343 @@
     switch (pEvent->type())
     {
+
         /* Process key press only: */
-    case QEvent::KeyPress:
+        case QEvent::KeyPress:
         {
             /* Cast to corresponding key press event: */
@@ -368 +429 @@
 }
 
-void UIVMLogViewerSearchPanel::search(bool fForward, bool fStartCurrent /* = false */)
-{
-    /* Get current log-page: */
-    QPlainTextEdit *pBrowser = m_pViewer->currentLogPage();
-    if (!pBrowser) return;
-
-    /* Get text-cursor and its attributes: */
-    QTextCursor cursor = pBrowser->textCursor();
-    int iPos = cursor.position();
-    int iAnc = cursor.anchor();
-
-    /* Get the text to be searched: */
-    QString strText = pBrowser->toPlainText();
-    int iDiff = fStartCurrent ? 0 : 1;
-
-    int iResult = -1;
-    /* If search-direction is forward and cursor position is valid: */
-    if (fForward && (fStartCurrent || iPos < strText.size() - 1))
-    {
-        /* Search and get the index of first match: */
-        iResult = strText.indexOf(m_pSearchEditor->text(), iAnc + iDiff,
-                                  m_pCaseSensitiveCheckBox->isChecked() ?
-                                  Qt::CaseSensitive : Qt::CaseInsensitive);
-
-        /* When searchstring is changed, search from beginning of log again: */
-        if (iResult == -1 && fStartCurrent)
-            iResult = strText.indexOf(m_pSearchEditor->text(), 0,
-                                      m_pCaseSensitiveCheckBox->isChecked() ?
-                                      Qt::CaseSensitive : Qt::CaseInsensitive);
-    }
-    /* If search-direction is backward: */
-    else if (!fForward && iAnc > 0)
-        iResult = strText.lastIndexOf(m_pSearchEditor->text(), iAnc - 1,
-                                      m_pCaseSensitiveCheckBox->isChecked() ?
-                                      Qt::CaseSensitive : Qt::CaseInsensitive);
-
-    /* If the result is valid, move cursor-position: */
-    if (iResult != -1)
-    {
-        cursor.movePosition(QTextCursor::Start,
-                            QTextCursor::MoveAnchor);
-        cursor.movePosition(QTextCursor::NextCharacter,
-                            QTextCursor::MoveAnchor, iResult);
-        cursor.movePosition(QTextCursor::NextCharacter,
-                            QTextCursor::KeepAnchor,
-                            m_pSearchEditor->text().size());
-        pBrowser->setTextCursor(cursor);
-    }
-
-    /* Show/hide the warning as per search-result: */
-    toggleWarning(iResult != -1);
+void UIVMLogViewerSearchPanel::search(SearchDirection direction)
+{
+   QPlainTextEdit *pTextEdit = m_pViewer->currentLogPage();
+   if (!pTextEdit) return;
+   QTextDocument *pDocument = pTextEdit->document();
+   if (!pDocument)
+       return;
+
+   const QString &searchString = m_pSearchEditor->text();
+   if (searchString.isEmpty())
+       return;
+
+   QTextCursor endCursor(pDocument);
+   endCursor.movePosition(QTextCursor::End);
+   QTextCursor startCursor(pDocument);
+
+   /* Construct the find flags for QTextDocument::find function: */
+   QTextDocument::FindFlags findFlags = constructFindFlags(direction);
+
+   if (m_pHighlightAllCheckBox->isChecked())
+       highlightAll(pDocument, findFlags, searchString);
+
+   QTextCursor resultCursor(pDocument);
+   int startPosition = m_iSearchPosition;
+   if (direction == BackwardSearch)
+       startPosition -= searchString.length();
+   resultCursor = pDocument->find(searchString, startPosition, findFlags);
+
+   /* Decide whether to wrap around or to end the search */
+   if (resultCursor.isNull())
+   {
+       /* End the search if we search the whole document with no find: */
+       if ((direction == ForwardSearch && startPosition == startCursor.position()) ||
+           (direction == BackwardSearch && startPosition == endCursor.position()))
+       {
+           toggleWarning(false);
+           return;
+       }
+       /* Wrap the search */
+       if (direction == ForwardSearch)
+       {
+           m_iSearchPosition = startCursor.position();
+           search(ForwardSearch);
+           return;
+       }
+       else
+       {
+           /* Set the search position away from the end position to be
+              able to find the string at the end of the document: */
+           m_iSearchPosition = endCursor.position() + searchString.length();
+           search(BackwardSearch);
+           return;
+       }
+   }
+   pTextEdit->setTextCursor(resultCursor);
+   m_iSearchPosition = resultCursor.position();
+   toggleWarning(true);
 }
 
 void UIVMLogViewerSearchPanel::findNext()
 {
-    search(true);
+    search(ForwardSearch);
 }
 
 void UIVMLogViewerSearchPanel::findBack()
 {
-    search(false);
+    search(BackwardSearch);
+}
+
+void UIVMLogViewerSearchPanel::highlightAll(QTextDocument *pDocument,
+                                            const QTextDocument::FindFlags &findFlags,
+                                            const QString &searchString)
+{
+    if (!pDocument)
+        return;
+    if (searchString.isEmpty())
+        return;
+
+    pDocument->undo();
+    QTextCursor highlightCursor(pDocument);
+    QTextCharFormat colorFormat(highlightCursor.charFormat());
+    QTextCursor cursor(pDocument);
+    cursor.beginEditBlock();
+
+    colorFormat.setBackground(Qt::yellow);
+
+    while (!highlightCursor.isNull() && !highlightCursor.atEnd())
+    {
+        highlightCursor = pDocument->find(searchString, highlightCursor, findFlags);
+
+        if (!highlightCursor.isNull())
+            highlightCursor.mergeCharFormat(colorFormat);
+    }
+    cursor.endEditBlock();
 }
 
@@ -446 +540 @@
     m_pWarningLabel->setHidden(fHide);
 }
+
+QTextDocument::FindFlags UIVMLogViewerSearchPanel::constructFindFlags(SearchDirection eDirection)
+{
+   QTextDocument::FindFlags findFlags;
+   if (eDirection == BackwardSearch)
+       findFlags = findFlags | QTextDocument::FindBackward;
+   if (m_pCaseSensitiveCheckBox->isChecked())
+       findFlags = findFlags | QTextDocument::FindCaseSensitively;
+   if (m_pMatchWholeWordCheckBox->isChecked())
+       findFlags = findFlags | QTextDocument::FindWholeWords;
+   return findFlags;
+}

trunk/src/VBox/Frontends/VirtualBox/src/logviewer/UIVMLogViewerSearchPanel.h

@@ -20 +20 @@
 
 /* Qt includes: */
+#include <QTextDocument>
 #include <QWidget>
 
@@ -55 +56 @@
       * @param  strSearchString  Specifies search-string. */
     void findCurrent(const QString &strSearchString);
+
+    void sltHighlightAllCheckBox();
 private:
-
+    enum SearchDirection { ForwardSearch, BackwardSearch };
     /** Prepares search-panel. */
     void prepare();
@@ -76 +79 @@
 
     /** Search routine.
-      * @param  fForward       Specifies the direction of search.
-      * @param  fStartCurrent  Specifies whether search should start from beginning of the log. */
-    void search(bool fForward, bool fStartCurrent = false);
+      * @param  eDirection     Specifies the seach direction */
+    void search(SearchDirection eDirection);
     /** Forward search routine wrapper. */
     void findNext();
     /** Backward search routine wrapper. */
     void findBack();
+    void highlightAll(QTextDocument *pDocument, const QTextDocument::FindFlags &findFlags, const QString &searchString);
     /** Shows/hides the search border warning using @a fHide as hint. */
     void toggleWarning(bool fHide);
+    /** Constructs the find flags for QTextDocument::find function. */
+    QTextDocument::FindFlags constructFindFlags(SearchDirection eDirection);
 
     /** Holds the reference to the VM Log-Viewer this search-panel belongs to. */
@@ -99 +104 @@
     UIRoundRectSegmentedButton *m_pNextPrevButtons;
     /** Holds the instance of case-sensitive checkbox we create. */
-    QCheckBox *m_pCaseSensitiveCheckBox;
+    QCheckBox   *m_pCaseSensitiveCheckBox;
+    QCheckBox   *m_pMatchWholeWordCheckBox;
+    QCheckBox   *m_pHighlightAllCheckBox;
     /** Holds the instance of warning spacer-item we create. */
     QSpacerItem *m_pWarningSpacer;
     /** Holds the instance of warning icon we create. */
-    QLabel *m_pWarningIcon;
+    QLabel      *m_pWarningIcon;
     /** Holds the instance of warning label we create. */
-    QLabel *m_pWarningLabel;
+    QLabel      *m_pWarningLabel;
     /** Holds the instance of spacer item we create. */
     QSpacerItem *m_pSpacerItem;
+    /** Holds the position where we start the next search. */
+    int          m_iSearchPosition;
 };