pv/views/trace/view.cpp

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