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