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;
82 using std::placeholders::_1;
84 using std::set_difference;
85 using std::shared_ptr;
86 using std::stringstream;
87 using std::unordered_map;
88 using std::unordered_set;
95 const Timestamp View::MaxScale("1e9");
96 const Timestamp View::MinScale("1e-12");
98 const int View::MaxScrollValue = INT_MAX / 2;
100 const int View::ScaleUnits[3] = {1, 2, 5};
103 CustomScrollArea::CustomScrollArea(QWidget *parent) :
104 QAbstractScrollArea(parent)
108 bool CustomScrollArea::viewportEvent(QEvent *event)
110 switch (event->type()) {
112 case QEvent::MouseButtonPress:
113 case QEvent::MouseButtonRelease:
114 case QEvent::MouseButtonDblClick:
115 case QEvent::MouseMove:
117 case QEvent::TouchBegin:
118 case QEvent::TouchUpdate:
119 case QEvent::TouchEnd:
122 return QAbstractScrollArea::viewportEvent(event);
126 View::View(Session &session, bool is_main_view, QWidget *parent) :
127 ViewBase(session, is_main_view, parent),
128 splitter_(new QSplitter()),
129 segment_display_mode_(Trace::ShowLastSegmentOnly),
130 segment_selectable_(false),
134 updating_scroll_(false),
135 settings_restored_(false),
136 header_was_shrunk_(false),
137 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
138 always_zoom_to_fit_(false),
140 tick_prefix_(pv::util::SIPrefix::yocto),
142 time_unit_(util::TimeUnit::Time),
143 show_cursors_(false),
144 cursors_(new CursorPair(*this)),
145 next_flag_text_('A'),
147 hover_point_(-1, -1),
148 scroll_needs_defaults_(true),
150 scale_at_acq_start_(0),
151 offset_at_acq_start_(0),
152 suppress_zoom_to_fit_after_acq_(false)
154 QVBoxLayout *root_layout = new QVBoxLayout(this);
155 root_layout->setContentsMargins(0, 0, 0, 0);
156 root_layout->addWidget(splitter_);
158 viewport_ = new Viewport(*this);
159 scrollarea_ = new CustomScrollArea(splitter_);
160 scrollarea_->setViewport(viewport_);
161 scrollarea_->setFrameShape(QFrame::NoFrame);
163 ruler_ = new Ruler(*this);
165 header_ = new Header(*this);
166 header_->setMinimumWidth(10); // So that the arrow tips show at least
168 // We put the header into a simple layout so that we can add the top margin,
169 // allowing us to make it line up with the bottom of the ruler
170 QWidget *header_container = new QWidget();
171 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
172 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
173 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
174 header_layout->addWidget(header_);
176 // To let the ruler and scrollarea be on the same split pane, we need a layout
177 QWidget *trace_container = new QWidget();
178 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
179 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
180 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
181 trace_layout->setContentsMargins(0, 0, 0, 0);
182 trace_layout->addWidget(ruler_);
183 trace_layout->addWidget(scrollarea_);
185 splitter_->addWidget(header_container);
186 splitter_->addWidget(trace_container);
187 splitter_->setHandleWidth(1); // Don't show a visible rubber band
188 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
189 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
190 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
191 splitter_->setStretchFactor(1, 1); // when the entire view is resized
192 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
194 viewport_->installEventFilter(this);
195 ruler_->installEventFilter(this);
196 header_->installEventFilter(this);
198 // Set up settings and event handlers
199 GlobalSettings settings;
200 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
202 GlobalSettings::register_change_handler(GlobalSettings::Key_View_TriggerIsZeroTime,
203 bind(&View::on_settingViewTriggerIsZeroTime_changed, this, _1));
205 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
206 this, SLOT(h_scroll_value_changed(int)));
207 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
208 this, SLOT(v_scroll_value_changed()));
210 connect(header_, SIGNAL(selection_changed()),
211 ruler_, SLOT(clear_selection()));
212 connect(ruler_, SIGNAL(selection_changed()),
213 header_, SLOT(clear_selection()));
215 connect(header_, SIGNAL(selection_changed()),
216 this, SIGNAL(selection_changed()));
217 connect(ruler_, SIGNAL(selection_changed()),
218 this, SIGNAL(selection_changed()));
220 connect(splitter_, SIGNAL(splitterMoved(int, int)),
221 this, SLOT(on_splitter_moved()));
223 connect(&lazy_event_handler_, SIGNAL(timeout()),
224 this, SLOT(process_sticky_events()));
225 lazy_event_handler_.setSingleShot(true);
227 // Trigger the initial event manually. The default device has signals
228 // which were created before this object came into being
231 // make sure the transparent widgets are on the top
235 // Update the zoom state
236 calculate_tick_spacing();
238 // Make sure the standard bar's segment selector is in sync
239 set_segment_display_mode(segment_display_mode_);
242 Session& View::session()
247 const Session& View::session() const
252 unordered_set< shared_ptr<Signal> > View::signals() const
257 void View::clear_signals()
259 ViewBase::clear_signalbases();
263 void View::add_signal(const shared_ptr<Signal> signal)
265 ViewBase::add_signalbase(signal->base());
266 signals_.insert(signal);
268 signal->set_segment_display_mode(segment_display_mode_);
269 signal->set_current_segment(current_segment_);
271 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
272 this, SLOT(on_signal_name_changed()));
276 void View::clear_decode_signals()
278 decode_traces_.clear();
281 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
283 shared_ptr<DecodeTrace> d(
284 new DecodeTrace(session_, signal, decode_traces_.size()));
285 decode_traces_.push_back(d);
287 d->set_segment_display_mode(segment_display_mode_);
288 d->set_current_segment(current_segment_);
290 connect(signal.get(), SIGNAL(name_changed(const QString&)),
291 this, SLOT(on_signal_name_changed()));
294 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
296 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
297 if ((*i)->base() == signal) {
298 decode_traces_.erase(i);
310 const View* View::view() const
315 Viewport* View::viewport()
320 const Viewport* View::viewport() const
325 void View::save_settings(QSettings &settings) const
327 settings.setValue("scale", scale_);
328 settings.setValue("v_offset",
329 scrollarea_->verticalScrollBar()->sliderPosition());
331 settings.setValue("splitter_state", splitter_->saveState());
332 settings.setValue("segment_display_mode", segment_display_mode_);
336 boost::archive::text_oarchive oa(ss);
337 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
338 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
342 boost::archive::text_oarchive oa(ss);
343 oa << boost::serialization::make_nvp("offset", offset_);
344 settings.setValue("offset", QString::fromStdString(ss.str()));
347 for (shared_ptr<Signal> signal : signals_) {
348 settings.beginGroup(signal->base()->internal_name());
349 signal->save_settings(settings);
354 void View::restore_settings(QSettings &settings)
356 // Note: It is assumed that this function is only called once,
357 // immediately after restoring a previous session.
359 if (settings.contains("scale"))
360 set_scale(settings.value("scale").toDouble());
362 if (settings.contains("ruler_shift")) {
363 util::Timestamp shift;
365 ss << settings.value("ruler_shift").toString().toStdString();
367 boost::archive::text_iarchive ia(ss);
368 ia >> boost::serialization::make_nvp("ruler_shift", shift);
370 ruler_shift_ = shift;
373 if (settings.contains("offset")) {
374 util::Timestamp offset;
376 ss << settings.value("offset").toString().toStdString();
378 boost::archive::text_iarchive ia(ss);
379 ia >> boost::serialization::make_nvp("offset", offset);
381 // This also updates ruler_offset_
385 if (settings.contains("splitter_state"))
386 splitter_->restoreState(settings.value("splitter_state").toByteArray());
388 if (settings.contains("segment_display_mode"))
389 set_segment_display_mode(
390 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
392 for (shared_ptr<Signal> signal : signals_) {
393 settings.beginGroup(signal->base()->internal_name());
394 signal->restore_settings(settings);
398 if (settings.contains("v_offset")) {
399 saved_v_offset_ = settings.value("v_offset").toInt();
400 set_v_offset(saved_v_offset_);
401 scroll_needs_defaults_ = false;
402 // Note: see eventFilter() for additional information
405 settings_restored_ = true;
406 suppress_zoom_to_fit_after_acq_ = true;
408 // Update the ruler so that it uses the new scale
409 calculate_tick_spacing();
412 vector< shared_ptr<TimeItem> > View::time_items() const
414 const vector<shared_ptr<Flag>> f(flags());
415 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
416 items.push_back(cursors_);
417 items.push_back(cursors_->first());
418 items.push_back(cursors_->second());
420 for (auto trigger_marker : trigger_markers_)
421 items.push_back(trigger_marker);
426 double View::scale() const
431 void View::set_scale(double scale)
433 if (scale_ != scale) {
439 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
441 if ((offset_ != offset) || force_update) {
443 ruler_offset_ = offset_ + ruler_shift_;
448 const Timestamp& View::offset() const
453 const Timestamp& View::ruler_offset() const
455 return ruler_offset_;
458 void View::set_zero_position(pv::util::Timestamp& position)
460 ruler_shift_ = -position;
462 // Force an immediate update of the offsets
463 set_offset(offset_, true);
467 void View::reset_zero_position()
471 // Force an immediate update of the offsets
472 set_offset(offset_, true);
476 int View::owner_visual_v_offset() const
478 return -scrollarea_->verticalScrollBar()->sliderPosition();
481 void View::set_v_offset(int offset)
483 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
488 unsigned int View::depth() const
493 uint32_t View::current_segment() const
495 return current_segment_;
498 pv::util::SIPrefix View::tick_prefix() const
503 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
505 if (tick_prefix_ != tick_prefix) {
506 tick_prefix_ = tick_prefix;
507 tick_prefix_changed();
511 unsigned int View::tick_precision() const
513 return tick_precision_;
516 void View::set_tick_precision(unsigned tick_precision)
518 if (tick_precision_ != tick_precision) {
519 tick_precision_ = tick_precision;
520 tick_precision_changed();
524 const pv::util::Timestamp& View::tick_period() const
529 unsigned int View::minor_tick_count() const
531 return minor_tick_count_;
534 void View::set_tick_period(const pv::util::Timestamp& tick_period)
536 if (tick_period_ != tick_period) {
537 tick_period_ = tick_period;
538 tick_period_changed();
542 TimeUnit View::time_unit() const
547 void View::set_time_unit(pv::util::TimeUnit time_unit)
549 if (time_unit_ != time_unit) {
550 time_unit_ = time_unit;
555 void View::set_current_segment(uint32_t segment_id)
557 current_segment_ = segment_id;
559 for (shared_ptr<Signal> signal : signals_)
560 signal->set_current_segment(current_segment_);
561 for (shared_ptr<DecodeTrace> dt : decode_traces_)
562 dt->set_current_segment(current_segment_);
564 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
566 trigger_markers_.clear();
567 for (util::Timestamp timestamp : triggers)
568 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
570 // When enabled, the first trigger for this segment is used as the zero position
571 GlobalSettings settings;
572 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
574 if (trigger_is_zero_time && (triggers.size() > 0))
575 set_zero_position(triggers.front());
579 segment_changed(segment_id);
582 bool View::segment_is_selectable() const
584 return segment_selectable_;
587 Trace::SegmentDisplayMode View::segment_display_mode() const
589 return segment_display_mode_;
592 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
594 trigger_markers_.clear();
596 segment_display_mode_ = mode;
598 for (shared_ptr<Signal> signal : signals_)
599 signal->set_segment_display_mode(mode);
601 uint32_t last_segment = session_.get_segment_count() - 1;
604 case Trace::ShowLastSegmentOnly:
605 if (current_segment_ != last_segment)
606 set_current_segment(last_segment);
609 case Trace::ShowLastCompleteSegmentOnly:
610 // Do nothing if we only have one segment so far
611 if (last_segment > 0) {
612 // If the last segment isn't complete, the previous one must be
613 uint32_t segment_id =
614 (session_.all_segments_complete(last_segment)) ?
615 last_segment : last_segment - 1;
617 if (current_segment_ != segment_id)
618 set_current_segment(segment_id);
622 case Trace::ShowSingleSegmentOnly:
623 case Trace::ShowAllSegments:
624 case Trace::ShowAccumulatedIntensity:
626 // Current segment remains as-is
630 segment_selectable_ = true;
632 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
633 segment_selectable_ = false;
637 segment_display_mode_changed((int)mode, segment_selectable_);
640 void View::zoom(double steps)
642 zoom(steps, viewport_->width() / 2);
645 void View::zoom(double steps, int offset)
647 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
650 void View::zoom_fit(bool gui_state)
652 // Act as one-shot when stopped, toggle along with the GUI otherwise
653 if (session_.get_capture_state() == Session::Stopped) {
654 always_zoom_to_fit_ = false;
655 always_zoom_to_fit_changed(false);
657 always_zoom_to_fit_ = gui_state;
658 always_zoom_to_fit_changed(gui_state);
661 const pair<Timestamp, Timestamp> extents = get_time_extents();
662 const Timestamp delta = extents.second - extents.first;
663 if (delta < Timestamp("1e-12"))
667 const int w = viewport_->width();
671 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
672 set_scale_offset(scale.convert_to<double>(), extents.first);
675 void View::zoom_one_to_one()
677 using pv::data::SignalData;
679 // Make a set of all the visible data objects
680 set< shared_ptr<SignalData> > visible_data = get_visible_data();
681 if (visible_data.empty())
685 const int w = viewport_->width();
689 set_zoom(1.0 / session_.get_samplerate(), w / 2);
692 void View::set_scale_offset(double scale, const Timestamp& offset)
694 // Disable sticky scrolling / always zoom to fit when acquisition runs
695 // and user drags the viewport
696 if ((scale_ == scale) && (offset_ != offset) &&
697 (session_.get_capture_state() == Session::Running)) {
699 if (sticky_scrolling_) {
700 sticky_scrolling_ = false;
701 sticky_scrolling_changed(false);
704 if (always_zoom_to_fit_) {
705 always_zoom_to_fit_ = false;
706 always_zoom_to_fit_changed(false);
713 calculate_tick_spacing();
720 set< shared_ptr<SignalData> > View::get_visible_data() const
722 // Make a set of all the visible data objects
723 set< shared_ptr<SignalData> > visible_data;
724 for (const shared_ptr<Signal> sig : signals_)
726 visible_data.insert(sig->data());
731 pair<Timestamp, Timestamp> View::get_time_extents() const
733 boost::optional<Timestamp> left_time, right_time;
734 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
735 for (const shared_ptr<SignalData> d : visible_data) {
736 const vector< shared_ptr<Segment> > segments = d->segments();
737 for (const shared_ptr<Segment> &s : segments) {
738 double samplerate = s->samplerate();
739 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
741 const Timestamp start_time = s->start_time();
742 left_time = left_time ?
743 min(*left_time, start_time) :
745 right_time = right_time ?
746 max(*right_time, start_time + d->max_sample_count() / samplerate) :
747 start_time + d->max_sample_count() / samplerate;
751 if (!left_time || !right_time)
752 return make_pair(0, 0);
754 assert(*left_time < *right_time);
755 return make_pair(*left_time, *right_time);
758 void View::enable_show_sampling_points(bool state)
765 void View::enable_show_analog_minor_grid(bool state)
772 void View::enable_coloured_bg(bool state)
774 coloured_bg_ = state;
778 bool View::coloured_bg() const
783 bool View::cursors_shown() const
785 return show_cursors_;
788 void View::show_cursors(bool show)
790 show_cursors_ = show;
795 void View::centre_cursors()
797 const double time_width = scale_ * viewport_->width();
798 cursors_->first()->set_time(offset_ + time_width * 0.4);
799 cursors_->second()->set_time(offset_ + time_width * 0.6);
804 shared_ptr<CursorPair> View::cursors() const
809 void View::add_flag(const Timestamp& time)
811 flags_.push_back(make_shared<Flag>(*this, time,
812 QString("%1").arg(next_flag_text_)));
814 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
815 (next_flag_text_ + 1);
817 time_item_appearance_changed(true, true);
820 void View::remove_flag(shared_ptr<Flag> flag)
823 time_item_appearance_changed(true, true);
826 vector< shared_ptr<Flag> > View::flags() const
828 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
829 stable_sort(flags.begin(), flags.end(),
830 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
831 return a->time() < b->time();
837 const QPoint& View::hover_point() const
842 void View::restack_all_trace_tree_items()
844 // Make a list of owners that is sorted from deepest first
845 const vector<shared_ptr<TraceTreeItem>> items(
846 list_by_type<TraceTreeItem>());
847 set< TraceTreeItemOwner* > owners;
848 for (const auto &r : items)
849 owners.insert(r->owner());
850 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
851 sort(sorted_owners.begin(), sorted_owners.end(),
852 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
853 return a->depth() > b->depth(); });
855 // Restack the items recursively
856 for (auto &o : sorted_owners)
859 // Animate the items to their destination
860 for (const auto &i : items)
861 i->animate_to_layout_v_offset();
864 void View::trigger_event(int segment_id, util::Timestamp location)
866 // TODO This doesn't work if we're showing multiple segments at once
867 if ((uint32_t)segment_id != current_segment_)
870 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
871 // if this is the first trigger for this segment.
872 GlobalSettings settings;
873 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
875 size_t trigger_count = session_.get_triggers(current_segment_).size();
877 if (trigger_is_zero_time && trigger_count == 1)
878 set_zero_position(location);
880 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
883 void View::get_scroll_layout(double &length, Timestamp &offset) const
885 const pair<Timestamp, Timestamp> extents = get_time_extents();
886 length = ((extents.second - extents.first) / scale_).convert_to<double>();
887 offset = offset_ / scale_;
890 void View::set_zoom(double scale, int offset)
892 // Reset the "always zoom to fit" feature as the user changed the zoom
893 always_zoom_to_fit_ = false;
894 always_zoom_to_fit_changed(false);
896 const Timestamp cursor_offset = offset_ + scale_ * offset;
897 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
898 const Timestamp new_offset = cursor_offset - new_scale * offset;
899 set_scale_offset(new_scale.convert_to<double>(), new_offset);
902 void View::calculate_tick_spacing()
904 const double SpacingIncrement = 10.0f;
905 const double MinValueSpacing = 40.0f;
907 // Figure out the highest numeric value visible on a label
908 const QSize areaSize = viewport_->size();
909 const Timestamp max_time = max(fabs(offset_),
910 fabs(offset_ + scale_ * areaSize.width()));
912 double min_width = SpacingIncrement;
913 double label_width, tick_period_width;
915 QFontMetrics m(QApplication::font());
917 // Copies of the member variables with the same name, used in the calculation
918 // and written back afterwards, so that we don't emit signals all the time
919 // during the calculation.
920 pv::util::Timestamp tick_period = tick_period_;
921 pv::util::SIPrefix tick_prefix = tick_prefix_;
922 unsigned tick_precision = tick_precision_;
925 const double min_period = scale_ * min_width;
927 const int order = (int)floorf(log10f(min_period));
928 const pv::util::Timestamp order_decimal =
929 pow(pv::util::Timestamp(10), order);
931 // Allow for a margin of error so that a scale unit of 1 can be used.
932 // Otherwise, for a SU of 1 the tick period will almost always be below
933 // the min_period by a small amount - and thus skipped in favor of 2.
934 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
935 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
936 double tp_with_margin;
937 unsigned int unit = 0;
940 tp_with_margin = order_decimal.convert_to<double>() *
941 (ScaleUnits[unit++] + tp_margin);
942 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
944 minor_tick_count_ = (unit == 2) ? (4) : (5);
945 tick_period = order_decimal * ScaleUnits[unit - 1];
946 tick_prefix = static_cast<pv::util::SIPrefix>(
947 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
949 // Precision is the number of fractional digits required, not
950 // taking the prefix into account (and it must never be negative)
951 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
953 tick_period_width = (tick_period / scale_).convert_to<double>();
955 const QString label_text = Ruler::format_time_with_distance(
956 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
958 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
959 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
962 min_width += SpacingIncrement;
963 } while (tick_period_width < label_width);
965 set_tick_period(tick_period);
966 set_tick_prefix(tick_prefix);
967 set_tick_precision(tick_precision);
970 void View::adjust_top_margin()
974 const QSize areaSize = viewport_->size();
976 const pair<int, int> extents = v_extents();
977 const int top_margin = owner_visual_v_offset() + extents.first;
978 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
980 // Do we have empty space at the top while the last trace goes out of screen?
981 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
982 const int trace_height = extents.second - extents.first;
984 // Center everything vertically if there is enough space
985 if (areaSize.height() >= trace_height)
986 set_v_offset(extents.first -
987 ((areaSize.height() - trace_height) / 2));
989 // Remove the top margin to make as many traces fit on screen as possible
990 set_v_offset(extents.first);
994 void View::update_scroll()
997 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
998 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1000 const QSize areaSize = viewport_->size();
1002 // Set the horizontal scroll bar
1005 get_scroll_layout(length, offset);
1006 length = max(length - areaSize.width(), 0.0);
1008 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1010 hscrollbar->setPageStep(areaSize.width() / 2);
1011 hscrollbar->setSingleStep(major_tick_distance);
1013 updating_scroll_ = true;
1015 if (length < MaxScrollValue) {
1016 hscrollbar->setRange(0, length);
1017 hscrollbar->setSliderPosition(offset.convert_to<double>());
1019 hscrollbar->setRange(0, MaxScrollValue);
1020 hscrollbar->setSliderPosition(
1021 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1024 updating_scroll_ = false;
1026 // Set the vertical scrollbar
1027 vscrollbar->setPageStep(areaSize.height());
1028 vscrollbar->setSingleStep(areaSize.height() / 8);
1030 const pair<int, int> extents = v_extents();
1032 // Don't change the scrollbar range if there are no traces
1033 if (extents.first != extents.second)
1034 vscrollbar->setRange(extents.first - areaSize.height(),
1037 if (scroll_needs_defaults_)
1038 set_scroll_default();
1041 void View::reset_scroll()
1043 scrollarea_->verticalScrollBar()->setRange(0, 0);
1046 void View::set_scroll_default()
1050 const QSize areaSize = viewport_->size();
1052 const pair<int, int> extents = v_extents();
1053 const int trace_height = extents.second - extents.first;
1055 // Do all traces fit in the view?
1056 if (areaSize.height() >= trace_height)
1057 // Center all traces vertically
1058 set_v_offset(extents.first -
1059 ((areaSize.height() - trace_height) / 2));
1061 // Put the first trace at the top, letting the bottom ones overflow
1062 set_v_offset(extents.first);
1065 void View::determine_if_header_was_shrunk()
1067 const int header_pane_width = splitter_->sizes().front();
1068 const int header_width = header_->extended_size_hint().width();
1070 // Allow for a slight margin of error so that we also accept
1071 // slight differences when e.g. a label name change increased
1072 // the overall width
1073 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1076 void View::resize_header_to_fit()
1078 // Setting the maximum width of the header widget doesn't work as
1079 // expected because the splitter would allow the user to make the
1080 // pane wider than that, creating empty space as a result.
1081 // To make this work, we stricly enforce the maximum width by
1082 // expanding the header unless the user shrunk it on purpose.
1083 // As we're then setting the width of the header pane, we set the
1084 // splitter to the maximum allowed position.
1086 int splitter_area_width = 0;
1087 for (int w : splitter_->sizes())
1088 splitter_area_width += w;
1090 // Make sure the header has enough horizontal space to show all labels fully
1091 QList<int> pane_sizes;
1092 pane_sizes.push_back(header_->extended_size_hint().width());
1093 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1094 splitter_->setSizes(pane_sizes);
1097 void View::update_layout()
1102 TraceTreeItemOwner* View::find_prevalent_trace_group(
1103 const shared_ptr<sigrok::ChannelGroup> &group,
1104 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1109 unordered_set<TraceTreeItemOwner*> owners;
1110 vector<TraceTreeItemOwner*> owner_list;
1112 // Make a set and a list of all the owners
1113 for (const auto &channel : group->channels()) {
1114 for (auto entry : signal_map) {
1115 if (entry.first->channel() == channel) {
1116 TraceTreeItemOwner *const o = (entry.second)->owner();
1117 owner_list.push_back(o);
1123 // Iterate through the list of owners, and find the most prevalent
1124 size_t max_prevalence = 0;
1125 TraceTreeItemOwner *prevalent_owner = nullptr;
1126 for (TraceTreeItemOwner *owner : owners) {
1127 const size_t prevalence = count_if(
1128 owner_list.begin(), owner_list.end(),
1129 [&](TraceTreeItemOwner *o) { return o == owner; });
1130 if (prevalence > max_prevalence) {
1131 max_prevalence = prevalence;
1132 prevalent_owner = owner;
1136 return prevalent_owner;
1139 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1140 const vector< shared_ptr<sigrok::Channel> > &channels,
1141 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1143 set< shared_ptr<Trace> > &add_list)
1145 vector< shared_ptr<Trace> > filtered_traces;
1147 for (const auto &channel : channels) {
1148 for (auto entry : signal_map) {
1149 if (entry.first->channel() == channel) {
1150 shared_ptr<Trace> trace = entry.second;
1151 const auto list_iter = add_list.find(trace);
1152 if (list_iter == add_list.end())
1155 filtered_traces.push_back(trace);
1156 add_list.erase(list_iter);
1161 return filtered_traces;
1164 void View::determine_time_unit()
1166 // Check whether we know the sample rate and hence can use time as the unit
1167 if (time_unit_ == util::TimeUnit::Samples) {
1168 // Check all signals but...
1169 for (const shared_ptr<Signal> signal : signals_) {
1170 const shared_ptr<SignalData> data = signal->data();
1172 // ...only check first segment of each
1173 const vector< shared_ptr<Segment> > segments = data->segments();
1174 if (!segments.empty())
1175 if (segments[0]->samplerate()) {
1176 set_time_unit(util::TimeUnit::Time);
1183 bool View::eventFilter(QObject *object, QEvent *event)
1185 const QEvent::Type type = event->type();
1186 if (type == QEvent::MouseMove) {
1188 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1189 if (object == viewport_)
1190 hover_point_ = mouse_event->pos();
1191 else if (object == ruler_)
1192 hover_point_ = QPoint(mouse_event->x(), 0);
1193 else if (object == header_)
1194 hover_point_ = QPoint(0, mouse_event->y());
1196 hover_point_ = QPoint(-1, -1);
1198 update_hover_point();
1200 } else if (type == QEvent::Leave) {
1201 hover_point_ = QPoint(-1, -1);
1202 update_hover_point();
1203 } else if (type == QEvent::Show) {
1205 // This is somewhat of a hack, unfortunately. We cannot use
1206 // set_v_offset() from within restore_settings() as the view
1207 // at that point is neither visible nor properly sized.
1208 // This is the least intrusive workaround I could come up
1209 // with: set the vertical offset (or scroll defaults) when
1210 // the view is shown, which happens after all widgets were
1211 // resized to their final sizes.
1214 if (settings_restored_)
1215 determine_if_header_was_shrunk();
1217 resize_header_to_fit();
1219 if (scroll_needs_defaults_) {
1220 set_scroll_default();
1221 scroll_needs_defaults_ = false;
1224 if (saved_v_offset_) {
1225 set_v_offset(saved_v_offset_);
1226 saved_v_offset_ = 0;
1230 return QObject::eventFilter(object, event);
1233 void View::resizeEvent(QResizeEvent* event)
1235 // Only adjust the top margin if we shrunk vertically
1236 if (event->size().height() < event->oldSize().height())
1237 adjust_top_margin();
1242 void View::update_hover_point()
1244 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1245 list_by_type<TraceTreeItem>());
1246 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1247 r->hover_point_changed(hover_point_);
1249 hover_point_changed(hover_point_);
1252 void View::row_item_appearance_changed(bool label, bool content)
1257 viewport_->update();
1260 void View::time_item_appearance_changed(bool label, bool content)
1265 // Make sure the header pane width is updated, too
1270 viewport_->update();
1273 void View::extents_changed(bool horz, bool vert)
1276 (horz ? TraceTreeItemHExtentsChanged : 0) |
1277 (vert ? TraceTreeItemVExtentsChanged : 0);
1279 lazy_event_handler_.start();
1282 void View::on_signal_name_changed()
1284 if (!header_was_shrunk_)
1285 resize_header_to_fit();
1288 void View::on_splitter_moved()
1290 // The header can only shrink when the splitter is moved manually
1291 determine_if_header_was_shrunk();
1293 if (!header_was_shrunk_)
1294 resize_header_to_fit();
1297 void View::h_scroll_value_changed(int value)
1299 if (updating_scroll_)
1302 // Disable sticky scrolling when user moves the horizontal scroll bar
1303 // during a running acquisition
1304 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1305 sticky_scrolling_ = false;
1306 sticky_scrolling_changed(false);
1309 const int range = scrollarea_->horizontalScrollBar()->maximum();
1310 if (range < MaxScrollValue)
1311 set_offset(scale_ * value);
1315 get_scroll_layout(length, offset);
1316 set_offset(scale_ * length * value / MaxScrollValue);
1320 viewport_->update();
1323 void View::v_scroll_value_changed()
1326 viewport_->update();
1329 void View::signals_changed()
1331 using sigrok::Channel;
1333 vector< shared_ptr<Channel> > channels;
1334 shared_ptr<sigrok::Device> sr_dev;
1335 bool signals_added_or_removed = false;
1337 // Do we need to set the vertical scrollbar to its default position later?
1338 // We do if there are no traces, i.e. the scroll bar has no range set
1339 bool reset_scrollbar =
1340 (scrollarea_->verticalScrollBar()->minimum() ==
1341 scrollarea_->verticalScrollBar()->maximum());
1343 if (!session_.device()) {
1347 sr_dev = session_.device()->device();
1349 channels = sr_dev->channels();
1352 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1354 // Make a list of traces that are being added, and a list of traces
1355 // that are being removed
1356 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1357 const set<shared_ptr<Trace>> prev_traces(
1358 prev_trace_list.begin(), prev_trace_list.end());
1360 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1362 #ifdef ENABLE_DECODE
1363 traces.insert(decode_traces_.begin(), decode_traces_.end());
1366 set< shared_ptr<Trace> > add_traces;
1367 set_difference(traces.begin(), traces.end(),
1368 prev_traces.begin(), prev_traces.end(),
1369 inserter(add_traces, add_traces.begin()));
1371 set< shared_ptr<Trace> > remove_traces;
1372 set_difference(prev_traces.begin(), prev_traces.end(),
1373 traces.begin(), traces.end(),
1374 inserter(remove_traces, remove_traces.begin()));
1376 // Make a look-up table of sigrok Channels to pulseview Signals
1377 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1379 for (const shared_ptr<Signal> &sig : signals_)
1380 signal_map[sig->base()] = sig;
1382 // Populate channel groups
1384 for (auto entry : sr_dev->channel_groups()) {
1385 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1387 if (group->channels().size() <= 1)
1390 // Find best trace group to add to
1391 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1394 // If there is no trace group, create one
1395 shared_ptr<TraceGroup> new_trace_group;
1397 new_trace_group.reset(new TraceGroup());
1398 owner = new_trace_group.get();
1401 // Extract traces for the trace group, removing them from
1403 const vector< shared_ptr<Trace> > new_traces_in_group =
1404 extract_new_traces_for_channels(group->channels(),
1405 signal_map, add_traces);
1407 // Add the traces to the group
1408 const pair<int, int> prev_v_extents = owner->v_extents();
1409 int offset = prev_v_extents.second - prev_v_extents.first;
1410 for (shared_ptr<Trace> trace : new_traces_in_group) {
1412 owner->add_child_item(trace);
1414 const pair<int, int> extents = trace->v_extents();
1415 if (trace->enabled())
1416 offset += -extents.first;
1417 trace->force_to_v_offset(offset);
1418 if (trace->enabled())
1419 offset += extents.second;
1422 if (new_trace_group) {
1423 // Assign proper vertical offsets to each channel in the group
1424 new_trace_group->restack_items();
1426 // If this is a new group, enqueue it in the new top level
1428 if (!new_traces_in_group.empty())
1429 new_top_level_items.push_back(new_trace_group);
1433 // Enqueue the remaining logic channels in a group
1434 vector< shared_ptr<Channel> > logic_channels;
1435 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1436 [](const shared_ptr<Channel>& c) {
1437 return c->type() == sigrok::ChannelType::LOGIC; });
1439 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1440 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1442 if (non_grouped_logic_signals.size() > 0) {
1443 const shared_ptr<TraceGroup> non_grouped_trace_group(
1444 make_shared<TraceGroup>());
1445 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1446 non_grouped_trace_group->add_child_item(trace);
1448 non_grouped_trace_group->restack_items();
1449 new_top_level_items.push_back(non_grouped_trace_group);
1452 // Enqueue the remaining channels as free ungrouped traces
1453 const vector< shared_ptr<Trace> > new_top_level_signals =
1454 extract_new_traces_for_channels(channels, signal_map, add_traces);
1455 new_top_level_items.insert(new_top_level_items.end(),
1456 new_top_level_signals.begin(), new_top_level_signals.end());
1458 // Enqueue any remaining traces i.e. decode traces
1459 new_top_level_items.insert(new_top_level_items.end(),
1460 add_traces.begin(), add_traces.end());
1462 // Remove any removed traces
1463 for (shared_ptr<Trace> trace : remove_traces) {
1464 TraceTreeItemOwner *const owner = trace->owner();
1466 owner->remove_child_item(trace);
1467 signals_added_or_removed = true;
1470 // Remove any empty trace groups
1471 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1472 if (group->child_items().size() == 0) {
1473 remove_child_item(group);
1477 // Add and position the pending top levels items
1478 int offset = v_extents().second;
1479 for (auto item : new_top_level_items) {
1480 add_child_item(item);
1482 // Position the item after the last item or at the top if there is none
1483 const pair<int, int> extents = item->v_extents();
1485 if (item->enabled())
1486 offset += -extents.first;
1488 item->force_to_v_offset(offset);
1490 if (item->enabled())
1491 offset += extents.second;
1492 signals_added_or_removed = true;
1496 if (signals_added_or_removed && !header_was_shrunk_)
1497 resize_header_to_fit();
1502 viewport_->update();
1504 if (reset_scrollbar)
1505 set_scroll_default();
1508 void View::capture_state_updated(int state)
1510 GlobalSettings settings;
1512 if (state == Session::Running) {
1513 set_time_unit(util::TimeUnit::Samples);
1515 trigger_markers_.clear();
1517 scale_at_acq_start_ = scale_;
1518 offset_at_acq_start_ = offset_;
1520 // Activate "always zoom to fit" if the setting is enabled and we're
1521 // the main view of this session (other trace views may be used for
1522 // zooming and we don't want to mess them up)
1523 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1524 if (is_main_view_ && state) {
1525 always_zoom_to_fit_ = true;
1526 always_zoom_to_fit_changed(always_zoom_to_fit_);
1529 // Enable sticky scrolling if the setting is enabled
1530 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1532 // Reset all traces to segment 0
1533 current_segment_ = 0;
1534 set_current_segment(current_segment_);
1537 if (state == Session::Stopped) {
1538 // After acquisition has stopped we need to re-calculate the ticks once
1539 // as it's otherwise done when the user pans or zooms, which is too late
1540 calculate_tick_spacing();
1542 // Reset "always zoom to fit", the acquisition has stopped
1543 if (always_zoom_to_fit_) {
1544 // Perform a final zoom-to-fit before disabling
1545 zoom_fit(always_zoom_to_fit_);
1546 always_zoom_to_fit_ = false;
1547 always_zoom_to_fit_changed(always_zoom_to_fit_);
1550 bool zoom_to_fit_after_acq =
1551 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1553 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1554 // we didn't restore settings in the meanwhile
1555 if (zoom_to_fit_after_acq &&
1556 !suppress_zoom_to_fit_after_acq_ &&
1557 (scale_ == scale_at_acq_start_) &&
1558 (offset_ == offset_at_acq_start_))
1559 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1561 suppress_zoom_to_fit_after_acq_ = false;
1565 void View::on_new_segment(int new_segment_id)
1567 on_segment_changed(new_segment_id);
1570 void View::on_segment_completed(int segment_id)
1572 on_segment_changed(segment_id);
1575 void View::on_segment_changed(int segment)
1577 switch (segment_display_mode_) {
1578 case Trace::ShowLastSegmentOnly:
1579 case Trace::ShowSingleSegmentOnly:
1580 set_current_segment(segment);
1583 case Trace::ShowLastCompleteSegmentOnly:
1584 // Only update if all segments are complete
1585 if (session_.all_segments_complete(segment))
1586 set_current_segment(segment);
1589 case Trace::ShowAllSegments:
1590 case Trace::ShowAccumulatedIntensity:
1596 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1598 if (new_value.toBool()) {
1599 // The first trigger for this segment is used as the zero position
1600 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1601 if (triggers.size() > 0)
1602 set_zero_position(triggers.front());
1604 reset_zero_position();
1607 void View::perform_delayed_view_update()
1609 if (always_zoom_to_fit_) {
1611 } else if (sticky_scrolling_) {
1612 // Make right side of the view sticky
1615 get_scroll_layout(length, offset);
1617 const QSize areaSize = viewport_->size();
1618 length = max(length - areaSize.width(), 0.0);
1620 set_offset(scale_ * length);
1623 determine_time_unit();
1626 viewport_->update();
1629 void View::process_sticky_events()
1631 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1633 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1634 restack_all_trace_tree_items();
1638 // Clear the sticky events
1642 } // namespace trace
1643 } // namespace views