2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
32 #include <unordered_set>
34 #include <boost/archive/text_iarchive.hpp>
35 #include <boost/archive/text_oarchive.hpp>
36 #include <boost/serialization/serialization.hpp>
38 #include <QApplication>
40 #include <QFontMetrics>
41 #include <QMouseEvent>
43 #include <QVBoxLayout>
45 #include <libsigrokcxx/libsigrokcxx.hpp>
47 #include "analogsignal.hpp"
49 #include "logicsignal.hpp"
52 #include "tracegroup.hpp"
53 #include "triggermarker.hpp"
55 #include "viewport.hpp"
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"
65 #include "decodetrace.hpp"
68 using pv::data::SignalData;
69 using pv::data::Segment;
70 using pv::util::TimeUnit;
71 using pv::util::Timestamp;
73 using std::back_inserter;
79 using std::make_shared;
83 using std::set_difference;
84 using std::shared_ptr;
85 using std::stringstream;
86 using std::unordered_map;
87 using std::unordered_set;
94 const Timestamp View::MaxScale("1e9");
95 const Timestamp View::MinScale("1e-12");
97 const int View::MaxScrollValue = INT_MAX / 2;
99 const int View::ScaleUnits[3] = {1, 2, 5};
102 CustomScrollArea::CustomScrollArea(QWidget *parent) :
103 QAbstractScrollArea(parent)
107 bool CustomScrollArea::viewportEvent(QEvent *event)
109 switch (event->type()) {
111 case QEvent::MouseButtonPress:
112 case QEvent::MouseButtonRelease:
113 case QEvent::MouseButtonDblClick:
114 case QEvent::MouseMove:
116 case QEvent::TouchBegin:
117 case QEvent::TouchUpdate:
118 case QEvent::TouchEnd:
121 return QAbstractScrollArea::viewportEvent(event);
125 View::View(Session &session, bool is_main_view, QWidget *parent) :
126 ViewBase(session, is_main_view, parent),
127 splitter_(new QSplitter()),
128 segment_display_mode_(Trace::ShowLastSegmentOnly),
129 segment_selectable_(false),
132 updating_scroll_(false),
133 settings_restored_(false),
134 header_was_shrunk_(false),
135 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
136 always_zoom_to_fit_(false),
138 tick_prefix_(pv::util::SIPrefix::yocto),
140 time_unit_(util::TimeUnit::Time),
141 show_cursors_(false),
142 cursors_(new CursorPair(*this)),
143 next_flag_text_('A'),
145 hover_point_(-1, -1),
146 scroll_needs_defaults_(true),
148 scale_at_acq_start_(0),
149 offset_at_acq_start_(0),
150 suppress_zoom_to_fit_after_acq_(false)
152 QVBoxLayout *root_layout = new QVBoxLayout(this);
153 root_layout->setContentsMargins(0, 0, 0, 0);
154 root_layout->addWidget(splitter_);
156 viewport_ = new Viewport(*this);
157 scrollarea_ = new CustomScrollArea(splitter_);
158 scrollarea_->setViewport(viewport_);
159 scrollarea_->setFrameShape(QFrame::NoFrame);
161 ruler_ = new Ruler(*this);
163 header_ = new Header(*this);
164 header_->setMinimumWidth(10); // So that the arrow tips show at least
166 // We put the header into a simple layout so that we can add the top margin,
167 // allowing us to make it line up with the bottom of the ruler
168 QWidget *header_container = new QWidget();
169 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
170 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
171 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
172 header_layout->addWidget(header_);
174 // To let the ruler and scrollarea be on the same split pane, we need a layout
175 QWidget *trace_container = new QWidget();
176 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
177 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
178 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
179 trace_layout->setContentsMargins(0, 0, 0, 0);
180 trace_layout->addWidget(ruler_);
181 trace_layout->addWidget(scrollarea_);
183 splitter_->addWidget(header_container);
184 splitter_->addWidget(trace_container);
185 splitter_->setHandleWidth(1); // Don't show a visible rubber band
186 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
187 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
188 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
189 splitter_->setStretchFactor(1, 1); // when the entire view is resized
190 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
192 viewport_->installEventFilter(this);
193 ruler_->installEventFilter(this);
194 header_->installEventFilter(this);
196 // Set up settings and event handlers
197 GlobalSettings settings;
198 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
200 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
201 this, SLOT(h_scroll_value_changed(int)));
202 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
203 this, SLOT(v_scroll_value_changed()));
205 connect(header_, SIGNAL(selection_changed()),
206 ruler_, SLOT(clear_selection()));
207 connect(ruler_, SIGNAL(selection_changed()),
208 header_, SLOT(clear_selection()));
210 connect(header_, SIGNAL(selection_changed()),
211 this, SIGNAL(selection_changed()));
212 connect(ruler_, SIGNAL(selection_changed()),
213 this, SIGNAL(selection_changed()));
215 connect(splitter_, SIGNAL(splitterMoved(int, int)),
216 this, SLOT(on_splitter_moved()));
218 connect(&lazy_event_handler_, SIGNAL(timeout()),
219 this, SLOT(process_sticky_events()));
220 lazy_event_handler_.setSingleShot(true);
222 // Trigger the initial event manually. The default device has signals
223 // which were created before this object came into being
226 // make sure the transparent widgets are on the top
230 // Update the zoom state
231 calculate_tick_spacing();
233 // Make sure the standard bar's segment selector is in sync
234 set_segment_display_mode(segment_display_mode_);
237 Session& View::session()
242 const Session& View::session() const
247 unordered_set< shared_ptr<Signal> > View::signals() const
252 void View::clear_signals()
254 ViewBase::clear_signalbases();
258 void View::add_signal(const shared_ptr<Signal> signal)
260 ViewBase::add_signalbase(signal->base());
261 signals_.insert(signal);
263 signal->set_segment_display_mode(segment_display_mode_);
264 signal->set_current_segment(current_segment_);
266 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
267 this, SLOT(on_signal_name_changed()));
271 void View::clear_decode_signals()
273 decode_traces_.clear();
276 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
278 shared_ptr<DecodeTrace> d(
279 new DecodeTrace(session_, signal, decode_traces_.size()));
280 decode_traces_.push_back(d);
282 d->set_segment_display_mode(segment_display_mode_);
283 d->set_current_segment(current_segment_);
285 connect(signal.get(), SIGNAL(name_changed(const QString&)),
286 this, SLOT(on_signal_name_changed()));
289 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
291 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
292 if ((*i)->base() == signal) {
293 decode_traces_.erase(i);
305 const View* View::view() const
310 Viewport* View::viewport()
315 const Viewport* View::viewport() const
320 void View::save_settings(QSettings &settings) const
322 settings.setValue("scale", scale_);
323 settings.setValue("v_offset",
324 scrollarea_->verticalScrollBar()->sliderPosition());
326 settings.setValue("splitter_state", splitter_->saveState());
327 settings.setValue("segment_display_mode", segment_display_mode_);
330 boost::archive::text_oarchive oa(ss);
331 oa << boost::serialization::make_nvp("offset", offset_);
332 settings.setValue("offset", QString::fromStdString(ss.str()));
334 for (shared_ptr<Signal> signal : signals_) {
335 settings.beginGroup(signal->base()->internal_name());
336 signal->save_settings(settings);
341 void View::restore_settings(QSettings &settings)
343 // Note: It is assumed that this function is only called once,
344 // immediately after restoring a previous session.
346 if (settings.contains("scale"))
347 set_scale(settings.value("scale").toDouble());
349 if (settings.contains("offset")) {
350 util::Timestamp offset;
352 ss << settings.value("offset").toString().toStdString();
354 boost::archive::text_iarchive ia(ss);
355 ia >> boost::serialization::make_nvp("offset", offset);
360 if (settings.contains("splitter_state"))
361 splitter_->restoreState(settings.value("splitter_state").toByteArray());
363 if (settings.contains("segment_display_mode"))
364 set_segment_display_mode(
365 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
367 for (shared_ptr<Signal> signal : signals_) {
368 settings.beginGroup(signal->base()->internal_name());
369 signal->restore_settings(settings);
373 if (settings.contains("v_offset")) {
374 saved_v_offset_ = settings.value("v_offset").toInt();
375 set_v_offset(saved_v_offset_);
376 scroll_needs_defaults_ = false;
377 // Note: see eventFilter() for additional information
380 settings_restored_ = true;
381 suppress_zoom_to_fit_after_acq_ = true;
383 // Update the ruler so that it uses the new scale
384 calculate_tick_spacing();
387 vector< shared_ptr<TimeItem> > View::time_items() const
389 const vector<shared_ptr<Flag>> f(flags());
390 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
391 items.push_back(cursors_);
392 items.push_back(cursors_->first());
393 items.push_back(cursors_->second());
395 for (auto trigger_marker : trigger_markers_)
396 items.push_back(trigger_marker);
401 double View::scale() const
406 void View::set_scale(double scale)
408 if (scale_ != scale) {
414 const Timestamp& View::offset() const
419 void View::set_offset(const pv::util::Timestamp& offset)
421 if (offset_ != offset) {
427 int View::owner_visual_v_offset() const
429 return -scrollarea_->verticalScrollBar()->sliderPosition();
432 void View::set_v_offset(int offset)
434 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
439 unsigned int View::depth() const
444 uint32_t View::current_segment() const
446 return current_segment_;
449 pv::util::SIPrefix View::tick_prefix() const
454 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
456 if (tick_prefix_ != tick_prefix) {
457 tick_prefix_ = tick_prefix;
458 tick_prefix_changed();
462 unsigned int View::tick_precision() const
464 return tick_precision_;
467 void View::set_tick_precision(unsigned tick_precision)
469 if (tick_precision_ != tick_precision) {
470 tick_precision_ = tick_precision;
471 tick_precision_changed();
475 const pv::util::Timestamp& View::tick_period() const
480 void View::set_tick_period(const pv::util::Timestamp& tick_period)
482 if (tick_period_ != tick_period) {
483 tick_period_ = tick_period;
484 tick_period_changed();
488 TimeUnit View::time_unit() const
493 void View::set_time_unit(pv::util::TimeUnit time_unit)
495 if (time_unit_ != time_unit) {
496 time_unit_ = time_unit;
501 void View::set_current_segment(uint32_t segment_id)
503 current_segment_ = segment_id;
505 for (shared_ptr<Signal> signal : signals_)
506 signal->set_current_segment(current_segment_);
507 for (shared_ptr<DecodeTrace> dt : decode_traces_)
508 dt->set_current_segment(current_segment_);
512 segment_changed(segment_id);
515 bool View::segment_is_selectable() const
517 return segment_selectable_;
520 Trace::SegmentDisplayMode View::segment_display_mode() const
522 return segment_display_mode_;
525 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
527 segment_display_mode_ = mode;
529 for (shared_ptr<Signal> signal : signals_)
530 signal->set_segment_display_mode(mode);
532 uint32_t last_segment = session_.get_segment_count() - 1;
535 case Trace::ShowLastSegmentOnly:
536 if (current_segment_ != last_segment)
537 set_current_segment(last_segment);
540 case Trace::ShowLastCompleteSegmentOnly:
541 // Do nothing if we only have one segment so far
542 if (last_segment > 0) {
543 // If the last segment isn't complete, the previous one must be
544 uint32_t segment_id =
545 (session_.all_segments_complete(last_segment)) ?
546 last_segment : last_segment - 1;
548 if (current_segment_ != segment_id)
549 set_current_segment(segment_id);
553 case Trace::ShowSingleSegmentOnly:
554 case Trace::ShowAllSegments:
555 case Trace::ShowAccumulatedIntensity:
557 // Current segment remains as-is
561 segment_selectable_ = true;
563 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
564 segment_selectable_ = false;
568 segment_display_mode_changed((int)mode, segment_selectable_);
571 void View::zoom(double steps)
573 zoom(steps, viewport_->width() / 2);
576 void View::zoom(double steps, int offset)
578 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
581 void View::zoom_fit(bool gui_state)
583 // Act as one-shot when stopped, toggle along with the GUI otherwise
584 if (session_.get_capture_state() == Session::Stopped) {
585 always_zoom_to_fit_ = false;
586 always_zoom_to_fit_changed(false);
588 always_zoom_to_fit_ = gui_state;
589 always_zoom_to_fit_changed(gui_state);
592 const pair<Timestamp, Timestamp> extents = get_time_extents();
593 const Timestamp delta = extents.second - extents.first;
594 if (delta < Timestamp("1e-12"))
598 const int w = viewport_->width();
602 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
603 set_scale_offset(scale.convert_to<double>(), extents.first);
606 void View::zoom_one_to_one()
608 using pv::data::SignalData;
610 // Make a set of all the visible data objects
611 set< shared_ptr<SignalData> > visible_data = get_visible_data();
612 if (visible_data.empty())
616 const int w = viewport_->width();
620 set_zoom(1.0 / session_.get_samplerate(), w / 2);
623 void View::set_scale_offset(double scale, const Timestamp& offset)
625 // Disable sticky scrolling / always zoom to fit when acquisition runs
626 // and user drags the viewport
627 if ((scale_ == scale) && (offset_ != offset) &&
628 (session_.get_capture_state() == Session::Running)) {
630 if (sticky_scrolling_) {
631 sticky_scrolling_ = false;
632 sticky_scrolling_changed(false);
635 if (always_zoom_to_fit_) {
636 always_zoom_to_fit_ = false;
637 always_zoom_to_fit_changed(false);
644 calculate_tick_spacing();
651 set< shared_ptr<SignalData> > View::get_visible_data() const
653 // Make a set of all the visible data objects
654 set< shared_ptr<SignalData> > visible_data;
655 for (const shared_ptr<Signal> sig : signals_)
657 visible_data.insert(sig->data());
662 pair<Timestamp, Timestamp> View::get_time_extents() const
664 boost::optional<Timestamp> left_time, right_time;
665 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
666 for (const shared_ptr<SignalData> d : visible_data) {
667 const vector< shared_ptr<Segment> > segments = d->segments();
668 for (const shared_ptr<Segment> &s : segments) {
669 double samplerate = s->samplerate();
670 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
672 const Timestamp start_time = s->start_time();
673 left_time = left_time ?
674 min(*left_time, start_time) :
676 right_time = right_time ?
677 max(*right_time, start_time + d->max_sample_count() / samplerate) :
678 start_time + d->max_sample_count() / samplerate;
682 if (!left_time || !right_time)
683 return make_pair(0, 0);
685 assert(*left_time < *right_time);
686 return make_pair(*left_time, *right_time);
689 void View::enable_show_sampling_points(bool state)
696 void View::enable_show_analog_minor_grid(bool state)
703 void View::enable_coloured_bg(bool state)
705 coloured_bg_ = state;
709 bool View::coloured_bg() const
714 bool View::cursors_shown() const
716 return show_cursors_;
719 void View::show_cursors(bool show)
721 show_cursors_ = show;
726 void View::centre_cursors()
728 const double time_width = scale_ * viewport_->width();
729 cursors_->first()->set_time(offset_ + time_width * 0.4);
730 cursors_->second()->set_time(offset_ + time_width * 0.6);
735 shared_ptr<CursorPair> View::cursors() const
740 void View::add_flag(const Timestamp& time)
742 flags_.push_back(make_shared<Flag>(*this, time,
743 QString("%1").arg(next_flag_text_)));
745 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
746 (next_flag_text_ + 1);
748 time_item_appearance_changed(true, true);
751 void View::remove_flag(shared_ptr<Flag> flag)
754 time_item_appearance_changed(true, true);
757 vector< shared_ptr<Flag> > View::flags() const
759 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
760 stable_sort(flags.begin(), flags.end(),
761 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
762 return a->time() < b->time();
768 const QPoint& View::hover_point() const
773 void View::restack_all_trace_tree_items()
775 // Make a list of owners that is sorted from deepest first
776 const vector<shared_ptr<TraceTreeItem>> items(
777 list_by_type<TraceTreeItem>());
778 set< TraceTreeItemOwner* > owners;
779 for (const auto &r : items)
780 owners.insert(r->owner());
781 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
782 sort(sorted_owners.begin(), sorted_owners.end(),
783 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
784 return a->depth() > b->depth(); });
786 // Restack the items recursively
787 for (auto &o : sorted_owners)
790 // Animate the items to their destination
791 for (const auto &i : items)
792 i->animate_to_layout_v_offset();
795 void View::trigger_event(util::Timestamp location)
797 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
800 void View::get_scroll_layout(double &length, Timestamp &offset) const
802 const pair<Timestamp, Timestamp> extents = get_time_extents();
803 length = ((extents.second - extents.first) / scale_).convert_to<double>();
804 offset = offset_ / scale_;
807 void View::set_zoom(double scale, int offset)
809 // Reset the "always zoom to fit" feature as the user changed the zoom
810 always_zoom_to_fit_ = false;
811 always_zoom_to_fit_changed(false);
813 const Timestamp cursor_offset = offset_ + scale_ * offset;
814 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
815 const Timestamp new_offset = cursor_offset - new_scale * offset;
816 set_scale_offset(new_scale.convert_to<double>(), new_offset);
819 void View::calculate_tick_spacing()
821 const double SpacingIncrement = 10.0f;
822 const double MinValueSpacing = 40.0f;
824 // Figure out the highest numeric value visible on a label
825 const QSize areaSize = viewport_->size();
826 const Timestamp max_time = max(fabs(offset_),
827 fabs(offset_ + scale_ * areaSize.width()));
829 double min_width = SpacingIncrement;
830 double label_width, tick_period_width;
832 QFontMetrics m(QApplication::font());
834 // Copies of the member variables with the same name, used in the calculation
835 // and written back afterwards, so that we don't emit signals all the time
836 // during the calculation.
837 pv::util::Timestamp tick_period = tick_period_;
838 pv::util::SIPrefix tick_prefix = tick_prefix_;
839 unsigned tick_precision = tick_precision_;
842 const double min_period = scale_ * min_width;
844 const int order = (int)floorf(log10f(min_period));
845 const pv::util::Timestamp order_decimal =
846 pow(pv::util::Timestamp(10), order);
848 // Allow for a margin of error so that a scale unit of 1 can be used.
849 // Otherwise, for a SU of 1 the tick period will almost always be below
850 // the min_period by a small amount - and thus skipped in favor of 2.
851 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
852 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
853 double tp_with_margin;
854 unsigned int unit = 0;
857 tp_with_margin = order_decimal.convert_to<double>() *
858 (ScaleUnits[unit++] + tp_margin);
859 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
861 tick_period = order_decimal * ScaleUnits[unit - 1];
862 tick_prefix = static_cast<pv::util::SIPrefix>(
863 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
865 // Precision is the number of fractional digits required, not
866 // taking the prefix into account (and it must never be negative)
867 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
869 tick_period_width = (tick_period / scale_).convert_to<double>();
871 const QString label_text = Ruler::format_time_with_distance(
872 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
874 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
875 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
878 min_width += SpacingIncrement;
879 } while (tick_period_width < label_width);
881 set_tick_period(tick_period);
882 set_tick_prefix(tick_prefix);
883 set_tick_precision(tick_precision);
886 void View::adjust_top_margin()
890 const QSize areaSize = viewport_->size();
892 const pair<int, int> extents = v_extents();
893 const int top_margin = owner_visual_v_offset() + extents.first;
894 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
896 // Do we have empty space at the top while the last trace goes out of screen?
897 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
898 const int trace_height = extents.second - extents.first;
900 // Center everything vertically if there is enough space
901 if (areaSize.height() >= trace_height)
902 set_v_offset(extents.first -
903 ((areaSize.height() - trace_height) / 2));
905 // Remove the top margin to make as many traces fit on screen as possible
906 set_v_offset(extents.first);
910 void View::update_scroll()
913 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
914 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
916 const QSize areaSize = viewport_->size();
918 // Set the horizontal scroll bar
921 get_scroll_layout(length, offset);
922 length = max(length - areaSize.width(), 0.0);
924 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
926 hscrollbar->setPageStep(areaSize.width() / 2);
927 hscrollbar->setSingleStep(major_tick_distance);
929 updating_scroll_ = true;
931 if (length < MaxScrollValue) {
932 hscrollbar->setRange(0, length);
933 hscrollbar->setSliderPosition(offset.convert_to<double>());
935 hscrollbar->setRange(0, MaxScrollValue);
936 hscrollbar->setSliderPosition(
937 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
940 updating_scroll_ = false;
942 // Set the vertical scrollbar
943 vscrollbar->setPageStep(areaSize.height());
944 vscrollbar->setSingleStep(areaSize.height() / 8);
946 const pair<int, int> extents = v_extents();
948 // Don't change the scrollbar range if there are no traces
949 if (extents.first != extents.second)
950 vscrollbar->setRange(extents.first - areaSize.height(),
953 if (scroll_needs_defaults_)
954 set_scroll_default();
957 void View::reset_scroll()
959 scrollarea_->verticalScrollBar()->setRange(0, 0);
962 void View::set_scroll_default()
966 const QSize areaSize = viewport_->size();
968 const pair<int, int> extents = v_extents();
969 const int trace_height = extents.second - extents.first;
971 // Do all traces fit in the view?
972 if (areaSize.height() >= trace_height)
973 // Center all traces vertically
974 set_v_offset(extents.first -
975 ((areaSize.height() - trace_height) / 2));
977 // Put the first trace at the top, letting the bottom ones overflow
978 set_v_offset(extents.first);
981 void View::determine_if_header_was_shrunk()
983 const int header_pane_width = splitter_->sizes().front();
984 const int header_width = header_->extended_size_hint().width();
986 // Allow for a slight margin of error so that we also accept
987 // slight differences when e.g. a label name change increased
989 header_was_shrunk_ = (header_pane_width < (header_width - 10));
992 void View::resize_header_to_fit()
994 // Setting the maximum width of the header widget doesn't work as
995 // expected because the splitter would allow the user to make the
996 // pane wider than that, creating empty space as a result.
997 // To make this work, we stricly enforce the maximum width by
998 // expanding the header unless the user shrunk it on purpose.
999 // As we're then setting the width of the header pane, we set the
1000 // splitter to the maximum allowed position.
1002 int splitter_area_width = 0;
1003 for (int w : splitter_->sizes())
1004 splitter_area_width += w;
1006 // Make sure the header has enough horizontal space to show all labels fully
1007 QList<int> pane_sizes;
1008 pane_sizes.push_back(header_->extended_size_hint().width());
1009 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1010 splitter_->setSizes(pane_sizes);
1013 void View::update_layout()
1018 TraceTreeItemOwner* View::find_prevalent_trace_group(
1019 const shared_ptr<sigrok::ChannelGroup> &group,
1020 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1025 unordered_set<TraceTreeItemOwner*> owners;
1026 vector<TraceTreeItemOwner*> owner_list;
1028 // Make a set and a list of all the owners
1029 for (const auto &channel : group->channels()) {
1030 for (auto entry : signal_map) {
1031 if (entry.first->channel() == channel) {
1032 TraceTreeItemOwner *const o = (entry.second)->owner();
1033 owner_list.push_back(o);
1039 // Iterate through the list of owners, and find the most prevalent
1040 size_t max_prevalence = 0;
1041 TraceTreeItemOwner *prevalent_owner = nullptr;
1042 for (TraceTreeItemOwner *owner : owners) {
1043 const size_t prevalence = count_if(
1044 owner_list.begin(), owner_list.end(),
1045 [&](TraceTreeItemOwner *o) { return o == owner; });
1046 if (prevalence > max_prevalence) {
1047 max_prevalence = prevalence;
1048 prevalent_owner = owner;
1052 return prevalent_owner;
1055 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1056 const vector< shared_ptr<sigrok::Channel> > &channels,
1057 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1059 set< shared_ptr<Trace> > &add_list)
1061 vector< shared_ptr<Trace> > filtered_traces;
1063 for (const auto &channel : channels) {
1064 for (auto entry : signal_map) {
1065 if (entry.first->channel() == channel) {
1066 shared_ptr<Trace> trace = entry.second;
1067 const auto list_iter = add_list.find(trace);
1068 if (list_iter == add_list.end())
1071 filtered_traces.push_back(trace);
1072 add_list.erase(list_iter);
1077 return filtered_traces;
1080 void View::determine_time_unit()
1082 // Check whether we know the sample rate and hence can use time as the unit
1083 if (time_unit_ == util::TimeUnit::Samples) {
1084 // Check all signals but...
1085 for (const shared_ptr<Signal> signal : signals_) {
1086 const shared_ptr<SignalData> data = signal->data();
1088 // ...only check first segment of each
1089 const vector< shared_ptr<Segment> > segments = data->segments();
1090 if (!segments.empty())
1091 if (segments[0]->samplerate()) {
1092 set_time_unit(util::TimeUnit::Time);
1099 bool View::eventFilter(QObject *object, QEvent *event)
1101 const QEvent::Type type = event->type();
1102 if (type == QEvent::MouseMove) {
1104 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1105 if (object == viewport_)
1106 hover_point_ = mouse_event->pos();
1107 else if (object == ruler_)
1108 hover_point_ = QPoint(mouse_event->x(), 0);
1109 else if (object == header_)
1110 hover_point_ = QPoint(0, mouse_event->y());
1112 hover_point_ = QPoint(-1, -1);
1114 update_hover_point();
1116 } else if (type == QEvent::Leave) {
1117 hover_point_ = QPoint(-1, -1);
1118 update_hover_point();
1119 } else if (type == QEvent::Show) {
1121 // This is somewhat of a hack, unfortunately. We cannot use
1122 // set_v_offset() from within restore_settings() as the view
1123 // at that point is neither visible nor properly sized.
1124 // This is the least intrusive workaround I could come up
1125 // with: set the vertical offset (or scroll defaults) when
1126 // the view is shown, which happens after all widgets were
1127 // resized to their final sizes.
1130 if (settings_restored_)
1131 determine_if_header_was_shrunk();
1133 resize_header_to_fit();
1135 if (scroll_needs_defaults_) {
1136 set_scroll_default();
1137 scroll_needs_defaults_ = false;
1140 if (saved_v_offset_) {
1141 set_v_offset(saved_v_offset_);
1142 saved_v_offset_ = 0;
1146 return QObject::eventFilter(object, event);
1149 void View::resizeEvent(QResizeEvent* event)
1151 // Only adjust the top margin if we shrunk vertically
1152 if (event->size().height() < event->oldSize().height())
1153 adjust_top_margin();
1158 void View::update_hover_point()
1160 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1161 list_by_type<TraceTreeItem>());
1162 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1163 r->hover_point_changed(hover_point_);
1165 hover_point_changed(hover_point_);
1168 void View::row_item_appearance_changed(bool label, bool content)
1173 viewport_->update();
1176 void View::time_item_appearance_changed(bool label, bool content)
1181 // Make sure the header pane width is updated, too
1186 viewport_->update();
1189 void View::extents_changed(bool horz, bool vert)
1192 (horz ? TraceTreeItemHExtentsChanged : 0) |
1193 (vert ? TraceTreeItemVExtentsChanged : 0);
1195 lazy_event_handler_.start();
1198 void View::on_signal_name_changed()
1200 if (!header_was_shrunk_)
1201 resize_header_to_fit();
1204 void View::on_splitter_moved()
1206 // The header can only shrink when the splitter is moved manually
1207 determine_if_header_was_shrunk();
1209 if (!header_was_shrunk_)
1210 resize_header_to_fit();
1213 void View::h_scroll_value_changed(int value)
1215 if (updating_scroll_)
1218 // Disable sticky scrolling when user moves the horizontal scroll bar
1219 // during a running acquisition
1220 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1221 sticky_scrolling_ = false;
1222 sticky_scrolling_changed(false);
1225 const int range = scrollarea_->horizontalScrollBar()->maximum();
1226 if (range < MaxScrollValue)
1227 set_offset(scale_ * value);
1231 get_scroll_layout(length, offset);
1232 set_offset(scale_ * length * value / MaxScrollValue);
1236 viewport_->update();
1239 void View::v_scroll_value_changed()
1242 viewport_->update();
1245 void View::signals_changed()
1247 using sigrok::Channel;
1249 vector< shared_ptr<Channel> > channels;
1250 shared_ptr<sigrok::Device> sr_dev;
1251 bool signals_added_or_removed = false;
1253 // Do we need to set the vertical scrollbar to its default position later?
1254 // We do if there are no traces, i.e. the scroll bar has no range set
1255 bool reset_scrollbar =
1256 (scrollarea_->verticalScrollBar()->minimum() ==
1257 scrollarea_->verticalScrollBar()->maximum());
1259 if (!session_.device()) {
1263 sr_dev = session_.device()->device();
1265 channels = sr_dev->channels();
1268 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1270 // Make a list of traces that are being added, and a list of traces
1271 // that are being removed
1272 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1273 const set<shared_ptr<Trace>> prev_traces(
1274 prev_trace_list.begin(), prev_trace_list.end());
1276 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1278 #ifdef ENABLE_DECODE
1279 traces.insert(decode_traces_.begin(), decode_traces_.end());
1282 set< shared_ptr<Trace> > add_traces;
1283 set_difference(traces.begin(), traces.end(),
1284 prev_traces.begin(), prev_traces.end(),
1285 inserter(add_traces, add_traces.begin()));
1287 set< shared_ptr<Trace> > remove_traces;
1288 set_difference(prev_traces.begin(), prev_traces.end(),
1289 traces.begin(), traces.end(),
1290 inserter(remove_traces, remove_traces.begin()));
1292 // Make a look-up table of sigrok Channels to pulseview Signals
1293 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1295 for (const shared_ptr<Signal> &sig : signals_)
1296 signal_map[sig->base()] = sig;
1298 // Populate channel groups
1300 for (auto entry : sr_dev->channel_groups()) {
1301 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1303 if (group->channels().size() <= 1)
1306 // Find best trace group to add to
1307 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1310 // If there is no trace group, create one
1311 shared_ptr<TraceGroup> new_trace_group;
1313 new_trace_group.reset(new TraceGroup());
1314 owner = new_trace_group.get();
1317 // Extract traces for the trace group, removing them from
1319 const vector< shared_ptr<Trace> > new_traces_in_group =
1320 extract_new_traces_for_channels(group->channels(),
1321 signal_map, add_traces);
1323 // Add the traces to the group
1324 const pair<int, int> prev_v_extents = owner->v_extents();
1325 int offset = prev_v_extents.second - prev_v_extents.first;
1326 for (shared_ptr<Trace> trace : new_traces_in_group) {
1328 owner->add_child_item(trace);
1330 const pair<int, int> extents = trace->v_extents();
1331 if (trace->enabled())
1332 offset += -extents.first;
1333 trace->force_to_v_offset(offset);
1334 if (trace->enabled())
1335 offset += extents.second;
1338 if (new_trace_group) {
1339 // Assign proper vertical offsets to each channel in the group
1340 new_trace_group->restack_items();
1342 // If this is a new group, enqueue it in the new top level
1344 if (!new_traces_in_group.empty())
1345 new_top_level_items.push_back(new_trace_group);
1349 // Enqueue the remaining logic channels in a group
1350 vector< shared_ptr<Channel> > logic_channels;
1351 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1352 [](const shared_ptr<Channel>& c) {
1353 return c->type() == sigrok::ChannelType::LOGIC; });
1355 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1356 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1358 if (non_grouped_logic_signals.size() > 0) {
1359 const shared_ptr<TraceGroup> non_grouped_trace_group(
1360 make_shared<TraceGroup>());
1361 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1362 non_grouped_trace_group->add_child_item(trace);
1364 non_grouped_trace_group->restack_items();
1365 new_top_level_items.push_back(non_grouped_trace_group);
1368 // Enqueue the remaining channels as free ungrouped traces
1369 const vector< shared_ptr<Trace> > new_top_level_signals =
1370 extract_new_traces_for_channels(channels, signal_map, add_traces);
1371 new_top_level_items.insert(new_top_level_items.end(),
1372 new_top_level_signals.begin(), new_top_level_signals.end());
1374 // Enqueue any remaining traces i.e. decode traces
1375 new_top_level_items.insert(new_top_level_items.end(),
1376 add_traces.begin(), add_traces.end());
1378 // Remove any removed traces
1379 for (shared_ptr<Trace> trace : remove_traces) {
1380 TraceTreeItemOwner *const owner = trace->owner();
1382 owner->remove_child_item(trace);
1383 signals_added_or_removed = true;
1386 // Remove any empty trace groups
1387 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1388 if (group->child_items().size() == 0) {
1389 remove_child_item(group);
1393 // Add and position the pending top levels items
1394 int offset = v_extents().second;
1395 for (auto item : new_top_level_items) {
1396 add_child_item(item);
1398 // Position the item after the last item or at the top if there is none
1399 const pair<int, int> extents = item->v_extents();
1401 if (item->enabled())
1402 offset += -extents.first;
1404 item->force_to_v_offset(offset);
1406 if (item->enabled())
1407 offset += extents.second;
1408 signals_added_or_removed = true;
1412 if (signals_added_or_removed && !header_was_shrunk_)
1413 resize_header_to_fit();
1418 viewport_->update();
1420 if (reset_scrollbar)
1421 set_scroll_default();
1424 void View::capture_state_updated(int state)
1426 GlobalSettings settings;
1428 if (state == Session::Running) {
1429 set_time_unit(util::TimeUnit::Samples);
1431 trigger_markers_.clear();
1433 scale_at_acq_start_ = scale_;
1434 offset_at_acq_start_ = offset_;
1436 // Activate "always zoom to fit" if the setting is enabled and we're
1437 // the main view of this session (other trace views may be used for
1438 // zooming and we don't want to mess them up)
1439 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1440 if (is_main_view_ && state) {
1441 always_zoom_to_fit_ = true;
1442 always_zoom_to_fit_changed(always_zoom_to_fit_);
1445 // Enable sticky scrolling if the setting is enabled
1446 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1448 // Reset all traces to segment 0
1449 current_segment_ = 0;
1450 set_current_segment(current_segment_);
1453 if (state == Session::Stopped) {
1454 // After acquisition has stopped we need to re-calculate the ticks once
1455 // as it's otherwise done when the user pans or zooms, which is too late
1456 calculate_tick_spacing();
1458 // Reset "always zoom to fit", the acquisition has stopped
1459 if (always_zoom_to_fit_) {
1460 // Perform a final zoom-to-fit before disabling
1461 zoom_fit(always_zoom_to_fit_);
1462 always_zoom_to_fit_ = false;
1463 always_zoom_to_fit_changed(always_zoom_to_fit_);
1466 bool zoom_to_fit_after_acq =
1467 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1469 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1470 // we didn't restore settings in the meanwhile
1471 if (zoom_to_fit_after_acq &&
1472 !suppress_zoom_to_fit_after_acq_ &&
1473 (scale_ == scale_at_acq_start_) &&
1474 (offset_ == offset_at_acq_start_))
1475 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1477 suppress_zoom_to_fit_after_acq_ = false;
1481 void View::on_new_segment(int new_segment_id)
1483 on_segment_changed(new_segment_id);
1486 void View::on_segment_completed(int segment_id)
1488 on_segment_changed(segment_id);
1491 void View::on_segment_changed(int segment)
1493 switch (segment_display_mode_) {
1494 case Trace::ShowLastSegmentOnly:
1495 case Trace::ShowSingleSegmentOnly:
1496 set_current_segment(segment);
1499 case Trace::ShowLastCompleteSegmentOnly:
1500 // Only update if all segments are complete
1501 if (session_.all_segments_complete(segment))
1502 set_current_segment(segment);
1505 case Trace::ShowAllSegments:
1506 case Trace::ShowAccumulatedIntensity:
1512 void View::perform_delayed_view_update()
1514 if (always_zoom_to_fit_) {
1516 } else if (sticky_scrolling_) {
1517 // Make right side of the view sticky
1520 get_scroll_layout(length, offset);
1522 const QSize areaSize = viewport_->size();
1523 length = max(length - areaSize.width(), 0.0);
1525 set_offset(scale_ * length);
1528 determine_time_unit();
1531 viewport_->update();
1534 void View::process_sticky_events()
1536 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1538 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1539 restack_all_trace_tree_items();
1543 // Clear the sticky events
1547 } // namespace trace
1548 } // namespace views