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),
133 updating_scroll_(false),
134 settings_restored_(false),
135 header_was_shrunk_(false),
136 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
137 always_zoom_to_fit_(false),
139 tick_prefix_(pv::util::SIPrefix::yocto),
141 time_unit_(util::TimeUnit::Time),
142 show_cursors_(false),
143 cursors_(new CursorPair(*this)),
144 next_flag_text_('A'),
146 hover_point_(-1, -1),
147 scroll_needs_defaults_(true),
149 scale_at_acq_start_(0),
150 offset_at_acq_start_(0),
151 suppress_zoom_to_fit_after_acq_(false)
153 QVBoxLayout *root_layout = new QVBoxLayout(this);
154 root_layout->setContentsMargins(0, 0, 0, 0);
155 root_layout->addWidget(splitter_);
157 viewport_ = new Viewport(*this);
158 scrollarea_ = new CustomScrollArea(splitter_);
159 scrollarea_->setViewport(viewport_);
160 scrollarea_->setFrameShape(QFrame::NoFrame);
162 ruler_ = new Ruler(*this);
164 header_ = new Header(*this);
165 header_->setMinimumWidth(10); // So that the arrow tips show at least
167 // We put the header into a simple layout so that we can add the top margin,
168 // allowing us to make it line up with the bottom of the ruler
169 QWidget *header_container = new QWidget();
170 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
171 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
172 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
173 header_layout->addWidget(header_);
175 // To let the ruler and scrollarea be on the same split pane, we need a layout
176 QWidget *trace_container = new QWidget();
177 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
178 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
179 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
180 trace_layout->setContentsMargins(0, 0, 0, 0);
181 trace_layout->addWidget(ruler_);
182 trace_layout->addWidget(scrollarea_);
184 splitter_->addWidget(header_container);
185 splitter_->addWidget(trace_container);
186 splitter_->setHandleWidth(1); // Don't show a visible rubber band
187 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
188 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
189 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
190 splitter_->setStretchFactor(1, 1); // when the entire view is resized
191 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
193 viewport_->installEventFilter(this);
194 ruler_->installEventFilter(this);
195 header_->installEventFilter(this);
197 // Set up settings and event handlers
198 GlobalSettings settings;
199 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
201 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
202 this, SLOT(h_scroll_value_changed(int)));
203 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
204 this, SLOT(v_scroll_value_changed()));
206 connect(header_, SIGNAL(selection_changed()),
207 ruler_, SLOT(clear_selection()));
208 connect(ruler_, SIGNAL(selection_changed()),
209 header_, SLOT(clear_selection()));
211 connect(header_, SIGNAL(selection_changed()),
212 this, SIGNAL(selection_changed()));
213 connect(ruler_, SIGNAL(selection_changed()),
214 this, SIGNAL(selection_changed()));
216 connect(splitter_, SIGNAL(splitterMoved(int, int)),
217 this, SLOT(on_splitter_moved()));
219 connect(&lazy_event_handler_, SIGNAL(timeout()),
220 this, SLOT(process_sticky_events()));
221 lazy_event_handler_.setSingleShot(true);
223 // Trigger the initial event manually. The default device has signals
224 // which were created before this object came into being
227 // make sure the transparent widgets are on the top
231 // Update the zoom state
232 calculate_tick_spacing();
234 // Make sure the standard bar's segment selector is in sync
235 set_segment_display_mode(segment_display_mode_);
238 Session& View::session()
243 const Session& View::session() const
248 unordered_set< shared_ptr<Signal> > View::signals() const
253 void View::clear_signals()
255 ViewBase::clear_signalbases();
259 void View::add_signal(const shared_ptr<Signal> signal)
261 ViewBase::add_signalbase(signal->base());
262 signals_.insert(signal);
264 signal->set_segment_display_mode(segment_display_mode_);
265 signal->set_current_segment(current_segment_);
267 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
268 this, SLOT(on_signal_name_changed()));
272 void View::clear_decode_signals()
274 decode_traces_.clear();
277 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
279 shared_ptr<DecodeTrace> d(
280 new DecodeTrace(session_, signal, decode_traces_.size()));
281 decode_traces_.push_back(d);
283 d->set_segment_display_mode(segment_display_mode_);
284 d->set_current_segment(current_segment_);
286 connect(signal.get(), SIGNAL(name_changed(const QString&)),
287 this, SLOT(on_signal_name_changed()));
290 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
292 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
293 if ((*i)->base() == signal) {
294 decode_traces_.erase(i);
306 const View* View::view() const
311 Viewport* View::viewport()
316 const Viewport* View::viewport() const
321 void View::save_settings(QSettings &settings) const
323 settings.setValue("scale", scale_);
324 settings.setValue("v_offset",
325 scrollarea_->verticalScrollBar()->sliderPosition());
327 settings.setValue("splitter_state", splitter_->saveState());
328 settings.setValue("segment_display_mode", segment_display_mode_);
332 boost::archive::text_oarchive oa(ss);
333 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
334 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
338 boost::archive::text_oarchive oa(ss);
339 oa << boost::serialization::make_nvp("offset", offset_);
340 settings.setValue("offset", QString::fromStdString(ss.str()));
343 for (shared_ptr<Signal> signal : signals_) {
344 settings.beginGroup(signal->base()->internal_name());
345 signal->save_settings(settings);
350 void View::restore_settings(QSettings &settings)
352 // Note: It is assumed that this function is only called once,
353 // immediately after restoring a previous session.
355 if (settings.contains("scale"))
356 set_scale(settings.value("scale").toDouble());
358 if (settings.contains("ruler_shift")) {
359 util::Timestamp shift;
361 ss << settings.value("ruler_shift").toString().toStdString();
363 boost::archive::text_iarchive ia(ss);
364 ia >> boost::serialization::make_nvp("ruler_shift", shift);
366 ruler_shift_ = shift;
369 if (settings.contains("offset")) {
370 util::Timestamp offset;
372 ss << settings.value("offset").toString().toStdString();
374 boost::archive::text_iarchive ia(ss);
375 ia >> boost::serialization::make_nvp("offset", offset);
377 // This also updates ruler_offset_
381 if (settings.contains("splitter_state"))
382 splitter_->restoreState(settings.value("splitter_state").toByteArray());
384 if (settings.contains("segment_display_mode"))
385 set_segment_display_mode(
386 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
388 for (shared_ptr<Signal> signal : signals_) {
389 settings.beginGroup(signal->base()->internal_name());
390 signal->restore_settings(settings);
394 if (settings.contains("v_offset")) {
395 saved_v_offset_ = settings.value("v_offset").toInt();
396 set_v_offset(saved_v_offset_);
397 scroll_needs_defaults_ = false;
398 // Note: see eventFilter() for additional information
401 settings_restored_ = true;
402 suppress_zoom_to_fit_after_acq_ = true;
404 // Update the ruler so that it uses the new scale
405 calculate_tick_spacing();
408 vector< shared_ptr<TimeItem> > View::time_items() const
410 const vector<shared_ptr<Flag>> f(flags());
411 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
412 items.push_back(cursors_);
413 items.push_back(cursors_->first());
414 items.push_back(cursors_->second());
416 for (auto trigger_marker : trigger_markers_)
417 items.push_back(trigger_marker);
422 double View::scale() const
427 void View::set_scale(double scale)
429 if (scale_ != scale) {
435 void View::set_offset(const pv::util::Timestamp& offset)
437 if (offset_ != offset) {
439 ruler_offset_ = offset_ + ruler_shift_;
444 // Returns the internal version of the time offset
445 const Timestamp& View::offset() const
450 // Returns the ruler version of the time offset
451 const Timestamp& View::ruler_offset() const
453 return ruler_offset_;
456 int View::owner_visual_v_offset() const
458 return -scrollarea_->verticalScrollBar()->sliderPosition();
461 void View::set_v_offset(int offset)
463 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
468 unsigned int View::depth() const
473 uint32_t View::current_segment() const
475 return current_segment_;
478 pv::util::SIPrefix View::tick_prefix() const
483 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
485 if (tick_prefix_ != tick_prefix) {
486 tick_prefix_ = tick_prefix;
487 tick_prefix_changed();
491 unsigned int View::tick_precision() const
493 return tick_precision_;
496 void View::set_tick_precision(unsigned tick_precision)
498 if (tick_precision_ != tick_precision) {
499 tick_precision_ = tick_precision;
500 tick_precision_changed();
504 const pv::util::Timestamp& View::tick_period() const
509 unsigned int View::minor_tick_count() const
511 return minor_tick_count_;
514 void View::set_tick_period(const pv::util::Timestamp& tick_period)
516 if (tick_period_ != tick_period) {
517 tick_period_ = tick_period;
518 tick_period_changed();
522 TimeUnit View::time_unit() const
527 void View::set_time_unit(pv::util::TimeUnit time_unit)
529 if (time_unit_ != time_unit) {
530 time_unit_ = time_unit;
535 void View::set_current_segment(uint32_t segment_id)
537 current_segment_ = segment_id;
539 for (shared_ptr<Signal> signal : signals_)
540 signal->set_current_segment(current_segment_);
541 for (shared_ptr<DecodeTrace> dt : decode_traces_)
542 dt->set_current_segment(current_segment_);
544 trigger_markers_.clear();
545 for (util::Timestamp timestamp : session_.get_triggers(segment_id))
546 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
550 segment_changed(segment_id);
553 bool View::segment_is_selectable() const
555 return segment_selectable_;
558 Trace::SegmentDisplayMode View::segment_display_mode() const
560 return segment_display_mode_;
563 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
565 trigger_markers_.clear();
567 segment_display_mode_ = mode;
569 for (shared_ptr<Signal> signal : signals_)
570 signal->set_segment_display_mode(mode);
572 uint32_t last_segment = session_.get_segment_count() - 1;
575 case Trace::ShowLastSegmentOnly:
576 if (current_segment_ != last_segment)
577 set_current_segment(last_segment);
580 case Trace::ShowLastCompleteSegmentOnly:
581 // Do nothing if we only have one segment so far
582 if (last_segment > 0) {
583 // If the last segment isn't complete, the previous one must be
584 uint32_t segment_id =
585 (session_.all_segments_complete(last_segment)) ?
586 last_segment : last_segment - 1;
588 if (current_segment_ != segment_id)
589 set_current_segment(segment_id);
593 case Trace::ShowSingleSegmentOnly:
594 case Trace::ShowAllSegments:
595 case Trace::ShowAccumulatedIntensity:
597 // Current segment remains as-is
601 segment_selectable_ = true;
603 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
604 segment_selectable_ = false;
608 segment_display_mode_changed((int)mode, segment_selectable_);
611 void View::zoom(double steps)
613 zoom(steps, viewport_->width() / 2);
616 void View::zoom(double steps, int offset)
618 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
621 void View::zoom_fit(bool gui_state)
623 // Act as one-shot when stopped, toggle along with the GUI otherwise
624 if (session_.get_capture_state() == Session::Stopped) {
625 always_zoom_to_fit_ = false;
626 always_zoom_to_fit_changed(false);
628 always_zoom_to_fit_ = gui_state;
629 always_zoom_to_fit_changed(gui_state);
632 const pair<Timestamp, Timestamp> extents = get_time_extents();
633 const Timestamp delta = extents.second - extents.first;
634 if (delta < Timestamp("1e-12"))
638 const int w = viewport_->width();
642 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
643 set_scale_offset(scale.convert_to<double>(), extents.first);
646 void View::zoom_one_to_one()
648 using pv::data::SignalData;
650 // Make a set of all the visible data objects
651 set< shared_ptr<SignalData> > visible_data = get_visible_data();
652 if (visible_data.empty())
656 const int w = viewport_->width();
660 set_zoom(1.0 / session_.get_samplerate(), w / 2);
663 void View::set_scale_offset(double scale, const Timestamp& offset)
665 // Disable sticky scrolling / always zoom to fit when acquisition runs
666 // and user drags the viewport
667 if ((scale_ == scale) && (offset_ != offset) &&
668 (session_.get_capture_state() == Session::Running)) {
670 if (sticky_scrolling_) {
671 sticky_scrolling_ = false;
672 sticky_scrolling_changed(false);
675 if (always_zoom_to_fit_) {
676 always_zoom_to_fit_ = false;
677 always_zoom_to_fit_changed(false);
684 calculate_tick_spacing();
691 set< shared_ptr<SignalData> > View::get_visible_data() const
693 // Make a set of all the visible data objects
694 set< shared_ptr<SignalData> > visible_data;
695 for (const shared_ptr<Signal> sig : signals_)
697 visible_data.insert(sig->data());
702 pair<Timestamp, Timestamp> View::get_time_extents() const
704 boost::optional<Timestamp> left_time, right_time;
705 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
706 for (const shared_ptr<SignalData> d : visible_data) {
707 const vector< shared_ptr<Segment> > segments = d->segments();
708 for (const shared_ptr<Segment> &s : segments) {
709 double samplerate = s->samplerate();
710 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
712 const Timestamp start_time = s->start_time();
713 left_time = left_time ?
714 min(*left_time, start_time) :
716 right_time = right_time ?
717 max(*right_time, start_time + d->max_sample_count() / samplerate) :
718 start_time + d->max_sample_count() / samplerate;
722 if (!left_time || !right_time)
723 return make_pair(0, 0);
725 assert(*left_time < *right_time);
726 return make_pair(*left_time, *right_time);
729 void View::enable_show_sampling_points(bool state)
736 void View::enable_show_analog_minor_grid(bool state)
743 void View::enable_coloured_bg(bool state)
745 coloured_bg_ = state;
749 bool View::coloured_bg() const
754 bool View::cursors_shown() const
756 return show_cursors_;
759 void View::show_cursors(bool show)
761 show_cursors_ = show;
766 void View::centre_cursors()
768 const double time_width = scale_ * viewport_->width();
769 cursors_->first()->set_time(offset_ + time_width * 0.4);
770 cursors_->second()->set_time(offset_ + time_width * 0.6);
775 shared_ptr<CursorPair> View::cursors() const
780 void View::add_flag(const Timestamp& time)
782 flags_.push_back(make_shared<Flag>(*this, time,
783 QString("%1").arg(next_flag_text_)));
785 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
786 (next_flag_text_ + 1);
788 time_item_appearance_changed(true, true);
791 void View::remove_flag(shared_ptr<Flag> flag)
794 time_item_appearance_changed(true, true);
797 vector< shared_ptr<Flag> > View::flags() const
799 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
800 stable_sort(flags.begin(), flags.end(),
801 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
802 return a->time() < b->time();
808 const QPoint& View::hover_point() const
813 void View::restack_all_trace_tree_items()
815 // Make a list of owners that is sorted from deepest first
816 const vector<shared_ptr<TraceTreeItem>> items(
817 list_by_type<TraceTreeItem>());
818 set< TraceTreeItemOwner* > owners;
819 for (const auto &r : items)
820 owners.insert(r->owner());
821 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
822 sort(sorted_owners.begin(), sorted_owners.end(),
823 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
824 return a->depth() > b->depth(); });
826 // Restack the items recursively
827 for (auto &o : sorted_owners)
830 // Animate the items to their destination
831 for (const auto &i : items)
832 i->animate_to_layout_v_offset();
835 void View::trigger_event(int segment_id, util::Timestamp location)
837 // TODO This doesn't work if we're showing multiple segments at once
838 if ((uint32_t)segment_id != current_segment_)
841 // Set up ruler_shift if the Key_View_TriggerIsZeroTime option is set.
842 GlobalSettings settings;
843 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
845 ruler_shift_ = (trigger_is_zero_time) ? (-location) : (0);
846 // Force an immediate update of both offsets
848 set_offset(offset_ + 0.001);
850 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
853 void View::get_scroll_layout(double &length, Timestamp &offset) const
855 const pair<Timestamp, Timestamp> extents = get_time_extents();
856 length = ((extents.second - extents.first) / scale_).convert_to<double>();
857 offset = offset_ / scale_;
860 void View::set_zoom(double scale, int offset)
862 // Reset the "always zoom to fit" feature as the user changed the zoom
863 always_zoom_to_fit_ = false;
864 always_zoom_to_fit_changed(false);
866 const Timestamp cursor_offset = offset_ + scale_ * offset;
867 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
868 const Timestamp new_offset = cursor_offset - new_scale * offset;
869 set_scale_offset(new_scale.convert_to<double>(), new_offset);
872 void View::calculate_tick_spacing()
874 const double SpacingIncrement = 10.0f;
875 const double MinValueSpacing = 40.0f;
877 // Figure out the highest numeric value visible on a label
878 const QSize areaSize = viewport_->size();
879 const Timestamp max_time = max(fabs(offset_),
880 fabs(offset_ + scale_ * areaSize.width()));
882 double min_width = SpacingIncrement;
883 double label_width, tick_period_width;
885 QFontMetrics m(QApplication::font());
887 // Copies of the member variables with the same name, used in the calculation
888 // and written back afterwards, so that we don't emit signals all the time
889 // during the calculation.
890 pv::util::Timestamp tick_period = tick_period_;
891 pv::util::SIPrefix tick_prefix = tick_prefix_;
892 unsigned tick_precision = tick_precision_;
895 const double min_period = scale_ * min_width;
897 const int order = (int)floorf(log10f(min_period));
898 const pv::util::Timestamp order_decimal =
899 pow(pv::util::Timestamp(10), order);
901 // Allow for a margin of error so that a scale unit of 1 can be used.
902 // Otherwise, for a SU of 1 the tick period will almost always be below
903 // the min_period by a small amount - and thus skipped in favor of 2.
904 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
905 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
906 double tp_with_margin;
907 unsigned int unit = 0;
910 tp_with_margin = order_decimal.convert_to<double>() *
911 (ScaleUnits[unit++] + tp_margin);
912 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
914 minor_tick_count_ = (unit == 2) ? (4) : (5);
915 tick_period = order_decimal * ScaleUnits[unit - 1];
916 tick_prefix = static_cast<pv::util::SIPrefix>(
917 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
919 // Precision is the number of fractional digits required, not
920 // taking the prefix into account (and it must never be negative)
921 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
923 tick_period_width = (tick_period / scale_).convert_to<double>();
925 const QString label_text = Ruler::format_time_with_distance(
926 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
928 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
929 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
932 min_width += SpacingIncrement;
933 } while (tick_period_width < label_width);
935 set_tick_period(tick_period);
936 set_tick_prefix(tick_prefix);
937 set_tick_precision(tick_precision);
940 void View::adjust_top_margin()
944 const QSize areaSize = viewport_->size();
946 const pair<int, int> extents = v_extents();
947 const int top_margin = owner_visual_v_offset() + extents.first;
948 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
950 // Do we have empty space at the top while the last trace goes out of screen?
951 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
952 const int trace_height = extents.second - extents.first;
954 // Center everything vertically if there is enough space
955 if (areaSize.height() >= trace_height)
956 set_v_offset(extents.first -
957 ((areaSize.height() - trace_height) / 2));
959 // Remove the top margin to make as many traces fit on screen as possible
960 set_v_offset(extents.first);
964 void View::update_scroll()
967 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
968 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
970 const QSize areaSize = viewport_->size();
972 // Set the horizontal scroll bar
975 get_scroll_layout(length, offset);
976 length = max(length - areaSize.width(), 0.0);
978 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
980 hscrollbar->setPageStep(areaSize.width() / 2);
981 hscrollbar->setSingleStep(major_tick_distance);
983 updating_scroll_ = true;
985 if (length < MaxScrollValue) {
986 hscrollbar->setRange(0, length);
987 hscrollbar->setSliderPosition(offset.convert_to<double>());
989 hscrollbar->setRange(0, MaxScrollValue);
990 hscrollbar->setSliderPosition(
991 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
994 updating_scroll_ = false;
996 // Set the vertical scrollbar
997 vscrollbar->setPageStep(areaSize.height());
998 vscrollbar->setSingleStep(areaSize.height() / 8);
1000 const pair<int, int> extents = v_extents();
1002 // Don't change the scrollbar range if there are no traces
1003 if (extents.first != extents.second)
1004 vscrollbar->setRange(extents.first - areaSize.height(),
1007 if (scroll_needs_defaults_)
1008 set_scroll_default();
1011 void View::reset_scroll()
1013 scrollarea_->verticalScrollBar()->setRange(0, 0);
1016 void View::set_scroll_default()
1020 const QSize areaSize = viewport_->size();
1022 const pair<int, int> extents = v_extents();
1023 const int trace_height = extents.second - extents.first;
1025 // Do all traces fit in the view?
1026 if (areaSize.height() >= trace_height)
1027 // Center all traces vertically
1028 set_v_offset(extents.first -
1029 ((areaSize.height() - trace_height) / 2));
1031 // Put the first trace at the top, letting the bottom ones overflow
1032 set_v_offset(extents.first);
1035 void View::determine_if_header_was_shrunk()
1037 const int header_pane_width = splitter_->sizes().front();
1038 const int header_width = header_->extended_size_hint().width();
1040 // Allow for a slight margin of error so that we also accept
1041 // slight differences when e.g. a label name change increased
1042 // the overall width
1043 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1046 void View::resize_header_to_fit()
1048 // Setting the maximum width of the header widget doesn't work as
1049 // expected because the splitter would allow the user to make the
1050 // pane wider than that, creating empty space as a result.
1051 // To make this work, we stricly enforce the maximum width by
1052 // expanding the header unless the user shrunk it on purpose.
1053 // As we're then setting the width of the header pane, we set the
1054 // splitter to the maximum allowed position.
1056 int splitter_area_width = 0;
1057 for (int w : splitter_->sizes())
1058 splitter_area_width += w;
1060 // Make sure the header has enough horizontal space to show all labels fully
1061 QList<int> pane_sizes;
1062 pane_sizes.push_back(header_->extended_size_hint().width());
1063 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1064 splitter_->setSizes(pane_sizes);
1067 void View::update_layout()
1072 TraceTreeItemOwner* View::find_prevalent_trace_group(
1073 const shared_ptr<sigrok::ChannelGroup> &group,
1074 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1079 unordered_set<TraceTreeItemOwner*> owners;
1080 vector<TraceTreeItemOwner*> owner_list;
1082 // Make a set and a list of all the owners
1083 for (const auto &channel : group->channels()) {
1084 for (auto entry : signal_map) {
1085 if (entry.first->channel() == channel) {
1086 TraceTreeItemOwner *const o = (entry.second)->owner();
1087 owner_list.push_back(o);
1093 // Iterate through the list of owners, and find the most prevalent
1094 size_t max_prevalence = 0;
1095 TraceTreeItemOwner *prevalent_owner = nullptr;
1096 for (TraceTreeItemOwner *owner : owners) {
1097 const size_t prevalence = count_if(
1098 owner_list.begin(), owner_list.end(),
1099 [&](TraceTreeItemOwner *o) { return o == owner; });
1100 if (prevalence > max_prevalence) {
1101 max_prevalence = prevalence;
1102 prevalent_owner = owner;
1106 return prevalent_owner;
1109 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1110 const vector< shared_ptr<sigrok::Channel> > &channels,
1111 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1113 set< shared_ptr<Trace> > &add_list)
1115 vector< shared_ptr<Trace> > filtered_traces;
1117 for (const auto &channel : channels) {
1118 for (auto entry : signal_map) {
1119 if (entry.first->channel() == channel) {
1120 shared_ptr<Trace> trace = entry.second;
1121 const auto list_iter = add_list.find(trace);
1122 if (list_iter == add_list.end())
1125 filtered_traces.push_back(trace);
1126 add_list.erase(list_iter);
1131 return filtered_traces;
1134 void View::determine_time_unit()
1136 // Check whether we know the sample rate and hence can use time as the unit
1137 if (time_unit_ == util::TimeUnit::Samples) {
1138 // Check all signals but...
1139 for (const shared_ptr<Signal> signal : signals_) {
1140 const shared_ptr<SignalData> data = signal->data();
1142 // ...only check first segment of each
1143 const vector< shared_ptr<Segment> > segments = data->segments();
1144 if (!segments.empty())
1145 if (segments[0]->samplerate()) {
1146 set_time_unit(util::TimeUnit::Time);
1153 bool View::eventFilter(QObject *object, QEvent *event)
1155 const QEvent::Type type = event->type();
1156 if (type == QEvent::MouseMove) {
1158 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1159 if (object == viewport_)
1160 hover_point_ = mouse_event->pos();
1161 else if (object == ruler_)
1162 hover_point_ = QPoint(mouse_event->x(), 0);
1163 else if (object == header_)
1164 hover_point_ = QPoint(0, mouse_event->y());
1166 hover_point_ = QPoint(-1, -1);
1168 update_hover_point();
1170 } else if (type == QEvent::Leave) {
1171 hover_point_ = QPoint(-1, -1);
1172 update_hover_point();
1173 } else if (type == QEvent::Show) {
1175 // This is somewhat of a hack, unfortunately. We cannot use
1176 // set_v_offset() from within restore_settings() as the view
1177 // at that point is neither visible nor properly sized.
1178 // This is the least intrusive workaround I could come up
1179 // with: set the vertical offset (or scroll defaults) when
1180 // the view is shown, which happens after all widgets were
1181 // resized to their final sizes.
1184 if (settings_restored_)
1185 determine_if_header_was_shrunk();
1187 resize_header_to_fit();
1189 if (scroll_needs_defaults_) {
1190 set_scroll_default();
1191 scroll_needs_defaults_ = false;
1194 if (saved_v_offset_) {
1195 set_v_offset(saved_v_offset_);
1196 saved_v_offset_ = 0;
1200 return QObject::eventFilter(object, event);
1203 void View::resizeEvent(QResizeEvent* event)
1205 // Only adjust the top margin if we shrunk vertically
1206 if (event->size().height() < event->oldSize().height())
1207 adjust_top_margin();
1212 void View::update_hover_point()
1214 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1215 list_by_type<TraceTreeItem>());
1216 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1217 r->hover_point_changed(hover_point_);
1219 hover_point_changed(hover_point_);
1222 void View::row_item_appearance_changed(bool label, bool content)
1227 viewport_->update();
1230 void View::time_item_appearance_changed(bool label, bool content)
1235 // Make sure the header pane width is updated, too
1240 viewport_->update();
1243 void View::extents_changed(bool horz, bool vert)
1246 (horz ? TraceTreeItemHExtentsChanged : 0) |
1247 (vert ? TraceTreeItemVExtentsChanged : 0);
1249 lazy_event_handler_.start();
1252 void View::on_signal_name_changed()
1254 if (!header_was_shrunk_)
1255 resize_header_to_fit();
1258 void View::on_splitter_moved()
1260 // The header can only shrink when the splitter is moved manually
1261 determine_if_header_was_shrunk();
1263 if (!header_was_shrunk_)
1264 resize_header_to_fit();
1267 void View::h_scroll_value_changed(int value)
1269 if (updating_scroll_)
1272 // Disable sticky scrolling when user moves the horizontal scroll bar
1273 // during a running acquisition
1274 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1275 sticky_scrolling_ = false;
1276 sticky_scrolling_changed(false);
1279 const int range = scrollarea_->horizontalScrollBar()->maximum();
1280 if (range < MaxScrollValue)
1281 set_offset(scale_ * value);
1285 get_scroll_layout(length, offset);
1286 set_offset(scale_ * length * value / MaxScrollValue);
1290 viewport_->update();
1293 void View::v_scroll_value_changed()
1296 viewport_->update();
1299 void View::signals_changed()
1301 using sigrok::Channel;
1303 vector< shared_ptr<Channel> > channels;
1304 shared_ptr<sigrok::Device> sr_dev;
1305 bool signals_added_or_removed = false;
1307 // Do we need to set the vertical scrollbar to its default position later?
1308 // We do if there are no traces, i.e. the scroll bar has no range set
1309 bool reset_scrollbar =
1310 (scrollarea_->verticalScrollBar()->minimum() ==
1311 scrollarea_->verticalScrollBar()->maximum());
1313 if (!session_.device()) {
1317 sr_dev = session_.device()->device();
1319 channels = sr_dev->channels();
1322 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1324 // Make a list of traces that are being added, and a list of traces
1325 // that are being removed
1326 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1327 const set<shared_ptr<Trace>> prev_traces(
1328 prev_trace_list.begin(), prev_trace_list.end());
1330 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1332 #ifdef ENABLE_DECODE
1333 traces.insert(decode_traces_.begin(), decode_traces_.end());
1336 set< shared_ptr<Trace> > add_traces;
1337 set_difference(traces.begin(), traces.end(),
1338 prev_traces.begin(), prev_traces.end(),
1339 inserter(add_traces, add_traces.begin()));
1341 set< shared_ptr<Trace> > remove_traces;
1342 set_difference(prev_traces.begin(), prev_traces.end(),
1343 traces.begin(), traces.end(),
1344 inserter(remove_traces, remove_traces.begin()));
1346 // Make a look-up table of sigrok Channels to pulseview Signals
1347 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1349 for (const shared_ptr<Signal> &sig : signals_)
1350 signal_map[sig->base()] = sig;
1352 // Populate channel groups
1354 for (auto entry : sr_dev->channel_groups()) {
1355 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1357 if (group->channels().size() <= 1)
1360 // Find best trace group to add to
1361 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1364 // If there is no trace group, create one
1365 shared_ptr<TraceGroup> new_trace_group;
1367 new_trace_group.reset(new TraceGroup());
1368 owner = new_trace_group.get();
1371 // Extract traces for the trace group, removing them from
1373 const vector< shared_ptr<Trace> > new_traces_in_group =
1374 extract_new_traces_for_channels(group->channels(),
1375 signal_map, add_traces);
1377 // Add the traces to the group
1378 const pair<int, int> prev_v_extents = owner->v_extents();
1379 int offset = prev_v_extents.second - prev_v_extents.first;
1380 for (shared_ptr<Trace> trace : new_traces_in_group) {
1382 owner->add_child_item(trace);
1384 const pair<int, int> extents = trace->v_extents();
1385 if (trace->enabled())
1386 offset += -extents.first;
1387 trace->force_to_v_offset(offset);
1388 if (trace->enabled())
1389 offset += extents.second;
1392 if (new_trace_group) {
1393 // Assign proper vertical offsets to each channel in the group
1394 new_trace_group->restack_items();
1396 // If this is a new group, enqueue it in the new top level
1398 if (!new_traces_in_group.empty())
1399 new_top_level_items.push_back(new_trace_group);
1403 // Enqueue the remaining logic channels in a group
1404 vector< shared_ptr<Channel> > logic_channels;
1405 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1406 [](const shared_ptr<Channel>& c) {
1407 return c->type() == sigrok::ChannelType::LOGIC; });
1409 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1410 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1412 if (non_grouped_logic_signals.size() > 0) {
1413 const shared_ptr<TraceGroup> non_grouped_trace_group(
1414 make_shared<TraceGroup>());
1415 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1416 non_grouped_trace_group->add_child_item(trace);
1418 non_grouped_trace_group->restack_items();
1419 new_top_level_items.push_back(non_grouped_trace_group);
1422 // Enqueue the remaining channels as free ungrouped traces
1423 const vector< shared_ptr<Trace> > new_top_level_signals =
1424 extract_new_traces_for_channels(channels, signal_map, add_traces);
1425 new_top_level_items.insert(new_top_level_items.end(),
1426 new_top_level_signals.begin(), new_top_level_signals.end());
1428 // Enqueue any remaining traces i.e. decode traces
1429 new_top_level_items.insert(new_top_level_items.end(),
1430 add_traces.begin(), add_traces.end());
1432 // Remove any removed traces
1433 for (shared_ptr<Trace> trace : remove_traces) {
1434 TraceTreeItemOwner *const owner = trace->owner();
1436 owner->remove_child_item(trace);
1437 signals_added_or_removed = true;
1440 // Remove any empty trace groups
1441 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1442 if (group->child_items().size() == 0) {
1443 remove_child_item(group);
1447 // Add and position the pending top levels items
1448 int offset = v_extents().second;
1449 for (auto item : new_top_level_items) {
1450 add_child_item(item);
1452 // Position the item after the last item or at the top if there is none
1453 const pair<int, int> extents = item->v_extents();
1455 if (item->enabled())
1456 offset += -extents.first;
1458 item->force_to_v_offset(offset);
1460 if (item->enabled())
1461 offset += extents.second;
1462 signals_added_or_removed = true;
1466 if (signals_added_or_removed && !header_was_shrunk_)
1467 resize_header_to_fit();
1472 viewport_->update();
1474 if (reset_scrollbar)
1475 set_scroll_default();
1478 void View::capture_state_updated(int state)
1480 GlobalSettings settings;
1482 if (state == Session::Running) {
1483 set_time_unit(util::TimeUnit::Samples);
1485 trigger_markers_.clear();
1487 scale_at_acq_start_ = scale_;
1488 offset_at_acq_start_ = offset_;
1490 // Activate "always zoom to fit" if the setting is enabled and we're
1491 // the main view of this session (other trace views may be used for
1492 // zooming and we don't want to mess them up)
1493 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1494 if (is_main_view_ && state) {
1495 always_zoom_to_fit_ = true;
1496 always_zoom_to_fit_changed(always_zoom_to_fit_);
1499 // Enable sticky scrolling if the setting is enabled
1500 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1502 // Reset all traces to segment 0
1503 current_segment_ = 0;
1504 set_current_segment(current_segment_);
1507 if (state == Session::Stopped) {
1508 // After acquisition has stopped we need to re-calculate the ticks once
1509 // as it's otherwise done when the user pans or zooms, which is too late
1510 calculate_tick_spacing();
1512 // Reset "always zoom to fit", the acquisition has stopped
1513 if (always_zoom_to_fit_) {
1514 // Perform a final zoom-to-fit before disabling
1515 zoom_fit(always_zoom_to_fit_);
1516 always_zoom_to_fit_ = false;
1517 always_zoom_to_fit_changed(always_zoom_to_fit_);
1520 bool zoom_to_fit_after_acq =
1521 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1523 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1524 // we didn't restore settings in the meanwhile
1525 if (zoom_to_fit_after_acq &&
1526 !suppress_zoom_to_fit_after_acq_ &&
1527 (scale_ == scale_at_acq_start_) &&
1528 (offset_ == offset_at_acq_start_))
1529 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1531 suppress_zoom_to_fit_after_acq_ = false;
1535 void View::on_new_segment(int new_segment_id)
1537 on_segment_changed(new_segment_id);
1540 void View::on_segment_completed(int segment_id)
1542 on_segment_changed(segment_id);
1545 void View::on_segment_changed(int segment)
1547 switch (segment_display_mode_) {
1548 case Trace::ShowLastSegmentOnly:
1549 case Trace::ShowSingleSegmentOnly:
1550 set_current_segment(segment);
1553 case Trace::ShowLastCompleteSegmentOnly:
1554 // Only update if all segments are complete
1555 if (session_.all_segments_complete(segment))
1556 set_current_segment(segment);
1559 case Trace::ShowAllSegments:
1560 case Trace::ShowAccumulatedIntensity:
1566 void View::perform_delayed_view_update()
1568 if (always_zoom_to_fit_) {
1570 } else if (sticky_scrolling_) {
1571 // Make right side of the view sticky
1574 get_scroll_layout(length, offset);
1576 const QSize areaSize = viewport_->size();
1577 length = max(length - areaSize.width(), 0.0);
1579 set_offset(scale_ * length);
1582 determine_time_unit();
1585 viewport_->update();
1588 void View::process_sticky_events()
1590 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1592 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1593 restack_all_trace_tree_items();
1597 // Clear the sticky events
1601 } // namespace trace
1602 } // namespace views