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;
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;
823 void View::centre_cursors()
826 const double time_width = scale_ * viewport_->width();
827 cursors_->first()->set_time(offset_ + time_width * 0.4);
828 cursors_->second()->set_time(offset_ + time_width * 0.6);
835 shared_ptr<CursorPair> View::cursors() const
840 void View::add_flag(const Timestamp& time)
842 flags_.push_back(make_shared<Flag>(*this, time,
843 QString("%1").arg(next_flag_text_)));
845 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
846 (next_flag_text_ + 1);
848 time_item_appearance_changed(true, true);
851 void View::remove_flag(shared_ptr<Flag> flag)
854 time_item_appearance_changed(true, true);
857 vector< shared_ptr<Flag> > View::flags() const
859 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
860 stable_sort(flags.begin(), flags.end(),
861 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
862 return a->time() < b->time();
868 const QPoint& View::hover_point() const
873 void View::restack_all_trace_tree_items()
875 // Make a list of owners that is sorted from deepest first
876 const vector<shared_ptr<TraceTreeItem>> items(
877 list_by_type<TraceTreeItem>());
878 set< TraceTreeItemOwner* > owners;
879 for (const auto &r : items)
880 owners.insert(r->owner());
881 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
882 sort(sorted_owners.begin(), sorted_owners.end(),
883 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
884 return a->depth() > b->depth(); });
886 // Restack the items recursively
887 for (auto &o : sorted_owners)
890 // Animate the items to their destination
891 for (const auto &i : items)
892 i->animate_to_layout_v_offset();
895 void View::on_setting_changed(const QString &key, const QVariant &value)
897 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
898 on_settingViewTriggerIsZeroTime_changed(value);
901 void View::trigger_event(int segment_id, util::Timestamp location)
903 // TODO This doesn't work if we're showing multiple segments at once
904 if ((uint32_t)segment_id != current_segment_)
907 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
908 // if this is the first trigger for this segment.
909 GlobalSettings settings;
910 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
912 size_t trigger_count = session_.get_triggers(current_segment_).size();
914 if (trigger_is_zero_time && trigger_count == 1)
915 set_zero_position(location);
917 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
920 void View::get_scroll_layout(double &length, Timestamp &offset) const
922 const pair<Timestamp, Timestamp> extents = get_time_extents();
923 length = ((extents.second - extents.first) / scale_).convert_to<double>();
924 offset = offset_ / scale_;
927 void View::set_zoom(double scale, int offset)
929 // Reset the "always zoom to fit" feature as the user changed the zoom
930 always_zoom_to_fit_ = false;
931 always_zoom_to_fit_changed(false);
933 const Timestamp cursor_offset = offset_ + scale_ * offset;
934 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
935 const Timestamp new_offset = cursor_offset - new_scale * offset;
936 set_scale_offset(new_scale.convert_to<double>(), new_offset);
939 void View::calculate_tick_spacing()
941 const double SpacingIncrement = 10.0f;
942 const double MinValueSpacing = 40.0f;
944 // Figure out the highest numeric value visible on a label
945 const QSize areaSize = viewport_->size();
946 const Timestamp max_time = max(fabs(offset_),
947 fabs(offset_ + scale_ * areaSize.width()));
949 double min_width = SpacingIncrement;
950 double label_width, tick_period_width;
952 QFontMetrics m(QApplication::font());
954 // Copies of the member variables with the same name, used in the calculation
955 // and written back afterwards, so that we don't emit signals all the time
956 // during the calculation.
957 pv::util::Timestamp tick_period = tick_period_;
958 pv::util::SIPrefix tick_prefix = tick_prefix_;
959 unsigned tick_precision = tick_precision_;
962 const double min_period = scale_ * min_width;
964 const int order = (int)floorf(log10f(min_period));
965 const pv::util::Timestamp order_decimal =
966 pow(pv::util::Timestamp(10), order);
968 // Allow for a margin of error so that a scale unit of 1 can be used.
969 // Otherwise, for a SU of 1 the tick period will almost always be below
970 // the min_period by a small amount - and thus skipped in favor of 2.
971 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
972 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
973 double tp_with_margin;
974 unsigned int unit = 0;
977 tp_with_margin = order_decimal.convert_to<double>() *
978 (ScaleUnits[unit++] + tp_margin);
979 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
981 minor_tick_count_ = (unit == 2) ? 4 : 5;
982 tick_period = order_decimal * ScaleUnits[unit - 1];
983 tick_prefix = static_cast<pv::util::SIPrefix>(
984 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
986 // Precision is the number of fractional digits required, not
987 // taking the prefix into account (and it must never be negative)
988 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
990 tick_period_width = (tick_period / scale_).convert_to<double>();
992 const QString label_text = Ruler::format_time_with_distance(
993 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
995 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
996 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
999 min_width += SpacingIncrement;
1000 } while (tick_period_width < label_width);
1002 set_tick_period(tick_period);
1003 set_tick_prefix(tick_prefix);
1004 set_tick_precision(tick_precision);
1007 void View::adjust_top_margin()
1011 const QSize areaSize = viewport_->size();
1013 const pair<int, int> extents = v_extents();
1014 const int top_margin = owner_visual_v_offset() + extents.first;
1015 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1017 // Do we have empty space at the top while the last trace goes out of screen?
1018 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1019 const int trace_height = extents.second - extents.first;
1021 // Center everything vertically if there is enough space
1022 if (areaSize.height() >= trace_height)
1023 set_v_offset(extents.first -
1024 ((areaSize.height() - trace_height) / 2));
1026 // Remove the top margin to make as many traces fit on screen as possible
1027 set_v_offset(extents.first);
1031 void View::update_scroll()
1034 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1035 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1037 const QSize areaSize = viewport_->size();
1039 // Set the horizontal scroll bar
1042 get_scroll_layout(length, offset);
1043 length = max(length - areaSize.width(), 0.0);
1045 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1047 hscrollbar->setPageStep(areaSize.width() / 2);
1048 hscrollbar->setSingleStep(major_tick_distance);
1050 updating_scroll_ = true;
1052 if (length < MaxScrollValue) {
1053 hscrollbar->setRange(0, length);
1054 hscrollbar->setSliderPosition(offset.convert_to<double>());
1056 hscrollbar->setRange(0, MaxScrollValue);
1057 hscrollbar->setSliderPosition(
1058 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1061 updating_scroll_ = false;
1063 // Set the vertical scrollbar
1064 vscrollbar->setPageStep(areaSize.height());
1065 vscrollbar->setSingleStep(areaSize.height() / 8);
1067 const pair<int, int> extents = v_extents();
1069 // Don't change the scrollbar range if there are no traces
1070 if (extents.first != extents.second)
1071 vscrollbar->setRange(extents.first - areaSize.height(),
1074 if (scroll_needs_defaults_)
1075 set_scroll_default();
1078 void View::reset_scroll()
1080 scrollarea_->verticalScrollBar()->setRange(0, 0);
1083 void View::set_scroll_default()
1087 const QSize areaSize = viewport_->size();
1089 const pair<int, int> extents = v_extents();
1090 const int trace_height = extents.second - extents.first;
1092 // Do all traces fit in the view?
1093 if (areaSize.height() >= trace_height)
1094 // Center all traces vertically
1095 set_v_offset(extents.first -
1096 ((areaSize.height() - trace_height) / 2));
1098 // Put the first trace at the top, letting the bottom ones overflow
1099 set_v_offset(extents.first);
1102 void View::determine_if_header_was_shrunk()
1104 const int header_pane_width = splitter_->sizes().front();
1105 const int header_width = header_->extended_size_hint().width();
1107 // Allow for a slight margin of error so that we also accept
1108 // slight differences when e.g. a label name change increased
1109 // the overall width
1110 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1113 void View::resize_header_to_fit()
1115 // Setting the maximum width of the header widget doesn't work as
1116 // expected because the splitter would allow the user to make the
1117 // pane wider than that, creating empty space as a result.
1118 // To make this work, we stricly enforce the maximum width by
1119 // expanding the header unless the user shrunk it on purpose.
1120 // As we're then setting the width of the header pane, we set the
1121 // splitter to the maximum allowed position.
1123 int splitter_area_width = 0;
1124 for (int w : splitter_->sizes())
1125 splitter_area_width += w;
1127 // Make sure the header has enough horizontal space to show all labels fully
1128 QList<int> pane_sizes;
1129 pane_sizes.push_back(header_->extended_size_hint().width());
1130 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1131 splitter_->setSizes(pane_sizes);
1134 void View::update_layout()
1139 TraceTreeItemOwner* View::find_prevalent_trace_group(
1140 const shared_ptr<sigrok::ChannelGroup> &group,
1141 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1146 unordered_set<TraceTreeItemOwner*> owners;
1147 vector<TraceTreeItemOwner*> owner_list;
1149 // Make a set and a list of all the owners
1150 for (const auto &channel : group->channels()) {
1151 for (auto entry : signal_map) {
1152 if (entry.first->channel() == channel) {
1153 TraceTreeItemOwner *const o = (entry.second)->owner();
1154 owner_list.push_back(o);
1160 // Iterate through the list of owners, and find the most prevalent
1161 size_t max_prevalence = 0;
1162 TraceTreeItemOwner *prevalent_owner = nullptr;
1163 for (TraceTreeItemOwner *owner : owners) {
1164 const size_t prevalence = count_if(
1165 owner_list.begin(), owner_list.end(),
1166 [&](TraceTreeItemOwner *o) { return o == owner; });
1167 if (prevalence > max_prevalence) {
1168 max_prevalence = prevalence;
1169 prevalent_owner = owner;
1173 return prevalent_owner;
1176 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1177 const vector< shared_ptr<sigrok::Channel> > &channels,
1178 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1180 set< shared_ptr<Trace> > &add_list)
1182 vector< shared_ptr<Trace> > filtered_traces;
1184 for (const auto &channel : channels) {
1185 for (auto entry : signal_map) {
1186 if (entry.first->channel() == channel) {
1187 shared_ptr<Trace> trace = entry.second;
1188 const auto list_iter = add_list.find(trace);
1189 if (list_iter == add_list.end())
1192 filtered_traces.push_back(trace);
1193 add_list.erase(list_iter);
1198 return filtered_traces;
1201 void View::determine_time_unit()
1203 // Check whether we know the sample rate and hence can use time as the unit
1204 if (time_unit_ == util::TimeUnit::Samples) {
1205 // Check all signals but...
1206 for (const shared_ptr<Signal> signal : signals_) {
1207 const shared_ptr<SignalData> data = signal->data();
1209 // ...only check first segment of each
1210 const vector< shared_ptr<Segment> > segments = data->segments();
1211 if (!segments.empty())
1212 if (segments[0]->samplerate()) {
1213 set_time_unit(util::TimeUnit::Time);
1220 bool View::eventFilter(QObject *object, QEvent *event)
1222 const QEvent::Type type = event->type();
1223 if (type == QEvent::MouseMove) {
1225 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1226 if (object == viewport_)
1227 hover_point_ = mouse_event->pos();
1228 else if (object == ruler_)
1229 hover_point_ = QPoint(mouse_event->x(), 0);
1230 else if (object == header_)
1231 hover_point_ = QPoint(0, mouse_event->y());
1233 hover_point_ = QPoint(-1, -1);
1235 update_hover_point();
1237 } else if (type == QEvent::Leave) {
1238 hover_point_ = QPoint(-1, -1);
1239 update_hover_point();
1240 } else if (type == QEvent::Show) {
1242 // This is somewhat of a hack, unfortunately. We cannot use
1243 // set_v_offset() from within restore_settings() as the view
1244 // at that point is neither visible nor properly sized.
1245 // This is the least intrusive workaround I could come up
1246 // with: set the vertical offset (or scroll defaults) when
1247 // the view is shown, which happens after all widgets were
1248 // resized to their final sizes.
1251 if (settings_restored_)
1252 determine_if_header_was_shrunk();
1254 resize_header_to_fit();
1256 if (scroll_needs_defaults_) {
1257 set_scroll_default();
1258 scroll_needs_defaults_ = false;
1261 if (saved_v_offset_) {
1262 set_v_offset(saved_v_offset_);
1263 saved_v_offset_ = 0;
1267 return QObject::eventFilter(object, event);
1270 void View::resizeEvent(QResizeEvent* event)
1272 // Only adjust the top margin if we shrunk vertically
1273 if (event->size().height() < event->oldSize().height())
1274 adjust_top_margin();
1279 void View::update_hover_point()
1281 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1282 list_by_type<TraceTreeItem>());
1283 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1284 r->hover_point_changed(hover_point_);
1286 hover_point_changed(hover_point_);
1289 void View::row_item_appearance_changed(bool label, bool content)
1294 viewport_->update();
1297 void View::time_item_appearance_changed(bool label, bool content)
1302 // Make sure the header pane width is updated, too
1307 viewport_->update();
1310 void View::extents_changed(bool horz, bool vert)
1313 (horz ? TraceTreeItemHExtentsChanged : 0) |
1314 (vert ? TraceTreeItemVExtentsChanged : 0);
1316 lazy_event_handler_.start();
1319 void View::on_signal_name_changed()
1321 if (!header_was_shrunk_)
1322 resize_header_to_fit();
1325 void View::on_splitter_moved()
1327 // The header can only shrink when the splitter is moved manually
1328 determine_if_header_was_shrunk();
1330 if (!header_was_shrunk_)
1331 resize_header_to_fit();
1334 void View::h_scroll_value_changed(int value)
1336 if (updating_scroll_)
1339 // Disable sticky scrolling when user moves the horizontal scroll bar
1340 // during a running acquisition
1341 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1342 sticky_scrolling_ = false;
1343 sticky_scrolling_changed(false);
1346 const int range = scrollarea_->horizontalScrollBar()->maximum();
1347 if (range < MaxScrollValue)
1348 set_offset(scale_ * value);
1352 get_scroll_layout(length, offset);
1353 set_offset(scale_ * length * value / MaxScrollValue);
1357 viewport_->update();
1360 void View::v_scroll_value_changed()
1363 viewport_->update();
1366 void View::signals_changed()
1368 using sigrok::Channel;
1370 vector< shared_ptr<Channel> > channels;
1371 shared_ptr<sigrok::Device> sr_dev;
1372 bool signals_added_or_removed = false;
1374 // Do we need to set the vertical scrollbar to its default position later?
1375 // We do if there are no traces, i.e. the scroll bar has no range set
1376 bool reset_scrollbar =
1377 (scrollarea_->verticalScrollBar()->minimum() ==
1378 scrollarea_->verticalScrollBar()->maximum());
1380 if (!session_.device()) {
1384 sr_dev = session_.device()->device();
1386 channels = sr_dev->channels();
1389 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1391 // Make a list of traces that are being added, and a list of traces
1392 // that are being removed
1393 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1394 const set<shared_ptr<Trace>> prev_traces(
1395 prev_trace_list.begin(), prev_trace_list.end());
1397 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1399 #ifdef ENABLE_DECODE
1400 traces.insert(decode_traces_.begin(), decode_traces_.end());
1403 set< shared_ptr<Trace> > add_traces;
1404 set_difference(traces.begin(), traces.end(),
1405 prev_traces.begin(), prev_traces.end(),
1406 inserter(add_traces, add_traces.begin()));
1408 set< shared_ptr<Trace> > remove_traces;
1409 set_difference(prev_traces.begin(), prev_traces.end(),
1410 traces.begin(), traces.end(),
1411 inserter(remove_traces, remove_traces.begin()));
1413 // Make a look-up table of sigrok Channels to pulseview Signals
1414 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1416 for (const shared_ptr<Signal> &sig : signals_)
1417 signal_map[sig->base()] = sig;
1419 // Populate channel groups
1421 for (auto entry : sr_dev->channel_groups()) {
1422 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1424 if (group->channels().size() <= 1)
1427 // Find best trace group to add to
1428 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1431 // If there is no trace group, create one
1432 shared_ptr<TraceGroup> new_trace_group;
1434 new_trace_group.reset(new TraceGroup());
1435 owner = new_trace_group.get();
1438 // Extract traces for the trace group, removing them from
1440 const vector< shared_ptr<Trace> > new_traces_in_group =
1441 extract_new_traces_for_channels(group->channels(),
1442 signal_map, add_traces);
1444 // Add the traces to the group
1445 const pair<int, int> prev_v_extents = owner->v_extents();
1446 int offset = prev_v_extents.second - prev_v_extents.first;
1447 for (shared_ptr<Trace> trace : new_traces_in_group) {
1449 owner->add_child_item(trace);
1451 const pair<int, int> extents = trace->v_extents();
1452 if (trace->enabled())
1453 offset += -extents.first;
1454 trace->force_to_v_offset(offset);
1455 if (trace->enabled())
1456 offset += extents.second;
1459 if (new_trace_group) {
1460 // Assign proper vertical offsets to each channel in the group
1461 new_trace_group->restack_items();
1463 // If this is a new group, enqueue it in the new top level
1465 if (!new_traces_in_group.empty())
1466 new_top_level_items.push_back(new_trace_group);
1470 // Enqueue the remaining logic channels in a group
1471 vector< shared_ptr<Channel> > logic_channels;
1472 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1473 [](const shared_ptr<Channel>& c) {
1474 return c->type() == sigrok::ChannelType::LOGIC; });
1476 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1477 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1479 if (non_grouped_logic_signals.size() > 0) {
1480 const shared_ptr<TraceGroup> non_grouped_trace_group(
1481 make_shared<TraceGroup>());
1482 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1483 non_grouped_trace_group->add_child_item(trace);
1485 non_grouped_trace_group->restack_items();
1486 new_top_level_items.push_back(non_grouped_trace_group);
1489 // Enqueue the remaining channels as free ungrouped traces
1490 const vector< shared_ptr<Trace> > new_top_level_signals =
1491 extract_new_traces_for_channels(channels, signal_map, add_traces);
1492 new_top_level_items.insert(new_top_level_items.end(),
1493 new_top_level_signals.begin(), new_top_level_signals.end());
1495 // Enqueue any remaining traces i.e. decode traces
1496 new_top_level_items.insert(new_top_level_items.end(),
1497 add_traces.begin(), add_traces.end());
1499 // Remove any removed traces
1500 for (shared_ptr<Trace> trace : remove_traces) {
1501 TraceTreeItemOwner *const owner = trace->owner();
1503 owner->remove_child_item(trace);
1504 signals_added_or_removed = true;
1507 // Remove any empty trace groups
1508 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1509 if (group->child_items().size() == 0) {
1510 remove_child_item(group);
1514 // Add and position the pending top levels items
1515 int offset = v_extents().second;
1516 for (auto item : new_top_level_items) {
1517 add_child_item(item);
1519 // Position the item after the last item or at the top if there is none
1520 const pair<int, int> extents = item->v_extents();
1522 if (item->enabled())
1523 offset += -extents.first;
1525 item->force_to_v_offset(offset);
1527 if (item->enabled())
1528 offset += extents.second;
1529 signals_added_or_removed = true;
1533 if (signals_added_or_removed && !header_was_shrunk_)
1534 resize_header_to_fit();
1539 viewport_->update();
1541 if (reset_scrollbar)
1542 set_scroll_default();
1545 void View::capture_state_updated(int state)
1547 GlobalSettings settings;
1549 if (state == Session::Running) {
1550 set_time_unit(util::TimeUnit::Samples);
1552 trigger_markers_.clear();
1554 scale_at_acq_start_ = scale_;
1555 offset_at_acq_start_ = offset_;
1557 // Activate "always zoom to fit" if the setting is enabled and we're
1558 // the main view of this session (other trace views may be used for
1559 // zooming and we don't want to mess them up)
1560 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1561 if (is_main_view_ && state) {
1562 always_zoom_to_fit_ = true;
1563 always_zoom_to_fit_changed(always_zoom_to_fit_);
1566 // Enable sticky scrolling if the setting is enabled
1567 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1569 // Reset all traces to segment 0
1570 current_segment_ = 0;
1571 set_current_segment(current_segment_);
1574 if (state == Session::Stopped) {
1575 // After acquisition has stopped we need to re-calculate the ticks once
1576 // as it's otherwise done when the user pans or zooms, which is too late
1577 calculate_tick_spacing();
1579 // Reset "always zoom to fit", the acquisition has stopped
1580 if (always_zoom_to_fit_) {
1581 // Perform a final zoom-to-fit before disabling
1582 zoom_fit(always_zoom_to_fit_);
1583 always_zoom_to_fit_ = false;
1584 always_zoom_to_fit_changed(always_zoom_to_fit_);
1587 bool zoom_to_fit_after_acq =
1588 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1590 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1591 // we didn't restore settings in the meanwhile
1592 if (zoom_to_fit_after_acq &&
1593 !suppress_zoom_to_fit_after_acq_ &&
1594 (scale_ == scale_at_acq_start_) &&
1595 (offset_ == offset_at_acq_start_))
1596 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1598 suppress_zoom_to_fit_after_acq_ = false;
1602 void View::on_new_segment(int new_segment_id)
1604 on_segment_changed(new_segment_id);
1607 void View::on_segment_completed(int segment_id)
1609 on_segment_changed(segment_id);
1612 void View::on_segment_changed(int segment)
1614 switch (segment_display_mode_) {
1615 case Trace::ShowLastSegmentOnly:
1616 case Trace::ShowSingleSegmentOnly:
1617 set_current_segment(segment);
1620 case Trace::ShowLastCompleteSegmentOnly:
1621 // Only update if all segments are complete
1622 if (session_.all_segments_complete(segment))
1623 set_current_segment(segment);
1626 case Trace::ShowAllSegments:
1627 case Trace::ShowAccumulatedIntensity:
1633 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1635 if (new_value.toBool()) {
1636 // The first trigger for this segment is used as the zero position
1637 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1638 if (triggers.size() > 0)
1639 set_zero_position(triggers.front());
1641 reset_zero_position();
1644 void View::perform_delayed_view_update()
1646 if (always_zoom_to_fit_) {
1648 } else if (sticky_scrolling_) {
1649 // Make right side of the view sticky
1652 get_scroll_layout(length, offset);
1654 const QSize areaSize = viewport_->size();
1655 length = max(length - areaSize.width(), 0.0);
1657 set_offset(scale_ * length);
1660 determine_time_unit();
1663 viewport_->update();
1666 void View::process_sticky_events()
1668 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1670 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1671 restack_all_trace_tree_items();
1675 // Clear the sticky events
1679 } // namespace trace
1680 } // namespace views