2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
30 #include <boost/functional/hash.hpp>
33 #include <QApplication>
35 #include <QFileDialog>
36 #include <QFormLayout>
39 #include <QMessageBox>
40 #include <QPushButton>
41 #include <QTextStream>
44 #include "decodetrace.hpp"
46 #include "viewport.hpp"
48 #include <pv/globalsettings.hpp>
49 #include <pv/session.hpp>
50 #include <pv/strnatcmp.hpp>
51 #include <pv/data/decodesignal.hpp>
52 #include <pv/data/decode/annotation.hpp>
53 #include <pv/data/decode/decoder.hpp>
54 #include <pv/data/logic.hpp>
55 #include <pv/data/logicsegment.hpp>
56 #include <pv/widgets/decodergroupbox.hpp>
57 #include <pv/widgets/decodermenu.hpp>
63 using std::out_of_range;
65 using std::shared_ptr;
69 using pv::data::decode::Annotation;
70 using pv::data::decode::Row;
71 using pv::data::DecodeChannel;
72 using pv::data::DecodeSignal;
79 #define DECODETRACE_COLOR_SATURATION (180) /* 0-255 */
80 #define DECODETRACE_COLOR_VALUE (170) /* 0-255 */
82 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
83 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
85 const int DecodeTrace::ArrowSize = 4;
86 const double DecodeTrace::EndCapWidth = 5;
87 const int DecodeTrace::RowTitleMargin = 10;
88 const int DecodeTrace::DrawPadding = 100;
90 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
92 DecodeTrace::DecodeTrace(pv::Session &session,
93 shared_ptr<data::SignalBase> signalbase, int index) :
99 show_hide_mapper_(this)
101 decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
103 // Determine shortest string we want to see displayed in full
104 QFontMetrics m(QApplication::font());
105 min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
107 // For the base color, we want to start at a very different color for
108 // every decoder stack, so multiply the index with a number that is
109 // rather close to 180 degrees of the color circle but not a dividend of 360
110 // Note: The offset equals the color of the first annotation
112 const int h = (120 + 160 * index) % 360;
113 const int s = DECODETRACE_COLOR_SATURATION;
114 const int v = DECODETRACE_COLOR_VALUE;
115 color.setHsv(h, s, v);
116 base_->set_color(color);
118 connect(decode_signal_.get(), SIGNAL(new_annotations()),
119 this, SLOT(on_new_annotations()));
120 connect(decode_signal_.get(), SIGNAL(decode_reset()),
121 this, SLOT(on_decode_reset()));
122 connect(decode_signal_.get(), SIGNAL(decode_finished()),
123 this, SLOT(on_decode_finished()));
124 connect(decode_signal_.get(), SIGNAL(channels_updated()),
125 this, SLOT(on_channels_updated()));
127 connect(&delete_mapper_, SIGNAL(mapped(int)),
128 this, SLOT(on_delete_decoder(int)));
129 connect(&show_hide_mapper_, SIGNAL(mapped(int)),
130 this, SLOT(on_show_hide_decoder(int)));
132 connect(&delayed_trace_updater_, SIGNAL(timeout()),
133 this, SLOT(on_delayed_trace_update()));
134 delayed_trace_updater_.setSingleShot(true);
135 delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
138 bool DecodeTrace::enabled() const
143 shared_ptr<data::SignalBase> DecodeTrace::base() const
148 pair<int, int> DecodeTrace::v_extents() const
150 const int row_height = (ViewItemPaintParams::text_height() * 6) / 4;
152 // Make an empty decode trace appear symmetrical
153 const int row_count = max(1, max_visible_rows_);
155 return make_pair(-row_height, row_height * row_count);
158 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
160 Trace::paint_back(p, pp);
161 paint_axis(p, pp, get_visual_y());
164 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
166 const int text_height = ViewItemPaintParams::text_height();
167 row_height_ = (text_height * 6) / 4;
168 const int annotation_height = (text_height * 5) / 4;
170 // Set default pen to allow for text width calculation
173 // Iterate through the rows
174 int y = get_visual_y();
175 pair<uint64_t, uint64_t> sample_range = get_sample_range(pp.left(), pp.right());
177 // Just because the view says we see a certain sample range it
178 // doesn't mean we have this many decoded samples, too, so crop
179 // the range to what has been decoded already
180 sample_range.second = min((int64_t)sample_range.second,
181 decode_signal_->get_decoded_sample_count(current_segment_, false));
183 const vector<Row> rows = decode_signal_->visible_rows();
185 visible_rows_.clear();
186 for (const Row& row : rows) {
187 // Cache the row title widths
190 row_title_width = row_title_widths_.at(row);
191 } catch (out_of_range&) {
192 const int w = p.boundingRect(QRectF(), 0, row.title()).width() +
194 row_title_widths_[row] = w;
198 vector<Annotation> annotations;
199 decode_signal_->get_annotation_subset(annotations, row,
200 current_segment_, sample_range.first, sample_range.second);
201 if (!annotations.empty()) {
202 draw_annotations(annotations, p, annotation_height, pp, y,
203 get_row_color(row.index()), row_title_width);
205 visible_rows_.push_back(row);
209 draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
211 if ((int)visible_rows_.size() > max_visible_rows_) {
212 max_visible_rows_ = (int)visible_rows_.size();
214 // Call order is important, otherwise the lazy event handler won't work
215 owner_->extents_changed(false, true);
216 owner_->row_item_appearance_changed(false, true);
219 const QString err = decode_signal_->error_message();
221 draw_error(p, err, pp);
224 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
228 for (size_t i = 0; i < visible_rows_.size(); i++) {
229 const int y = i * row_height_ + get_visual_y();
231 p.setPen(QPen(Qt::NoPen));
232 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
235 const QPointF points[] = {
236 QPointF(pp.left(), y - ArrowSize),
237 QPointF(pp.left() + ArrowSize, y),
238 QPointF(pp.left(), y + ArrowSize)
240 p.drawPolygon(points, countof(points));
243 const QRect r(pp.left() + ArrowSize * 2, y - row_height_ / 2,
244 pp.right() - pp.left(), row_height_);
245 const QString h(visible_rows_[i].title());
246 const int f = Qt::AlignLeft | Qt::AlignVCenter |
250 p.setPen(QApplication::palette().color(QPalette::Base));
251 for (int dx = -1; dx <= 1; dx++)
252 for (int dy = -1; dy <= 1; dy++)
253 if (dx != 0 && dy != 0)
254 p.drawText(r.translated(dx, dy), f, h);
257 p.setPen(QApplication::palette().color(QPalette::WindowText));
261 if (show_hover_marker_)
262 paint_hover_marker(p);
265 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
267 using pv::data::decode::Decoder;
271 // Add the standard options
272 Trace::populate_popup_form(parent, form);
274 // Add the decoder options
276 channel_id_map_.clear();
277 init_state_map_.clear();
278 decoder_forms_.clear();
280 const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
283 QLabel *const l = new QLabel(
284 tr("<p><i>No decoders in the stack</i></p>"));
285 l->setAlignment(Qt::AlignCenter);
288 auto iter = stack.cbegin();
289 for (int i = 0; i < (int)stack.size(); i++, iter++) {
290 shared_ptr<Decoder> dec(*iter);
291 create_decoder_form(i, dec, parent, form);
294 form->addRow(new QLabel(
295 tr("<i>* Required channels</i>"), parent));
298 // Add stacking button
299 pv::widgets::DecoderMenu *const decoder_menu =
300 new pv::widgets::DecoderMenu(parent);
301 connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
302 this, SLOT(on_stack_decoder(srd_decoder*)));
304 QPushButton *const stack_button =
305 new QPushButton(tr("Stack Decoder"), parent);
306 stack_button->setMenu(decoder_menu);
307 stack_button->setToolTip(tr("Stack a higher-level decoder on top of this one"));
309 QHBoxLayout *stack_button_box = new QHBoxLayout;
310 stack_button_box->addWidget(stack_button, 0, Qt::AlignRight);
311 form->addRow(stack_button_box);
314 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
316 QMenu *const menu = Trace::create_header_context_menu(parent);
318 menu->addSeparator();
320 QAction *const del = new QAction(tr("Delete"), this);
321 del->setShortcuts(QKeySequence::Delete);
322 connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
323 menu->addAction(del);
328 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
331 selected_row_ = &visible_rows_[get_row_at_point(click_pos)];
332 } catch (out_of_range&) {
333 selected_row_ = nullptr;
336 const pair<uint64_t, uint64_t> sample_range =
337 get_sample_range(click_pos.x(), click_pos.x() + 1);
338 selected_samplepos_ = sample_range.first;
340 QMenu *const menu = new QMenu(parent);
342 QAction *const export_all_rows =
343 new QAction(tr("Export all annotations"), this);
344 export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
345 QIcon(":/icons/document-save-as.png")));
346 connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
347 menu->addAction(export_all_rows);
349 QAction *const export_row =
350 new QAction(tr("Export all annotations for this row"), this);
351 export_row->setIcon(QIcon::fromTheme("document-save-as",
352 QIcon(":/icons/document-save-as.png")));
353 connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
354 menu->addAction(export_row);
356 menu->addSeparator();
358 QAction *const export_all_rows_from_here =
359 new QAction(tr("Export all annotations, starting here"), this);
360 export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
361 QIcon(":/icons/document-save-as.png")));
362 connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
363 menu->addAction(export_all_rows_from_here);
365 QAction *const export_row_from_here =
366 new QAction(tr("Export annotations for this row, starting here"), this);
367 export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
368 QIcon(":/icons/document-save-as.png")));
369 connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
370 menu->addAction(export_row_from_here);
375 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
376 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
377 QColor row_color, int row_title_width)
379 using namespace pv::data::decode;
381 Annotation::Class block_class = 0;
382 bool block_class_uniform = true;
383 qreal block_start = 0;
384 int block_ann_count = 0;
386 const Annotation *prev_ann;
387 qreal prev_end = INT_MIN;
391 double samples_per_pixel, pixels_offset;
392 tie(pixels_offset, samples_per_pixel) =
393 get_pixels_offset_samples_per_pixel();
395 // Sort the annotations by start sample so that decoders
396 // can't confuse us by creating annotations out of order
397 stable_sort(annotations.begin(), annotations.end(),
398 [](const Annotation &a, const Annotation &b) {
399 return a.start_sample() < b.start_sample(); });
401 // Gather all annotations that form a visual "block" and draw them as such
402 for (const Annotation &a : annotations) {
404 const qreal abs_a_start = a.start_sample() / samples_per_pixel;
405 const qreal abs_a_end = a.end_sample() / samples_per_pixel;
407 const qreal a_start = abs_a_start - pixels_offset;
408 a_end = abs_a_end - pixels_offset;
410 const qreal a_width = a_end - a_start;
411 const qreal delta = a_end - prev_end;
413 bool a_is_separate = false;
415 // Annotation wider than the threshold for a useful label width?
416 if (a_width >= min_useful_label_width_) {
417 for (const QString &ann_text : a.annotations()) {
418 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
419 // Annotation wide enough to fit a label? Don't put it in a block then
421 a_is_separate = true;
427 // Were the previous and this annotation more than a pixel apart?
428 if ((abs(delta) > 1) || a_is_separate) {
429 // Block was broken, draw annotations that form the current block
430 if (block_ann_count == 1)
431 draw_annotation(*prev_ann, p, h, pp, y, row_color,
433 else if (block_ann_count > 0)
434 draw_annotation_block(block_start, prev_end, block_class,
435 block_class_uniform, p, h, y, row_color);
441 draw_annotation(a, p, h, pp, y, row_color, row_title_width);
442 // Next annotation must start a new block. delta will be > 1
443 // because we set prev_end to INT_MIN but that's okay since
444 // block_ann_count will be 0 and nothing will be drawn
451 if (block_ann_count == 0) {
452 block_start = a_start;
453 block_class = a.ann_class();
454 block_class_uniform = true;
456 if (a.ann_class() != block_class)
457 block_class_uniform = false;
463 if (block_ann_count == 1)
464 draw_annotation(*prev_ann, p, h, pp, y, row_color, row_title_width);
465 else if (block_ann_count > 0)
466 draw_annotation_block(block_start, prev_end, block_class,
467 block_class_uniform, p, h, y, row_color);
470 void DecodeTrace::draw_annotation(const pv::data::decode::Annotation &a,
471 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
472 QColor row_color, int row_title_width) const
474 double samples_per_pixel, pixels_offset;
475 tie(pixels_offset, samples_per_pixel) =
476 get_pixels_offset_samples_per_pixel();
478 const double start = a.start_sample() / samples_per_pixel -
480 const double end = a.end_sample() / samples_per_pixel - pixels_offset;
482 QColor color = get_annotation_color(row_color, a.ann_class());
483 p.setPen(color.darker());
486 if (start > pp.right() + DrawPadding || end < pp.left() - DrawPadding)
489 if (a.start_sample() == a.end_sample())
490 draw_instant(a, p, h, start, y);
492 draw_range(a, p, h, start, end, y, pp, row_title_width);
495 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
496 Annotation::Class ann_class, bool use_ann_format, QPainter &p, int h,
497 int y, QColor row_color) const
499 const double top = y + .5 - h / 2;
500 const double bottom = y + .5 + h / 2;
502 const QRectF rect(start, top, end - start, bottom - top);
505 p.setPen(QPen(Qt::NoPen));
506 p.setBrush(Qt::white);
507 p.drawRoundedRect(rect, r, r);
509 // If all annotations in this block are of the same type, we can use the
510 // one format that all of these annotations have. Otherwise, we should use
511 // a neutral color (i.e. gray)
512 if (use_ann_format) {
513 const QColor color = get_annotation_color(row_color, ann_class);
514 p.setPen(color.darker());
515 p.setBrush(QBrush(color, Qt::Dense4Pattern));
518 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
521 p.drawRoundedRect(rect, r, r);
524 void DecodeTrace::draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
525 int h, qreal x, int y) const
527 const QString text = a.annotations().empty() ?
528 QString() : a.annotations().back();
529 const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
531 const QRectF rect(x - w / 2, y - h / 2, w, h);
533 p.drawRoundedRect(rect, h / 2, h / 2);
536 p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
539 void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
540 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
541 int row_title_width) const
543 const qreal top = y + .5 - h / 2;
544 const qreal bottom = y + .5 + h / 2;
545 const vector<QString> annotations = a.annotations();
547 // If the two ends are within 1 pixel, draw a vertical line
548 if (start + 1.0 > end) {
549 p.drawLine(QPointF(start, top), QPointF(start, bottom));
553 const qreal cap_width = min((end - start) / 4, EndCapWidth);
556 QPointF(start, y + .5f),
557 QPointF(start + cap_width, top),
558 QPointF(end - cap_width, top),
559 QPointF(end, y + .5f),
560 QPointF(end - cap_width, bottom),
561 QPointF(start + cap_width, bottom)
564 p.drawConvexPolygon(pts, countof(pts));
566 if (annotations.empty())
569 const int ann_start = start + cap_width;
570 const int ann_end = end - cap_width;
572 const int real_start = max(ann_start, pp.left() + row_title_width);
573 const int real_end = min(ann_end, pp.right());
574 const int real_width = real_end - real_start;
576 QRectF rect(real_start, y - h / 2, real_width, h);
577 if (rect.width() <= 4)
582 // Try to find an annotation that will fit
583 QString best_annotation;
586 for (const QString &a : annotations) {
587 const int w = p.boundingRect(QRectF(), 0, a).width();
588 if (w <= rect.width() && w > best_width)
589 best_annotation = a, best_width = w;
592 if (best_annotation.isEmpty())
593 best_annotation = annotations.back();
595 // If not ellide the last in the list
596 p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
597 best_annotation, Qt::ElideRight, rect.width()));
600 void DecodeTrace::draw_error(QPainter &p, const QString &message,
601 const ViewItemPaintParams &pp)
603 const int y = get_visual_y();
605 double samples_per_pixel, pixels_offset;
606 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
608 p.setPen(ErrorBgColor.darker());
609 p.setBrush(ErrorBgColor);
611 const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
613 const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
614 const qreal r = text_rect.height() / 4;
616 p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
619 p.drawText(text_rect, message);
622 void DecodeTrace::draw_unresolved_period(QPainter &p, int h, int left, int right) const
624 using namespace pv::data;
625 using pv::data::decode::Decoder;
627 double samples_per_pixel, pixels_offset;
629 const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
630 if (sample_count == 0)
633 const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
634 if (sample_count == samples_decoded)
637 const int y = get_visual_y();
639 tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
641 const double start = max(samples_decoded /
642 samples_per_pixel - pixels_offset, left - 1.0);
643 const double end = min(sample_count / samples_per_pixel -
644 pixels_offset, right + 1.0);
645 const QRectF no_decode_rect(start, y - (h / 2) - 0.5, end - start, h);
647 p.setPen(QPen(Qt::NoPen));
648 p.setBrush(Qt::white);
649 p.drawRect(no_decode_rect);
651 p.setPen(NoDecodeColor);
652 p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
653 p.drawRect(no_decode_rect);
656 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
660 const View *view = owner_->view();
663 const double scale = view->scale();
666 const double pixels_offset =
667 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
669 double samplerate = decode_signal_->samplerate();
671 // Show sample rate as 1Hz when it is unknown
672 if (samplerate == 0.0)
675 return make_pair(pixels_offset, samplerate * scale);
678 pair<uint64_t, uint64_t> DecodeTrace::get_sample_range(
679 int x_start, int x_end) const
681 double samples_per_pixel, pixels_offset;
682 tie(pixels_offset, samples_per_pixel) =
683 get_pixels_offset_samples_per_pixel();
685 const uint64_t start = (uint64_t)max(
686 (x_start + pixels_offset) * samples_per_pixel, 0.0);
687 const uint64_t end = (uint64_t)max(
688 (x_end + pixels_offset) * samples_per_pixel, 0.0);
690 return make_pair(start, end);
693 QColor DecodeTrace::get_row_color(int row_index) const
695 // For each row color, use the base color hue and add an offset that's
696 // not a dividend of 360
699 const int h = (base_->color().toHsv().hue() + 20 * row_index) % 360;
700 const int s = DECODETRACE_COLOR_SATURATION;
701 const int v = DECODETRACE_COLOR_VALUE;
702 color.setHsl(h, s, v);
707 QColor DecodeTrace::get_annotation_color(QColor row_color, int annotation_index) const
709 // For each row color, use the base color hue and add an offset that's
710 // not a dividend of 360 and not a multiple of the row offset
712 QColor color(row_color);
713 const int h = (color.toHsv().hue() + 55 * annotation_index) % 360;
714 const int s = DECODETRACE_COLOR_SATURATION;
715 const int v = DECODETRACE_COLOR_VALUE;
716 color.setHsl(h, s, v);
721 int DecodeTrace::get_row_at_point(const QPoint &point)
726 const int y = (point.y() - get_visual_y() + row_height_ / 2);
728 /* Integer divison of (x-1)/x would yield 0, so we check for this. */
732 const int row = y / row_height_;
734 if (row >= (int)visible_rows_.size())
740 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
742 using namespace pv::data::decode;
747 const pair<uint64_t, uint64_t> sample_range =
748 get_sample_range(point.x(), point.x() + 1);
749 const int row = get_row_at_point(point);
753 vector<Annotation> annotations;
755 decode_signal_->get_annotation_subset(annotations, visible_rows_[row],
756 current_segment_, sample_range.first, sample_range.second);
758 return (annotations.empty()) ?
759 QString() : annotations[0].annotations().front();
762 void DecodeTrace::hover_point_changed(const QPoint &hp)
764 Trace::hover_point_changed(hp);
768 const View *const view = owner_->view();
772 QToolTip::hideText();
776 QString ann = get_annotation_at_point(hp);
780 if (!row_height_ || ann.isEmpty()) {
781 QToolTip::hideText();
785 const int hover_row = get_row_at_point(hp);
787 QFontMetrics m(QToolTip::font());
788 const QRect text_size = m.boundingRect(QRect(), 0, ann);
790 // This is OS-specific and unfortunately we can't query it, so
791 // use an approximation to at least try to minimize the error.
792 const int padding = 8;
794 // Make sure the tool tip doesn't overlap with the mouse cursor.
795 // If it did, the tool tip would constantly hide and re-appear.
796 // We also push it up by one row so that it appears above the
797 // decode trace, not below.
799 p.setX(hp.x() - (text_size.width() / 2) - padding);
801 p.setY(get_visual_y() - (row_height_ / 2) +
802 (hover_row * row_height_) -
803 row_height_ - text_size.height() - padding);
805 QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
808 void DecodeTrace::create_decoder_form(int index,
809 shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
812 GlobalSettings settings;
815 const srd_decoder *const decoder = dec->decoder();
818 const bool decoder_deletable = index > 0;
820 pv::widgets::DecoderGroupBox *const group =
821 new pv::widgets::DecoderGroupBox(
822 QString::fromUtf8(decoder->name),
823 tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
824 QString::fromUtf8(decoder->desc)),
825 nullptr, decoder_deletable);
826 group->set_decoder_visible(dec->shown());
828 if (decoder_deletable) {
829 delete_mapper_.setMapping(group, index);
830 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
833 show_hide_mapper_.setMapping(group, index);
834 connect(group, SIGNAL(show_hide_decoder()),
835 &show_hide_mapper_, SLOT(map()));
837 QFormLayout *const decoder_form = new QFormLayout;
838 group->add_layout(decoder_form);
840 const vector<DecodeChannel> channels = decode_signal_->get_channels();
843 for (DecodeChannel ch : channels) {
844 // Ignore channels not part of the decoder we create the form for
845 if (ch.decoder_ != dec)
848 QComboBox *const combo = create_channel_selector(parent, &ch);
849 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
851 channel_id_map_[combo] = ch.id;
852 init_state_map_[combo_init_state] = ch.id;
854 connect(combo, SIGNAL(currentIndexChanged(int)),
855 this, SLOT(on_channel_selected(int)));
856 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
857 this, SLOT(on_init_state_changed(int)));
859 QHBoxLayout *const hlayout = new QHBoxLayout;
860 hlayout->addWidget(combo);
861 hlayout->addWidget(combo_init_state);
863 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
864 combo_init_state->hide();
866 const QString required_flag = ch.is_optional ? QString() : QString("*");
867 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
868 .arg(ch.name, ch.desc, required_flag), hlayout);
872 shared_ptr<binding::Decoder> binding(
873 new binding::Decoder(decode_signal_, dec));
874 binding->add_properties_to_form(decoder_form, true);
876 bindings_.push_back(binding);
879 decoder_forms_.push_back(group);
882 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
884 const auto sigs(session_.signalbases());
886 // Sort signals in natural order
887 vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
888 sort(sig_list.begin(), sig_list.end(),
889 [](const shared_ptr<data::SignalBase> &a,
890 const shared_ptr<data::SignalBase> &b) {
891 return strnatcasecmp(a->name().toStdString(),
892 b->name().toStdString()) < 0; });
894 QComboBox *selector = new QComboBox(parent);
896 selector->addItem("-", qVariantFromValue((void*)nullptr));
898 if (!ch->assigned_signal)
899 selector->setCurrentIndex(0);
901 for (const shared_ptr<data::SignalBase> &b : sig_list) {
903 if (b->logic_data() && b->enabled()) {
904 selector->addItem(b->name(),
905 qVariantFromValue((void*)b.get()));
907 if (ch->assigned_signal == b.get())
908 selector->setCurrentIndex(selector->count() - 1);
915 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
916 const DecodeChannel *ch)
918 QComboBox *selector = new QComboBox(parent);
920 selector->addItem("0", qVariantFromValue((int)SRD_INITIAL_PIN_LOW));
921 selector->addItem("1", qVariantFromValue((int)SRD_INITIAL_PIN_HIGH));
922 selector->addItem("X", qVariantFromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
924 selector->setCurrentIndex(ch->initial_pin_state);
926 selector->setToolTip("Initial (assumed) pin value before the first sample");
931 void DecodeTrace::export_annotations(vector<Annotation> *annotations) const
933 using namespace pv::data::decode;
935 GlobalSettings settings;
936 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
938 const QString file_name = QFileDialog::getSaveFileName(
939 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
941 if (file_name.isEmpty())
944 QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
945 const QString quote = format.contains("%q") ? "\"" : "";
946 format = format.remove("%q");
948 QFile file(file_name);
949 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
950 QTextStream out_stream(&file);
952 for (Annotation &ann : *annotations) {
953 const QString sample_range = QString("%1-%2") \
954 .arg(QString::number(ann.start_sample()), QString::number(ann.end_sample()));
956 const QString class_name = quote + ann.row()->class_name() + quote;
958 QString all_ann_text;
959 for (const QString &s : ann.annotations())
960 all_ann_text = all_ann_text + quote + s + quote + ",";
961 all_ann_text.chop(1);
963 const QString first_ann_text = quote + ann.annotations().front() + quote;
965 QString out_text = format;
966 out_text = out_text.replace("%s", sample_range);
967 out_text = out_text.replace("%d",
968 quote + QString::fromUtf8(ann.row()->decoder()->name) + quote);
969 out_text = out_text.replace("%c", class_name);
970 out_text = out_text.replace("%1", first_ann_text);
971 out_text = out_text.replace("%a", all_ann_text);
972 out_stream << out_text << '\n';
975 if (out_stream.status() == QTextStream::Ok)
979 QMessageBox msg(owner_->view());
980 msg.setText(tr("Error"));
981 msg.setInformativeText(tr("File %1 could not be written to.").arg(file_name));
982 msg.setStandardButtons(QMessageBox::Ok);
983 msg.setIcon(QMessageBox::Warning);
987 void DecodeTrace::on_new_annotations()
989 if (!delayed_trace_updater_.isActive())
990 delayed_trace_updater_.start();
993 void DecodeTrace::on_delayed_trace_update()
996 owner_->row_item_appearance_changed(false, true);
999 void DecodeTrace::on_decode_reset()
1001 visible_rows_.clear();
1002 max_visible_rows_ = 0;
1005 owner_->row_item_appearance_changed(false, true);
1008 void DecodeTrace::on_decode_finished()
1011 owner_->row_item_appearance_changed(false, true);
1014 void DecodeTrace::delete_pressed()
1019 void DecodeTrace::on_delete()
1021 session_.remove_decode_signal(decode_signal_);
1024 void DecodeTrace::on_channel_selected(int)
1026 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1028 // Determine signal that was selected
1029 const data::SignalBase *signal =
1030 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1032 // Determine decode channel ID this combo box is the channel selector for
1033 const uint16_t id = channel_id_map_.at(cb);
1035 decode_signal_->assign_signal(id, signal);
1038 void DecodeTrace::on_channels_updated()
1041 owner_->row_item_appearance_changed(false, true);
1044 void DecodeTrace::on_init_state_changed(int)
1046 QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1048 // Determine inital pin state that was selected
1049 int init_state = cb->itemData(cb->currentIndex()).value<int>();
1051 // Determine decode channel ID this combo box is the channel selector for
1052 const uint16_t id = init_state_map_.at(cb);
1054 decode_signal_->set_initial_pin_state(id, init_state);
1057 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1059 decode_signal_->stack_decoder(decoder);
1061 create_popup_form();
1064 void DecodeTrace::on_delete_decoder(int index)
1066 decode_signal_->remove_decoder(index);
1068 // Force re-calculation of the trace height, see paint_mid()
1069 max_visible_rows_ = 0;
1070 owner_->extents_changed(false, true);
1073 create_popup_form();
1076 void DecodeTrace::on_show_hide_decoder(int index)
1078 const bool state = decode_signal_->toggle_decoder_visibility(index);
1080 assert(index < (int)decoder_forms_.size());
1081 decoder_forms_[index]->set_decoder_visible(state);
1084 // Force re-calculation of the trace height, see paint_mid()
1085 max_visible_rows_ = 0;
1086 owner_->extents_changed(false, true);
1090 owner_->row_item_appearance_changed(false, true);
1093 void DecodeTrace::on_export_row()
1095 selected_samplepos_ = 0;
1096 on_export_row_from_here();
1099 void DecodeTrace::on_export_all_rows()
1101 selected_samplepos_ = 0;
1102 on_export_all_rows_from_here();
1105 void DecodeTrace::on_export_row_from_here()
1107 using namespace pv::data::decode;
1112 vector<Annotation> *annotations = new vector<Annotation>();
1114 decode_signal_->get_annotation_subset(*annotations, *selected_row_,
1115 current_segment_, selected_samplepos_, ULLONG_MAX);
1117 if (annotations->empty())
1120 export_annotations(annotations);
1124 void DecodeTrace::on_export_all_rows_from_here()
1126 using namespace pv::data::decode;
1128 vector<Annotation> *annotations = new vector<Annotation>();
1130 decode_signal_->get_annotation_subset(*annotations, current_segment_,
1131 selected_samplepos_, ULLONG_MAX);
1133 if (!annotations->empty())
1134 export_annotations(annotations);
1139 } // namespace trace
1140 } // namespace views