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;
251 // Update the zoom state
252 calculate_tick_spacing();
254 // Make sure the standard bar's segment selector is in sync
255 set_segment_display_mode(segment_display_mode_);
258 Session& View::session()
263 const Session& View::session() const
268 unordered_set< shared_ptr<Signal> > View::signals() const
273 void View::clear_signals()
275 ViewBase::clear_signalbases();
279 void View::add_signal(const shared_ptr<Signal> signal)
281 ViewBase::add_signalbase(signal->base());
282 signals_.insert(signal);
284 signal->set_segment_display_mode(segment_display_mode_);
285 signal->set_current_segment(current_segment_);
287 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
288 this, SLOT(on_signal_name_changed()));
292 void View::clear_decode_signals()
294 decode_traces_.clear();
297 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
299 shared_ptr<DecodeTrace> d(
300 new DecodeTrace(session_, signal, decode_traces_.size()));
301 decode_traces_.push_back(d);
303 d->set_segment_display_mode(segment_display_mode_);
304 d->set_current_segment(current_segment_);
306 connect(signal.get(), SIGNAL(name_changed(const QString&)),
307 this, SLOT(on_signal_name_changed()));
310 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
312 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
313 if ((*i)->base() == signal) {
314 decode_traces_.erase(i);
326 const View* View::view() const
331 Viewport* View::viewport()
336 const Viewport* View::viewport() const
341 void View::save_settings(QSettings &settings) const
343 settings.setValue("scale", scale_);
344 settings.setValue("v_offset",
345 scrollarea_->verticalScrollBar()->sliderPosition());
347 settings.setValue("splitter_state", splitter_->saveState());
348 settings.setValue("segment_display_mode", segment_display_mode_);
352 boost::archive::text_oarchive oa(ss);
353 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
354 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
358 boost::archive::text_oarchive oa(ss);
359 oa << boost::serialization::make_nvp("offset", offset_);
360 settings.setValue("offset", QString::fromStdString(ss.str()));
363 for (shared_ptr<Signal> signal : signals_) {
364 settings.beginGroup(signal->base()->internal_name());
365 signal->save_settings(settings);
370 void View::restore_settings(QSettings &settings)
372 // Note: It is assumed that this function is only called once,
373 // immediately after restoring a previous session.
375 if (settings.contains("scale"))
376 set_scale(settings.value("scale").toDouble());
378 if (settings.contains("ruler_shift")) {
379 util::Timestamp shift;
381 ss << settings.value("ruler_shift").toString().toStdString();
384 boost::archive::text_iarchive ia(ss);
385 ia >> boost::serialization::make_nvp("ruler_shift", shift);
386 ruler_shift_ = shift;
387 } catch (boost::archive::archive_exception) {
388 qDebug() << "Could not restore the view ruler shift";
392 if (settings.contains("offset")) {
393 util::Timestamp offset;
395 ss << settings.value("offset").toString().toStdString();
398 boost::archive::text_iarchive ia(ss);
399 ia >> boost::serialization::make_nvp("offset", offset);
400 // This also updates ruler_offset_
402 } catch (boost::archive::archive_exception) {
403 qDebug() << "Could not restore the view offset";
407 if (settings.contains("splitter_state"))
408 splitter_->restoreState(settings.value("splitter_state").toByteArray());
410 if (settings.contains("segment_display_mode"))
411 set_segment_display_mode(
412 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
414 for (shared_ptr<Signal> signal : signals_) {
415 settings.beginGroup(signal->base()->internal_name());
416 signal->restore_settings(settings);
420 if (settings.contains("v_offset")) {
421 saved_v_offset_ = settings.value("v_offset").toInt();
422 set_v_offset(saved_v_offset_);
423 scroll_needs_defaults_ = false;
424 // Note: see eventFilter() for additional information
427 settings_restored_ = true;
428 suppress_zoom_to_fit_after_acq_ = true;
430 // Update the ruler so that it uses the new scale
431 calculate_tick_spacing();
434 vector< shared_ptr<TimeItem> > View::time_items() const
436 const vector<shared_ptr<Flag>> f(flags());
437 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
440 items.push_back(cursors_);
441 items.push_back(cursors_->first());
442 items.push_back(cursors_->second());
445 for (auto trigger_marker : trigger_markers_)
446 items.push_back(trigger_marker);
451 double View::scale() const
456 void View::set_scale(double scale)
458 if (scale_ != scale) {
464 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
466 if ((offset_ != offset) || force_update) {
468 ruler_offset_ = offset_ + ruler_shift_;
473 const Timestamp& View::offset() const
478 const Timestamp& View::ruler_offset() const
480 return ruler_offset_;
483 void View::set_zero_position(pv::util::Timestamp& position)
485 ruler_shift_ = -position;
487 // Force an immediate update of the offsets
488 set_offset(offset_, true);
492 void View::reset_zero_position()
496 // Force an immediate update of the offsets
497 set_offset(offset_, true);
501 int View::owner_visual_v_offset() const
503 return -scrollarea_->verticalScrollBar()->sliderPosition();
506 void View::set_v_offset(int offset)
508 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
513 unsigned int View::depth() const
518 uint32_t View::current_segment() const
520 return current_segment_;
523 pv::util::SIPrefix View::tick_prefix() const
528 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
530 if (tick_prefix_ != tick_prefix) {
531 tick_prefix_ = tick_prefix;
532 tick_prefix_changed();
536 unsigned int View::tick_precision() const
538 return tick_precision_;
541 void View::set_tick_precision(unsigned tick_precision)
543 if (tick_precision_ != tick_precision) {
544 tick_precision_ = tick_precision;
545 tick_precision_changed();
549 const pv::util::Timestamp& View::tick_period() const
554 unsigned int View::minor_tick_count() const
556 return minor_tick_count_;
559 void View::set_tick_period(const pv::util::Timestamp& tick_period)
561 if (tick_period_ != tick_period) {
562 tick_period_ = tick_period;
563 tick_period_changed();
567 TimeUnit View::time_unit() const
572 void View::set_time_unit(pv::util::TimeUnit time_unit)
574 if (time_unit_ != time_unit) {
575 time_unit_ = time_unit;
580 void View::set_current_segment(uint32_t segment_id)
582 current_segment_ = segment_id;
584 for (shared_ptr<Signal> signal : signals_)
585 signal->set_current_segment(current_segment_);
587 for (shared_ptr<DecodeTrace> dt : decode_traces_)
588 dt->set_current_segment(current_segment_);
591 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
593 trigger_markers_.clear();
594 for (util::Timestamp timestamp : triggers)
595 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
597 // When enabled, the first trigger for this segment is used as the zero position
598 GlobalSettings settings;
599 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
601 if (trigger_is_zero_time && (triggers.size() > 0))
602 set_zero_position(triggers.front());
606 segment_changed(segment_id);
609 bool View::segment_is_selectable() const
611 return segment_selectable_;
614 Trace::SegmentDisplayMode View::segment_display_mode() const
616 return segment_display_mode_;
619 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
621 trigger_markers_.clear();
623 segment_display_mode_ = mode;
625 for (shared_ptr<Signal> signal : signals_)
626 signal->set_segment_display_mode(mode);
628 uint32_t last_segment = session_.get_segment_count() - 1;
631 case Trace::ShowLastSegmentOnly:
632 if (current_segment_ != last_segment)
633 set_current_segment(last_segment);
636 case Trace::ShowLastCompleteSegmentOnly:
637 // Do nothing if we only have one segment so far
638 if (last_segment > 0) {
639 // If the last segment isn't complete, the previous one must be
640 uint32_t segment_id =
641 (session_.all_segments_complete(last_segment)) ?
642 last_segment : last_segment - 1;
644 if (current_segment_ != segment_id)
645 set_current_segment(segment_id);
649 case Trace::ShowSingleSegmentOnly:
650 case Trace::ShowAllSegments:
651 case Trace::ShowAccumulatedIntensity:
653 // Current segment remains as-is
657 segment_selectable_ = true;
659 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
660 segment_selectable_ = false;
664 segment_display_mode_changed((int)mode, segment_selectable_);
667 void View::zoom(double steps)
669 zoom(steps, viewport_->width() / 2);
672 void View::zoom(double steps, int offset)
674 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
677 void View::zoom_fit(bool gui_state)
679 // Act as one-shot when stopped, toggle along with the GUI otherwise
680 if (session_.get_capture_state() == Session::Stopped) {
681 always_zoom_to_fit_ = false;
682 always_zoom_to_fit_changed(false);
684 always_zoom_to_fit_ = gui_state;
685 always_zoom_to_fit_changed(gui_state);
688 const pair<Timestamp, Timestamp> extents = get_time_extents();
689 const Timestamp delta = extents.second - extents.first;
690 if (delta < Timestamp("1e-12"))
694 const int w = viewport_->width();
698 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
699 set_scale_offset(scale.convert_to<double>(), extents.first);
702 void View::zoom_one_to_one()
704 using pv::data::SignalData;
706 // Make a set of all the visible data objects
707 set< shared_ptr<SignalData> > visible_data = get_visible_data();
708 if (visible_data.empty())
712 const int w = viewport_->width();
716 set_zoom(1.0 / session_.get_samplerate(), w / 2);
719 void View::set_scale_offset(double scale, const Timestamp& offset)
721 // Disable sticky scrolling / always zoom to fit when acquisition runs
722 // and user drags the viewport
723 if ((scale_ == scale) && (offset_ != offset) &&
724 (session_.get_capture_state() == Session::Running)) {
726 if (sticky_scrolling_) {
727 sticky_scrolling_ = false;
728 sticky_scrolling_changed(false);
731 if (always_zoom_to_fit_) {
732 always_zoom_to_fit_ = false;
733 always_zoom_to_fit_changed(false);
740 calculate_tick_spacing();
747 set< shared_ptr<SignalData> > View::get_visible_data() const
749 // Make a set of all the visible data objects
750 set< shared_ptr<SignalData> > visible_data;
751 for (const shared_ptr<Signal> sig : signals_)
753 visible_data.insert(sig->data());
758 pair<Timestamp, Timestamp> View::get_time_extents() const
760 boost::optional<Timestamp> left_time, right_time;
761 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
762 for (const shared_ptr<SignalData> d : visible_data) {
763 const vector< shared_ptr<Segment> > segments = d->segments();
764 for (const shared_ptr<Segment> &s : segments) {
765 double samplerate = s->samplerate();
766 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
768 const Timestamp start_time = s->start_time();
769 left_time = left_time ?
770 min(*left_time, start_time) :
772 right_time = right_time ?
773 max(*right_time, start_time + d->max_sample_count() / samplerate) :
774 start_time + d->max_sample_count() / samplerate;
778 if (!left_time || !right_time)
779 return make_pair(0, 0);
781 assert(*left_time < *right_time);
782 return make_pair(*left_time, *right_time);
785 void View::enable_show_sampling_points(bool state)
792 void View::enable_show_analog_minor_grid(bool state)
799 void View::enable_colored_bg(bool state)
805 bool View::colored_bg() const
810 bool View::cursors_shown() const
812 return show_cursors_;
815 void View::show_cursors(bool show)
817 show_cursors_ = show;
822 void View::centre_cursors()
825 const double time_width = scale_ * viewport_->width();
826 cursors_->first()->set_time(offset_ + time_width * 0.4);
827 cursors_->second()->set_time(offset_ + time_width * 0.6);
834 shared_ptr<CursorPair> View::cursors() const
839 void View::add_flag(const Timestamp& time)
841 flags_.push_back(make_shared<Flag>(*this, time,
842 QString("%1").arg(next_flag_text_)));
844 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
845 (next_flag_text_ + 1);
847 time_item_appearance_changed(true, true);
850 void View::remove_flag(shared_ptr<Flag> flag)
853 time_item_appearance_changed(true, true);
856 vector< shared_ptr<Flag> > View::flags() const
858 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
859 stable_sort(flags.begin(), flags.end(),
860 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
861 return a->time() < b->time();
867 const QPoint& View::hover_point() const
872 void View::restack_all_trace_tree_items()
874 // Make a list of owners that is sorted from deepest first
875 const vector<shared_ptr<TraceTreeItem>> items(
876 list_by_type<TraceTreeItem>());
877 set< TraceTreeItemOwner* > owners;
878 for (const auto &r : items)
879 owners.insert(r->owner());
880 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
881 sort(sorted_owners.begin(), sorted_owners.end(),
882 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
883 return a->depth() > b->depth(); });
885 // Restack the items recursively
886 for (auto &o : sorted_owners)
889 // Animate the items to their destination
890 for (const auto &i : items)
891 i->animate_to_layout_v_offset();
894 void View::on_setting_changed(const QString &key, const QVariant &value)
896 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
897 on_settingViewTriggerIsZeroTime_changed(value);
900 void View::trigger_event(int segment_id, util::Timestamp location)
902 // TODO This doesn't work if we're showing multiple segments at once
903 if ((uint32_t)segment_id != current_segment_)
906 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
907 // if this is the first trigger for this segment.
908 GlobalSettings settings;
909 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
911 size_t trigger_count = session_.get_triggers(current_segment_).size();
913 if (trigger_is_zero_time && trigger_count == 1)
914 set_zero_position(location);
916 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
919 void View::get_scroll_layout(double &length, Timestamp &offset) const
921 const pair<Timestamp, Timestamp> extents = get_time_extents();
922 length = ((extents.second - extents.first) / scale_).convert_to<double>();
923 offset = offset_ / scale_;
926 void View::set_zoom(double scale, int offset)
928 // Reset the "always zoom to fit" feature as the user changed the zoom
929 always_zoom_to_fit_ = false;
930 always_zoom_to_fit_changed(false);
932 const Timestamp cursor_offset = offset_ + scale_ * offset;
933 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
934 const Timestamp new_offset = cursor_offset - new_scale * offset;
935 set_scale_offset(new_scale.convert_to<double>(), new_offset);
938 void View::calculate_tick_spacing()
940 const double SpacingIncrement = 10.0f;
941 const double MinValueSpacing = 40.0f;
943 // Figure out the highest numeric value visible on a label
944 const QSize areaSize = viewport_->size();
945 const Timestamp max_time = max(fabs(offset_),
946 fabs(offset_ + scale_ * areaSize.width()));
948 double min_width = SpacingIncrement;
949 double label_width, tick_period_width;
951 QFontMetrics m(QApplication::font());
953 // Copies of the member variables with the same name, used in the calculation
954 // and written back afterwards, so that we don't emit signals all the time
955 // during the calculation.
956 pv::util::Timestamp tick_period = tick_period_;
957 pv::util::SIPrefix tick_prefix = tick_prefix_;
958 unsigned tick_precision = tick_precision_;
961 const double min_period = scale_ * min_width;
963 const int order = (int)floorf(log10f(min_period));
964 const pv::util::Timestamp order_decimal =
965 pow(pv::util::Timestamp(10), order);
967 // Allow for a margin of error so that a scale unit of 1 can be used.
968 // Otherwise, for a SU of 1 the tick period will almost always be below
969 // the min_period by a small amount - and thus skipped in favor of 2.
970 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
971 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
972 double tp_with_margin;
973 unsigned int unit = 0;
976 tp_with_margin = order_decimal.convert_to<double>() *
977 (ScaleUnits[unit++] + tp_margin);
978 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
980 minor_tick_count_ = (unit == 2) ? 4 : 5;
981 tick_period = order_decimal * ScaleUnits[unit - 1];
982 tick_prefix = static_cast<pv::util::SIPrefix>(
983 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
985 // Precision is the number of fractional digits required, not
986 // taking the prefix into account (and it must never be negative)
987 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
989 tick_period_width = (tick_period / scale_).convert_to<double>();
991 const QString label_text = Ruler::format_time_with_distance(
992 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
994 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
995 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
998 min_width += SpacingIncrement;
999 } while (tick_period_width < label_width);
1001 set_tick_period(tick_period);
1002 set_tick_prefix(tick_prefix);
1003 set_tick_precision(tick_precision);
1006 void View::adjust_top_margin()
1010 const QSize areaSize = viewport_->size();
1012 const pair<int, int> extents = v_extents();
1013 const int top_margin = owner_visual_v_offset() + extents.first;
1014 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1016 // Do we have empty space at the top while the last trace goes out of screen?
1017 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1018 const int trace_height = extents.second - extents.first;
1020 // Center everything vertically if there is enough space
1021 if (areaSize.height() >= trace_height)
1022 set_v_offset(extents.first -
1023 ((areaSize.height() - trace_height) / 2));
1025 // Remove the top margin to make as many traces fit on screen as possible
1026 set_v_offset(extents.first);
1030 void View::update_scroll()
1033 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1034 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1036 const QSize areaSize = viewport_->size();
1038 // Set the horizontal scroll bar
1041 get_scroll_layout(length, offset);
1042 length = max(length - areaSize.width(), 0.0);
1044 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1046 hscrollbar->setPageStep(areaSize.width() / 2);
1047 hscrollbar->setSingleStep(major_tick_distance);
1049 updating_scroll_ = true;
1051 if (length < MaxScrollValue) {
1052 hscrollbar->setRange(0, length);
1053 hscrollbar->setSliderPosition(offset.convert_to<double>());
1055 hscrollbar->setRange(0, MaxScrollValue);
1056 hscrollbar->setSliderPosition(
1057 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1060 updating_scroll_ = false;
1062 // Set the vertical scrollbar
1063 vscrollbar->setPageStep(areaSize.height());
1064 vscrollbar->setSingleStep(areaSize.height() / 8);
1066 const pair<int, int> extents = v_extents();
1068 // Don't change the scrollbar range if there are no traces
1069 if (extents.first != extents.second)
1070 vscrollbar->setRange(extents.first - areaSize.height(),
1073 if (scroll_needs_defaults_)
1074 set_scroll_default();
1077 void View::reset_scroll()
1079 scrollarea_->verticalScrollBar()->setRange(0, 0);
1082 void View::set_scroll_default()
1086 const QSize areaSize = viewport_->size();
1088 const pair<int, int> extents = v_extents();
1089 const int trace_height = extents.second - extents.first;
1091 // Do all traces fit in the view?
1092 if (areaSize.height() >= trace_height)
1093 // Center all traces vertically
1094 set_v_offset(extents.first -
1095 ((areaSize.height() - trace_height) / 2));
1097 // Put the first trace at the top, letting the bottom ones overflow
1098 set_v_offset(extents.first);
1101 void View::determine_if_header_was_shrunk()
1103 const int header_pane_width = splitter_->sizes().front();
1104 const int header_width = header_->extended_size_hint().width();
1106 // Allow for a slight margin of error so that we also accept
1107 // slight differences when e.g. a label name change increased
1108 // the overall width
1109 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1112 void View::resize_header_to_fit()
1114 // Setting the maximum width of the header widget doesn't work as
1115 // expected because the splitter would allow the user to make the
1116 // pane wider than that, creating empty space as a result.
1117 // To make this work, we stricly enforce the maximum width by
1118 // expanding the header unless the user shrunk it on purpose.
1119 // As we're then setting the width of the header pane, we set the
1120 // splitter to the maximum allowed position.
1122 int splitter_area_width = 0;
1123 for (int w : splitter_->sizes())
1124 splitter_area_width += w;
1126 // Make sure the header has enough horizontal space to show all labels fully
1127 QList<int> pane_sizes;
1128 pane_sizes.push_back(header_->extended_size_hint().width());
1129 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1130 splitter_->setSizes(pane_sizes);
1133 void View::update_layout()
1138 TraceTreeItemOwner* View::find_prevalent_trace_group(
1139 const shared_ptr<sigrok::ChannelGroup> &group,
1140 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1145 unordered_set<TraceTreeItemOwner*> owners;
1146 vector<TraceTreeItemOwner*> owner_list;
1148 // Make a set and a list of all the owners
1149 for (const auto &channel : group->channels()) {
1150 for (auto entry : signal_map) {
1151 if (entry.first->channel() == channel) {
1152 TraceTreeItemOwner *const o = (entry.second)->owner();
1153 owner_list.push_back(o);
1159 // Iterate through the list of owners, and find the most prevalent
1160 size_t max_prevalence = 0;
1161 TraceTreeItemOwner *prevalent_owner = nullptr;
1162 for (TraceTreeItemOwner *owner : owners) {
1163 const size_t prevalence = count_if(
1164 owner_list.begin(), owner_list.end(),
1165 [&](TraceTreeItemOwner *o) { return o == owner; });
1166 if (prevalence > max_prevalence) {
1167 max_prevalence = prevalence;
1168 prevalent_owner = owner;
1172 return prevalent_owner;
1175 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1176 const vector< shared_ptr<sigrok::Channel> > &channels,
1177 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1179 set< shared_ptr<Trace> > &add_list)
1181 vector< shared_ptr<Trace> > filtered_traces;
1183 for (const auto &channel : channels) {
1184 for (auto entry : signal_map) {
1185 if (entry.first->channel() == channel) {
1186 shared_ptr<Trace> trace = entry.second;
1187 const auto list_iter = add_list.find(trace);
1188 if (list_iter == add_list.end())
1191 filtered_traces.push_back(trace);
1192 add_list.erase(list_iter);
1197 return filtered_traces;
1200 void View::determine_time_unit()
1202 // Check whether we know the sample rate and hence can use time as the unit
1203 if (time_unit_ == util::TimeUnit::Samples) {
1204 // Check all signals but...
1205 for (const shared_ptr<Signal> signal : signals_) {
1206 const shared_ptr<SignalData> data = signal->data();
1208 // ...only check first segment of each
1209 const vector< shared_ptr<Segment> > segments = data->segments();
1210 if (!segments.empty())
1211 if (segments[0]->samplerate()) {
1212 set_time_unit(util::TimeUnit::Time);
1219 bool View::eventFilter(QObject *object, QEvent *event)
1221 const QEvent::Type type = event->type();
1222 if (type == QEvent::MouseMove) {
1224 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1225 if (object == viewport_)
1226 hover_point_ = mouse_event->pos();
1227 else if (object == ruler_)
1228 hover_point_ = QPoint(mouse_event->x(), 0);
1229 else if (object == header_)
1230 hover_point_ = QPoint(0, mouse_event->y());
1232 hover_point_ = QPoint(-1, -1);
1234 update_hover_point();
1236 } else if (type == QEvent::Leave) {
1237 hover_point_ = QPoint(-1, -1);
1238 update_hover_point();
1239 } else if (type == QEvent::Show) {
1241 // This is somewhat of a hack, unfortunately. We cannot use
1242 // set_v_offset() from within restore_settings() as the view
1243 // at that point is neither visible nor properly sized.
1244 // This is the least intrusive workaround I could come up
1245 // with: set the vertical offset (or scroll defaults) when
1246 // the view is shown, which happens after all widgets were
1247 // resized to their final sizes.
1250 if (settings_restored_)
1251 determine_if_header_was_shrunk();
1253 resize_header_to_fit();
1255 if (scroll_needs_defaults_) {
1256 set_scroll_default();
1257 scroll_needs_defaults_ = false;
1260 if (saved_v_offset_) {
1261 set_v_offset(saved_v_offset_);
1262 saved_v_offset_ = 0;
1266 return QObject::eventFilter(object, event);
1269 void View::resizeEvent(QResizeEvent* event)
1271 // Only adjust the top margin if we shrunk vertically
1272 if (event->size().height() < event->oldSize().height())
1273 adjust_top_margin();
1278 void View::update_hover_point()
1280 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1281 list_by_type<TraceTreeItem>());
1282 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1283 r->hover_point_changed(hover_point_);
1285 hover_point_changed(hover_point_);
1288 void View::row_item_appearance_changed(bool label, bool content)
1293 viewport_->update();
1296 void View::time_item_appearance_changed(bool label, bool content)
1301 // Make sure the header pane width is updated, too
1306 viewport_->update();
1309 void View::extents_changed(bool horz, bool vert)
1312 (horz ? TraceTreeItemHExtentsChanged : 0) |
1313 (vert ? TraceTreeItemVExtentsChanged : 0);
1315 lazy_event_handler_.start();
1318 void View::on_signal_name_changed()
1320 if (!header_was_shrunk_)
1321 resize_header_to_fit();
1324 void View::on_splitter_moved()
1326 // The header can only shrink when the splitter is moved manually
1327 determine_if_header_was_shrunk();
1329 if (!header_was_shrunk_)
1330 resize_header_to_fit();
1333 void View::h_scroll_value_changed(int value)
1335 if (updating_scroll_)
1338 // Disable sticky scrolling when user moves the horizontal scroll bar
1339 // during a running acquisition
1340 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1341 sticky_scrolling_ = false;
1342 sticky_scrolling_changed(false);
1345 const int range = scrollarea_->horizontalScrollBar()->maximum();
1346 if (range < MaxScrollValue)
1347 set_offset(scale_ * value);
1351 get_scroll_layout(length, offset);
1352 set_offset(scale_ * length * value / MaxScrollValue);
1356 viewport_->update();
1359 void View::v_scroll_value_changed()
1362 viewport_->update();
1365 void View::signals_changed()
1367 using sigrok::Channel;
1369 vector< shared_ptr<Channel> > channels;
1370 shared_ptr<sigrok::Device> sr_dev;
1371 bool signals_added_or_removed = false;
1373 // Do we need to set the vertical scrollbar to its default position later?
1374 // We do if there are no traces, i.e. the scroll bar has no range set
1375 bool reset_scrollbar =
1376 (scrollarea_->verticalScrollBar()->minimum() ==
1377 scrollarea_->verticalScrollBar()->maximum());
1379 if (!session_.device()) {
1383 sr_dev = session_.device()->device();
1385 channels = sr_dev->channels();
1388 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1390 // Make a list of traces that are being added, and a list of traces
1391 // that are being removed
1392 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1393 const set<shared_ptr<Trace>> prev_traces(
1394 prev_trace_list.begin(), prev_trace_list.end());
1396 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1398 #ifdef ENABLE_DECODE
1399 traces.insert(decode_traces_.begin(), decode_traces_.end());
1402 set< shared_ptr<Trace> > add_traces;
1403 set_difference(traces.begin(), traces.end(),
1404 prev_traces.begin(), prev_traces.end(),
1405 inserter(add_traces, add_traces.begin()));
1407 set< shared_ptr<Trace> > remove_traces;
1408 set_difference(prev_traces.begin(), prev_traces.end(),
1409 traces.begin(), traces.end(),
1410 inserter(remove_traces, remove_traces.begin()));
1412 // Make a look-up table of sigrok Channels to pulseview Signals
1413 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1415 for (const shared_ptr<Signal> &sig : signals_)
1416 signal_map[sig->base()] = sig;
1418 // Populate channel groups
1420 for (auto entry : sr_dev->channel_groups()) {
1421 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1423 if (group->channels().size() <= 1)
1426 // Find best trace group to add to
1427 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1430 // If there is no trace group, create one
1431 shared_ptr<TraceGroup> new_trace_group;
1433 new_trace_group.reset(new TraceGroup());
1434 owner = new_trace_group.get();
1437 // Extract traces for the trace group, removing them from
1439 const vector< shared_ptr<Trace> > new_traces_in_group =
1440 extract_new_traces_for_channels(group->channels(),
1441 signal_map, add_traces);
1443 // Add the traces to the group
1444 const pair<int, int> prev_v_extents = owner->v_extents();
1445 int offset = prev_v_extents.second - prev_v_extents.first;
1446 for (shared_ptr<Trace> trace : new_traces_in_group) {
1448 owner->add_child_item(trace);
1450 const pair<int, int> extents = trace->v_extents();
1451 if (trace->enabled())
1452 offset += -extents.first;
1453 trace->force_to_v_offset(offset);
1454 if (trace->enabled())
1455 offset += extents.second;
1458 if (new_trace_group) {
1459 // Assign proper vertical offsets to each channel in the group
1460 new_trace_group->restack_items();
1462 // If this is a new group, enqueue it in the new top level
1464 if (!new_traces_in_group.empty())
1465 new_top_level_items.push_back(new_trace_group);
1469 // Enqueue the remaining logic channels in a group
1470 vector< shared_ptr<Channel> > logic_channels;
1471 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1472 [](const shared_ptr<Channel>& c) {
1473 return c->type() == sigrok::ChannelType::LOGIC; });
1475 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1476 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1478 if (non_grouped_logic_signals.size() > 0) {
1479 const shared_ptr<TraceGroup> non_grouped_trace_group(
1480 make_shared<TraceGroup>());
1481 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1482 non_grouped_trace_group->add_child_item(trace);
1484 non_grouped_trace_group->restack_items();
1485 new_top_level_items.push_back(non_grouped_trace_group);
1488 // Enqueue the remaining channels as free ungrouped traces
1489 const vector< shared_ptr<Trace> > new_top_level_signals =
1490 extract_new_traces_for_channels(channels, signal_map, add_traces);
1491 new_top_level_items.insert(new_top_level_items.end(),
1492 new_top_level_signals.begin(), new_top_level_signals.end());
1494 // Enqueue any remaining traces i.e. decode traces
1495 new_top_level_items.insert(new_top_level_items.end(),
1496 add_traces.begin(), add_traces.end());
1498 // Remove any removed traces
1499 for (shared_ptr<Trace> trace : remove_traces) {
1500 TraceTreeItemOwner *const owner = trace->owner();
1502 owner->remove_child_item(trace);
1503 signals_added_or_removed = true;
1506 // Remove any empty trace groups
1507 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1508 if (group->child_items().size() == 0) {
1509 remove_child_item(group);
1513 // Add and position the pending top levels items
1514 int offset = v_extents().second;
1515 for (auto item : new_top_level_items) {
1516 add_child_item(item);
1518 // Position the item after the last item or at the top if there is none
1519 const pair<int, int> extents = item->v_extents();
1521 if (item->enabled())
1522 offset += -extents.first;
1524 item->force_to_v_offset(offset);
1526 if (item->enabled())
1527 offset += extents.second;
1528 signals_added_or_removed = true;
1532 if (signals_added_or_removed && !header_was_shrunk_)
1533 resize_header_to_fit();
1538 viewport_->update();
1540 if (reset_scrollbar)
1541 set_scroll_default();
1544 void View::capture_state_updated(int state)
1546 GlobalSettings settings;
1548 if (state == Session::Running) {
1549 set_time_unit(util::TimeUnit::Samples);
1551 trigger_markers_.clear();
1553 scale_at_acq_start_ = scale_;
1554 offset_at_acq_start_ = offset_;
1556 // Activate "always zoom to fit" if the setting is enabled and we're
1557 // the main view of this session (other trace views may be used for
1558 // zooming and we don't want to mess them up)
1559 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1560 if (is_main_view_ && state) {
1561 always_zoom_to_fit_ = true;
1562 always_zoom_to_fit_changed(always_zoom_to_fit_);
1565 // Enable sticky scrolling if the setting is enabled
1566 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1568 // Reset all traces to segment 0
1569 current_segment_ = 0;
1570 set_current_segment(current_segment_);
1573 if (state == Session::Stopped) {
1574 // After acquisition has stopped we need to re-calculate the ticks once
1575 // as it's otherwise done when the user pans or zooms, which is too late
1576 calculate_tick_spacing();
1578 // Reset "always zoom to fit", the acquisition has stopped
1579 if (always_zoom_to_fit_) {
1580 // Perform a final zoom-to-fit before disabling
1581 zoom_fit(always_zoom_to_fit_);
1582 always_zoom_to_fit_ = false;
1583 always_zoom_to_fit_changed(always_zoom_to_fit_);
1586 bool zoom_to_fit_after_acq =
1587 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1589 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1590 // we didn't restore settings in the meanwhile
1591 if (zoom_to_fit_after_acq &&
1592 !suppress_zoom_to_fit_after_acq_ &&
1593 (scale_ == scale_at_acq_start_) &&
1594 (offset_ == offset_at_acq_start_))
1595 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1597 suppress_zoom_to_fit_after_acq_ = false;
1601 void View::on_new_segment(int new_segment_id)
1603 on_segment_changed(new_segment_id);
1606 void View::on_segment_completed(int segment_id)
1608 on_segment_changed(segment_id);
1611 void View::on_segment_changed(int segment)
1613 switch (segment_display_mode_) {
1614 case Trace::ShowLastSegmentOnly:
1615 case Trace::ShowSingleSegmentOnly:
1616 set_current_segment(segment);
1619 case Trace::ShowLastCompleteSegmentOnly:
1620 // Only update if all segments are complete
1621 if (session_.all_segments_complete(segment))
1622 set_current_segment(segment);
1625 case Trace::ShowAllSegments:
1626 case Trace::ShowAccumulatedIntensity:
1632 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1634 if (new_value.toBool()) {
1635 // The first trigger for this segment is used as the zero position
1636 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1637 if (triggers.size() > 0)
1638 set_zero_position(triggers.front());
1640 reset_zero_position();
1643 void View::perform_delayed_view_update()
1645 if (always_zoom_to_fit_) {
1647 } else if (sticky_scrolling_) {
1648 // Make right side of the view sticky
1651 get_scroll_layout(length, offset);
1653 const QSize areaSize = viewport_->size();
1654 length = max(length - areaSize.width(), 0.0);
1656 set_offset(scale_ * length);
1659 determine_time_unit();
1662 viewport_->update();
1665 void View::process_sticky_events()
1667 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1669 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1670 restack_all_trace_tree_items();
1674 // Clear the sticky events
1678 } // namespace trace
1679 } // namespace views