2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
32 #include <unordered_set>
34 #include <boost/archive/text_iarchive.hpp>
35 #include <boost/archive/text_oarchive.hpp>
36 #include <boost/serialization/serialization.hpp>
38 #include <QApplication>
40 #include <QFontMetrics>
41 #include <QMouseEvent>
43 #include <QVBoxLayout>
45 #include <libsigrokcxx/libsigrokcxx.hpp>
47 #include "analogsignal.hpp"
49 #include "logicsignal.hpp"
52 #include "tracegroup.hpp"
53 #include "triggermarker.hpp"
55 #include "viewport.hpp"
57 #include "pv/data/logic.hpp"
58 #include "pv/data/logicsegment.hpp"
59 #include "pv/devices/device.hpp"
60 #include "pv/globalsettings.hpp"
61 #include "pv/session.hpp"
62 #include "pv/util.hpp"
65 #include "decodetrace.hpp"
68 using pv::data::SignalData;
69 using pv::data::Segment;
70 using pv::util::TimeUnit;
71 using pv::util::Timestamp;
73 using std::back_inserter;
79 using std::make_shared;
83 using std::set_difference;
84 using std::shared_ptr;
85 using std::stringstream;
86 using std::unordered_map;
87 using std::unordered_set;
94 const Timestamp View::MaxScale("1e9");
95 const Timestamp View::MinScale("1e-12");
97 const int View::MaxScrollValue = INT_MAX / 2;
99 const int View::ScaleUnits[3] = {1, 2, 5};
102 CustomScrollArea::CustomScrollArea(QWidget *parent) :
103 QAbstractScrollArea(parent)
107 bool CustomScrollArea::viewportEvent(QEvent *event)
109 switch (event->type()) {
111 case QEvent::MouseButtonPress:
112 case QEvent::MouseButtonRelease:
113 case QEvent::MouseButtonDblClick:
114 case QEvent::MouseMove:
116 case QEvent::TouchBegin:
117 case QEvent::TouchUpdate:
118 case QEvent::TouchEnd:
121 return QAbstractScrollArea::viewportEvent(event);
125 View::View(Session &session, bool is_main_view, QWidget *parent) :
126 ViewBase(session, is_main_view, parent),
127 splitter_(new QSplitter()),
128 segment_display_mode_(Trace::ShowLastSegmentOnly),
129 segment_selectable_(false),
132 updating_scroll_(false),
133 settings_restored_(false),
134 header_was_shrunk_(false),
135 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
136 always_zoom_to_fit_(false),
138 tick_prefix_(pv::util::SIPrefix::yocto),
140 time_unit_(util::TimeUnit::Time),
141 show_cursors_(false),
142 cursors_(new CursorPair(*this)),
143 next_flag_text_('A'),
145 hover_point_(-1, -1),
146 scroll_needs_defaults_(true),
148 scale_at_acq_start_(0),
149 offset_at_acq_start_(0),
150 suppress_zoom_to_fit_after_acq_(false)
152 QVBoxLayout *root_layout = new QVBoxLayout(this);
153 root_layout->setContentsMargins(0, 0, 0, 0);
154 root_layout->addWidget(splitter_);
156 viewport_ = new Viewport(*this);
157 scrollarea_ = new CustomScrollArea(splitter_);
158 scrollarea_->setViewport(viewport_);
159 scrollarea_->setFrameShape(QFrame::NoFrame);
161 ruler_ = new Ruler(*this);
163 header_ = new Header(*this);
164 header_->setMinimumWidth(10); // So that the arrow tips show at least
166 // We put the header into a simple layout so that we can add the top margin,
167 // allowing us to make it line up with the bottom of the ruler
168 QWidget *header_container = new QWidget();
169 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
170 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
171 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
172 header_layout->addWidget(header_);
174 // To let the ruler and scrollarea be on the same split pane, we need a layout
175 QWidget *trace_container = new QWidget();
176 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
177 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
178 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
179 trace_layout->setContentsMargins(0, 0, 0, 0);
180 trace_layout->addWidget(ruler_);
181 trace_layout->addWidget(scrollarea_);
183 splitter_->addWidget(header_container);
184 splitter_->addWidget(trace_container);
185 splitter_->setHandleWidth(1); // Don't show a visible rubber band
186 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
187 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
188 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
189 splitter_->setStretchFactor(1, 1); // when the entire view is resized
190 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
192 viewport_->installEventFilter(this);
193 ruler_->installEventFilter(this);
194 header_->installEventFilter(this);
196 // Set up settings and event handlers
197 GlobalSettings settings;
198 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
200 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
201 this, SLOT(h_scroll_value_changed(int)));
202 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
203 this, SLOT(v_scroll_value_changed()));
205 connect(header_, SIGNAL(selection_changed()),
206 ruler_, SLOT(clear_selection()));
207 connect(ruler_, SIGNAL(selection_changed()),
208 header_, SLOT(clear_selection()));
210 connect(header_, SIGNAL(selection_changed()),
211 this, SIGNAL(selection_changed()));
212 connect(ruler_, SIGNAL(selection_changed()),
213 this, SIGNAL(selection_changed()));
215 connect(splitter_, SIGNAL(splitterMoved(int, int)),
216 this, SLOT(on_splitter_moved()));
218 connect(&lazy_event_handler_, SIGNAL(timeout()),
219 this, SLOT(process_sticky_events()));
220 lazy_event_handler_.setSingleShot(true);
222 // Trigger the initial event manually. The default device has signals
223 // which were created before this object came into being
226 // make sure the transparent widgets are on the top
230 // Update the zoom state
231 calculate_tick_spacing();
233 // Make sure the standard bar's segment selector is in sync
234 set_segment_display_mode(segment_display_mode_);
237 Session& View::session()
242 const Session& View::session() const
247 unordered_set< shared_ptr<Signal> > View::signals() const
252 void View::clear_signals()
254 ViewBase::clear_signalbases();
258 void View::add_signal(const shared_ptr<Signal> signal)
260 ViewBase::add_signalbase(signal->base());
261 signals_.insert(signal);
263 signal->set_segment_display_mode(segment_display_mode_);
264 signal->set_current_segment(current_segment_);
266 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
267 this, SLOT(on_signal_name_changed()));
271 void View::clear_decode_signals()
273 decode_traces_.clear();
276 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
278 shared_ptr<DecodeTrace> d(
279 new DecodeTrace(session_, signal, decode_traces_.size()));
280 decode_traces_.push_back(d);
282 d->set_segment_display_mode(segment_display_mode_);
283 d->set_current_segment(current_segment_);
285 connect(signal.get(), SIGNAL(name_changed(const QString&)),
286 this, SLOT(on_signal_name_changed()));
289 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
291 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
292 if ((*i)->base() == signal) {
293 decode_traces_.erase(i);
305 const View* View::view() const
310 Viewport* View::viewport()
315 const Viewport* View::viewport() const
320 void View::save_settings(QSettings &settings) const
322 settings.setValue("scale", scale_);
323 settings.setValue("v_offset",
324 scrollarea_->verticalScrollBar()->sliderPosition());
326 settings.setValue("splitter_state", splitter_->saveState());
329 boost::archive::text_oarchive oa(ss);
330 oa << boost::serialization::make_nvp("offset", offset_);
331 settings.setValue("offset", QString::fromStdString(ss.str()));
333 for (shared_ptr<Signal> signal : signals_) {
334 settings.beginGroup(signal->base()->internal_name());
335 signal->save_settings(settings);
340 void View::restore_settings(QSettings &settings)
342 // Note: It is assumed that this function is only called once,
343 // immediately after restoring a previous session.
345 if (settings.contains("scale"))
346 set_scale(settings.value("scale").toDouble());
348 if (settings.contains("offset")) {
349 util::Timestamp offset;
351 ss << settings.value("offset").toString().toStdString();
353 boost::archive::text_iarchive ia(ss);
354 ia >> boost::serialization::make_nvp("offset", offset);
359 if (settings.contains("splitter_state"))
360 splitter_->restoreState(settings.value("splitter_state").toByteArray());
362 for (shared_ptr<Signal> signal : signals_) {
363 settings.beginGroup(signal->base()->internal_name());
364 signal->restore_settings(settings);
368 if (settings.contains("v_offset")) {
369 saved_v_offset_ = settings.value("v_offset").toInt();
370 set_v_offset(saved_v_offset_);
371 scroll_needs_defaults_ = false;
372 // Note: see eventFilter() for additional information
375 settings_restored_ = true;
376 suppress_zoom_to_fit_after_acq_ = true;
378 // Update the ruler so that it uses the new scale
379 calculate_tick_spacing();
382 vector< shared_ptr<TimeItem> > View::time_items() const
384 const vector<shared_ptr<Flag>> f(flags());
385 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
386 items.push_back(cursors_);
387 items.push_back(cursors_->first());
388 items.push_back(cursors_->second());
390 for (auto trigger_marker : trigger_markers_)
391 items.push_back(trigger_marker);
396 double View::scale() const
401 void View::set_scale(double scale)
403 if (scale_ != scale) {
409 const Timestamp& View::offset() const
414 void View::set_offset(const pv::util::Timestamp& offset)
416 if (offset_ != offset) {
422 int View::owner_visual_v_offset() const
424 return -scrollarea_->verticalScrollBar()->sliderPosition();
427 void View::set_v_offset(int offset)
429 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
434 unsigned int View::depth() const
439 pv::util::SIPrefix View::tick_prefix() const
444 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
446 if (tick_prefix_ != tick_prefix) {
447 tick_prefix_ = tick_prefix;
448 tick_prefix_changed();
452 unsigned int View::tick_precision() const
454 return tick_precision_;
457 void View::set_tick_precision(unsigned tick_precision)
459 if (tick_precision_ != tick_precision) {
460 tick_precision_ = tick_precision;
461 tick_precision_changed();
465 const pv::util::Timestamp& View::tick_period() const
470 void View::set_tick_period(const pv::util::Timestamp& tick_period)
472 if (tick_period_ != tick_period) {
473 tick_period_ = tick_period;
474 tick_period_changed();
478 TimeUnit View::time_unit() const
483 void View::set_time_unit(pv::util::TimeUnit time_unit)
485 if (time_unit_ != time_unit) {
486 time_unit_ = time_unit;
491 void View::set_current_segment(uint32_t segment_id)
493 current_segment_ = segment_id;
495 for (shared_ptr<Signal> signal : signals_)
496 signal->set_current_segment(current_segment_);
497 for (shared_ptr<DecodeTrace> dt : decode_traces_)
498 dt->set_current_segment(current_segment_);
503 bool View::segment_is_selectable() const
505 return segment_selectable_;
508 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
510 for (shared_ptr<Signal> signal : signals_)
511 signal->set_segment_display_mode(mode);
515 segment_selectable_ = true;
517 if (mode == Trace::ShowLastSegmentOnly)
518 segment_selectable_ = false;
520 segment_display_mode_changed(segment_selectable_);
523 void View::zoom(double steps)
525 zoom(steps, viewport_->width() / 2);
528 void View::zoom(double steps, int offset)
530 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
533 void View::zoom_fit(bool gui_state)
535 // Act as one-shot when stopped, toggle along with the GUI otherwise
536 if (session_.get_capture_state() == Session::Stopped) {
537 always_zoom_to_fit_ = false;
538 always_zoom_to_fit_changed(false);
540 always_zoom_to_fit_ = gui_state;
541 always_zoom_to_fit_changed(gui_state);
544 const pair<Timestamp, Timestamp> extents = get_time_extents();
545 const Timestamp delta = extents.second - extents.first;
546 if (delta < Timestamp("1e-12"))
550 const int w = viewport_->width();
554 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
555 set_scale_offset(scale.convert_to<double>(), extents.first);
558 void View::zoom_one_to_one()
560 using pv::data::SignalData;
562 // Make a set of all the visible data objects
563 set< shared_ptr<SignalData> > visible_data = get_visible_data();
564 if (visible_data.empty())
568 const int w = viewport_->width();
572 set_zoom(1.0 / session_.get_samplerate(), w / 2);
575 void View::set_scale_offset(double scale, const Timestamp& offset)
577 // Disable sticky scrolling / always zoom to fit when acquisition runs
578 // and user drags the viewport
579 if ((scale_ == scale) && (offset_ != offset) &&
580 (session_.get_capture_state() == Session::Running)) {
582 if (sticky_scrolling_) {
583 sticky_scrolling_ = false;
584 sticky_scrolling_changed(false);
587 if (always_zoom_to_fit_) {
588 always_zoom_to_fit_ = false;
589 always_zoom_to_fit_changed(false);
596 calculate_tick_spacing();
603 set< shared_ptr<SignalData> > View::get_visible_data() const
605 // Make a set of all the visible data objects
606 set< shared_ptr<SignalData> > visible_data;
607 for (const shared_ptr<Signal> sig : signals_)
609 visible_data.insert(sig->data());
614 pair<Timestamp, Timestamp> View::get_time_extents() const
616 boost::optional<Timestamp> left_time, right_time;
617 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
618 for (const shared_ptr<SignalData> d : visible_data) {
619 const vector< shared_ptr<Segment> > segments = d->segments();
620 for (const shared_ptr<Segment> &s : segments) {
621 double samplerate = s->samplerate();
622 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
624 const Timestamp start_time = s->start_time();
625 left_time = left_time ?
626 min(*left_time, start_time) :
628 right_time = right_time ?
629 max(*right_time, start_time + d->max_sample_count() / samplerate) :
630 start_time + d->max_sample_count() / samplerate;
634 if (!left_time || !right_time)
635 return make_pair(0, 0);
637 assert(*left_time < *right_time);
638 return make_pair(*left_time, *right_time);
641 void View::enable_show_sampling_points(bool state)
648 void View::enable_show_analog_minor_grid(bool state)
655 void View::enable_coloured_bg(bool state)
657 coloured_bg_ = state;
661 bool View::coloured_bg() const
666 bool View::cursors_shown() const
668 return show_cursors_;
671 void View::show_cursors(bool show)
673 show_cursors_ = show;
678 void View::centre_cursors()
680 const double time_width = scale_ * viewport_->width();
681 cursors_->first()->set_time(offset_ + time_width * 0.4);
682 cursors_->second()->set_time(offset_ + time_width * 0.6);
687 shared_ptr<CursorPair> View::cursors() const
692 void View::add_flag(const Timestamp& time)
694 flags_.push_back(make_shared<Flag>(*this, time,
695 QString("%1").arg(next_flag_text_)));
697 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
698 (next_flag_text_ + 1);
700 time_item_appearance_changed(true, true);
703 void View::remove_flag(shared_ptr<Flag> flag)
706 time_item_appearance_changed(true, true);
709 vector< shared_ptr<Flag> > View::flags() const
711 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
712 stable_sort(flags.begin(), flags.end(),
713 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
714 return a->time() < b->time();
720 const QPoint& View::hover_point() const
725 void View::restack_all_trace_tree_items()
727 // Make a list of owners that is sorted from deepest first
728 const vector<shared_ptr<TraceTreeItem>> items(
729 list_by_type<TraceTreeItem>());
730 set< TraceTreeItemOwner* > owners;
731 for (const auto &r : items)
732 owners.insert(r->owner());
733 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
734 sort(sorted_owners.begin(), sorted_owners.end(),
735 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
736 return a->depth() > b->depth(); });
738 // Restack the items recursively
739 for (auto &o : sorted_owners)
742 // Animate the items to their destination
743 for (const auto &i : items)
744 i->animate_to_layout_v_offset();
747 void View::trigger_event(util::Timestamp location)
749 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
752 void View::get_scroll_layout(double &length, Timestamp &offset) const
754 const pair<Timestamp, Timestamp> extents = get_time_extents();
755 length = ((extents.second - extents.first) / scale_).convert_to<double>();
756 offset = offset_ / scale_;
759 void View::set_zoom(double scale, int offset)
761 // Reset the "always zoom to fit" feature as the user changed the zoom
762 always_zoom_to_fit_ = false;
763 always_zoom_to_fit_changed(false);
765 const Timestamp cursor_offset = offset_ + scale_ * offset;
766 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
767 const Timestamp new_offset = cursor_offset - new_scale * offset;
768 set_scale_offset(new_scale.convert_to<double>(), new_offset);
771 void View::calculate_tick_spacing()
773 const double SpacingIncrement = 10.0f;
774 const double MinValueSpacing = 40.0f;
776 // Figure out the highest numeric value visible on a label
777 const QSize areaSize = viewport_->size();
778 const Timestamp max_time = max(fabs(offset_),
779 fabs(offset_ + scale_ * areaSize.width()));
781 double min_width = SpacingIncrement;
782 double label_width, tick_period_width;
784 QFontMetrics m(QApplication::font());
786 // Copies of the member variables with the same name, used in the calculation
787 // and written back afterwards, so that we don't emit signals all the time
788 // during the calculation.
789 pv::util::Timestamp tick_period = tick_period_;
790 pv::util::SIPrefix tick_prefix = tick_prefix_;
791 unsigned tick_precision = tick_precision_;
794 const double min_period = scale_ * min_width;
796 const int order = (int)floorf(log10f(min_period));
797 const pv::util::Timestamp order_decimal =
798 pow(pv::util::Timestamp(10), order);
800 // Allow for a margin of error so that a scale unit of 1 can be used.
801 // Otherwise, for a SU of 1 the tick period will almost always be below
802 // the min_period by a small amount - and thus skipped in favor of 2.
803 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
804 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
805 double tp_with_margin;
806 unsigned int unit = 0;
809 tp_with_margin = order_decimal.convert_to<double>() *
810 (ScaleUnits[unit++] + tp_margin);
811 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
813 tick_period = order_decimal * ScaleUnits[unit - 1];
814 tick_prefix = static_cast<pv::util::SIPrefix>(
815 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
817 // Precision is the number of fractional digits required, not
818 // taking the prefix into account (and it must never be negative)
819 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
821 tick_period_width = (tick_period / scale_).convert_to<double>();
823 const QString label_text = Ruler::format_time_with_distance(
824 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
826 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
827 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
830 min_width += SpacingIncrement;
831 } while (tick_period_width < label_width);
833 set_tick_period(tick_period);
834 set_tick_prefix(tick_prefix);
835 set_tick_precision(tick_precision);
838 void View::adjust_top_margin()
842 const QSize areaSize = viewport_->size();
844 const pair<int, int> extents = v_extents();
845 const int top_margin = owner_visual_v_offset() + extents.first;
846 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
848 // Do we have empty space at the top while the last trace goes out of screen?
849 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
850 const int trace_height = extents.second - extents.first;
852 // Center everything vertically if there is enough space
853 if (areaSize.height() >= trace_height)
854 set_v_offset(extents.first -
855 ((areaSize.height() - trace_height) / 2));
857 // Remove the top margin to make as many traces fit on screen as possible
858 set_v_offset(extents.first);
862 void View::update_scroll()
865 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
866 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
868 const QSize areaSize = viewport_->size();
870 // Set the horizontal scroll bar
873 get_scroll_layout(length, offset);
874 length = max(length - areaSize.width(), 0.0);
876 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
878 hscrollbar->setPageStep(areaSize.width() / 2);
879 hscrollbar->setSingleStep(major_tick_distance);
881 updating_scroll_ = true;
883 if (length < MaxScrollValue) {
884 hscrollbar->setRange(0, length);
885 hscrollbar->setSliderPosition(offset.convert_to<double>());
887 hscrollbar->setRange(0, MaxScrollValue);
888 hscrollbar->setSliderPosition(
889 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
892 updating_scroll_ = false;
894 // Set the vertical scrollbar
895 vscrollbar->setPageStep(areaSize.height());
896 vscrollbar->setSingleStep(areaSize.height() / 8);
898 const pair<int, int> extents = v_extents();
900 // Don't change the scrollbar range if there are no traces
901 if (extents.first != extents.second)
902 vscrollbar->setRange(extents.first - areaSize.height(),
905 if (scroll_needs_defaults_)
906 set_scroll_default();
909 void View::reset_scroll()
911 scrollarea_->verticalScrollBar()->setRange(0, 0);
914 void View::set_scroll_default()
918 const QSize areaSize = viewport_->size();
920 const pair<int, int> extents = v_extents();
921 const int trace_height = extents.second - extents.first;
923 // Do all traces fit in the view?
924 if (areaSize.height() >= trace_height)
925 // Center all traces vertically
926 set_v_offset(extents.first -
927 ((areaSize.height() - trace_height) / 2));
929 // Put the first trace at the top, letting the bottom ones overflow
930 set_v_offset(extents.first);
933 void View::determine_if_header_was_shrunk()
935 const int header_pane_width = splitter_->sizes().front();
936 const int header_width = header_->extended_size_hint().width();
938 // Allow for a slight margin of error so that we also accept
939 // slight differences when e.g. a label name change increased
941 header_was_shrunk_ = (header_pane_width < (header_width - 10));
944 void View::resize_header_to_fit()
946 // Setting the maximum width of the header widget doesn't work as
947 // expected because the splitter would allow the user to make the
948 // pane wider than that, creating empty space as a result.
949 // To make this work, we stricly enforce the maximum width by
950 // expanding the header unless the user shrunk it on purpose.
951 // As we're then setting the width of the header pane, we set the
952 // splitter to the maximum allowed position.
954 int splitter_area_width = 0;
955 for (int w : splitter_->sizes())
956 splitter_area_width += w;
958 // Make sure the header has enough horizontal space to show all labels fully
959 QList<int> pane_sizes;
960 pane_sizes.push_back(header_->extended_size_hint().width());
961 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
962 splitter_->setSizes(pane_sizes);
965 void View::update_layout()
970 TraceTreeItemOwner* View::find_prevalent_trace_group(
971 const shared_ptr<sigrok::ChannelGroup> &group,
972 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
977 unordered_set<TraceTreeItemOwner*> owners;
978 vector<TraceTreeItemOwner*> owner_list;
980 // Make a set and a list of all the owners
981 for (const auto &channel : group->channels()) {
982 for (auto entry : signal_map) {
983 if (entry.first->channel() == channel) {
984 TraceTreeItemOwner *const o = (entry.second)->owner();
985 owner_list.push_back(o);
991 // Iterate through the list of owners, and find the most prevalent
992 size_t max_prevalence = 0;
993 TraceTreeItemOwner *prevalent_owner = nullptr;
994 for (TraceTreeItemOwner *owner : owners) {
995 const size_t prevalence = count_if(
996 owner_list.begin(), owner_list.end(),
997 [&](TraceTreeItemOwner *o) { return o == owner; });
998 if (prevalence > max_prevalence) {
999 max_prevalence = prevalence;
1000 prevalent_owner = owner;
1004 return prevalent_owner;
1007 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1008 const vector< shared_ptr<sigrok::Channel> > &channels,
1009 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1011 set< shared_ptr<Trace> > &add_list)
1013 vector< shared_ptr<Trace> > filtered_traces;
1015 for (const auto &channel : channels) {
1016 for (auto entry : signal_map) {
1017 if (entry.first->channel() == channel) {
1018 shared_ptr<Trace> trace = entry.second;
1019 const auto list_iter = add_list.find(trace);
1020 if (list_iter == add_list.end())
1023 filtered_traces.push_back(trace);
1024 add_list.erase(list_iter);
1029 return filtered_traces;
1032 void View::determine_time_unit()
1034 // Check whether we know the sample rate and hence can use time as the unit
1035 if (time_unit_ == util::TimeUnit::Samples) {
1036 // Check all signals but...
1037 for (const shared_ptr<Signal> signal : signals_) {
1038 const shared_ptr<SignalData> data = signal->data();
1040 // ...only check first segment of each
1041 const vector< shared_ptr<Segment> > segments = data->segments();
1042 if (!segments.empty())
1043 if (segments[0]->samplerate()) {
1044 set_time_unit(util::TimeUnit::Time);
1051 bool View::eventFilter(QObject *object, QEvent *event)
1053 const QEvent::Type type = event->type();
1054 if (type == QEvent::MouseMove) {
1056 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1057 if (object == viewport_)
1058 hover_point_ = mouse_event->pos();
1059 else if (object == ruler_)
1060 hover_point_ = QPoint(mouse_event->x(), 0);
1061 else if (object == header_)
1062 hover_point_ = QPoint(0, mouse_event->y());
1064 hover_point_ = QPoint(-1, -1);
1066 update_hover_point();
1068 } else if (type == QEvent::Leave) {
1069 hover_point_ = QPoint(-1, -1);
1070 update_hover_point();
1071 } else if (type == QEvent::Show) {
1073 // This is somewhat of a hack, unfortunately. We cannot use
1074 // set_v_offset() from within restore_settings() as the view
1075 // at that point is neither visible nor properly sized.
1076 // This is the least intrusive workaround I could come up
1077 // with: set the vertical offset (or scroll defaults) when
1078 // the view is shown, which happens after all widgets were
1079 // resized to their final sizes.
1082 if (settings_restored_)
1083 determine_if_header_was_shrunk();
1085 resize_header_to_fit();
1087 if (scroll_needs_defaults_) {
1088 set_scroll_default();
1089 scroll_needs_defaults_ = false;
1092 if (saved_v_offset_) {
1093 set_v_offset(saved_v_offset_);
1094 saved_v_offset_ = 0;
1098 return QObject::eventFilter(object, event);
1101 void View::resizeEvent(QResizeEvent* event)
1103 // Only adjust the top margin if we shrunk vertically
1104 if (event->size().height() < event->oldSize().height())
1105 adjust_top_margin();
1110 void View::update_hover_point()
1112 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1113 list_by_type<TraceTreeItem>());
1114 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1115 r->hover_point_changed(hover_point_);
1117 hover_point_changed(hover_point_);
1120 void View::row_item_appearance_changed(bool label, bool content)
1125 viewport_->update();
1128 void View::time_item_appearance_changed(bool label, bool content)
1133 // Make sure the header pane width is updated, too
1138 viewport_->update();
1141 void View::extents_changed(bool horz, bool vert)
1144 (horz ? TraceTreeItemHExtentsChanged : 0) |
1145 (vert ? TraceTreeItemVExtentsChanged : 0);
1147 lazy_event_handler_.start();
1150 void View::on_signal_name_changed()
1152 if (!header_was_shrunk_)
1153 resize_header_to_fit();
1156 void View::on_splitter_moved()
1158 // The header can only shrink when the splitter is moved manually
1159 determine_if_header_was_shrunk();
1161 if (!header_was_shrunk_)
1162 resize_header_to_fit();
1165 void View::h_scroll_value_changed(int value)
1167 if (updating_scroll_)
1170 // Disable sticky scrolling when user moves the horizontal scroll bar
1171 // during a running acquisition
1172 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1173 sticky_scrolling_ = false;
1174 sticky_scrolling_changed(false);
1177 const int range = scrollarea_->horizontalScrollBar()->maximum();
1178 if (range < MaxScrollValue)
1179 set_offset(scale_ * value);
1183 get_scroll_layout(length, offset);
1184 set_offset(scale_ * length * value / MaxScrollValue);
1188 viewport_->update();
1191 void View::v_scroll_value_changed()
1194 viewport_->update();
1197 void View::signals_changed()
1199 using sigrok::Channel;
1201 vector< shared_ptr<Channel> > channels;
1202 shared_ptr<sigrok::Device> sr_dev;
1203 bool signals_added_or_removed = false;
1205 // Do we need to set the vertical scrollbar to its default position later?
1206 // We do if there are no traces, i.e. the scroll bar has no range set
1207 bool reset_scrollbar =
1208 (scrollarea_->verticalScrollBar()->minimum() ==
1209 scrollarea_->verticalScrollBar()->maximum());
1211 if (!session_.device()) {
1215 sr_dev = session_.device()->device();
1217 channels = sr_dev->channels();
1220 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1222 // Make a list of traces that are being added, and a list of traces
1223 // that are being removed
1224 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1225 const set<shared_ptr<Trace>> prev_traces(
1226 prev_trace_list.begin(), prev_trace_list.end());
1228 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1230 #ifdef ENABLE_DECODE
1231 traces.insert(decode_traces_.begin(), decode_traces_.end());
1234 set< shared_ptr<Trace> > add_traces;
1235 set_difference(traces.begin(), traces.end(),
1236 prev_traces.begin(), prev_traces.end(),
1237 inserter(add_traces, add_traces.begin()));
1239 set< shared_ptr<Trace> > remove_traces;
1240 set_difference(prev_traces.begin(), prev_traces.end(),
1241 traces.begin(), traces.end(),
1242 inserter(remove_traces, remove_traces.begin()));
1244 // Make a look-up table of sigrok Channels to pulseview Signals
1245 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1247 for (const shared_ptr<Signal> &sig : signals_)
1248 signal_map[sig->base()] = sig;
1250 // Populate channel groups
1252 for (auto entry : sr_dev->channel_groups()) {
1253 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1255 if (group->channels().size() <= 1)
1258 // Find best trace group to add to
1259 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1262 // If there is no trace group, create one
1263 shared_ptr<TraceGroup> new_trace_group;
1265 new_trace_group.reset(new TraceGroup());
1266 owner = new_trace_group.get();
1269 // Extract traces for the trace group, removing them from
1271 const vector< shared_ptr<Trace> > new_traces_in_group =
1272 extract_new_traces_for_channels(group->channels(),
1273 signal_map, add_traces);
1275 // Add the traces to the group
1276 const pair<int, int> prev_v_extents = owner->v_extents();
1277 int offset = prev_v_extents.second - prev_v_extents.first;
1278 for (shared_ptr<Trace> trace : new_traces_in_group) {
1280 owner->add_child_item(trace);
1282 const pair<int, int> extents = trace->v_extents();
1283 if (trace->enabled())
1284 offset += -extents.first;
1285 trace->force_to_v_offset(offset);
1286 if (trace->enabled())
1287 offset += extents.second;
1290 if (new_trace_group) {
1291 // Assign proper vertical offsets to each channel in the group
1292 new_trace_group->restack_items();
1294 // If this is a new group, enqueue it in the new top level
1296 if (!new_traces_in_group.empty())
1297 new_top_level_items.push_back(new_trace_group);
1301 // Enqueue the remaining logic channels in a group
1302 vector< shared_ptr<Channel> > logic_channels;
1303 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1304 [](const shared_ptr<Channel>& c) {
1305 return c->type() == sigrok::ChannelType::LOGIC; });
1307 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1308 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1310 if (non_grouped_logic_signals.size() > 0) {
1311 const shared_ptr<TraceGroup> non_grouped_trace_group(
1312 make_shared<TraceGroup>());
1313 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1314 non_grouped_trace_group->add_child_item(trace);
1316 non_grouped_trace_group->restack_items();
1317 new_top_level_items.push_back(non_grouped_trace_group);
1320 // Enqueue the remaining channels as free ungrouped traces
1321 const vector< shared_ptr<Trace> > new_top_level_signals =
1322 extract_new_traces_for_channels(channels, signal_map, add_traces);
1323 new_top_level_items.insert(new_top_level_items.end(),
1324 new_top_level_signals.begin(), new_top_level_signals.end());
1326 // Enqueue any remaining traces i.e. decode traces
1327 new_top_level_items.insert(new_top_level_items.end(),
1328 add_traces.begin(), add_traces.end());
1330 // Remove any removed traces
1331 for (shared_ptr<Trace> trace : remove_traces) {
1332 TraceTreeItemOwner *const owner = trace->owner();
1334 owner->remove_child_item(trace);
1335 signals_added_or_removed = true;
1338 // Remove any empty trace groups
1339 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1340 if (group->child_items().size() == 0) {
1341 remove_child_item(group);
1345 // Add and position the pending top levels items
1346 int offset = v_extents().second;
1347 for (auto item : new_top_level_items) {
1348 add_child_item(item);
1350 // Position the item after the last item or at the top if there is none
1351 const pair<int, int> extents = item->v_extents();
1353 if (item->enabled())
1354 offset += -extents.first;
1356 item->force_to_v_offset(offset);
1358 if (item->enabled())
1359 offset += extents.second;
1360 signals_added_or_removed = true;
1364 if (signals_added_or_removed && !header_was_shrunk_)
1365 resize_header_to_fit();
1370 viewport_->update();
1372 if (reset_scrollbar)
1373 set_scroll_default();
1376 void View::capture_state_updated(int state)
1378 GlobalSettings settings;
1380 if (state == Session::Running) {
1381 set_time_unit(util::TimeUnit::Samples);
1383 trigger_markers_.clear();
1385 scale_at_acq_start_ = scale_;
1386 offset_at_acq_start_ = offset_;
1388 // Activate "always zoom to fit" if the setting is enabled and we're
1389 // the main view of this session (other trace views may be used for
1390 // zooming and we don't want to mess them up)
1391 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1392 if (is_main_view_ && state) {
1393 always_zoom_to_fit_ = true;
1394 always_zoom_to_fit_changed(always_zoom_to_fit_);
1397 // Enable sticky scrolling if the setting is enabled
1398 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1400 // Reset all traces to segment 0
1401 current_segment_ = 0;
1402 set_current_segment(current_segment_);
1405 if (state == Session::Stopped) {
1406 // After acquisition has stopped we need to re-calculate the ticks once
1407 // as it's otherwise done when the user pans or zooms, which is too late
1408 calculate_tick_spacing();
1410 // Reset "always zoom to fit", the acquisition has stopped
1411 if (always_zoom_to_fit_) {
1412 // Perform a final zoom-to-fit before disabling
1413 zoom_fit(always_zoom_to_fit_);
1414 always_zoom_to_fit_ = false;
1415 always_zoom_to_fit_changed(always_zoom_to_fit_);
1418 bool zoom_to_fit_after_acq =
1419 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1421 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1422 // we didn't restore settings in the meanwhile
1423 if (zoom_to_fit_after_acq &&
1424 !suppress_zoom_to_fit_after_acq_ &&
1425 (scale_ == scale_at_acq_start_) &&
1426 (offset_ == offset_at_acq_start_))
1427 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1429 suppress_zoom_to_fit_after_acq_ = false;
1433 void View::on_new_segment(int new_segment_id)
1435 on_segment_changed(new_segment_id);
1436 segment_changed(new_segment_id);
1439 void View::on_segment_completed(int segment_id)
1441 on_segment_changed(segment_id);
1442 segment_changed(segment_id);
1445 void View::on_segment_changed(int segment)
1447 switch (segment_display_mode_) {
1448 case Trace::ShowLastSegmentOnly:
1449 case Trace::ShowSingleSegmentOnly:
1450 set_current_segment(segment);
1453 case Trace::ShowLastCompleteSegmentOnly:
1455 // Only update if all segments are complete
1456 bool all_complete = true;
1458 for (shared_ptr<Signal> signal : signals_)
1459 if (!signal->base()->segment_is_complete(segment))
1460 all_complete = false;
1463 set_current_segment(segment);
1467 case Trace::ShowAllSegments:
1468 case Trace::ShowAccumulatedIntensity:
1474 void View::perform_delayed_view_update()
1476 if (always_zoom_to_fit_) {
1478 } else if (sticky_scrolling_) {
1479 // Make right side of the view sticky
1482 get_scroll_layout(length, offset);
1484 const QSize areaSize = viewport_->size();
1485 length = max(length - areaSize.width(), 0.0);
1487 set_offset(scale_ * length);
1490 determine_time_unit();
1493 viewport_->update();
1496 void View::process_sticky_events()
1498 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1500 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1501 restack_all_trace_tree_items();
1505 // Clear the sticky events
1509 } // namespace trace
1510 } // namespace views