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