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         // Ensure that all decoder tag names are fully visible by default
 109         tree_view_->resizeColumnToContents(0);
 110
 111         info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 112         QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
 113         info_box_layout->addWidget(info_label_header_);
 114         info_box_layout->addWidget(info_label_body_);
 115         info_box_layout->addWidget(info_label_footer_);
 116         info_box_layout->setAlignment(Qt::AlignTop);
 117         Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard;
 118         info_label_header_->setWordWrap(true);
 119         info_label_header_->setTextInteractionFlags(flags);
 120         info_label_body_->setWordWrap(true);
 121         info_label_body_->setTextInteractionFlags(flags);
 122         info_label_body_->setText(tr("Select a decoder to see its description here."));
 123         info_label_footer_->setWordWrap(true);
 124         info_label_footer_->setTextInteractionFlags(flags);
 125
 126         connect(filter, SIGNAL(textChanged(const QString&)),
 127                 this, SLOT(on_filter_changed(const QString&)));
 128
 129         connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
 130                 this, SLOT(on_item_changed(const QModelIndex&)));
 131         connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
 132                 this, SLOT(on_item_activated(const QModelIndex&)));
 133
 134         connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
 135                 &session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
 136 }
 137
 138 bool SubWindow::has_toolbar() const
 139 {
 140         return true;
 141 }
 142
 143 QToolBar* SubWindow::create_toolbar(QWidget *parent) const
 144 {
 145         QToolBar* toolbar = new QToolBar(parent);
 146
 147         return toolbar;
 148 }
 149
 150 vector<const char*> SubWindow::get_decoder_inputs(const srd_decoder* d) const
 151 {
 152         vector<const char*> ret_val;
 153
 154         for (GSList* li = d->inputs; li; li = li->next)
 155                 ret_val.push_back((const char*)li->data);
 156
 157         return ret_val;
 158 }
 159
 160 vector<const srd_decoder*> SubWindow::get_decoders_providing(const char* output) const
 161 {
 162         vector<const srd_decoder*> ret_val;
 163
 164         for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
 165                 const srd_decoder* d = (srd_decoder*)li->data;
 166                 assert(d);
 167
 168                 if (!d->outputs)
 169                         continue;
 170
 171                 // TODO For now we ignore that d->outputs is actually a list
 172                 if (strncmp((char*)(d->outputs->data), output, strlen(output)) == 0)
 173                         ret_val.push_back(d);
 174         }
 175
 176         return ret_val;
 177 }
 178
 179 void SubWindow::on_item_changed(const QModelIndex& index)
 180 {
 181         if (!index.isValid())
 182                 return;
 183
 184         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 185         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 186
 187         if (decoder_name.isEmpty())
 188                 return;
 189
 190         const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
 191
 192         const QString id = QString::fromUtf8(d->id);
 193         const QString longname = QString::fromUtf8(d->longname);
 194         const QString desc = QString::fromUtf8(d->desc);
 195         const QString doc = QString::fromUtf8(srd_decoder_doc_get(d));
 196
 197         QString tags;
 198         for (GSList* li = (GSList*)d->tags; li; li = li->next) {
 199                 QString s = (li == (GSList*)d->tags) ?
 200                         tr((char*)li->data) :
 201                         QString(tr(", %1")).arg(tr((char*)li->data));
 202                 tags.append(s);
 203         }
 204
 205         info_label_header_->setText(QString("<span style='font-size:large;font-weight:bold'>%1 (%2)</span><br>%3")
 206                 .arg(longname, id, desc));
 207         info_label_body_->setText(doc);
 208         info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
 209 }
 210
 211 void SubWindow::on_item_activated(const QModelIndex& index)
 212 {
 213         if (!index.isValid())
 214                 return;
 215
 216         QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
 217         QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
 218
 219         const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
 220         if (chosen_decoder == nullptr)
 221                 return;
 222
 223         vector<const srd_decoder*> decoders;
 224         decoders.push_back(chosen_decoder);
 225
 226         // If the decoder only depends on logic inputs, we add it and are done
 227         vector<const char*> inputs = get_decoder_inputs(decoders.front());
 228         if (inputs.size() == 0) {
 229                 qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
 230                 return;
 231         }
 232
 233         if (strncmp(inputs.at(0), "logic", 5) == 0) {
 234                 new_decoders_selected(decoders);
 235                 return;
 236         }
 237
 238         // Check if we can automatically fulfill the stacking requirements
 239         while (strncmp(inputs.at(0), "logic", 5) != 0) {
 240                 vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
 241
 242                 if (prov_decoders.size() == 0) {
 243                         // Emit warning and add the stack that we could gather so far
 244                         qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
 245                                 << "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
 246                         break;
 247                 }
 248
 249                 if (prov_decoders.size() == 1) {
 250                         decoders.push_back(prov_decoders.front());
 251                 } else {
 252                         // Let user decide which one to use
 253                         QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
 254                                 "which several decoders provide.<br>Choose which one to use:<br>"))
 255                                         .arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
 256
 257                         QStringList items;
 258                         for (const srd_decoder* d : prov_decoders)
 259                                 items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
 260                         bool ok_clicked;
 261                         QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
 262                                 tr(caption.toUtf8()), items, 0, false, &ok_clicked);
 263
 264                         if ((!ok_clicked) || (item.isEmpty()))
 265                                 return;
 266
 267                         QString d = item.section(' ', 0, 0);
 268                         decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
 269                 }
 270
 271                 inputs = get_decoder_inputs(decoders.back());
 272         }
 273
 274         // Reverse decoder list and add the stack
 275         reverse(decoders.begin(), decoders.end());
 276         new_decoders_selected(decoders);
 277 }
 278
 279 void SubWindow::on_filter_changed(const QString& text)
 280 {
 281         sort_filter_model_->setFilterFixedString(text);
 282 }
 283
 284 } // namespace decoder_selector
 285 } // namespace subwindows
 286 } // namespace pv