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