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 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
133 always_zoom_to_fit_(false),
135 tick_prefix_(pv::util::SIPrefix::yocto),
137 time_unit_(util::TimeUnit::Time),
138 show_cursors_(false),
139 cursors_(new CursorPair(*this)),
140 next_flag_text_('A'),
142 hover_point_(-1, -1),
143 scroll_needs_defaults_(false),
146 QVBoxLayout *root_layout = new QVBoxLayout(this);
147 root_layout->setContentsMargins(0, 0, 0, 0);
148 root_layout->addWidget(splitter_);
150 viewport_ = new Viewport(*this);
151 scrollarea_ = new CustomScrollArea(splitter_);
152 scrollarea_->setViewport(viewport_);
153 scrollarea_->setFrameShape(QFrame::NoFrame);
155 ruler_ = new Ruler(*this);
157 header_ = new Header(*this);
158 header_->setMinimumWidth(10); // So that the arrow tips show at least
160 // We put the header into a simple layout so that we can add the top margin,
161 // allowing us to make it line up with the bottom of the ruler
162 QWidget *header_container = new QWidget();
163 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
164 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
165 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
166 header_layout->addWidget(header_);
168 // To let the ruler and scrollarea be on the same split pane, we need a layout
169 QWidget *trace_container = new QWidget();
170 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
171 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
172 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
173 trace_layout->setContentsMargins(0, 0, 0, 0);
174 trace_layout->addWidget(ruler_);
175 trace_layout->addWidget(scrollarea_);
177 splitter_->addWidget(header_container);
178 splitter_->addWidget(trace_container);
179 splitter_->setHandleWidth(1); // Don't show a visible rubber band
180 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
181 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
182 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
184 viewport_->installEventFilter(this);
185 ruler_->installEventFilter(this);
186 header_->installEventFilter(this);
188 // Set up settings and event handlers
189 GlobalSettings settings;
190 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
192 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
193 this, SLOT(h_scroll_value_changed(int)));
194 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
195 this, SLOT(v_scroll_value_changed()));
197 connect(header_, SIGNAL(selection_changed()),
198 ruler_, SLOT(clear_selection()));
199 connect(ruler_, SIGNAL(selection_changed()),
200 header_, SLOT(clear_selection()));
202 connect(header_, SIGNAL(selection_changed()),
203 this, SIGNAL(selection_changed()));
204 connect(ruler_, SIGNAL(selection_changed()),
205 this, SIGNAL(selection_changed()));
207 connect(splitter_, SIGNAL(splitterMoved(int, int)),
208 this, SLOT(on_splitter_moved()));
210 connect(this, SIGNAL(hover_point_changed()),
211 this, SLOT(on_hover_point_changed()));
213 connect(&lazy_event_handler_, SIGNAL(timeout()),
214 this, SLOT(process_sticky_events()));
215 lazy_event_handler_.setSingleShot(true);
217 // Trigger the initial event manually. The default device has signals
218 // which were created before this object came into being
221 // make sure the transparent widgets are on the top
225 // Update the zoom state
226 calculate_tick_spacing();
229 Session& View::session()
234 const Session& View::session() const
239 unordered_set< shared_ptr<Signal> > View::signals() const
244 void View::clear_signals()
246 ViewBase::clear_signalbases();
250 void View::add_signal(const shared_ptr<Signal> signal)
252 ViewBase::add_signalbase(signal->base());
253 signals_.insert(signal);
257 void View::clear_decode_signals()
259 decode_traces_.clear();
262 void View::add_decode_signal(shared_ptr<data::SignalBase> signalbase)
264 shared_ptr<DecodeTrace> d(
265 new DecodeTrace(session_, signalbase, decode_traces_.size()));
266 decode_traces_.push_back(d);
269 void View::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
271 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
272 if ((*i)->base() == signalbase) {
273 decode_traces_.erase(i);
285 const View* View::view() const
290 Viewport* View::viewport()
295 const Viewport* View::viewport() const
300 void View::save_settings(QSettings &settings) const
302 settings.setValue("scale", scale_);
303 settings.setValue("v_offset",
304 scrollarea_->verticalScrollBar()->sliderPosition());
306 settings.setValue("splitter_state", splitter_->saveState());
309 boost::archive::text_oarchive oa(ss);
310 oa << boost::serialization::make_nvp("offset", offset_);
311 settings.setValue("offset", QString::fromStdString(ss.str()));
313 for (shared_ptr<Signal> signal : signals_) {
314 settings.beginGroup(signal->base()->internal_name());
315 signal->save_settings(settings);
320 void View::restore_settings(QSettings &settings)
322 // Note: It is assumed that this function is only called once,
323 // immediately after restoring a previous session.
325 if (settings.contains("scale"))
326 set_scale(settings.value("scale").toDouble());
328 if (settings.contains("offset")) {
329 util::Timestamp offset;
331 ss << settings.value("offset").toString().toStdString();
333 boost::archive::text_iarchive ia(ss);
334 ia >> boost::serialization::make_nvp("offset", offset);
339 if (settings.contains("splitter_state"))
340 splitter_->restoreState(settings.value("splitter_state").toByteArray());
342 for (shared_ptr<Signal> signal : signals_) {
343 settings.beginGroup(signal->base()->internal_name());
344 signal->restore_settings(settings);
348 if (settings.contains("v_offset")) {
349 saved_v_offset_ = settings.value("v_offset").toInt();
350 set_v_offset(saved_v_offset_);
351 scroll_needs_defaults_ = false;
352 // Note: see eventFilter() for additional information
356 vector< shared_ptr<TimeItem> > View::time_items() const
358 const vector<shared_ptr<Flag>> f(flags());
359 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
360 items.push_back(cursors_);
361 items.push_back(cursors_->first());
362 items.push_back(cursors_->second());
364 for (auto trigger_marker : trigger_markers_)
365 items.push_back(trigger_marker);
370 double View::scale() const
375 void View::set_scale(double scale)
377 if (scale_ != scale) {
379 Q_EMIT scale_changed();
383 const Timestamp& View::offset() const
388 void View::set_offset(const pv::util::Timestamp& offset)
390 if (offset_ != offset) {
392 Q_EMIT offset_changed();
396 int View::owner_visual_v_offset() const
398 return -scrollarea_->verticalScrollBar()->sliderPosition();
401 void View::set_v_offset(int offset)
403 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
408 unsigned int View::depth() const
413 pv::util::SIPrefix View::tick_prefix() const
418 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
420 if (tick_prefix_ != tick_prefix) {
421 tick_prefix_ = tick_prefix;
422 Q_EMIT tick_prefix_changed();
426 unsigned int View::tick_precision() const
428 return tick_precision_;
431 void View::set_tick_precision(unsigned tick_precision)
433 if (tick_precision_ != tick_precision) {
434 tick_precision_ = tick_precision;
435 Q_EMIT tick_precision_changed();
439 const pv::util::Timestamp& View::tick_period() const
444 void View::set_tick_period(const pv::util::Timestamp& tick_period)
446 if (tick_period_ != tick_period) {
447 tick_period_ = tick_period;
448 Q_EMIT tick_period_changed();
452 TimeUnit View::time_unit() const
457 void View::set_time_unit(pv::util::TimeUnit time_unit)
459 if (time_unit_ != time_unit) {
460 time_unit_ = time_unit;
461 Q_EMIT time_unit_changed();
465 void View::zoom(double steps)
467 zoom(steps, viewport_->width() / 2);
470 void View::zoom(double steps, int offset)
472 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
475 void View::zoom_fit(bool gui_state)
477 // Act as one-shot when stopped, toggle along with the GUI otherwise
478 if (session_.get_capture_state() == Session::Stopped) {
479 always_zoom_to_fit_ = false;
480 always_zoom_to_fit_changed(false);
482 always_zoom_to_fit_ = gui_state;
483 always_zoom_to_fit_changed(gui_state);
486 const pair<Timestamp, Timestamp> extents = get_time_extents();
487 const Timestamp delta = extents.second - extents.first;
488 if (delta < Timestamp("1e-12"))
492 const int w = viewport_->width();
496 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
497 set_scale_offset(scale.convert_to<double>(), extents.first);
500 void View::zoom_one_to_one()
502 using pv::data::SignalData;
504 // Make a set of all the visible data objects
505 set< shared_ptr<SignalData> > visible_data = get_visible_data();
506 if (visible_data.empty())
510 const int w = viewport_->width();
514 set_zoom(1.0 / session_.get_samplerate(), w / 2);
517 void View::set_scale_offset(double scale, const Timestamp& offset)
519 // Disable sticky scrolling / always zoom to fit when acquisition runs
520 // and user drags the viewport
521 if ((scale_ == scale) && (offset_ != offset) &&
522 (session_.get_capture_state() == Session::Running)) {
524 if (sticky_scrolling_) {
525 sticky_scrolling_ = false;
526 sticky_scrolling_changed(false);
529 if (always_zoom_to_fit_) {
530 always_zoom_to_fit_ = false;
531 always_zoom_to_fit_changed(false);
538 calculate_tick_spacing();
545 set< shared_ptr<SignalData> > View::get_visible_data() const
547 // Make a set of all the visible data objects
548 set< shared_ptr<SignalData> > visible_data;
549 for (const shared_ptr<Signal> sig : signals_)
551 visible_data.insert(sig->data());
556 pair<Timestamp, Timestamp> View::get_time_extents() const
558 boost::optional<Timestamp> left_time, right_time;
559 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
560 for (const shared_ptr<SignalData> d : visible_data) {
561 const vector< shared_ptr<Segment> > segments = d->segments();
562 for (const shared_ptr<Segment> &s : segments) {
563 double samplerate = s->samplerate();
564 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
566 const Timestamp start_time = s->start_time();
567 left_time = left_time ?
568 min(*left_time, start_time) :
570 right_time = right_time ?
571 max(*right_time, start_time + d->max_sample_count() / samplerate) :
572 start_time + d->max_sample_count() / samplerate;
576 if (!left_time || !right_time)
577 return make_pair(0, 0);
579 assert(*left_time < *right_time);
580 return make_pair(*left_time, *right_time);
583 void View::enable_show_sampling_points(bool state)
590 void View::enable_show_analog_minor_grid(bool state)
597 void View::enable_coloured_bg(bool state)
599 coloured_bg_ = state;
603 bool View::coloured_bg() const
608 bool View::cursors_shown() const
610 return show_cursors_;
613 void View::show_cursors(bool show)
615 show_cursors_ = show;
620 void View::centre_cursors()
622 const double time_width = scale_ * viewport_->width();
623 cursors_->first()->set_time(offset_ + time_width * 0.4);
624 cursors_->second()->set_time(offset_ + time_width * 0.6);
629 shared_ptr<CursorPair> View::cursors() const
634 void View::add_flag(const Timestamp& time)
636 flags_.push_back(make_shared<Flag>(*this, time,
637 QString("%1").arg(next_flag_text_)));
639 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
640 (next_flag_text_ + 1);
642 time_item_appearance_changed(true, true);
645 void View::remove_flag(shared_ptr<Flag> flag)
648 time_item_appearance_changed(true, true);
651 vector< shared_ptr<Flag> > View::flags() const
653 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
654 stable_sort(flags.begin(), flags.end(),
655 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
656 return a->time() < b->time();
662 const QPoint& View::hover_point() const
667 void View::restack_all_trace_tree_items()
669 // Make a list of owners that is sorted from deepest first
670 const vector<shared_ptr<TraceTreeItem>> items(
671 list_by_type<TraceTreeItem>());
672 set< TraceTreeItemOwner* > owners;
673 for (const auto &r : items)
674 owners.insert(r->owner());
675 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
676 sort(sorted_owners.begin(), sorted_owners.end(),
677 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
678 return a->depth() > b->depth(); });
680 // Restack the items recursively
681 for (auto &o : sorted_owners)
684 // Animate the items to their destination
685 for (const auto &i : items)
686 i->animate_to_layout_v_offset();
689 void View::trigger_event(util::Timestamp location)
691 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
694 void View::get_scroll_layout(double &length, Timestamp &offset) const
696 const pair<Timestamp, Timestamp> extents = get_time_extents();
697 length = ((extents.second - extents.first) / scale_).convert_to<double>();
698 offset = offset_ / scale_;
701 void View::set_zoom(double scale, int offset)
703 // Reset the "always zoom to fit" feature as the user changed the zoom
704 always_zoom_to_fit_ = false;
705 always_zoom_to_fit_changed(false);
707 const Timestamp cursor_offset = offset_ + scale_ * offset;
708 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
709 const Timestamp new_offset = cursor_offset - new_scale * offset;
710 set_scale_offset(new_scale.convert_to<double>(), new_offset);
713 void View::calculate_tick_spacing()
715 const double SpacingIncrement = 10.0f;
716 const double MinValueSpacing = 40.0f;
718 // Figure out the highest numeric value visible on a label
719 const QSize areaSize = viewport_->size();
720 const Timestamp max_time = max(fabs(offset_),
721 fabs(offset_ + scale_ * areaSize.width()));
723 double min_width = SpacingIncrement;
724 double label_width, tick_period_width;
726 QFontMetrics m(QApplication::font());
728 // Copies of the member variables with the same name, used in the calculation
729 // and written back afterwards, so that we don't emit signals all the time
730 // during the calculation.
731 pv::util::Timestamp tick_period = tick_period_;
732 pv::util::SIPrefix tick_prefix = tick_prefix_;
733 unsigned tick_precision = tick_precision_;
736 const double min_period = scale_ * min_width;
738 const int order = (int)floorf(log10f(min_period));
739 const pv::util::Timestamp order_decimal =
740 pow(pv::util::Timestamp(10), order);
742 // Allow for a margin of error so that a scale unit of 1 can be used.
743 // Otherwise, for a SU of 1 the tick period will almost always be below
744 // the min_period by a small amount - and thus skipped in favor of 2.
745 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
746 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
747 double tp_with_margin;
748 unsigned int unit = 0;
751 tp_with_margin = order_decimal.convert_to<double>() *
752 (ScaleUnits[unit++] + tp_margin);
753 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
755 tick_period = order_decimal * ScaleUnits[unit - 1];
756 tick_prefix = static_cast<pv::util::SIPrefix>(
757 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
759 // Precision is the number of fractional digits required, not
760 // taking the prefix into account (and it must never be negative)
761 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
763 tick_period_width = (tick_period / scale_).convert_to<double>();
765 const QString label_text = Ruler::format_time_with_distance(
766 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
768 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
769 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
772 min_width += SpacingIncrement;
773 } while (tick_period_width < label_width);
775 set_tick_period(tick_period);
776 set_tick_prefix(tick_prefix);
777 set_tick_precision(tick_precision);
780 void View::adjust_top_margin()
784 const QSize areaSize = viewport_->size();
786 const pair<int, int> extents = v_extents();
787 const int top_margin = owner_visual_v_offset() + extents.first;
788 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
790 // Do we have empty space at the top while the last trace goes out of screen?
791 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
792 const int trace_height = extents.second - extents.first;
794 // Center everything vertically if there is enough space
795 if (areaSize.height() >= trace_height)
796 set_v_offset(extents.first -
797 ((areaSize.height() - trace_height) / 2));
799 // Remove the top margin to make as many traces fit on screen as possible
800 set_v_offset(extents.first);
804 void View::update_scroll()
807 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
808 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
810 const QSize areaSize = viewport_->size();
812 // Set the horizontal scroll bar
815 get_scroll_layout(length, offset);
816 length = max(length - areaSize.width(), 0.0);
818 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
820 hscrollbar->setPageStep(areaSize.width() / 2);
821 hscrollbar->setSingleStep(major_tick_distance);
823 updating_scroll_ = true;
825 if (length < MaxScrollValue) {
826 hscrollbar->setRange(0, length);
827 hscrollbar->setSliderPosition(offset.convert_to<double>());
829 hscrollbar->setRange(0, MaxScrollValue);
830 hscrollbar->setSliderPosition(
831 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
834 updating_scroll_ = false;
836 // Set the vertical scrollbar
837 vscrollbar->setPageStep(areaSize.height());
838 vscrollbar->setSingleStep(areaSize.height() / 8);
840 const pair<int, int> extents = v_extents();
842 // Don't change the scrollbar range if there are no traces
843 if (extents.first != extents.second)
844 vscrollbar->setRange(extents.first - areaSize.height(),
847 if (scroll_needs_defaults_)
848 set_scroll_default();
851 void View::reset_scroll()
853 scrollarea_->verticalScrollBar()->setRange(0, 0);
856 void View::set_scroll_default()
860 const QSize areaSize = viewport_->size();
862 const pair<int, int> extents = v_extents();
863 const int trace_height = extents.second - extents.first;
865 // Do all traces fit in the view?
866 if (areaSize.height() >= trace_height)
867 // Center all traces vertically
868 set_v_offset(extents.first -
869 ((areaSize.height() - trace_height) / 2));
871 // Put the first trace at the top, letting the bottom ones overflow
872 set_v_offset(extents.first);
875 bool View::header_fully_visible() const
877 const int header_pane_width = splitter_->sizes().front();
878 const int header_width = header_->extended_size_hint().width();
880 // Allow for a slight margin of error so that we also accept
881 // slight differences when e.g. a label name change increased
883 return (header_pane_width >= (header_width - 10));
886 void View::update_layout()
888 // Only adjust pane sizes if the header hasn't been partially hidden by the user
889 if (header_fully_visible()) {
890 int splitter_area_width = 0;
891 for (int w : splitter_->sizes())
892 splitter_area_width += w;
894 // Make sure the header has enough horizontal space to show all labels fully
895 QList<int> pane_sizes;
896 pane_sizes.push_back(header_->extended_size_hint().width());
897 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
898 splitter_->setSizes(pane_sizes);
904 TraceTreeItemOwner* View::find_prevalent_trace_group(
905 const shared_ptr<sigrok::ChannelGroup> &group,
906 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
911 unordered_set<TraceTreeItemOwner*> owners;
912 vector<TraceTreeItemOwner*> owner_list;
914 // Make a set and a list of all the owners
915 for (const auto &channel : group->channels()) {
916 for (auto entry : signal_map) {
917 if (entry.first->channel() == channel) {
918 TraceTreeItemOwner *const o = (entry.second)->owner();
919 owner_list.push_back(o);
925 // Iterate through the list of owners, and find the most prevalent
926 size_t max_prevalence = 0;
927 TraceTreeItemOwner *prevalent_owner = nullptr;
928 for (TraceTreeItemOwner *owner : owners) {
929 const size_t prevalence = count_if(
930 owner_list.begin(), owner_list.end(),
931 [&](TraceTreeItemOwner *o) { return o == owner; });
932 if (prevalence > max_prevalence) {
933 max_prevalence = prevalence;
934 prevalent_owner = owner;
938 return prevalent_owner;
941 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
942 const vector< shared_ptr<sigrok::Channel> > &channels,
943 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
945 set< shared_ptr<Trace> > &add_list)
947 vector< shared_ptr<Trace> > filtered_traces;
949 for (const auto &channel : channels) {
950 for (auto entry : signal_map) {
951 if (entry.first->channel() == channel) {
952 shared_ptr<Trace> trace = entry.second;
953 const auto list_iter = add_list.find(trace);
954 if (list_iter == add_list.end())
957 filtered_traces.push_back(trace);
958 add_list.erase(list_iter);
963 return filtered_traces;
966 void View::determine_time_unit()
968 // Check whether we know the sample rate and hence can use time as the unit
969 if (time_unit_ == util::TimeUnit::Samples) {
970 // Check all signals but...
971 for (const shared_ptr<Signal> signal : signals_) {
972 const shared_ptr<SignalData> data = signal->data();
974 // ...only check first segment of each
975 const vector< shared_ptr<Segment> > segments = data->segments();
976 if (!segments.empty())
977 if (segments[0]->samplerate()) {
978 set_time_unit(util::TimeUnit::Time);
985 bool View::eventFilter(QObject *object, QEvent *event)
987 const QEvent::Type type = event->type();
988 if (type == QEvent::MouseMove) {
990 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
991 if (object == viewport_)
992 hover_point_ = mouse_event->pos();
993 else if (object == ruler_)
994 hover_point_ = QPoint(mouse_event->x(), 0);
995 else if (object == header_)
996 hover_point_ = QPoint(0, mouse_event->y());
998 hover_point_ = QPoint(-1, -1);
1000 hover_point_changed();
1002 } else if (type == QEvent::Leave) {
1003 hover_point_ = QPoint(-1, -1);
1004 hover_point_changed();
1005 } else if (type == QEvent::Show) {
1007 // This is somewhat of a hack, unfortunately. We cannot use
1008 // set_v_offset() from within restore_settings() as the view
1009 // at that point is neither visible nor properly sized.
1010 // This is the least intrusive workaround I could come up
1011 // with: set the vertical offset (or scroll defaults) when
1012 // the view is shown, which happens after all widgets were
1013 // resized to their final sizes.
1016 if (scroll_needs_defaults_) {
1017 set_scroll_default();
1018 scroll_needs_defaults_ = false;
1021 if (saved_v_offset_) {
1022 set_v_offset(saved_v_offset_);
1023 saved_v_offset_ = 0;
1027 return QObject::eventFilter(object, event);
1030 void View::resizeEvent(QResizeEvent* event)
1032 // Only adjust the top margin if we shrunk vertically
1033 if (event->size().height() < event->oldSize().height())
1034 adjust_top_margin();
1039 void View::row_item_appearance_changed(bool label, bool content)
1044 viewport_->update();
1047 void View::time_item_appearance_changed(bool label, bool content)
1052 // Make sure the header pane width is updated, too
1057 viewport_->update();
1060 void View::extents_changed(bool horz, bool vert)
1063 (horz ? TraceTreeItemHExtentsChanged : 0) |
1064 (vert ? TraceTreeItemVExtentsChanged : 0);
1066 lazy_event_handler_.start();
1069 void View::on_splitter_moved()
1071 // Setting the maximum width of the header widget doesn't work as
1072 // expected because the splitter would allow the user to make the
1073 // pane wider than that, creating empty space as a result.
1074 // To make this work, we stricly enforce the maximum width by calling
1078 void View::h_scroll_value_changed(int value)
1080 if (updating_scroll_)
1083 // Disable sticky scrolling when user moves the horizontal scroll bar
1084 // during a running acquisition
1085 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1086 sticky_scrolling_ = false;
1087 sticky_scrolling_changed(false);
1090 const int range = scrollarea_->horizontalScrollBar()->maximum();
1091 if (range < MaxScrollValue)
1092 set_offset(scale_ * value);
1096 get_scroll_layout(length, offset);
1097 set_offset(scale_ * length * value / MaxScrollValue);
1101 viewport_->update();
1104 void View::v_scroll_value_changed()
1107 viewport_->update();
1110 void View::signals_changed()
1112 using sigrok::Channel;
1114 vector< shared_ptr<Channel> > channels;
1115 shared_ptr<sigrok::Device> sr_dev;
1117 // Do we need to set the vertical scrollbar to its default position later?
1118 // We do if there are no traces, i.e. the scroll bar has no range set
1119 bool reset_scrollbar =
1120 (scrollarea_->verticalScrollBar()->minimum() ==
1121 scrollarea_->verticalScrollBar()->maximum());
1123 if (!session_.device()) {
1127 sr_dev = session_.device()->device();
1129 channels = sr_dev->channels();
1132 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1134 // Make a list of traces that are being added, and a list of traces
1135 // that are being removed
1136 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1137 const set<shared_ptr<Trace>> prev_traces(
1138 prev_trace_list.begin(), prev_trace_list.end());
1140 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1142 #ifdef ENABLE_DECODE
1143 traces.insert(decode_traces_.begin(), decode_traces_.end());
1146 set< shared_ptr<Trace> > add_traces;
1147 set_difference(traces.begin(), traces.end(),
1148 prev_traces.begin(), prev_traces.end(),
1149 inserter(add_traces, add_traces.begin()));
1151 set< shared_ptr<Trace> > remove_traces;
1152 set_difference(prev_traces.begin(), prev_traces.end(),
1153 traces.begin(), traces.end(),
1154 inserter(remove_traces, remove_traces.begin()));
1156 // Make a look-up table of sigrok Channels to pulseview Signals
1157 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1159 for (const shared_ptr<Signal> &sig : signals_)
1160 signal_map[sig->base()] = sig;
1162 // Populate channel groups
1164 for (auto entry : sr_dev->channel_groups()) {
1165 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1167 if (group->channels().size() <= 1)
1170 // Find best trace group to add to
1171 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1174 // If there is no trace group, create one
1175 shared_ptr<TraceGroup> new_trace_group;
1177 new_trace_group.reset(new TraceGroup());
1178 owner = new_trace_group.get();
1181 // Extract traces for the trace group, removing them from
1183 const vector< shared_ptr<Trace> > new_traces_in_group =
1184 extract_new_traces_for_channels(group->channels(),
1185 signal_map, add_traces);
1187 // Add the traces to the group
1188 const pair<int, int> prev_v_extents = owner->v_extents();
1189 int offset = prev_v_extents.second - prev_v_extents.first;
1190 for (shared_ptr<Trace> trace : new_traces_in_group) {
1192 owner->add_child_item(trace);
1194 const pair<int, int> extents = trace->v_extents();
1195 if (trace->enabled())
1196 offset += -extents.first;
1197 trace->force_to_v_offset(offset);
1198 if (trace->enabled())
1199 offset += extents.second;
1202 if (new_trace_group) {
1203 // Assign proper vertical offsets to each channel in the group
1204 new_trace_group->restack_items();
1206 // If this is a new group, enqueue it in the new top level
1208 if (!new_traces_in_group.empty())
1209 new_top_level_items.push_back(new_trace_group);
1213 // Enqueue the remaining logic channels in a group
1214 vector< shared_ptr<Channel> > logic_channels;
1215 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1216 [](const shared_ptr<Channel>& c) {
1217 return c->type() == sigrok::ChannelType::LOGIC; });
1219 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1220 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1222 if (non_grouped_logic_signals.size() > 0) {
1223 const shared_ptr<TraceGroup> non_grouped_trace_group(
1224 make_shared<TraceGroup>());
1225 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1226 non_grouped_trace_group->add_child_item(trace);
1228 non_grouped_trace_group->restack_items();
1229 new_top_level_items.push_back(non_grouped_trace_group);
1232 // Enqueue the remaining channels as free ungrouped traces
1233 const vector< shared_ptr<Trace> > new_top_level_signals =
1234 extract_new_traces_for_channels(channels, signal_map, add_traces);
1235 new_top_level_items.insert(new_top_level_items.end(),
1236 new_top_level_signals.begin(), new_top_level_signals.end());
1238 // Enqueue any remaining traces i.e. decode traces
1239 new_top_level_items.insert(new_top_level_items.end(),
1240 add_traces.begin(), add_traces.end());
1242 // Remove any removed traces
1243 for (shared_ptr<Trace> trace : remove_traces) {
1244 TraceTreeItemOwner *const owner = trace->owner();
1246 owner->remove_child_item(trace);
1249 // Remove any empty trace groups
1250 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1251 if (group->child_items().size() == 0) {
1252 remove_child_item(group);
1256 // Add and position the pending top levels items
1257 int offset = v_extents().second;
1258 for (auto item : new_top_level_items) {
1259 add_child_item(item);
1261 // Position the item after the last item or at the top if there is none
1262 const pair<int, int> extents = item->v_extents();
1264 if (item->enabled())
1265 offset += -extents.first;
1267 item->force_to_v_offset(offset);
1269 if (item->enabled())
1270 offset += extents.second;
1276 viewport_->update();
1278 if (reset_scrollbar)
1279 set_scroll_default();
1282 void View::capture_state_updated(int state)
1284 if (state == Session::Running) {
1285 set_time_unit(util::TimeUnit::Samples);
1287 trigger_markers_.clear();
1289 // Activate "always zoom to fit" if the setting is enabled and we're
1290 // the main view of this session (other trace views may be used for
1291 // zooming and we don't want to mess them up)
1292 GlobalSettings settings;
1293 bool state = settings.value(GlobalSettings::Key_View_AlwaysZoomToFit).toBool();
1294 if (is_main_view_ && state) {
1295 always_zoom_to_fit_ = true;
1296 always_zoom_to_fit_changed(always_zoom_to_fit_);
1299 // Enable sticky scrolling if the setting is enabled
1300 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1303 if (state == Session::Stopped) {
1304 // After acquisition has stopped we need to re-calculate the ticks once
1305 // as it's otherwise done when the user pans or zooms, which is too late
1306 calculate_tick_spacing();
1308 // Reset "always zoom to fit", the acquisition has stopped
1309 if (always_zoom_to_fit_) {
1310 // Perform a final zoom-to-fit before disabling
1311 zoom_fit(always_zoom_to_fit_);
1312 always_zoom_to_fit_ = false;
1313 always_zoom_to_fit_changed(always_zoom_to_fit_);
1318 void View::perform_delayed_view_update()
1320 if (always_zoom_to_fit_) {
1322 } else if (sticky_scrolling_) {
1323 // Make right side of the view sticky
1326 get_scroll_layout(length, offset);
1328 const QSize areaSize = viewport_->size();
1329 length = max(length - areaSize.width(), 0.0);
1331 set_offset(scale_ * length);
1334 determine_time_unit();
1337 viewport_->update();
1340 void View::process_sticky_events()
1342 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1344 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1345 restack_all_trace_tree_items();
1349 // Clear the sticky events
1353 void View::on_hover_point_changed()
1355 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1356 list_by_type<TraceTreeItem>());
1357 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1358 r->hover_point_changed();
1361 } // namespace TraceView
1362 } // namespace views