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