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