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;
82 using std::placeholders::_1;
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()),
129 segment_display_mode_(Trace::ShowLastSegmentOnly),
130 segment_selectable_(false),
134 updating_scroll_(false),
135 settings_restored_(false),
136 header_was_shrunk_(false),
137 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
138 always_zoom_to_fit_(false),
140 tick_prefix_(pv::util::SIPrefix::yocto),
142 time_unit_(util::TimeUnit::Time),
143 show_cursors_(false),
144 cursors_(new CursorPair(*this)),
145 next_flag_text_('A'),
147 hover_point_(-1, -1),
148 scroll_needs_defaults_(true),
150 scale_at_acq_start_(0),
151 offset_at_acq_start_(0),
152 suppress_zoom_to_fit_after_acq_(false)
154 QVBoxLayout *root_layout = new QVBoxLayout(this);
155 root_layout->setContentsMargins(0, 0, 0, 0);
156 root_layout->addWidget(splitter_);
158 viewport_ = new Viewport(*this);
159 scrollarea_ = new CustomScrollArea(splitter_);
160 scrollarea_->setViewport(viewport_);
161 scrollarea_->setFrameShape(QFrame::NoFrame);
163 ruler_ = new Ruler(*this);
165 header_ = new Header(*this);
166 header_->setMinimumWidth(10); // So that the arrow tips show at least
168 // We put the header into a simple layout so that we can add the top margin,
169 // allowing us to make it line up with the bottom of the ruler
170 QWidget *header_container = new QWidget();
171 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
172 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
173 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
174 header_layout->addWidget(header_);
176 // To let the ruler and scrollarea be on the same split pane, we need a layout
177 QWidget *trace_container = new QWidget();
178 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
179 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
180 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
181 trace_layout->setContentsMargins(0, 0, 0, 0);
182 trace_layout->addWidget(ruler_);
183 trace_layout->addWidget(scrollarea_);
185 splitter_->addWidget(header_container);
186 splitter_->addWidget(trace_container);
187 splitter_->setHandleWidth(1); // Don't show a visible rubber band
188 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
189 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
190 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
191 splitter_->setStretchFactor(1, 1); // when the entire view is resized
192 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
194 viewport_->installEventFilter(this);
195 ruler_->installEventFilter(this);
196 header_->installEventFilter(this);
198 // Set up settings and event handlers
199 GlobalSettings settings;
200 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
202 GlobalSettings::add_change_handler(this);
204 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
205 this, SLOT(h_scroll_value_changed(int)));
206 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
207 this, SLOT(v_scroll_value_changed()));
209 connect(header_, SIGNAL(selection_changed()),
210 ruler_, SLOT(clear_selection()));
211 connect(ruler_, SIGNAL(selection_changed()),
212 header_, SLOT(clear_selection()));
214 connect(header_, SIGNAL(selection_changed()),
215 this, SIGNAL(selection_changed()));
216 connect(ruler_, SIGNAL(selection_changed()),
217 this, SIGNAL(selection_changed()));
219 connect(splitter_, SIGNAL(splitterMoved(int, int)),
220 this, SLOT(on_splitter_moved()));
222 connect(&lazy_event_handler_, SIGNAL(timeout()),
223 this, SLOT(process_sticky_events()));
224 lazy_event_handler_.setSingleShot(true);
226 // Trigger the initial event manually. The default device has signals
227 // which were created before this object came into being
230 // make sure the transparent widgets are on the top
234 // Update the zoom state
235 calculate_tick_spacing();
237 // Make sure the standard bar's segment selector is in sync
238 set_segment_display_mode(segment_display_mode_);
243 GlobalSettings::remove_change_handler(this);
246 Session& View::session()
251 const Session& View::session() const
256 unordered_set< shared_ptr<Signal> > View::signals() const
261 void View::clear_signals()
263 ViewBase::clear_signalbases();
267 void View::add_signal(const shared_ptr<Signal> signal)
269 ViewBase::add_signalbase(signal->base());
270 signals_.insert(signal);
272 signal->set_segment_display_mode(segment_display_mode_);
273 signal->set_current_segment(current_segment_);
275 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
276 this, SLOT(on_signal_name_changed()));
280 void View::clear_decode_signals()
282 decode_traces_.clear();
285 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
287 shared_ptr<DecodeTrace> d(
288 new DecodeTrace(session_, signal, decode_traces_.size()));
289 decode_traces_.push_back(d);
291 d->set_segment_display_mode(segment_display_mode_);
292 d->set_current_segment(current_segment_);
294 connect(signal.get(), SIGNAL(name_changed(const QString&)),
295 this, SLOT(on_signal_name_changed()));
298 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
300 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
301 if ((*i)->base() == signal) {
302 decode_traces_.erase(i);
314 const View* View::view() const
319 Viewport* View::viewport()
324 const Viewport* View::viewport() const
329 void View::save_settings(QSettings &settings) const
331 settings.setValue("scale", scale_);
332 settings.setValue("v_offset",
333 scrollarea_->verticalScrollBar()->sliderPosition());
335 settings.setValue("splitter_state", splitter_->saveState());
336 settings.setValue("segment_display_mode", segment_display_mode_);
340 boost::archive::text_oarchive oa(ss);
341 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
342 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
346 boost::archive::text_oarchive oa(ss);
347 oa << boost::serialization::make_nvp("offset", offset_);
348 settings.setValue("offset", QString::fromStdString(ss.str()));
351 for (shared_ptr<Signal> signal : signals_) {
352 settings.beginGroup(signal->base()->internal_name());
353 signal->save_settings(settings);
358 void View::restore_settings(QSettings &settings)
360 // Note: It is assumed that this function is only called once,
361 // immediately after restoring a previous session.
363 if (settings.contains("scale"))
364 set_scale(settings.value("scale").toDouble());
366 if (settings.contains("ruler_shift")) {
367 util::Timestamp shift;
369 ss << settings.value("ruler_shift").toString().toStdString();
371 boost::archive::text_iarchive ia(ss);
372 ia >> boost::serialization::make_nvp("ruler_shift", shift);
374 ruler_shift_ = shift;
377 if (settings.contains("offset")) {
378 util::Timestamp offset;
380 ss << settings.value("offset").toString().toStdString();
382 boost::archive::text_iarchive ia(ss);
383 ia >> boost::serialization::make_nvp("offset", offset);
385 // This also updates ruler_offset_
389 if (settings.contains("splitter_state"))
390 splitter_->restoreState(settings.value("splitter_state").toByteArray());
392 if (settings.contains("segment_display_mode"))
393 set_segment_display_mode(
394 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
396 for (shared_ptr<Signal> signal : signals_) {
397 settings.beginGroup(signal->base()->internal_name());
398 signal->restore_settings(settings);
402 if (settings.contains("v_offset")) {
403 saved_v_offset_ = settings.value("v_offset").toInt();
404 set_v_offset(saved_v_offset_);
405 scroll_needs_defaults_ = false;
406 // Note: see eventFilter() for additional information
409 settings_restored_ = true;
410 suppress_zoom_to_fit_after_acq_ = true;
412 // Update the ruler so that it uses the new scale
413 calculate_tick_spacing();
416 vector< shared_ptr<TimeItem> > View::time_items() const
418 const vector<shared_ptr<Flag>> f(flags());
419 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
420 items.push_back(cursors_);
421 items.push_back(cursors_->first());
422 items.push_back(cursors_->second());
424 for (auto trigger_marker : trigger_markers_)
425 items.push_back(trigger_marker);
430 double View::scale() const
435 void View::set_scale(double scale)
437 if (scale_ != scale) {
443 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
445 if ((offset_ != offset) || force_update) {
447 ruler_offset_ = offset_ + ruler_shift_;
452 const Timestamp& View::offset() const
457 const Timestamp& View::ruler_offset() const
459 return ruler_offset_;
462 void View::set_zero_position(pv::util::Timestamp& position)
464 ruler_shift_ = -position;
466 // Force an immediate update of the offsets
467 set_offset(offset_, true);
471 void View::reset_zero_position()
475 // Force an immediate update of the offsets
476 set_offset(offset_, true);
480 int View::owner_visual_v_offset() const
482 return -scrollarea_->verticalScrollBar()->sliderPosition();
485 void View::set_v_offset(int offset)
487 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
492 unsigned int View::depth() const
497 uint32_t View::current_segment() const
499 return current_segment_;
502 pv::util::SIPrefix View::tick_prefix() const
507 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
509 if (tick_prefix_ != tick_prefix) {
510 tick_prefix_ = tick_prefix;
511 tick_prefix_changed();
515 unsigned int View::tick_precision() const
517 return tick_precision_;
520 void View::set_tick_precision(unsigned tick_precision)
522 if (tick_precision_ != tick_precision) {
523 tick_precision_ = tick_precision;
524 tick_precision_changed();
528 const pv::util::Timestamp& View::tick_period() const
533 unsigned int View::minor_tick_count() const
535 return minor_tick_count_;
538 void View::set_tick_period(const pv::util::Timestamp& tick_period)
540 if (tick_period_ != tick_period) {
541 tick_period_ = tick_period;
542 tick_period_changed();
546 TimeUnit View::time_unit() const
551 void View::set_time_unit(pv::util::TimeUnit time_unit)
553 if (time_unit_ != time_unit) {
554 time_unit_ = time_unit;
559 void View::set_current_segment(uint32_t segment_id)
561 current_segment_ = segment_id;
563 for (shared_ptr<Signal> signal : signals_)
564 signal->set_current_segment(current_segment_);
566 for (shared_ptr<DecodeTrace> dt : decode_traces_)
567 dt->set_current_segment(current_segment_);
570 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
572 trigger_markers_.clear();
573 for (util::Timestamp timestamp : triggers)
574 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
576 // When enabled, the first trigger for this segment is used as the zero position
577 GlobalSettings settings;
578 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
580 if (trigger_is_zero_time && (triggers.size() > 0))
581 set_zero_position(triggers.front());
585 segment_changed(segment_id);
588 bool View::segment_is_selectable() const
590 return segment_selectable_;
593 Trace::SegmentDisplayMode View::segment_display_mode() const
595 return segment_display_mode_;
598 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
600 trigger_markers_.clear();
602 segment_display_mode_ = mode;
604 for (shared_ptr<Signal> signal : signals_)
605 signal->set_segment_display_mode(mode);
607 uint32_t last_segment = session_.get_segment_count() - 1;
610 case Trace::ShowLastSegmentOnly:
611 if (current_segment_ != last_segment)
612 set_current_segment(last_segment);
615 case Trace::ShowLastCompleteSegmentOnly:
616 // Do nothing if we only have one segment so far
617 if (last_segment > 0) {
618 // If the last segment isn't complete, the previous one must be
619 uint32_t segment_id =
620 (session_.all_segments_complete(last_segment)) ?
621 last_segment : last_segment - 1;
623 if (current_segment_ != segment_id)
624 set_current_segment(segment_id);
628 case Trace::ShowSingleSegmentOnly:
629 case Trace::ShowAllSegments:
630 case Trace::ShowAccumulatedIntensity:
632 // Current segment remains as-is
636 segment_selectable_ = true;
638 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
639 segment_selectable_ = false;
643 segment_display_mode_changed((int)mode, segment_selectable_);
646 void View::zoom(double steps)
648 zoom(steps, viewport_->width() / 2);
651 void View::zoom(double steps, int offset)
653 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
656 void View::zoom_fit(bool gui_state)
658 // Act as one-shot when stopped, toggle along with the GUI otherwise
659 if (session_.get_capture_state() == Session::Stopped) {
660 always_zoom_to_fit_ = false;
661 always_zoom_to_fit_changed(false);
663 always_zoom_to_fit_ = gui_state;
664 always_zoom_to_fit_changed(gui_state);
667 const pair<Timestamp, Timestamp> extents = get_time_extents();
668 const Timestamp delta = extents.second - extents.first;
669 if (delta < Timestamp("1e-12"))
673 const int w = viewport_->width();
677 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
678 set_scale_offset(scale.convert_to<double>(), extents.first);
681 void View::zoom_one_to_one()
683 using pv::data::SignalData;
685 // Make a set of all the visible data objects
686 set< shared_ptr<SignalData> > visible_data = get_visible_data();
687 if (visible_data.empty())
691 const int w = viewport_->width();
695 set_zoom(1.0 / session_.get_samplerate(), w / 2);
698 void View::set_scale_offset(double scale, const Timestamp& offset)
700 // Disable sticky scrolling / always zoom to fit when acquisition runs
701 // and user drags the viewport
702 if ((scale_ == scale) && (offset_ != offset) &&
703 (session_.get_capture_state() == Session::Running)) {
705 if (sticky_scrolling_) {
706 sticky_scrolling_ = false;
707 sticky_scrolling_changed(false);
710 if (always_zoom_to_fit_) {
711 always_zoom_to_fit_ = false;
712 always_zoom_to_fit_changed(false);
719 calculate_tick_spacing();
726 set< shared_ptr<SignalData> > View::get_visible_data() const
728 // Make a set of all the visible data objects
729 set< shared_ptr<SignalData> > visible_data;
730 for (const shared_ptr<Signal> sig : signals_)
732 visible_data.insert(sig->data());
737 pair<Timestamp, Timestamp> View::get_time_extents() const
739 boost::optional<Timestamp> left_time, right_time;
740 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
741 for (const shared_ptr<SignalData> d : visible_data) {
742 const vector< shared_ptr<Segment> > segments = d->segments();
743 for (const shared_ptr<Segment> &s : segments) {
744 double samplerate = s->samplerate();
745 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
747 const Timestamp start_time = s->start_time();
748 left_time = left_time ?
749 min(*left_time, start_time) :
751 right_time = right_time ?
752 max(*right_time, start_time + d->max_sample_count() / samplerate) :
753 start_time + d->max_sample_count() / samplerate;
757 if (!left_time || !right_time)
758 return make_pair(0, 0);
760 assert(*left_time < *right_time);
761 return make_pair(*left_time, *right_time);
764 void View::enable_show_sampling_points(bool state)
771 void View::enable_show_analog_minor_grid(bool state)
778 void View::enable_coloured_bg(bool state)
780 coloured_bg_ = state;
784 bool View::coloured_bg() const
789 bool View::cursors_shown() const
791 return show_cursors_;
794 void View::show_cursors(bool show)
796 show_cursors_ = show;
801 void View::centre_cursors()
803 const double time_width = scale_ * viewport_->width();
804 cursors_->first()->set_time(offset_ + time_width * 0.4);
805 cursors_->second()->set_time(offset_ + time_width * 0.6);
810 shared_ptr<CursorPair> View::cursors() const
815 void View::add_flag(const Timestamp& time)
817 flags_.push_back(make_shared<Flag>(*this, time,
818 QString("%1").arg(next_flag_text_)));
820 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
821 (next_flag_text_ + 1);
823 time_item_appearance_changed(true, true);
826 void View::remove_flag(shared_ptr<Flag> flag)
829 time_item_appearance_changed(true, true);
832 vector< shared_ptr<Flag> > View::flags() const
834 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
835 stable_sort(flags.begin(), flags.end(),
836 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
837 return a->time() < b->time();
843 const QPoint& View::hover_point() const
848 void View::restack_all_trace_tree_items()
850 // Make a list of owners that is sorted from deepest first
851 const vector<shared_ptr<TraceTreeItem>> items(
852 list_by_type<TraceTreeItem>());
853 set< TraceTreeItemOwner* > owners;
854 for (const auto &r : items)
855 owners.insert(r->owner());
856 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
857 sort(sorted_owners.begin(), sorted_owners.end(),
858 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
859 return a->depth() > b->depth(); });
861 // Restack the items recursively
862 for (auto &o : sorted_owners)
865 // Animate the items to their destination
866 for (const auto &i : items)
867 i->animate_to_layout_v_offset();
870 void View::on_setting_changed(const QString &key, const QVariant &value)
872 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
873 on_settingViewTriggerIsZeroTime_changed(value);
876 void View::trigger_event(int segment_id, util::Timestamp location)
878 // TODO This doesn't work if we're showing multiple segments at once
879 if ((uint32_t)segment_id != current_segment_)
882 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
883 // if this is the first trigger for this segment.
884 GlobalSettings settings;
885 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
887 size_t trigger_count = session_.get_triggers(current_segment_).size();
889 if (trigger_is_zero_time && trigger_count == 1)
890 set_zero_position(location);
892 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
895 void View::get_scroll_layout(double &length, Timestamp &offset) const
897 const pair<Timestamp, Timestamp> extents = get_time_extents();
898 length = ((extents.second - extents.first) / scale_).convert_to<double>();
899 offset = offset_ / scale_;
902 void View::set_zoom(double scale, int offset)
904 // Reset the "always zoom to fit" feature as the user changed the zoom
905 always_zoom_to_fit_ = false;
906 always_zoom_to_fit_changed(false);
908 const Timestamp cursor_offset = offset_ + scale_ * offset;
909 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
910 const Timestamp new_offset = cursor_offset - new_scale * offset;
911 set_scale_offset(new_scale.convert_to<double>(), new_offset);
914 void View::calculate_tick_spacing()
916 const double SpacingIncrement = 10.0f;
917 const double MinValueSpacing = 40.0f;
919 // Figure out the highest numeric value visible on a label
920 const QSize areaSize = viewport_->size();
921 const Timestamp max_time = max(fabs(offset_),
922 fabs(offset_ + scale_ * areaSize.width()));
924 double min_width = SpacingIncrement;
925 double label_width, tick_period_width;
927 QFontMetrics m(QApplication::font());
929 // Copies of the member variables with the same name, used in the calculation
930 // and written back afterwards, so that we don't emit signals all the time
931 // during the calculation.
932 pv::util::Timestamp tick_period = tick_period_;
933 pv::util::SIPrefix tick_prefix = tick_prefix_;
934 unsigned tick_precision = tick_precision_;
937 const double min_period = scale_ * min_width;
939 const int order = (int)floorf(log10f(min_period));
940 const pv::util::Timestamp order_decimal =
941 pow(pv::util::Timestamp(10), order);
943 // Allow for a margin of error so that a scale unit of 1 can be used.
944 // Otherwise, for a SU of 1 the tick period will almost always be below
945 // the min_period by a small amount - and thus skipped in favor of 2.
946 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
947 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
948 double tp_with_margin;
949 unsigned int unit = 0;
952 tp_with_margin = order_decimal.convert_to<double>() *
953 (ScaleUnits[unit++] + tp_margin);
954 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
956 minor_tick_count_ = (unit == 2) ? (4) : (5);
957 tick_period = order_decimal * ScaleUnits[unit - 1];
958 tick_prefix = static_cast<pv::util::SIPrefix>(
959 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
961 // Precision is the number of fractional digits required, not
962 // taking the prefix into account (and it must never be negative)
963 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
965 tick_period_width = (tick_period / scale_).convert_to<double>();
967 const QString label_text = Ruler::format_time_with_distance(
968 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
970 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
971 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
974 min_width += SpacingIncrement;
975 } while (tick_period_width < label_width);
977 set_tick_period(tick_period);
978 set_tick_prefix(tick_prefix);
979 set_tick_precision(tick_precision);
982 void View::adjust_top_margin()
986 const QSize areaSize = viewport_->size();
988 const pair<int, int> extents = v_extents();
989 const int top_margin = owner_visual_v_offset() + extents.first;
990 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
992 // Do we have empty space at the top while the last trace goes out of screen?
993 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
994 const int trace_height = extents.second - extents.first;
996 // Center everything vertically if there is enough space
997 if (areaSize.height() >= trace_height)
998 set_v_offset(extents.first -
999 ((areaSize.height() - trace_height) / 2));
1001 // Remove the top margin to make as many traces fit on screen as possible
1002 set_v_offset(extents.first);
1006 void View::update_scroll()
1009 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1010 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1012 const QSize areaSize = viewport_->size();
1014 // Set the horizontal scroll bar
1017 get_scroll_layout(length, offset);
1018 length = max(length - areaSize.width(), 0.0);
1020 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1022 hscrollbar->setPageStep(areaSize.width() / 2);
1023 hscrollbar->setSingleStep(major_tick_distance);
1025 updating_scroll_ = true;
1027 if (length < MaxScrollValue) {
1028 hscrollbar->setRange(0, length);
1029 hscrollbar->setSliderPosition(offset.convert_to<double>());
1031 hscrollbar->setRange(0, MaxScrollValue);
1032 hscrollbar->setSliderPosition(
1033 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1036 updating_scroll_ = false;
1038 // Set the vertical scrollbar
1039 vscrollbar->setPageStep(areaSize.height());
1040 vscrollbar->setSingleStep(areaSize.height() / 8);
1042 const pair<int, int> extents = v_extents();
1044 // Don't change the scrollbar range if there are no traces
1045 if (extents.first != extents.second)
1046 vscrollbar->setRange(extents.first - areaSize.height(),
1049 if (scroll_needs_defaults_)
1050 set_scroll_default();
1053 void View::reset_scroll()
1055 scrollarea_->verticalScrollBar()->setRange(0, 0);
1058 void View::set_scroll_default()
1062 const QSize areaSize = viewport_->size();
1064 const pair<int, int> extents = v_extents();
1065 const int trace_height = extents.second - extents.first;
1067 // Do all traces fit in the view?
1068 if (areaSize.height() >= trace_height)
1069 // Center all traces vertically
1070 set_v_offset(extents.first -
1071 ((areaSize.height() - trace_height) / 2));
1073 // Put the first trace at the top, letting the bottom ones overflow
1074 set_v_offset(extents.first);
1077 void View::determine_if_header_was_shrunk()
1079 const int header_pane_width = splitter_->sizes().front();
1080 const int header_width = header_->extended_size_hint().width();
1082 // Allow for a slight margin of error so that we also accept
1083 // slight differences when e.g. a label name change increased
1084 // the overall width
1085 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1088 void View::resize_header_to_fit()
1090 // Setting the maximum width of the header widget doesn't work as
1091 // expected because the splitter would allow the user to make the
1092 // pane wider than that, creating empty space as a result.
1093 // To make this work, we stricly enforce the maximum width by
1094 // expanding the header unless the user shrunk it on purpose.
1095 // As we're then setting the width of the header pane, we set the
1096 // splitter to the maximum allowed position.
1098 int splitter_area_width = 0;
1099 for (int w : splitter_->sizes())
1100 splitter_area_width += w;
1102 // Make sure the header has enough horizontal space to show all labels fully
1103 QList<int> pane_sizes;
1104 pane_sizes.push_back(header_->extended_size_hint().width());
1105 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1106 splitter_->setSizes(pane_sizes);
1109 void View::update_layout()
1114 TraceTreeItemOwner* View::find_prevalent_trace_group(
1115 const shared_ptr<sigrok::ChannelGroup> &group,
1116 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1121 unordered_set<TraceTreeItemOwner*> owners;
1122 vector<TraceTreeItemOwner*> owner_list;
1124 // Make a set and a list of all the owners
1125 for (const auto &channel : group->channels()) {
1126 for (auto entry : signal_map) {
1127 if (entry.first->channel() == channel) {
1128 TraceTreeItemOwner *const o = (entry.second)->owner();
1129 owner_list.push_back(o);
1135 // Iterate through the list of owners, and find the most prevalent
1136 size_t max_prevalence = 0;
1137 TraceTreeItemOwner *prevalent_owner = nullptr;
1138 for (TraceTreeItemOwner *owner : owners) {
1139 const size_t prevalence = count_if(
1140 owner_list.begin(), owner_list.end(),
1141 [&](TraceTreeItemOwner *o) { return o == owner; });
1142 if (prevalence > max_prevalence) {
1143 max_prevalence = prevalence;
1144 prevalent_owner = owner;
1148 return prevalent_owner;
1151 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1152 const vector< shared_ptr<sigrok::Channel> > &channels,
1153 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1155 set< shared_ptr<Trace> > &add_list)
1157 vector< shared_ptr<Trace> > filtered_traces;
1159 for (const auto &channel : channels) {
1160 for (auto entry : signal_map) {
1161 if (entry.first->channel() == channel) {
1162 shared_ptr<Trace> trace = entry.second;
1163 const auto list_iter = add_list.find(trace);
1164 if (list_iter == add_list.end())
1167 filtered_traces.push_back(trace);
1168 add_list.erase(list_iter);
1173 return filtered_traces;
1176 void View::determine_time_unit()
1178 // Check whether we know the sample rate and hence can use time as the unit
1179 if (time_unit_ == util::TimeUnit::Samples) {
1180 // Check all signals but...
1181 for (const shared_ptr<Signal> signal : signals_) {
1182 const shared_ptr<SignalData> data = signal->data();
1184 // ...only check first segment of each
1185 const vector< shared_ptr<Segment> > segments = data->segments();
1186 if (!segments.empty())
1187 if (segments[0]->samplerate()) {
1188 set_time_unit(util::TimeUnit::Time);
1195 bool View::eventFilter(QObject *object, QEvent *event)
1197 const QEvent::Type type = event->type();
1198 if (type == QEvent::MouseMove) {
1200 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1201 if (object == viewport_)
1202 hover_point_ = mouse_event->pos();
1203 else if (object == ruler_)
1204 hover_point_ = QPoint(mouse_event->x(), 0);
1205 else if (object == header_)
1206 hover_point_ = QPoint(0, mouse_event->y());
1208 hover_point_ = QPoint(-1, -1);
1210 update_hover_point();
1212 } else if (type == QEvent::Leave) {
1213 hover_point_ = QPoint(-1, -1);
1214 update_hover_point();
1215 } else if (type == QEvent::Show) {
1217 // This is somewhat of a hack, unfortunately. We cannot use
1218 // set_v_offset() from within restore_settings() as the view
1219 // at that point is neither visible nor properly sized.
1220 // This is the least intrusive workaround I could come up
1221 // with: set the vertical offset (or scroll defaults) when
1222 // the view is shown, which happens after all widgets were
1223 // resized to their final sizes.
1226 if (settings_restored_)
1227 determine_if_header_was_shrunk();
1229 resize_header_to_fit();
1231 if (scroll_needs_defaults_) {
1232 set_scroll_default();
1233 scroll_needs_defaults_ = false;
1236 if (saved_v_offset_) {
1237 set_v_offset(saved_v_offset_);
1238 saved_v_offset_ = 0;
1242 return QObject::eventFilter(object, event);
1245 void View::resizeEvent(QResizeEvent* event)
1247 // Only adjust the top margin if we shrunk vertically
1248 if (event->size().height() < event->oldSize().height())
1249 adjust_top_margin();
1254 void View::update_hover_point()
1256 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1257 list_by_type<TraceTreeItem>());
1258 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1259 r->hover_point_changed(hover_point_);
1261 hover_point_changed(hover_point_);
1264 void View::row_item_appearance_changed(bool label, bool content)
1269 viewport_->update();
1272 void View::time_item_appearance_changed(bool label, bool content)
1277 // Make sure the header pane width is updated, too
1282 viewport_->update();
1285 void View::extents_changed(bool horz, bool vert)
1288 (horz ? TraceTreeItemHExtentsChanged : 0) |
1289 (vert ? TraceTreeItemVExtentsChanged : 0);
1291 lazy_event_handler_.start();
1294 void View::on_signal_name_changed()
1296 if (!header_was_shrunk_)
1297 resize_header_to_fit();
1300 void View::on_splitter_moved()
1302 // The header can only shrink when the splitter is moved manually
1303 determine_if_header_was_shrunk();
1305 if (!header_was_shrunk_)
1306 resize_header_to_fit();
1309 void View::h_scroll_value_changed(int value)
1311 if (updating_scroll_)
1314 // Disable sticky scrolling when user moves the horizontal scroll bar
1315 // during a running acquisition
1316 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1317 sticky_scrolling_ = false;
1318 sticky_scrolling_changed(false);
1321 const int range = scrollarea_->horizontalScrollBar()->maximum();
1322 if (range < MaxScrollValue)
1323 set_offset(scale_ * value);
1327 get_scroll_layout(length, offset);
1328 set_offset(scale_ * length * value / MaxScrollValue);
1332 viewport_->update();
1335 void View::v_scroll_value_changed()
1338 viewport_->update();
1341 void View::signals_changed()
1343 using sigrok::Channel;
1345 vector< shared_ptr<Channel> > channels;
1346 shared_ptr<sigrok::Device> sr_dev;
1347 bool signals_added_or_removed = false;
1349 // Do we need to set the vertical scrollbar to its default position later?
1350 // We do if there are no traces, i.e. the scroll bar has no range set
1351 bool reset_scrollbar =
1352 (scrollarea_->verticalScrollBar()->minimum() ==
1353 scrollarea_->verticalScrollBar()->maximum());
1355 if (!session_.device()) {
1359 sr_dev = session_.device()->device();
1361 channels = sr_dev->channels();
1364 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1366 // Make a list of traces that are being added, and a list of traces
1367 // that are being removed
1368 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1369 const set<shared_ptr<Trace>> prev_traces(
1370 prev_trace_list.begin(), prev_trace_list.end());
1372 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1374 #ifdef ENABLE_DECODE
1375 traces.insert(decode_traces_.begin(), decode_traces_.end());
1378 set< shared_ptr<Trace> > add_traces;
1379 set_difference(traces.begin(), traces.end(),
1380 prev_traces.begin(), prev_traces.end(),
1381 inserter(add_traces, add_traces.begin()));
1383 set< shared_ptr<Trace> > remove_traces;
1384 set_difference(prev_traces.begin(), prev_traces.end(),
1385 traces.begin(), traces.end(),
1386 inserter(remove_traces, remove_traces.begin()));
1388 // Make a look-up table of sigrok Channels to pulseview Signals
1389 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1391 for (const shared_ptr<Signal> &sig : signals_)
1392 signal_map[sig->base()] = sig;
1394 // Populate channel groups
1396 for (auto entry : sr_dev->channel_groups()) {
1397 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1399 if (group->channels().size() <= 1)
1402 // Find best trace group to add to
1403 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1406 // If there is no trace group, create one
1407 shared_ptr<TraceGroup> new_trace_group;
1409 new_trace_group.reset(new TraceGroup());
1410 owner = new_trace_group.get();
1413 // Extract traces for the trace group, removing them from
1415 const vector< shared_ptr<Trace> > new_traces_in_group =
1416 extract_new_traces_for_channels(group->channels(),
1417 signal_map, add_traces);
1419 // Add the traces to the group
1420 const pair<int, int> prev_v_extents = owner->v_extents();
1421 int offset = prev_v_extents.second - prev_v_extents.first;
1422 for (shared_ptr<Trace> trace : new_traces_in_group) {
1424 owner->add_child_item(trace);
1426 const pair<int, int> extents = trace->v_extents();
1427 if (trace->enabled())
1428 offset += -extents.first;
1429 trace->force_to_v_offset(offset);
1430 if (trace->enabled())
1431 offset += extents.second;
1434 if (new_trace_group) {
1435 // Assign proper vertical offsets to each channel in the group
1436 new_trace_group->restack_items();
1438 // If this is a new group, enqueue it in the new top level
1440 if (!new_traces_in_group.empty())
1441 new_top_level_items.push_back(new_trace_group);
1445 // Enqueue the remaining logic channels in a group
1446 vector< shared_ptr<Channel> > logic_channels;
1447 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1448 [](const shared_ptr<Channel>& c) {
1449 return c->type() == sigrok::ChannelType::LOGIC; });
1451 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1452 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1454 if (non_grouped_logic_signals.size() > 0) {
1455 const shared_ptr<TraceGroup> non_grouped_trace_group(
1456 make_shared<TraceGroup>());
1457 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1458 non_grouped_trace_group->add_child_item(trace);
1460 non_grouped_trace_group->restack_items();
1461 new_top_level_items.push_back(non_grouped_trace_group);
1464 // Enqueue the remaining channels as free ungrouped traces
1465 const vector< shared_ptr<Trace> > new_top_level_signals =
1466 extract_new_traces_for_channels(channels, signal_map, add_traces);
1467 new_top_level_items.insert(new_top_level_items.end(),
1468 new_top_level_signals.begin(), new_top_level_signals.end());
1470 // Enqueue any remaining traces i.e. decode traces
1471 new_top_level_items.insert(new_top_level_items.end(),
1472 add_traces.begin(), add_traces.end());
1474 // Remove any removed traces
1475 for (shared_ptr<Trace> trace : remove_traces) {
1476 TraceTreeItemOwner *const owner = trace->owner();
1478 owner->remove_child_item(trace);
1479 signals_added_or_removed = true;
1482 // Remove any empty trace groups
1483 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1484 if (group->child_items().size() == 0) {
1485 remove_child_item(group);
1489 // Add and position the pending top levels items
1490 int offset = v_extents().second;
1491 for (auto item : new_top_level_items) {
1492 add_child_item(item);
1494 // Position the item after the last item or at the top if there is none
1495 const pair<int, int> extents = item->v_extents();
1497 if (item->enabled())
1498 offset += -extents.first;
1500 item->force_to_v_offset(offset);
1502 if (item->enabled())
1503 offset += extents.second;
1504 signals_added_or_removed = true;
1508 if (signals_added_or_removed && !header_was_shrunk_)
1509 resize_header_to_fit();
1514 viewport_->update();
1516 if (reset_scrollbar)
1517 set_scroll_default();
1520 void View::capture_state_updated(int state)
1522 GlobalSettings settings;
1524 if (state == Session::Running) {
1525 set_time_unit(util::TimeUnit::Samples);
1527 trigger_markers_.clear();
1529 scale_at_acq_start_ = scale_;
1530 offset_at_acq_start_ = offset_;
1532 // Activate "always zoom to fit" if the setting is enabled and we're
1533 // the main view of this session (other trace views may be used for
1534 // zooming and we don't want to mess them up)
1535 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1536 if (is_main_view_ && state) {
1537 always_zoom_to_fit_ = true;
1538 always_zoom_to_fit_changed(always_zoom_to_fit_);
1541 // Enable sticky scrolling if the setting is enabled
1542 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1544 // Reset all traces to segment 0
1545 current_segment_ = 0;
1546 set_current_segment(current_segment_);
1549 if (state == Session::Stopped) {
1550 // After acquisition has stopped we need to re-calculate the ticks once
1551 // as it's otherwise done when the user pans or zooms, which is too late
1552 calculate_tick_spacing();
1554 // Reset "always zoom to fit", the acquisition has stopped
1555 if (always_zoom_to_fit_) {
1556 // Perform a final zoom-to-fit before disabling
1557 zoom_fit(always_zoom_to_fit_);
1558 always_zoom_to_fit_ = false;
1559 always_zoom_to_fit_changed(always_zoom_to_fit_);
1562 bool zoom_to_fit_after_acq =
1563 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1565 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1566 // we didn't restore settings in the meanwhile
1567 if (zoom_to_fit_after_acq &&
1568 !suppress_zoom_to_fit_after_acq_ &&
1569 (scale_ == scale_at_acq_start_) &&
1570 (offset_ == offset_at_acq_start_))
1571 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1573 suppress_zoom_to_fit_after_acq_ = false;
1577 void View::on_new_segment(int new_segment_id)
1579 on_segment_changed(new_segment_id);
1582 void View::on_segment_completed(int segment_id)
1584 on_segment_changed(segment_id);
1587 void View::on_segment_changed(int segment)
1589 switch (segment_display_mode_) {
1590 case Trace::ShowLastSegmentOnly:
1591 case Trace::ShowSingleSegmentOnly:
1592 set_current_segment(segment);
1595 case Trace::ShowLastCompleteSegmentOnly:
1596 // Only update if all segments are complete
1597 if (session_.all_segments_complete(segment))
1598 set_current_segment(segment);
1601 case Trace::ShowAllSegments:
1602 case Trace::ShowAccumulatedIntensity:
1608 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1610 if (new_value.toBool()) {
1611 // The first trigger for this segment is used as the zero position
1612 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1613 if (triggers.size() > 0)
1614 set_zero_position(triggers.front());
1616 reset_zero_position();
1619 void View::perform_delayed_view_update()
1621 if (always_zoom_to_fit_) {
1623 } else if (sticky_scrolling_) {
1624 // Make right side of the view sticky
1627 get_scroll_layout(length, offset);
1629 const QSize areaSize = viewport_->size();
1630 length = max(length - areaSize.width(), 0.0);
1632 set_offset(scale_ * length);
1635 determine_time_unit();
1638 viewport_->update();
1641 void View::process_sticky_events()
1643 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1645 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1646 restack_all_trace_tree_items();
1650 // Clear the sticky events
1654 } // namespace trace
1655 } // namespace views