]> sigrok.org Git - pulseview.git/blob - pv/views/trace/decodetrace.cpp
DecodeTrace: Add fallback icon for edit-paste action
[pulseview.git] / pv / views / trace / decodetrace.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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 extern "C" {
21 #include <libsigrokdecode/libsigrokdecode.h>
22 }
23
24 #include <limits>
25 #include <mutex>
26 #include <tuple>
27
28 #include <extdef.h>
29
30 #include <boost/functional/hash.hpp>
31
32 #include <QAction>
33 #include <QApplication>
34 #include <QClipboard>
35 #include <QComboBox>
36 #include <QFileDialog>
37 #include <QFormLayout>
38 #include <QLabel>
39 #include <QMenu>
40 #include <QMessageBox>
41 #include <QPushButton>
42 #include <QTextStream>
43 #include <QToolTip>
44
45 #include "decodetrace.hpp"
46 #include "view.hpp"
47 #include "viewport.hpp"
48
49 #include <pv/globalsettings.hpp>
50 #include <pv/session.hpp>
51 #include <pv/strnatcmp.hpp>
52 #include <pv/data/decodesignal.hpp>
53 #include <pv/data/decode/annotation.hpp>
54 #include <pv/data/decode/decoder.hpp>
55 #include <pv/data/logic.hpp>
56 #include <pv/data/logicsegment.hpp>
57 #include <pv/widgets/decodergroupbox.hpp>
58 #include <pv/widgets/decodermenu.hpp>
59
60 using std::abs;
61 using std::make_pair;
62 using std::max;
63 using std::min;
64 using std::numeric_limits;
65 using std::out_of_range;
66 using std::pair;
67 using std::shared_ptr;
68 using std::tie;
69 using std::vector;
70
71 using pv::data::decode::Annotation;
72 using pv::data::decode::Row;
73 using pv::data::DecodeChannel;
74 using pv::data::DecodeSignal;
75
76 namespace pv {
77 namespace views {
78 namespace trace {
79
80
81 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
82 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
83
84 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
85 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
86
87 const int DecodeTrace::ArrowSize = 4;
88 const double DecodeTrace::EndCapWidth = 5;
89 const int DecodeTrace::RowTitleMargin = 10;
90 const int DecodeTrace::DrawPadding = 100;
91
92 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
93
94 DecodeTrace::DecodeTrace(pv::Session &session,
95         shared_ptr<data::SignalBase> signalbase, int index) :
96         Trace(signalbase),
97         session_(session),
98         row_height_(0),
99         max_visible_rows_(0),
100         delete_mapper_(this),
101         show_hide_mapper_(this)
102 {
103         decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
104
105         GlobalSettings settings;
106         always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool();
107
108         GlobalSettings::add_change_handler(this);
109
110         // Determine shortest string we want to see displayed in full
111         QFontMetrics m(QApplication::font());
112         min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
113
114         // For the base color, we want to start at a very different color for
115         // every decoder stack, so multiply the index with a number that is
116         // rather close to 180 degrees of the color circle but not a dividend of 360
117         // Note: The offset equals the color of the first annotation
118         QColor color;
119         const int h = (120 + 160 * index) % 360;
120         const int s = DECODETRACE_COLOR_SATURATION;
121         const int v = DECODETRACE_COLOR_VALUE;
122         color.setHsv(h, s, v);
123         base_->set_color(color);
124
125         connect(decode_signal_.get(), SIGNAL(new_annotations()),
126                 this, SLOT(on_new_annotations()));
127         connect(decode_signal_.get(), SIGNAL(decode_reset()),
128                 this, SLOT(on_decode_reset()));
129         connect(decode_signal_.get(), SIGNAL(decode_finished()),
130                 this, SLOT(on_decode_finished()));
131         connect(decode_signal_.get(), SIGNAL(channels_updated()),
132                 this, SLOT(on_channels_updated()));
133
134         connect(&delete_mapper_, SIGNAL(mapped(int)),
135                 this, SLOT(on_delete_decoder(int)));
136         connect(&show_hide_mapper_, SIGNAL(mapped(int)),
137                 this, SLOT(on_show_hide_decoder(int)));
138
139         connect(&delayed_trace_updater_, SIGNAL(timeout()),
140                 this, SLOT(on_delayed_trace_update()));
141         delayed_trace_updater_.setSingleShot(true);
142         delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
143 }
144
145 DecodeTrace::~DecodeTrace()
146 {
147         GlobalSettings::remove_change_handler(this);
148 }
149
150 bool DecodeTrace::enabled() const
151 {
152         return true;
153 }
154
155 shared_ptr<data::SignalBase> DecodeTrace::base() const
156 {
157         return base_;
158 }
159
160 pair<int, int> DecodeTrace::v_extents() const
161 {
162         const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
163
164         // Make an empty decode trace appear symmetrical
165         const int row_count = max(1, max_visible_rows_);
166
167         return make_pair(-row_height, row_height * row_count);
168 }
169
170 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
171 {
172         Trace::paint_back(p, pp);
173         paint_axis(p, pp, get_visual_y());
174 }
175
176 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
177 {
178         const int text_height = ViewItemPaintParams::text_height();
179         row_height_ = (text_height * 6) / 4;
180         const int annotation_height = (text_height * 5) / 4;
181
182         // Set default pen to allow for text width calculation
183         p.setPen(Qt::black);
184
185         // Iterate through the rows
186         int y = get_visual_y();
187         pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
188
189         // Just because the view says we see a certain sample range it
190         // doesn't mean we have this many decoded samples, too, so crop
191         // the range to what has been decoded already
192         sample_range.second = min((int64_t)sample_range.second,
193                 decode_signal_->get_decoded_sample_count(current_segment_, false));
194
195         const vector<Row> rows = decode_signal_->get_rows(!always_show_all_rows_);
196
197         visible_rows_.clear();
198         for (const Row& row : rows) {
199                 // Cache the row title widths
200                 int row_title_width;
201                 try {
202                         row_title_width = row_title_widths_.at(row);
203                 } catch (out_of_range&) {
204                         const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
205                                 RowTitleMargin;
206                         row_title_widths_[row] = w;
207                         row_title_width = w;
208                 }
209
210                 vector<Annotation> annotations;
211                 decode_signal_->get_annotation_subset(annotations, row,
212                         current_segment_, sample_range.first, sample_range.second);
213                 if (always_show_all_rows_ || !annotations.empty()) {
214                         draw_annotations(annotations, p, annotation_height, pp, y,
215                                 get_row_color(row.index()), row_title_width);
216                         y += row_height_;
217                         visible_rows_.push_back(row);
218                 }
219         }
220
221         draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
222
223         if ((int)visible_rows_.size() > max_visible_rows_) {
224                 max_visible_rows_ = (int)visible_rows_.size();
225
226                 // Call order is important, otherwise the lazy event handler won't work
227                 owner_->extents_changed(false, true);
228                 owner_->row_item_appearance_changed(false, true);
229         }
230
231         const QString err = decode_signal_->error_message();
232         if (!err.isEmpty())
233                 draw_error(p, err, pp);
234 }
235
236 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
237 {
238         assert(row_height_);
239
240         for (size_t i = 0; i < visible_rows_.size(); i++) {
241                 const int y = i * row_height_ + get_visual_y();
242
243                 p.setPen(QPen(Qt::NoPen));
244                 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
245
246                 if (i != 0) {
247                         const QPointF points[] = {
248                                 QPointF(pp.left(), y - ArrowSize),
249                                 QPointF(pp.left() + ArrowSize, y),
250                                 QPointF(pp.left(), y + ArrowSize)
251                         };
252                         p.drawPolygon(points, countof(points));
253                 }
254
255                 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
256                         pp.right() - pp.left(), row_height_);
257                 const QString h(visible_rows_[i].title());
258                 const int f = Qt::AlignLeft | Qt::AlignVCenter |
259                         Qt::TextDontClip;
260
261                 // Draw the outline
262                 p.setPen(QApplication::palette().color(QPalette::Base));
263                 for (int dx = -1; dx <= 1; dx++)
264                         for (int dy = -1; dy <= 1; dy++)
265                                 if (dx != 0 && dy != 0)
266                                         p.drawText(r.translated(dx, dy), f, h);
267
268                 // Draw the text
269                 p.setPen(QApplication::palette().color(QPalette::WindowText));
270                 p.drawText(r, f, h);
271         }
272
273         if (show_hover_marker_)
274                 paint_hover_marker(p);
275 }
276
277 void DecodeTrace::update_stack_button()
278 {
279         const vector< shared_ptr<data::decode::Decoder> > &stack = decode_signal_->decoder_stack();
280
281         // Only show decoders in the menu that can be stacked onto the last one in the stack
282         if (!stack.empty()) {
283                 const srd_decoder* d = stack.back()->decoder();
284
285                 if (d->outputs) {
286                         pv::widgets::DecoderMenu *const decoder_menu =
287                                 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
288                         connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
289                                 this, SLOT(on_stack_decoder(srd_decoder*)));
290
291                         decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
292
293                         stack_button_->setMenu(decoder_menu);
294                         stack_button_->show();
295                         return;
296                 }
297         }
298
299         // No decoders available for stacking
300         stack_button_->setMenu(nullptr);
301         stack_button_->hide();
302 }
303
304 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
305 {
306         using pv::data::decode::Decoder;
307
308         assert(form);
309
310         // Add the standard options
311         Trace::populate_popup_form(parent, form);
312
313         // Add the decoder options
314         bindings_.clear();
315         channel_id_map_.clear();
316         init_state_map_.clear();
317         decoder_forms_.clear();
318
319         const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
320
321         if (stack.empty()) {
322                 QLabel *const l = new QLabel(
323                         tr("<p><i>No decoders in the stack</i></p>"));
324                 l->setAlignment(Qt::AlignCenter);
325                 form->addRow(l);
326         } else {
327                 auto iter = stack.cbegin();
328                 for (int i = 0; i < (int)stack.size(); i++, iter++) {
329                         shared_ptr<Decoder> dec(*iter);
330                         create_decoder_form(i, dec, parent, form);
331                 }
332
333                 form->addRow(new QLabel(
334                         tr("<i>* Required channels</i>"), parent));
335         }
336
337         // Add stacking button
338         stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
339         stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
340         update_stack_button();
341
342         QHBoxLayout *stack_button_box = new QHBoxLayout;
343         stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
344         form->addRow(stack_button_box);
345 }
346
347 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
348 {
349         QMenu *const menu = Trace::create_header_context_menu(parent);
350
351         menu->addSeparator();
352
353         QAction *const del = new QAction(tr("Delete"), this);
354         del->setShortcuts(QKeySequence::Delete);
355         connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
356         menu->addAction(del);
357
358         return menu;
359 }
360
361 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
362 {
363         // Get entries from default menu before adding our own
364         QMenu *const menu = new QMenu(parent);
365
366         QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
367         if (default_menu) {
368                 for (QAction *action : default_menu->actions()) {  // clazy:exclude=range-loop
369                         menu->addAction(action);
370                         if (action->parent() == default_menu)
371                                 action->setParent(menu);
372                 }
373                 delete default_menu;
374
375                 // Add separator if needed
376                 if (menu->actions().length() > 0)
377                         menu->addSeparator();
378         }
379
380         try {
381                 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
382         } catch (out_of_range&) {
383                 selected_row_ = nullptr;
384         }
385
386         const View *const view = owner_->view();
387         assert(view);
388         QPoint pos = view->viewport()->mapFrom(parent, click_pos);
389
390         // Default sample range is "from here"
391         const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
392         selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
393
394         if (decode_signal_->is_paused()) {
395                 QAction *const resume =
396                         new QAction(tr("Resume decoding"), this);
397                 resume->setIcon(QIcon::fromTheme("media-playback-start",
398                         QIcon(":/icons/media-playback-start.png")));
399                 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
400                 menu->addAction(resume);
401         } else {
402                 QAction *const pause =
403                         new QAction(tr("Pause decoding"), this);
404                 pause->setIcon(QIcon::fromTheme("media-playback-pause",
405                         QIcon(":/icons/media-playback-pause.png")));
406                 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
407                 menu->addAction(pause);
408         }
409
410         QAction *const copy_annotation_to_clipboard =
411                 new QAction(tr("Copy annotation text to clipboard"), this);
412         copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
413                 QIcon(":/icons/edit-paste.svg")));
414         connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
415         menu->addAction(copy_annotation_to_clipboard);
416
417         menu->addSeparator();
418
419         QAction *const export_all_rows =
420                 new QAction(tr("Export all annotations"), this);
421         export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
422                 QIcon(":/icons/document-save-as.png")));
423         connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
424         menu->addAction(export_all_rows);
425
426         QAction *const export_row =
427                 new QAction(tr("Export all annotations for this row"), this);
428         export_row->setIcon(QIcon::fromTheme("document-save-as",
429                 QIcon(":/icons/document-save-as.png")));
430         connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
431         menu->addAction(export_row);
432
433         menu->addSeparator();
434
435         QAction *const export_all_rows_from_here =
436                 new QAction(tr("Export all annotations, starting here"), this);
437         export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
438                 QIcon(":/icons/document-save-as.png")));
439         connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
440         menu->addAction(export_all_rows_from_here);
441
442         QAction *const export_row_from_here =
443                 new QAction(tr("Export annotations for this row, starting here"), this);
444         export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
445                 QIcon(":/icons/document-save-as.png")));
446         connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
447         menu->addAction(export_row_from_here);
448
449         menu->addSeparator();
450
451         QAction *const export_all_rows_with_cursor =
452                 new QAction(tr("Export all annotations within cursor range"), this);
453         export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
454                 QIcon(":/icons/document-save-as.png")));
455         connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
456         menu->addAction(export_all_rows_with_cursor);
457
458         QAction *const export_row_with_cursor =
459                 new QAction(tr("Export annotations for this row within cursor range"), this);
460         export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
461                 QIcon(":/icons/document-save-as.png")));
462         connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
463         menu->addAction(export_row_with_cursor);
464
465         if (!view->cursors()->enabled()) {
466                 export_all_rows_with_cursor->setEnabled(false);
467                 export_row_with_cursor->setEnabled(false);
468         }
469
470         return menu;
471 }
472
473 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
474                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
475                 QColor row_color, int row_title_width)
476 {
477         using namespace pv::data::decode;
478
479         Annotation::Class block_class = 0;
480         bool block_class_uniform = true;
481         qreal block_start = 0;
482         int block_ann_count = 0;
483
484         const Annotation *prev_ann;
485         qreal prev_end = INT_MIN;
486
487         qreal a_end;
488
489         double samples_per_pixel, pixels_offset;
490         tie(pixels_offset, samples_per_pixel) =
491                 get_pixels_offset_samples_per_pixel();
492
493         // Sort the annotations by start sample so that decoders
494         // can't confuse us by creating annotations out of order
495         stable_sort(annotations.begin(), annotations.end(),
496                 [](const Annotation &a, const Annotation &b) {
497                         return a.start_sample() < b.start_sample(); });
498
499         // Gather all annotations that form a visual "block" and draw them as such
500         for (const Annotation &a : annotations) {
501
502                 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
503                 const qreal abs_a_end   = a.end_sample() / samples_per_pixel;
504
505                 const qreal a_start = abs_a_start - pixels_offset;
506                 a_end = abs_a_end - pixels_offset;
507
508                 const qreal a_width = a_end - a_start;
509                 const qreal delta = a_end - prev_end;
510
511                 bool a_is_separate = false;
512
513                 // Annotation wider than the threshold for a useful label width?
514                 if (a_width >= min_useful_label_width_) {
515                         for (const QString &ann_text : a.annotations()) {
516                                 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
517                                 // Annotation wide enough to fit a label? Don't put it in a block then
518                                 if (w <= a_width) {
519                                         a_is_separate = true;
520                                         break;
521                                 }
522                         }
523                 }
524
525                 // Were the previous and this annotation more than a pixel apart?
526                 if ((abs(delta) > 1) || a_is_separate) {
527                         // Block was broken, draw annotations that form the current block
528                         if (block_ann_count == 1)
529                                 draw_annotation(*prev_ann, p, h, pp, y, row_color,
530                                         row_title_width);
531                         else if (block_ann_count > 0)
532                                 draw_annotation_block(block_start, prev_end, block_class,
533                                         block_class_uniform, p, h, y, row_color);
534
535                         block_ann_count = 0;
536                 }
537
538                 if (a_is_separate) {
539                         draw_annotation(a, p, h, pp, y, row_color, row_title_width);
540                         // Next annotation must start a new block. delta will be > 1
541                         // because we set prev_end to INT_MIN but that's okay since
542                         // block_ann_count will be 0 and nothing will be drawn
543                         prev_end = INT_MIN;
544                         block_ann_count = 0;
545                 } else {
546                         prev_end = a_end;
547                         prev_ann = &a;
548
549                         if (block_ann_count == 0) {
550                                 block_start = a_start;
551                                 block_class = a.ann_class();
552                                 block_class_uniform = true;
553                         } else
554                                 if (a.ann_class() != block_class)
555                                         block_class_uniform = false;
556
557                         block_ann_count++;
558                 }
559         }
560
561         if (block_ann_count == 1)
562                 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
563         else if (block_ann_count > 0)
564                 draw_annotation_block(block_start, prev_end, block_class,
565                         block_class_uniform, p, h, y, row_color);
566 }
567
568 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
569         QPainter &p, int h, const ViewItemPaintParams &pp, int y,
570         QColor row_color, int row_title_width) const
571 {
572         double samples_per_pixel, pixels_offset;
573         tie(pixels_offset, samples_per_pixel) =
574                 get_pixels_offset_samples_per_pixel();
575
576         const double start = a.start_sample() / samples_per_pixel -
577                 pixels_offset;
578         const double end = a.end_sample() / samples_per_pixel - pixels_offset;
579
580         QColor color = get_annotation_color(row_color, a.ann_class());
581         p.setPen(color.darker());
582         p.setBrush(color);
583
584         if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
585                 return;
586
587         if (a.start_sample() == a.end_sample())
588                 draw_instant(a, p, h, start, y);
589         else
590                 draw_range(a, p, h, start, end, y, pp, row_title_width);
591 }
592
593 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
594         Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
595         int y, QColor row_color) const
596 {
597         const double top = y + .5 - h / 2;
598         const double bottom = y + .5 + h / 2;
599
600         const QRectF rect(start, top, end - start, bottom - top);
601         const int r = h / 4;
602
603         p.setPen(QPen(Qt::NoPen));
604         p.setBrush(Qt::white);
605         p.drawRoundedRect(rect, r, r);
606
607         // If all annotations in this block are of the same type, we can use the
608         // one format that all of these annotations have. Otherwise, we should use
609         // a neutral color (i.e. gray)
610         if (use_ann_format) {
611                 const QColor color = get_annotation_color(row_color, ann_class);
612                 p.setPen(color.darker());
613                 p.setBrush(QBrush(color, Qt::Dense4Pattern));
614         } else {
615                 p.setPen(Qt::gray);
616                 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
617         }
618
619         p.drawRoundedRect(rect, r, r);
620 }
621
622 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
623         int h, qreal x, int y) const
624 {
625         const QString text = a.annotations().empty() ?
626                 QString() : a.annotations().back();
627         const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
628                 0.0) + h;
629         const QRectF rect(x - w / 2, y - h / 2, w, h);
630
631         p.drawRoundedRect(rect, h / 2, h / 2);
632
633         p.setPen(Qt::black);
634         p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
635 }
636
637 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
638         int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
639         int row_title_width) const
640 {
641         const qreal top = y + .5 - h / 2;
642         const qreal bottom = y + .5 + h / 2;
643         const vector<QString> annotations = a.annotations();
644
645         // If the two ends are within 1 pixel, draw a vertical line
646         if (start + 1.0 > end) {
647                 p.drawLine(QPointF(start, top), QPointF(start, bottom));
648                 return;
649         }
650
651         const qreal cap_width = min((end - start) / 4, EndCapWidth);
652
653         QPointF pts[] = {
654                 QPointF(start, y + .5f),
655                 QPointF(start + cap_width, top),
656                 QPointF(end - cap_width, top),
657                 QPointF(end, y + .5f),
658                 QPointF(end - cap_width, bottom),
659                 QPointF(start + cap_width, bottom)
660         };
661
662         p.drawConvexPolygon(pts, countof(pts));
663
664         if (annotations.empty())
665                 return;
666
667         const int ann_start = start + cap_width;
668         const int ann_end = end - cap_width;
669
670         const int real_start = max(ann_start, pp.left() + row_title_width);
671         const int real_end = min(ann_end, pp.right());
672         const int real_width = real_end - real_start;
673
674         QRectF rect(real_start, y - h / 2, real_width, h);
675         if (rect.width() <= 4)
676                 return;
677
678         p.setPen(Qt::black);
679
680         // Try to find an annotation that will fit
681         QString best_annotation;
682         int best_width = 0;
683
684         for (const QString &a : annotations) {
685                 const int w = p.boundingRect(QRectF(), 0, a).width();
686                 if (w <= rect.width() && w > best_width)
687                         best_annotation = a, best_width = w;
688         }
689
690         if (best_annotation.isEmpty())
691                 best_annotation = annotations.back();
692
693         // If not ellide the last in the list
694         p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
695                 best_annotation, Qt::ElideRight, rect.width()));
696 }
697
698 void DecodeTrace::draw_error(QPainter &p, const QString &message,
699         const ViewItemPaintParams &pp)
700 {
701         const int y = get_visual_y();
702
703         double samples_per_pixel, pixels_offset;
704         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
705
706         p.setPen(ErrorBgColor.darker());
707         p.setBrush(ErrorBgColor);
708
709         const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
710
711         const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
712         const qreal r = text_rect.height() / 4;
713
714         p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
715
716         p.setPen(Qt::black);
717         p.drawText(text_rect, message);
718 }
719
720 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
721 {
722         using namespace pv::data;
723         using pv::data::decode::Decoder;
724
725         double samples_per_pixel, pixels_offset;
726
727         const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
728         if (sample_count == 0)
729                 return;
730
731         const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
732         if (sample_count == samples_decoded)
733                 return;
734
735         const int y = get_visual_y();
736
737         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
738
739         const double start = max(samples_decoded /
740                 samples_per_pixel - pixels_offset, left - 1.0);
741         const double end = min(sample_count / samples_per_pixel -
742                 pixels_offset, right + 1.0);
743         const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
744
745         p.setPen(QPen(Qt::NoPen));
746         p.setBrush(Qt::white);
747         p.drawRect(no_decode_rect);
748
749         p.setPen(NoDecodeColor);
750         p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
751         p.drawRect(no_decode_rect);
752 }
753
754 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
755 {
756         assert(owner_);
757
758         const View *view = owner_->view();
759         assert(view);
760
761         const double scale = view->scale();
762         assert(scale > 0);
763
764         const double pixels_offset =
765                 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
766
767         double samplerate = decode_signal_->samplerate();
768
769         // Show sample rate as 1Hz when it is unknown
770         if (samplerate == 0.0)
771                 samplerate = 1.0;
772
773         return make_pair(pixels_offset, samplerate * scale);
774 }
775
776 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
777         int x_start, int x_end) const
778 {
779         double samples_per_pixel, pixels_offset;
780         tie(pixels_offset, samples_per_pixel) =
781                 get_pixels_offset_samples_per_pixel();
782
783         const uint64_t start = (uint64_t)max(
784                 (x_start + pixels_offset) * samples_per_pixel, 0.0);
785         const uint64_t end = (uint64_t)max(
786                 (x_end + pixels_offset) * samples_per_pixel, 0.0);
787
788         return make_pair(start, end);
789 }
790
791 QColor DecodeTrace::get_row_color(int row_index) const
792 {
793         // For each row color, use the base color hue and add an offset that's
794         // not a dividend of 360
795
796         QColor color;
797         const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
798         const int s = DECODETRACE_COLOR_SATURATION;
799         const int v = DECODETRACE_COLOR_VALUE;
800         color.setHsl(h, s, v);
801
802         return color;
803 }
804
805 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
806 {
807         // For each row color, use the base color hue and add an offset that's
808         // not a dividend of 360 and not a multiple of the row offset
809
810         QColor color(row_color);
811         const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
812         const int s = DECODETRACE_COLOR_SATURATION;
813         const int v = DECODETRACE_COLOR_VALUE;
814         color.setHsl(h, s, v);
815
816         return color;
817 }
818
819 int DecodeTrace::get_row_at_point(const QPoint &point)
820 {
821         if (!row_height_)
822                 return -1;
823
824         const int y = (point.y() - get_visual_y() + row_height_ / 2);
825
826         /* Integer divison of (x-1)/x would yield 0, so we check for this. */
827         if (y < 0)
828                 return -1;
829
830         const int row = y / row_height_;
831
832         if (row >= (int)visible_rows_.size())
833                 return -1;
834
835         return row;
836 }
837
838 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
839 {
840         using namespace pv::data::decode;
841
842         if (!enabled())
843                 return QString();
844
845         const pair<uint64_t, uint64_t> sample_range =
846                 get_view_sample_range(point.x(), point.x() + 1);
847         const int row = get_row_at_point(point);
848         if (row < 0)
849                 return QString();
850
851         vector<Annotation> annotations;
852
853         decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
854                 current_segment_, sample_range.first, sample_range.second);
855
856         return (annotations.empty()) ?
857                 QString() : annotations[0].annotations().front();
858 }
859
860 void DecodeTrace::hover_point_changed(const QPoint &hp)
861 {
862         Trace::hover_point_changed(hp);
863
864         assert(owner_);
865
866         const View *const view = owner_->view();
867         assert(view);
868
869         if (hp.x() == 0) {
870                 QToolTip::hideText();
871                 return;
872         }
873
874         QString ann = get_annotation_at_point(hp);
875
876         if (!row_height_ || ann.isEmpty()) {
877                 QToolTip::hideText();
878                 return;
879         }
880
881         const int hover_row = get_row_at_point(hp);
882
883         QFontMetrics m(QToolTip::font());
884         const QRect text_size = m.boundingRect(QRect(), 0, ann);
885
886         // This is OS-specific and unfortunately we can't query it, so
887         // use an approximation to at least try to minimize the error.
888         const int padding = 8;
889
890         // Make sure the tool tip doesn't overlap with the mouse cursor.
891         // If it did, the tool tip would constantly hide and re-appear.
892         // We also push it up by one row so that it appears above the
893         // decode trace, not below.
894         QPoint p = hp;
895         p.setX(hp.x() - (text_size.width() / 2) - padding);
896
897         p.setY(get_visual_y() - (row_height_ / 2) +
898                 (hover_row * row_height_) -
899                 row_height_ - text_size.height() - padding);
900
901         QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
902 }
903
904 void DecodeTrace::create_decoder_form(int index,
905         shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
906         QFormLayout *form)
907 {
908         GlobalSettings settings;
909
910         assert(dec);
911         const srd_decoder *const decoder = dec->decoder();
912         assert(decoder);
913
914         const bool decoder_deletable = index > 0;
915
916         pv::widgets::DecoderGroupBox *const group =
917                 new pv::widgets::DecoderGroupBox(
918                         QString::fromUtf8(decoder->name),
919                         tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
920                                 QString::fromUtf8(decoder->desc)),
921                         nullptr, decoder_deletable);
922         group->set_decoder_visible(dec->shown());
923
924         if (decoder_deletable) {
925                 delete_mapper_.setMapping(group, index);
926                 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
927         }
928
929         show_hide_mapper_.setMapping(group, index);
930         connect(group, SIGNAL(show_hide_decoder()),
931                 &show_hide_mapper_, SLOT(map()));
932
933         QFormLayout *const decoder_form = new QFormLayout;
934         group->add_layout(decoder_form);
935
936         const vector<DecodeChannel> channels = decode_signal_->get_channels();
937
938         // Add the channels
939         for (const DecodeChannel& ch : channels) {
940                 // Ignore channels not part of the decoder we create the form for
941                 if (ch.decoder_ != dec)
942                         continue;
943
944                 QComboBox *const combo = create_channel_selector(parent, &ch);
945                 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
946
947                 channel_id_map_[combo] = ch.id;
948                 init_state_map_[combo_init_state] = ch.id;
949
950                 connect(combo, SIGNAL(currentIndexChanged(int)),
951                         this, SLOT(on_channel_selected(int)));
952                 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
953                         this, SLOT(on_init_state_changed(int)));
954
955                 QHBoxLayout *const hlayout = new QHBoxLayout;
956                 hlayout->addWidget(combo);
957                 hlayout->addWidget(combo_init_state);
958
959                 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
960                         combo_init_state->hide();
961
962                 const QString required_flag = ch.is_optional ? QString() : QString("*");
963                 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
964                         .arg(ch.name, ch.desc, required_flag), hlayout);
965         }
966
967         // Add the options
968         shared_ptr<binding::Decoder> binding(
969                 new binding::Decoder(decode_signal_, dec));
970         binding->add_properties_to_form(decoder_form, true);
971
972         bindings_.push_back(binding);
973
974         form->addRow(group);
975         decoder_forms_.push_back(group);
976 }
977
978 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
979 {
980         const auto sigs(session_.signalbases());
981
982         // Sort signals in natural order
983         vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
984         sort(sig_list.begin(), sig_list.end(),
985                 [](const shared_ptr<data::SignalBase> &a,
986                 const shared_ptr<data::SignalBase> &b) {
987                         return strnatcasecmp(a->name().toStdString(),
988                                 b->name().toStdString()) < 0; });
989
990         QComboBox *selector = new QComboBox(parent);
991
992         selector->addItem("-", qVariantFromValue((void*)nullptr));
993
994         if (!ch->assigned_signal)
995                 selector->setCurrentIndex(0);
996
997         for (const shared_ptr<data::SignalBase> &b : sig_list) {
998                 assert(b);
999                 if (b->logic_data() && b->enabled()) {
1000                         selector->addItem(b->name(),
1001                                 qVariantFromValue((void*)b.get()));
1002
1003                         if (ch->assigned_signal == b.get())
1004                                 selector->setCurrentIndex(selector->count() - 1);
1005                 }
1006         }
1007
1008         return selector;
1009 }
1010
1011 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1012         const DecodeChannel *ch)
1013 {
1014         QComboBox *selector = new QComboBox(parent);
1015
1016         selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
1017         selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
1018         selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1019
1020         selector->setCurrentIndex(ch->initial_pin_state);
1021
1022         selector->setToolTip("Initial (assumed) pin value before the first sample");
1023
1024         return selector;
1025 }
1026
1027 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
1028 {
1029         using namespace pv::data::decode;
1030
1031         GlobalSettings settings;
1032         const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1033
1034         const QString file_name = QFileDialog::getSaveFileName(
1035                 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1036
1037         if (file_name.isEmpty())
1038                 return;
1039
1040         QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1041         const QString quote = format.contains("%q") ? "\"" : "";
1042         format = format.remove("%q");
1043
1044         QFile file(file_name);
1045         if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1046                 QTextStream out_stream(&file);
1047
1048                 for (Annotation &ann : *annotations) {
1049                         const QString sample_range = QString("%1-%2") \
1050                                 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
1051
1052                         const QString class_name = quote + ann.row()->class_name() + quote;
1053
1054                         QString all_ann_text;
1055                         for (const QString &s : ann.annotations())
1056                                 all_ann_text = all_ann_text + quote + s + quote + ",";
1057                         all_ann_text.chop(1);
1058
1059                         const QString first_ann_text = quote + ann.annotations().front() + quote;
1060
1061                         QString out_text = format;
1062                         out_text = out_text.replace("%s", sample_range);
1063                         out_text = out_text.replace("%d",
1064                                 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
1065                         out_text = out_text.replace("%c", class_name);
1066                         out_text = out_text.replace("%1", first_ann_text);
1067                         out_text = out_text.replace("%a", all_ann_text);
1068                         out_stream << out_text << '\n';
1069                 }
1070
1071                 if (out_stream.status() == QTextStream::Ok)
1072                         return;
1073         }
1074
1075         QMessageBox msg(owner_->view());
1076         msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1077         msg.setStandardButtons(QMessageBox::Ok);
1078         msg.setIcon(QMessageBox::Warning);
1079         msg.exec();
1080 }
1081
1082 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1083 {
1084         if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows) {
1085                 visible_rows_.clear();
1086                 max_visible_rows_ = 0;
1087                 always_show_all_rows_ = value.toBool();
1088         }
1089 }
1090
1091 void DecodeTrace::on_new_annotations()
1092 {
1093         if (!delayed_trace_updater_.isActive())
1094                 delayed_trace_updater_.start();
1095 }
1096
1097 void DecodeTrace::on_delayed_trace_update()
1098 {
1099         if (owner_)
1100                 owner_->row_item_appearance_changed(false, true);
1101 }
1102
1103 void DecodeTrace::on_decode_reset()
1104 {
1105         visible_rows_.clear();
1106         max_visible_rows_ = 0;
1107
1108         if (owner_)
1109                 owner_->row_item_appearance_changed(false, true);
1110 }
1111
1112 void DecodeTrace::on_decode_finished()
1113 {
1114         if (owner_)
1115                 owner_->row_item_appearance_changed(false, true);
1116 }
1117
1118 void DecodeTrace::on_pause_decode()
1119 {
1120         if (decode_signal_->is_paused())
1121                 decode_signal_->resume_decode();
1122         else
1123                 decode_signal_->pause_decode();
1124 }
1125
1126 void DecodeTrace::delete_pressed()
1127 {
1128         on_delete();
1129 }
1130
1131 void DecodeTrace::on_delete()
1132 {
1133         session_.remove_decode_signal(decode_signal_);
1134 }
1135
1136 void DecodeTrace::on_channel_selected(int)
1137 {
1138         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1139
1140         // Determine signal that was selected
1141         const data::SignalBase *signal =
1142                 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1143
1144         // Determine decode channel ID this combo box is the channel selector for
1145         const uint16_t id = channel_id_map_.at(cb);
1146
1147         decode_signal_->assign_signal(id, signal);
1148 }
1149
1150 void DecodeTrace::on_channels_updated()
1151 {
1152         if (owner_)
1153                 owner_->row_item_appearance_changed(false, true);
1154 }
1155
1156 void DecodeTrace::on_init_state_changed(int)
1157 {
1158         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1159
1160         // Determine inital pin state that was selected
1161         int init_state = cb->itemData(cb->currentIndex()).value<int>();
1162
1163         // Determine decode channel ID this combo box is the channel selector for
1164         const uint16_t id = init_state_map_.at(cb);
1165
1166         decode_signal_->set_initial_pin_state(id, init_state);
1167 }
1168
1169 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1170 {
1171         decode_signal_->stack_decoder(decoder);
1172
1173         create_popup_form();
1174 }
1175
1176 void DecodeTrace::on_delete_decoder(int index)
1177 {
1178         decode_signal_->remove_decoder(index);
1179
1180         // Force re-calculation of the trace height, see paint_mid()
1181         max_visible_rows_ = 0;
1182         owner_->extents_changed(false, true);
1183
1184         // Update the popup
1185         create_popup_form();
1186 }
1187
1188 void DecodeTrace::on_show_hide_decoder(int index)
1189 {
1190         const bool state = decode_signal_->toggle_decoder_visibility(index);
1191
1192         assert(index < (int)decoder_forms_.size());
1193         decoder_forms_[index]->set_decoder_visible(state);
1194
1195         if (!state) {
1196                 // Force re-calculation of the trace height, see paint_mid()
1197                 max_visible_rows_ = 0;
1198                 owner_->extents_changed(false, true);
1199         }
1200
1201         if (owner_)
1202                 owner_->row_item_appearance_changed(false, true);
1203 }
1204
1205 void DecodeTrace::on_copy_annotation_to_clipboard()
1206 {
1207         using namespace pv::data::decode;
1208
1209         if (!selected_row_)
1210                 return;
1211
1212         vector<Annotation> *annotations = new vector<Annotation>();
1213
1214         decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1215                 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1216
1217         if (annotations->empty())
1218                 return;
1219
1220         QClipboard *clipboard = QGuiApplication::clipboard();
1221         clipboard->setText(annotations->front().annotations().front(), QClipboard::Clipboard);
1222
1223         if (clipboard->supportsSelection())
1224                 clipboard->setText(annotations->front().annotations().front(), QClipboard::Selection);
1225
1226         delete annotations;
1227 }
1228
1229 void DecodeTrace::on_export_row()
1230 {
1231         selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1232         on_export_row_from_here();
1233 }
1234
1235 void DecodeTrace::on_export_all_rows()
1236 {
1237         selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1238         on_export_all_rows_from_here();
1239 }
1240
1241 void DecodeTrace::on_export_row_with_cursor()
1242 {
1243         const View *view = owner_->view();
1244         assert(view);
1245
1246         if (!view->cursors()->enabled())
1247                 return;
1248
1249         const double samplerate = session_.get_samplerate();
1250
1251         const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1252         const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1253
1254         const uint64_t start_sample = (uint64_t)max(
1255                 0.0, start_time.convert_to<double>() * samplerate);
1256         const uint64_t end_sample = (uint64_t)max(
1257                 0.0, end_time.convert_to<double>() * samplerate);
1258
1259         // Are both cursors negative and thus were clamped to 0?
1260         if ((start_sample == 0) && (end_sample == 0))
1261                 return;
1262
1263         selected_sample_range_ = make_pair(start_sample, end_sample);
1264         on_export_row_from_here();
1265 }
1266
1267 void DecodeTrace::on_export_all_rows_with_cursor()
1268 {
1269         const View *view = owner_->view();
1270         assert(view);
1271
1272         if (!view->cursors()->enabled())
1273                 return;
1274
1275         const double samplerate = session_.get_samplerate();
1276
1277         const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1278         const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1279
1280         const uint64_t start_sample = (uint64_t)max(
1281                 0.0, start_time.convert_to<double>() * samplerate);
1282         const uint64_t end_sample = (uint64_t)max(
1283                 0.0, end_time.convert_to<double>() * samplerate);
1284
1285         // Are both cursors negative and thus were clamped to 0?
1286         if ((start_sample == 0) && (end_sample == 0))
1287                 return;
1288
1289         selected_sample_range_ = make_pair(start_sample, end_sample);
1290         on_export_all_rows_from_here();
1291 }
1292
1293 void DecodeTrace::on_export_row_from_here()
1294 {
1295         using namespace pv::data::decode;
1296
1297         if (!selected_row_)
1298                 return;
1299
1300         vector<Annotation> *annotations = new vector<Annotation>();
1301
1302         decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1303                 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1304
1305         if (annotations->empty())
1306                 return;
1307
1308         export_annotations(annotations);
1309         delete annotations;
1310 }
1311
1312 void DecodeTrace::on_export_all_rows_from_here()
1313 {
1314         using namespace pv::data::decode;
1315
1316         vector<Annotation> *annotations = new vector<Annotation>();
1317
1318         decode_signal_->get_annotation_subset(*annotations, current_segment_,
1319                         selected_sample_range_.first, selected_sample_range_.second);
1320
1321         if (!annotations->empty())
1322                 export_annotations(annotations);
1323
1324         delete annotations;
1325 }
1326
1327 } // namespace trace
1328 } // namespace views
1329 } // namespace pv