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;
76 using std::dynamic_pointer_cast;
80 using std::make_shared;
84 using std::set_difference;
85 using std::shared_ptr;
86 using std::stringstream;
87 using std::unordered_map;
88 using std::unordered_set;
95 const Timestamp View::MaxScale("1e9");
96 const Timestamp View::MinScale("1e-12");
98 const int View::MaxScrollValue = INT_MAX / 2;
100 const int View::ScaleUnits[3] = {1, 2, 5};
103 CustomScrollArea::CustomScrollArea(QWidget *parent) :
104 QAbstractScrollArea(parent)
108 bool CustomScrollArea::viewportEvent(QEvent *event)
110 switch (event->type()) {
112 case QEvent::MouseButtonPress:
113 case QEvent::MouseButtonRelease:
114 case QEvent::MouseButtonDblClick:
115 case QEvent::MouseMove:
117 case QEvent::TouchBegin:
118 case QEvent::TouchUpdate:
119 case QEvent::TouchEnd:
122 return QAbstractScrollArea::viewportEvent(event);
126 View::View(Session &session, bool is_main_view, QWidget *parent) :
127 ViewBase(session, is_main_view, parent),
128 splitter_(new QSplitter()),
131 updating_scroll_(false),
132 settings_restored_(false),
133 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
134 always_zoom_to_fit_(false),
136 tick_prefix_(pv::util::SIPrefix::yocto),
138 time_unit_(util::TimeUnit::Time),
139 show_cursors_(false),
140 cursors_(new CursorPair(*this)),
141 next_flag_text_('A'),
143 hover_point_(-1, -1),
144 scroll_needs_defaults_(false),
147 QVBoxLayout *root_layout = new QVBoxLayout(this);
148 root_layout->setContentsMargins(0, 0, 0, 0);
149 root_layout->addWidget(splitter_);
151 viewport_ = new Viewport(*this);
152 scrollarea_ = new CustomScrollArea(splitter_);
153 scrollarea_->setViewport(viewport_);
154 scrollarea_->setFrameShape(QFrame::NoFrame);
156 ruler_ = new Ruler(*this);
158 header_ = new Header(*this);
159 header_->setMinimumWidth(10); // So that the arrow tips show at least
161 // We put the header into a simple layout so that we can add the top margin,
162 // allowing us to make it line up with the bottom of the ruler
163 QWidget *header_container = new QWidget();
164 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
165 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
166 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
167 header_layout->addWidget(header_);
169 // To let the ruler and scrollarea be on the same split pane, we need a layout
170 QWidget *trace_container = new QWidget();
171 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
172 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
173 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
174 trace_layout->setContentsMargins(0, 0, 0, 0);
175 trace_layout->addWidget(ruler_);
176 trace_layout->addWidget(scrollarea_);
178 splitter_->addWidget(header_container);
179 splitter_->addWidget(trace_container);
180 splitter_->setHandleWidth(1); // Don't show a visible rubber band
181 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
182 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
183 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
185 viewport_->installEventFilter(this);
186 ruler_->installEventFilter(this);
187 header_->installEventFilter(this);
189 // Set up settings and event handlers
190 GlobalSettings settings;
191 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
193 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
194 this, SLOT(h_scroll_value_changed(int)));
195 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
196 this, SLOT(v_scroll_value_changed()));
198 connect(header_, SIGNAL(selection_changed()),
199 ruler_, SLOT(clear_selection()));
200 connect(ruler_, SIGNAL(selection_changed()),
201 header_, SLOT(clear_selection()));
203 connect(header_, SIGNAL(selection_changed()),
204 this, SIGNAL(selection_changed()));
205 connect(ruler_, SIGNAL(selection_changed()),
206 this, SIGNAL(selection_changed()));
208 connect(splitter_, SIGNAL(splitterMoved(int, int)),
209 this, SLOT(on_splitter_moved()));
211 connect(this, SIGNAL(hover_point_changed()),
212 this, SLOT(on_hover_point_changed()));
214 connect(&lazy_event_handler_, SIGNAL(timeout()),
215 this, SLOT(process_sticky_events()));
216 lazy_event_handler_.setSingleShot(true);
218 // Trigger the initial event manually. The default device has signals
219 // which were created before this object came into being
222 // make sure the transparent widgets are on the top
226 // Update the zoom state
227 calculate_tick_spacing();
230 Session& View::session()
235 const Session& View::session() const
240 unordered_set< shared_ptr<Signal> > View::signals() const
245 void View::clear_signals()
247 ViewBase::clear_signalbases();
251 void View::add_signal(const shared_ptr<Signal> signal)
253 ViewBase::add_signalbase(signal->base());
254 signals_.insert(signal);
258 void View::clear_decode_signals()
260 decode_traces_.clear();
263 void View::add_decode_signal(shared_ptr<data::SignalBase> signalbase)
265 shared_ptr<DecodeTrace> d(
266 new DecodeTrace(session_, signalbase, decode_traces_.size()));
267 decode_traces_.push_back(d);
270 void View::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
272 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
273 if ((*i)->base() == signalbase) {
274 decode_traces_.erase(i);
286 const View* View::view() const
291 Viewport* View::viewport()
296 const Viewport* View::viewport() const
301 void View::save_settings(QSettings &settings) const
303 settings.setValue("scale", scale_);
304 settings.setValue("v_offset",
305 scrollarea_->verticalScrollBar()->sliderPosition());
307 settings.setValue("splitter_state", splitter_->saveState());
310 boost::archive::text_oarchive oa(ss);
311 oa << boost::serialization::make_nvp("offset", offset_);
312 settings.setValue("offset", QString::fromStdString(ss.str()));
314 for (shared_ptr<Signal> signal : signals_) {
315 settings.beginGroup(signal->base()->internal_name());
316 signal->save_settings(settings);
321 void View::restore_settings(QSettings &settings)
323 // Note: It is assumed that this function is only called once,
324 // immediately after restoring a previous session.
326 if (settings.contains("scale"))
327 set_scale(settings.value("scale").toDouble());
329 if (settings.contains("offset")) {
330 util::Timestamp offset;
332 ss << settings.value("offset").toString().toStdString();
334 boost::archive::text_iarchive ia(ss);
335 ia >> boost::serialization::make_nvp("offset", offset);
340 if (settings.contains("splitter_state"))
341 splitter_->restoreState(settings.value("splitter_state").toByteArray());
343 for (shared_ptr<Signal> signal : signals_) {
344 settings.beginGroup(signal->base()->internal_name());
345 signal->restore_settings(settings);
349 if (settings.contains("v_offset")) {
350 saved_v_offset_ = settings.value("v_offset").toInt();
351 set_v_offset(saved_v_offset_);
352 scroll_needs_defaults_ = false;
353 // Note: see eventFilter() for additional information
356 settings_restored_ = true;
359 vector< shared_ptr<TimeItem> > View::time_items() const
361 const vector<shared_ptr<Flag>> f(flags());
362 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
363 items.push_back(cursors_);
364 items.push_back(cursors_->first());
365 items.push_back(cursors_->second());
367 for (auto trigger_marker : trigger_markers_)
368 items.push_back(trigger_marker);
373 double View::scale() const
378 void View::set_scale(double scale)
380 if (scale_ != scale) {
386 const Timestamp& View::offset() const
391 void View::set_offset(const pv::util::Timestamp& offset)
393 if (offset_ != offset) {
399 int View::owner_visual_v_offset() const
401 return -scrollarea_->verticalScrollBar()->sliderPosition();
404 void View::set_v_offset(int offset)
406 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
411 unsigned int View::depth() const
416 pv::util::SIPrefix View::tick_prefix() const
421 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
423 if (tick_prefix_ != tick_prefix) {
424 tick_prefix_ = tick_prefix;
425 tick_prefix_changed();
429 unsigned int View::tick_precision() const
431 return tick_precision_;
434 void View::set_tick_precision(unsigned tick_precision)
436 if (tick_precision_ != tick_precision) {
437 tick_precision_ = tick_precision;
438 tick_precision_changed();
442 const pv::util::Timestamp& View::tick_period() const
447 void View::set_tick_period(const pv::util::Timestamp& tick_period)
449 if (tick_period_ != tick_period) {
450 tick_period_ = tick_period;
451 tick_period_changed();
455 TimeUnit View::time_unit() const
460 void View::set_time_unit(pv::util::TimeUnit time_unit)
462 if (time_unit_ != time_unit) {
463 time_unit_ = time_unit;
468 void View::zoom(double steps)
470 zoom(steps, viewport_->width() / 2);
473 void View::zoom(double steps, int offset)
475 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
478 void View::zoom_fit(bool gui_state)
480 // Act as one-shot when stopped, toggle along with the GUI otherwise
481 if (session_.get_capture_state() == Session::Stopped) {
482 always_zoom_to_fit_ = false;
483 always_zoom_to_fit_changed(false);
485 always_zoom_to_fit_ = gui_state;
486 always_zoom_to_fit_changed(gui_state);
489 const pair<Timestamp, Timestamp> extents = get_time_extents();
490 const Timestamp delta = extents.second - extents.first;
491 if (delta < Timestamp("1e-12"))
495 const int w = viewport_->width();
499 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
500 set_scale_offset(scale.convert_to<double>(), extents.first);
503 void View::zoom_one_to_one()
505 using pv::data::SignalData;
507 // Make a set of all the visible data objects
508 set< shared_ptr<SignalData> > visible_data = get_visible_data();
509 if (visible_data.empty())
513 const int w = viewport_->width();
517 set_zoom(1.0 / session_.get_samplerate(), w / 2);
520 void View::set_scale_offset(double scale, const Timestamp& offset)
522 // Disable sticky scrolling / always zoom to fit when acquisition runs
523 // and user drags the viewport
524 if ((scale_ == scale) && (offset_ != offset) &&
525 (session_.get_capture_state() == Session::Running)) {
527 if (sticky_scrolling_) {
528 sticky_scrolling_ = false;
529 sticky_scrolling_changed(false);
532 if (always_zoom_to_fit_) {
533 always_zoom_to_fit_ = false;
534 always_zoom_to_fit_changed(false);
541 calculate_tick_spacing();
548 set< shared_ptr<SignalData> > View::get_visible_data() const
550 // Make a set of all the visible data objects
551 set< shared_ptr<SignalData> > visible_data;
552 for (const shared_ptr<Signal> sig : signals_)
554 visible_data.insert(sig->data());
559 pair<Timestamp, Timestamp> View::get_time_extents() const
561 boost::optional<Timestamp> left_time, right_time;
562 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
563 for (const shared_ptr<SignalData> d : visible_data) {
564 const vector< shared_ptr<Segment> > segments = d->segments();
565 for (const shared_ptr<Segment> &s : segments) {
566 double samplerate = s->samplerate();
567 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
569 const Timestamp start_time = s->start_time();
570 left_time = left_time ?
571 min(*left_time, start_time) :
573 right_time = right_time ?
574 max(*right_time, start_time + d->max_sample_count() / samplerate) :
575 start_time + d->max_sample_count() / samplerate;
579 if (!left_time || !right_time)
580 return make_pair(0, 0);
582 assert(*left_time < *right_time);
583 return make_pair(*left_time, *right_time);
586 void View::enable_show_sampling_points(bool state)
593 void View::enable_show_analog_minor_grid(bool state)
600 void View::enable_coloured_bg(bool state)
602 coloured_bg_ = state;
606 bool View::coloured_bg() const
611 bool View::cursors_shown() const
613 return show_cursors_;
616 void View::show_cursors(bool show)
618 show_cursors_ = show;
623 void View::centre_cursors()
625 const double time_width = scale_ * viewport_->width();
626 cursors_->first()->set_time(offset_ + time_width * 0.4);
627 cursors_->second()->set_time(offset_ + time_width * 0.6);
632 shared_ptr<CursorPair> View::cursors() const
637 void View::add_flag(const Timestamp& time)
639 flags_.push_back(make_shared<Flag>(*this, time,
640 QString("%1").arg(next_flag_text_)));
642 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
643 (next_flag_text_ + 1);
645 time_item_appearance_changed(true, true);
648 void View::remove_flag(shared_ptr<Flag> flag)
651 time_item_appearance_changed(true, true);
654 vector< shared_ptr<Flag> > View::flags() const
656 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
657 stable_sort(flags.begin(), flags.end(),
658 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
659 return a->time() < b->time();
665 const QPoint& View::hover_point() const
670 void View::restack_all_trace_tree_items()
672 // Make a list of owners that is sorted from deepest first
673 const vector<shared_ptr<TraceTreeItem>> items(
674 list_by_type<TraceTreeItem>());
675 set< TraceTreeItemOwner* > owners;
676 for (const auto &r : items)
677 owners.insert(r->owner());
678 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
679 sort(sorted_owners.begin(), sorted_owners.end(),
680 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
681 return a->depth() > b->depth(); });
683 // Restack the items recursively
684 for (auto &o : sorted_owners)
687 // Animate the items to their destination
688 for (const auto &i : items)
689 i->animate_to_layout_v_offset();
692 void View::trigger_event(util::Timestamp location)
694 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
697 void View::get_scroll_layout(double &length, Timestamp &offset) const
699 const pair<Timestamp, Timestamp> extents = get_time_extents();
700 length = ((extents.second - extents.first) / scale_).convert_to<double>();
701 offset = offset_ / scale_;
704 void View::set_zoom(double scale, int offset)
706 // Reset the "always zoom to fit" feature as the user changed the zoom
707 always_zoom_to_fit_ = false;
708 always_zoom_to_fit_changed(false);
710 const Timestamp cursor_offset = offset_ + scale_ * offset;
711 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
712 const Timestamp new_offset = cursor_offset - new_scale * offset;
713 set_scale_offset(new_scale.convert_to<double>(), new_offset);
716 void View::calculate_tick_spacing()
718 const double SpacingIncrement = 10.0f;
719 const double MinValueSpacing = 40.0f;
721 // Figure out the highest numeric value visible on a label
722 const QSize areaSize = viewport_->size();
723 const Timestamp max_time = max(fabs(offset_),
724 fabs(offset_ + scale_ * areaSize.width()));
726 double min_width = SpacingIncrement;
727 double label_width, tick_period_width;
729 QFontMetrics m(QApplication::font());
731 // Copies of the member variables with the same name, used in the calculation
732 // and written back afterwards, so that we don't emit signals all the time
733 // during the calculation.
734 pv::util::Timestamp tick_period = tick_period_;
735 pv::util::SIPrefix tick_prefix = tick_prefix_;
736 unsigned tick_precision = tick_precision_;
739 const double min_period = scale_ * min_width;
741 const int order = (int)floorf(log10f(min_period));
742 const pv::util::Timestamp order_decimal =
743 pow(pv::util::Timestamp(10), order);
745 // Allow for a margin of error so that a scale unit of 1 can be used.
746 // Otherwise, for a SU of 1 the tick period will almost always be below
747 // the min_period by a small amount - and thus skipped in favor of 2.
748 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
749 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
750 double tp_with_margin;
751 unsigned int unit = 0;
754 tp_with_margin = order_decimal.convert_to<double>() *
755 (ScaleUnits[unit++] + tp_margin);
756 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
758 tick_period = order_decimal * ScaleUnits[unit - 1];
759 tick_prefix = static_cast<pv::util::SIPrefix>(
760 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
762 // Precision is the number of fractional digits required, not
763 // taking the prefix into account (and it must never be negative)
764 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
766 tick_period_width = (tick_period / scale_).convert_to<double>();
768 const QString label_text = Ruler::format_time_with_distance(
769 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
771 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
772 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
775 min_width += SpacingIncrement;
776 } while (tick_period_width < label_width);
778 set_tick_period(tick_period);
779 set_tick_prefix(tick_prefix);
780 set_tick_precision(tick_precision);
783 void View::adjust_top_margin()
787 const QSize areaSize = viewport_->size();
789 const pair<int, int> extents = v_extents();
790 const int top_margin = owner_visual_v_offset() + extents.first;
791 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
793 // Do we have empty space at the top while the last trace goes out of screen?
794 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
795 const int trace_height = extents.second - extents.first;
797 // Center everything vertically if there is enough space
798 if (areaSize.height() >= trace_height)
799 set_v_offset(extents.first -
800 ((areaSize.height() - trace_height) / 2));
802 // Remove the top margin to make as many traces fit on screen as possible
803 set_v_offset(extents.first);
807 void View::update_scroll()
810 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
811 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
813 const QSize areaSize = viewport_->size();
815 // Set the horizontal scroll bar
818 get_scroll_layout(length, offset);
819 length = max(length - areaSize.width(), 0.0);
821 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
823 hscrollbar->setPageStep(areaSize.width() / 2);
824 hscrollbar->setSingleStep(major_tick_distance);
826 updating_scroll_ = true;
828 if (length < MaxScrollValue) {
829 hscrollbar->setRange(0, length);
830 hscrollbar->setSliderPosition(offset.convert_to<double>());
832 hscrollbar->setRange(0, MaxScrollValue);
833 hscrollbar->setSliderPosition(
834 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
837 updating_scroll_ = false;
839 // Set the vertical scrollbar
840 vscrollbar->setPageStep(areaSize.height());
841 vscrollbar->setSingleStep(areaSize.height() / 8);
843 const pair<int, int> extents = v_extents();
845 // Don't change the scrollbar range if there are no traces
846 if (extents.first != extents.second)
847 vscrollbar->setRange(extents.first - areaSize.height(),
850 if (scroll_needs_defaults_)
851 set_scroll_default();
854 void View::reset_scroll()
856 scrollarea_->verticalScrollBar()->setRange(0, 0);
859 void View::set_scroll_default()
863 const QSize areaSize = viewport_->size();
865 const pair<int, int> extents = v_extents();
866 const int trace_height = extents.second - extents.first;
868 // Do all traces fit in the view?
869 if (areaSize.height() >= trace_height)
870 // Center all traces vertically
871 set_v_offset(extents.first -
872 ((areaSize.height() - trace_height) / 2));
874 // Put the first trace at the top, letting the bottom ones overflow
875 set_v_offset(extents.first);
878 bool View::header_was_shrunk() const
880 const int header_pane_width = splitter_->sizes().front();
881 const int header_width = header_->extended_size_hint().width();
883 // Allow for a slight margin of error so that we also accept
884 // slight differences when e.g. a label name change increased
886 return (header_pane_width < (header_width - 10));
889 void View::expand_header_to_fit()
891 int splitter_area_width = 0;
892 for (int w : splitter_->sizes())
893 splitter_area_width += w;
895 // Workaround for when the header needs resizing but the view
896 // isn't visible yet and thus splitter_->sizes() returns (0, 0)
897 if (splitter_area_width == 0) {
898 QTimer::singleShot(50, this, SLOT(on_repeat_splitter_expansion()));
902 // Make sure the header has enough horizontal space to show all labels fully
903 QList<int> pane_sizes;
904 pane_sizes.push_back(header_->extended_size_hint().width());
905 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
906 splitter_->setSizes(pane_sizes);
909 void View::update_layout()
914 TraceTreeItemOwner* View::find_prevalent_trace_group(
915 const shared_ptr<sigrok::ChannelGroup> &group,
916 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
921 unordered_set<TraceTreeItemOwner*> owners;
922 vector<TraceTreeItemOwner*> owner_list;
924 // Make a set and a list of all the owners
925 for (const auto &channel : group->channels()) {
926 for (auto entry : signal_map) {
927 if (entry.first->channel() == channel) {
928 TraceTreeItemOwner *const o = (entry.second)->owner();
929 owner_list.push_back(o);
935 // Iterate through the list of owners, and find the most prevalent
936 size_t max_prevalence = 0;
937 TraceTreeItemOwner *prevalent_owner = nullptr;
938 for (TraceTreeItemOwner *owner : owners) {
939 const size_t prevalence = count_if(
940 owner_list.begin(), owner_list.end(),
941 [&](TraceTreeItemOwner *o) { return o == owner; });
942 if (prevalence > max_prevalence) {
943 max_prevalence = prevalence;
944 prevalent_owner = owner;
948 return prevalent_owner;
951 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
952 const vector< shared_ptr<sigrok::Channel> > &channels,
953 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
955 set< shared_ptr<Trace> > &add_list)
957 vector< shared_ptr<Trace> > filtered_traces;
959 for (const auto &channel : channels) {
960 for (auto entry : signal_map) {
961 if (entry.first->channel() == channel) {
962 shared_ptr<Trace> trace = entry.second;
963 const auto list_iter = add_list.find(trace);
964 if (list_iter == add_list.end())
967 filtered_traces.push_back(trace);
968 add_list.erase(list_iter);
973 return filtered_traces;
976 void View::determine_time_unit()
978 // Check whether we know the sample rate and hence can use time as the unit
979 if (time_unit_ == util::TimeUnit::Samples) {
980 // Check all signals but...
981 for (const shared_ptr<Signal> signal : signals_) {
982 const shared_ptr<SignalData> data = signal->data();
984 // ...only check first segment of each
985 const vector< shared_ptr<Segment> > segments = data->segments();
986 if (!segments.empty())
987 if (segments[0]->samplerate()) {
988 set_time_unit(util::TimeUnit::Time);
995 bool View::eventFilter(QObject *object, QEvent *event)
997 const QEvent::Type type = event->type();
998 if (type == QEvent::MouseMove) {
1000 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1001 if (object == viewport_)
1002 hover_point_ = mouse_event->pos();
1003 else if (object == ruler_)
1004 hover_point_ = QPoint(mouse_event->x(), 0);
1005 else if (object == header_)
1006 hover_point_ = QPoint(0, mouse_event->y());
1008 hover_point_ = QPoint(-1, -1);
1010 hover_point_changed();
1012 } else if (type == QEvent::Leave) {
1013 hover_point_ = QPoint(-1, -1);
1014 hover_point_changed();
1015 } else if (type == QEvent::Show) {
1017 // This is somewhat of a hack, unfortunately. We cannot use
1018 // set_v_offset() from within restore_settings() as the view
1019 // at that point is neither visible nor properly sized.
1020 // This is the least intrusive workaround I could come up
1021 // with: set the vertical offset (or scroll defaults) when
1022 // the view is shown, which happens after all widgets were
1023 // resized to their final sizes.
1026 if (scroll_needs_defaults_) {
1027 set_scroll_default();
1028 scroll_needs_defaults_ = false;
1031 if (saved_v_offset_) {
1032 set_v_offset(saved_v_offset_);
1033 saved_v_offset_ = 0;
1037 return QObject::eventFilter(object, event);
1040 void View::resizeEvent(QResizeEvent* event)
1042 // Only adjust the top margin if we shrunk vertically
1043 if (event->size().height() < event->oldSize().height())
1044 adjust_top_margin();
1049 void View::row_item_appearance_changed(bool label, bool content)
1054 viewport_->update();
1057 void View::time_item_appearance_changed(bool label, bool content)
1062 // Make sure the header pane width is updated, too
1067 viewport_->update();
1070 void View::extents_changed(bool horz, bool vert)
1073 (horz ? TraceTreeItemHExtentsChanged : 0) |
1074 (vert ? TraceTreeItemVExtentsChanged : 0);
1076 lazy_event_handler_.start();
1079 void View::on_splitter_moved()
1081 // Setting the maximum width of the header widget doesn't work as
1082 // expected because the splitter would allow the user to make the
1083 // pane wider than that, creating empty space as a result.
1084 // To make this work, we stricly enforce the maximum width by
1085 // expanding the header unless the user shrunk it on purpose.
1086 // As we're then setting the width of the header pane, we set the
1087 // splitter to the maximum allowed position.
1088 if (!header_was_shrunk())
1089 expand_header_to_fit();
1092 void View::on_repeat_splitter_expansion()
1094 // Don't mess with the header if settings were restored in the meanwhile
1095 if (!settings_restored_)
1096 expand_header_to_fit();
1099 void View::h_scroll_value_changed(int value)
1101 if (updating_scroll_)
1104 // Disable sticky scrolling when user moves the horizontal scroll bar
1105 // during a running acquisition
1106 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1107 sticky_scrolling_ = false;
1108 sticky_scrolling_changed(false);
1111 const int range = scrollarea_->horizontalScrollBar()->maximum();
1112 if (range < MaxScrollValue)
1113 set_offset(scale_ * value);
1117 get_scroll_layout(length, offset);
1118 set_offset(scale_ * length * value / MaxScrollValue);
1122 viewport_->update();
1125 void View::v_scroll_value_changed()
1128 viewport_->update();
1131 void View::signals_changed()
1133 using sigrok::Channel;
1135 vector< shared_ptr<Channel> > channels;
1136 shared_ptr<sigrok::Device> sr_dev;
1138 // Do we need to set the vertical scrollbar to its default position later?
1139 // We do if there are no traces, i.e. the scroll bar has no range set
1140 bool reset_scrollbar =
1141 (scrollarea_->verticalScrollBar()->minimum() ==
1142 scrollarea_->verticalScrollBar()->maximum());
1144 if (!session_.device()) {
1148 sr_dev = session_.device()->device();
1150 channels = sr_dev->channels();
1153 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1155 // Make a list of traces that are being added, and a list of traces
1156 // that are being removed
1157 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1158 const set<shared_ptr<Trace>> prev_traces(
1159 prev_trace_list.begin(), prev_trace_list.end());
1161 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1163 #ifdef ENABLE_DECODE
1164 traces.insert(decode_traces_.begin(), decode_traces_.end());
1167 set< shared_ptr<Trace> > add_traces;
1168 set_difference(traces.begin(), traces.end(),
1169 prev_traces.begin(), prev_traces.end(),
1170 inserter(add_traces, add_traces.begin()));
1172 set< shared_ptr<Trace> > remove_traces;
1173 set_difference(prev_traces.begin(), prev_traces.end(),
1174 traces.begin(), traces.end(),
1175 inserter(remove_traces, remove_traces.begin()));
1177 // Make a look-up table of sigrok Channels to pulseview Signals
1178 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1180 for (const shared_ptr<Signal> &sig : signals_)
1181 signal_map[sig->base()] = sig;
1183 // Populate channel groups
1185 for (auto entry : sr_dev->channel_groups()) {
1186 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1188 if (group->channels().size() <= 1)
1191 // Find best trace group to add to
1192 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1195 // If there is no trace group, create one
1196 shared_ptr<TraceGroup> new_trace_group;
1198 new_trace_group.reset(new TraceGroup());
1199 owner = new_trace_group.get();
1202 // Extract traces for the trace group, removing them from
1204 const vector< shared_ptr<Trace> > new_traces_in_group =
1205 extract_new_traces_for_channels(group->channels(),
1206 signal_map, add_traces);
1208 // Add the traces to the group
1209 const pair<int, int> prev_v_extents = owner->v_extents();
1210 int offset = prev_v_extents.second - prev_v_extents.first;
1211 for (shared_ptr<Trace> trace : new_traces_in_group) {
1213 owner->add_child_item(trace);
1215 const pair<int, int> extents = trace->v_extents();
1216 if (trace->enabled())
1217 offset += -extents.first;
1218 trace->force_to_v_offset(offset);
1219 if (trace->enabled())
1220 offset += extents.second;
1223 if (new_trace_group) {
1224 // Assign proper vertical offsets to each channel in the group
1225 new_trace_group->restack_items();
1227 // If this is a new group, enqueue it in the new top level
1229 if (!new_traces_in_group.empty())
1230 new_top_level_items.push_back(new_trace_group);
1234 // Enqueue the remaining logic channels in a group
1235 vector< shared_ptr<Channel> > logic_channels;
1236 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1237 [](const shared_ptr<Channel>& c) {
1238 return c->type() == sigrok::ChannelType::LOGIC; });
1240 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1241 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1243 if (non_grouped_logic_signals.size() > 0) {
1244 const shared_ptr<TraceGroup> non_grouped_trace_group(
1245 make_shared<TraceGroup>());
1246 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1247 non_grouped_trace_group->add_child_item(trace);
1249 non_grouped_trace_group->restack_items();
1250 new_top_level_items.push_back(non_grouped_trace_group);
1253 // Enqueue the remaining channels as free ungrouped traces
1254 const vector< shared_ptr<Trace> > new_top_level_signals =
1255 extract_new_traces_for_channels(channels, signal_map, add_traces);
1256 new_top_level_items.insert(new_top_level_items.end(),
1257 new_top_level_signals.begin(), new_top_level_signals.end());
1259 // Enqueue any remaining traces i.e. decode traces
1260 new_top_level_items.insert(new_top_level_items.end(),
1261 add_traces.begin(), add_traces.end());
1263 // Remove any removed traces
1264 for (shared_ptr<Trace> trace : remove_traces) {
1265 TraceTreeItemOwner *const owner = trace->owner();
1267 owner->remove_child_item(trace);
1270 // Remove any empty trace groups
1271 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1272 if (group->child_items().size() == 0) {
1273 remove_child_item(group);
1277 // Add and position the pending top levels items
1278 int offset = v_extents().second;
1279 for (auto item : new_top_level_items) {
1280 add_child_item(item);
1282 // Position the item after the last item or at the top if there is none
1283 const pair<int, int> extents = item->v_extents();
1285 if (item->enabled())
1286 offset += -extents.first;
1288 item->force_to_v_offset(offset);
1290 if (item->enabled())
1291 offset += extents.second;
1295 if (!new_top_level_items.empty())
1296 // Expand the header pane because the header should become fully
1297 // visible when new signals are added
1298 expand_header_to_fit();
1303 viewport_->update();
1305 if (reset_scrollbar)
1306 set_scroll_default();
1309 void View::capture_state_updated(int state)
1311 if (state == Session::Running) {
1312 set_time_unit(util::TimeUnit::Samples);
1314 trigger_markers_.clear();
1316 // Activate "always zoom to fit" if the setting is enabled and we're
1317 // the main view of this session (other trace views may be used for
1318 // zooming and we don't want to mess them up)
1319 GlobalSettings settings;
1320 bool state = settings.value(GlobalSettings::Key_View_AlwaysZoomToFit).toBool();
1321 if (is_main_view_ && state) {
1322 always_zoom_to_fit_ = true;
1323 always_zoom_to_fit_changed(always_zoom_to_fit_);
1326 // Enable sticky scrolling if the setting is enabled
1327 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1330 if (state == Session::Stopped) {
1331 // After acquisition has stopped we need to re-calculate the ticks once
1332 // as it's otherwise done when the user pans or zooms, which is too late
1333 calculate_tick_spacing();
1335 // Reset "always zoom to fit", the acquisition has stopped
1336 if (always_zoom_to_fit_) {
1337 // Perform a final zoom-to-fit before disabling
1338 zoom_fit(always_zoom_to_fit_);
1339 always_zoom_to_fit_ = false;
1340 always_zoom_to_fit_changed(always_zoom_to_fit_);
1345 void View::perform_delayed_view_update()
1347 if (always_zoom_to_fit_) {
1349 } else if (sticky_scrolling_) {
1350 // Make right side of the view sticky
1353 get_scroll_layout(length, offset);
1355 const QSize areaSize = viewport_->size();
1356 length = max(length - areaSize.width(), 0.0);
1358 set_offset(scale_ * length);
1361 determine_time_unit();
1364 viewport_->update();
1367 void View::process_sticky_events()
1369 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1371 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1372 restack_all_trace_tree_items();
1376 // Clear the sticky events
1380 void View::on_hover_point_changed()
1382 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1383 list_by_type<TraceTreeItem>());
1384 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1385 r->hover_point_changed();
1388 } // namespace TraceView
1389 } // namespace views