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