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