2 * This file is part of the PulseView project.
4 * Copyright (C) 2018 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
22 #include <QApplication>
24 #include <QFontMetrics>
25 #include <QInputDialog>
28 #include <QPushButton>
29 #include <QScrollArea>
30 #include <QVBoxLayout>
32 #include "pv/session.hpp"
33 #include "pv/subwindows/decoder_selector/subwindow.hpp"
36 using std::shared_ptr;
39 namespace subwindows {
40 namespace decoder_selector {
42 const QString initial_notice = QApplication::tr("Select a decoder to see its description here.");
43 const int min_width_margin = 75;
46 bool QCustomSortFilterProxyModel::filterAcceptsRow(int source_row,
47 const QModelIndex& source_parent) const
49 // Search model recursively
51 if (QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent))
54 const QModelIndex index = sourceModel()->index(source_row, 0, source_parent);
56 for (int i = 0; i < sourceModel()->rowCount(index); i++)
57 if (filterAcceptsRow(i, index))
64 void QCustomTreeView::currentChanged(const QModelIndex& current,
65 const QModelIndex& previous)
67 QTreeView::currentChanged(current, previous);
68 currentChanged(current);
72 SubWindow::SubWindow(Session& session, QWidget* parent) :
73 SubWindowBase(session, parent),
74 splitter_(new QSplitter()),
75 tree_view_(new QCustomTreeView()),
76 info_box_(new QWidget()),
77 info_label_header_(new QLabel()),
78 info_label_body_(new QLabel()),
79 info_label_footer_(new QLabel()),
80 model_(new DecoderCollectionModel()),
81 sort_filter_model_(new QCustomSortFilterProxyModel())
83 QVBoxLayout* root_layout = new QVBoxLayout(this);
84 root_layout->setContentsMargins(0, 0, 0, 0);
85 root_layout->addWidget(splitter_);
87 QWidget* upper_container = new QWidget();
88 QVBoxLayout* upper_layout = new QVBoxLayout(upper_container);
89 upper_layout->setContentsMargins(0, 5, 0, 0);
90 QLineEdit* filter = new QLineEdit();
91 upper_layout->addWidget(filter);
92 upper_layout->addWidget(tree_view_);
94 splitter_->setOrientation(Qt::Vertical);
95 splitter_->addWidget(upper_container);
96 splitter_->addWidget(info_box_);
98 const QIcon filter_icon(QIcon::fromTheme("search",
99 QIcon(":/icons/search.svg")));
100 filter->setClearButtonEnabled(true);
101 filter->addAction(filter_icon, QLineEdit::LeadingPosition);
103 sort_filter_model_->setSourceModel(model_);
104 sort_filter_model_->setFilterCaseSensitivity(Qt::CaseInsensitive);
105 sort_filter_model_->setFilterKeyColumn(-1);
107 tree_view_->setModel(sort_filter_model_);
108 tree_view_->setRootIsDecorated(true);
109 tree_view_->setSortingEnabled(true);
110 tree_view_->sortByColumn(0, Qt::AscendingOrder);
112 // Hide the columns that hold the detailed item information
113 tree_view_->hideColumn(2); // ID
115 // Ensure that all decoder tag names are fully visible by default
116 tree_view_->resizeColumnToContents(0);
118 tree_view_->setIndentation(10);
120 QScrollArea* info_label_body_container = new QScrollArea();
121 info_label_body_container->setWidget(info_label_body_);
122 info_label_body_container->setWidgetResizable(true);
124 info_box_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
125 QVBoxLayout* info_box_layout = new QVBoxLayout(info_box_);
126 info_box_layout->addWidget(info_label_header_);
127 info_box_layout->addWidget(info_label_body_container);
128 info_box_layout->addWidget(info_label_footer_);
129 info_box_layout->setAlignment(Qt::AlignTop);
130 Qt::TextInteractionFlags flags = Qt::TextSelectableByMouse | Qt::TextSelectableByKeyboard;
131 info_label_header_->setWordWrap(true);
132 info_label_header_->setTextInteractionFlags(flags);
133 info_label_body_->setWordWrap(true);
134 info_label_body_->setTextInteractionFlags(flags);
135 info_label_body_->setText(initial_notice);
136 info_label_body_->setAlignment(Qt::AlignTop);
137 info_label_footer_->setWordWrap(true);
138 info_label_footer_->setTextInteractionFlags(flags);
140 connect(filter, SIGNAL(textChanged(const QString&)),
141 this, SLOT(on_filter_changed(const QString&)));
143 connect(tree_view_, SIGNAL(currentChanged(const QModelIndex&)),
144 this, SLOT(on_item_changed(const QModelIndex&)));
145 connect(tree_view_, SIGNAL(activated(const QModelIndex&)),
146 this, SLOT(on_item_activated(const QModelIndex&)));
148 connect(this, SIGNAL(new_decoders_selected(vector<const srd_decoder*>)),
149 &session, SLOT(on_new_decoders_selected(vector<const srd_decoder*>)));
151 // Place the keyboard cursor in the filter QLineEdit initially
155 bool SubWindow::has_toolbar() const
160 QToolBar* SubWindow::create_toolbar(QWidget *parent) const
162 QToolBar* toolbar = new QToolBar(parent);
167 int SubWindow::minimum_width() const
169 QFontMetrics m(info_label_body_->font());
170 const int label_width = m.width(initial_notice);
172 return label_width + min_width_margin;
175 vector<const char*> SubWindow::get_decoder_inputs(const srd_decoder* d) const
177 vector<const char*> ret_val;
179 for (GSList* li = d->inputs; li; li = li->next)
180 ret_val.push_back((const char*)li->data);
185 vector<const srd_decoder*> SubWindow::get_decoders_providing(const char* output) const
187 vector<const srd_decoder*> ret_val;
189 for (GSList* li = (GSList*)srd_decoder_list(); li; li = li->next) {
190 const srd_decoder* d = (srd_decoder*)li->data;
196 const int maxlen = 1024;
198 // TODO For now we ignore that d->outputs is actually a list
199 if (strncmp((char*)(d->outputs->data), output, maxlen) == 0)
200 ret_val.push_back(d);
206 void SubWindow::on_item_changed(const QModelIndex& index)
208 if (!index.isValid())
211 QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
212 QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
214 if (decoder_name.isEmpty())
217 const srd_decoder* d = srd_decoder_get_by_id(decoder_name.toUtf8());
219 const QString id = QString::fromUtf8(d->id);
220 const QString longname = QString::fromUtf8(d->longname);
221 const QString desc = QString::fromUtf8(d->desc);
222 const QString doc = QString::fromUtf8(srd_decoder_doc_get(d)).trimmed();
225 for (GSList* li = (GSList*)d->tags; li; li = li->next) {
226 QString s = (li == (GSList*)d->tags) ?
227 tr((char*)li->data) :
228 QString(tr(", %1")).arg(tr((char*)li->data));
232 info_label_header_->setText(QString("<span style='font-size:large'><b>%1 (%2)</b></span><br><i>%3</i>")
233 .arg(longname, id, desc));
234 info_label_body_->setText(doc);
235 info_label_footer_->setText(tr("<p align='right'>Tags: %1</p>").arg(tags));
238 void SubWindow::on_item_activated(const QModelIndex& index)
240 if (!index.isValid())
243 QModelIndex id_index = index.model()->index(index.row(), 2, index.parent());
244 QString decoder_name = index.model()->data(id_index, Qt::DisplayRole).toString();
246 const srd_decoder* chosen_decoder = srd_decoder_get_by_id(decoder_name.toUtf8());
247 if (chosen_decoder == nullptr)
250 vector<const srd_decoder*> decoders;
251 decoders.push_back(chosen_decoder);
253 // If the decoder only depends on logic inputs, we add it and are done
254 vector<const char*> inputs = get_decoder_inputs(decoders.front());
255 if (inputs.size() == 0) {
256 qWarning() << "Protocol decoder" << decoder_name << "cannot have 0 inputs!";
260 if (strcmp(inputs.at(0), "logic") == 0) {
261 new_decoders_selected(decoders);
265 // Check if we can automatically fulfill the stacking requirements
266 while (strcmp(inputs.at(0), "logic") != 0) {
267 vector<const srd_decoder*> prov_decoders = get_decoders_providing(inputs.at(0));
269 if (prov_decoders.size() == 0) {
270 // Emit warning and add the stack that we could gather so far
271 qWarning() << "Protocol decoder" << QString::fromUtf8(decoders.back()->id) \
272 << "has input that no other decoder provides:" << QString::fromUtf8(inputs.at(0));
276 if (prov_decoders.size() == 1) {
277 decoders.push_back(prov_decoders.front());
279 // Let user decide which one to use
280 QString caption = QString(tr("Protocol decoder <b>%1</b> requires input type <b>%2</b> " \
281 "which several decoders provide.<br>Choose which one to use:<br>"))
282 .arg(QString::fromUtf8(decoders.back()->id), QString::fromUtf8(inputs.at(0)));
285 for (const srd_decoder* d : prov_decoders)
286 items << QString::fromUtf8(d->id) + " (" + QString::fromUtf8(d->longname) + ")";
288 QString item = QInputDialog::getItem(this, tr("Choose Decoder"),
289 tr(caption.toUtf8()), items, 0, false, &ok_clicked);
291 if ((!ok_clicked) || (item.isEmpty()))
294 QString d = item.section(' ', 0, 0);
295 decoders.push_back(srd_decoder_get_by_id(d.toUtf8()));
298 inputs = get_decoder_inputs(decoders.back());
301 // Reverse decoder list and add the stack
302 reverse(decoders.begin(), decoders.end());
303 new_decoders_selected(decoders);
306 void SubWindow::on_filter_changed(const QString& text)
308 sort_filter_model_->setFilterFixedString(text);
310 // Expand the "All Decoders" category/tag if the user filtered
311 tree_view_->setExpanded(tree_view_->model()->index(0, 0), !text.isEmpty());
314 } // namespace decoder_selector
315 } // namespace subwindows