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