pv/views/trace/view.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 #ifdef ENABLE_DECODE
  21 #include <libsigrokdecode/libsigrokdecode.h>
  22 #endif
  23
  24 #include <extdef.h>
  25
  26 #include <algorithm>
  27 #include <cassert>
  28 #include <climits>
  29 #include <cmath>
  30 #include <iostream>
  31 #include <iterator>
  32 #include <unordered_set>
  33
  34 #include <QApplication>
  35 #include <QDebug>
  36 #include <QEvent>
  37 #include <QFontMetrics>
  38 #include <QMenu>
  39 #include <QMouseEvent>
  40 #include <QScrollBar>
  41 #include <QVBoxLayout>
  42
  43 #include <libsigrokcxx/libsigrokcxx.hpp>
  44
  45 #include "analogsignal.hpp"
  46 #include "header.hpp"
  47 #include "logicsignal.hpp"
  48 #include "ruler.hpp"
  49 #include "signal.hpp"
  50 #include "tracegroup.hpp"
  51 #include "triggermarker.hpp"
  52 #include "view.hpp"
  53 #include "viewport.hpp"
  54
  55 #include "pv/data/logic.hpp"
  56 #include "pv/data/logicsegment.hpp"
  57 #include "pv/devices/device.hpp"
  58 #include "pv/globalsettings.hpp"
  59 #include "pv/session.hpp"
  60 #include "pv/util.hpp"
  61
  62 #ifdef ENABLE_DECODE
  63 #include "decodetrace.hpp"
  64 #endif
  65
  66 using pv::data::SignalData;
  67 using pv::data::Segment;
  68 using pv::util::TimeUnit;
  69 using pv::util::Timestamp;
  70
  71 using std::back_inserter;
  72 using std::copy_if;
  73 using std::count_if;
  74 using std::inserter;
  75 using std::max;
  76 using std::make_pair;
  77 using std::make_shared;
  78 using std::min;
  79 using std::numeric_limits;
  80 using std::pair;
  81 using std::set;
  82 using std::set_difference;
  83 using std::shared_ptr;
  84 using std::unordered_map;
  85 using std::unordered_set;
  86 using std::vector;
  87
  88 namespace pv {
  89 namespace views {
  90 namespace trace {
  91
  92 const Timestamp View::MaxScale("1e9");
  93 const Timestamp View::MinScale("1e-12");
  94
  95 const int View::MaxScrollValue = INT_MAX / 2;
  96
  97 /* Area at the top and bottom of the view that can't be scrolled out of sight */
  98 const int View::ViewScrollMargin = 50;
  99
 100 const int View::ScaleUnits[3] = {1, 2, 5};
 101
 102 CustomScrollArea::CustomScrollArea(QWidget *parent) :
 103         QAbstractScrollArea(parent)
 104 {
 105 }
 106
 107 bool CustomScrollArea::viewportEvent(QEvent *event)
 108 {
 109         switch (event->type()) {
 110         case QEvent::Paint:
 111         case QEvent::MouseButtonPress:
 112         case QEvent::MouseButtonRelease:
 113         case QEvent::MouseButtonDblClick:
 114         case QEvent::MouseMove:
 115         case QEvent::Wheel:
 116         case QEvent::TouchBegin:
 117         case QEvent::TouchUpdate:
 118         case QEvent::TouchEnd:
 119                 return false;
 120         default:
 121                 return QAbstractScrollArea::viewportEvent(event);
 122         }
 123 }
 124
 125 View::View(Session &session, bool is_main_view, QMainWindow *parent) :
 126         ViewBase(session, is_main_view, parent),
 127
 128         // Note: Place defaults in View::reset_view_state(), not here
 129         splitter_(new QSplitter()),
 130         header_was_shrunk_(false),  // The splitter remains unchanged after a reset, so this goes here
 131         sticky_scrolling_(false),  // Default setting is set in MainWindow::setup_ui()
 132         scroll_needs_defaults_(true)
 133 {
 134         QVBoxLayout *root_layout = new QVBoxLayout(this);
 135         root_layout->setContentsMargins(0, 0, 0, 0);
 136         root_layout->addWidget(splitter_);
 137
 138         viewport_ = new Viewport(*this);
 139         scrollarea_ = new CustomScrollArea(splitter_);
 140         scrollarea_->setViewport(viewport_);
 141         scrollarea_->setFrameShape(QFrame::NoFrame);
 142
 143         ruler_ = new Ruler(*this);
 144
 145         header_ = new Header(*this);
 146         header_->setMinimumWidth(10);  // So that the arrow tips show at least
 147
 148         // We put the header into a simple layout so that we can add the top margin,
 149         // allowing us to make it line up with the bottom of the ruler
 150         QWidget *header_container = new QWidget();
 151         header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 152         QVBoxLayout *header_layout = new QVBoxLayout(header_container);
 153         header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
 154         header_layout->addWidget(header_);
 155
 156         // To let the ruler and scrollarea be on the same split pane, we need a layout
 157         QWidget *trace_container = new QWidget();
 158         trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 159         QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
 160         trace_layout->setSpacing(0);  // We don't want space between the ruler and scrollarea
 161         trace_layout->setContentsMargins(0, 0, 0, 0);
 162         trace_layout->addWidget(ruler_);
 163         trace_layout->addWidget(scrollarea_);
 164
 165         splitter_->addWidget(header_container);
 166         splitter_->addWidget(trace_container);
 167         splitter_->setHandleWidth(1);  // Don't show a visible rubber band
 168         splitter_->setCollapsible(0, false);  // Prevent the header from collapsing
 169         splitter_->setCollapsible(1, false);  // Prevent the traces from collapsing
 170         splitter_->setStretchFactor(0, 0);  // Prevent the panes from being resized
 171         splitter_->setStretchFactor(1, 1);  // when the entire view is resized
 172         splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 173
 174         viewport_->installEventFilter(this);
 175         ruler_->installEventFilter(this);
 176         header_->installEventFilter(this);
 177
 178         // Set up settings and event handlers
 179         GlobalSettings settings;
 180         colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
 181         snap_distance_ = settings.value(GlobalSettings::Key_View_SnapDistance).toInt();
 182
 183         GlobalSettings::add_change_handler(this);
 184
 185         connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
 186                 this, SLOT(h_scroll_value_changed(int)));
 187         connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
 188                 this, SLOT(v_scroll_value_changed()));
 189
 190         connect(header_, SIGNAL(selection_changed()),
 191                 ruler_, SLOT(clear_selection()));
 192         connect(ruler_, SIGNAL(selection_changed()),
 193                 header_, SLOT(clear_selection()));
 194
 195         connect(header_, SIGNAL(selection_changed()),
 196                 this, SIGNAL(selection_changed()));
 197         connect(ruler_, SIGNAL(selection_changed()),
 198                 this, SIGNAL(selection_changed()));
 199
 200         connect(splitter_, SIGNAL(splitterMoved(int, int)),
 201                 this, SLOT(on_splitter_moved()));
 202
 203         connect(&lazy_event_handler_, SIGNAL(timeout()),
 204                 this, SLOT(process_sticky_events()));
 205         lazy_event_handler_.setSingleShot(true);
 206         lazy_event_handler_.setInterval(1000 / ViewBase::MaxViewAutoUpdateRate);
 207
 208         // Set up local keyboard shortcuts
 209         zoom_in_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Plus), this,
 210                 SLOT(on_zoom_in_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 211         zoom_in_shortcut_->setAutoRepeat(false);
 212
 213         zoom_out_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Minus), this,
 214                 SLOT(on_zoom_out_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 215         zoom_out_shortcut_->setAutoRepeat(false);
 216
 217         zoom_in_shortcut_2_ = new QShortcut(QKeySequence(Qt::Key_Up), this,
 218                 SLOT(on_zoom_in_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 219         zoom_out_shortcut_2_ = new QShortcut(QKeySequence(Qt::Key_Down), this,
 220                 SLOT(on_zoom_out_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 221
 222         home_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Home), this,
 223                 SLOT(on_scroll_to_start_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 224         home_shortcut_->setAutoRepeat(false);
 225
 226         end_shortcut_ = new QShortcut(QKeySequence(Qt::Key_End), this,
 227                 SLOT(on_scroll_to_end_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
 228         end_shortcut_->setAutoRepeat(false);
 229
 230         grab_ruler_left_shortcut_ = new QShortcut(QKeySequence(Qt::Key_1), this,
 231                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
 232         connect(grab_ruler_left_shortcut_, &QShortcut::activated,
 233                 this, [=]{on_grab_ruler(1);});
 234         grab_ruler_left_shortcut_->setAutoRepeat(false);
 235
 236         grab_ruler_right_shortcut_ = new QShortcut(QKeySequence(Qt::Key_2), this,
 237                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
 238         connect(grab_ruler_right_shortcut_, &QShortcut::activated,
 239                 this, [=]{on_grab_ruler(2);});
 240         grab_ruler_right_shortcut_->setAutoRepeat(false);
 241
 242         cancel_grab_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Escape), this,
 243                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
 244         connect(cancel_grab_shortcut_, &QShortcut::activated,
 245                 this, [=]{grabbed_widget_ = nullptr;});
 246         cancel_grab_shortcut_->setAutoRepeat(false);
 247
 248         // Trigger the initial event manually. The default device has signals
 249         // which were created before this object came into being
 250         signals_changed();
 251
 252         // Make sure the transparent widgets are on the top
 253         ruler_->raise();
 254         header_->raise();
 255
 256         reset_view_state();
 257 }
 258
 259 View::~View()
 260 {
 261         GlobalSettings::remove_change_handler(this);
 262 }
 263
 264 ViewType View::get_type() const
 265 {
 266         return ViewTypeTrace;
 267 }
 268
 269 void View::reset_view_state()
 270 {
 271         ViewBase::reset_view_state();
 272
 273         segment_display_mode_ = Trace::ShowLastSegmentOnly;
 274         segment_selectable_ = false;
 275         scale_ = 1e-3;
 276         offset_ = 0;
 277         ruler_offset_ = 0;
 278         zero_offset_ = 0;
 279         custom_zero_offset_set_ = false;
 280         updating_scroll_ = false;
 281         settings_restored_ = false;
 282         always_zoom_to_fit_ = false;
 283         tick_period_ = 0;
 284         tick_prefix_ = pv::util::SIPrefix::yocto;
 285         tick_precision_ = 0;
 286         time_unit_ = util::TimeUnit::Time;
 287         show_cursors_ = false;
 288         cursors_ = make_shared<CursorPair>(*this);
 289         next_flag_text_ = 'A';
 290         trigger_markers_.clear();
 291         hover_widget_ = nullptr;
 292         grabbed_widget_ = nullptr;
 293         hover_point_ = QPoint(-1, -1);
 294         scroll_needs_defaults_ = true;
 295         saved_v_offset_ = 0;
 296         scale_at_acq_start_ = 0;
 297         offset_at_acq_start_ = 0;
 298         suppress_zoom_to_fit_after_acq_ = false;
 299
 300         show_cursors_ = false;
 301         cursor_state_changed(show_cursors_);
 302         flags_.clear();
 303
 304         // Update the zoom state
 305         calculate_tick_spacing();
 306
 307         // Make sure the standard bar's segment selector is in sync
 308         set_segment_display_mode(segment_display_mode_);
 309 }
 310
 311 Session& View::session()
 312 {
 313         return session_;
 314 }
 315
 316 const Session& View::session() const
 317 {
 318         return session_;
 319 }
 320
 321 vector< shared_ptr<Signal> > View::signals() const
 322 {
 323         return signals_;
 324 }
 325
 326 shared_ptr<Signal> View::get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const
 327 {
 328         shared_ptr<Signal> ret_val;
 329
 330         for (const shared_ptr<Signal>& s : signals_)
 331                 if (s->base() == base) {
 332                         ret_val = s;
 333                         break;
 334                 }
 335
 336         return ret_val;
 337 }
 338
 339 void View::clear_signals()
 340 {
 341         ViewBase::clear_signals();
 342         signals_.clear();
 343 }
 344
 345 void View::add_signal(const shared_ptr<Signal> signal)
 346 {
 347         ViewBase::add_signalbase(signal->base());
 348         signals_.push_back(signal);
 349
 350         signal->set_segment_display_mode(segment_display_mode_);
 351         signal->set_current_segment(current_segment_);
 352
 353         connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
 354                 this, SLOT(on_signal_name_changed()));
 355 }
 356
 357 #ifdef ENABLE_DECODE
 358 void View::clear_decode_signals()
 359 {
 360         ViewBase::clear_decode_signals();
 361         decode_traces_.clear();
 362 }
 363
 364 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
 365 {
 366         ViewBase::add_decode_signal(signal);
 367
 368         shared_ptr<DecodeTrace> d(
 369                 new DecodeTrace(session_, signal, decode_traces_.size()));
 370         decode_traces_.push_back(d);
 371
 372         d->set_segment_display_mode(segment_display_mode_);
 373         d->set_current_segment(current_segment_);
 374
 375         connect(signal.get(), SIGNAL(name_changed(const QString&)),
 376                 this, SLOT(on_signal_name_changed()));
 377 }
 378
 379 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
 380 {
 381         for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
 382                 if ((*i)->base() == signal) {
 383                         decode_traces_.erase(i);
 384                         signals_changed();
 385                         return;
 386                 }
 387
 388         ViewBase::remove_decode_signal(signal);
 389 }
 390 #endif
 391
 392 shared_ptr<Signal> View::get_signal_under_mouse_cursor() const
 393 {
 394         return signal_under_mouse_cursor_;
 395 }
 396
 397 View* View::view()
 398 {
 399         return this;
 400 }
 401
 402 const View* View::view() const
 403 {
 404         return this;
 405 }
 406
 407 Viewport* View::viewport()
 408 {
 409         return viewport_;
 410 }
 411
 412 const Viewport* View::viewport() const
 413 {
 414         return viewport_;
 415 }
 416
 417 QAbstractScrollArea* View::scrollarea() const
 418 {
 419         return scrollarea_;
 420 }
 421
 422 const Ruler* View::ruler() const
 423 {
 424         return ruler_;
 425 }
 426
 427 void View::save_settings(QSettings &settings) const
 428 {
 429         settings.setValue("scale", scale_);
 430         settings.setValue("v_offset",
 431                 scrollarea_->verticalScrollBar()->sliderPosition());
 432
 433         settings.setValue("splitter_state", splitter_->saveState());
 434         settings.setValue("segment_display_mode", segment_display_mode_);
 435
 436         GlobalSettings::store_timestamp(settings, "offset", offset_);
 437
 438         if (custom_zero_offset_set_)
 439                 GlobalSettings::store_timestamp(settings, "zero_offset", -zero_offset_);
 440         else
 441                 settings.remove("zero_offset");
 442
 443         for (const shared_ptr<Signal>& signal : signals_) {
 444                 settings.beginGroup(signal->base()->internal_name());
 445                 signal->save_settings(settings);
 446                 settings.endGroup();
 447         }
 448 }
 449
 450 void View::restore_settings(QSettings &settings)
 451 {
 452         // Note: It is assumed that this function is only called once,
 453         // immediately after restoring a previous session.
 454
 455         if (settings.contains("scale"))
 456                 set_scale(settings.value("scale").toDouble());
 457
 458         if (settings.contains("offset")) {
 459                 // This also updates ruler_offset_
 460                 set_offset(GlobalSettings::restore_timestamp(settings, "offset"));
 461         }
 462
 463         if (settings.contains("zero_offset"))
 464                 set_zero_position(GlobalSettings::restore_timestamp(settings, "zero_offset"));
 465
 466         if (settings.contains("splitter_state"))
 467                 splitter_->restoreState(settings.value("splitter_state").toByteArray());
 468
 469         if (settings.contains("segment_display_mode"))
 470                 set_segment_display_mode(
 471                         (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
 472
 473         for (shared_ptr<Signal> signal : signals_) {
 474                 settings.beginGroup(signal->base()->internal_name());
 475                 signal->restore_settings(settings);
 476                 settings.endGroup();
 477         }
 478
 479         if (settings.contains("v_offset")) {
 480                 saved_v_offset_ = settings.value("v_offset").toInt();
 481                 set_v_offset(saved_v_offset_);
 482                 scroll_needs_defaults_ = false;
 483                 // Note: see eventFilter() for additional information
 484         }
 485
 486         settings_restored_ = true;
 487         suppress_zoom_to_fit_after_acq_ = true;
 488
 489         // Update the ruler so that it uses the new scale
 490         calculate_tick_spacing();
 491 }
 492
 493 vector< shared_ptr<TimeItem> > View::time_items() const
 494 {
 495         const vector<shared_ptr<Flag>> f(flags());
 496         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
 497
 498         if (cursors_) {
 499                 items.push_back(cursors_);
 500                 items.push_back(cursors_->first());
 501                 items.push_back(cursors_->second());
 502         }
 503
 504         for (auto& trigger_marker : trigger_markers_)
 505                 items.push_back(trigger_marker);
 506
 507         return items;
 508 }
 509
 510 double View::scale() const
 511 {
 512         return scale_;
 513 }
 514
 515 void View::set_scale(double scale)
 516 {
 517         if (scale_ != scale) {
 518                 scale_ = scale;
 519                 scale_changed();
 520         }
 521 }
 522
 523 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
 524 {
 525         if ((offset_ != offset) || force_update) {
 526                 offset_ = offset;
 527                 ruler_offset_ = offset_ + zero_offset_;
 528                 offset_changed();
 529         }
 530 }
 531
 532 const Timestamp& View::offset() const
 533 {
 534         return offset_;
 535 }
 536
 537 const Timestamp& View::ruler_offset() const
 538 {
 539         return ruler_offset_;
 540 }
 541
 542 void View::set_zero_position(const pv::util::Timestamp& position)
 543 {
 544         zero_offset_ = -position;
 545         custom_zero_offset_set_ = true;
 546
 547         // Force an immediate update of the offsets
 548         set_offset(offset_, true);
 549         ruler_->update();
 550 }
 551
 552 void View::reset_zero_position()
 553 {
 554         zero_offset_ = 0;
 555
 556         // When enabled, the first trigger for this segment is used as the zero position
 557         GlobalSettings settings;
 558         bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
 559
 560         if (trigger_is_zero_time) {
 561                 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
 562
 563                 if (triggers.size() > 0)
 564                         zero_offset_ = triggers.front();
 565         }
 566
 567         custom_zero_offset_set_ = false;
 568
 569         // Force an immediate update of the offsets
 570         set_offset(offset_, true);
 571         ruler_->update();
 572 }
 573
 574 pv::util::Timestamp View::zero_offset() const
 575 {
 576         return zero_offset_;
 577 }
 578
 579 int View::owner_visual_v_offset() const
 580 {
 581         return -scrollarea_->verticalScrollBar()->sliderPosition();
 582 }
 583
 584 void View::set_v_offset(int offset)
 585 {
 586         scrollarea_->verticalScrollBar()->setSliderPosition(offset);
 587         header_->update();
 588         viewport_->update();
 589 }
 590
 591 void View::set_h_offset(int offset)
 592 {
 593         scrollarea_->horizontalScrollBar()->setSliderPosition(offset);
 594         header_->update();
 595         viewport_->update();
 596 }
 597
 598 int View::get_h_scrollbar_maximum() const
 599 {
 600         return scrollarea_->horizontalScrollBar()->maximum();
 601 }
 602
 603 unsigned int View::depth() const
 604 {
 605         return 0;
 606 }
 607
 608 uint32_t View::current_segment() const
 609 {
 610         return current_segment_;
 611 }
 612
 613 pv::util::SIPrefix View::tick_prefix() const
 614 {
 615         return tick_prefix_;
 616 }
 617
 618 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
 619 {
 620         if (tick_prefix_ != tick_prefix) {
 621                 tick_prefix_ = tick_prefix;
 622                 tick_prefix_changed();
 623         }
 624 }
 625
 626 unsigned int View::tick_precision() const
 627 {
 628         return tick_precision_;
 629 }
 630
 631 void View::set_tick_precision(unsigned tick_precision)
 632 {
 633         if (tick_precision_ != tick_precision) {
 634                 tick_precision_ = tick_precision;
 635                 tick_precision_changed();
 636         }
 637 }
 638
 639 const pv::util::Timestamp& View::tick_period() const
 640 {
 641         return tick_period_;
 642 }
 643
 644 unsigned int View::minor_tick_count() const
 645 {
 646         return minor_tick_count_;
 647 }
 648
 649 void View::set_tick_period(const pv::util::Timestamp& tick_period)
 650 {
 651         if (tick_period_ != tick_period) {
 652                 tick_period_ = tick_period;
 653                 tick_period_changed();
 654         }
 655 }
 656
 657 TimeUnit View::time_unit() const
 658 {
 659         return time_unit_;
 660 }
 661
 662 void View::set_time_unit(pv::util::TimeUnit time_unit)
 663 {
 664         if (time_unit_ != time_unit) {
 665                 time_unit_ = time_unit;
 666                 time_unit_changed();
 667         }
 668 }
 669
 670 void View::set_current_segment(uint32_t segment_id)
 671 {
 672         current_segment_ = segment_id;
 673
 674         for (const shared_ptr<Signal>& signal : signals_)
 675                 signal->set_current_segment(current_segment_);
 676 #ifdef ENABLE_DECODE
 677         for (shared_ptr<DecodeTrace>& dt : decode_traces_)
 678                 dt->set_current_segment(current_segment_);
 679 #endif
 680
 681         vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
 682
 683         trigger_markers_.clear();
 684         for (util::Timestamp timestamp : triggers)
 685                 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
 686
 687         if (!custom_zero_offset_set_)
 688                 reset_zero_position();
 689
 690         viewport_->update();
 691
 692         segment_changed(segment_id);
 693 }
 694
 695 bool View::segment_is_selectable() const
 696 {
 697         return segment_selectable_;
 698 }
 699
 700 Trace::SegmentDisplayMode View::segment_display_mode() const
 701 {
 702         return segment_display_mode_;
 703 }
 704
 705 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
 706 {
 707         segment_display_mode_ = mode;
 708
 709         for (const shared_ptr<Signal>& signal : signals_)
 710                 signal->set_segment_display_mode(mode);
 711
 712         uint32_t last_segment = session_.get_segment_count() - 1;
 713
 714         switch (mode) {
 715         case Trace::ShowLastSegmentOnly:
 716                 if (current_segment_ != last_segment)
 717                         set_current_segment(last_segment);
 718                 break;
 719
 720         case Trace::ShowLastCompleteSegmentOnly:
 721                 // Do nothing if we only have one segment so far
 722                 if (last_segment > 0) {
 723                         // If the last segment isn't complete, the previous one must be
 724                         uint32_t segment_id =
 725                                 (session_.all_segments_complete(last_segment)) ?
 726                                 last_segment : last_segment - 1;
 727
 728                         if (current_segment_ != segment_id)
 729                                 set_current_segment(segment_id);
 730                 }
 731                 break;
 732
 733         case Trace::ShowSingleSegmentOnly:
 734         case Trace::ShowAllSegments:
 735         case Trace::ShowAccumulatedIntensity:
 736         default:
 737                 // Current segment remains as-is
 738                 break;
 739         }
 740
 741         segment_selectable_ = true;
 742
 743         if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
 744                 segment_selectable_ = false;
 745
 746         viewport_->update();
 747
 748         segment_display_mode_changed((int)mode, segment_selectable_);
 749 }
 750
 751 void View::zoom(double steps)
 752 {
 753         zoom(steps, viewport_->width() / 2);
 754 }
 755
 756 void View::zoom(double steps, int offset)
 757 {
 758         set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
 759 }
 760
 761 void View::zoom_fit(bool gui_state)
 762 {
 763         // Act as one-shot when stopped, toggle along with the GUI otherwise
 764         if (session_.get_capture_state() == Session::Stopped) {
 765                 always_zoom_to_fit_ = false;
 766                 always_zoom_to_fit_changed(false);
 767         } else {
 768                 always_zoom_to_fit_ = gui_state;
 769                 always_zoom_to_fit_changed(gui_state);
 770         }
 771
 772         const pair<Timestamp, Timestamp> extents = get_time_extents();
 773         const Timestamp delta = extents.second - extents.first;
 774         if (delta < Timestamp("1e-12"))
 775                 return;
 776
 777         assert(viewport_);
 778         const int w = viewport_->width();
 779         if (w <= 0)
 780                 return;
 781
 782         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
 783         set_scale_offset(scale.convert_to<double>(), extents.first);
 784 }
 785
 786 void View::focus_on_range(uint64_t start_sample, uint64_t end_sample)
 787 {
 788         assert(viewport_);
 789         const int w = viewport_->width();
 790         if (w <= 0)
 791                 return;
 792
 793         const double samplerate = session_.get_samplerate();
 794
 795         const uint64_t sample_delta = (end_sample - start_sample);
 796
 797         // Note: We add 20% margin on the left and 5% on the right
 798         const Timestamp delta = (sample_delta * 1.25) / samplerate;
 799
 800         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
 801         const Timestamp offset = (start_sample - sample_delta * 0.20) / samplerate;
 802
 803         set_scale_offset(scale.convert_to<double>(), offset);
 804 }
 805
 806 void View::set_scale_offset(double scale, const Timestamp& offset)
 807 {
 808         // Disable sticky scrolling / always zoom to fit when acquisition runs
 809         // and user drags the viewport
 810         if ((scale_ == scale) && (offset_ != offset) &&
 811                         (session_.get_capture_state() == Session::Running)) {
 812
 813                 if (sticky_scrolling_) {
 814                         sticky_scrolling_ = false;
 815                         sticky_scrolling_changed(false);
 816                 }
 817
 818                 if (always_zoom_to_fit_) {
 819                         always_zoom_to_fit_ = false;
 820                         always_zoom_to_fit_changed(false);
 821                 }
 822         }
 823
 824         set_scale(scale);
 825         set_offset(offset);
 826
 827         calculate_tick_spacing();
 828
 829         update_scroll();
 830         ruler_->update();
 831         viewport_->update();
 832 }
 833
 834 vector< shared_ptr<SignalData> > View::get_visible_data() const
 835 {
 836         // Make a set of all the visible data objects
 837         vector< shared_ptr<SignalData> > visible_data;
 838         for (const shared_ptr<Signal>& sig : signals_)
 839                 if (sig->enabled())
 840                         visible_data.push_back(sig->data());
 841
 842         return visible_data;
 843 }
 844
 845 pair<Timestamp, Timestamp> View::get_time_extents() const
 846 {
 847         boost::optional<Timestamp> left_time, right_time;
 848
 849         vector< shared_ptr<SignalData> > data;
 850         if (signals_.size() == 0)
 851                 return make_pair(0, 0);
 852
 853         data.push_back(signals_.front()->data());
 854
 855         for (const shared_ptr<SignalData>& d : data) {
 856                 const vector< shared_ptr<Segment> > segments = d->segments();
 857                 for (const shared_ptr<Segment>& s : segments) {
 858                         double samplerate = s->samplerate();
 859                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 860
 861                         const Timestamp start_time = s->start_time();
 862                         left_time = left_time ?
 863                                 min(*left_time, start_time) :
 864                                                 start_time;
 865                         right_time = right_time ?
 866                                 max(*right_time, start_time + d->max_sample_count() / samplerate) :
 867                                                  start_time + d->max_sample_count() / samplerate;
 868                 }
 869         }
 870
 871         if (!left_time || !right_time)
 872                 return make_pair(0, 0);
 873
 874         assert(*left_time < *right_time);
 875         return make_pair(*left_time, *right_time);
 876 }
 877
 878 bool View::colored_bg() const
 879 {
 880         return colored_bg_;
 881 }
 882
 883 bool View::cursors_shown() const
 884 {
 885         return show_cursors_;
 886 }
 887
 888 void View::show_cursors(bool show)
 889 {
 890         if (show_cursors_ != show) {
 891                 show_cursors_ = show;
 892
 893                 cursor_state_changed(show);
 894                 ruler_->update();
 895                 viewport_->update();
 896         }
 897 }
 898
 899 void View::set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second)
 900 {
 901         assert(cursors_);
 902
 903         cursors_->first()->set_time(first);
 904         cursors_->second()->set_time(second);
 905
 906         ruler_->update();
 907         viewport_->update();
 908 }
 909
 910 void View::center_cursors()
 911 {
 912         assert(cursors_);
 913
 914         const double time_width = scale_ * viewport_->width();
 915         cursors_->first()->set_time(offset_ + time_width * 0.4);
 916         cursors_->second()->set_time(offset_ + time_width * 0.6);
 917
 918         ruler_->update();
 919         viewport_->update();
 920 }
 921
 922 shared_ptr<CursorPair> View::cursors() const
 923 {
 924         return cursors_;
 925 }
 926
 927 shared_ptr<Flag> View::add_flag(const Timestamp& time)
 928 {
 929         shared_ptr<Flag> flag =
 930                 make_shared<Flag>(*this, time, QString("%1").arg(next_flag_text_));
 931         flags_.push_back(flag);
 932
 933         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
 934                 (next_flag_text_ + 1);
 935
 936         time_item_appearance_changed(true, true);
 937         return flag;
 938 }
 939
 940 void View::remove_flag(shared_ptr<Flag> flag)
 941 {
 942         flags_.remove(flag);
 943         time_item_appearance_changed(true, true);
 944 }
 945
 946 vector< shared_ptr<Flag> > View::flags() const
 947 {
 948         vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
 949         stable_sort(flags.begin(), flags.end(),
 950                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
 951                         return a->time() < b->time();
 952                 });
 953
 954         return flags;
 955 }
 956
 957 const QPoint& View::hover_point() const
 958 {
 959         return hover_point_;
 960 }
 961
 962 const QWidget* View::hover_widget() const
 963 {
 964         return hover_widget_;
 965 }
 966
 967 int64_t View::get_nearest_level_change(const QPoint &p)
 968 {
 969         // Is snapping disabled?
 970         if (snap_distance_ == 0)
 971                 return -1;
 972
 973         struct entry_t {
 974                 entry_t(shared_ptr<Signal> s) :
 975                         signal(s), delta(numeric_limits<int64_t>::max()), sample(-1), is_dense(false) {}
 976                 shared_ptr<Signal> signal;
 977                 int64_t delta;
 978                 int64_t sample;
 979                 bool is_dense;
 980         };
 981
 982         vector<entry_t> list;
 983
 984         // Create list of signals to consider
 985         if (signal_under_mouse_cursor_)
 986                 list.emplace_back(signal_under_mouse_cursor_);
 987         else
 988                 for (shared_ptr<Signal> s : signals_) {
 989                         if (!s->enabled())
 990                                 continue;
 991
 992                         list.emplace_back(s);
 993                 }
 994
 995         // Get data for listed signals
 996         for (entry_t &e : list) {
 997                 // Calculate sample number from cursor position
 998                 const double samples_per_pixel = e.signal->base()->get_samplerate() * scale();
 999                 const int64_t x_offset = offset().convert_to<double>() / scale();
1000                 const int64_t sample_num = max(((x_offset + p.x()) * samples_per_pixel), 0.0);
1001
1002                 vector<data::LogicSegment::EdgePair> edges =
1003                         e.signal->get_nearest_level_changes(sample_num);
1004
1005                 if (edges.empty())
1006                         continue;
1007
1008                 // Check first edge
1009                 const int64_t first_sample_delta = abs(sample_num - edges.front().first);
1010                 const int64_t first_delta = first_sample_delta / samples_per_pixel;
1011                 e.delta = first_delta;
1012                 e.sample = edges.front().first;
1013
1014                 // Check second edge if available
1015                 if (edges.size() == 2) {
1016                         // Note: -1 because this is usually the right edge and sample points are left-aligned
1017                         const int64_t second_sample_delta = abs(sample_num - edges.back().first - 1);
1018                         const int64_t second_delta = second_sample_delta / samples_per_pixel;
1019
1020                         // If both edges are too close, we mark this signal as being dense
1021                         if ((first_delta + second_delta) <= snap_distance_)
1022                                 e.is_dense = true;
1023
1024                         if (second_delta < first_delta) {
1025                                 e.delta = second_delta;
1026                                 e.sample = edges.back().first;
1027                         }
1028                 }
1029         }
1030
1031         // Look for the best match: non-dense first, then dense
1032         entry_t *match = nullptr;
1033
1034         for (entry_t &e : list) {
1035                 if (e.delta > snap_distance_ || e.is_dense)
1036                         continue;
1037
1038                 if (match) {
1039                         if (e.delta < match->delta)
1040                                 match = &e;
1041                 } else
1042                         match = &e;
1043         }
1044
1045         if (!match) {
1046                 for (entry_t &e : list) {
1047                         if (!e.is_dense)
1048                                 continue;
1049
1050                         if (match) {
1051                                 if (e.delta < match->delta)
1052                                         match = &e;
1053                         } else
1054                                 match = &e;
1055                 }
1056         }
1057
1058         if (match) {
1059                 // Somewhat ugly hack to make TimeItem::drag_by() work
1060                 signal_under_mouse_cursor_ = match->signal;
1061
1062                 return match->sample;
1063         }
1064
1065         return -1;
1066 }
1067
1068 void View::restack_all_trace_tree_items()
1069 {
1070         // Make a list of owners that is sorted from deepest first
1071         const vector<shared_ptr<TraceTreeItem>> items(
1072                 list_by_type<TraceTreeItem>());
1073         set< TraceTreeItemOwner* > owners;
1074         for (const auto &r : items)
1075                 owners.insert(r->owner());
1076         vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
1077         sort(sorted_owners.begin(), sorted_owners.end(),
1078                 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
1079                         return a->depth() > b->depth(); });
1080
1081         // Restack the items recursively
1082         for (auto &o : sorted_owners)
1083                 o->restack_items();
1084
1085         // Animate the items to their destination
1086         for (const auto &i : items)
1087                 i->animate_to_layout_v_offset();
1088 }
1089
1090 int View::header_width() const
1091 {
1092          return header_->extended_size_hint().width();
1093 }
1094
1095 void View::on_setting_changed(const QString &key, const QVariant &value)
1096 {
1097         GlobalSettings settings;
1098
1099         if (key == GlobalSettings::Key_View_ColoredBG) {
1100                 colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
1101                 viewport_->update();
1102         }
1103
1104         if ((key == GlobalSettings::Key_View_ShowSamplingPoints) ||
1105            (key == GlobalSettings::Key_View_ShowAnalogMinorGrid))
1106                 viewport_->update();
1107
1108         if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
1109                 on_settingViewTriggerIsZeroTime_changed(value);
1110
1111         if (key == GlobalSettings::Key_View_SnapDistance)
1112                 snap_distance_ = settings.value(GlobalSettings::Key_View_SnapDistance).toInt();
1113 }
1114
1115 void View::trigger_event(int segment_id, util::Timestamp location)
1116 {
1117         // TODO This doesn't work if we're showing multiple segments at once
1118         if ((uint32_t)segment_id != current_segment_)
1119                 return;
1120
1121         if (!custom_zero_offset_set_)
1122                 reset_zero_position();
1123
1124         trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
1125 }
1126
1127 void View::get_scroll_layout(double &length, Timestamp &offset) const
1128 {
1129         const pair<Timestamp, Timestamp> extents = get_time_extents();
1130         length = ((extents.second - extents.first) / scale_).convert_to<double>();
1131         offset = offset_ / scale_;
1132 }
1133
1134 void View::set_zoom(double scale, int offset)
1135 {
1136         // Reset the "always zoom to fit" feature as the user changed the zoom
1137         always_zoom_to_fit_ = false;
1138         always_zoom_to_fit_changed(false);
1139
1140         const Timestamp cursor_offset = offset_ + scale_ * offset;
1141         const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
1142         const Timestamp new_offset = cursor_offset - new_scale * offset;
1143         set_scale_offset(new_scale.convert_to<double>(), new_offset);
1144 }
1145
1146 void View::calculate_tick_spacing()
1147 {
1148         const double SpacingIncrement = 10.0f;
1149         const double MinValueSpacing = 40.0f;
1150
1151         // Figure out the highest numeric value visible on a label
1152         const QSize areaSize = viewport_->size();
1153         const Timestamp max_time = max(fabs(offset_),
1154                 fabs(offset_ + scale_ * areaSize.width()));
1155
1156         double min_width = SpacingIncrement;
1157         double label_width, tick_period_width;
1158
1159         QFontMetrics m(QApplication::font());
1160
1161         // Copies of the member variables with the same name, used in the calculation
1162         // and written back afterwards, so that we don't emit signals all the time
1163         // during the calculation.
1164         pv::util::Timestamp tick_period = tick_period_;
1165         pv::util::SIPrefix tick_prefix = tick_prefix_;
1166         unsigned tick_precision = tick_precision_;
1167
1168         do {
1169                 const double min_period = scale_ * min_width;
1170
1171                 const int order = (int)floorf(log10f(min_period));
1172                 const pv::util::Timestamp order_decimal =
1173                         pow(pv::util::Timestamp(10), order);
1174
1175                 // Allow for a margin of error so that a scale unit of 1 can be used.
1176                 // Otherwise, for a SU of 1 the tick period will almost always be below
1177                 // the min_period by a small amount - and thus skipped in favor of 2.
1178                 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
1179                 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
1180                 double tp_with_margin;
1181                 unsigned int unit = 0;
1182
1183                 do {
1184                         tp_with_margin = order_decimal.convert_to<double>() *
1185                                 (ScaleUnits[unit++] + tp_margin);
1186                 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
1187
1188                 minor_tick_count_ = (unit == 2) ? 4 : 5;
1189                 tick_period = order_decimal * ScaleUnits[unit - 1];
1190                 tick_prefix = static_cast<pv::util::SIPrefix>(
1191                         (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
1192
1193                 // Precision is the number of fractional digits required, not
1194                 // taking the prefix into account (and it must never be negative)
1195                 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
1196
1197                 tick_period_width = (tick_period / scale_).convert_to<double>();
1198
1199                 const QString label_text = Ruler::format_time_with_distance(
1200                         tick_period, max_time, tick_prefix, time_unit_, tick_precision);
1201
1202                 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
1203                         Qt::AlignLeft | Qt::AlignTop, label_text).width() +
1204                                 MinValueSpacing;
1205
1206                 min_width += SpacingIncrement;
1207         } while (tick_period_width < label_width);
1208
1209         set_tick_period(tick_period);
1210         set_tick_prefix(tick_prefix);
1211         set_tick_precision(tick_precision);
1212 }
1213
1214 void View::adjust_top_margin()
1215 {
1216         assert(viewport_);
1217
1218         const QSize areaSize = viewport_->size();
1219
1220         const pair<int, int> extents = v_extents();
1221         const int top_margin = owner_visual_v_offset() + extents.first;
1222         const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1223
1224         // Do we have empty space at the top while the last trace goes out of screen?
1225         if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1226                 const int trace_height = extents.second - extents.first;
1227
1228                 // Center everything vertically if there is enough space
1229                 if (areaSize.height() >= trace_height)
1230                         set_v_offset(extents.first -
1231                                 ((areaSize.height() - trace_height) / 2));
1232                 else
1233                         // Remove the top margin to make as many traces fit on screen as possible
1234                         set_v_offset(extents.first);
1235         }
1236 }
1237
1238 void View::update_scroll()
1239 {
1240         assert(viewport_);
1241         QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1242         QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1243
1244         const QSize areaSize = viewport_->size();
1245
1246         // Set the horizontal scroll bar
1247         double length = 0;
1248         Timestamp offset;
1249         get_scroll_layout(length, offset);
1250         length = max(length - areaSize.width(), 0.0);
1251
1252         int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1253
1254         hscrollbar->setPageStep(areaSize.width() / 2);
1255         hscrollbar->setSingleStep(major_tick_distance);
1256
1257         updating_scroll_ = true;
1258
1259         if (length < MaxScrollValue) {
1260                 hscrollbar->setRange(0, length);
1261                 hscrollbar->setSliderPosition(offset.convert_to<double>());
1262         } else {
1263                 hscrollbar->setRange(0, MaxScrollValue);
1264                 hscrollbar->setSliderPosition(
1265                         (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1266         }
1267
1268         updating_scroll_ = false;
1269
1270         // Set the vertical scrollbar
1271         vscrollbar->setPageStep(areaSize.height());
1272         vscrollbar->setSingleStep(areaSize.height() / 8);
1273
1274         const pair<int, int> extents = v_extents();
1275
1276         // Don't change the scrollbar range if there are no traces
1277         if (extents.first != extents.second) {
1278                 int top_margin = ViewScrollMargin;
1279                 int btm_margin = ViewScrollMargin;
1280
1281                 vscrollbar->setRange(extents.first - areaSize.height() + top_margin,
1282                         extents.second - btm_margin);
1283         }
1284
1285         if (scroll_needs_defaults_) {
1286                 set_scroll_default();
1287                 scroll_needs_defaults_ = false;
1288         }
1289 }
1290
1291 void View::reset_scroll()
1292 {
1293         scrollarea_->verticalScrollBar()->setRange(0, 0);
1294 }
1295
1296 void View::set_scroll_default()
1297 {
1298         assert(viewport_);
1299
1300         const QSize areaSize = viewport_->size();
1301
1302         const pair<int, int> extents = v_extents();
1303         const int trace_height = extents.second - extents.first;
1304
1305         // Do all traces fit in the view?
1306         if (areaSize.height() >= trace_height)
1307                 // Center all traces vertically
1308                 set_v_offset(extents.first -
1309                         ((areaSize.height() - trace_height) / 2));
1310         else
1311                 // Put the first trace at the top, letting the bottom ones overflow
1312                 set_v_offset(extents.first);
1313 }
1314
1315 void View::determine_if_header_was_shrunk()
1316 {
1317         const int header_pane_width =
1318                 splitter_->sizes().front();  // clazy:exclude=detaching-temporary
1319
1320         // Allow for a slight margin of error so that we also accept
1321         // slight differences when e.g. a label name change increased
1322         // the overall width
1323         header_was_shrunk_ = (header_pane_width < (header_width() - 10));
1324 }
1325
1326 void View::resize_header_to_fit()
1327 {
1328         // Setting the maximum width of the header widget doesn't work as
1329         // expected because the splitter would allow the user to make the
1330         // pane wider than that, creating empty space as a result.
1331         // To make this work, we stricly enforce the maximum width by
1332         // expanding the header unless the user shrunk it on purpose.
1333         // As we're then setting the width of the header pane, we set the
1334         // splitter to the maximum allowed position.
1335
1336         int splitter_area_width = 0;
1337         for (int w : splitter_->sizes())  // clazy:exclude=range-loop
1338                 splitter_area_width += w;
1339
1340         // Make sure the header has enough horizontal space to show all labels fully
1341         QList<int> pane_sizes;
1342         pane_sizes.push_back(header_->extended_size_hint().width());
1343         pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1344         splitter_->setSizes(pane_sizes);
1345 }
1346
1347 void View::update_layout()
1348 {
1349         update_scroll();
1350 }
1351
1352 TraceTreeItemOwner* View::find_prevalent_trace_group(
1353         const shared_ptr<sigrok::ChannelGroup> &group,
1354         const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1355                 &signal_map)
1356 {
1357         assert(group);
1358
1359         unordered_set<TraceTreeItemOwner*> owners;
1360         vector<TraceTreeItemOwner*> owner_list;
1361
1362         // Make a set and a list of all the owners
1363         for (const auto& channel : group->channels()) {
1364                 for (auto& entry : signal_map) {
1365                         if (entry.first->channel() == channel) {
1366                                 TraceTreeItemOwner *const o = (entry.second)->owner();
1367                                 owner_list.push_back(o);
1368                                 owners.insert(o);
1369                         }
1370                 }
1371         }
1372
1373         // Iterate through the list of owners, and find the most prevalent
1374         size_t max_prevalence = 0;
1375         TraceTreeItemOwner *prevalent_owner = nullptr;
1376         for (TraceTreeItemOwner *owner : owners) {
1377                 const size_t prevalence = count_if(
1378                         owner_list.begin(), owner_list.end(),
1379                         [&](TraceTreeItemOwner *o) { return o == owner; });
1380                 if (prevalence > max_prevalence) {
1381                         max_prevalence = prevalence;
1382                         prevalent_owner = owner;
1383                 }
1384         }
1385
1386         return prevalent_owner;
1387 }
1388
1389 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1390         const vector< shared_ptr<sigrok::Channel> > &channels,
1391         const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1392                 &signal_map,
1393         set< shared_ptr<Trace> > &add_list)
1394 {
1395         vector< shared_ptr<Trace> > filtered_traces;
1396
1397         for (const auto& channel : channels) {
1398                 for (auto& entry : signal_map) {
1399                         if (entry.first->channel() == channel) {
1400                                 shared_ptr<Trace> trace = entry.second;
1401                                 const auto list_iter = add_list.find(trace);
1402                                 if (list_iter == add_list.end())
1403                                         continue;
1404
1405                                 filtered_traces.push_back(trace);
1406                                 add_list.erase(list_iter);
1407                         }
1408                 }
1409         }
1410
1411         return filtered_traces;
1412 }
1413
1414 void View::determine_time_unit()
1415 {
1416         // Check whether we know the sample rate and hence can use time as the unit
1417         if (time_unit_ == util::TimeUnit::Samples) {
1418                 // Check all signals but...
1419                 for (const shared_ptr<Signal>& signal : signals_) {
1420                         const shared_ptr<SignalData> data = signal->data();
1421
1422                         // ...only check first segment of each
1423                         const vector< shared_ptr<Segment> > segments = data->segments();
1424                         if (!segments.empty())
1425                                 if (segments[0]->samplerate()) {
1426                                         set_time_unit(util::TimeUnit::Time);
1427                                         break;
1428                                 }
1429                 }
1430         }
1431 }
1432
1433 bool View::eventFilter(QObject *object, QEvent *event)
1434 {
1435         const QEvent::Type type = event->type();
1436
1437         if (type == QEvent::MouseMove) {
1438
1439                 if (object)
1440                         hover_widget_ = qobject_cast<QWidget*>(object);
1441
1442                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1443                 if (object == viewport_)
1444                         hover_point_ = mouse_event->pos();
1445                 else if (object == ruler_)
1446                         hover_point_ = mouse_event->pos();
1447                 else if (object == header_)
1448                         hover_point_ = QPoint(0, mouse_event->y());
1449                 else
1450                         hover_point_ = QPoint(-1, -1);
1451
1452                 update_hover_point();
1453
1454                 if (grabbed_widget_) {
1455                         int64_t nearest = get_nearest_level_change(hover_point_);
1456                         pv::util::Timestamp mouse_time = offset_ + hover_point_.x() * scale_;
1457
1458                         if (nearest == -1) {
1459                                 grabbed_widget_->set_time(mouse_time);
1460                         } else {
1461                                 grabbed_widget_->set_time(nearest / get_signal_under_mouse_cursor()->base()->get_samplerate());
1462                         }
1463                 }
1464
1465         } else if (type == QEvent::MouseButtonPress) {
1466                 grabbed_widget_ = nullptr;
1467
1468                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1469                 if ((object == viewport_) && (mouse_event->button() & Qt::LeftButton)) {
1470                         // Send event to all trace tree items
1471                         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1472                                 list_by_type<TraceTreeItem>());
1473                         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1474                                 r->mouse_left_press_event(mouse_event);
1475                 }
1476         } else if (type == QEvent::Leave) {
1477                 hover_point_ = QPoint(-1, -1);
1478                 update_hover_point();
1479         } else if (type == QEvent::Show) {
1480
1481                 // This is somewhat of a hack, unfortunately. We cannot use
1482                 // set_v_offset() from within restore_settings() as the view
1483                 // at that point is neither visible nor properly sized.
1484                 // This is the least intrusive workaround I could come up
1485                 // with: set the vertical offset (or scroll defaults) when
1486                 // the view is shown, which happens after all widgets were
1487                 // resized to their final sizes.
1488                 update_layout();
1489
1490                 if (settings_restored_)
1491                         determine_if_header_was_shrunk();
1492                 else
1493                         resize_header_to_fit();
1494
1495                 if (scroll_needs_defaults_) {
1496                         set_scroll_default();
1497                         scroll_needs_defaults_ = false;
1498                 }
1499
1500                 if (saved_v_offset_) {
1501                         set_v_offset(saved_v_offset_);
1502                         saved_v_offset_ = 0;
1503                 }
1504         }
1505
1506         return QObject::eventFilter(object, event);
1507 }
1508
1509 void View::contextMenuEvent(QContextMenuEvent *event)
1510 {
1511         QPoint pos = event->pos() - QPoint(0, ruler_->sizeHint().height());
1512
1513         const shared_ptr<ViewItem> r = viewport_->get_mouse_over_item(pos);
1514         if (!r)
1515                 return;
1516
1517         QMenu *menu = r->create_view_context_menu(this, pos);
1518         if (menu)
1519                 menu->popup(event->globalPos());
1520 }
1521
1522 void View::resizeEvent(QResizeEvent* event)
1523 {
1524         // Only adjust the top margin if we shrunk vertically
1525         if (event->size().height() < event->oldSize().height())
1526                 adjust_top_margin();
1527
1528         update_layout();
1529 }
1530
1531 void View::update_hover_point()
1532 {
1533         // Determine signal that the mouse cursor is hovering over
1534         signal_under_mouse_cursor_.reset();
1535         if (hover_widget_ == this) {
1536                 for (const shared_ptr<Signal>& s : signals_) {
1537                         const pair<int, int> extents = s->v_extents();
1538                         const int top = s->get_visual_y() + extents.first;
1539                         const int btm = s->get_visual_y() + extents.second;
1540                         if ((hover_point_.y() >= top) && (hover_point_.y() <= btm)
1541                                 && s->base()->enabled())
1542                                 signal_under_mouse_cursor_ = s;
1543                 }
1544         }
1545
1546         // Update all trace tree items
1547         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1548                 list_by_type<TraceTreeItem>());
1549         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1550                 r->hover_point_changed(hover_point_);
1551
1552         // Notify any other listeners
1553         hover_point_changed(hover_widget_, hover_point_);
1554 }
1555
1556 void View::row_item_appearance_changed(bool label, bool content)
1557 {
1558         if (label)
1559                 header_->update();
1560         if (content)
1561                 viewport_->update();
1562 }
1563
1564 void View::time_item_appearance_changed(bool label, bool content)
1565 {
1566         if (label) {
1567                 ruler_->update();
1568
1569                 // Make sure the header pane width is updated, too
1570                 update_layout();
1571         }
1572
1573         if (content)
1574                 viewport_->update();
1575 }
1576
1577 void View::extents_changed(bool horz, bool vert)
1578 {
1579         sticky_events_ |=
1580                 (horz ? TraceTreeItemHExtentsChanged : 0) |
1581                 (vert ? TraceTreeItemVExtentsChanged : 0);
1582
1583         if (!lazy_event_handler_.isActive())
1584                 lazy_event_handler_.start();
1585 }
1586
1587 void View::on_signal_name_changed()
1588 {
1589         if (!header_was_shrunk_)
1590                 resize_header_to_fit();
1591 }
1592
1593 void View::on_splitter_moved()
1594 {
1595         // The header can only shrink when the splitter is moved manually
1596         determine_if_header_was_shrunk();
1597
1598         if (!header_was_shrunk_)
1599                 resize_header_to_fit();
1600 }
1601
1602 void View::on_zoom_in_shortcut_triggered()
1603 {
1604         zoom(1);
1605 }
1606
1607 void View::on_zoom_out_shortcut_triggered()
1608 {
1609         zoom(-1);
1610 }
1611
1612 void View::on_scroll_to_start_shortcut_triggered()
1613 {
1614         set_h_offset(0);
1615 }
1616
1617 void View::on_scroll_to_end_shortcut_triggered()
1618 {
1619         set_h_offset(get_h_scrollbar_maximum());
1620 }
1621
1622 void View::h_scroll_value_changed(int value)
1623 {
1624         if (updating_scroll_)
1625                 return;
1626
1627         // Disable sticky scrolling when user moves the horizontal scroll bar
1628         // during a running acquisition
1629         if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1630                 sticky_scrolling_ = false;
1631                 sticky_scrolling_changed(false);
1632         }
1633
1634         const int range = scrollarea_->horizontalScrollBar()->maximum();
1635         if (range < MaxScrollValue)
1636                 set_offset(scale_ * value);
1637         else {
1638                 double length = 0;
1639                 Timestamp offset;
1640                 get_scroll_layout(length, offset);
1641                 set_offset(scale_ * length * value / MaxScrollValue);
1642         }
1643
1644         ruler_->update();
1645         viewport_->update();
1646 }
1647
1648 void View::v_scroll_value_changed()
1649 {
1650         header_->update();
1651         viewport_->update();
1652 }
1653
1654 void View::on_grab_ruler(int ruler_id)
1655 {
1656         if (!cursors_shown()) {
1657                 center_cursors();
1658                 show_cursors();
1659         }
1660
1661         // Release the grabbed widget if its trigger hotkey was pressed twice
1662         if (ruler_id == 1)
1663                 grabbed_widget_ = (grabbed_widget_ == cursors_->first().get()) ?
1664                         nullptr : cursors_->first().get();
1665         else
1666                 grabbed_widget_ = (grabbed_widget_ == cursors_->second().get()) ?
1667                         nullptr : cursors_->second().get();
1668
1669         if (grabbed_widget_)
1670                 grabbed_widget_->set_time(ruler_->get_absolute_time_from_x_pos(
1671                         mapFromGlobal(QCursor::pos()).x() - header_width()));
1672 }
1673
1674 void View::signals_changed()
1675 {
1676         using sigrok::Channel;
1677
1678         vector< shared_ptr<Channel> > channels;
1679         shared_ptr<sigrok::Device> sr_dev;
1680         bool signals_added_or_removed = false;
1681
1682         // Do we need to set the vertical scrollbar to its default position later?
1683         // We do if there are no traces, i.e. the scroll bar has no range set
1684         bool reset_scrollbar =
1685                 (scrollarea_->verticalScrollBar()->minimum() ==
1686                         scrollarea_->verticalScrollBar()->maximum());
1687
1688         if (!session_.device()) {
1689                 reset_scroll();
1690                 signals_.clear();
1691         } else {
1692                 sr_dev = session_.device()->device();
1693                 assert(sr_dev);
1694                 channels = sr_dev->channels();
1695         }
1696
1697         vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1698
1699         // Make a list of traces that are being added, and a list of traces
1700         // that are being removed
1701         const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1702         const set<shared_ptr<Trace>> prev_traces(
1703                 prev_trace_list.begin(), prev_trace_list.end());
1704
1705         set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1706
1707 #ifdef ENABLE_DECODE
1708         traces.insert(decode_traces_.begin(), decode_traces_.end());
1709 #endif
1710
1711         set< shared_ptr<Trace> > add_traces;
1712         set_difference(traces.begin(), traces.end(),
1713                 prev_traces.begin(), prev_traces.end(),
1714                 inserter(add_traces, add_traces.begin()));
1715
1716         set< shared_ptr<Trace> > remove_traces;
1717         set_difference(prev_traces.begin(), prev_traces.end(),
1718                 traces.begin(), traces.end(),
1719                 inserter(remove_traces, remove_traces.begin()));
1720
1721         // Make a look-up table of sigrok Channels to pulseview Signals
1722         unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1723                 signal_map;
1724         for (const shared_ptr<Signal>& sig : signals_)
1725                 signal_map[sig->base()] = sig;
1726
1727         // Populate channel groups
1728         if (sr_dev)
1729                 for (auto& entry : sr_dev->channel_groups()) {
1730                         const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1731
1732                         if (group->channels().size() <= 1)
1733                                 continue;
1734
1735                         // Find best trace group to add to
1736                         TraceTreeItemOwner *owner = find_prevalent_trace_group(
1737                                 group, signal_map);
1738
1739                         // If there is no trace group, create one
1740                         shared_ptr<TraceGroup> new_trace_group;
1741                         if (!owner) {
1742                                 new_trace_group.reset(new TraceGroup());
1743                                 owner = new_trace_group.get();
1744                         }
1745
1746                         // Extract traces for the trace group, removing them from
1747                         // the add list
1748                         const vector< shared_ptr<Trace> > new_traces_in_group =
1749                                 extract_new_traces_for_channels(group->channels(),
1750                                         signal_map, add_traces);
1751
1752                         // Add the traces to the group
1753                         const pair<int, int> prev_v_extents = owner->v_extents();
1754                         int offset = prev_v_extents.second - prev_v_extents.first;
1755                         for (const shared_ptr<Trace>& trace : new_traces_in_group) {
1756                                 assert(trace);
1757                                 owner->add_child_item(trace);
1758
1759                                 const pair<int, int> extents = trace->v_extents();
1760                                 if (trace->enabled())
1761                                         offset += -extents.first;
1762                                 trace->force_to_v_offset(offset);
1763                                 if (trace->enabled())
1764                                         offset += extents.second;
1765                         }
1766
1767                         if (new_trace_group) {
1768                                 // Assign proper vertical offsets to each channel in the group
1769                                 new_trace_group->restack_items();
1770
1771                                 // If this is a new group, enqueue it in the new top level
1772                                 // items list
1773                                 if (!new_traces_in_group.empty())
1774                                         new_top_level_items.push_back(new_trace_group);
1775                         }
1776                 }
1777
1778         // Enqueue the remaining logic channels in a group
1779         vector< shared_ptr<Channel> > logic_channels;
1780         copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1781                 [](const shared_ptr<Channel>& c) {
1782                         return c->type() == sigrok::ChannelType::LOGIC; });
1783
1784         const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1785                 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1786
1787         if (non_grouped_logic_signals.size() > 0) {
1788                 const shared_ptr<TraceGroup> non_grouped_trace_group(
1789                         make_shared<TraceGroup>());
1790                 for (const shared_ptr<Trace>& trace : non_grouped_logic_signals)
1791                         non_grouped_trace_group->add_child_item(trace);
1792
1793                 non_grouped_trace_group->restack_items();
1794                 new_top_level_items.push_back(non_grouped_trace_group);
1795         }
1796
1797         // Enqueue the remaining channels as free ungrouped traces
1798         const vector< shared_ptr<Trace> > new_top_level_signals =
1799                 extract_new_traces_for_channels(channels, signal_map, add_traces);
1800         new_top_level_items.insert(new_top_level_items.end(),
1801                 new_top_level_signals.begin(), new_top_level_signals.end());
1802
1803         // Enqueue any remaining traces i.e. decode traces
1804         new_top_level_items.insert(new_top_level_items.end(),
1805                 add_traces.begin(), add_traces.end());
1806
1807         // Remove any removed traces
1808         for (const shared_ptr<Trace>& trace : remove_traces) {
1809                 TraceTreeItemOwner *const owner = trace->owner();
1810                 assert(owner);
1811                 owner->remove_child_item(trace);
1812                 signals_added_or_removed = true;
1813         }
1814
1815         // Remove any empty trace groups
1816         for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1817                 if (group->child_items().size() == 0) {
1818                         remove_child_item(group);
1819                         group.reset();
1820                 }
1821
1822         // Add and position the pending top levels items
1823         int offset = v_extents().second;
1824         for (auto item : new_top_level_items) {
1825                 add_child_item(item);
1826
1827                 // Position the item after the last item or at the top if there is none
1828                 const pair<int, int> extents = item->v_extents();
1829
1830                 if (item->enabled())
1831                         offset += -extents.first;
1832
1833                 item->force_to_v_offset(offset);
1834
1835                 if (item->enabled())
1836                         offset += extents.second;
1837                 signals_added_or_removed = true;
1838         }
1839
1840
1841         if (signals_added_or_removed && !header_was_shrunk_)
1842                 resize_header_to_fit();
1843
1844         update_layout();
1845
1846         header_->update();
1847         viewport_->update();
1848
1849         if (reset_scrollbar)
1850                 set_scroll_default();
1851 }
1852
1853 void View::capture_state_updated(int state)
1854 {
1855         GlobalSettings settings;
1856
1857         if (state == Session::Running) {
1858                 set_time_unit(util::TimeUnit::Samples);
1859
1860                 trigger_markers_.clear();
1861                 if (!custom_zero_offset_set_)
1862                         set_zero_position(0);
1863
1864                 scale_at_acq_start_ = scale_;
1865                 offset_at_acq_start_ = offset_;
1866
1867                 // Activate "always zoom to fit" if the setting is enabled and we're
1868                 // the main view of this session (other trace views may be used for
1869                 // zooming and we don't want to mess them up)
1870                 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1871                 if (is_main_view_ && state) {
1872                         always_zoom_to_fit_ = true;
1873                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1874                 }
1875
1876                 // Enable sticky scrolling if the setting is enabled
1877                 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1878
1879                 // Reset all traces to segment 0
1880                 current_segment_ = 0;
1881                 set_current_segment(current_segment_);
1882         }
1883
1884         if (state == Session::Stopped) {
1885                 // After acquisition has stopped we need to re-calculate the ticks once
1886                 // as it's otherwise done when the user pans or zooms, which is too late
1887                 calculate_tick_spacing();
1888
1889                 // Reset "always zoom to fit", the acquisition has stopped
1890                 if (always_zoom_to_fit_) {
1891                         // Perform a final zoom-to-fit before disabling
1892                         zoom_fit(always_zoom_to_fit_);
1893                         always_zoom_to_fit_ = false;
1894                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1895                 }
1896
1897                 bool zoom_to_fit_after_acq =
1898                         settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1899
1900                 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1901                 // we didn't restore settings in the meanwhile
1902                 if (zoom_to_fit_after_acq &&
1903                         !suppress_zoom_to_fit_after_acq_ &&
1904                         (scale_ == scale_at_acq_start_) &&
1905                         (offset_ == offset_at_acq_start_))
1906                         zoom_fit(false);  // We're stopped, so the GUI state doesn't matter
1907
1908                 suppress_zoom_to_fit_after_acq_ = false;
1909         }
1910 }
1911
1912 void View::on_new_segment(int new_segment_id)
1913 {
1914         on_segment_changed(new_segment_id);
1915 }
1916
1917 void View::on_segment_completed(int segment_id)
1918 {
1919         on_segment_changed(segment_id);
1920 }
1921
1922 void View::on_segment_changed(int segment)
1923 {
1924         switch (segment_display_mode_) {
1925         case Trace::ShowLastSegmentOnly:
1926         case Trace::ShowSingleSegmentOnly:
1927                 set_current_segment(segment);
1928                 break;
1929
1930         case Trace::ShowLastCompleteSegmentOnly:
1931                 // Only update if all segments are complete
1932                 if (session_.all_segments_complete(segment))
1933                         set_current_segment(segment);
1934                 break;
1935
1936         case Trace::ShowAllSegments:
1937         case Trace::ShowAccumulatedIntensity:
1938         default:
1939                 break;
1940         }
1941 }
1942
1943 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1944 {
1945         (void)new_value;
1946
1947         if (!custom_zero_offset_set_)
1948                 reset_zero_position();
1949 }
1950
1951 void View::perform_delayed_view_update()
1952 {
1953         if (always_zoom_to_fit_) {
1954                 zoom_fit(true);
1955         } else if (sticky_scrolling_) {
1956                 // Make right side of the view sticky
1957                 double length = 0;
1958                 Timestamp offset;
1959                 get_scroll_layout(length, offset);
1960
1961                 const QSize areaSize = viewport_->size();
1962                 length = max(length - areaSize.width(), 0.0);
1963
1964                 set_offset(scale_ * length);
1965         }
1966
1967         determine_time_unit();
1968         update_scroll();
1969         ruler_->update();
1970         viewport_->update();
1971 }
1972
1973 void View::process_sticky_events()
1974 {
1975         if (sticky_events_ & TraceTreeItemHExtentsChanged)
1976                 update_layout();
1977         if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1978                 restack_all_trace_tree_items();
1979                 update_scroll();
1980         }
1981
1982         // Clear the sticky events
1983         sticky_events_ = 0;
1984 }
1985
1986 } // namespace trace
1987 } // namespace views
1988 } // namespace pv