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