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