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 <QCheckBox>
  36 #include <QComboBox>
  37 #include <QDebug>
  38 #include <QFileDialog>
  39 #include <QFormLayout>
  40 #include <QLabel>
  41 #include <QMenu>
  42 #include <QMessageBox>
  43 #include <QPushButton>
  44 #include <QTextStream>
  45 #include <QToolTip>
  46
  47 #include "decodetrace.hpp"
  48 #include "view.hpp"
  49 #include "viewport.hpp"
  50
  51 #include <pv/globalsettings.hpp>
  52 #include <pv/session.hpp>
  53 #include <pv/strnatcmp.hpp>
  54 #include <pv/data/decodesignal.hpp>
  55 #include <pv/data/decode/annotation.hpp>
  56 #include <pv/data/decode/decoder.hpp>
  57 #include <pv/data/logic.hpp>
  58 #include <pv/data/logicsegment.hpp>
  59 #include <pv/widgets/decodergroupbox.hpp>
  60 #include <pv/widgets/decodermenu.hpp>
  61 #include <pv/widgets/flowlayout.hpp>
  62
  63 using std::abs;
  64 using std::find_if;
  65 using std::lock_guard;
  66 using std::make_pair;
  67 using std::max;
  68 using std::min;
  69 using std::numeric_limits;
  70 using std::pair;
  71 using std::shared_ptr;
  72 using std::tie;
  73 using std::vector;
  74
  75 using pv::data::decode::Annotation;
  76 using pv::data::decode::AnnotationClass;
  77 using pv::data::decode::Row;
  78 using pv::data::decode::DecodeChannel;
  79 using pv::data::DecodeSignal;
  80
  81 namespace pv {
  82 namespace views {
  83 namespace trace {
  84
  85 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
  86 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
  87 const QColor DecodeTrace::ExpandMarkerWarnColor = QColor(0xFF, 0xA5, 0x00); // QColorConstants::Svg::orange
  88 const QColor DecodeTrace::ExpandMarkerHiddenColor = QColor(0x69, 0x69, 0x69); // QColorConstants::Svg::dimgray
  89 const uint8_t DecodeTrace::ExpansionAreaHeaderAlpha = 10 * 255 / 100;
  90 const uint8_t DecodeTrace::ExpansionAreaAlpha = 5 * 255 / 100;
  91
  92 const int DecodeTrace::ArrowSize = 6;
  93 const double DecodeTrace::EndCapWidth = 5;
  94 const int DecodeTrace::RowTitleMargin = 7;
  95 const int DecodeTrace::DrawPadding = 100;
  96
  97 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
  98 const int DecodeTrace::AnimationDurationInTicks = 7;
  99 const int DecodeTrace::HiddenRowHideDelay = 1000; // 1 second
 100
 101 /**
 102  * Helper function for forceUpdate()
 103  */
 104 void invalidateLayout(QLayout* layout)
 105 {
 106         // Recompute the given layout and all its child layouts recursively
 107         for (int i = 0; i < layout->count(); i++) {
 108                 QLayoutItem *item = layout->itemAt(i);
 109
 110                 if (item->layout())
 111                         invalidateLayout(item->layout());
 112                 else
 113                         item->invalidate();
 114         }
 115
 116         layout->invalidate();
 117         layout->activate();
 118 }
 119
 120 void forceUpdate(QWidget* widget)
 121 {
 122         // Update all child widgets recursively
 123         for (QObject* child : widget->children())
 124                 if (child->isWidgetType())
 125                         forceUpdate((QWidget*)child);
 126
 127         // Invalidate the layout of the widget itself
 128         if (widget->layout())
 129                 invalidateLayout(widget->layout());
 130 }
 131
 132
 133 ContainerWidget::ContainerWidget(QWidget *parent) :
 134         QWidget(parent)
 135 {
 136 }
 137
 138 void ContainerWidget::resizeEvent(QResizeEvent* event)
 139 {
 140         QWidget::resizeEvent(event);
 141
 142         widgetResized(this);
 143 }
 144
 145
 146 DecodeTrace::DecodeTrace(pv::Session &session,
 147         shared_ptr<data::SignalBase> signalbase, int index) :
 148         Trace(signalbase),
 149         session_(session),
 150         show_hidden_rows_(false),
 151         delete_mapper_(this),
 152         show_hide_mapper_(this),
 153         row_show_hide_mapper_(this)
 154 {
 155         decode_signal_ = dynamic_pointer_cast<data::DecodeSignal>(base_);
 156
 157         GlobalSettings settings;
 158         always_show_all_rows_ = settings.value(GlobalSettings::Key_Dec_AlwaysShowAllRows).toBool();
 159
 160         GlobalSettings::add_change_handler(this);
 161
 162         // Determine shortest string we want to see displayed in full
 163         QFontMetrics m(QApplication::font());
 164         min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
 165
 166         default_row_height_ = (ViewItemPaintParams::text_height() * 6) / 4;
 167         annotation_height_ = (ViewItemPaintParams::text_height() * 5) / 4;
 168
 169         // For the base color, we want to start at a very different color for
 170         // every decoder stack, so multiply the index with a number that is
 171         // rather close to 180 degrees of the color circle but not a dividend of 360
 172         // Note: The offset equals the color of the first annotation
 173         QColor color;
 174         const int h = (120 + 160 * index) % 360;
 175         const int s = DECODE_COLOR_SATURATION;
 176         const int v = DECODE_COLOR_VALUE;
 177         color.setHsv(h, s, v);
 178         base_->set_color(color);
 179
 180         connect(decode_signal_.get(), SIGNAL(color_changed(QColor)),
 181                 this, SLOT(on_color_changed(QColor)));
 182
 183         connect(decode_signal_.get(), SIGNAL(new_annotations()),
 184                 this, SLOT(on_new_annotations()));
 185         connect(decode_signal_.get(), SIGNAL(decode_reset()),
 186                 this, SLOT(on_decode_reset()));
 187         connect(decode_signal_.get(), SIGNAL(decode_finished()),
 188                 this, SLOT(on_decode_finished()));
 189         connect(decode_signal_.get(), SIGNAL(channels_updated()),
 190                 this, SLOT(on_channels_updated()));
 191
 192         connect(&delete_mapper_, SIGNAL(mapped(int)),
 193                 this, SLOT(on_delete_decoder(int)));
 194         connect(&show_hide_mapper_, SIGNAL(mapped(int)),
 195                 this, SLOT(on_show_hide_decoder(int)));
 196         connect(&row_show_hide_mapper_, SIGNAL(mapped(int)),
 197                 this, SLOT(on_show_hide_row(int)));
 198         connect(&class_show_hide_mapper_, SIGNAL(mapped(QWidget*)),
 199                 this, SLOT(on_show_hide_class(QWidget*)));
 200
 201         connect(&delayed_trace_updater_, SIGNAL(timeout()),
 202                 this, SLOT(on_delayed_trace_update()));
 203         delayed_trace_updater_.setSingleShot(true);
 204         delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
 205
 206         connect(&animation_timer_, SIGNAL(timeout()),
 207                 this, SLOT(on_animation_timer()));
 208         animation_timer_.setInterval(1000 / 50);
 209
 210         connect(&delayed_hidden_row_hider_, SIGNAL(timeout()),
 211                 this, SLOT(on_hide_hidden_rows()));
 212         delayed_hidden_row_hider_.setSingleShot(true);
 213         delayed_hidden_row_hider_.setInterval(HiddenRowHideDelay);
 214
 215         default_marker_shape_ << QPoint(0,         -ArrowSize);
 216         default_marker_shape_ << QPoint(ArrowSize,  0);
 217         default_marker_shape_ << QPoint(0,          ArrowSize);
 218 }
 219
 220 DecodeTrace::~DecodeTrace()
 221 {
 222         GlobalSettings::remove_change_handler(this);
 223
 224         for (DecodeTraceRow& r : rows_) {
 225                 for (QCheckBox* cb : r.selectors)
 226                         delete cb;
 227
 228                 delete r.selector_container;
 229                 delete r.header_container;
 230                 delete r.container;
 231         }
 232 }
 233
 234 bool DecodeTrace::enabled() const
 235 {
 236         return true;
 237 }
 238
 239 shared_ptr<data::SignalBase> DecodeTrace::base() const
 240 {
 241         return base_;
 242 }
 243
 244 void DecodeTrace::set_owner(TraceTreeItemOwner *owner)
 245 {
 246         Trace::set_owner(owner);
 247
 248         // The owner is set in trace::View::signals_changed(), which is a slot.
 249         // So after this trace was added to the view, we won't have an owner
 250         // that we need to initialize in update_rows(). Once we do, we call it
 251         // from on_decode_reset().
 252         on_decode_reset();
 253 }
 254
 255 pair<int, int> DecodeTrace::v_extents() const
 256 {
 257         // Make an empty decode trace appear symmetrical
 258         if (visible_rows_ == 0)
 259                 return make_pair(-default_row_height_, default_row_height_);
 260
 261         unsigned int height = 0;
 262         for (const DecodeTraceRow& r : rows_)
 263                 if (r.currently_visible)
 264                         height += r.height;
 265
 266         return make_pair(-default_row_height_, height);
 267 }
 268
 269 void DecodeTrace::paint_back(QPainter &p, ViewItemPaintParams &pp)
 270 {
 271         Trace::paint_back(p, pp);
 272         paint_axis(p, pp, get_visual_y());
 273 }
 274
 275 void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 276 {
 277         lock_guard<mutex> lock(row_modification_mutex_);
 278         unsigned int visible_rows;
 279
 280 #if DECODETRACE_SHOW_RENDER_TIME
 281         render_time_.restart();
 282 #endif
 283
 284         // Set default pen to allow for text width calculation
 285         p.setPen(Qt::black);
 286
 287         pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pp.left(), pp.right());
 288
 289         // Just because the view says we see a certain sample range it
 290         // doesn't mean we have this many decoded samples, too, so crop
 291         // the range to what has been decoded already
 292         sample_range.second = min((int64_t)sample_range.second,
 293                 decode_signal_->get_decoded_sample_count(current_segment_, false));
 294
 295         visible_rows = 0;
 296         int y = get_visual_y();
 297
 298         for (DecodeTraceRow& r : rows_) {
 299                 // If the row is hidden, we don't want to fetch annotations
 300                 assert(r.decode_row);
 301                 assert(r.decode_row->decoder());
 302                 if ((!r.decode_row->decoder()->visible()) ||
 303                         ((!r.decode_row->visible() && (!show_hidden_rows_) && (!r.expanding) && (!r.expanded) && (!r.collapsing)))) {
 304                         r.currently_visible = false;
 305                         continue;
 306                 }
 307
 308                 deque<const Annotation*> annotations;
 309                 decode_signal_->get_annotation_subset(annotations, r.decode_row,
 310                         current_segment_, sample_range.first, sample_range.second);
 311
 312                 // Show row if there are visible annotations, when user wants to see
 313                 // all rows that have annotations somewhere and this one is one of them
 314                 // or when the row has at least one hidden annotation class
 315                 r.currently_visible = !annotations.empty();
 316                 if (!r.currently_visible) {
 317                         size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
 318                         r.currently_visible = ((always_show_all_rows_ || r.has_hidden_classes) &&
 319                                 (ann_count > 0)) || r.expanded;
 320                 }
 321
 322                 if (r.currently_visible) {
 323                         draw_annotations(annotations, p, pp, y, r);
 324                         y += r.height;
 325                         visible_rows++;
 326                 }
 327         }
 328
 329         draw_unresolved_period(p, pp.left(), pp.right());
 330
 331         if (visible_rows != visible_rows_) {
 332                 visible_rows_ = visible_rows;
 333
 334                 // Call order is important, otherwise the lazy event handler won't work
 335                 owner_->extents_changed(false, true);
 336                 owner_->row_item_appearance_changed(false, true);
 337         }
 338
 339         const QString err = decode_signal_->error_message();
 340         if (!err.isEmpty())
 341                 draw_error(p, err, pp);
 342
 343 #if DECODETRACE_SHOW_RENDER_TIME
 344         qDebug() << "Rendering" << base_->name() << "took" << render_time_.elapsed() << "ms";
 345 #endif
 346 }
 347
 348 void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
 349 {
 350         unsigned int y = get_visual_y();
 351
 352         update_expanded_rows();
 353
 354         for (const DecodeTraceRow& r : rows_) {
 355                 if (!r.currently_visible)
 356                         continue;
 357
 358                 p.setPen(QPen(Qt::NoPen));
 359
 360                 if (r.expand_marker_highlighted)
 361                         p.setBrush(QApplication::palette().brush(QPalette::Highlight));
 362                 else if (!r.decode_row->visible())
 363                         p.setBrush(ExpandMarkerHiddenColor);
 364                 else if (r.has_hidden_classes)
 365                         p.setBrush(ExpandMarkerWarnColor);
 366                 else
 367                         p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 368
 369                 // Draw expansion marker
 370                 QPolygon marker(r.expand_marker_shape);
 371                 marker.translate(pp.left(), y);
 372                 p.drawPolygon(marker);
 373
 374                 p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 375
 376                 const QRect text_rect(pp.left() + ArrowSize * 2, y - r.height / 2,
 377                         pp.right() - pp.left(), r.height);
 378                 const QString h(r.decode_row->title());
 379                 const int f = Qt::AlignLeft | Qt::AlignVCenter |
 380                         Qt::TextDontClip;
 381
 382                 // Draw the outline
 383                 p.setPen(QApplication::palette().color(QPalette::Base));
 384                 for (int dx = -1; dx <= 1; dx++)
 385                         for (int dy = -1; dy <= 1; dy++)
 386                                 if (dx != 0 && dy != 0)
 387                                         p.drawText(text_rect.translated(dx, dy), f, h);
 388
 389                 // Draw the text
 390                 if (!r.decode_row->visible())
 391                         p.setPen(ExpandMarkerHiddenColor);
 392                 else
 393                         p.setPen(QApplication::palette().color(QPalette::WindowText));
 394
 395                 p.drawText(text_rect, f, h);
 396
 397                 y += r.height;
 398         }
 399
 400         if (show_hover_marker_)
 401                 paint_hover_marker(p);
 402 }
 403
 404 void DecodeTrace::update_stack_button()
 405 {
 406         const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
 407
 408         // Only show decoders in the menu that can be stacked onto the last one in the stack
 409         if (!stack.empty()) {
 410                 const srd_decoder* d = stack.back()->get_srd_decoder();
 411
 412                 if (d->outputs) {
 413                         pv::widgets::DecoderMenu *const decoder_menu =
 414                                 new pv::widgets::DecoderMenu(stack_button_, (const char*)(d->outputs->data));
 415                         connect(decoder_menu, SIGNAL(decoder_selected(srd_decoder*)),
 416                                 this, SLOT(on_stack_decoder(srd_decoder*)));
 417
 418                         decoder_menu->setStyleSheet("QMenu { menu-scrollable: 1; }");
 419
 420                         stack_button_->setMenu(decoder_menu);
 421                         stack_button_->show();
 422                         return;
 423                 }
 424         }
 425
 426         // No decoders available for stacking
 427         stack_button_->setMenu(nullptr);
 428         stack_button_->hide();
 429 }
 430
 431 void DecodeTrace::populate_popup_form(QWidget *parent, QFormLayout *form)
 432 {
 433         assert(form);
 434
 435         // Add the standard options
 436         Trace::populate_popup_form(parent, form);
 437
 438         // Add the decoder options
 439         bindings_.clear();
 440         channel_id_map_.clear();
 441         init_state_map_.clear();
 442         decoder_forms_.clear();
 443
 444         const vector< shared_ptr<Decoder> > &stack = decode_signal_->decoder_stack();
 445
 446         if (stack.empty()) {
 447                 QLabel *const l = new QLabel(
 448                         tr("<p><i>No decoders in the stack</i></p>"));
 449                 l->setAlignment(Qt::AlignCenter);
 450                 form->addRow(l);
 451         } else {
 452                 auto iter = stack.cbegin();
 453                 for (int i = 0; i < (int)stack.size(); i++, iter++) {
 454                         shared_ptr<Decoder> dec(*iter);
 455                         create_decoder_form(i, dec, parent, form);
 456                 }
 457
 458                 form->addRow(new QLabel(
 459                         tr("<i>* Required channels</i>"), parent));
 460         }
 461
 462         // Add stacking button
 463         stack_button_ = new QPushButton(tr("Stack Decoder"), parent);
 464         stack_button_->setToolTip(tr("Stack a higher-level decoder on top of this one"));
 465         update_stack_button();
 466
 467         QHBoxLayout *stack_button_box = new QHBoxLayout;
 468         stack_button_box->addWidget(stack_button_, 0, Qt::AlignRight);
 469         form->addRow(stack_button_box);
 470 }
 471
 472 QMenu* DecodeTrace::create_header_context_menu(QWidget *parent)
 473 {
 474         QMenu *const menu = Trace::create_header_context_menu(parent);
 475
 476         menu->addSeparator();
 477
 478         QAction *const del = new QAction(tr("Delete"), this);
 479         del->setShortcuts(QKeySequence::Delete);
 480         connect(del, SIGNAL(triggered()), this, SLOT(on_delete()));
 481         menu->addAction(del);
 482
 483         return menu;
 484 }
 485
 486 QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
 487 {
 488         // Get entries from default menu before adding our own
 489         QMenu *const menu = new QMenu(parent);
 490
 491         QMenu* default_menu = Trace::create_view_context_menu(parent, click_pos);
 492         if (default_menu) {
 493                 for (QAction *action : default_menu->actions()) {  // clazy:exclude=range-loop
 494                         menu->addAction(action);
 495                         if (action->parent() == default_menu)
 496                                 action->setParent(menu);
 497                 }
 498                 delete default_menu;
 499
 500                 // Add separator if needed
 501                 if (menu->actions().length() > 0)
 502                         menu->addSeparator();
 503         }
 504
 505         selected_row_ = nullptr;
 506         const DecodeTraceRow* r = get_row_at_point(click_pos);
 507         if (r)
 508                 selected_row_ = r->decode_row;
 509
 510         const View *const view = owner_->view();
 511         assert(view);
 512         QPoint pos = view->viewport()->mapFrom(parent, click_pos);
 513
 514         // Default sample range is "from here"
 515         const pair<uint64_t, uint64_t> sample_range = get_view_sample_range(pos.x(), pos.x() + 1);
 516         selected_sample_range_ = make_pair(sample_range.first, numeric_limits<uint64_t>::max());
 517
 518         if (decode_signal_->is_paused()) {
 519                 QAction *const resume =
 520                         new QAction(tr("Resume decoding"), this);
 521                 resume->setIcon(QIcon::fromTheme("media-playback-start",
 522                         QIcon(":/icons/media-playback-start.png")));
 523                 connect(resume, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
 524                 menu->addAction(resume);
 525         } else {
 526                 QAction *const pause =
 527                         new QAction(tr("Pause decoding"), this);
 528                 pause->setIcon(QIcon::fromTheme("media-playback-pause",
 529                         QIcon(":/icons/media-playback-pause.png")));
 530                 connect(pause, SIGNAL(triggered()), this, SLOT(on_pause_decode()));
 531                 menu->addAction(pause);
 532         }
 533
 534         QAction *const copy_annotation_to_clipboard =
 535                 new QAction(tr("Copy annotation text to clipboard"), this);
 536         copy_annotation_to_clipboard->setIcon(QIcon::fromTheme("edit-paste",
 537                 QIcon(":/icons/edit-paste.svg")));
 538         connect(copy_annotation_to_clipboard, SIGNAL(triggered()), this, SLOT(on_copy_annotation_to_clipboard()));
 539         menu->addAction(copy_annotation_to_clipboard);
 540
 541         menu->addSeparator();
 542
 543         QAction *const export_all_rows =
 544                 new QAction(tr("Export all annotations"), this);
 545         export_all_rows->setIcon(QIcon::fromTheme("document-save-as",
 546                 QIcon(":/icons/document-save-as.png")));
 547         connect(export_all_rows, SIGNAL(triggered()), this, SLOT(on_export_all_rows()));
 548         menu->addAction(export_all_rows);
 549
 550         QAction *const export_row =
 551                 new QAction(tr("Export all annotations for this row"), this);
 552         export_row->setIcon(QIcon::fromTheme("document-save-as",
 553                 QIcon(":/icons/document-save-as.png")));
 554         connect(export_row, SIGNAL(triggered()), this, SLOT(on_export_row()));
 555         menu->addAction(export_row);
 556
 557         menu->addSeparator();
 558
 559         QAction *const export_all_rows_from_here =
 560                 new QAction(tr("Export all annotations, starting here"), this);
 561         export_all_rows_from_here->setIcon(QIcon::fromTheme("document-save-as",
 562                 QIcon(":/icons/document-save-as.png")));
 563         connect(export_all_rows_from_here, SIGNAL(triggered()), this, SLOT(on_export_all_rows_from_here()));
 564         menu->addAction(export_all_rows_from_here);
 565
 566         QAction *const export_row_from_here =
 567                 new QAction(tr("Export annotations for this row, starting here"), this);
 568         export_row_from_here->setIcon(QIcon::fromTheme("document-save-as",
 569                 QIcon(":/icons/document-save-as.png")));
 570         connect(export_row_from_here, SIGNAL(triggered()), this, SLOT(on_export_row_from_here()));
 571         menu->addAction(export_row_from_here);
 572
 573         menu->addSeparator();
 574
 575         QAction *const export_all_rows_with_cursor =
 576                 new QAction(tr("Export all annotations within cursor range"), this);
 577         export_all_rows_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
 578                 QIcon(":/icons/document-save-as.png")));
 579         connect(export_all_rows_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_all_rows_with_cursor()));
 580         menu->addAction(export_all_rows_with_cursor);
 581
 582         QAction *const export_row_with_cursor =
 583                 new QAction(tr("Export annotations for this row within cursor range"), this);
 584         export_row_with_cursor->setIcon(QIcon::fromTheme("document-save-as",
 585                 QIcon(":/icons/document-save-as.png")));
 586         connect(export_row_with_cursor, SIGNAL(triggered()), this, SLOT(on_export_row_with_cursor()));
 587         menu->addAction(export_row_with_cursor);
 588
 589         if (!view->cursors()->enabled()) {
 590                 export_all_rows_with_cursor->setEnabled(false);
 591                 export_row_with_cursor->setEnabled(false);
 592         }
 593
 594         return menu;
 595 }
 596
 597 void DecodeTrace::delete_pressed()
 598 {
 599         on_delete();
 600 }
 601
 602 void DecodeTrace::hover_point_changed(const QPoint &hp)
 603 {
 604         Trace::hover_point_changed(hp);
 605
 606         assert(owner_);
 607
 608         DecodeTraceRow* hover_row = get_row_at_point(hp);
 609
 610         // Row expansion marker handling
 611         for (DecodeTraceRow& r : rows_)
 612                 r.expand_marker_highlighted = false;
 613
 614         if (hover_row) {
 615                 const pair<int, int> extents = v_extents();
 616                 const int trace_top = get_visual_y() + extents.first;
 617                 const int trace_btm = get_visual_y() + extents.second;
 618
 619                 if ((hp.x() > 0) && (hp.x() < (int)(ArrowSize + 3 + hover_row->title_width)) &&
 620                         (hp.y() > trace_top) && (hp.y() < trace_btm)) {
 621
 622                         hover_row->expand_marker_highlighted = true;
 623                         show_hidden_rows_ = true;
 624                         delayed_hidden_row_hider_.start();
 625                 }
 626         }
 627
 628         // Tooltip handling
 629         if (hp.x() > 0) {
 630                 QString ann = get_annotation_at_point(hp);
 631
 632                 if (!ann.isEmpty()) {
 633                         QFontMetrics m(QToolTip::font());
 634                         const QRect text_size = m.boundingRect(QRect(), 0, ann);
 635
 636                         // This is OS-specific and unfortunately we can't query it, so
 637                         // use an approximation to at least try to minimize the error.
 638                         const int padding = default_row_height_ + 8;
 639
 640                         // Make sure the tool tip doesn't overlap with the mouse cursor.
 641                         // If it did, the tool tip would constantly hide and re-appear.
 642                         // We also push it up by one row so that it appears above the
 643                         // decode trace, not below.
 644                         QPoint p = hp;
 645                         p.setX(hp.x() - (text_size.width() / 2) - padding);
 646
 647                         p.setY(get_row_y(hover_row) - default_row_height_ -
 648                                 text_size.height() - padding);
 649
 650                         const View *const view = owner_->view();
 651                         assert(view);
 652                         QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
 653
 654                 } else
 655                         QToolTip::hideText();
 656
 657         } else
 658                 QToolTip::hideText();
 659 }
 660
 661 void DecodeTrace::mouse_left_press_event(const QMouseEvent* event)
 662 {
 663         // Update container widths which depend on the scrollarea's current width
 664         update_expanded_rows();
 665
 666         // Handle row expansion marker
 667         for (DecodeTraceRow& r : rows_) {
 668                 if (!r.expand_marker_highlighted)
 669                         continue;
 670
 671                 unsigned int y = get_row_y(&r);
 672                 if ((event->x() > 0) && (event->x() <= (int)(ArrowSize + 3 + r.title_width)) &&
 673                         (event->y() > (int)(y - (default_row_height_ / 2))) &&
 674                         (event->y() <= (int)(y + (default_row_height_ / 2)))) {
 675
 676                         if (r.expanded) {
 677                                 r.collapsing = true;
 678                                 r.expanded = false;
 679                                 r.anim_shape = ArrowSize;
 680                         } else {
 681                                 r.expanding = true;
 682                                 r.anim_shape = 0;
 683
 684                                 // Force geometry update of the widget container to get
 685                                 // an up-to-date height (which also depends on the width)
 686                                 forceUpdate(r.container);
 687
 688                                 r.container->setVisible(true);
 689                                 r.expanded_height = 2 * default_row_height_ + r.container->sizeHint().height();
 690                         }
 691
 692                         r.animation_step = 0;
 693                         r.anim_height = r.height;
 694
 695                         animation_timer_.start();
 696                 }
 697         }
 698 }
 699
 700 void DecodeTrace::draw_annotations(deque<const Annotation*>& annotations,
 701                 QPainter &p, const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row)
 702 {
 703         uint32_t block_class = 0;
 704         bool block_class_uniform = true;
 705         qreal block_start = 0;
 706         int block_ann_count = 0;
 707
 708         const Annotation* prev_ann;
 709         qreal prev_end = INT_MIN;
 710
 711         qreal a_end;
 712
 713         double samples_per_pixel, pixels_offset;
 714         tie(pixels_offset, samples_per_pixel) =
 715                 get_pixels_offset_samples_per_pixel();
 716
 717         // Gather all annotations that form a visual "block" and draw them as such
 718         for (const Annotation* a : annotations) {
 719
 720                 const qreal abs_a_start = a->start_sample() / samples_per_pixel;
 721                 const qreal abs_a_end   = a->end_sample() / samples_per_pixel;
 722
 723                 const qreal a_start = abs_a_start - pixels_offset;
 724                 a_end = abs_a_end - pixels_offset;
 725
 726                 const qreal a_width = a_end - a_start;
 727                 const qreal delta = a_end - prev_end;
 728
 729                 bool a_is_separate = false;
 730
 731                 // Annotation wider than the threshold for a useful label width?
 732                 if (a_width >= min_useful_label_width_) {
 733                         for (const QString &ann_text : *(a->annotations())) {
 734                                 const qreal w = p.boundingRect(QRectF(), 0, ann_text).width();
 735                                 // Annotation wide enough to fit a label? Don't put it in a block then
 736                                 if (w <= a_width) {
 737                                         a_is_separate = true;
 738                                         break;
 739                                 }
 740                         }
 741                 }
 742
 743                 // Were the previous and this annotation more than a pixel apart?
 744                 if ((abs(delta) > 1) || a_is_separate) {
 745                         // Block was broken, draw annotations that form the current block
 746                         if (block_ann_count == 1)
 747                                 draw_annotation(prev_ann, p, pp, y, row);
 748                         else if (block_ann_count > 0)
 749                                 draw_annotation_block(block_start, prev_end, block_class,
 750                                         block_class_uniform, p, y, row);
 751
 752                         block_ann_count = 0;
 753                 }
 754
 755                 if (a_is_separate) {
 756                         draw_annotation(a, p, pp, y, row);
 757                         // Next annotation must start a new block. delta will be > 1
 758                         // because we set prev_end to INT_MIN but that's okay since
 759                         // block_ann_count will be 0 and nothing will be drawn
 760                         prev_end = INT_MIN;
 761                         block_ann_count = 0;
 762                 } else {
 763                         prev_end = a_end;
 764                         prev_ann = a;
 765
 766                         if (block_ann_count == 0) {
 767                                 block_start = a_start;
 768                                 block_class = a->ann_class_id();
 769                                 block_class_uniform = true;
 770                         } else
 771                                 if (a->ann_class_id() != block_class)
 772                                         block_class_uniform = false;
 773
 774                         block_ann_count++;
 775                 }
 776         }
 777
 778         if (block_ann_count == 1)
 779                 draw_annotation(prev_ann, p, pp, y, row);
 780         else if (block_ann_count > 0)
 781                 draw_annotation_block(block_start, prev_end, block_class,
 782                         block_class_uniform, p, y, row);
 783 }
 784
 785 void DecodeTrace::draw_annotation(const Annotation* a, QPainter &p,
 786         const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row) const
 787 {
 788         double samples_per_pixel, pixels_offset;
 789         tie(pixels_offset, samples_per_pixel) =
 790                 get_pixels_offset_samples_per_pixel();
 791
 792         const double start = a->start_sample() / samples_per_pixel - pixels_offset;
 793         const double end = a->end_sample() / samples_per_pixel - pixels_offset;
 794
 795         p.setPen(a->dark_color());
 796         p.setBrush(a->color());
 797
 798         if ((start > (pp.right() + DrawPadding)) || (end < (pp.left() - DrawPadding)))
 799                 return;
 800
 801         if (a->start_sample() == a->end_sample())
 802                 draw_instant(a, p, start, y);
 803         else
 804                 draw_range(a, p, start, end, y, pp, row.title_width);
 805 }
 806
 807 void DecodeTrace::draw_annotation_block(qreal start, qreal end,
 808         uint32_t ann_class, bool use_ann_format, QPainter &p, int y,
 809         const DecodeTraceRow& row) const
 810 {
 811         const double top = y + .5 - annotation_height_ / 2;
 812         const double bottom = y + .5 + annotation_height_ / 2;
 813         const double width = end - start;
 814
 815         // If all annotations in this block are of the same type, we can use the
 816         // one format that all of these annotations have. Otherwise, we should use
 817         // a neutral color (i.e. gray)
 818         if (use_ann_format) {
 819                 p.setPen(row.decode_row->get_dark_class_color(ann_class));
 820                 p.setBrush(QBrush(row.decode_row->get_class_color(ann_class), Qt::Dense4Pattern));
 821         } else {
 822                 p.setPen(QColor(Qt::darkGray));
 823                 p.setBrush(QBrush(Qt::gray, Qt::Dense4Pattern));
 824         }
 825
 826         if (width <= 1)
 827                 p.drawLine(QPointF(start, top), QPointF(start, bottom));
 828         else {
 829                 const QRectF rect(start, top, width, bottom - top);
 830                 const int r = annotation_height_ / 4;
 831                 p.drawRoundedRect(rect, r, r);
 832         }
 833 }
 834
 835 void DecodeTrace::draw_instant(const Annotation* a, QPainter &p, qreal x, int y) const
 836 {
 837         const QString text = a->annotations()->empty() ?
 838                 QString() : a->annotations()->back();
 839         const qreal w = min((qreal)p.boundingRect(QRectF(), 0, text).width(),
 840                 0.0) + annotation_height_;
 841         const QRectF rect(x - w / 2, y - annotation_height_ / 2, w, annotation_height_);
 842
 843         p.drawRoundedRect(rect, annotation_height_ / 2, annotation_height_ / 2);
 844
 845         p.setPen(Qt::black);
 846         p.drawText(rect, Qt::AlignCenter | Qt::AlignVCenter, text);
 847 }
 848
 849 void DecodeTrace::draw_range(const Annotation* a, QPainter &p,
 850         qreal start, qreal end, int y, const ViewItemPaintParams &pp,
 851         int row_title_width) const
 852 {
 853         const qreal top = y + .5 - annotation_height_ / 2;
 854         const qreal bottom = y + .5 + annotation_height_ / 2;
 855         const vector<QString>* annotations = a->annotations();
 856
 857         // If the two ends are within 1 pixel, draw a vertical line
 858         if (start + 1.0 > end) {
 859                 p.drawLine(QPointF(start, top), QPointF(start, bottom));
 860                 return;
 861         }
 862
 863         const qreal cap_width = min((end - start) / 4, EndCapWidth);
 864
 865         QPointF pts[] = {
 866                 QPointF(start, y + .5f),
 867                 QPointF(start + cap_width, top),
 868                 QPointF(end - cap_width, top),
 869                 QPointF(end, y + .5f),
 870                 QPointF(end - cap_width, bottom),
 871                 QPointF(start + cap_width, bottom)
 872         };
 873
 874         p.drawConvexPolygon(pts, countof(pts));
 875
 876         if (annotations->empty())
 877                 return;
 878
 879         const int ann_start = start + cap_width;
 880         const int ann_end = end - cap_width;
 881
 882         const int real_start = max(ann_start, pp.left() + ArrowSize + row_title_width);
 883         const int real_end = min(ann_end, pp.right());
 884         const int real_width = real_end - real_start;
 885
 886         QRectF rect(real_start, y - annotation_height_ / 2, real_width, annotation_height_);
 887         if (rect.width() <= 4)
 888                 return;
 889
 890         p.setPen(Qt::black);
 891
 892         // Try to find an annotation that will fit
 893         QString best_annotation;
 894         int best_width = 0;
 895
 896         for (const QString &s : *annotations) {
 897                 const int w = p.boundingRect(QRectF(), 0, s).width();
 898                 if (w <= rect.width() && w > best_width)
 899                         best_annotation = s, best_width = w;
 900         }
 901
 902         if (best_annotation.isEmpty())
 903                 best_annotation = annotations->back();
 904
 905         // If not ellide the last in the list
 906         p.drawText(rect, Qt::AlignCenter, p.fontMetrics().elidedText(
 907                 best_annotation, Qt::ElideRight, rect.width()));
 908 }
 909
 910 void DecodeTrace::draw_error(QPainter &p, const QString &message,
 911         const ViewItemPaintParams &pp)
 912 {
 913         const int y = get_visual_y();
 914
 915         double samples_per_pixel, pixels_offset;
 916         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
 917
 918         p.setPen(ErrorBgColor.darker());
 919         p.setBrush(ErrorBgColor);
 920
 921         const QRectF bounding_rect = QRectF(pp.left(), INT_MIN / 2 + y, pp.right(), INT_MAX);
 922
 923         const QRectF text_rect = p.boundingRect(bounding_rect, Qt::AlignCenter, message);
 924         const qreal r = text_rect.height() / 4;
 925
 926         p.drawRoundedRect(text_rect.adjusted(-r, -r, r, r), r, r, Qt::AbsoluteSize);
 927
 928         p.setPen(Qt::black);
 929         p.drawText(text_rect, message);
 930 }
 931
 932 void DecodeTrace::draw_unresolved_period(QPainter &p, int left, int right) const
 933 {
 934         double samples_per_pixel, pixels_offset;
 935
 936         const int64_t sample_count = decode_signal_->get_working_sample_count(current_segment_);
 937         if (sample_count == 0)
 938                 return;
 939
 940         const int64_t samples_decoded = decode_signal_->get_decoded_sample_count(current_segment_, true);
 941         if (sample_count == samples_decoded)
 942                 return;
 943
 944         const int y = get_visual_y();
 945
 946         tie(pixels_offset, samples_per_pixel) = get_pixels_offset_samples_per_pixel();
 947
 948         const double start = max(samples_decoded /
 949                 samples_per_pixel - pixels_offset, left - 1.0);
 950         const double end = min(sample_count / samples_per_pixel -
 951                 pixels_offset, right + 1.0);
 952         const QRectF no_decode_rect(start, y - (annotation_height_ / 2) - 0.5,
 953                 end - start, annotation_height_);
 954
 955         p.setPen(QPen(Qt::NoPen));
 956         p.setBrush(Qt::white);
 957         p.drawRect(no_decode_rect);
 958
 959         p.setPen(NoDecodeColor);
 960         p.setBrush(QBrush(NoDecodeColor, Qt::Dense6Pattern));
 961         p.drawRect(no_decode_rect);
 962 }
 963
 964 pair<double, double> DecodeTrace::get_pixels_offset_samples_per_pixel() const
 965 {
 966         assert(owner_);
 967
 968         const View *view = owner_->view();
 969         assert(view);
 970
 971         const double scale = view->scale();
 972         assert(scale > 0);
 973
 974         const double pixels_offset =
 975                 ((view->offset() - decode_signal_->start_time()) / scale).convert_to<double>();
 976
 977         double samplerate = decode_signal_->get_samplerate();
 978
 979         // Show sample rate as 1Hz when it is unknown
 980         if (samplerate == 0.0)
 981                 samplerate = 1.0;
 982
 983         return make_pair(pixels_offset, samplerate * scale);
 984 }
 985
 986 pair<uint64_t, uint64_t> DecodeTrace::get_view_sample_range(
 987         int x_start, int x_end) const
 988 {
 989         double samples_per_pixel, pixels_offset;
 990         tie(pixels_offset, samples_per_pixel) =
 991                 get_pixels_offset_samples_per_pixel();
 992
 993         const uint64_t start = (uint64_t)max(
 994                 (x_start + pixels_offset) * samples_per_pixel, 0.0);
 995         const uint64_t end = (uint64_t)max(
 996                 (x_end + pixels_offset) * samples_per_pixel, 0.0);
 997
 998         return make_pair(start, end);
 999 }
1000
1001 unsigned int DecodeTrace::get_row_y(const DecodeTraceRow* row) const
1002 {
1003         assert(row);
1004
1005         unsigned int y = get_visual_y();
1006
1007         for (const DecodeTraceRow& r : rows_) {
1008                 if (!r.currently_visible)
1009                         continue;
1010
1011                 if (row->decode_row == r.decode_row)
1012                         break;
1013                 else
1014                         y += r.height;
1015         }
1016
1017         return y;
1018 }
1019
1020 DecodeTraceRow* DecodeTrace::get_row_at_point(const QPoint &point)
1021 {
1022         int y = get_visual_y() - (default_row_height_ / 2);
1023
1024         for (DecodeTraceRow& r : rows_) {
1025                 if (!r.currently_visible)
1026                         continue;
1027
1028                 if ((point.y() >= y) && (point.y() < (int)(y + r.height)))
1029                         return &r;
1030
1031                 y += r.height;
1032         }
1033
1034         return nullptr;
1035 }
1036
1037 const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
1038 {
1039         if (!enabled())
1040                 return QString();
1041
1042         const pair<uint64_t, uint64_t> sample_range =
1043                 get_view_sample_range(point.x(), point.x() + 1);
1044         const DecodeTraceRow* r = get_row_at_point(point);
1045
1046         if (!r)
1047                 return QString();
1048
1049         if (point.y() > (int)(get_row_y(r) + (annotation_height_ / 2)))
1050                 return QString();
1051
1052         deque<const Annotation*> annotations;
1053
1054         decode_signal_->get_annotation_subset(annotations, r->decode_row,
1055                 current_segment_, sample_range.first, sample_range.second);
1056
1057         return (annotations.empty()) ?
1058                 QString() : annotations[0]->annotations()->front();
1059 }
1060
1061 void DecodeTrace::create_decoder_form(int index, shared_ptr<Decoder> &dec,
1062         QWidget *parent, QFormLayout *form)
1063 {
1064         GlobalSettings settings;
1065
1066         assert(dec);
1067         const srd_decoder *const decoder = dec->get_srd_decoder();
1068         assert(decoder);
1069
1070         const bool decoder_deletable = index > 0;
1071
1072         pv::widgets::DecoderGroupBox *const group =
1073                 new pv::widgets::DecoderGroupBox(
1074                         QString::fromUtf8(decoder->name),
1075                         tr("%1:\n%2").arg(QString::fromUtf8(decoder->longname),
1076                                 QString::fromUtf8(decoder->desc)),
1077                         nullptr, decoder_deletable);
1078         group->set_decoder_visible(dec->visible());
1079
1080         if (decoder_deletable) {
1081                 delete_mapper_.setMapping(group, index);
1082                 connect(group, SIGNAL(delete_decoder()), &delete_mapper_, SLOT(map()));
1083         }
1084
1085         show_hide_mapper_.setMapping(group, index);
1086         connect(group, SIGNAL(show_hide_decoder()),
1087                 &show_hide_mapper_, SLOT(map()));
1088
1089         QFormLayout *const decoder_form = new QFormLayout;
1090         group->add_layout(decoder_form);
1091
1092         const vector<DecodeChannel> channels = decode_signal_->get_channels();
1093
1094         // Add the channels
1095         for (const DecodeChannel& ch : channels) {
1096                 // Ignore channels not part of the decoder we create the form for
1097                 if (ch.decoder_ != dec)
1098                         continue;
1099
1100                 QComboBox *const combo = create_channel_selector(parent, &ch);
1101                 QComboBox *const combo_init_state = create_channel_selector_init_state(parent, &ch);
1102
1103                 channel_id_map_[combo] = ch.id;
1104                 init_state_map_[combo_init_state] = ch.id;
1105
1106                 connect(combo, SIGNAL(currentIndexChanged(int)),
1107                         this, SLOT(on_channel_selected(int)));
1108                 connect(combo_init_state, SIGNAL(currentIndexChanged(int)),
1109                         this, SLOT(on_init_state_changed(int)));
1110
1111                 QHBoxLayout *const hlayout = new QHBoxLayout;
1112                 hlayout->addWidget(combo);
1113                 hlayout->addWidget(combo_init_state);
1114
1115                 if (!settings.value(GlobalSettings::Key_Dec_InitialStateConfigurable).toBool())
1116                         combo_init_state->hide();
1117
1118                 const QString required_flag = ch.is_optional ? QString() : QString("*");
1119                 decoder_form->addRow(tr("<b>%1</b> (%2) %3")
1120                         .arg(ch.name, ch.desc, required_flag), hlayout);
1121         }
1122
1123         // Add the options
1124         shared_ptr<binding::Decoder> binding(
1125                 new binding::Decoder(decode_signal_, dec));
1126         binding->add_properties_to_form(decoder_form, true);
1127
1128         bindings_.push_back(binding);
1129
1130         form->addRow(group);
1131         decoder_forms_.push_back(group);
1132 }
1133
1134 QComboBox* DecodeTrace::create_channel_selector(QWidget *parent, const DecodeChannel *ch)
1135 {
1136         const auto sigs(session_.signalbases());
1137
1138         // Sort signals in natural order
1139         vector< shared_ptr<data::SignalBase> > sig_list(sigs.begin(), sigs.end());
1140         sort(sig_list.begin(), sig_list.end(),
1141                 [](const shared_ptr<data::SignalBase> &a,
1142                 const shared_ptr<data::SignalBase> &b) {
1143                         return strnatcasecmp(a->name().toStdString(),
1144                                 b->name().toStdString()) < 0; });
1145
1146         QComboBox *selector = new QComboBox(parent);
1147
1148         selector->addItem("-", QVariant::fromValue((void*)nullptr));
1149
1150         if (!ch->assigned_signal)
1151                 selector->setCurrentIndex(0);
1152
1153         for (const shared_ptr<data::SignalBase> &b : sig_list) {
1154                 assert(b);
1155                 if (b->logic_data() && b->enabled()) {
1156                         selector->addItem(b->name(),
1157                                 QVariant::fromValue((void*)b.get()));
1158
1159                         if (ch->assigned_signal == b.get())
1160                                 selector->setCurrentIndex(selector->count() - 1);
1161                 }
1162         }
1163
1164         return selector;
1165 }
1166
1167 QComboBox* DecodeTrace::create_channel_selector_init_state(QWidget *parent,
1168         const DecodeChannel *ch)
1169 {
1170         QComboBox *selector = new QComboBox(parent);
1171
1172         selector->addItem("0", QVariant::fromValue((int)SRD_INITIAL_PIN_LOW));
1173         selector->addItem("1", QVariant::fromValue((int)SRD_INITIAL_PIN_HIGH));
1174         selector->addItem("X", QVariant::fromValue((int)SRD_INITIAL_PIN_SAME_AS_SAMPLE0));
1175
1176         selector->setCurrentIndex(ch->initial_pin_state);
1177
1178         selector->setToolTip("Initial (assumed) pin value before the first sample");
1179
1180         return selector;
1181 }
1182
1183 void DecodeTrace::export_annotations(deque<const Annotation*>& annotations) const
1184 {
1185         GlobalSettings settings;
1186         const QString dir = settings.value("MainWindow/SaveDirectory").toString();
1187
1188         const QString file_name = QFileDialog::getSaveFileName(
1189                 owner_->view(), tr("Export annotations"), dir, tr("Text Files (*.txt);;All Files (*)"));
1190
1191         if (file_name.isEmpty())
1192                 return;
1193
1194         QString format = settings.value(GlobalSettings::Key_Dec_ExportFormat).toString();
1195         const QString quote = format.contains("%q") ? "\"" : "";
1196         format = format.remove("%q");
1197
1198         const bool has_sample_range   = format.contains("%s");
1199         const bool has_row_name       = format.contains("%r");
1200         const bool has_dec_name       = format.contains("%d");
1201         const bool has_class_name     = format.contains("%c");
1202         const bool has_first_ann_text = format.contains("%1");
1203         const bool has_all_ann_text   = format.contains("%a");
1204
1205         QFile file(file_name);
1206         if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
1207                 QTextStream out_stream(&file);
1208
1209                 for (const Annotation* ann : annotations) {
1210                         QString out_text = format;
1211
1212                         if (has_sample_range) {
1213                                 const QString sample_range = QString("%1-%2") \
1214                                         .arg(QString::number(ann->start_sample()), QString::number(ann->end_sample()));
1215                                 out_text = out_text.replace("%s", sample_range);
1216                         }
1217
1218                         if (has_dec_name)
1219                                 out_text = out_text.replace("%d",
1220                                         quote + QString::fromUtf8(ann->row()->decoder()->name()) + quote);
1221
1222                         if (has_row_name) {
1223                                 const QString row_name = quote + ann->row()->description() + quote;
1224                                 out_text = out_text.replace("%r", row_name);
1225                         }
1226
1227                         if (has_class_name) {
1228                                 const QString class_name = quote + ann->ann_class_name() + quote;
1229                                 out_text = out_text.replace("%c", class_name);
1230                         }
1231
1232                         if (has_first_ann_text) {
1233                                 const QString first_ann_text = quote + ann->annotations()->front() + quote;
1234                                 out_text = out_text.replace("%1", first_ann_text);
1235                         }
1236
1237                         if (has_all_ann_text) {
1238                                 QString all_ann_text;
1239                                 for (const QString &s : *(ann->annotations()))
1240                                         all_ann_text = all_ann_text + quote + s + quote + ",";
1241                                 all_ann_text.chop(1);
1242
1243                                 out_text = out_text.replace("%a", all_ann_text);
1244                         }
1245
1246                         out_stream << out_text << '\n';
1247                 }
1248
1249                 if (out_stream.status() == QTextStream::Ok)
1250                         return;
1251         }
1252
1253         QMessageBox msg(owner_->view());
1254         msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
1255         msg.setStandardButtons(QMessageBox::Ok);
1256         msg.setIcon(QMessageBox::Warning);
1257         msg.exec();
1258 }
1259
1260 void DecodeTrace::initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id)
1261 {
1262         // Set colors and fixed widths
1263         QFontMetrics m(QApplication::font());
1264
1265         QPalette header_palette = owner_->view()->palette();
1266         QPalette selector_palette = owner_->view()->palette();
1267
1268         if (GlobalSettings::current_theme_is_dark()) {
1269                 header_palette.setColor(QPalette::Background,
1270                         QColor(255, 255, 255, ExpansionAreaHeaderAlpha));
1271                 selector_palette.setColor(QPalette::Background,
1272                         QColor(255, 255, 255, ExpansionAreaAlpha));
1273         } else {
1274                 header_palette.setColor(QPalette::Background,
1275                         QColor(0, 0, 0, ExpansionAreaHeaderAlpha));
1276                 selector_palette.setColor(QPalette::Background,
1277                         QColor(0, 0, 0, ExpansionAreaAlpha));
1278         }
1279
1280         const int w = m.boundingRect(r->decode_row->title()).width() + RowTitleMargin;
1281         r->title_width = w;
1282
1283         // Set up top-level container
1284         connect(r->container, SIGNAL(widgetResized(QWidget*)),
1285                 this, SLOT(on_row_container_resized(QWidget*)));
1286
1287         QVBoxLayout* vlayout = new QVBoxLayout();
1288         r->container->setLayout(vlayout);
1289
1290         // Add header container
1291         vlayout->addWidget(r->header_container);
1292         vlayout->setContentsMargins(0, 0, 0, 0);
1293         vlayout->setSpacing(0);
1294         QHBoxLayout* header_container_layout = new QHBoxLayout();
1295         r->header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
1296         r->header_container->setMinimumSize(0, default_row_height_);
1297         r->header_container->setLayout(header_container_layout);
1298         r->header_container->layout()->setContentsMargins(10, 2, 10, 2);
1299
1300         r->header_container->setAutoFillBackground(true);
1301         r->header_container->setPalette(header_palette);
1302
1303         // Add widgets inside the header container
1304         QCheckBox* cb = new QCheckBox();
1305         r->row_visibility_checkbox = cb;
1306         header_container_layout->addWidget(cb);
1307         cb->setText(tr("Show this row"));
1308         cb->setChecked(r->decode_row->visible());
1309
1310         row_show_hide_mapper_.setMapping(cb, row_id);
1311         connect(cb, SIGNAL(stateChanged(int)),
1312                 &row_show_hide_mapper_, SLOT(map()));
1313
1314         QPushButton* btn = new QPushButton();
1315         header_container_layout->addWidget(btn);
1316         btn->setFlat(true);
1317         btn->setStyleSheet(":hover { background-color: palette(button); color: palette(button-text); border:0; }");
1318         btn->setText(tr("Show All"));
1319         btn->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
1320         connect(btn, SIGNAL(clicked(bool)), this, SLOT(on_show_all_classes()));
1321
1322         btn = new QPushButton();
1323         header_container_layout->addWidget(btn);
1324         btn->setFlat(true);
1325         btn->setStyleSheet(":hover { background-color: palette(button); color: palette(button-text); border:0; }");
1326         btn->setText(tr("Hide All"));
1327         btn->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
1328         connect(btn, SIGNAL(clicked(bool)), this, SLOT(on_hide_all_classes()));
1329
1330         header_container_layout->addStretch(); // To left-align the header widgets
1331
1332         // Add selector container
1333         vlayout->addWidget(r->selector_container);
1334         r->selector_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
1335         r->selector_container->setLayout(new FlowLayout(r->selector_container));
1336
1337         r->selector_container->setAutoFillBackground(true);
1338         r->selector_container->setPalette(selector_palette);
1339
1340         // Add all classes that can be toggled
1341         vector<AnnotationClass*> ann_classes = r->decode_row->ann_classes();
1342
1343         for (const AnnotationClass* ann_class : ann_classes) {
1344                 cb = new QCheckBox();
1345                 cb->setText(tr(ann_class->description));
1346                 cb->setChecked(ann_class->visible());
1347
1348                 int dim = ViewItemPaintParams::text_height() - 2;
1349                 QPixmap pixmap(dim, dim);
1350                 pixmap.fill(r->decode_row->get_class_color(ann_class->id));
1351                 cb->setIcon(pixmap);
1352
1353                 r->selector_container->layout()->addWidget(cb);
1354                 r->selectors.push_back(cb);
1355
1356                 cb->setProperty("ann_class_ptr", QVariant::fromValue((void*)ann_class));
1357                 cb->setProperty("decode_trace_row_ptr", QVariant::fromValue((void*)r));
1358
1359                 class_show_hide_mapper_.setMapping(cb, cb);
1360                 connect(cb, SIGNAL(stateChanged(int)),
1361                         &class_show_hide_mapper_, SLOT(map()));
1362         }
1363 }
1364
1365 void DecodeTrace::update_rows()
1366 {
1367         if (!owner_)
1368                 return;
1369
1370         lock_guard<mutex> lock(row_modification_mutex_);
1371
1372         for (DecodeTraceRow& r : rows_)
1373                 r.exists = false;
1374
1375         unsigned int row_id = 0;
1376         for (Row* decode_row : decode_signal_->get_rows()) {
1377                 // Find row in our list
1378                 auto r_it = find_if(rows_.begin(), rows_.end(),
1379                         [&](DecodeTraceRow& r){ return r.decode_row == decode_row; });
1380
1381                 DecodeTraceRow* r = nullptr;
1382                 if (r_it == rows_.end()) {
1383                         // Row doesn't exist yet, create and append it
1384                         DecodeTraceRow nr;
1385                         nr.decode_row = decode_row;
1386                         nr.decode_row->set_base_color(base_->color());
1387                         nr.height = default_row_height_;
1388                         nr.expanded_height = default_row_height_;
1389                         nr.currently_visible = false;
1390                         nr.has_hidden_classes = decode_row->has_hidden_classes();
1391                         nr.expand_marker_highlighted = false;
1392                         nr.expanding = false;
1393                         nr.expanded = false;
1394                         nr.collapsing = false;
1395                         nr.expand_marker_shape = default_marker_shape_;
1396                         nr.container = new ContainerWidget(owner_->view()->scrollarea());
1397                         nr.header_container = new QWidget(nr.container);
1398                         nr.selector_container = new QWidget(nr.container);
1399
1400                         rows_.push_back(nr);
1401                         r = &rows_.back();
1402                         initialize_row_widgets(r, row_id);
1403                 } else
1404                         r = &(*r_it);
1405
1406                 r->exists = true;
1407                 row_id++;
1408         }
1409
1410         // If there's only one row, it must not be hidden or else it can't be un-hidden
1411         if (row_id == 1)
1412                 rows_.front().row_visibility_checkbox->setEnabled(false);
1413
1414         // Remove any rows that no longer exist, obeying that iterators are invalidated
1415         bool any_exists;
1416         do {
1417                 any_exists = false;
1418
1419                 for (unsigned int i = 0; i < rows_.size(); i++)
1420                         if (!rows_[i].exists) {
1421                                 delete rows_[i].row_visibility_checkbox;
1422
1423                                 for (QCheckBox* cb : rows_[i].selectors)
1424                                         delete cb;
1425
1426                                 delete rows_[i].selector_container;
1427                                 delete rows_[i].header_container;
1428                                 delete rows_[i].container;
1429
1430                                 rows_.erase(rows_.begin() + i);
1431                                 any_exists = true;
1432                                 break;
1433                         }
1434         } while (any_exists);
1435 }
1436
1437 void DecodeTrace::set_row_expanded(DecodeTraceRow* r)
1438 {
1439         r->height = r->expanded_height;
1440         r->expanding = false;
1441         r->expanded = true;
1442
1443         // For details on this, see on_animation_timer()
1444         r->expand_marker_shape.setPoint(0, 0, 0);
1445         r->expand_marker_shape.setPoint(1, ArrowSize, ArrowSize);
1446         r->expand_marker_shape.setPoint(2, 2*ArrowSize, 0);
1447
1448         r->container->resize(owner_->view()->viewport()->width() - r->container->pos().x(),
1449                 r->height - 2 * default_row_height_);
1450 }
1451
1452 void DecodeTrace::set_row_collapsed(DecodeTraceRow* r)
1453 {
1454         r->height = default_row_height_;
1455         r->collapsing = false;
1456         r->expanded = false;
1457         r->expand_marker_shape = default_marker_shape_;
1458         r->container->setVisible(false);
1459
1460         r->container->resize(owner_->view()->viewport()->width() - r->container->pos().x(),
1461                 r->height - 2 * default_row_height_);
1462 }
1463
1464 void DecodeTrace::update_expanded_rows()
1465 {
1466         for (DecodeTraceRow& r : rows_) {
1467                 if (r.expanding || r.expanded)
1468                         r.expanded_height = 2 * default_row_height_ + r.container->sizeHint().height();
1469
1470                 if (r.expanded)
1471                         r.height = r.expanded_height;
1472
1473                 int x = 2 * ArrowSize;
1474                 int y = get_row_y(&r) + default_row_height_;
1475                 // Only update the position if it actually changes
1476                 if ((x != r.container->pos().x()) || (y != r.container->pos().y()))
1477                         r.container->move(x, y);
1478
1479                 int w = owner_->view()->viewport()->width() - x;
1480                 int h = r.height - 2 * default_row_height_;
1481                 // Only update the dimension if they actually change
1482                 if ((w != r.container->sizeHint().width()) || (h != r.container->sizeHint().height()))
1483                         r.container->resize(w, h);
1484         }
1485 }
1486
1487 void DecodeTrace::on_setting_changed(const QString &key, const QVariant &value)
1488 {
1489         Trace::on_setting_changed(key, value);
1490
1491         if (key == GlobalSettings::Key_Dec_AlwaysShowAllRows)
1492                 always_show_all_rows_ = value.toBool();
1493 }
1494
1495 void DecodeTrace::on_color_changed(const QColor &color)
1496 {
1497         for (DecodeTraceRow& r : rows_)
1498                 r.decode_row->set_base_color(color);
1499
1500         if (owner_)
1501                 owner_->row_item_appearance_changed(false, true);
1502 }
1503
1504 void DecodeTrace::on_new_annotations()
1505 {
1506         if (!delayed_trace_updater_.isActive())
1507                 delayed_trace_updater_.start();
1508 }
1509
1510 void DecodeTrace::on_delayed_trace_update()
1511 {
1512         if (owner_)
1513                 owner_->row_item_appearance_changed(false, true);
1514 }
1515
1516 void DecodeTrace::on_decode_reset()
1517 {
1518         update_rows();
1519
1520         if (owner_)
1521                 owner_->row_item_appearance_changed(false, true);
1522 }
1523
1524 void DecodeTrace::on_decode_finished()
1525 {
1526         if (owner_)
1527                 owner_->row_item_appearance_changed(false, true);
1528 }
1529
1530 void DecodeTrace::on_pause_decode()
1531 {
1532         if (decode_signal_->is_paused())
1533                 decode_signal_->resume_decode();
1534         else
1535                 decode_signal_->pause_decode();
1536 }
1537
1538 void DecodeTrace::on_delete()
1539 {
1540         session_.remove_decode_signal(decode_signal_);
1541 }
1542
1543 void DecodeTrace::on_channel_selected(int)
1544 {
1545         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1546
1547         // Determine signal that was selected
1548         const data::SignalBase *signal =
1549                 (data::SignalBase*)cb->itemData(cb->currentIndex()).value<void*>();
1550
1551         // Determine decode channel ID this combo box is the channel selector for
1552         const uint16_t id = channel_id_map_.at(cb);
1553
1554         decode_signal_->assign_signal(id, signal);
1555 }
1556
1557 void DecodeTrace::on_channels_updated()
1558 {
1559         if (owner_)
1560                 owner_->row_item_appearance_changed(false, true);
1561 }
1562
1563 void DecodeTrace::on_init_state_changed(int)
1564 {
1565         QComboBox *cb = qobject_cast<QComboBox*>(QObject::sender());
1566
1567         // Determine inital pin state that was selected
1568         int init_state = cb->itemData(cb->currentIndex()).value<int>();
1569
1570         // Determine decode channel ID this combo box is the channel selector for
1571         const uint16_t id = init_state_map_.at(cb);
1572
1573         decode_signal_->set_initial_pin_state(id, init_state);
1574 }
1575
1576 void DecodeTrace::on_stack_decoder(srd_decoder *decoder)
1577 {
1578         decode_signal_->stack_decoder(decoder);
1579         update_rows();
1580
1581         create_popup_form();
1582 }
1583
1584 void DecodeTrace::on_delete_decoder(int index)
1585 {
1586         decode_signal_->remove_decoder(index);
1587         update_rows();
1588
1589         owner_->extents_changed(false, true);
1590
1591         create_popup_form();
1592 }
1593
1594 void DecodeTrace::on_show_hide_decoder(int index)
1595 {
1596         const bool state = decode_signal_->toggle_decoder_visibility(index);
1597
1598         assert(index < (int)decoder_forms_.size());
1599         decoder_forms_[index]->set_decoder_visible(state);
1600
1601         if (!state)
1602                 owner_->extents_changed(false, true);
1603
1604         owner_->row_item_appearance_changed(false, true);
1605 }
1606
1607 void DecodeTrace::on_show_hide_row(int row_id)
1608 {
1609         if (row_id >= (int)rows_.size())
1610                 return;
1611
1612         rows_[row_id].decode_row->set_visible(!rows_[row_id].decode_row->visible());
1613
1614         if (!rows_[row_id].decode_row->visible())
1615                 set_row_collapsed(&rows_[row_id]);
1616
1617         owner_->extents_changed(false, true);
1618         owner_->row_item_appearance_changed(false, true);
1619 }
1620
1621 void DecodeTrace::on_show_hide_class(QWidget* sender)
1622 {
1623         void* ann_class_ptr = sender->property("ann_class_ptr").value<void*>();
1624         assert(ann_class_ptr);
1625         AnnotationClass* ann_class = (AnnotationClass*)ann_class_ptr;
1626
1627         ann_class->set_visible(!ann_class->visible());
1628
1629         void* row_ptr = sender->property("decode_trace_row_ptr").value<void*>();
1630         assert(row_ptr);
1631         DecodeTraceRow* row = (DecodeTraceRow*)row_ptr;
1632
1633         row->has_hidden_classes = row->decode_row->has_hidden_classes();
1634
1635         owner_->row_item_appearance_changed(false, true);
1636 }
1637
1638 void DecodeTrace::on_show_all_classes()
1639 {
1640         void* row_ptr = QObject::sender()->property("decode_trace_row_ptr").value<void*>();
1641         assert(row_ptr);
1642         DecodeTraceRow* row = (DecodeTraceRow*)row_ptr;
1643
1644         for (QCheckBox* cb : row->selectors)
1645                 cb->setChecked(true);
1646
1647         row->has_hidden_classes = false;
1648
1649         owner_->row_item_appearance_changed(false, true);
1650 }
1651
1652 void DecodeTrace::on_hide_all_classes()
1653 {
1654         void* row_ptr = QObject::sender()->property("decode_trace_row_ptr").value<void*>();
1655         assert(row_ptr);
1656         DecodeTraceRow* row = (DecodeTraceRow*)row_ptr;
1657
1658         for (QCheckBox* cb : row->selectors)
1659                 cb->setChecked(false);
1660
1661         row->has_hidden_classes = true;
1662
1663         owner_->row_item_appearance_changed(false, true);
1664 }
1665
1666 void DecodeTrace::on_row_container_resized(QWidget* sender)
1667 {
1668         sender->update();
1669
1670         owner_->extents_changed(false, true);
1671         owner_->row_item_appearance_changed(false, true);
1672 }
1673
1674 void DecodeTrace::on_copy_annotation_to_clipboard()
1675 {
1676         if (!selected_row_)
1677                 return;
1678
1679         deque<const Annotation*> annotations;
1680
1681         decode_signal_->get_annotation_subset(annotations, selected_row_,
1682                 current_segment_, selected_sample_range_.first, selected_sample_range_.first);
1683
1684         if (annotations.empty())
1685                 return;
1686
1687         QClipboard *clipboard = QApplication::clipboard();
1688         clipboard->setText(annotations.front()->annotations()->front(), QClipboard::Clipboard);
1689
1690         if (clipboard->supportsSelection())
1691                 clipboard->setText(annotations.front()->annotations()->front(), QClipboard::Selection);
1692 }
1693
1694 void DecodeTrace::on_export_row()
1695 {
1696         selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1697         on_export_row_from_here();
1698 }
1699
1700 void DecodeTrace::on_export_all_rows()
1701 {
1702         selected_sample_range_ = make_pair(0, numeric_limits<uint64_t>::max());
1703         on_export_all_rows_from_here();
1704 }
1705
1706 void DecodeTrace::on_export_row_with_cursor()
1707 {
1708         const View *view = owner_->view();
1709         assert(view);
1710
1711         if (!view->cursors()->enabled())
1712                 return;
1713
1714         const double samplerate = session_.get_samplerate();
1715
1716         const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1717         const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1718
1719         const uint64_t start_sample = (uint64_t)max(
1720                 0.0, start_time.convert_to<double>() * samplerate);
1721         const uint64_t end_sample = (uint64_t)max(
1722                 0.0, end_time.convert_to<double>() * samplerate);
1723
1724         // Are both cursors negative and thus were clamped to 0?
1725         if ((start_sample == 0) && (end_sample == 0))
1726                 return;
1727
1728         selected_sample_range_ = make_pair(start_sample, end_sample);
1729         on_export_row_from_here();
1730 }
1731
1732 void DecodeTrace::on_export_all_rows_with_cursor()
1733 {
1734         const View *view = owner_->view();
1735         assert(view);
1736
1737         if (!view->cursors()->enabled())
1738                 return;
1739
1740         const double samplerate = session_.get_samplerate();
1741
1742         const pv::util::Timestamp& start_time = view->cursors()->first()->time();
1743         const pv::util::Timestamp& end_time = view->cursors()->second()->time();
1744
1745         const uint64_t start_sample = (uint64_t)max(
1746                 0.0, start_time.convert_to<double>() * samplerate);
1747         const uint64_t end_sample = (uint64_t)max(
1748                 0.0, end_time.convert_to<double>() * samplerate);
1749
1750         // Are both cursors negative and thus were clamped to 0?
1751         if ((start_sample == 0) && (end_sample == 0))
1752                 return;
1753
1754         selected_sample_range_ = make_pair(start_sample, end_sample);
1755         on_export_all_rows_from_here();
1756 }
1757
1758 void DecodeTrace::on_export_row_from_here()
1759 {
1760         if (!selected_row_)
1761                 return;
1762
1763         deque<const Annotation*> annotations;
1764
1765         decode_signal_->get_annotation_subset(annotations, selected_row_,
1766                 current_segment_, selected_sample_range_.first, selected_sample_range_.second);
1767
1768         if (annotations.empty())
1769                 return;
1770
1771         export_annotations(annotations);
1772 }
1773
1774 void DecodeTrace::on_export_all_rows_from_here()
1775 {
1776         deque<const Annotation*> annotations;
1777
1778         decode_signal_->get_annotation_subset(annotations, current_segment_,
1779                         selected_sample_range_.first, selected_sample_range_.second);
1780
1781         if (!annotations.empty())
1782                 export_annotations(annotations);
1783 }
1784
1785 void DecodeTrace::on_animation_timer()
1786 {
1787         bool animation_finished = true;
1788
1789         for (DecodeTraceRow& r : rows_) {
1790                 if (!(r.expanding || r.collapsing))
1791                         continue;
1792
1793                 unsigned int height_delta = r.expanded_height - default_row_height_;
1794
1795                 if (r.expanding) {
1796                         if (r.height < r.expanded_height) {
1797                                 r.anim_height += height_delta / (float)AnimationDurationInTicks;
1798                                 r.height = min((int)r.anim_height, (int)r.expanded_height);
1799                                 r.anim_shape += ArrowSize / (float)AnimationDurationInTicks;
1800                                 animation_finished = false;
1801                         } else
1802                                 set_row_expanded(&r);
1803                 }
1804
1805                 if (r.collapsing) {
1806                         if (r.height > default_row_height_) {
1807                                 r.anim_height -= height_delta / (float)AnimationDurationInTicks;
1808                                 r.height = max((int)r.anim_height, (int)0);
1809                                 r.anim_shape -= ArrowSize / (float)AnimationDurationInTicks;
1810                                 animation_finished = false;
1811                         } else
1812                                 set_row_collapsed(&r);
1813                 }
1814
1815                 // The expansion marker shape switches between
1816                 // 0/-A, A/0,  0/A (default state; anim_shape=0) and
1817                 // 0/ 0, A/A, 2A/0 (expanded state; anim_shape=ArrowSize)
1818
1819                 r.expand_marker_shape.setPoint(0, 0, -ArrowSize + r.anim_shape);
1820                 r.expand_marker_shape.setPoint(1, ArrowSize, r.anim_shape);
1821                 r.expand_marker_shape.setPoint(2, 2*r.anim_shape, ArrowSize - r.anim_shape);
1822         }
1823
1824         if (animation_finished)
1825                 animation_timer_.stop();
1826
1827         owner_->extents_changed(false, true);
1828         owner_->row_item_appearance_changed(false, true);
1829 }
1830
1831 void DecodeTrace::on_hide_hidden_rows()
1832 {
1833         // Make all hidden traces invisible again unless the user is hovering over a row name
1834         bool any_highlighted = false;
1835
1836         for (DecodeTraceRow& r : rows_)
1837                 if (r.expand_marker_highlighted)
1838                         any_highlighted = true;
1839
1840         if (!any_highlighted) {
1841                 show_hidden_rows_ = false;
1842
1843                 owner_->extents_changed(false, true);
1844                 owner_->row_item_appearance_changed(false, true);
1845         }
1846 }
1847
1848 } // namespace trace
1849 } // namespace views
1850 } // namespace pv