pv/view/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 <mutex>
  33 #include <unordered_set>
  34
  35 #include <boost/archive/text_iarchive.hpp>
  36 #include <boost/archive/text_oarchive.hpp>
  37 #include <boost/serialization/serialization.hpp>
  38 #include <boost/thread/locks.hpp>
  39
  40 #include <QApplication>
  41 #include <QHBoxLayout>
  42 #include <QEvent>
  43 #include <QFontMetrics>
  44 #include <QMouseEvent>
  45 #include <QScrollBar>
  46
  47 #include <libsigrokcxx/libsigrokcxx.hpp>
  48
  49 #include "analogsignal.hpp"
  50 #include "header.hpp"
  51 #include "logicsignal.hpp"
  52 #include "ruler.hpp"
  53 #include "signal.hpp"
  54 #include "tracegroup.hpp"
  55 #include "triggermarker.hpp"
  56 #include "view.hpp"
  57 #include "viewport.hpp"
  58
  59 #include "pv/session.hpp"
  60 #include "pv/devices/device.hpp"
  61 #include "pv/data/logic.hpp"
  62 #include "pv/data/logicsegment.hpp"
  63 #include "pv/util.hpp"
  64
  65 #ifdef ENABLE_DECODE
  66 #include "decodetrace.hpp"
  67 #endif
  68
  69 using boost::shared_lock;
  70 using boost::shared_mutex;
  71
  72 using pv::data::SignalData;
  73 using pv::data::Segment;
  74 using pv::util::TimeUnit;
  75 using pv::util::Timestamp;
  76
  77 using std::back_inserter;
  78 using std::copy_if;
  79 using std::deque;
  80 using std::dynamic_pointer_cast;
  81 using std::inserter;
  82 using std::list;
  83 using std::lock_guard;
  84 using std::max;
  85 using std::make_pair;
  86 using std::make_shared;
  87 using std::min;
  88 using std::pair;
  89 using std::set;
  90 using std::set_difference;
  91 using std::shared_ptr;
  92 using std::unordered_map;
  93 using std::unordered_set;
  94 using std::vector;
  95 using std::weak_ptr;
  96
  97 namespace pv {
  98 namespace views {
  99 namespace TraceView {
 100
 101 const Timestamp View::MaxScale("1e9");
 102 const Timestamp View::MinScale("1e-12");
 103
 104 const int View::MaxScrollValue = INT_MAX / 2;
 105 const int View::MaxViewAutoUpdateRate = 25; // No more than 25 Hz with sticky scrolling
 106
 107 const int View::ScaleUnits[3] = {1, 2, 5};
 108
 109
 110 CustomAbstractScrollArea::CustomAbstractScrollArea(QWidget *parent) :
 111         QAbstractScrollArea(parent)
 112 {
 113 }
 114
 115 void CustomAbstractScrollArea::setViewportMargins(int left, int top, int right, int bottom)
 116 {
 117         QAbstractScrollArea::setViewportMargins(left, top, right, bottom);
 118 }
 119
 120 bool CustomAbstractScrollArea::viewportEvent(QEvent *event)
 121 {
 122         switch (event->type()) {
 123         case QEvent::Paint:
 124         case QEvent::MouseButtonPress:
 125         case QEvent::MouseButtonRelease:
 126         case QEvent::MouseButtonDblClick:
 127         case QEvent::MouseMove:
 128         case QEvent::Wheel:
 129         case QEvent::TouchBegin:
 130         case QEvent::TouchUpdate:
 131         case QEvent::TouchEnd:
 132                 return false;
 133         default:
 134                 return QAbstractScrollArea::viewportEvent(event);
 135         }
 136 }
 137
 138 View::View(Session &session, QWidget *parent) :
 139         ViewBase(session, parent),
 140         viewport_(new Viewport(*this)),
 141         ruler_(new Ruler(*this)),
 142         header_(new Header(*this)),
 143         scrollarea_(this),
 144         scale_(1e-3),
 145         offset_(0),
 146         updating_scroll_(false),
 147         sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
 148         coloured_bg_(false),
 149         always_zoom_to_fit_(false),
 150         tick_period_(0),
 151         tick_prefix_(pv::util::SIPrefix::yocto),
 152         tick_precision_(0),
 153         time_unit_(util::TimeUnit::Time),
 154         show_cursors_(false),
 155         cursors_(new CursorPair(*this)),
 156         next_flag_text_('A'),
 157         trigger_markers_(),
 158         hover_point_(-1, -1),
 159         scroll_needs_defaults_(false),
 160         saved_v_offset_(0),
 161         size_finalized_(false)
 162 {
 163         connect(scrollarea_.horizontalScrollBar(), SIGNAL(valueChanged(int)),
 164                 this, SLOT(h_scroll_value_changed(int)));
 165         connect(scrollarea_.verticalScrollBar(), SIGNAL(valueChanged(int)),
 166                 this, SLOT(v_scroll_value_changed()));
 167
 168         connect(header_, SIGNAL(selection_changed()),
 169                 ruler_, SLOT(clear_selection()));
 170         connect(ruler_, SIGNAL(selection_changed()),
 171                 header_, SLOT(clear_selection()));
 172
 173         connect(header_, SIGNAL(selection_changed()),
 174                 this, SIGNAL(selection_changed()));
 175         connect(ruler_, SIGNAL(selection_changed()),
 176                 this, SIGNAL(selection_changed()));
 177
 178         connect(this, SIGNAL(hover_point_changed()),
 179                 this, SLOT(on_hover_point_changed()));
 180
 181         connect(&lazy_event_handler_, SIGNAL(timeout()),
 182                 this, SLOT(process_sticky_events()));
 183         lazy_event_handler_.setSingleShot(true);
 184
 185         connect(&delayed_view_updater_, SIGNAL(timeout()),
 186                 this, SLOT(perform_delayed_view_update()));
 187         delayed_view_updater_.setSingleShot(true);
 188         delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
 189
 190         /* To let the scroll area fill up the parent QWidget (this), we need a layout */
 191         QHBoxLayout *layout = new QHBoxLayout(this);
 192         setLayout(layout);
 193         layout->setContentsMargins(0, 0, 0, 0);
 194         layout->addWidget(&scrollarea_);
 195
 196         scrollarea_.setViewport(viewport_);
 197
 198         viewport_->installEventFilter(this);
 199         ruler_->installEventFilter(this);
 200         header_->installEventFilter(this);
 201
 202         // Trigger the initial event manually. The default device has signals
 203         // which were created before this object came into being
 204         signals_changed();
 205
 206         // make sure the transparent widgets are on the top
 207         ruler_->raise();
 208         header_->raise();
 209
 210         // Update the zoom state
 211         calculate_tick_spacing();
 212 }
 213
 214 Session& View::session()
 215 {
 216         return session_;
 217 }
 218
 219 const Session& View::session() const
 220 {
 221         return session_;
 222 }
 223
 224 std::unordered_set< std::shared_ptr<Signal> > View::signals() const
 225 {
 226         return signals_;
 227 }
 228
 229 void View::clear_signals()
 230 {
 231         signals_.clear();
 232 }
 233
 234 void View::add_signal(const shared_ptr<Signal> signal)
 235 {
 236         signals_.insert(signal);
 237 }
 238
 239 #ifdef ENABLE_DECODE
 240 void View::clear_decode_signals()
 241 {
 242         decode_traces_.clear();
 243 }
 244
 245 void View::add_decode_signal(shared_ptr<data::SignalBase> signalbase)
 246 {
 247         shared_ptr<DecodeTrace> d(
 248                 new DecodeTrace(session_, signalbase, decode_traces_.size()));
 249         decode_traces_.push_back(d);
 250 }
 251
 252 void View::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
 253 {
 254         for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
 255                 if ((*i)->base() == signalbase) {
 256                         decode_traces_.erase(i);
 257                         signals_changed();
 258                         return;
 259                 }
 260 }
 261 #endif
 262
 263 View* View::view()
 264 {
 265         return this;
 266 }
 267
 268 const View* View::view() const
 269 {
 270         return this;
 271 }
 272
 273 Viewport* View::viewport()
 274 {
 275         return viewport_;
 276 }
 277
 278 const Viewport* View::viewport() const
 279 {
 280         return viewport_;
 281 }
 282
 283 void View::save_settings(QSettings &settings) const
 284 {
 285         settings.setValue("scale", scale_);
 286         settings.setValue("v_offset",
 287                 scrollarea_.verticalScrollBar()->sliderPosition());
 288
 289         std::stringstream ss;
 290         boost::archive::text_oarchive oa(ss);
 291         oa << boost::serialization::make_nvp("offset", offset_);
 292         settings.setValue("offset", QString::fromStdString(ss.str()));
 293
 294         for (shared_ptr<Signal> signal : signals_) {
 295                 settings.beginGroup(signal->base()->internal_name());
 296                 signal->save_settings(settings);
 297                 settings.endGroup();
 298         }
 299 }
 300
 301 void View::restore_settings(QSettings &settings)
 302 {
 303         // Note: It is assumed that this function is only called once,
 304         // immediately after restoring a previous session.
 305
 306         if (settings.contains("scale"))
 307                 set_scale(settings.value("scale").toDouble());
 308
 309         if (settings.contains("offset")) {
 310                 util::Timestamp offset;
 311                 std::stringstream ss;
 312                 ss << settings.value("offset").toString().toStdString();
 313
 314                 boost::archive::text_iarchive ia(ss);
 315                 ia >> boost::serialization::make_nvp("offset", offset);
 316
 317                 set_offset(offset);
 318         }
 319
 320         for (shared_ptr<Signal> signal : signals_) {
 321                 settings.beginGroup(signal->base()->internal_name());
 322                 signal->restore_settings(settings);
 323                 settings.endGroup();
 324         }
 325
 326         if (settings.contains("v_offset")) {
 327                 saved_v_offset_ = settings.value("v_offset").toInt();
 328                 set_v_offset(saved_v_offset_);
 329                 scroll_needs_defaults_ = false;
 330                 // Note: see resizeEvent() for additional information
 331         }
 332 }
 333
 334 vector< shared_ptr<TimeItem> > View::time_items() const
 335 {
 336         const vector<shared_ptr<Flag>> f(flags());
 337         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
 338         items.push_back(cursors_);
 339         items.push_back(cursors_->first());
 340         items.push_back(cursors_->second());
 341
 342         for (auto trigger_marker : trigger_markers_)
 343                 items.push_back(trigger_marker);
 344
 345         return items;
 346 }
 347
 348 double View::scale() const
 349 {
 350         return scale_;
 351 }
 352
 353 void View::set_scale(double scale)
 354 {
 355         if (scale_ != scale) {
 356                 scale_ = scale;
 357                 Q_EMIT scale_changed();
 358         }
 359 }
 360
 361 const Timestamp& View::offset() const
 362 {
 363         return offset_;
 364 }
 365
 366 void View::set_offset(const pv::util::Timestamp& offset)
 367 {
 368         if (offset_ != offset) {
 369                 offset_ = offset;
 370                 Q_EMIT offset_changed();
 371         }
 372 }
 373
 374 int View::owner_visual_v_offset() const
 375 {
 376         return -scrollarea_.verticalScrollBar()->sliderPosition();
 377 }
 378
 379 void View::set_v_offset(int offset)
 380 {
 381         scrollarea_.verticalScrollBar()->setSliderPosition(offset);
 382         header_->update();
 383         viewport_->update();
 384 }
 385
 386 unsigned int View::depth() const
 387 {
 388         return 0;
 389 }
 390
 391 pv::util::SIPrefix View::tick_prefix() const
 392 {
 393         return tick_prefix_;
 394 }
 395
 396 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
 397 {
 398         if (tick_prefix_ != tick_prefix) {
 399                 tick_prefix_ = tick_prefix;
 400                 Q_EMIT tick_prefix_changed();
 401         }
 402 }
 403
 404 unsigned int View::tick_precision() const
 405 {
 406         return tick_precision_;
 407 }
 408
 409 void View::set_tick_precision(unsigned tick_precision)
 410 {
 411         if (tick_precision_ != tick_precision) {
 412                 tick_precision_ = tick_precision;
 413                 Q_EMIT tick_precision_changed();
 414         }
 415 }
 416
 417 const pv::util::Timestamp& View::tick_period() const
 418 {
 419         return tick_period_;
 420 }
 421
 422 void View::set_tick_period(const pv::util::Timestamp& tick_period)
 423 {
 424         if (tick_period_ != tick_period) {
 425                 tick_period_ = tick_period;
 426                 Q_EMIT tick_period_changed();
 427         }
 428 }
 429
 430 TimeUnit View::time_unit() const
 431 {
 432         return time_unit_;
 433 }
 434
 435 void View::set_time_unit(pv::util::TimeUnit time_unit)
 436 {
 437         if (time_unit_ != time_unit) {
 438                 time_unit_ = time_unit;
 439                 Q_EMIT time_unit_changed();
 440         }
 441 }
 442
 443 void View::zoom(double steps)
 444 {
 445         zoom(steps, viewport_->width() / 2);
 446 }
 447
 448 void View::zoom(double steps, int offset)
 449 {
 450         set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
 451 }
 452
 453 void View::zoom_fit(bool gui_state)
 454 {
 455         // Act as one-shot when stopped, toggle along with the GUI otherwise
 456         if (session_.get_capture_state() == Session::Stopped) {
 457                 always_zoom_to_fit_ = false;
 458                 always_zoom_to_fit_changed(false);
 459         } else {
 460                 always_zoom_to_fit_ = gui_state;
 461                 always_zoom_to_fit_changed(gui_state);
 462         }
 463
 464         const pair<Timestamp, Timestamp> extents = get_time_extents();
 465         const Timestamp delta = extents.second - extents.first;
 466         if (delta < Timestamp("1e-12"))
 467                 return;
 468
 469         assert(viewport_);
 470         const int w = viewport_->width();
 471         if (w <= 0)
 472                 return;
 473
 474         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
 475         set_scale_offset(scale.convert_to<double>(), extents.first);
 476 }
 477
 478 void View::zoom_one_to_one()
 479 {
 480         using pv::data::SignalData;
 481
 482         // Make a set of all the visible data objects
 483         set< shared_ptr<SignalData> > visible_data = get_visible_data();
 484         if (visible_data.empty())
 485                 return;
 486
 487         assert(viewport_);
 488         const int w = viewport_->width();
 489         if (w <= 0)
 490                 return;
 491
 492         set_zoom(1.0 / session_.get_samplerate(), w / 2);
 493 }
 494
 495 void View::set_scale_offset(double scale, const Timestamp& offset)
 496 {
 497         // Disable sticky scrolling / always zoom to fit when acquisition runs
 498         // and user drags the viewport
 499         if ((scale_ == scale) && (offset_ != offset) &&
 500                         (session_.get_capture_state() == Session::Running)) {
 501
 502                 if (sticky_scrolling_) {
 503                         sticky_scrolling_ = false;
 504                         sticky_scrolling_changed(false);
 505                 }
 506
 507                 if (always_zoom_to_fit_) {
 508                         always_zoom_to_fit_ = false;
 509                         always_zoom_to_fit_changed(false);
 510                 }
 511         }
 512
 513         set_scale(scale);
 514         set_offset(offset);
 515
 516         calculate_tick_spacing();
 517
 518         update_scroll();
 519         ruler_->update();
 520         viewport_->update();
 521 }
 522
 523 set< shared_ptr<SignalData> > View::get_visible_data() const
 524 {
 525         // Make a set of all the visible data objects
 526         set< shared_ptr<SignalData> > visible_data;
 527         for (const shared_ptr<Signal> sig : signals_)
 528                 if (sig->enabled())
 529                         visible_data.insert(sig->data());
 530
 531         return visible_data;
 532 }
 533
 534 pair<Timestamp, Timestamp> View::get_time_extents() const
 535 {
 536         boost::optional<Timestamp> left_time, right_time;
 537         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
 538         for (const shared_ptr<SignalData> d : visible_data) {
 539                 const vector< shared_ptr<Segment> > segments =
 540                         d->segments();
 541                 for (const shared_ptr<Segment> &s : segments) {
 542                         double samplerate = s->samplerate();
 543                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 544
 545                         const Timestamp start_time = s->start_time();
 546                         left_time = left_time ?
 547                                 min(*left_time, start_time) :
 548                                                 start_time;
 549                         right_time = right_time ?
 550                                 max(*right_time, start_time + d->max_sample_count() / samplerate) :
 551                                                  start_time + d->max_sample_count() / samplerate;
 552                 }
 553         }
 554
 555         if (!left_time || !right_time)
 556                 return make_pair(0, 0);
 557
 558         assert(*left_time < *right_time);
 559         return make_pair(*left_time, *right_time);
 560 }
 561
 562 void View::enable_sticky_scrolling(bool state)
 563 {
 564         sticky_scrolling_ = state;
 565 }
 566
 567 void View::toggle_sticky_scrolling(void)
 568 {
 569         sticky_scrolling_ = !sticky_scrolling_;
 570 }
 571
 572 bool View::get_coloured_bg(void)
 573 {
 574         return coloured_bg_;
 575 }
 576
 577 void View::enable_coloured_bg(bool state)
 578 {
 579         const vector<shared_ptr<TraceTreeItem>> items(
 580                 list_by_type<TraceTreeItem>());
 581
 582         coloured_bg_ = state;
 583
 584         for (shared_ptr<TraceTreeItem> i : items) {
 585                 // Can't cast to Trace because it's abstract, so we need to
 586                 // check for any derived classes individually
 587
 588                 shared_ptr<AnalogSignal> a = dynamic_pointer_cast<AnalogSignal>(i);
 589                 if (a)
 590                         a->set_coloured_bg(state);
 591
 592                 shared_ptr<LogicSignal> l = dynamic_pointer_cast<LogicSignal>(i);
 593                 if (l)
 594                         l->set_coloured_bg(state);
 595
 596 #ifdef ENABLE_DECODE
 597                 shared_ptr<DecodeTrace> d = dynamic_pointer_cast<DecodeTrace>(i);
 598                 if (d)
 599                         d->set_coloured_bg(state);
 600 #endif
 601         }
 602
 603         viewport_->update();
 604 }
 605
 606 void View::toggle_coloured_bg(void)
 607 {
 608         enable_coloured_bg(!coloured_bg_);
 609 }
 610
 611 bool View::cursors_shown() const
 612 {
 613         return show_cursors_;
 614 }
 615
 616 void View::show_cursors(bool show)
 617 {
 618         show_cursors_ = show;
 619         ruler_->update();
 620         viewport_->update();
 621 }
 622
 623 void View::centre_cursors()
 624 {
 625         const double time_width = scale_ * viewport_->width();
 626         cursors_->first()->set_time(offset_ + time_width * 0.4);
 627         cursors_->second()->set_time(offset_ + time_width * 0.6);
 628         ruler_->update();
 629         viewport_->update();
 630 }
 631
 632 std::shared_ptr<CursorPair> View::cursors() const
 633 {
 634         return cursors_;
 635 }
 636
 637 void View::add_flag(const Timestamp& time)
 638 {
 639         flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
 640                 QString("%1").arg(next_flag_text_))));
 641
 642         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
 643                 (next_flag_text_ + 1);
 644
 645         time_item_appearance_changed(true, true);
 646 }
 647
 648 void View::remove_flag(std::shared_ptr<Flag> flag)
 649 {
 650         flags_.remove(flag);
 651         time_item_appearance_changed(true, true);
 652 }
 653
 654 vector< std::shared_ptr<Flag> > View::flags() const
 655 {
 656         vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
 657         stable_sort(flags.begin(), flags.end(),
 658                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
 659                         return a->time() < b->time();
 660                 });
 661
 662         return flags;
 663 }
 664
 665 const QPoint& View::hover_point() const
 666 {
 667         return hover_point_;
 668 }
 669
 670 void View::restack_all_trace_tree_items()
 671 {
 672         // Make a list of owners that is sorted from deepest first
 673         const vector<shared_ptr<TraceTreeItem>> items(
 674                 list_by_type<TraceTreeItem>());
 675         set< TraceTreeItemOwner* > owners;
 676         for (const auto &r : items)
 677                 owners.insert(r->owner());
 678         vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
 679         sort(sorted_owners.begin(), sorted_owners.end(),
 680                 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
 681                         return a->depth() > b->depth(); });
 682
 683         // Restack the items recursively
 684         for (auto &o : sorted_owners)
 685                 o->restack_items();
 686
 687         // Re-assign background colors
 688         bool next_bgcolour_state = 0;
 689
 690         for (auto &o : sorted_owners)
 691                 next_bgcolour_state = o->reassign_bgcolour_states(next_bgcolour_state);
 692
 693         // Animate the items to their destination
 694         for (const auto &i : items)
 695                 i->animate_to_layout_v_offset();
 696 }
 697
 698 void View::trigger_event(util::Timestamp location)
 699 {
 700         trigger_markers_.push_back(shared_ptr<TriggerMarker>(
 701                 new TriggerMarker(*this, location)));
 702 }
 703
 704 void View::get_scroll_layout(double &length, Timestamp &offset) const
 705 {
 706         const pair<Timestamp, Timestamp> extents = get_time_extents();
 707         length = ((extents.second - extents.first) / scale_).convert_to<double>();
 708         offset = offset_ / scale_;
 709 }
 710
 711 void View::set_zoom(double scale, int offset)
 712 {
 713         // Reset the "always zoom to fit" feature as the user changed the zoom
 714         always_zoom_to_fit_ = false;
 715         always_zoom_to_fit_changed(false);
 716
 717         const Timestamp cursor_offset = offset_ + scale_ * offset;
 718         const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
 719         const Timestamp new_offset = cursor_offset - new_scale * offset;
 720         set_scale_offset(new_scale.convert_to<double>(), new_offset);
 721 }
 722
 723 void View::calculate_tick_spacing()
 724 {
 725         const double SpacingIncrement = 10.0f;
 726         const double MinValueSpacing = 40.0f;
 727
 728         // Figure out the highest numeric value visible on a label
 729         const QSize areaSize = viewport_->size();
 730         const Timestamp max_time = max(fabs(offset_),
 731                 fabs(offset_ + scale_ * areaSize.width()));
 732
 733         double min_width = SpacingIncrement;
 734         double label_width, tick_period_width;
 735
 736         QFontMetrics m(QApplication::font());
 737
 738         // Copies of the member variables with the same name, used in the calculation
 739         // and written back afterwards, so that we don't emit signals all the time
 740         // during the calculation.
 741         pv::util::Timestamp tick_period = tick_period_;
 742         pv::util::SIPrefix tick_prefix = tick_prefix_;
 743         unsigned tick_precision = tick_precision_;
 744
 745         do {
 746                 const double min_period = scale_ * min_width;
 747
 748                 const int order = (int)floorf(log10f(min_period));
 749                 const pv::util::Timestamp order_decimal =
 750                         pow(pv::util::Timestamp(10), order);
 751
 752                 // Allow for a margin of error so that a scale unit of 1 can be used.
 753                 // Otherwise, for a SU of 1 the tick period will almost always be below
 754                 // the min_period by a small amount - and thus skipped in favor of 2.
 755                 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
 756                 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
 757                 double tp_with_margin;
 758                 unsigned int unit = 0;
 759
 760                 do {
 761                         tp_with_margin = order_decimal.convert_to<double>() *
 762                                 (ScaleUnits[unit++] + tp_margin);
 763                 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
 764
 765                 tick_period = order_decimal * ScaleUnits[unit - 1];
 766                 tick_prefix = static_cast<pv::util::SIPrefix>(
 767                         (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
 768
 769                 // Precision is the number of fractional digits required, not
 770                 // taking the prefix into account (and it must never be negative)
 771                 tick_precision = std::max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
 772
 773                 tick_period_width = (tick_period / scale_).convert_to<double>();
 774
 775                 const QString label_text = Ruler::format_time_with_distance(
 776                         tick_period, max_time, tick_prefix, time_unit_, tick_precision);
 777
 778                 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
 779                         Qt::AlignLeft | Qt::AlignTop, label_text).width() +
 780                                 MinValueSpacing;
 781
 782                 min_width += SpacingIncrement;
 783         } while (tick_period_width < label_width);
 784
 785         set_tick_period(tick_period);
 786         set_tick_prefix(tick_prefix);
 787         set_tick_precision(tick_precision);
 788 }
 789
 790 void View::update_scroll()
 791 {
 792         assert(viewport_);
 793         QScrollBar *hscrollbar = scrollarea_.horizontalScrollBar();
 794         QScrollBar *vscrollbar = scrollarea_.verticalScrollBar();
 795
 796         const QSize areaSize = viewport_->size();
 797
 798         // Set the horizontal scroll bar
 799         double length = 0;
 800         Timestamp offset;
 801         get_scroll_layout(length, offset);
 802         length = max(length - areaSize.width(), 0.0);
 803
 804         int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
 805
 806         hscrollbar->setPageStep(areaSize.width() / 2);
 807         hscrollbar->setSingleStep(major_tick_distance);
 808
 809         updating_scroll_ = true;
 810
 811         if (length < MaxScrollValue) {
 812                 hscrollbar->setRange(0, length);
 813                 hscrollbar->setSliderPosition(offset.convert_to<double>());
 814         } else {
 815                 hscrollbar->setRange(0, MaxScrollValue);
 816                 hscrollbar->setSliderPosition(
 817                         (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
 818         }
 819
 820         updating_scroll_ = false;
 821
 822         // Set the vertical scrollbar
 823         vscrollbar->setPageStep(areaSize.height());
 824         vscrollbar->setSingleStep(areaSize.height() / 8);
 825
 826         const pair<int, int> extents = v_extents();
 827
 828         // Don't change the scrollbar range if there are no traces
 829         if (extents.first != extents.second)
 830                 vscrollbar->setRange(extents.first - areaSize.height(),
 831                         extents.second);
 832
 833         if (scroll_needs_defaults_)
 834                 set_scroll_default();
 835 }
 836
 837 void View::reset_scroll()
 838 {
 839         scrollarea_.verticalScrollBar()->setRange(0, 0);
 840 }
 841
 842 void View::set_scroll_default()
 843 {
 844         assert(viewport_);
 845
 846         const QSize areaSize = viewport_->size();
 847
 848         const pair<int, int> extents = v_extents();
 849         const int trace_height = extents.second - extents.first;
 850
 851         // Do all traces fit in the view?
 852         if (areaSize.height() >= trace_height)
 853                 // Center all traces vertically
 854                 set_v_offset(extents.first -
 855                         ((areaSize.height() - trace_height) / 2));
 856         else
 857                 // Put the first trace at the top, letting the bottom ones overflow
 858                 set_v_offset(extents.first);
 859
 860         // If we're not sure whether setting the defaults worked as
 861         // the window wasn't set up entirely yet, we want to be called
 862         // again later to make sure
 863         scroll_needs_defaults_ = !size_finalized_;
 864 }
 865
 866 void View::update_layout()
 867 {
 868         scrollarea_.setViewportMargins(
 869                 header_->sizeHint().width() - Header::BaselineOffset,
 870                 ruler_->sizeHint().height(), 0, 0);
 871         ruler_->setGeometry(viewport_->x(), 0,
 872                 viewport_->width(), ruler_->extended_size_hint().height());
 873         header_->setGeometry(0, viewport_->y(),
 874                 header_->extended_size_hint().width(), viewport_->height());
 875         update_scroll();
 876 }
 877
 878 TraceTreeItemOwner* View::find_prevalent_trace_group(
 879         const shared_ptr<sigrok::ChannelGroup> &group,
 880         const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
 881                 &signal_map)
 882 {
 883         assert(group);
 884
 885         unordered_set<TraceTreeItemOwner*> owners;
 886         vector<TraceTreeItemOwner*> owner_list;
 887
 888         // Make a set and a list of all the owners
 889         for (const auto &channel : group->channels()) {
 890                 for (auto entry : signal_map) {
 891                         if (entry.first->channel() == channel) {
 892                                 TraceTreeItemOwner *const o = (entry.second)->owner();
 893                                 owner_list.push_back(o);
 894                                 owners.insert(o);
 895                         }
 896                 }
 897         }
 898
 899         // Iterate through the list of owners, and find the most prevalent
 900         size_t max_prevalence = 0;
 901         TraceTreeItemOwner *prevalent_owner = nullptr;
 902         for (TraceTreeItemOwner *owner : owners) {
 903                 const size_t prevalence = std::count_if(
 904                         owner_list.begin(), owner_list.end(),
 905                         [&](TraceTreeItemOwner *o) { return o == owner; });
 906                 if (prevalence > max_prevalence) {
 907                         max_prevalence = prevalence;
 908                         prevalent_owner = owner;
 909                 }
 910         }
 911
 912         return prevalent_owner;
 913 }
 914
 915 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
 916         const vector< shared_ptr<sigrok::Channel> > &channels,
 917         const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
 918                 &signal_map,
 919         set< shared_ptr<Trace> > &add_list)
 920 {
 921         vector< shared_ptr<Trace> > filtered_traces;
 922
 923         for (const auto &channel : channels) {
 924                 for (auto entry : signal_map) {
 925                         if (entry.first->channel() == channel) {
 926                                 shared_ptr<Trace> trace = entry.second;
 927                                 const auto list_iter = add_list.find(trace);
 928                                 if (list_iter == add_list.end())
 929                                         continue;
 930
 931                                 filtered_traces.push_back(trace);
 932                                 add_list.erase(list_iter);
 933                         }
 934                 }
 935         }
 936
 937         return filtered_traces;
 938 }
 939
 940 void View::determine_time_unit()
 941 {
 942         // Check whether we know the sample rate and hence can use time as the unit
 943         if (time_unit_ == util::TimeUnit::Samples) {
 944                 // Check all signals but...
 945                 for (const shared_ptr<Signal> signal : signals_) {
 946                         const shared_ptr<SignalData> data = signal->data();
 947
 948                         // ...only check first segment of each
 949                         const vector< shared_ptr<Segment> > segments = data->segments();
 950                         if (!segments.empty())
 951                                 if (segments[0]->samplerate()) {
 952                                         set_time_unit(util::TimeUnit::Time);
 953                                         break;
 954                                 }
 955                 }
 956         }
 957 }
 958
 959 bool View::eventFilter(QObject *object, QEvent *event)
 960 {
 961         const QEvent::Type type = event->type();
 962         if (type == QEvent::MouseMove) {
 963
 964                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 965                 if (object == viewport_)
 966                         hover_point_ = mouse_event->pos();
 967                 else if (object == ruler_)
 968                         hover_point_ = QPoint(mouse_event->x(), 0);
 969                 else if (object == header_)
 970                         hover_point_ = QPoint(0, mouse_event->y());
 971                 else
 972                         hover_point_ = QPoint(-1, -1);
 973
 974                 hover_point_changed();
 975
 976         } else if (type == QEvent::Leave) {
 977                 hover_point_ = QPoint(-1, -1);
 978                 hover_point_changed();
 979         }
 980
 981         return QObject::eventFilter(object, event);
 982 }
 983
 984 void View::resizeEvent(QResizeEvent*)
 985 {
 986         update_layout();
 987
 988         // This is somewhat of a hack, unfortunately. We cannot use
 989         // set_v_offset() from within restore_settings() as the view
 990         // at that point is neither visible nor properly sized.
 991         // This is the least intrusive workaround I could come up
 992         // with: set the vertical offset (or scroll defaults) when
 993         // the view is visible and resized to its final size.
 994         // Resize events that are sent when the view is not visible
 995         // must be ignored as they have wrong sizes, potentially
 996         // preventing the v offset from being set successfully.
 997
 998         if (isVisible())
 999                 size_finalized_ = true;
1000
1001         if (size_finalized_ && saved_v_offset_) {
1002                 set_v_offset(saved_v_offset_);
1003                 saved_v_offset_ = 0;
1004         }
1005
1006         if (size_finalized_ && scroll_needs_defaults_)
1007                 set_scroll_default();
1008 }
1009
1010 void View::row_item_appearance_changed(bool label, bool content)
1011 {
1012         if (label)
1013                 header_->update();
1014         if (content)
1015                 viewport_->update();
1016 }
1017
1018 void View::time_item_appearance_changed(bool label, bool content)
1019 {
1020         if (label)
1021                 ruler_->update();
1022         if (content)
1023                 viewport_->update();
1024 }
1025
1026 void View::extents_changed(bool horz, bool vert)
1027 {
1028         sticky_events_ |=
1029                 (horz ? TraceTreeItemHExtentsChanged : 0) |
1030                 (vert ? TraceTreeItemVExtentsChanged : 0);
1031         lazy_event_handler_.start();
1032 }
1033
1034 void View::h_scroll_value_changed(int value)
1035 {
1036         if (updating_scroll_)
1037                 return;
1038
1039         // Disable sticky scrolling when user moves the horizontal scroll bar
1040         // during a running acquisition
1041         if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1042                 sticky_scrolling_ = false;
1043                 sticky_scrolling_changed(false);
1044         }
1045
1046         const int range = scrollarea_.horizontalScrollBar()->maximum();
1047         if (range < MaxScrollValue)
1048                 set_offset(scale_ * value);
1049         else {
1050                 double length = 0;
1051                 Timestamp offset;
1052                 get_scroll_layout(length, offset);
1053                 set_offset(scale_ * length * value / MaxScrollValue);
1054         }
1055
1056         ruler_->update();
1057         viewport_->update();
1058 }
1059
1060 void View::v_scroll_value_changed()
1061 {
1062         header_->update();
1063         viewport_->update();
1064 }
1065
1066 void View::signals_changed()
1067 {
1068         using sigrok::Channel;
1069
1070         vector< shared_ptr<Channel> > channels;
1071         shared_ptr<sigrok::Device> sr_dev;
1072
1073         // Do we need to set the vertical scrollbar to its default position later?
1074         // We do if there are no traces, i.e. the scroll bar has no range set
1075         bool reset_scrollbar =
1076                 (scrollarea_.verticalScrollBar()->minimum() ==
1077                         scrollarea_.verticalScrollBar()->maximum());
1078
1079         if (!session_.device()) {
1080                 reset_scroll();
1081                 signals_.clear();
1082         } else {
1083                 sr_dev = session_.device()->device();
1084                 assert(sr_dev);
1085                 channels = sr_dev->channels();
1086         }
1087
1088         vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1089
1090         // Make a list of traces that are being added, and a list of traces
1091         // that are being removed
1092         const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1093         const set<shared_ptr<Trace>> prev_traces(
1094                 prev_trace_list.begin(), prev_trace_list.end());
1095
1096         set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1097
1098 #ifdef ENABLE_DECODE
1099         traces.insert(decode_traces_.begin(), decode_traces_.end());
1100 #endif
1101
1102         set< shared_ptr<Trace> > add_traces;
1103         set_difference(traces.begin(), traces.end(),
1104                 prev_traces.begin(), prev_traces.end(),
1105                 inserter(add_traces, add_traces.begin()));
1106
1107         set< shared_ptr<Trace> > remove_traces;
1108         set_difference(prev_traces.begin(), prev_traces.end(),
1109                 traces.begin(), traces.end(),
1110                 inserter(remove_traces, remove_traces.begin()));
1111
1112         // Make a look-up table of sigrok Channels to pulseview Signals
1113         unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1114                 signal_map;
1115         for (const shared_ptr<Signal> &sig : signals_)
1116                 signal_map[sig->base()] = sig;
1117
1118         // Populate channel groups
1119         if (sr_dev)
1120                 for (auto entry : sr_dev->channel_groups()) {
1121                         const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1122
1123                         if (group->channels().size() <= 1)
1124                                 continue;
1125
1126                         // Find best trace group to add to
1127                         TraceTreeItemOwner *owner = find_prevalent_trace_group(
1128                                 group, signal_map);
1129
1130                         // If there is no trace group, create one
1131                         shared_ptr<TraceGroup> new_trace_group;
1132                         if (!owner) {
1133                                 new_trace_group.reset(new TraceGroup());
1134                                 owner = new_trace_group.get();
1135                         }
1136
1137                         // Extract traces for the trace group, removing them from
1138                         // the add list
1139                         const vector< shared_ptr<Trace> > new_traces_in_group =
1140                                 extract_new_traces_for_channels(group->channels(),
1141                                         signal_map, add_traces);
1142
1143                         // Add the traces to the group
1144                         const pair<int, int> prev_v_extents = owner->v_extents();
1145                         int offset = prev_v_extents.second - prev_v_extents.first;
1146                         for (shared_ptr<Trace> trace : new_traces_in_group) {
1147                                 assert(trace);
1148                                 owner->add_child_item(trace);
1149
1150                                 const pair<int, int> extents = trace->v_extents();
1151                                 if (trace->enabled())
1152                                         offset += -extents.first;
1153                                 trace->force_to_v_offset(offset);
1154                                 if (trace->enabled())
1155                                         offset += extents.second;
1156                         }
1157
1158                         if (new_trace_group) {
1159                                 // Assign proper vertical offsets to each channel in the group
1160                                 new_trace_group->restack_items();
1161
1162                                 // If this is a new group, enqueue it in the new top level
1163                                 // items list
1164                                 if (!new_traces_in_group.empty())
1165                                         new_top_level_items.push_back(new_trace_group);
1166                         }
1167                 }
1168
1169         // Enqueue the remaining logic channels in a group
1170         vector< shared_ptr<Channel> > logic_channels;
1171         copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1172                 [](const shared_ptr<Channel>& c) {
1173                         return c->type() == sigrok::ChannelType::LOGIC; });
1174
1175         const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1176                 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1177
1178         if (non_grouped_logic_signals.size() > 0) {
1179                 const shared_ptr<TraceGroup> non_grouped_trace_group(
1180                         make_shared<TraceGroup>());
1181                 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1182                         non_grouped_trace_group->add_child_item(trace);
1183
1184                 non_grouped_trace_group->restack_items();
1185                 new_top_level_items.push_back(non_grouped_trace_group);
1186         }
1187
1188         // Enqueue the remaining channels as free ungrouped traces
1189         const vector< shared_ptr<Trace> > new_top_level_signals =
1190                 extract_new_traces_for_channels(channels, signal_map, add_traces);
1191         new_top_level_items.insert(new_top_level_items.end(),
1192                 new_top_level_signals.begin(), new_top_level_signals.end());
1193
1194         // Enqueue any remaining traces i.e. decode traces
1195         new_top_level_items.insert(new_top_level_items.end(),
1196                 add_traces.begin(), add_traces.end());
1197
1198         // Remove any removed traces
1199         for (shared_ptr<Trace> trace : remove_traces) {
1200                 TraceTreeItemOwner *const owner = trace->owner();
1201                 assert(owner);
1202                 owner->remove_child_item(trace);
1203         }
1204
1205         // Remove any empty trace groups
1206         for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1207                 if (group->child_items().size() == 0) {
1208                         remove_child_item(group);
1209                         group.reset();
1210                 }
1211
1212         // Add and position the pending top levels items
1213         int offset = v_extents().second;
1214         for (auto item : new_top_level_items) {
1215                 add_child_item(item);
1216
1217                 // Position the item after the last item or at the top if there is none
1218                 const pair<int, int> extents = item->v_extents();
1219
1220                 if (item->enabled())
1221                         offset += -extents.first;
1222
1223                 item->force_to_v_offset(offset);
1224
1225                 if (item->enabled())
1226                         offset += extents.second;
1227         }
1228
1229         update_layout();
1230
1231         header_->update();
1232         viewport_->update();
1233
1234         if (reset_scrollbar)
1235                 set_scroll_default();
1236 }
1237
1238 void View::capture_state_updated(int state)
1239 {
1240         if (state == Session::Running) {
1241                 set_time_unit(util::TimeUnit::Samples);
1242
1243                 trigger_markers_.clear();
1244         }
1245
1246         if (state == Session::Stopped) {
1247                 // After acquisition has stopped we need to re-calculate the ticks once
1248                 // as it's otherwise done when the user pans or zooms, which is too late
1249                 calculate_tick_spacing();
1250
1251                 // Reset "always zoom to fit", the acquisition has stopped
1252                 if (always_zoom_to_fit_) {
1253                         always_zoom_to_fit_ = false;
1254                         always_zoom_to_fit_changed(false);
1255                 }
1256         }
1257 }
1258
1259 void View::data_updated()
1260 {
1261         if (always_zoom_to_fit_ || sticky_scrolling_) {
1262                 if (!delayed_view_updater_.isActive())
1263                         delayed_view_updater_.start();
1264         } else {
1265                 determine_time_unit();
1266                 update_scroll();
1267                 ruler_->update();
1268                 viewport_->update();
1269         }
1270 }
1271
1272 void View::perform_delayed_view_update()
1273 {
1274         if (always_zoom_to_fit_)
1275                 zoom_fit(true);
1276
1277         if (sticky_scrolling_) {
1278                 // Make right side of the view sticky
1279                 double length = 0;
1280                 Timestamp offset;
1281                 get_scroll_layout(length, offset);
1282
1283                 const QSize areaSize = viewport_->size();
1284                 length = max(length - areaSize.width(), 0.0);
1285
1286                 set_offset(scale_ * length);
1287         }
1288
1289         determine_time_unit();
1290         update_scroll();
1291         ruler_->update();
1292         viewport_->update();
1293 }
1294
1295 void View::process_sticky_events()
1296 {
1297         if (sticky_events_ & TraceTreeItemHExtentsChanged)
1298                 update_layout();
1299         if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1300                 restack_all_trace_tree_items();
1301                 update_scroll();
1302         }
1303
1304         // Clear the sticky events
1305         sticky_events_ = 0;
1306 }
1307
1308 void View::on_hover_point_changed()
1309 {
1310         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1311                 list_by_type<TraceTreeItem>());
1312         for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1313                 r->hover_point_changed();
1314 }
1315
1316 } // namespace TraceView
1317 } // namespace views
1318 } // namespace pv