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_);
565 for (shared_ptr<DecodeTrace> dt : decode_traces_)
566 dt->set_current_segment(current_segment_);
568 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
570 trigger_markers_.clear();
571 for (util::Timestamp timestamp : triggers)
572 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
574 // When enabled, the first trigger for this segment is used as the zero position
575 GlobalSettings settings;
576 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
578 if (trigger_is_zero_time && (triggers.size() > 0))
579 set_zero_position(triggers.front());
583 segment_changed(segment_id);
586 bool View::segment_is_selectable() const
588 return segment_selectable_;
591 Trace::SegmentDisplayMode View::segment_display_mode() const
593 return segment_display_mode_;
596 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
598 trigger_markers_.clear();
600 segment_display_mode_ = mode;
602 for (shared_ptr<Signal> signal : signals_)
603 signal->set_segment_display_mode(mode);
605 uint32_t last_segment = session_.get_segment_count() - 1;
608 case Trace::ShowLastSegmentOnly:
609 if (current_segment_ != last_segment)
610 set_current_segment(last_segment);
613 case Trace::ShowLastCompleteSegmentOnly:
614 // Do nothing if we only have one segment so far
615 if (last_segment > 0) {
616 // If the last segment isn't complete, the previous one must be
617 uint32_t segment_id =
618 (session_.all_segments_complete(last_segment)) ?
619 last_segment : last_segment - 1;
621 if (current_segment_ != segment_id)
622 set_current_segment(segment_id);
626 case Trace::ShowSingleSegmentOnly:
627 case Trace::ShowAllSegments:
628 case Trace::ShowAccumulatedIntensity:
630 // Current segment remains as-is
634 segment_selectable_ = true;
636 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
637 segment_selectable_ = false;
641 segment_display_mode_changed((int)mode, segment_selectable_);
644 void View::zoom(double steps)
646 zoom(steps, viewport_->width() / 2);
649 void View::zoom(double steps, int offset)
651 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
654 void View::zoom_fit(bool gui_state)
656 // Act as one-shot when stopped, toggle along with the GUI otherwise
657 if (session_.get_capture_state() == Session::Stopped) {
658 always_zoom_to_fit_ = false;
659 always_zoom_to_fit_changed(false);
661 always_zoom_to_fit_ = gui_state;
662 always_zoom_to_fit_changed(gui_state);
665 const pair<Timestamp, Timestamp> extents = get_time_extents();
666 const Timestamp delta = extents.second - extents.first;
667 if (delta < Timestamp("1e-12"))
671 const int w = viewport_->width();
675 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
676 set_scale_offset(scale.convert_to<double>(), extents.first);
679 void View::zoom_one_to_one()
681 using pv::data::SignalData;
683 // Make a set of all the visible data objects
684 set< shared_ptr<SignalData> > visible_data = get_visible_data();
685 if (visible_data.empty())
689 const int w = viewport_->width();
693 set_zoom(1.0 / session_.get_samplerate(), w / 2);
696 void View::set_scale_offset(double scale, const Timestamp& offset)
698 // Disable sticky scrolling / always zoom to fit when acquisition runs
699 // and user drags the viewport
700 if ((scale_ == scale) && (offset_ != offset) &&
701 (session_.get_capture_state() == Session::Running)) {
703 if (sticky_scrolling_) {
704 sticky_scrolling_ = false;
705 sticky_scrolling_changed(false);
708 if (always_zoom_to_fit_) {
709 always_zoom_to_fit_ = false;
710 always_zoom_to_fit_changed(false);
717 calculate_tick_spacing();
724 set< shared_ptr<SignalData> > View::get_visible_data() const
726 // Make a set of all the visible data objects
727 set< shared_ptr<SignalData> > visible_data;
728 for (const shared_ptr<Signal> sig : signals_)
730 visible_data.insert(sig->data());
735 pair<Timestamp, Timestamp> View::get_time_extents() const
737 boost::optional<Timestamp> left_time, right_time;
738 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
739 for (const shared_ptr<SignalData> d : visible_data) {
740 const vector< shared_ptr<Segment> > segments = d->segments();
741 for (const shared_ptr<Segment> &s : segments) {
742 double samplerate = s->samplerate();
743 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
745 const Timestamp start_time = s->start_time();
746 left_time = left_time ?
747 min(*left_time, start_time) :
749 right_time = right_time ?
750 max(*right_time, start_time + d->max_sample_count() / samplerate) :
751 start_time + d->max_sample_count() / samplerate;
755 if (!left_time || !right_time)
756 return make_pair(0, 0);
758 assert(*left_time < *right_time);
759 return make_pair(*left_time, *right_time);
762 void View::enable_show_sampling_points(bool state)
769 void View::enable_show_analog_minor_grid(bool state)
776 void View::enable_coloured_bg(bool state)
778 coloured_bg_ = state;
782 bool View::coloured_bg() const
787 bool View::cursors_shown() const
789 return show_cursors_;
792 void View::show_cursors(bool show)
794 show_cursors_ = show;
799 void View::centre_cursors()
801 const double time_width = scale_ * viewport_->width();
802 cursors_->first()->set_time(offset_ + time_width * 0.4);
803 cursors_->second()->set_time(offset_ + time_width * 0.6);
808 shared_ptr<CursorPair> View::cursors() const
813 void View::add_flag(const Timestamp& time)
815 flags_.push_back(make_shared<Flag>(*this, time,
816 QString("%1").arg(next_flag_text_)));
818 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
819 (next_flag_text_ + 1);
821 time_item_appearance_changed(true, true);
824 void View::remove_flag(shared_ptr<Flag> flag)
827 time_item_appearance_changed(true, true);
830 vector< shared_ptr<Flag> > View::flags() const
832 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
833 stable_sort(flags.begin(), flags.end(),
834 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
835 return a->time() < b->time();
841 const QPoint& View::hover_point() const
846 void View::restack_all_trace_tree_items()
848 // Make a list of owners that is sorted from deepest first
849 const vector<shared_ptr<TraceTreeItem>> items(
850 list_by_type<TraceTreeItem>());
851 set< TraceTreeItemOwner* > owners;
852 for (const auto &r : items)
853 owners.insert(r->owner());
854 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
855 sort(sorted_owners.begin(), sorted_owners.end(),
856 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
857 return a->depth() > b->depth(); });
859 // Restack the items recursively
860 for (auto &o : sorted_owners)
863 // Animate the items to their destination
864 for (const auto &i : items)
865 i->animate_to_layout_v_offset();
868 void View::on_setting_changed(const QString &key, const QVariant &value)
870 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
871 on_settingViewTriggerIsZeroTime_changed(value);
874 void View::trigger_event(int segment_id, util::Timestamp location)
876 // TODO This doesn't work if we're showing multiple segments at once
877 if ((uint32_t)segment_id != current_segment_)
880 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
881 // if this is the first trigger for this segment.
882 GlobalSettings settings;
883 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
885 size_t trigger_count = session_.get_triggers(current_segment_).size();
887 if (trigger_is_zero_time && trigger_count == 1)
888 set_zero_position(location);
890 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
893 void View::get_scroll_layout(double &length, Timestamp &offset) const
895 const pair<Timestamp, Timestamp> extents = get_time_extents();
896 length = ((extents.second - extents.first) / scale_).convert_to<double>();
897 offset = offset_ / scale_;
900 void View::set_zoom(double scale, int offset)
902 // Reset the "always zoom to fit" feature as the user changed the zoom
903 always_zoom_to_fit_ = false;
904 always_zoom_to_fit_changed(false);
906 const Timestamp cursor_offset = offset_ + scale_ * offset;
907 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
908 const Timestamp new_offset = cursor_offset - new_scale * offset;
909 set_scale_offset(new_scale.convert_to<double>(), new_offset);
912 void View::calculate_tick_spacing()
914 const double SpacingIncrement = 10.0f;
915 const double MinValueSpacing = 40.0f;
917 // Figure out the highest numeric value visible on a label
918 const QSize areaSize = viewport_->size();
919 const Timestamp max_time = max(fabs(offset_),
920 fabs(offset_ + scale_ * areaSize.width()));
922 double min_width = SpacingIncrement;
923 double label_width, tick_period_width;
925 QFontMetrics m(QApplication::font());
927 // Copies of the member variables with the same name, used in the calculation
928 // and written back afterwards, so that we don't emit signals all the time
929 // during the calculation.
930 pv::util::Timestamp tick_period = tick_period_;
931 pv::util::SIPrefix tick_prefix = tick_prefix_;
932 unsigned tick_precision = tick_precision_;
935 const double min_period = scale_ * min_width;
937 const int order = (int)floorf(log10f(min_period));
938 const pv::util::Timestamp order_decimal =
939 pow(pv::util::Timestamp(10), order);
941 // Allow for a margin of error so that a scale unit of 1 can be used.
942 // Otherwise, for a SU of 1 the tick period will almost always be below
943 // the min_period by a small amount - and thus skipped in favor of 2.
944 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
945 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
946 double tp_with_margin;
947 unsigned int unit = 0;
950 tp_with_margin = order_decimal.convert_to<double>() *
951 (ScaleUnits[unit++] + tp_margin);
952 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
954 minor_tick_count_ = (unit == 2) ? (4) : (5);
955 tick_period = order_decimal * ScaleUnits[unit - 1];
956 tick_prefix = static_cast<pv::util::SIPrefix>(
957 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
959 // Precision is the number of fractional digits required, not
960 // taking the prefix into account (and it must never be negative)
961 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
963 tick_period_width = (tick_period / scale_).convert_to<double>();
965 const QString label_text = Ruler::format_time_with_distance(
966 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
968 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
969 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
972 min_width += SpacingIncrement;
973 } while (tick_period_width < label_width);
975 set_tick_period(tick_period);
976 set_tick_prefix(tick_prefix);
977 set_tick_precision(tick_precision);
980 void View::adjust_top_margin()
984 const QSize areaSize = viewport_->size();
986 const pair<int, int> extents = v_extents();
987 const int top_margin = owner_visual_v_offset() + extents.first;
988 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
990 // Do we have empty space at the top while the last trace goes out of screen?
991 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
992 const int trace_height = extents.second - extents.first;
994 // Center everything vertically if there is enough space
995 if (areaSize.height() >= trace_height)
996 set_v_offset(extents.first -
997 ((areaSize.height() - trace_height) / 2));
999 // Remove the top margin to make as many traces fit on screen as possible
1000 set_v_offset(extents.first);
1004 void View::update_scroll()
1007 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1008 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1010 const QSize areaSize = viewport_->size();
1012 // Set the horizontal scroll bar
1015 get_scroll_layout(length, offset);
1016 length = max(length - areaSize.width(), 0.0);
1018 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1020 hscrollbar->setPageStep(areaSize.width() / 2);
1021 hscrollbar->setSingleStep(major_tick_distance);
1023 updating_scroll_ = true;
1025 if (length < MaxScrollValue) {
1026 hscrollbar->setRange(0, length);
1027 hscrollbar->setSliderPosition(offset.convert_to<double>());
1029 hscrollbar->setRange(0, MaxScrollValue);
1030 hscrollbar->setSliderPosition(
1031 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1034 updating_scroll_ = false;
1036 // Set the vertical scrollbar
1037 vscrollbar->setPageStep(areaSize.height());
1038 vscrollbar->setSingleStep(areaSize.height() / 8);
1040 const pair<int, int> extents = v_extents();
1042 // Don't change the scrollbar range if there are no traces
1043 if (extents.first != extents.second)
1044 vscrollbar->setRange(extents.first - areaSize.height(),
1047 if (scroll_needs_defaults_)
1048 set_scroll_default();
1051 void View::reset_scroll()
1053 scrollarea_->verticalScrollBar()->setRange(0, 0);
1056 void View::set_scroll_default()
1060 const QSize areaSize = viewport_->size();
1062 const pair<int, int> extents = v_extents();
1063 const int trace_height = extents.second - extents.first;
1065 // Do all traces fit in the view?
1066 if (areaSize.height() >= trace_height)
1067 // Center all traces vertically
1068 set_v_offset(extents.first -
1069 ((areaSize.height() - trace_height) / 2));
1071 // Put the first trace at the top, letting the bottom ones overflow
1072 set_v_offset(extents.first);
1075 void View::determine_if_header_was_shrunk()
1077 const int header_pane_width = splitter_->sizes().front();
1078 const int header_width = header_->extended_size_hint().width();
1080 // Allow for a slight margin of error so that we also accept
1081 // slight differences when e.g. a label name change increased
1082 // the overall width
1083 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1086 void View::resize_header_to_fit()
1088 // Setting the maximum width of the header widget doesn't work as
1089 // expected because the splitter would allow the user to make the
1090 // pane wider than that, creating empty space as a result.
1091 // To make this work, we stricly enforce the maximum width by
1092 // expanding the header unless the user shrunk it on purpose.
1093 // As we're then setting the width of the header pane, we set the
1094 // splitter to the maximum allowed position.
1096 int splitter_area_width = 0;
1097 for (int w : splitter_->sizes())
1098 splitter_area_width += w;
1100 // Make sure the header has enough horizontal space to show all labels fully
1101 QList<int> pane_sizes;
1102 pane_sizes.push_back(header_->extended_size_hint().width());
1103 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1104 splitter_->setSizes(pane_sizes);
1107 void View::update_layout()
1112 TraceTreeItemOwner* View::find_prevalent_trace_group(
1113 const shared_ptr<sigrok::ChannelGroup> &group,
1114 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1119 unordered_set<TraceTreeItemOwner*> owners;
1120 vector<TraceTreeItemOwner*> owner_list;
1122 // Make a set and a list of all the owners
1123 for (const auto &channel : group->channels()) {
1124 for (auto entry : signal_map) {
1125 if (entry.first->channel() == channel) {
1126 TraceTreeItemOwner *const o = (entry.second)->owner();
1127 owner_list.push_back(o);
1133 // Iterate through the list of owners, and find the most prevalent
1134 size_t max_prevalence = 0;
1135 TraceTreeItemOwner *prevalent_owner = nullptr;
1136 for (TraceTreeItemOwner *owner : owners) {
1137 const size_t prevalence = count_if(
1138 owner_list.begin(), owner_list.end(),
1139 [&](TraceTreeItemOwner *o) { return o == owner; });
1140 if (prevalence > max_prevalence) {
1141 max_prevalence = prevalence;
1142 prevalent_owner = owner;
1146 return prevalent_owner;
1149 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1150 const vector< shared_ptr<sigrok::Channel> > &channels,
1151 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1153 set< shared_ptr<Trace> > &add_list)
1155 vector< shared_ptr<Trace> > filtered_traces;
1157 for (const auto &channel : channels) {
1158 for (auto entry : signal_map) {
1159 if (entry.first->channel() == channel) {
1160 shared_ptr<Trace> trace = entry.second;
1161 const auto list_iter = add_list.find(trace);
1162 if (list_iter == add_list.end())
1165 filtered_traces.push_back(trace);
1166 add_list.erase(list_iter);
1171 return filtered_traces;
1174 void View::determine_time_unit()
1176 // Check whether we know the sample rate and hence can use time as the unit
1177 if (time_unit_ == util::TimeUnit::Samples) {
1178 // Check all signals but...
1179 for (const shared_ptr<Signal> signal : signals_) {
1180 const shared_ptr<SignalData> data = signal->data();
1182 // ...only check first segment of each
1183 const vector< shared_ptr<Segment> > segments = data->segments();
1184 if (!segments.empty())
1185 if (segments[0]->samplerate()) {
1186 set_time_unit(util::TimeUnit::Time);
1193 bool View::eventFilter(QObject *object, QEvent *event)
1195 const QEvent::Type type = event->type();
1196 if (type == QEvent::MouseMove) {
1198 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1199 if (object == viewport_)
1200 hover_point_ = mouse_event->pos();
1201 else if (object == ruler_)
1202 hover_point_ = QPoint(mouse_event->x(), 0);
1203 else if (object == header_)
1204 hover_point_ = QPoint(0, mouse_event->y());
1206 hover_point_ = QPoint(-1, -1);
1208 update_hover_point();
1210 } else if (type == QEvent::Leave) {
1211 hover_point_ = QPoint(-1, -1);
1212 update_hover_point();
1213 } else if (type == QEvent::Show) {
1215 // This is somewhat of a hack, unfortunately. We cannot use
1216 // set_v_offset() from within restore_settings() as the view
1217 // at that point is neither visible nor properly sized.
1218 // This is the least intrusive workaround I could come up
1219 // with: set the vertical offset (or scroll defaults) when
1220 // the view is shown, which happens after all widgets were
1221 // resized to their final sizes.
1224 if (settings_restored_)
1225 determine_if_header_was_shrunk();
1227 resize_header_to_fit();
1229 if (scroll_needs_defaults_) {
1230 set_scroll_default();
1231 scroll_needs_defaults_ = false;
1234 if (saved_v_offset_) {
1235 set_v_offset(saved_v_offset_);
1236 saved_v_offset_ = 0;
1240 return QObject::eventFilter(object, event);
1243 void View::resizeEvent(QResizeEvent* event)
1245 // Only adjust the top margin if we shrunk vertically
1246 if (event->size().height() < event->oldSize().height())
1247 adjust_top_margin();
1252 void View::update_hover_point()
1254 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1255 list_by_type<TraceTreeItem>());
1256 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1257 r->hover_point_changed(hover_point_);
1259 hover_point_changed(hover_point_);
1262 void View::row_item_appearance_changed(bool label, bool content)
1267 viewport_->update();
1270 void View::time_item_appearance_changed(bool label, bool content)
1275 // Make sure the header pane width is updated, too
1280 viewport_->update();
1283 void View::extents_changed(bool horz, bool vert)
1286 (horz ? TraceTreeItemHExtentsChanged : 0) |
1287 (vert ? TraceTreeItemVExtentsChanged : 0);
1289 lazy_event_handler_.start();
1292 void View::on_signal_name_changed()
1294 if (!header_was_shrunk_)
1295 resize_header_to_fit();
1298 void View::on_splitter_moved()
1300 // The header can only shrink when the splitter is moved manually
1301 determine_if_header_was_shrunk();
1303 if (!header_was_shrunk_)
1304 resize_header_to_fit();
1307 void View::h_scroll_value_changed(int value)
1309 if (updating_scroll_)
1312 // Disable sticky scrolling when user moves the horizontal scroll bar
1313 // during a running acquisition
1314 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1315 sticky_scrolling_ = false;
1316 sticky_scrolling_changed(false);
1319 const int range = scrollarea_->horizontalScrollBar()->maximum();
1320 if (range < MaxScrollValue)
1321 set_offset(scale_ * value);
1325 get_scroll_layout(length, offset);
1326 set_offset(scale_ * length * value / MaxScrollValue);
1330 viewport_->update();
1333 void View::v_scroll_value_changed()
1336 viewport_->update();
1339 void View::signals_changed()
1341 using sigrok::Channel;
1343 vector< shared_ptr<Channel> > channels;
1344 shared_ptr<sigrok::Device> sr_dev;
1345 bool signals_added_or_removed = false;
1347 // Do we need to set the vertical scrollbar to its default position later?
1348 // We do if there are no traces, i.e. the scroll bar has no range set
1349 bool reset_scrollbar =
1350 (scrollarea_->verticalScrollBar()->minimum() ==
1351 scrollarea_->verticalScrollBar()->maximum());
1353 if (!session_.device()) {
1357 sr_dev = session_.device()->device();
1359 channels = sr_dev->channels();
1362 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1364 // Make a list of traces that are being added, and a list of traces
1365 // that are being removed
1366 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1367 const set<shared_ptr<Trace>> prev_traces(
1368 prev_trace_list.begin(), prev_trace_list.end());
1370 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1372 #ifdef ENABLE_DECODE
1373 traces.insert(decode_traces_.begin(), decode_traces_.end());
1376 set< shared_ptr<Trace> > add_traces;
1377 set_difference(traces.begin(), traces.end(),
1378 prev_traces.begin(), prev_traces.end(),
1379 inserter(add_traces, add_traces.begin()));
1381 set< shared_ptr<Trace> > remove_traces;
1382 set_difference(prev_traces.begin(), prev_traces.end(),
1383 traces.begin(), traces.end(),
1384 inserter(remove_traces, remove_traces.begin()));
1386 // Make a look-up table of sigrok Channels to pulseview Signals
1387 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1389 for (const shared_ptr<Signal> &sig : signals_)
1390 signal_map[sig->base()] = sig;
1392 // Populate channel groups
1394 for (auto entry : sr_dev->channel_groups()) {
1395 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1397 if (group->channels().size() <= 1)
1400 // Find best trace group to add to
1401 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1404 // If there is no trace group, create one
1405 shared_ptr<TraceGroup> new_trace_group;
1407 new_trace_group.reset(new TraceGroup());
1408 owner = new_trace_group.get();
1411 // Extract traces for the trace group, removing them from
1413 const vector< shared_ptr<Trace> > new_traces_in_group =
1414 extract_new_traces_for_channels(group->channels(),
1415 signal_map, add_traces);
1417 // Add the traces to the group
1418 const pair<int, int> prev_v_extents = owner->v_extents();
1419 int offset = prev_v_extents.second - prev_v_extents.first;
1420 for (shared_ptr<Trace> trace : new_traces_in_group) {
1422 owner->add_child_item(trace);
1424 const pair<int, int> extents = trace->v_extents();
1425 if (trace->enabled())
1426 offset += -extents.first;
1427 trace->force_to_v_offset(offset);
1428 if (trace->enabled())
1429 offset += extents.second;
1432 if (new_trace_group) {
1433 // Assign proper vertical offsets to each channel in the group
1434 new_trace_group->restack_items();
1436 // If this is a new group, enqueue it in the new top level
1438 if (!new_traces_in_group.empty())
1439 new_top_level_items.push_back(new_trace_group);
1443 // Enqueue the remaining logic channels in a group
1444 vector< shared_ptr<Channel> > logic_channels;
1445 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1446 [](const shared_ptr<Channel>& c) {
1447 return c->type() == sigrok::ChannelType::LOGIC; });
1449 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1450 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1452 if (non_grouped_logic_signals.size() > 0) {
1453 const shared_ptr<TraceGroup> non_grouped_trace_group(
1454 make_shared<TraceGroup>());
1455 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1456 non_grouped_trace_group->add_child_item(trace);
1458 non_grouped_trace_group->restack_items();
1459 new_top_level_items.push_back(non_grouped_trace_group);
1462 // Enqueue the remaining channels as free ungrouped traces
1463 const vector< shared_ptr<Trace> > new_top_level_signals =
1464 extract_new_traces_for_channels(channels, signal_map, add_traces);
1465 new_top_level_items.insert(new_top_level_items.end(),
1466 new_top_level_signals.begin(), new_top_level_signals.end());
1468 // Enqueue any remaining traces i.e. decode traces
1469 new_top_level_items.insert(new_top_level_items.end(),
1470 add_traces.begin(), add_traces.end());
1472 // Remove any removed traces
1473 for (shared_ptr<Trace> trace : remove_traces) {
1474 TraceTreeItemOwner *const owner = trace->owner();
1476 owner->remove_child_item(trace);
1477 signals_added_or_removed = true;
1480 // Remove any empty trace groups
1481 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1482 if (group->child_items().size() == 0) {
1483 remove_child_item(group);
1487 // Add and position the pending top levels items
1488 int offset = v_extents().second;
1489 for (auto item : new_top_level_items) {
1490 add_child_item(item);
1492 // Position the item after the last item or at the top if there is none
1493 const pair<int, int> extents = item->v_extents();
1495 if (item->enabled())
1496 offset += -extents.first;
1498 item->force_to_v_offset(offset);
1500 if (item->enabled())
1501 offset += extents.second;
1502 signals_added_or_removed = true;
1506 if (signals_added_or_removed && !header_was_shrunk_)
1507 resize_header_to_fit();
1512 viewport_->update();
1514 if (reset_scrollbar)
1515 set_scroll_default();
1518 void View::capture_state_updated(int state)
1520 GlobalSettings settings;
1522 if (state == Session::Running) {
1523 set_time_unit(util::TimeUnit::Samples);
1525 trigger_markers_.clear();
1527 scale_at_acq_start_ = scale_;
1528 offset_at_acq_start_ = offset_;
1530 // Activate "always zoom to fit" if the setting is enabled and we're
1531 // the main view of this session (other trace views may be used for
1532 // zooming and we don't want to mess them up)
1533 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1534 if (is_main_view_ && state) {
1535 always_zoom_to_fit_ = true;
1536 always_zoom_to_fit_changed(always_zoom_to_fit_);
1539 // Enable sticky scrolling if the setting is enabled
1540 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1542 // Reset all traces to segment 0
1543 current_segment_ = 0;
1544 set_current_segment(current_segment_);
1547 if (state == Session::Stopped) {
1548 // After acquisition has stopped we need to re-calculate the ticks once
1549 // as it's otherwise done when the user pans or zooms, which is too late
1550 calculate_tick_spacing();
1552 // Reset "always zoom to fit", the acquisition has stopped
1553 if (always_zoom_to_fit_) {
1554 // Perform a final zoom-to-fit before disabling
1555 zoom_fit(always_zoom_to_fit_);
1556 always_zoom_to_fit_ = false;
1557 always_zoom_to_fit_changed(always_zoom_to_fit_);
1560 bool zoom_to_fit_after_acq =
1561 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1563 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1564 // we didn't restore settings in the meanwhile
1565 if (zoom_to_fit_after_acq &&
1566 !suppress_zoom_to_fit_after_acq_ &&
1567 (scale_ == scale_at_acq_start_) &&
1568 (offset_ == offset_at_acq_start_))
1569 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1571 suppress_zoom_to_fit_after_acq_ = false;
1575 void View::on_new_segment(int new_segment_id)
1577 on_segment_changed(new_segment_id);
1580 void View::on_segment_completed(int segment_id)
1582 on_segment_changed(segment_id);
1585 void View::on_segment_changed(int segment)
1587 switch (segment_display_mode_) {
1588 case Trace::ShowLastSegmentOnly:
1589 case Trace::ShowSingleSegmentOnly:
1590 set_current_segment(segment);
1593 case Trace::ShowLastCompleteSegmentOnly:
1594 // Only update if all segments are complete
1595 if (session_.all_segments_complete(segment))
1596 set_current_segment(segment);
1599 case Trace::ShowAllSegments:
1600 case Trace::ShowAccumulatedIntensity:
1606 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1608 if (new_value.toBool()) {
1609 // The first trigger for this segment is used as the zero position
1610 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1611 if (triggers.size() > 0)
1612 set_zero_position(triggers.front());
1614 reset_zero_position();
1617 void View::perform_delayed_view_update()
1619 if (always_zoom_to_fit_) {
1621 } else if (sticky_scrolling_) {
1622 // Make right side of the view sticky
1625 get_scroll_layout(length, offset);
1627 const QSize areaSize = viewport_->size();
1628 length = max(length - areaSize.width(), 0.0);
1630 set_offset(scale_ * length);
1633 determine_time_unit();
1636 viewport_->update();
1639 void View::process_sticky_events()
1641 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1643 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1644 restack_all_trace_tree_items();
1648 // Clear the sticky events
1652 } // namespace trace
1653 } // namespace views