pv/subwindows/decoder_selector/subwindow.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2018 Soeren Apel <soeren@apelpie.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <algorithm>
  21
  22 #include <QApplication>
  23 #include <QDebug>
  24 #include <QFontMetrics>
  25 #include <QInputDialog>
  26 #include <QLabel>
  27 #include <QLineEdit>
  28 #include <QPushButton>
  29 #include <QScrollArea>
  30 #include <QVBoxLayout>
  31
  32 #include "pv/session.hpp"
  33 #include "pv/subwindows/decoder_selector/subwindow.hpp"
  34
  35 using std::reverse;
  36
  37 namespace pv {
  38 namespace subwindows {
  39 namespace decoder_selector {
  40
  41 const char *initial_notice =
  42         QT_TRANSLATE_NOOP("pv::subwindows::decoder_selector::SubWindow",
  43                 "Select a decoder to see its description here.");  // clazy:exclude=non-pod-global-static
  44
  45 const int min_width_margin = 75;
  46
  47
  48 bool QCustomSortFilterProxyModel::filterAcceptsRow(int source_row,
  49         const QModelIndex& source_parent) const
  50 {
  51         // Search model recursively
  52
  53         if (QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent))
  54                 return true;
  55
  56         const QModelIndex index = sourceModel()->index(source_row, 0, source_parent);
  57
  58         for (int i = 0; i < sourceModel()->rowCount(index); i++)
  59                 if (filterAcceptsRow(i, index))
  60                         return true;
  61
  62         return false;
  63 }
  64
  65
  66 void QCustomTreeView::currentChanged(const QModelIndex& current,
  67         const QModelIndex& previous)
  68 {
  69         QTreeView::currentChanged(current, previous);
  70         currentChanged(current);
  71 }
  72
  73
  74 SubWindow::SubWindow(Session& session, QWidget* parent) :
  75         SubWindowBase(session, parent),
  76         splitter_(new QSplitter()),
  77         tree_view_(new QCustomTreeView()),
  78         info_box_(new QWidget()),
  79         info_label_header_(new QLabel()),
  80         info_label_body_(new QLabel()),
  81         info_label_footer_(new QLabel()),
  82         model_(new DecoderCollectionModel()),
  83         sort_filter_model_(new QCustomSortFilterProxyModel())
  84 {
  85         QVBoxLayout* root_layout = new QVBoxLayout(this);
  86         root_layout->setContentsMargins(0, 0, 0, 0);
  87         root_layout->addWidget(splitter_);
  88
  89         QWidget* upper_container = new QWidget();
  90         QVBoxLayout* upper_layout = new QVBoxLayout(upper_container);
  91         upper_layout->setContentsMargins(0, 5, 0, 0);
  92         QLineEdit* filter = new QLineEdit();
  93         upper_layout->addWidget(filter);
  94         upper_layout->addWidget(tree_view_);
  95
  96         splitter_->setOrientation(Qt::Vertical);
  97         splitter_->addWidget(upper_container);
  98         splitter_->addWidget(info_box_);
  99
 100         const QIcon filter_icon(QIcon::fromTheme("search",
 101                 QIcon(":/icons/search.svg")));
 102         filter->setClearButtonEnabled(true);
 103         filter->addAction(filter_icon, QLineEdit::LeadingPosition);
 104
 105         sort_filter_model_->setSourceModel(model_);
 106         sort_filter_model_->setFilterCaseSensitivity(Qt::CaseInsensitive);
 107         sort_filter_model_->setFilterKeyColumn(-1);
 108
 109         tree_view_->setModel(sort_filter_model_);
 110         tree_view_->setRootIsDecorated(true);
 111         tree_view_->setSortingEnabled(true);
 112         tree_view_->sortByColumn(0, Qt::AscendingOrder);
 113
 114         // Hide the columns that hold the detailed item information
 115         tree_view_->hideColumn(2);  // ID
 116
 117         // Ensure that all decoder tag names are fully visible by default
 118         tree_view_->resizeColumnToContents(0);
 119
 120         tree_view_->setIndentation(10);
 121
 122         QScrollArea* info_label_body_container = new QScrollArea();
 123         info_label_body_container->setWidget(info_label_body_);
 124         info_label_body_container->setWidgetResizable(true);
 125
 126         info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 127         QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
 128         info_box_layout->addWidget(info_label_header_);
 129         info_box_layout->addWidget(info_label_body_container);
 130         info_box_layout->addWidget(info_label_footer_);
 131         info_box_layout->setAlignment(Qt::AlignTop);
 132         Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard;
 133         info_label_header_->setWordWrap(true);
 134         info_label_header_->setTextInteractionFlags(flags);
 135         info_label_body_->setWordWrap(true);
 136         info_label_body_->setTextInteractionFlags(flags);
 137         info_label_body_->setText(QString(tr(initial_notice)));
 138         info_label_body_->setAlignment(Qt::AlignTop);
 139         info_label_footer_->setWordWrap(true);
 140         info_label_footer_->setTextInteractionFlags(flags);
 141
 142         connect(filter, SIGNAL(textChanged(const QString&)),
 143                 this, SLOT(on_filter_changed(const QString&)));
 144         connect(filter, SIGNAL(returnPressed()),
 145                 this, SLOT(on_filter_return_pressed()));
 146
 147         connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
 148                 this, SLOT(on_item_changed(const QModelIndex&)));
 149         connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
 150                 this, SLOT(on_item_activated(const QModelIndex&)));
 151
 152         connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
 153                 &session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
 154
 155         // Place the keyboard cursor in the filter QLineEdit initially
 156         filter->setFocus();
 157 }
 158
 159 bool SubWindow::has_toolbar() const
 160 {
 161         return true;
 162 }
 163
 164 QToolBar* SubWindow::create_toolbar(QWidget *parent) const
 165 {
 166         QToolBar* toolbar = new QToolBar(parent);
 167
 168         return toolbar;
 169 }
 170
 171 int SubWindow::minimum_width() const
 172 {
 173         QFontMetrics m(info_label_body_->font());
 174         const int label_width = m.width(QString(tr(initial_notice)));
 175
 176         return label_width + min_width_margin;
 177 }
 178
 179 vector<const char*> SubWindow::get_decoder_inputs(const srd_decoder* d) const
 180 {
 181         vector<const char*> ret_val;
 182
 183         for (GSList* li = d->inputs; li; li = li->next)
 184                 ret_val.push_back((const char*)li->data);
 185
 186         return ret_val;
 187 }
 188
 189 vector<const srd_decoder*> SubWindow::get_decoders_providing(const char* output) const
 190 {
 191         vector<const srd_decoder*> ret_val;
 192
 193         for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
 194                 const srd_decoder* d = (srd_decoder*)li->data;
 195                 assert(d);
 196
 197                 if (!d->outputs)
 198                         continue;
 199
 200                 const int maxlen = 1024;
 201
 202                 // TODO For now we ignore that d->outputs is actually a list
 203                 if (strncmp((char*)(d->outputs->data), output, maxlen) == 0)
 204                         ret_val.push_back(d);
 205         }
 206
 207         return ret_val;
 208 }
 209
 210 void SubWindow::on_item_changed(const QModelIndex& index)
 211 {
 212         if (!index.isValid())
 213                 return;
 214
 215         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 216         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 217
 218         if (decoder_name.isEmpty())
 219                 return;
 220
 221         const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
 222
 223         const QString id = QString::fromUtf8(d->id);
 224         const QString longname = QString::fromUtf8(d->longname);
 225         const QString desc = QString::fromUtf8(d->desc);
 226         const QString doc = QString::fromUtf8(srd_decoder_doc_get(d)).trimmed();
 227
 228         QString tags;
 229         for (GSList* li = (GSList*)d->tags; li; li = li->next) {
 230                 QString s = (li == (GSList*)d->tags) ?
 231                         tr((char*)li->data) :
 232                         QString(tr(", %1")).arg(tr((char*)li->data));
 233                 tags.append(s);
 234         }
 235
 236         info_label_header_->setText(QString("<span style='font-size:large'><b>%1 (%2)</b></span><br><i>%3</i>")
 237                 .arg(longname, id, desc));
 238         info_label_body_->setText(doc);
 239         info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
 240 }
 241
 242 void SubWindow::on_item_activated(const QModelIndex& index)
 243 {
 244         if (!index.isValid())
 245                 return;
 246
 247         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 248         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 249
 250         const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
 251         if (chosen_decoder == nullptr)
 252                 return;
 253
 254         vector<const srd_decoder*> decoders;
 255         decoders.push_back(chosen_decoder);
 256
 257         // If the decoder only depends on logic inputs, we add it and are done
 258         vector<const char*> inputs = get_decoder_inputs(decoders.front());
 259         if (inputs.size() == 0) {
 260                 qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
 261                 return;
 262         }
 263
 264         if (strcmp(inputs.at(0), "logic") == 0) {
 265                 new_decoders_selected(decoders);
 266                 return;
 267         }
 268
 269         // Check if we can automatically fulfill the stacking requirements
 270         while (strcmp(inputs.at(0), "logic") != 0) {
 271                 vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
 272
 273                 if (prov_decoders.size() == 0) {
 274                         // Emit warning and add the stack that we could gather so far
 275                         qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
 276                                 << "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
 277                         break;
 278                 }
 279
 280                 if (prov_decoders.size() == 1) {
 281                         decoders.push_back(prov_decoders.front());
 282                 } else {
 283                         // Let user decide which one to use
 284                         QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
 285                                 "which several decoders provide.<br>Choose which one to use:<br>"))
 286                                         .arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
 287
 288                         QStringList items;
 289                         for (const srd_decoder* d : prov_decoders)
 290                                 items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
 291                         bool ok_clicked;
 292                         QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
 293                                 tr(caption.toUtf8()), items, 0, false, &ok_clicked);
 294
 295                         if ((!ok_clicked) || (item.isEmpty()))
 296                                 return;
 297
 298                         QString d = item.section(' ', 0, 0);
 299                         decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
 300                 }
 301
 302                 inputs = get_decoder_inputs(decoders.back());
 303         }
 304
 305         // Reverse decoder list and add the stack
 306         reverse(decoders.begin(), decoders.end());
 307         new_decoders_selected(decoders);
 308 }
 309
 310 void SubWindow::on_filter_changed(const QString& text)
 311 {
 312         sort_filter_model_->setFilterFixedString(text);
 313
 314         // Expand the "All Decoders" category/tag if the user filtered
 315         tree_view_->setExpanded(tree_view_->model()->index(0, 0), !text.isEmpty());
 316 }
 317
 318 void SubWindow::on_filter_return_pressed()
 319 {
 320         int num_visible_decoders = 0;
 321         QModelIndex last_valid_index;
 322
 323         QModelIndex index = tree_view_->model()->index(0, 0);
 324
 325         while (index.isValid()) {
 326                 QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 327                 QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 328                 if (!decoder_name.isEmpty()) {
 329                         last_valid_index = index;
 330                         num_visible_decoders++;
 331                 }
 332                 index = tree_view_->indexBelow(index);
 333         }
 334
 335         // If only one decoder matches the filter, apply it when the user presses enter
 336         if (num_visible_decoders == 1)
 337                 tree_view_->activated(last_valid_index);
 338 }
 339
 340 } // namespace decoder_selector
 341 } // namespace subwindows
 342 } // namespace pv