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 void View::set_tick_period(const pv::util::Timestamp& tick_period)
511 if (tick_period_ != tick_period) {
512 tick_period_ = tick_period;
513 tick_period_changed();
517 TimeUnit View::time_unit() const
522 void View::set_time_unit(pv::util::TimeUnit time_unit)
524 if (time_unit_ != time_unit) {
525 time_unit_ = time_unit;
530 void View::set_current_segment(uint32_t segment_id)
532 current_segment_ = segment_id;
534 for (shared_ptr<Signal> signal : signals_)
535 signal->set_current_segment(current_segment_);
536 for (shared_ptr<DecodeTrace> dt : decode_traces_)
537 dt->set_current_segment(current_segment_);
541 segment_changed(segment_id);
544 bool View::segment_is_selectable() const
546 return segment_selectable_;
549 Trace::SegmentDisplayMode View::segment_display_mode() const
551 return segment_display_mode_;
554 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
556 segment_display_mode_ = mode;
558 for (shared_ptr<Signal> signal : signals_)
559 signal->set_segment_display_mode(mode);
561 uint32_t last_segment = session_.get_segment_count() - 1;
564 case Trace::ShowLastSegmentOnly:
565 if (current_segment_ != last_segment)
566 set_current_segment(last_segment);
569 case Trace::ShowLastCompleteSegmentOnly:
570 // Do nothing if we only have one segment so far
571 if (last_segment > 0) {
572 // If the last segment isn't complete, the previous one must be
573 uint32_t segment_id =
574 (session_.all_segments_complete(last_segment)) ?
575 last_segment : last_segment - 1;
577 if (current_segment_ != segment_id)
578 set_current_segment(segment_id);
582 case Trace::ShowSingleSegmentOnly:
583 case Trace::ShowAllSegments:
584 case Trace::ShowAccumulatedIntensity:
586 // Current segment remains as-is
590 segment_selectable_ = true;
592 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
593 segment_selectable_ = false;
597 segment_display_mode_changed((int)mode, segment_selectable_);
600 void View::zoom(double steps)
602 zoom(steps, viewport_->width() / 2);
605 void View::zoom(double steps, int offset)
607 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
610 void View::zoom_fit(bool gui_state)
612 // Act as one-shot when stopped, toggle along with the GUI otherwise
613 if (session_.get_capture_state() == Session::Stopped) {
614 always_zoom_to_fit_ = false;
615 always_zoom_to_fit_changed(false);
617 always_zoom_to_fit_ = gui_state;
618 always_zoom_to_fit_changed(gui_state);
621 const pair<Timestamp, Timestamp> extents = get_time_extents();
622 const Timestamp delta = extents.second - extents.first;
623 if (delta < Timestamp("1e-12"))
627 const int w = viewport_->width();
631 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
632 set_scale_offset(scale.convert_to<double>(), extents.first);
635 void View::zoom_one_to_one()
637 using pv::data::SignalData;
639 // Make a set of all the visible data objects
640 set< shared_ptr<SignalData> > visible_data = get_visible_data();
641 if (visible_data.empty())
645 const int w = viewport_->width();
649 set_zoom(1.0 / session_.get_samplerate(), w / 2);
652 void View::set_scale_offset(double scale, const Timestamp& offset)
654 // Disable sticky scrolling / always zoom to fit when acquisition runs
655 // and user drags the viewport
656 if ((scale_ == scale) && (offset_ != offset) &&
657 (session_.get_capture_state() == Session::Running)) {
659 if (sticky_scrolling_) {
660 sticky_scrolling_ = false;
661 sticky_scrolling_changed(false);
664 if (always_zoom_to_fit_) {
665 always_zoom_to_fit_ = false;
666 always_zoom_to_fit_changed(false);
673 calculate_tick_spacing();
680 set< shared_ptr<SignalData> > View::get_visible_data() const
682 // Make a set of all the visible data objects
683 set< shared_ptr<SignalData> > visible_data;
684 for (const shared_ptr<Signal> sig : signals_)
686 visible_data.insert(sig->data());
691 pair<Timestamp, Timestamp> View::get_time_extents() const
693 boost::optional<Timestamp> left_time, right_time;
694 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
695 for (const shared_ptr<SignalData> d : visible_data) {
696 const vector< shared_ptr<Segment> > segments = d->segments();
697 for (const shared_ptr<Segment> &s : segments) {
698 double samplerate = s->samplerate();
699 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
701 const Timestamp start_time = s->start_time();
702 left_time = left_time ?
703 min(*left_time, start_time) :
705 right_time = right_time ?
706 max(*right_time, start_time + d->max_sample_count() / samplerate) :
707 start_time + d->max_sample_count() / samplerate;
711 if (!left_time || !right_time)
712 return make_pair(0, 0);
714 assert(*left_time < *right_time);
715 return make_pair(*left_time, *right_time);
718 void View::enable_show_sampling_points(bool state)
725 void View::enable_show_analog_minor_grid(bool state)
732 void View::enable_coloured_bg(bool state)
734 coloured_bg_ = state;
738 bool View::coloured_bg() const
743 bool View::cursors_shown() const
745 return show_cursors_;
748 void View::show_cursors(bool show)
750 show_cursors_ = show;
755 void View::centre_cursors()
757 const double time_width = scale_ * viewport_->width();
758 cursors_->first()->set_time(offset_ + time_width * 0.4);
759 cursors_->second()->set_time(offset_ + time_width * 0.6);
764 shared_ptr<CursorPair> View::cursors() const
769 void View::add_flag(const Timestamp& time)
771 flags_.push_back(make_shared<Flag>(*this, time,
772 QString("%1").arg(next_flag_text_)));
774 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
775 (next_flag_text_ + 1);
777 time_item_appearance_changed(true, true);
780 void View::remove_flag(shared_ptr<Flag> flag)
783 time_item_appearance_changed(true, true);
786 vector< shared_ptr<Flag> > View::flags() const
788 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
789 stable_sort(flags.begin(), flags.end(),
790 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
791 return a->time() < b->time();
797 const QPoint& View::hover_point() const
802 void View::restack_all_trace_tree_items()
804 // Make a list of owners that is sorted from deepest first
805 const vector<shared_ptr<TraceTreeItem>> items(
806 list_by_type<TraceTreeItem>());
807 set< TraceTreeItemOwner* > owners;
808 for (const auto &r : items)
809 owners.insert(r->owner());
810 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
811 sort(sorted_owners.begin(), sorted_owners.end(),
812 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
813 return a->depth() > b->depth(); });
815 // Restack the items recursively
816 for (auto &o : sorted_owners)
819 // Animate the items to their destination
820 for (const auto &i : items)
821 i->animate_to_layout_v_offset();
824 void View::trigger_event(util::Timestamp location)
826 // Set up ruler_shift if the Key_View_TriggerIsZeroTime option is set.
827 GlobalSettings settings;
828 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
830 ruler_shift_ = (trigger_is_zero_time) ? (-location) : (0);
831 // Force an immediate update of both offsets
833 set_offset(offset_ + 0.001);
835 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
838 void View::get_scroll_layout(double &length, Timestamp &offset) const
840 const pair<Timestamp, Timestamp> extents = get_time_extents();
841 length = ((extents.second - extents.first) / scale_).convert_to<double>();
842 offset = offset_ / scale_;
845 void View::set_zoom(double scale, int offset)
847 // Reset the "always zoom to fit" feature as the user changed the zoom
848 always_zoom_to_fit_ = false;
849 always_zoom_to_fit_changed(false);
851 const Timestamp cursor_offset = offset_ + scale_ * offset;
852 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
853 const Timestamp new_offset = cursor_offset - new_scale * offset;
854 set_scale_offset(new_scale.convert_to<double>(), new_offset);
857 void View::calculate_tick_spacing()
859 const double SpacingIncrement = 10.0f;
860 const double MinValueSpacing = 40.0f;
862 // Figure out the highest numeric value visible on a label
863 const QSize areaSize = viewport_->size();
864 const Timestamp max_time = max(fabs(offset_),
865 fabs(offset_ + scale_ * areaSize.width()));
867 double min_width = SpacingIncrement;
868 double label_width, tick_period_width;
870 QFontMetrics m(QApplication::font());
872 // Copies of the member variables with the same name, used in the calculation
873 // and written back afterwards, so that we don't emit signals all the time
874 // during the calculation.
875 pv::util::Timestamp tick_period = tick_period_;
876 pv::util::SIPrefix tick_prefix = tick_prefix_;
877 unsigned tick_precision = tick_precision_;
880 const double min_period = scale_ * min_width;
882 const int order = (int)floorf(log10f(min_period));
883 const pv::util::Timestamp order_decimal =
884 pow(pv::util::Timestamp(10), order);
886 // Allow for a margin of error so that a scale unit of 1 can be used.
887 // Otherwise, for a SU of 1 the tick period will almost always be below
888 // the min_period by a small amount - and thus skipped in favor of 2.
889 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
890 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
891 double tp_with_margin;
892 unsigned int unit = 0;
895 tp_with_margin = order_decimal.convert_to<double>() *
896 (ScaleUnits[unit++] + tp_margin);
897 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
899 tick_period = order_decimal * ScaleUnits[unit - 1];
900 tick_prefix = static_cast<pv::util::SIPrefix>(
901 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
903 // Precision is the number of fractional digits required, not
904 // taking the prefix into account (and it must never be negative)
905 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
907 tick_period_width = (tick_period / scale_).convert_to<double>();
909 const QString label_text = Ruler::format_time_with_distance(
910 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
912 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
913 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
916 min_width += SpacingIncrement;
917 } while (tick_period_width < label_width);
919 set_tick_period(tick_period);
920 set_tick_prefix(tick_prefix);
921 set_tick_precision(tick_precision);
924 void View::adjust_top_margin()
928 const QSize areaSize = viewport_->size();
930 const pair<int, int> extents = v_extents();
931 const int top_margin = owner_visual_v_offset() + extents.first;
932 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
934 // Do we have empty space at the top while the last trace goes out of screen?
935 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
936 const int trace_height = extents.second - extents.first;
938 // Center everything vertically if there is enough space
939 if (areaSize.height() >= trace_height)
940 set_v_offset(extents.first -
941 ((areaSize.height() - trace_height) / 2));
943 // Remove the top margin to make as many traces fit on screen as possible
944 set_v_offset(extents.first);
948 void View::update_scroll()
951 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
952 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
954 const QSize areaSize = viewport_->size();
956 // Set the horizontal scroll bar
959 get_scroll_layout(length, offset);
960 length = max(length - areaSize.width(), 0.0);
962 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
964 hscrollbar->setPageStep(areaSize.width() / 2);
965 hscrollbar->setSingleStep(major_tick_distance);
967 updating_scroll_ = true;
969 if (length < MaxScrollValue) {
970 hscrollbar->setRange(0, length);
971 hscrollbar->setSliderPosition(offset.convert_to<double>());
973 hscrollbar->setRange(0, MaxScrollValue);
974 hscrollbar->setSliderPosition(
975 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
978 updating_scroll_ = false;
980 // Set the vertical scrollbar
981 vscrollbar->setPageStep(areaSize.height());
982 vscrollbar->setSingleStep(areaSize.height() / 8);
984 const pair<int, int> extents = v_extents();
986 // Don't change the scrollbar range if there are no traces
987 if (extents.first != extents.second)
988 vscrollbar->setRange(extents.first - areaSize.height(),
991 if (scroll_needs_defaults_)
992 set_scroll_default();
995 void View::reset_scroll()
997 scrollarea_->verticalScrollBar()->setRange(0, 0);
1000 void View::set_scroll_default()
1004 const QSize areaSize = viewport_->size();
1006 const pair<int, int> extents = v_extents();
1007 const int trace_height = extents.second - extents.first;
1009 // Do all traces fit in the view?
1010 if (areaSize.height() >= trace_height)
1011 // Center all traces vertically
1012 set_v_offset(extents.first -
1013 ((areaSize.height() - trace_height) / 2));
1015 // Put the first trace at the top, letting the bottom ones overflow
1016 set_v_offset(extents.first);
1019 void View::determine_if_header_was_shrunk()
1021 const int header_pane_width = splitter_->sizes().front();
1022 const int header_width = header_->extended_size_hint().width();
1024 // Allow for a slight margin of error so that we also accept
1025 // slight differences when e.g. a label name change increased
1026 // the overall width
1027 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1030 void View::resize_header_to_fit()
1032 // Setting the maximum width of the header widget doesn't work as
1033 // expected because the splitter would allow the user to make the
1034 // pane wider than that, creating empty space as a result.
1035 // To make this work, we stricly enforce the maximum width by
1036 // expanding the header unless the user shrunk it on purpose.
1037 // As we're then setting the width of the header pane, we set the
1038 // splitter to the maximum allowed position.
1040 int splitter_area_width = 0;
1041 for (int w : splitter_->sizes())
1042 splitter_area_width += w;
1044 // Make sure the header has enough horizontal space to show all labels fully
1045 QList<int> pane_sizes;
1046 pane_sizes.push_back(header_->extended_size_hint().width());
1047 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1048 splitter_->setSizes(pane_sizes);
1051 void View::update_layout()
1056 TraceTreeItemOwner* View::find_prevalent_trace_group(
1057 const shared_ptr<sigrok::ChannelGroup> &group,
1058 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1063 unordered_set<TraceTreeItemOwner*> owners;
1064 vector<TraceTreeItemOwner*> owner_list;
1066 // Make a set and a list of all the owners
1067 for (const auto &channel : group->channels()) {
1068 for (auto entry : signal_map) {
1069 if (entry.first->channel() == channel) {
1070 TraceTreeItemOwner *const o = (entry.second)->owner();
1071 owner_list.push_back(o);
1077 // Iterate through the list of owners, and find the most prevalent
1078 size_t max_prevalence = 0;
1079 TraceTreeItemOwner *prevalent_owner = nullptr;
1080 for (TraceTreeItemOwner *owner : owners) {
1081 const size_t prevalence = count_if(
1082 owner_list.begin(), owner_list.end(),
1083 [&](TraceTreeItemOwner *o) { return o == owner; });
1084 if (prevalence > max_prevalence) {
1085 max_prevalence = prevalence;
1086 prevalent_owner = owner;
1090 return prevalent_owner;
1093 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1094 const vector< shared_ptr<sigrok::Channel> > &channels,
1095 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1097 set< shared_ptr<Trace> > &add_list)
1099 vector< shared_ptr<Trace> > filtered_traces;
1101 for (const auto &channel : channels) {
1102 for (auto entry : signal_map) {
1103 if (entry.first->channel() == channel) {
1104 shared_ptr<Trace> trace = entry.second;
1105 const auto list_iter = add_list.find(trace);
1106 if (list_iter == add_list.end())
1109 filtered_traces.push_back(trace);
1110 add_list.erase(list_iter);
1115 return filtered_traces;
1118 void View::determine_time_unit()
1120 // Check whether we know the sample rate and hence can use time as the unit
1121 if (time_unit_ == util::TimeUnit::Samples) {
1122 // Check all signals but...
1123 for (const shared_ptr<Signal> signal : signals_) {
1124 const shared_ptr<SignalData> data = signal->data();
1126 // ...only check first segment of each
1127 const vector< shared_ptr<Segment> > segments = data->segments();
1128 if (!segments.empty())
1129 if (segments[0]->samplerate()) {
1130 set_time_unit(util::TimeUnit::Time);
1137 bool View::eventFilter(QObject *object, QEvent *event)
1139 const QEvent::Type type = event->type();
1140 if (type == QEvent::MouseMove) {
1142 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1143 if (object == viewport_)
1144 hover_point_ = mouse_event->pos();
1145 else if (object == ruler_)
1146 hover_point_ = QPoint(mouse_event->x(), 0);
1147 else if (object == header_)
1148 hover_point_ = QPoint(0, mouse_event->y());
1150 hover_point_ = QPoint(-1, -1);
1152 update_hover_point();
1154 } else if (type == QEvent::Leave) {
1155 hover_point_ = QPoint(-1, -1);
1156 update_hover_point();
1157 } else if (type == QEvent::Show) {
1159 // This is somewhat of a hack, unfortunately. We cannot use
1160 // set_v_offset() from within restore_settings() as the view
1161 // at that point is neither visible nor properly sized.
1162 // This is the least intrusive workaround I could come up
1163 // with: set the vertical offset (or scroll defaults) when
1164 // the view is shown, which happens after all widgets were
1165 // resized to their final sizes.
1168 if (settings_restored_)
1169 determine_if_header_was_shrunk();
1171 resize_header_to_fit();
1173 if (scroll_needs_defaults_) {
1174 set_scroll_default();
1175 scroll_needs_defaults_ = false;
1178 if (saved_v_offset_) {
1179 set_v_offset(saved_v_offset_);
1180 saved_v_offset_ = 0;
1184 return QObject::eventFilter(object, event);
1187 void View::resizeEvent(QResizeEvent* event)
1189 // Only adjust the top margin if we shrunk vertically
1190 if (event->size().height() < event->oldSize().height())
1191 adjust_top_margin();
1196 void View::update_hover_point()
1198 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1199 list_by_type<TraceTreeItem>());
1200 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1201 r->hover_point_changed(hover_point_);
1203 hover_point_changed(hover_point_);
1206 void View::row_item_appearance_changed(bool label, bool content)
1211 viewport_->update();
1214 void View::time_item_appearance_changed(bool label, bool content)
1219 // Make sure the header pane width is updated, too
1224 viewport_->update();
1227 void View::extents_changed(bool horz, bool vert)
1230 (horz ? TraceTreeItemHExtentsChanged : 0) |
1231 (vert ? TraceTreeItemVExtentsChanged : 0);
1233 lazy_event_handler_.start();
1236 void View::on_signal_name_changed()
1238 if (!header_was_shrunk_)
1239 resize_header_to_fit();
1242 void View::on_splitter_moved()
1244 // The header can only shrink when the splitter is moved manually
1245 determine_if_header_was_shrunk();
1247 if (!header_was_shrunk_)
1248 resize_header_to_fit();
1251 void View::h_scroll_value_changed(int value)
1253 if (updating_scroll_)
1256 // Disable sticky scrolling when user moves the horizontal scroll bar
1257 // during a running acquisition
1258 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1259 sticky_scrolling_ = false;
1260 sticky_scrolling_changed(false);
1263 const int range = scrollarea_->horizontalScrollBar()->maximum();
1264 if (range < MaxScrollValue)
1265 set_offset(scale_ * value);
1269 get_scroll_layout(length, offset);
1270 set_offset(scale_ * length * value / MaxScrollValue);
1274 viewport_->update();
1277 void View::v_scroll_value_changed()
1280 viewport_->update();
1283 void View::signals_changed()
1285 using sigrok::Channel;
1287 vector< shared_ptr<Channel> > channels;
1288 shared_ptr<sigrok::Device> sr_dev;
1289 bool signals_added_or_removed = false;
1291 // Do we need to set the vertical scrollbar to its default position later?
1292 // We do if there are no traces, i.e. the scroll bar has no range set
1293 bool reset_scrollbar =
1294 (scrollarea_->verticalScrollBar()->minimum() ==
1295 scrollarea_->verticalScrollBar()->maximum());
1297 if (!session_.device()) {
1301 sr_dev = session_.device()->device();
1303 channels = sr_dev->channels();
1306 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1308 // Make a list of traces that are being added, and a list of traces
1309 // that are being removed
1310 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1311 const set<shared_ptr<Trace>> prev_traces(
1312 prev_trace_list.begin(), prev_trace_list.end());
1314 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1316 #ifdef ENABLE_DECODE
1317 traces.insert(decode_traces_.begin(), decode_traces_.end());
1320 set< shared_ptr<Trace> > add_traces;
1321 set_difference(traces.begin(), traces.end(),
1322 prev_traces.begin(), prev_traces.end(),
1323 inserter(add_traces, add_traces.begin()));
1325 set< shared_ptr<Trace> > remove_traces;
1326 set_difference(prev_traces.begin(), prev_traces.end(),
1327 traces.begin(), traces.end(),
1328 inserter(remove_traces, remove_traces.begin()));
1330 // Make a look-up table of sigrok Channels to pulseview Signals
1331 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1333 for (const shared_ptr<Signal> &sig : signals_)
1334 signal_map[sig->base()] = sig;
1336 // Populate channel groups
1338 for (auto entry : sr_dev->channel_groups()) {
1339 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1341 if (group->channels().size() <= 1)
1344 // Find best trace group to add to
1345 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1348 // If there is no trace group, create one
1349 shared_ptr<TraceGroup> new_trace_group;
1351 new_trace_group.reset(new TraceGroup());
1352 owner = new_trace_group.get();
1355 // Extract traces for the trace group, removing them from
1357 const vector< shared_ptr<Trace> > new_traces_in_group =
1358 extract_new_traces_for_channels(group->channels(),
1359 signal_map, add_traces);
1361 // Add the traces to the group
1362 const pair<int, int> prev_v_extents = owner->v_extents();
1363 int offset = prev_v_extents.second - prev_v_extents.first;
1364 for (shared_ptr<Trace> trace : new_traces_in_group) {
1366 owner->add_child_item(trace);
1368 const pair<int, int> extents = trace->v_extents();
1369 if (trace->enabled())
1370 offset += -extents.first;
1371 trace->force_to_v_offset(offset);
1372 if (trace->enabled())
1373 offset += extents.second;
1376 if (new_trace_group) {
1377 // Assign proper vertical offsets to each channel in the group
1378 new_trace_group->restack_items();
1380 // If this is a new group, enqueue it in the new top level
1382 if (!new_traces_in_group.empty())
1383 new_top_level_items.push_back(new_trace_group);
1387 // Enqueue the remaining logic channels in a group
1388 vector< shared_ptr<Channel> > logic_channels;
1389 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1390 [](const shared_ptr<Channel>& c) {
1391 return c->type() == sigrok::ChannelType::LOGIC; });
1393 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1394 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1396 if (non_grouped_logic_signals.size() > 0) {
1397 const shared_ptr<TraceGroup> non_grouped_trace_group(
1398 make_shared<TraceGroup>());
1399 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1400 non_grouped_trace_group->add_child_item(trace);
1402 non_grouped_trace_group->restack_items();
1403 new_top_level_items.push_back(non_grouped_trace_group);
1406 // Enqueue the remaining channels as free ungrouped traces
1407 const vector< shared_ptr<Trace> > new_top_level_signals =
1408 extract_new_traces_for_channels(channels, signal_map, add_traces);
1409 new_top_level_items.insert(new_top_level_items.end(),
1410 new_top_level_signals.begin(), new_top_level_signals.end());
1412 // Enqueue any remaining traces i.e. decode traces
1413 new_top_level_items.insert(new_top_level_items.end(),
1414 add_traces.begin(), add_traces.end());
1416 // Remove any removed traces
1417 for (shared_ptr<Trace> trace : remove_traces) {
1418 TraceTreeItemOwner *const owner = trace->owner();
1420 owner->remove_child_item(trace);
1421 signals_added_or_removed = true;
1424 // Remove any empty trace groups
1425 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1426 if (group->child_items().size() == 0) {
1427 remove_child_item(group);
1431 // Add and position the pending top levels items
1432 int offset = v_extents().second;
1433 for (auto item : new_top_level_items) {
1434 add_child_item(item);
1436 // Position the item after the last item or at the top if there is none
1437 const pair<int, int> extents = item->v_extents();
1439 if (item->enabled())
1440 offset += -extents.first;
1442 item->force_to_v_offset(offset);
1444 if (item->enabled())
1445 offset += extents.second;
1446 signals_added_or_removed = true;
1450 if (signals_added_or_removed && !header_was_shrunk_)
1451 resize_header_to_fit();
1456 viewport_->update();
1458 if (reset_scrollbar)
1459 set_scroll_default();
1462 void View::capture_state_updated(int state)
1464 GlobalSettings settings;
1466 if (state == Session::Running) {
1467 set_time_unit(util::TimeUnit::Samples);
1469 trigger_markers_.clear();
1471 scale_at_acq_start_ = scale_;
1472 offset_at_acq_start_ = offset_;
1474 // Activate "always zoom to fit" if the setting is enabled and we're
1475 // the main view of this session (other trace views may be used for
1476 // zooming and we don't want to mess them up)
1477 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1478 if (is_main_view_ && state) {
1479 always_zoom_to_fit_ = true;
1480 always_zoom_to_fit_changed(always_zoom_to_fit_);
1483 // Enable sticky scrolling if the setting is enabled
1484 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1486 // Reset all traces to segment 0
1487 current_segment_ = 0;
1488 set_current_segment(current_segment_);
1491 if (state == Session::Stopped) {
1492 // After acquisition has stopped we need to re-calculate the ticks once
1493 // as it's otherwise done when the user pans or zooms, which is too late
1494 calculate_tick_spacing();
1496 // Reset "always zoom to fit", the acquisition has stopped
1497 if (always_zoom_to_fit_) {
1498 // Perform a final zoom-to-fit before disabling
1499 zoom_fit(always_zoom_to_fit_);
1500 always_zoom_to_fit_ = false;
1501 always_zoom_to_fit_changed(always_zoom_to_fit_);
1504 bool zoom_to_fit_after_acq =
1505 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1507 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1508 // we didn't restore settings in the meanwhile
1509 if (zoom_to_fit_after_acq &&
1510 !suppress_zoom_to_fit_after_acq_ &&
1511 (scale_ == scale_at_acq_start_) &&
1512 (offset_ == offset_at_acq_start_))
1513 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1515 suppress_zoom_to_fit_after_acq_ = false;
1519 void View::on_new_segment(int new_segment_id)
1521 on_segment_changed(new_segment_id);
1524 void View::on_segment_completed(int segment_id)
1526 on_segment_changed(segment_id);
1529 void View::on_segment_changed(int segment)
1531 switch (segment_display_mode_) {
1532 case Trace::ShowLastSegmentOnly:
1533 case Trace::ShowSingleSegmentOnly:
1534 set_current_segment(segment);
1537 case Trace::ShowLastCompleteSegmentOnly:
1538 // Only update if all segments are complete
1539 if (session_.all_segments_complete(segment))
1540 set_current_segment(segment);
1543 case Trace::ShowAllSegments:
1544 case Trace::ShowAccumulatedIntensity:
1550 void View::perform_delayed_view_update()
1552 if (always_zoom_to_fit_) {
1554 } else if (sticky_scrolling_) {
1555 // Make right side of the view sticky
1558 get_scroll_layout(length, offset);
1560 const QSize areaSize = viewport_->size();
1561 length = max(length - areaSize.width(), 0.0);
1563 set_offset(scale_ * length);
1566 determine_time_unit();
1569 viewport_->update();
1572 void View::process_sticky_events()
1574 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1576 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1577 restack_all_trace_tree_items();
1581 // Clear the sticky events
1585 } // namespace trace
1586 } // namespace views