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