pv/views/trace/view.cpp

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