ui/qt/models/uat_delegate.cpp

   1 /* uat_delegate.cpp
   2  * Delegates for editing various field types in a UAT record.
   3  *
   4  * Copyright 2016 Peter Wu <peter@lekensteyn.nl>
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * SPDX-License-Identifier: GPL-2.0-or-later
  11  */
  12
  13 #include <ui/qt/models/uat_delegate.h>
  14 #include <epan/packet.h> // for get_dissector_names()
  15 #include "epan/value_string.h"
  16 #include <wsutil/ws_assert.h>
  17 #include <QRegularExpression>
  18 #include <QComboBox>
  19 #include <QEvent>
  20 #include <QFileDialog>
  21 #include <QLineEdit>
  22 #include <QCheckBox>
  23 #include <QColorDialog>
  24
  25 #include <ui/qt/widgets/display_filter_edit.h>
  26 #include <ui/qt/widgets/dissector_syntax_line_edit.h>
  27 #include <ui/qt/widgets/field_filter_edit.h>
  28 #include <ui/qt/widgets/editor_file_dialog.h>
  29 #include <ui/qt/widgets/path_selection_edit.h>
  30
  31 // The Qt docs suggest overriding updateEditorGeometry, but the
  32 // defaults seem sane.
  33
  34 UatDelegate::UatDelegate(QObject *parent) : QStyledItemDelegate(parent)
  35 {
  36 }
  37
  38 uat_field_t *UatDelegate::indexToField(const QModelIndex &index) const
  39 {
  40     const QVariant v = index.model()->data(index, Qt::UserRole);
  41     return static_cast<uat_field_t *>(v.value<void *>());
  42 }
  43
  44 QWidget *UatDelegate::createEditor(QWidget *parent, const QStyleOptionViewItem &option,
  45                                   const QModelIndex &index) const
  46 {
  47     uat_field_t *field = indexToField(index);
  48     QWidget *editor = nullptr;
  49
  50     switch (field->mode) {
  51     case PT_TXTMOD_DIRECTORYNAME:
  52     case PT_TXTMOD_FILENAME:
  53         if (index.isValid()) {
  54             QString filename_old = index.model()->data(index, Qt::EditRole).toString();
  55             PathSelectionEdit * pathEdit = new PathSelectionEdit(field->title, QString(), field->mode != PT_TXTMOD_DIRECTORYNAME, parent);
  56             connect(pathEdit, &PathSelectionEdit::pathChanged, this, &UatDelegate::pathHasChanged);
  57             return pathEdit;
  58         }
  59         break;
  60    case PT_TXTMOD_COLOR:
  61         if (index.isValid()) {
  62             QColor color(index.model()->data(index, Qt::DecorationRole).toString());
  63             QColorDialog * colorDialog = new QColorDialog(color, parent);
  64             // Don't fall through and set setAutoFillBackground(true)
  65             return colorDialog;
  66         }
  67         break;
  68
  69     case PT_TXTMOD_ENUM:
  70     {
  71         // Note: the string repr. is written, not the integer value.
  72         QComboBox *cb_editor = new QComboBox(parent);
  73         const value_string *enum_vals = (const value_string *)field->fld_data;
  74         for (int i = 0; enum_vals[i].strptr != nullptr; i++) {
  75             cb_editor->addItem(enum_vals[i].strptr);
  76         }
  77         editor = cb_editor;
  78         cb_editor->setMinimumWidth(cb_editor->minimumSizeHint().width());
  79         break;
  80     }
  81
  82     case PT_TXTMOD_DISSECTOR:
  83     {
  84         editor = new DissectorSyntaxLineEdit(parent);
  85         break;
  86     }
  87
  88     case PT_TXTMOD_STRING:
  89         // TODO add a live validator? Should SyntaxLineEdit be used?
  90         editor = QStyledItemDelegate::createEditor(parent, option, index);
  91         break;
  92
  93     case PT_TXTMOD_DISPLAY_FILTER:
  94         editor = new DisplayFilterEdit(parent);
  95         break;
  96
  97     case PT_TXTMOD_PROTO_FIELD:
  98         editor = new FieldFilterEdit(parent);
  99         break;
 100
 101     case PT_TXTMOD_HEXBYTES:
 102     {
 103         // Requires input of the form "ab cd ef" (with possibly no or a colon
 104         // separator instead of a single whitespace) for the editor to accept.
 105         QRegularExpression hexbytes_regex("([0-9a-f]{2}[ :]?)*");
 106         hexbytes_regex.setPatternOptions(QRegularExpression::CaseInsensitiveOption);
 107         // QString types from QStyledItemDelegate are documented to return a
 108         // QLineEdit. Note that Qt returns a subclass from QLineEdit which
 109         // automatically adapts the width to the typed contents.
 110         QLineEdit *le_editor = static_cast<QLineEdit *>(
 111                 QStyledItemDelegate::createEditor(parent, option, index));
 112         le_editor->setValidator(new QRegularExpressionValidator(hexbytes_regex, le_editor));
 113         editor = le_editor;
 114         break;
 115     }
 116
 117     case PT_TXTMOD_BOOL:
 118         // model will handle creating checkbox
 119         break;
 120
 121     case PT_TXTMOD_NONE:
 122         break;
 123
 124     default:
 125         ws_assert_not_reached();
 126         break;
 127     }
 128
 129     if (editor) {
 130         editor->setAutoFillBackground(true);
 131     }
 132     return editor;
 133 }
 134
 135 void UatDelegate::setEditorData(QWidget *editor, const QModelIndex &index) const
 136 {
 137     uat_field_t *field = indexToField(index);
 138
 139     switch (field->mode) {
 140     case PT_TXTMOD_DIRECTORYNAME:
 141     case PT_TXTMOD_FILENAME:
 142         if (index.isValid() && qobject_cast<PathSelectionEdit *>(editor))
 143             qobject_cast<PathSelectionEdit *>(editor)->setPath(index.model()->data(index, Qt::EditRole).toString());
 144         break;
 145     case PT_TXTMOD_ENUM:
 146     {
 147         QComboBox *combobox = static_cast<QComboBox *>(editor);
 148         const QString &data = index.model()->data(index, Qt::EditRole).toString();
 149         combobox->setCurrentText(data);
 150
 151         break;
 152     }
 153     case PT_TXTMOD_COLOR:
 154     {
 155         if (qobject_cast<QColorDialog *>(editor))
 156         {
 157             QColor color(index.model()->data(index, Qt::DecorationRole).toString());
 158             qobject_cast<QColorDialog *>(editor)->setCurrentColor(color);
 159         }
 160         break;
 161     }
 162
 163     default:
 164         QStyledItemDelegate::setEditorData(editor, index);
 165     }
 166 }
 167
 168 void UatDelegate::setModelData(QWidget *editor, QAbstractItemModel *model,
 169                               const QModelIndex &index) const
 170 {
 171     uat_field_t *field = indexToField(index);
 172
 173     switch (field->mode) {
 174     case PT_TXTMOD_DIRECTORYNAME:
 175     case PT_TXTMOD_FILENAME:
 176         if (index.isValid() && qobject_cast<PathSelectionEdit *>(editor))
 177             const_cast<QAbstractItemModel *>(index.model())->setData(index, qobject_cast<PathSelectionEdit *>(editor)->path(), Qt::EditRole);
 178         break;
 179     case PT_TXTMOD_ENUM:
 180     {
 181         QComboBox *combobox = static_cast<QComboBox *>(editor);
 182         const QString &data = combobox->currentText();
 183         model->setData(index, data, Qt::EditRole);
 184         break;
 185     }
 186     case PT_TXTMOD_COLOR:
 187         //do nothing, dialog signals will update table
 188         if (qobject_cast<QColorDialog *>(editor))
 189         {
 190             QColor newColor = qobject_cast<QColorDialog *>(editor)->currentColor();
 191             const_cast<QAbstractItemModel *>(index.model())->setData(index, newColor.name(), Qt::EditRole);
 192         }
 193         break;
 194
 195     default:
 196         QStyledItemDelegate::setModelData(editor, model, index);
 197     }
 198 }
 199
 200 void UatDelegate::updateEditorGeometry(QWidget *editor,
 201                                            const QStyleOptionViewItem &option,
 202                                            const QModelIndex &index) const
 203 {
 204     uat_field_t *field = indexToField(index);
 205
 206     switch (field->mode) {
 207     case PT_TXTMOD_DIRECTORYNAME:
 208     case PT_TXTMOD_FILENAME:
 209         editor->setGeometry(option.rect);
 210         break;
 211     default:
 212         QStyledItemDelegate::updateEditorGeometry(editor, option, index);
 213     }
 214 }
 215
 216 void UatDelegate::pathHasChanged(QString)
 217 {
 218     PathSelectionEdit * editor = qobject_cast<PathSelectionEdit *>(sender());
 219     if (editor)
 220         emit commitData(editor);
 221 }