Qt: Move all utility widgets to widgets subdirectory

Move all utility widgets to the widgets subdirectory and
add separate source_group for their files

Correct some alphabetization in ui/qt/CMakeLists.txt noticed
during compare.

Change-Id: I2d664edc2b32f126438fb673ea53a5ae94cd43d1
Reviewed-on: https://code.wireshark.org/review/22531
Petri-Dish: Michael Mann <mmann78@netscape.net>
Reviewed-by: Roland Knall <rknall@gmail.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>

1 files changed, 400 insertions, 0 deletions

diff --git a/ui/qt/widgets/syntax_line_edit.cpp b/ui/qt/widgets/syntax_line_edit.cpp
new file mode 100644
index 0000000000..432ad3dc49
--- /dev/null
+++ b/ui/qt/widgets/syntax_line_edit.cpp
@@ -0,0 +1,400 @@
+/* syntax_line_edit.cpp
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <glib.h>
+
+#include <epan/prefs.h>
+#include <epan/proto.h>
+#include <epan/dfilter/dfilter.h>
+#include <epan/column-info.h>
+
+#include "syntax_line_edit.h"
+
+#include "color_utils.h"
+
+#include <QAbstractItemView>
+#include <QCompleter>
+#include <QKeyEvent>
+#include <QScrollBar>
+#include <QStringListModel>
+#include <limits>
+
+// To do:
+// - Add indicator icons for syntax states to make things more clear for
+//   color blind people?
+
+const int max_completion_items_ = 20;
+
+SyntaxLineEdit::SyntaxLineEdit(QWidget *parent) :
+    QLineEdit(parent),
+    completer_(NULL),
+    completion_model_(NULL)
+{
+    // Try to matche QLineEdit's placeholder text color (which sets the
+    // alpha channel to 50%, which doesn't work in style sheets).
+    // Setting the foreground color lets us avoid yet another background
+    // color preference and should hopefully make things easier to
+    // distinguish for color blind folk.
+    busy_fg_ = ColorUtils::alphaBlend(palette().text(), palette().base(), 0.5);
+
+    setSyntaxState();
+    setMaxLength(std::numeric_limits<quint32>::max());
+}
+
+// Override setCompleter so that we don't clobber the filter text on activate.
+void SyntaxLineEdit::setCompleter(QCompleter *c)
+{
+    if (completer_)
+        QObject::disconnect(completer_, 0, this, 0);
+
+    completer_ = c;
+
+    if (!completer_)
+        return;
+
+    completer_->setWidget(this);
+    completer_->setCompletionMode(QCompleter::PopupCompletion);
+    completer_->setCaseSensitivity(Qt::CaseInsensitive);
+    // Completion items are not guaranteed to be sorted (recent filters +
+    // fields), so no setModelSorting.
+    completer_->setMaxVisibleItems(max_completion_items_);
+    QObject::connect(completer_, SIGNAL(activated(QString)),
+                     this, SLOT(insertFieldCompletion(QString)));
+}
+
+void SyntaxLineEdit::setSyntaxState(SyntaxState state) {
+    syntax_state_ = state;
+    state_style_sheet_ = QString(
+            "SyntaxLineEdit[syntaxState=\"%1\"] {"
+            "  color: %5;"
+            "  background-color: %7;"
+            "}"
+
+            "SyntaxLineEdit[syntaxState=\"%2\"] {"
+            "  color: %5;"
+            "  background-color: %8;"
+            "}"
+
+            "SyntaxLineEdit[syntaxState=\"%3\"] {"
+            "  color: %5;"
+            "  background-color: %9;"
+            "}"
+
+            "SyntaxLineEdit[syntaxState=\"%4\"] {"
+            "  color: %10;"
+            "  background-color: %6;"
+            "}"
+            )
+
+            // CSS selectors
+            .arg(Valid)
+            .arg(Invalid)
+            .arg(Deprecated)
+            .arg(Busy)
+
+            // Normal foreground / background
+            .arg("palette(text)")
+            .arg("palette(base)")
+
+            // Special foreground / background
+            .arg(ColorUtils::fromColorT(&prefs.gui_text_valid).name())
+            .arg(ColorUtils::fromColorT(&prefs.gui_text_invalid).name())
+            .arg(ColorUtils::fromColorT(&prefs.gui_text_deprecated).name())
+            .arg(busy_fg_.name())
+            ;
+    setStyleSheet(style_sheet_);
+}
+
+QString SyntaxLineEdit::syntaxErrorMessage() {
+    return syntax_error_message_;
+}
+
+QString SyntaxLineEdit::styleSheet() const {
+    return style_sheet_;
+}
+
+void SyntaxLineEdit::setStyleSheet(const QString &style_sheet) {
+    style_sheet_ = style_sheet;
+    QLineEdit::setStyleSheet(style_sheet_ + state_style_sheet_);
+}
+
+void SyntaxLineEdit::insertFilter(const QString &filter)
+{
+    QString padded_filter = filter;
+
+    if (hasSelectedText()) {
+        backspace();
+    }
+
+    int pos = cursorPosition();
+    if (pos > 0 && !text().at(pos - 1).isSpace()) {
+        padded_filter.prepend(" ");
+    }
+    if (pos < text().length() - 1 && !text().at(pos + 1).isSpace()) {
+        padded_filter.append(" ");
+    }
+    insert(padded_filter);
+}
+
+void SyntaxLineEdit::checkDisplayFilter(QString filter)
+{
+    if (filter.isEmpty()) {
+        setSyntaxState(SyntaxLineEdit::Empty);
+        return;
+    }
+
+    dfilter_t *dfp = NULL;
+    gchar *err_msg;
+    if (dfilter_compile(filter.toUtf8().constData(), &dfp, &err_msg)) {
+        GPtrArray *depr = NULL;
+        if (dfp) {
+            depr = dfilter_deprecated_tokens(dfp);
+        }
+        if (depr) {
+            // You keep using that word. I do not think it means what you think it means.
+            setSyntaxState(SyntaxLineEdit::Deprecated);
+            /*
+             * We're being lazy and only printing the first "problem" token.
+             * Would it be better to print all of them?
+             */
+            syntax_error_message_ = tr("\"%1\" may have unexpected results (see the User's Guide)")
+                    .arg((const char *) g_ptr_array_index(depr, 0));
+        } else {
+            setSyntaxState(SyntaxLineEdit::Valid);
+        }
+    } else {
+        setSyntaxState(SyntaxLineEdit::Invalid);
+        syntax_error_message_ = QString::fromUtf8(err_msg);
+        g_free(err_msg);
+    }
+    dfilter_free(dfp);
+}
+
+void SyntaxLineEdit::checkFieldName(QString field)
+{
+    if (field.isEmpty()) {
+        setSyntaxState(SyntaxLineEdit::Empty);
+        return;
+    }
+
+    char invalid_char = proto_check_field_name(field.toUtf8().constData());
+    if (invalid_char) {
+        setSyntaxState(SyntaxLineEdit::Invalid);
+    } else {
+        checkDisplayFilter(field);
+    }
+}
+
+void SyntaxLineEdit::checkCustomColumn(QString fields)
+{
+    if (fields.isEmpty()) {
+        setSyntaxState(SyntaxLineEdit::Empty);
+        return;
+    }
+
+    gchar **splitted_fields = g_regex_split_simple(COL_CUSTOM_PRIME_REGEX,
+                fields.toUtf8().constData(), G_REGEX_ANCHORED, G_REGEX_MATCH_ANCHORED);
+
+    for (guint i = 0; i < g_strv_length(splitted_fields); i++) {
+        if (splitted_fields[i] && *splitted_fields[i]) {
+            if (proto_check_field_name(splitted_fields[i]) != 0) {
+                setSyntaxState(SyntaxLineEdit::Invalid);
+                g_strfreev(splitted_fields);
+                return;
+            }
+        }
+    }
+    g_strfreev(splitted_fields);
+
+    checkDisplayFilter(fields);
+}
+
+void SyntaxLineEdit::checkInteger(QString number)
+{
+    if (number.isEmpty()) {
+        setSyntaxState(SyntaxLineEdit::Empty);
+        return;
+    }
+
+    bool ok;
+    text().toInt(&ok);
+    if (ok) {
+        setSyntaxState(SyntaxLineEdit::Valid);
+    } else {
+        setSyntaxState(SyntaxLineEdit::Invalid);
+    }
+}
+
+bool SyntaxLineEdit::isComplexFilter(const QString &filter)
+{
+    bool is_complex = false;
+    for (int i = 0; i < filter.length(); i++) {
+        if (!token_chars_.contains(filter.at(i))) {
+            is_complex = true;
+            break;
+        }
+    }
+    // Don't complete the current filter.
+    if (is_complex && filter.startsWith(text()) && filter.compare(text())) {
+        return true;
+    }
+    return false;
+}
+
+bool SyntaxLineEdit::event(QEvent *event)
+{
+    if (event->type() == QEvent::ShortcutOverride) {
+        // You can't set time display formats while the display filter edit
+        // has focus.
+
+        // Keep shortcuts in the main window from stealing keyPressEvents
+        // with Ctrl+Alt modifiers from us. This is a problem for many AltGr
+        // combinations since they are delivered with Ctrl+Alt modifiers
+        // instead of Qt::Key_AltGr and they tend to match the time display
+        // format shortcuts.
+
+        // Uncommenting the qDebug line below prints the following here:
+        //
+        // US Keyboard:
+        // Ctrl+o: 79 QFlags<Qt::KeyboardModifiers>(ControlModifier) "\u000F"
+        // Ctrl+Alt+2: 50 QFlags<Qt::KeyboardModifiers>(ControlModifier|AltModifier) "2"
+        //
+        // Swedish (Sweden) Keyboard:
+        // Ctrl+o: 79 QFlags<Qt::KeyboardModifiers>(ControlModifier) "\u000F"
+        // Ctrl+Alt+2: 64 QFlags<Qt::KeyboardModifiers>(ControlModifier|AltModifier) "@"
+        // AltGr+{: 123 QFlags<Qt::KeyboardModifiers>(ControlModifier|AltModifier) "{"
+
+        QKeyEvent* key_event = static_cast<QKeyEvent*>(event);
+        // qDebug() << "=so" << key_event->key() << key_event->modifiers() << key_event->text();
+
+        if (key_event->modifiers() == Qt::KeyboardModifiers(Qt::ControlModifier|Qt::AltModifier)) {
+            event->accept();
+            return true;
+        }
+    }
+    return QLineEdit::event(event);
+}
+
+void SyntaxLineEdit::completionKeyPressEvent(QKeyEvent *event)
+{
+    // Forward to the completer if needed...
+    if (completer_ && completer_->popup()->isVisible()) {
+        switch (event->key()) {
+        case Qt::Key_Enter:
+        case Qt::Key_Return:
+        case Qt::Key_Tab:
+            focusNextChild();
+            break;
+        case Qt::Key_Escape:
+        case Qt::Key_Backtab:
+            event->ignore();
+            return;
+        default:
+            break;
+        }
+    }
+
+    // ...otherwise process the key ourselves.
+    SyntaxLineEdit::keyPressEvent(event);
+
+    if (!completer_ || !completion_model_) return;
+
+    // Do nothing on bare shift.
+    if ((event->modifiers() & Qt::ShiftModifier) && event->text().isEmpty()) return;
+
+    if (event->modifiers() & (Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier)) {
+        completer_->popup()->hide();
+        return;
+    }
+
+    QPoint token_coords(getTokenUnderCursor());
+
+    QString token_word = text().mid(token_coords.x(), token_coords.y());
+    buildCompletionList(token_word);
+
+    if (completion_model_->stringList().length() < 1) {
+        completer_->popup()->hide();
+        return;
+    }
+
+    QRect cr = cursorRect();
+    cr.setWidth(completer_->popup()->sizeHintForColumn(0)
+                + completer_->popup()->verticalScrollBar()->sizeHint().width());
+    completer_->complete(cr);
+}
+
+void SyntaxLineEdit::completionFocusInEvent(QFocusEvent *event)
+{
+    if (completer_)
+        completer_->setWidget(this);
+    SyntaxLineEdit::focusInEvent(event);
+}
+
+void SyntaxLineEdit::focusOutEvent(QFocusEvent *event)
+{
+    if (completer_ && completer_->popup()->isVisible() && event->reason() == Qt::PopupFocusReason) {
+        // Pretend we still have focus so that we'll draw our cursor.
+        // If cursorRect() were more precise we could just draw the cursor
+        // during a paintEvent.
+        return;
+    }
+    QLineEdit::focusOutEvent(event);
+}
+
+void SyntaxLineEdit::insertFieldCompletion(const QString &completion_text)
+{
+    if (!completer_) return;
+
+    QPoint field_coords(getTokenUnderCursor());
+
+    // Insert only if we have a matching field or if the entry is empty
+    if (field_coords.y() < 1 && !text().isEmpty()) {
+        completer_->popup()->hide();
+        return;
+    }
+
+    QString new_text = text().replace(field_coords.x(), field_coords.y(), completion_text);
+    setText(new_text);
+    setCursorPosition(field_coords.x() + completion_text.length());
+    emit textEdited(new_text);
+}
+
+QPoint SyntaxLineEdit::getTokenUnderCursor()
+{
+    if (selectionStart() >= 0) return (QPoint(0,0));
+
+    int pos = cursorPosition();
+    int start = pos;
+    int len = 0;
+
+    while (start > 0 && token_chars_.contains(text().at(start -1))) {
+        start--;
+        len++;
+    }
+    while (pos < text().length() && token_chars_.contains(text().at(pos))) {
+        pos++;
+        len++;
+    }
+
+    return QPoint(start, len);
+}