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