2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include <libsigrokdecode/libsigrokdecode.h>
32 #include <unordered_set>
34 #include <boost/archive/text_iarchive.hpp>
35 #include <boost/archive/text_oarchive.hpp>
36 #include <boost/serialization/serialization.hpp>
38 #include <QApplication>
40 #include <QFontMetrics>
41 #include <QMouseEvent>
43 #include <QVBoxLayout>
45 #include <libsigrokcxx/libsigrokcxx.hpp>
47 #include "analogsignal.hpp"
49 #include "logicsignal.hpp"
52 #include "tracegroup.hpp"
53 #include "triggermarker.hpp"
55 #include "viewport.hpp"
57 #include "pv/data/logic.hpp"
58 #include "pv/data/logicsegment.hpp"
59 #include "pv/devices/device.hpp"
60 #include "pv/globalsettings.hpp"
61 #include "pv/session.hpp"
62 #include "pv/util.hpp"
65 #include "decodetrace.hpp"
68 using pv::data::SignalData;
69 using pv::data::Segment;
70 using pv::util::TimeUnit;
71 using pv::util::Timestamp;
73 using std::back_inserter;
79 using std::make_shared;
83 using std::set_difference;
84 using std::shared_ptr;
85 using std::stringstream;
86 using std::unordered_map;
87 using std::unordered_set;
94 const Timestamp View::MaxScale("1e9");
95 const Timestamp View::MinScale("1e-12");
97 const int View::MaxScrollValue = INT_MAX / 2;
99 const int View::ScaleUnits[3] = {1, 2, 5};
102 CustomScrollArea::CustomScrollArea(QWidget *parent) :
103 QAbstractScrollArea(parent)
107 bool CustomScrollArea::viewportEvent(QEvent *event)
109 switch (event->type()) {
111 case QEvent::MouseButtonPress:
112 case QEvent::MouseButtonRelease:
113 case QEvent::MouseButtonDblClick:
114 case QEvent::MouseMove:
116 case QEvent::TouchBegin:
117 case QEvent::TouchUpdate:
118 case QEvent::TouchEnd:
121 return QAbstractScrollArea::viewportEvent(event);
125 View::View(Session &session, bool is_main_view, QWidget *parent) :
126 ViewBase(session, is_main_view, parent),
128 // Note: Place defaults in View::reset_view_state(), not here
129 splitter_(new QSplitter()),
130 header_was_shrunk_(false), // The splitter remains unchanged after a reset, so this goes here
131 sticky_scrolling_(false) // Default setting is set in MainWindow::setup_ui()
133 QVBoxLayout *root_layout = new QVBoxLayout(this);
134 root_layout->setContentsMargins(0, 0, 0, 0);
135 root_layout->addWidget(splitter_);
137 viewport_ = new Viewport(*this);
138 scrollarea_ = new CustomScrollArea(splitter_);
139 scrollarea_->setViewport(viewport_);
140 scrollarea_->setFrameShape(QFrame::NoFrame);
142 ruler_ = new Ruler(*this);
144 header_ = new Header(*this);
145 header_->setMinimumWidth(10); // So that the arrow tips show at least
147 // We put the header into a simple layout so that we can add the top margin,
148 // allowing us to make it line up with the bottom of the ruler
149 QWidget *header_container = new QWidget();
150 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
151 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
152 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
153 header_layout->addWidget(header_);
155 // To let the ruler and scrollarea be on the same split pane, we need a layout
156 QWidget *trace_container = new QWidget();
157 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
158 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
159 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
160 trace_layout->setContentsMargins(0, 0, 0, 0);
161 trace_layout->addWidget(ruler_);
162 trace_layout->addWidget(scrollarea_);
164 splitter_->addWidget(header_container);
165 splitter_->addWidget(trace_container);
166 splitter_->setHandleWidth(1); // Don't show a visible rubber band
167 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
168 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
169 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
170 splitter_->setStretchFactor(1, 1); // when the entire view is resized
171 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
173 viewport_->installEventFilter(this);
174 ruler_->installEventFilter(this);
175 header_->installEventFilter(this);
177 // Set up settings and event handlers
178 GlobalSettings settings;
179 colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
181 GlobalSettings::add_change_handler(this);
183 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
184 this, SLOT(h_scroll_value_changed(int)));
185 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
186 this, SLOT(v_scroll_value_changed()));
188 connect(header_, SIGNAL(selection_changed()),
189 ruler_, SLOT(clear_selection()));
190 connect(ruler_, SIGNAL(selection_changed()),
191 header_, SLOT(clear_selection()));
193 connect(header_, SIGNAL(selection_changed()),
194 this, SIGNAL(selection_changed()));
195 connect(ruler_, SIGNAL(selection_changed()),
196 this, SIGNAL(selection_changed()));
198 connect(splitter_, SIGNAL(splitterMoved(int, int)),
199 this, SLOT(on_splitter_moved()));
201 connect(&lazy_event_handler_, SIGNAL(timeout()),
202 this, SLOT(process_sticky_events()));
203 lazy_event_handler_.setSingleShot(true);
205 // Trigger the initial event manually. The default device has signals
206 // which were created before this object came into being
209 // make sure the transparent widgets are on the top
218 GlobalSettings::remove_change_handler(this);
221 void View::reset_view_state()
223 ViewBase::reset_view_state();
225 segment_display_mode_ = Trace::ShowLastSegmentOnly;
226 segment_selectable_ = false;
230 updating_scroll_ = false;
231 settings_restored_ = false;
232 always_zoom_to_fit_ = false;
234 tick_prefix_ = pv::util::SIPrefix::yocto;
236 time_unit_ = util::TimeUnit::Time;
237 show_cursors_ = false;
238 cursors_ = make_shared<CursorPair>(*this);
239 next_flag_text_ = 'A';
240 trigger_markers_.clear();
241 hover_point_ = QPoint(-1, -1);
242 scroll_needs_defaults_ = true;
244 scale_at_acq_start_ = 0;
245 offset_at_acq_start_ = 0;
246 suppress_zoom_to_fit_after_acq_ = false;
248 show_cursors_ = false;
249 cursor_state_changed(show_cursors_);
252 // Update the zoom state
253 calculate_tick_spacing();
255 // Make sure the standard bar's segment selector is in sync
256 set_segment_display_mode(segment_display_mode_);
259 Session& View::session()
264 const Session& View::session() const
269 unordered_set< shared_ptr<Signal> > View::signals() const
274 void View::clear_signals()
276 ViewBase::clear_signalbases();
280 void View::add_signal(const shared_ptr<Signal> signal)
282 ViewBase::add_signalbase(signal->base());
283 signals_.insert(signal);
285 signal->set_segment_display_mode(segment_display_mode_);
286 signal->set_current_segment(current_segment_);
288 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
289 this, SLOT(on_signal_name_changed()));
293 void View::clear_decode_signals()
295 decode_traces_.clear();
298 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
300 shared_ptr<DecodeTrace> d(
301 new DecodeTrace(session_, signal, decode_traces_.size()));
302 decode_traces_.push_back(d);
304 d->set_segment_display_mode(segment_display_mode_);
305 d->set_current_segment(current_segment_);
307 connect(signal.get(), SIGNAL(name_changed(const QString&)),
308 this, SLOT(on_signal_name_changed()));
311 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
313 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
314 if ((*i)->base() == signal) {
315 decode_traces_.erase(i);
327 const View* View::view() const
332 Viewport* View::viewport()
337 const Viewport* View::viewport() const
342 void View::save_settings(QSettings &settings) const
344 settings.setValue("scale", scale_);
345 settings.setValue("v_offset",
346 scrollarea_->verticalScrollBar()->sliderPosition());
348 settings.setValue("splitter_state", splitter_->saveState());
349 settings.setValue("segment_display_mode", segment_display_mode_);
353 boost::archive::text_oarchive oa(ss);
354 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
355 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
359 boost::archive::text_oarchive oa(ss);
360 oa << boost::serialization::make_nvp("offset", offset_);
361 settings.setValue("offset", QString::fromStdString(ss.str()));
364 for (shared_ptr<Signal> signal : signals_) {
365 settings.beginGroup(signal->base()->internal_name());
366 signal->save_settings(settings);
371 void View::restore_settings(QSettings &settings)
373 // Note: It is assumed that this function is only called once,
374 // immediately after restoring a previous session.
376 if (settings.contains("scale"))
377 set_scale(settings.value("scale").toDouble());
379 if (settings.contains("ruler_shift")) {
380 util::Timestamp shift;
382 ss << settings.value("ruler_shift").toString().toStdString();
385 boost::archive::text_iarchive ia(ss);
386 ia >> boost::serialization::make_nvp("ruler_shift", shift);
387 ruler_shift_ = shift;
388 } catch (boost::archive::archive_exception) {
389 qDebug() << "Could not restore the view ruler shift";
393 if (settings.contains("offset")) {
394 util::Timestamp offset;
396 ss << settings.value("offset").toString().toStdString();
399 boost::archive::text_iarchive ia(ss);
400 ia >> boost::serialization::make_nvp("offset", offset);
401 // This also updates ruler_offset_
403 } catch (boost::archive::archive_exception) {
404 qDebug() << "Could not restore the view offset";
408 if (settings.contains("splitter_state"))
409 splitter_->restoreState(settings.value("splitter_state").toByteArray());
411 if (settings.contains("segment_display_mode"))
412 set_segment_display_mode(
413 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
415 for (shared_ptr<Signal> signal : signals_) {
416 settings.beginGroup(signal->base()->internal_name());
417 signal->restore_settings(settings);
421 if (settings.contains("v_offset")) {
422 saved_v_offset_ = settings.value("v_offset").toInt();
423 set_v_offset(saved_v_offset_);
424 scroll_needs_defaults_ = false;
425 // Note: see eventFilter() for additional information
428 settings_restored_ = true;
429 suppress_zoom_to_fit_after_acq_ = true;
431 // Update the ruler so that it uses the new scale
432 calculate_tick_spacing();
435 vector< shared_ptr<TimeItem> > View::time_items() const
437 const vector<shared_ptr<Flag>> f(flags());
438 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
441 items.push_back(cursors_);
442 items.push_back(cursors_->first());
443 items.push_back(cursors_->second());
446 for (auto trigger_marker : trigger_markers_)
447 items.push_back(trigger_marker);
452 double View::scale() const
457 void View::set_scale(double scale)
459 if (scale_ != scale) {
465 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
467 if ((offset_ != offset) || force_update) {
469 ruler_offset_ = offset_ + ruler_shift_;
474 const Timestamp& View::offset() const
479 const Timestamp& View::ruler_offset() const
481 return ruler_offset_;
484 void View::set_zero_position(pv::util::Timestamp& position)
486 ruler_shift_ = -position;
488 // Force an immediate update of the offsets
489 set_offset(offset_, true);
493 void View::reset_zero_position()
497 // Force an immediate update of the offsets
498 set_offset(offset_, true);
502 int View::owner_visual_v_offset() const
504 return -scrollarea_->verticalScrollBar()->sliderPosition();
507 void View::set_v_offset(int offset)
509 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
514 unsigned int View::depth() const
519 uint32_t View::current_segment() const
521 return current_segment_;
524 pv::util::SIPrefix View::tick_prefix() const
529 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
531 if (tick_prefix_ != tick_prefix) {
532 tick_prefix_ = tick_prefix;
533 tick_prefix_changed();
537 unsigned int View::tick_precision() const
539 return tick_precision_;
542 void View::set_tick_precision(unsigned tick_precision)
544 if (tick_precision_ != tick_precision) {
545 tick_precision_ = tick_precision;
546 tick_precision_changed();
550 const pv::util::Timestamp& View::tick_period() const
555 unsigned int View::minor_tick_count() const
557 return minor_tick_count_;
560 void View::set_tick_period(const pv::util::Timestamp& tick_period)
562 if (tick_period_ != tick_period) {
563 tick_period_ = tick_period;
564 tick_period_changed();
568 TimeUnit View::time_unit() const
573 void View::set_time_unit(pv::util::TimeUnit time_unit)
575 if (time_unit_ != time_unit) {
576 time_unit_ = time_unit;
581 void View::set_current_segment(uint32_t segment_id)
583 current_segment_ = segment_id;
585 for (shared_ptr<Signal> signal : signals_)
586 signal->set_current_segment(current_segment_);
588 for (shared_ptr<DecodeTrace> dt : decode_traces_)
589 dt->set_current_segment(current_segment_);
592 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
594 trigger_markers_.clear();
595 for (util::Timestamp timestamp : triggers)
596 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
598 // When enabled, the first trigger for this segment is used as the zero position
599 GlobalSettings settings;
600 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
602 if (trigger_is_zero_time && (triggers.size() > 0))
603 set_zero_position(triggers.front());
607 segment_changed(segment_id);
610 bool View::segment_is_selectable() const
612 return segment_selectable_;
615 Trace::SegmentDisplayMode View::segment_display_mode() const
617 return segment_display_mode_;
620 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
622 trigger_markers_.clear();
624 segment_display_mode_ = mode;
626 for (shared_ptr<Signal> signal : signals_)
627 signal->set_segment_display_mode(mode);
629 uint32_t last_segment = session_.get_segment_count() - 1;
632 case Trace::ShowLastSegmentOnly:
633 if (current_segment_ != last_segment)
634 set_current_segment(last_segment);
637 case Trace::ShowLastCompleteSegmentOnly:
638 // Do nothing if we only have one segment so far
639 if (last_segment > 0) {
640 // If the last segment isn't complete, the previous one must be
641 uint32_t segment_id =
642 (session_.all_segments_complete(last_segment)) ?
643 last_segment : last_segment - 1;
645 if (current_segment_ != segment_id)
646 set_current_segment(segment_id);
650 case Trace::ShowSingleSegmentOnly:
651 case Trace::ShowAllSegments:
652 case Trace::ShowAccumulatedIntensity:
654 // Current segment remains as-is
658 segment_selectable_ = true;
660 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
661 segment_selectable_ = false;
665 segment_display_mode_changed((int)mode, segment_selectable_);
668 void View::zoom(double steps)
670 zoom(steps, viewport_->width() / 2);
673 void View::zoom(double steps, int offset)
675 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
678 void View::zoom_fit(bool gui_state)
680 // Act as one-shot when stopped, toggle along with the GUI otherwise
681 if (session_.get_capture_state() == Session::Stopped) {
682 always_zoom_to_fit_ = false;
683 always_zoom_to_fit_changed(false);
685 always_zoom_to_fit_ = gui_state;
686 always_zoom_to_fit_changed(gui_state);
689 const pair<Timestamp, Timestamp> extents = get_time_extents();
690 const Timestamp delta = extents.second - extents.first;
691 if (delta < Timestamp("1e-12"))
695 const int w = viewport_->width();
699 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
700 set_scale_offset(scale.convert_to<double>(), extents.first);
703 void View::zoom_one_to_one()
705 using pv::data::SignalData;
707 // Make a set of all the visible data objects
708 set< shared_ptr<SignalData> > visible_data = get_visible_data();
709 if (visible_data.empty())
713 const int w = viewport_->width();
717 set_zoom(1.0 / session_.get_samplerate(), w / 2);
720 void View::set_scale_offset(double scale, const Timestamp& offset)
722 // Disable sticky scrolling / always zoom to fit when acquisition runs
723 // and user drags the viewport
724 if ((scale_ == scale) && (offset_ != offset) &&
725 (session_.get_capture_state() == Session::Running)) {
727 if (sticky_scrolling_) {
728 sticky_scrolling_ = false;
729 sticky_scrolling_changed(false);
732 if (always_zoom_to_fit_) {
733 always_zoom_to_fit_ = false;
734 always_zoom_to_fit_changed(false);
741 calculate_tick_spacing();
748 set< shared_ptr<SignalData> > View::get_visible_data() const
750 // Make a set of all the visible data objects
751 set< shared_ptr<SignalData> > visible_data;
752 for (const shared_ptr<Signal> sig : signals_)
754 visible_data.insert(sig->data());
759 pair<Timestamp, Timestamp> View::get_time_extents() const
761 boost::optional<Timestamp> left_time, right_time;
762 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
763 for (const shared_ptr<SignalData> d : visible_data) {
764 const vector< shared_ptr<Segment> > segments = d->segments();
765 for (const shared_ptr<Segment> &s : segments) {
766 double samplerate = s->samplerate();
767 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
769 const Timestamp start_time = s->start_time();
770 left_time = left_time ?
771 min(*left_time, start_time) :
773 right_time = right_time ?
774 max(*right_time, start_time + d->max_sample_count() / samplerate) :
775 start_time + d->max_sample_count() / samplerate;
779 if (!left_time || !right_time)
780 return make_pair(0, 0);
782 assert(*left_time < *right_time);
783 return make_pair(*left_time, *right_time);
786 void View::enable_show_sampling_points(bool state)
793 void View::enable_show_analog_minor_grid(bool state)
800 void View::enable_colored_bg(bool state)
806 bool View::colored_bg() const
811 bool View::cursors_shown() const
813 return show_cursors_;
816 void View::show_cursors(bool show)
818 show_cursors_ = show;
819 cursor_state_changed(show);
824 void View::centre_cursors()
827 const double time_width = scale_ * viewport_->width();
828 cursors_->first()->set_time(offset_ + time_width * 0.4);
829 cursors_->second()->set_time(offset_ + time_width * 0.6);
836 shared_ptr<CursorPair> View::cursors() const
841 void View::add_flag(const Timestamp& time)
843 flags_.push_back(make_shared<Flag>(*this, time,
844 QString("%1").arg(next_flag_text_)));
846 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
847 (next_flag_text_ + 1);
849 time_item_appearance_changed(true, true);
852 void View::remove_flag(shared_ptr<Flag> flag)
855 time_item_appearance_changed(true, true);
858 vector< shared_ptr<Flag> > View::flags() const
860 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
861 stable_sort(flags.begin(), flags.end(),
862 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
863 return a->time() < b->time();
869 const QPoint& View::hover_point() const
874 void View::restack_all_trace_tree_items()
876 // Make a list of owners that is sorted from deepest first
877 const vector<shared_ptr<TraceTreeItem>> items(
878 list_by_type<TraceTreeItem>());
879 set< TraceTreeItemOwner* > owners;
880 for (const auto &r : items)
881 owners.insert(r->owner());
882 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
883 sort(sorted_owners.begin(), sorted_owners.end(),
884 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
885 return a->depth() > b->depth(); });
887 // Restack the items recursively
888 for (auto &o : sorted_owners)
891 // Animate the items to their destination
892 for (const auto &i : items)
893 i->animate_to_layout_v_offset();
896 void View::on_setting_changed(const QString &key, const QVariant &value)
898 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
899 on_settingViewTriggerIsZeroTime_changed(value);
902 void View::trigger_event(int segment_id, util::Timestamp location)
904 // TODO This doesn't work if we're showing multiple segments at once
905 if ((uint32_t)segment_id != current_segment_)
908 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
909 // if this is the first trigger for this segment.
910 GlobalSettings settings;
911 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
913 size_t trigger_count = session_.get_triggers(current_segment_).size();
915 if (trigger_is_zero_time && trigger_count == 1)
916 set_zero_position(location);
918 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
921 void View::get_scroll_layout(double &length, Timestamp &offset) const
923 const pair<Timestamp, Timestamp> extents = get_time_extents();
924 length = ((extents.second - extents.first) / scale_).convert_to<double>();
925 offset = offset_ / scale_;
928 void View::set_zoom(double scale, int offset)
930 // Reset the "always zoom to fit" feature as the user changed the zoom
931 always_zoom_to_fit_ = false;
932 always_zoom_to_fit_changed(false);
934 const Timestamp cursor_offset = offset_ + scale_ * offset;
935 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
936 const Timestamp new_offset = cursor_offset - new_scale * offset;
937 set_scale_offset(new_scale.convert_to<double>(), new_offset);
940 void View::calculate_tick_spacing()
942 const double SpacingIncrement = 10.0f;
943 const double MinValueSpacing = 40.0f;
945 // Figure out the highest numeric value visible on a label
946 const QSize areaSize = viewport_->size();
947 const Timestamp max_time = max(fabs(offset_),
948 fabs(offset_ + scale_ * areaSize.width()));
950 double min_width = SpacingIncrement;
951 double label_width, tick_period_width;
953 QFontMetrics m(QApplication::font());
955 // Copies of the member variables with the same name, used in the calculation
956 // and written back afterwards, so that we don't emit signals all the time
957 // during the calculation.
958 pv::util::Timestamp tick_period = tick_period_;
959 pv::util::SIPrefix tick_prefix = tick_prefix_;
960 unsigned tick_precision = tick_precision_;
963 const double min_period = scale_ * min_width;
965 const int order = (int)floorf(log10f(min_period));
966 const pv::util::Timestamp order_decimal =
967 pow(pv::util::Timestamp(10), order);
969 // Allow for a margin of error so that a scale unit of 1 can be used.
970 // Otherwise, for a SU of 1 the tick period will almost always be below
971 // the min_period by a small amount - and thus skipped in favor of 2.
972 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
973 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
974 double tp_with_margin;
975 unsigned int unit = 0;
978 tp_with_margin = order_decimal.convert_to<double>() *
979 (ScaleUnits[unit++] + tp_margin);
980 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
982 minor_tick_count_ = (unit == 2) ? 4 : 5;
983 tick_period = order_decimal * ScaleUnits[unit - 1];
984 tick_prefix = static_cast<pv::util::SIPrefix>(
985 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
987 // Precision is the number of fractional digits required, not
988 // taking the prefix into account (and it must never be negative)
989 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
991 tick_period_width = (tick_period / scale_).convert_to<double>();
993 const QString label_text = Ruler::format_time_with_distance(
994 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
996 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
997 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
1000 min_width += SpacingIncrement;
1001 } while (tick_period_width < label_width);
1003 set_tick_period(tick_period);
1004 set_tick_prefix(tick_prefix);
1005 set_tick_precision(tick_precision);
1008 void View::adjust_top_margin()
1012 const QSize areaSize = viewport_->size();
1014 const pair<int, int> extents = v_extents();
1015 const int top_margin = owner_visual_v_offset() + extents.first;
1016 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1018 // Do we have empty space at the top while the last trace goes out of screen?
1019 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1020 const int trace_height = extents.second - extents.first;
1022 // Center everything vertically if there is enough space
1023 if (areaSize.height() >= trace_height)
1024 set_v_offset(extents.first -
1025 ((areaSize.height() - trace_height) / 2));
1027 // Remove the top margin to make as many traces fit on screen as possible
1028 set_v_offset(extents.first);
1032 void View::update_scroll()
1035 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1036 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1038 const QSize areaSize = viewport_->size();
1040 // Set the horizontal scroll bar
1043 get_scroll_layout(length, offset);
1044 length = max(length - areaSize.width(), 0.0);
1046 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1048 hscrollbar->setPageStep(areaSize.width() / 2);
1049 hscrollbar->setSingleStep(major_tick_distance);
1051 updating_scroll_ = true;
1053 if (length < MaxScrollValue) {
1054 hscrollbar->setRange(0, length);
1055 hscrollbar->setSliderPosition(offset.convert_to<double>());
1057 hscrollbar->setRange(0, MaxScrollValue);
1058 hscrollbar->setSliderPosition(
1059 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1062 updating_scroll_ = false;
1064 // Set the vertical scrollbar
1065 vscrollbar->setPageStep(areaSize.height());
1066 vscrollbar->setSingleStep(areaSize.height() / 8);
1068 const pair<int, int> extents = v_extents();
1070 // Don't change the scrollbar range if there are no traces
1071 if (extents.first != extents.second)
1072 vscrollbar->setRange(extents.first - areaSize.height(),
1075 if (scroll_needs_defaults_)
1076 set_scroll_default();
1079 void View::reset_scroll()
1081 scrollarea_->verticalScrollBar()->setRange(0, 0);
1084 void View::set_scroll_default()
1088 const QSize areaSize = viewport_->size();
1090 const pair<int, int> extents = v_extents();
1091 const int trace_height = extents.second - extents.first;
1093 // Do all traces fit in the view?
1094 if (areaSize.height() >= trace_height)
1095 // Center all traces vertically
1096 set_v_offset(extents.first -
1097 ((areaSize.height() - trace_height) / 2));
1099 // Put the first trace at the top, letting the bottom ones overflow
1100 set_v_offset(extents.first);
1103 void View::determine_if_header_was_shrunk()
1105 const int header_pane_width = splitter_->sizes().front();
1106 const int header_width = header_->extended_size_hint().width();
1108 // Allow for a slight margin of error so that we also accept
1109 // slight differences when e.g. a label name change increased
1110 // the overall width
1111 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1114 void View::resize_header_to_fit()
1116 // Setting the maximum width of the header widget doesn't work as
1117 // expected because the splitter would allow the user to make the
1118 // pane wider than that, creating empty space as a result.
1119 // To make this work, we stricly enforce the maximum width by
1120 // expanding the header unless the user shrunk it on purpose.
1121 // As we're then setting the width of the header pane, we set the
1122 // splitter to the maximum allowed position.
1124 int splitter_area_width = 0;
1125 for (int w : splitter_->sizes())
1126 splitter_area_width += w;
1128 // Make sure the header has enough horizontal space to show all labels fully
1129 QList<int> pane_sizes;
1130 pane_sizes.push_back(header_->extended_size_hint().width());
1131 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1132 splitter_->setSizes(pane_sizes);
1135 void View::update_layout()
1140 TraceTreeItemOwner* View::find_prevalent_trace_group(
1141 const shared_ptr<sigrok::ChannelGroup> &group,
1142 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1147 unordered_set<TraceTreeItemOwner*> owners;
1148 vector<TraceTreeItemOwner*> owner_list;
1150 // Make a set and a list of all the owners
1151 for (const auto &channel : group->channels()) {
1152 for (auto entry : signal_map) {
1153 if (entry.first->channel() == channel) {
1154 TraceTreeItemOwner *const o = (entry.second)->owner();
1155 owner_list.push_back(o);
1161 // Iterate through the list of owners, and find the most prevalent
1162 size_t max_prevalence = 0;
1163 TraceTreeItemOwner *prevalent_owner = nullptr;
1164 for (TraceTreeItemOwner *owner : owners) {
1165 const size_t prevalence = count_if(
1166 owner_list.begin(), owner_list.end(),
1167 [&](TraceTreeItemOwner *o) { return o == owner; });
1168 if (prevalence > max_prevalence) {
1169 max_prevalence = prevalence;
1170 prevalent_owner = owner;
1174 return prevalent_owner;
1177 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1178 const vector< shared_ptr<sigrok::Channel> > &channels,
1179 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1181 set< shared_ptr<Trace> > &add_list)
1183 vector< shared_ptr<Trace> > filtered_traces;
1185 for (const auto &channel : channels) {
1186 for (auto entry : signal_map) {
1187 if (entry.first->channel() == channel) {
1188 shared_ptr<Trace> trace = entry.second;
1189 const auto list_iter = add_list.find(trace);
1190 if (list_iter == add_list.end())
1193 filtered_traces.push_back(trace);
1194 add_list.erase(list_iter);
1199 return filtered_traces;
1202 void View::determine_time_unit()
1204 // Check whether we know the sample rate and hence can use time as the unit
1205 if (time_unit_ == util::TimeUnit::Samples) {
1206 // Check all signals but...
1207 for (const shared_ptr<Signal> signal : signals_) {
1208 const shared_ptr<SignalData> data = signal->data();
1210 // ...only check first segment of each
1211 const vector< shared_ptr<Segment> > segments = data->segments();
1212 if (!segments.empty())
1213 if (segments[0]->samplerate()) {
1214 set_time_unit(util::TimeUnit::Time);
1221 bool View::eventFilter(QObject *object, QEvent *event)
1223 const QEvent::Type type = event->type();
1224 if (type == QEvent::MouseMove) {
1226 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1227 if (object == viewport_)
1228 hover_point_ = mouse_event->pos();
1229 else if (object == ruler_)
1230 hover_point_ = QPoint(mouse_event->x(), 0);
1231 else if (object == header_)
1232 hover_point_ = QPoint(0, mouse_event->y());
1234 hover_point_ = QPoint(-1, -1);
1236 update_hover_point();
1238 } else if (type == QEvent::Leave) {
1239 hover_point_ = QPoint(-1, -1);
1240 update_hover_point();
1241 } else if (type == QEvent::Show) {
1243 // This is somewhat of a hack, unfortunately. We cannot use
1244 // set_v_offset() from within restore_settings() as the view
1245 // at that point is neither visible nor properly sized.
1246 // This is the least intrusive workaround I could come up
1247 // with: set the vertical offset (or scroll defaults) when
1248 // the view is shown, which happens after all widgets were
1249 // resized to their final sizes.
1252 if (settings_restored_)
1253 determine_if_header_was_shrunk();
1255 resize_header_to_fit();
1257 if (scroll_needs_defaults_) {
1258 set_scroll_default();
1259 scroll_needs_defaults_ = false;
1262 if (saved_v_offset_) {
1263 set_v_offset(saved_v_offset_);
1264 saved_v_offset_ = 0;
1268 return QObject::eventFilter(object, event);
1271 void View::resizeEvent(QResizeEvent* event)
1273 // Only adjust the top margin if we shrunk vertically
1274 if (event->size().height() < event->oldSize().height())
1275 adjust_top_margin();
1280 void View::update_hover_point()
1282 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1283 list_by_type<TraceTreeItem>());
1284 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1285 r->hover_point_changed(hover_point_);
1287 hover_point_changed(hover_point_);
1290 void View::row_item_appearance_changed(bool label, bool content)
1295 viewport_->update();
1298 void View::time_item_appearance_changed(bool label, bool content)
1303 // Make sure the header pane width is updated, too
1308 viewport_->update();
1311 void View::extents_changed(bool horz, bool vert)
1314 (horz ? TraceTreeItemHExtentsChanged : 0) |
1315 (vert ? TraceTreeItemVExtentsChanged : 0);
1317 lazy_event_handler_.start();
1320 void View::on_signal_name_changed()
1322 if (!header_was_shrunk_)
1323 resize_header_to_fit();
1326 void View::on_splitter_moved()
1328 // The header can only shrink when the splitter is moved manually
1329 determine_if_header_was_shrunk();
1331 if (!header_was_shrunk_)
1332 resize_header_to_fit();
1335 void View::h_scroll_value_changed(int value)
1337 if (updating_scroll_)
1340 // Disable sticky scrolling when user moves the horizontal scroll bar
1341 // during a running acquisition
1342 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1343 sticky_scrolling_ = false;
1344 sticky_scrolling_changed(false);
1347 const int range = scrollarea_->horizontalScrollBar()->maximum();
1348 if (range < MaxScrollValue)
1349 set_offset(scale_ * value);
1353 get_scroll_layout(length, offset);
1354 set_offset(scale_ * length * value / MaxScrollValue);
1358 viewport_->update();
1361 void View::v_scroll_value_changed()
1364 viewport_->update();
1367 void View::signals_changed()
1369 using sigrok::Channel;
1371 vector< shared_ptr<Channel> > channels;
1372 shared_ptr<sigrok::Device> sr_dev;
1373 bool signals_added_or_removed = false;
1375 // Do we need to set the vertical scrollbar to its default position later?
1376 // We do if there are no traces, i.e. the scroll bar has no range set
1377 bool reset_scrollbar =
1378 (scrollarea_->verticalScrollBar()->minimum() ==
1379 scrollarea_->verticalScrollBar()->maximum());
1381 if (!session_.device()) {
1385 sr_dev = session_.device()->device();
1387 channels = sr_dev->channels();
1390 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1392 // Make a list of traces that are being added, and a list of traces
1393 // that are being removed
1394 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1395 const set<shared_ptr<Trace>> prev_traces(
1396 prev_trace_list.begin(), prev_trace_list.end());
1398 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1400 #ifdef ENABLE_DECODE
1401 traces.insert(decode_traces_.begin(), decode_traces_.end());
1404 set< shared_ptr<Trace> > add_traces;
1405 set_difference(traces.begin(), traces.end(),
1406 prev_traces.begin(), prev_traces.end(),
1407 inserter(add_traces, add_traces.begin()));
1409 set< shared_ptr<Trace> > remove_traces;
1410 set_difference(prev_traces.begin(), prev_traces.end(),
1411 traces.begin(), traces.end(),
1412 inserter(remove_traces, remove_traces.begin()));
1414 // Make a look-up table of sigrok Channels to pulseview Signals
1415 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1417 for (const shared_ptr<Signal> &sig : signals_)
1418 signal_map[sig->base()] = sig;
1420 // Populate channel groups
1422 for (auto entry : sr_dev->channel_groups()) {
1423 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1425 if (group->channels().size() <= 1)
1428 // Find best trace group to add to
1429 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1432 // If there is no trace group, create one
1433 shared_ptr<TraceGroup> new_trace_group;
1435 new_trace_group.reset(new TraceGroup());
1436 owner = new_trace_group.get();
1439 // Extract traces for the trace group, removing them from
1441 const vector< shared_ptr<Trace> > new_traces_in_group =
1442 extract_new_traces_for_channels(group->channels(),
1443 signal_map, add_traces);
1445 // Add the traces to the group
1446 const pair<int, int> prev_v_extents = owner->v_extents();
1447 int offset = prev_v_extents.second - prev_v_extents.first;
1448 for (shared_ptr<Trace> trace : new_traces_in_group) {
1450 owner->add_child_item(trace);
1452 const pair<int, int> extents = trace->v_extents();
1453 if (trace->enabled())
1454 offset += -extents.first;
1455 trace->force_to_v_offset(offset);
1456 if (trace->enabled())
1457 offset += extents.second;
1460 if (new_trace_group) {
1461 // Assign proper vertical offsets to each channel in the group
1462 new_trace_group->restack_items();
1464 // If this is a new group, enqueue it in the new top level
1466 if (!new_traces_in_group.empty())
1467 new_top_level_items.push_back(new_trace_group);
1471 // Enqueue the remaining logic channels in a group
1472 vector< shared_ptr<Channel> > logic_channels;
1473 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1474 [](const shared_ptr<Channel>& c) {
1475 return c->type() == sigrok::ChannelType::LOGIC; });
1477 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1478 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1480 if (non_grouped_logic_signals.size() > 0) {
1481 const shared_ptr<TraceGroup> non_grouped_trace_group(
1482 make_shared<TraceGroup>());
1483 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1484 non_grouped_trace_group->add_child_item(trace);
1486 non_grouped_trace_group->restack_items();
1487 new_top_level_items.push_back(non_grouped_trace_group);
1490 // Enqueue the remaining channels as free ungrouped traces
1491 const vector< shared_ptr<Trace> > new_top_level_signals =
1492 extract_new_traces_for_channels(channels, signal_map, add_traces);
1493 new_top_level_items.insert(new_top_level_items.end(),
1494 new_top_level_signals.begin(), new_top_level_signals.end());
1496 // Enqueue any remaining traces i.e. decode traces
1497 new_top_level_items.insert(new_top_level_items.end(),
1498 add_traces.begin(), add_traces.end());
1500 // Remove any removed traces
1501 for (shared_ptr<Trace> trace : remove_traces) {
1502 TraceTreeItemOwner *const owner = trace->owner();
1504 owner->remove_child_item(trace);
1505 signals_added_or_removed = true;
1508 // Remove any empty trace groups
1509 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1510 if (group->child_items().size() == 0) {
1511 remove_child_item(group);
1515 // Add and position the pending top levels items
1516 int offset = v_extents().second;
1517 for (auto item : new_top_level_items) {
1518 add_child_item(item);
1520 // Position the item after the last item or at the top if there is none
1521 const pair<int, int> extents = item->v_extents();
1523 if (item->enabled())
1524 offset += -extents.first;
1526 item->force_to_v_offset(offset);
1528 if (item->enabled())
1529 offset += extents.second;
1530 signals_added_or_removed = true;
1534 if (signals_added_or_removed && !header_was_shrunk_)
1535 resize_header_to_fit();
1540 viewport_->update();
1542 if (reset_scrollbar)
1543 set_scroll_default();
1546 void View::capture_state_updated(int state)
1548 GlobalSettings settings;
1550 if (state == Session::Running) {
1551 set_time_unit(util::TimeUnit::Samples);
1553 trigger_markers_.clear();
1555 scale_at_acq_start_ = scale_;
1556 offset_at_acq_start_ = offset_;
1558 // Activate "always zoom to fit" if the setting is enabled and we're
1559 // the main view of this session (other trace views may be used for
1560 // zooming and we don't want to mess them up)
1561 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1562 if (is_main_view_ && state) {
1563 always_zoom_to_fit_ = true;
1564 always_zoom_to_fit_changed(always_zoom_to_fit_);
1567 // Enable sticky scrolling if the setting is enabled
1568 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1570 // Reset all traces to segment 0
1571 current_segment_ = 0;
1572 set_current_segment(current_segment_);
1575 if (state == Session::Stopped) {
1576 // After acquisition has stopped we need to re-calculate the ticks once
1577 // as it's otherwise done when the user pans or zooms, which is too late
1578 calculate_tick_spacing();
1580 // Reset "always zoom to fit", the acquisition has stopped
1581 if (always_zoom_to_fit_) {
1582 // Perform a final zoom-to-fit before disabling
1583 zoom_fit(always_zoom_to_fit_);
1584 always_zoom_to_fit_ = false;
1585 always_zoom_to_fit_changed(always_zoom_to_fit_);
1588 bool zoom_to_fit_after_acq =
1589 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1591 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1592 // we didn't restore settings in the meanwhile
1593 if (zoom_to_fit_after_acq &&
1594 !suppress_zoom_to_fit_after_acq_ &&
1595 (scale_ == scale_at_acq_start_) &&
1596 (offset_ == offset_at_acq_start_))
1597 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1599 suppress_zoom_to_fit_after_acq_ = false;
1603 void View::on_new_segment(int new_segment_id)
1605 on_segment_changed(new_segment_id);
1608 void View::on_segment_completed(int segment_id)
1610 on_segment_changed(segment_id);
1613 void View::on_segment_changed(int segment)
1615 switch (segment_display_mode_) {
1616 case Trace::ShowLastSegmentOnly:
1617 case Trace::ShowSingleSegmentOnly:
1618 set_current_segment(segment);
1621 case Trace::ShowLastCompleteSegmentOnly:
1622 // Only update if all segments are complete
1623 if (session_.all_segments_complete(segment))
1624 set_current_segment(segment);
1627 case Trace::ShowAllSegments:
1628 case Trace::ShowAccumulatedIntensity:
1634 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1636 if (new_value.toBool()) {
1637 // The first trigger for this segment is used as the zero position
1638 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1639 if (triggers.size() > 0)
1640 set_zero_position(triggers.front());
1642 reset_zero_position();
1645 void View::perform_delayed_view_update()
1647 if (always_zoom_to_fit_) {
1649 } else if (sticky_scrolling_) {
1650 // Make right side of the view sticky
1653 get_scroll_layout(length, offset);
1655 const QSize areaSize = viewport_->size();
1656 length = max(length - areaSize.width(), 0.0);
1658 set_offset(scale_ * length);
1661 determine_time_unit();
1664 viewport_->update();
1667 void View::process_sticky_events()
1669 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1671 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1672 restack_all_trace_tree_items();
1676 // Clear the sticky events
1680 } // namespace trace
1681 } // namespace views