ui/qt/funnel_text_dialog.cpp

   1 /* funnel_text_dialog.cpp
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #include "funnel_text_dialog.h"
  11 #include <ui_funnel_text_dialog.h>
  12
  13 #include <QPushButton>
  14 #include <QRegularExpression>
  15 #include <QTextCharFormat>
  16 #include <QTextCursor>
  17
  18 #include <ui/qt/utils/qt_ui_utils.h>
  19 #include "main_application.h"
  20
  21 // To do:
  22 // - Add "Find next" to highlighting.
  23 // - Add rich text support?
  24 // - Zoom text?
  25
  26 static QHash<QObject *, funnel_bt_t*> text_button_to_funnel_button_;
  27
  28 FunnelTextDialog::FunnelTextDialog(QWidget *parent, const QString &title) :
  29     GeometryStateDialog(parent),
  30     ui(new Ui::FunnelTextDialog),
  31     close_cb_(NULL),
  32     close_cb_data_(NULL)
  33 {
  34     ui->setupUi(this);
  35     if (!title.isEmpty()) {
  36         loadGeometry(0, 0, QStringLiteral("Funnel %1").arg(title));
  37     }
  38     setWindowTitle(mainApp->windowTitleString(title));
  39
  40     funnel_text_window_.funnel_text_dialog = this;
  41
  42     ui->textEdit->setFont(mainApp->monospaceFont());
  43     ui->textEdit->setReadOnly(true);
  44     ui->textEdit->setAcceptRichText(false);
  45 }
  46
  47 FunnelTextDialog::~FunnelTextDialog()
  48 {
  49     delete ui;
  50 }
  51
  52 void FunnelTextDialog::reject()
  53 {
  54     QDialog::reject();
  55
  56     if (close_cb_) {
  57         close_cb_(close_cb_data_);
  58     }
  59
  60     for (const auto& button : ui->buttonBox->buttons()) {
  61         funnel_bt_t *funnel_button = text_button_to_funnel_button_.take(qobject_cast<QObject*>(button));
  62         if (funnel_button != nullptr) {
  63             if (funnel_button->free_data_fcn) {
  64                 funnel_button->free_data_fcn(funnel_button->data);
  65             }
  66             if (funnel_button->free_fcn) {
  67                 funnel_button->free_fcn(funnel_button);
  68             }
  69         }
  70     }
  71
  72     disconnect();
  73     deleteLater();
  74 }
  75
  76 struct _funnel_text_window_t *FunnelTextDialog::textWindowNew(QWidget *parent, const QString title)
  77 {
  78     FunnelTextDialog *ftd = new FunnelTextDialog(parent, title);
  79     ftd->show();
  80     return &ftd->funnel_text_window_;
  81 }
  82
  83 void FunnelTextDialog::setText(const QString text)
  84 {
  85     ui->textEdit->setText(text);
  86 }
  87
  88 void FunnelTextDialog::appendText(const QString text)
  89 {
  90     ui->textEdit->moveCursor(QTextCursor::End);
  91     ui->textEdit->insertPlainText(text);
  92 }
  93
  94 void FunnelTextDialog::prependText(const QString text)
  95 {
  96     ui->textEdit->moveCursor(QTextCursor::Start);
  97     ui->textEdit->insertPlainText(text);
  98 }
  99
 100 void FunnelTextDialog::clearText()
 101 {
 102     ui->textEdit->clear();
 103 }
 104
 105 const char *FunnelTextDialog::getText()
 106 {
 107     return qstring_strdup(ui->textEdit->toPlainText());
 108 }
 109
 110 void FunnelTextDialog::setCloseCallback(text_win_close_cb_t close_cb, void *close_cb_data)
 111 {
 112     close_cb_ = close_cb;
 113     close_cb_data_ = close_cb_data;
 114 }
 115
 116 void FunnelTextDialog::setTextEditable(bool editable)
 117 {
 118     ui->textEdit->setReadOnly(!editable);
 119 }
 120
 121 void FunnelTextDialog::addButton(funnel_bt_t *funnel_button, QString label)
 122 {
 123     // Use "&&" to get a real ampersand in the button.
 124     label.replace('&', "&&");
 125
 126     QPushButton *button = new QPushButton(label);
 127     ui->buttonBox->addButton(button, QDialogButtonBox::ActionRole);
 128     text_button_to_funnel_button_[button] = funnel_button;
 129     connect(button, &QPushButton::clicked, this, &FunnelTextDialog::buttonClicked);
 130 }
 131
 132 void FunnelTextDialog::buttonClicked()
 133 {
 134     if (text_button_to_funnel_button_.contains(sender())) {
 135         funnel_bt_t *funnel_button = text_button_to_funnel_button_[sender()];
 136         if (funnel_button) {
 137             funnel_button->func(&funnel_text_window_, funnel_button->data);
 138         }
 139     }
 140 }
 141
 142 void FunnelTextDialog::on_findLineEdit_textChanged(const QString &pattern)
 143 {
 144     QRegularExpression re(pattern, QRegularExpression::CaseInsensitiveOption |
 145                           QRegularExpression::UseUnicodePropertiesOption);
 146     QTextCharFormat plain_fmt, highlight_fmt;
 147     highlight_fmt.setBackground(Qt::yellow);
 148     QTextCursor csr(ui->textEdit->document());
 149     int position = csr.position();
 150
 151     setUpdatesEnabled(false);
 152
 153     // Reset highlighting
 154     csr.movePosition(QTextCursor::Start);
 155     csr.movePosition(QTextCursor::End, QTextCursor::KeepAnchor);
 156     csr.setCharFormat(plain_fmt);
 157
 158     // Apply new highlighting
 159     if (!pattern.isEmpty() && re.isValid()) {
 160         QRegularExpressionMatchIterator iter = re.globalMatch(ui->textEdit->toPlainText());
 161         while (iter.hasNext()) {
 162             QRegularExpressionMatch match = iter.next();
 163             csr.setPosition(static_cast<int>(match.capturedStart()), QTextCursor::MoveAnchor);
 164             csr.setPosition(static_cast<int>(match.capturedEnd()), QTextCursor::KeepAnchor);
 165             csr.setCharFormat(highlight_fmt);
 166         }
 167     }
 168
 169     // Restore cursor and anchor
 170     csr.setPosition(position, QTextCursor::MoveAnchor);
 171     setUpdatesEnabled(true);
 172 }
 173
 174 void text_window_set_text(funnel_text_window_t *ftw, const char* text)
 175 {
 176     if (ftw) {
 177         ftw->funnel_text_dialog->setText(text);
 178     }
 179 }
 180
 181 void text_window_append(funnel_text_window_t* ftw, const char* text)
 182 {
 183     if (ftw) {
 184         ftw->funnel_text_dialog->appendText(text);
 185     }
 186 }
 187
 188 void text_window_prepend(funnel_text_window_t *ftw, const char* text)
 189 {
 190     if (ftw) {
 191         ftw->funnel_text_dialog->prependText(text);
 192     }
 193 }
 194
 195 void text_window_clear(funnel_text_window_t* ftw)
 196 {
 197     if (ftw) {
 198         ftw->funnel_text_dialog->clearText();
 199     }
 200 }
 201
 202 const char *text_window_get_text(funnel_text_window_t *ftw)
 203 {
 204     if (ftw) {
 205         return ftw->funnel_text_dialog->getText();
 206     }
 207     return NULL;
 208 }
 209
 210 void text_window_set_close_cb(funnel_text_window_t *ftw, text_win_close_cb_t close_cb, void *close_cb_data)
 211 {
 212     if (ftw) {
 213         ftw->funnel_text_dialog->setCloseCallback(close_cb, close_cb_data);
 214     }
 215 }
 216
 217 void text_window_set_editable(funnel_text_window_t *ftw, bool editable)
 218 {
 219     if (ftw) {
 220         ftw->funnel_text_dialog->setTextEditable(editable);
 221     }
 222 }
 223
 224 void text_window_destroy(funnel_text_window_t *ftw)
 225 {
 226     if (ftw) {
 227         ftw->funnel_text_dialog->close();
 228     }
 229 }
 230
 231 void text_window_add_button(funnel_text_window_t *ftw, funnel_bt_t *funnel_button, const char *label)
 232 {
 233     if (ftw) {
 234         ftw->funnel_text_dialog->addButton(funnel_button, label);
 235     }
 236 }