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 <QDebug>
  23 #include <QInputDialog>
  24 #include <QLabel>
  25 #include <QLineEdit>
  26 #include <QPushButton>
  27 #include <QVBoxLayout>
  28
  29 #include "pv/session.hpp"
  30 #include "pv/subwindows/decoder_selector/subwindow.hpp"
  31
  32 using std::reverse;
  33 using std::shared_ptr;
  34
  35 namespace pv {
  36 namespace subwindows {
  37 namespace decoder_selector {
  38
  39
  40 bool QCustomSortFilterProxyModel::filterAcceptsRow(int source_row,
  41         const QModelIndex& source_parent) const
  42 {
  43         // Search model recursively
  44
  45         if (QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent))
  46                 return true;
  47
  48         const QModelIndex index = sourceModel()->index(source_row, 0, source_parent);
  49
  50         for (int i = 0; i < sourceModel()->rowCount(index); i++)
  51                 if (filterAcceptsRow(i, index))
  52                         return true;
  53
  54         return false;
  55 }
  56
  57
  58 void QCustomTreeView::currentChanged(const QModelIndex& current,
  59         const QModelIndex& previous)
  60 {
  61         QTreeView::currentChanged(current, previous);
  62         currentChanged(current);
  63 }
  64
  65
  66 SubWindow::SubWindow(Session& session, QWidget* parent) :
  67         SubWindowBase(session, parent),
  68         splitter_(new QSplitter()),
  69         tree_view_(new QCustomTreeView()),
  70         info_box_(new QWidget()),
  71         info_label_header_(new QLabel()),
  72         info_label_body_(new QLabel()),
  73         info_label_footer_(new QLabel()),
  74         model_(new DecoderCollectionModel()),
  75         sort_filter_model_(new QCustomSortFilterProxyModel())
  76 {
  77         QVBoxLayout* root_layout = new QVBoxLayout(this);
  78         root_layout->setContentsMargins(0, 0, 0, 0);
  79         root_layout->addWidget(splitter_);
  80
  81         QWidget* upper_container = new QWidget();
  82         QVBoxLayout* upper_layout = new QVBoxLayout(upper_container);
  83         upper_layout->setContentsMargins(0, 5, 0, 0);
  84         QLineEdit* filter = new QLineEdit();
  85         upper_layout->addWidget(filter);
  86         upper_layout->addWidget(tree_view_);
  87
  88         splitter_->setOrientation(Qt::Vertical);
  89         splitter_->addWidget(upper_container);
  90         splitter_->addWidget(info_box_);
  91
  92         const QIcon filter_icon(QIcon::fromTheme("search",
  93                 QIcon(":/icons/search.svg")));
  94         filter->setClearButtonEnabled(true);
  95         filter->addAction(filter_icon, QLineEdit::LeadingPosition);
  96
  97         sort_filter_model_->setSourceModel(model_);
  98         sort_filter_model_->setFilterCaseSensitivity(Qt::CaseInsensitive);
  99
 100         tree_view_->setModel(sort_filter_model_);
 101         tree_view_->setRootIsDecorated(true);
 102         tree_view_->setSortingEnabled(true);
 103         tree_view_->sortByColumn(0, Qt::AscendingOrder);
 104
 105         // Hide the columns that hold the detailed item information
 106         tree_view_->hideColumn(2);  // ID
 107
 108         info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 109         QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
 110         info_box_layout->addWidget(info_label_header_);
 111         info_box_layout->addWidget(info_label_body_);
 112         info_box_layout->addWidget(info_label_footer_);
 113         Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard;
 114         info_label_header_->setWordWrap(true);
 115         info_label_header_->setTextInteractionFlags(flags);
 116         info_label_body_->setWordWrap(true);
 117         info_label_body_->setTextInteractionFlags(flags);
 118         info_label_body_->setText(tr("Select a decoder to see its description here."));
 119         info_label_footer_->setWordWrap(true);
 120         info_label_footer_->setTextInteractionFlags(flags);
 121
 122         connect(filter, SIGNAL(textChanged(const QString&)),
 123                 this, SLOT(on_filter_changed(const QString&)));
 124
 125         connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
 126                 this, SLOT(on_item_changed(const QModelIndex&)));
 127         connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
 128                 this, SLOT(on_item_activated(const QModelIndex&)));
 129
 130         connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
 131                 &session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
 132 }
 133
 134 bool SubWindow::has_toolbar() const
 135 {
 136         return true;
 137 }
 138
 139 QToolBar* SubWindow::create_toolbar(QWidget *parent) const
 140 {
 141         QToolBar* toolbar = new QToolBar(parent);
 142
 143         return toolbar;
 144 }
 145
 146 vector<const char*> SubWindow::get_decoder_inputs(const srd_decoder* d) const
 147 {
 148         vector<const char*> ret_val;
 149
 150         for (GSList* li = d->inputs; li; li = li->next)
 151                 ret_val.push_back((const char*)li->data);
 152
 153         return ret_val;
 154 }
 155
 156 vector<const srd_decoder*> SubWindow::get_decoders_providing(const char* output) const
 157 {
 158         vector<const srd_decoder*> ret_val;
 159
 160         for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
 161                 const srd_decoder* d = (srd_decoder*)li->data;
 162                 assert(d);
 163
 164                 if (!d->outputs)
 165                         continue;
 166
 167                 // TODO For now we ignore that d->outputs is actually a list
 168                 if (strncmp((char*)(d->outputs->data), output, strlen(output)) == 0)
 169                         ret_val.push_back(d);
 170         }
 171
 172         return ret_val;
 173 }
 174
 175 void SubWindow::on_item_changed(const QModelIndex& index)
 176 {
 177         if (!index.isValid())
 178                 return;
 179
 180         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 181         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 182
 183         if (decoder_name.isEmpty())
 184                 return;
 185
 186         const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
 187
 188         const QString id = QString::fromUtf8(d->id);
 189         const QString longname = QString::fromUtf8(d->longname);
 190         const QString desc = QString::fromUtf8(d->desc);
 191         const QString doc = QString::fromUtf8(srd_decoder_doc_get(d));
 192
 193         QString tags;
 194         for (GSList* li = (GSList*)d->tags; li; li = li->next) {
 195                 QString s = (li == (GSList*)d->tags) ?
 196                         tr((char*)li->data) :
 197                         QString(tr(", %1")).arg(tr((char*)li->data));
 198                 tags.append(s);
 199         }
 200
 201         info_label_header_->setText(QString("<span style='font-size:large;font-weight:bold'>%1 (%2)</span><br>%3")
 202                 .arg(longname, id, desc));
 203         info_label_body_->setText(doc);
 204         info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
 205 }
 206
 207 void SubWindow::on_item_activated(const QModelIndex& index)
 208 {
 209         if (!index.isValid())
 210                 return;
 211
 212         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 213         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 214
 215         const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
 216         if (chosen_decoder == nullptr)
 217                 return;
 218
 219         vector<const srd_decoder*> decoders;
 220         decoders.push_back(chosen_decoder);
 221
 222         // If the decoder only depends on logic inputs, we add it and are done
 223         vector<const char*> inputs = get_decoder_inputs(decoders.front());
 224         if (inputs.size() == 0) {
 225                 qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
 226                 return;
 227         }
 228
 229         if (strncmp(inputs.at(0), "logic", 5) == 0) {
 230                 new_decoders_selected(decoders);
 231                 return;
 232         }
 233
 234         // Check if we can automatically fulfill the stacking requirements
 235         while (strncmp(inputs.at(0), "logic", 5) != 0) {
 236                 vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
 237
 238                 if (prov_decoders.size() == 0) {
 239                         // Emit warning and add the stack that we could gather so far
 240                         qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
 241                                 << "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
 242                         break;
 243                 }
 244
 245                 if (prov_decoders.size() == 1) {
 246                         decoders.push_back(prov_decoders.front());
 247                 } else {
 248                         // Let user decide which one to use
 249                         QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
 250                                 "which several decoders provide.<br>Choose which one to use:<br>"))
 251                                         .arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
 252
 253                         QStringList items;
 254                         for (const srd_decoder* d : prov_decoders)
 255                                 items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
 256                         bool ok_clicked;
 257                         QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
 258                                 tr(caption.toUtf8()), items, 0, false, &ok_clicked);
 259
 260                         if ((!ok_clicked) || (item.isEmpty()))
 261                                 return;
 262
 263                         QString d = item.section(' ', 0, 0);
 264                         decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
 265                 }
 266
 267                 inputs = get_decoder_inputs(decoders.back());
 268         }
 269
 270         // Reverse decoder list and add the stack
 271         reverse(decoders.begin(), decoders.end());
 272         new_decoders_selected(decoders);
 273 }
 274
 275 void SubWindow::on_filter_changed(const QString& text)
 276 {
 277         sort_filter_model_->setFilterFixedString(text);
 278 }
 279
 280 } // namespace decoder_selector
 281 } // namespace subwindows
 282 } // namespace pv