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