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),
127 splitter_(new QSplitter()),
128 segment_display_mode_(Trace::ShowLastSegmentOnly),
129 segment_selectable_(false),
133 updating_scroll_(false),
134 settings_restored_(false),
135 header_was_shrunk_(false),
136 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
137 always_zoom_to_fit_(false),
139 tick_prefix_(pv::util::SIPrefix::yocto),
141 time_unit_(util::TimeUnit::Time),
142 show_cursors_(false),
143 cursors_(new CursorPair(*this)),
144 next_flag_text_('A'),
146 hover_point_(-1, -1),
147 scroll_needs_defaults_(true),
149 scale_at_acq_start_(0),
150 offset_at_acq_start_(0),
151 suppress_zoom_to_fit_after_acq_(false)
153 QVBoxLayout *root_layout = new QVBoxLayout(this);
154 root_layout->setContentsMargins(0, 0, 0, 0);
155 root_layout->addWidget(splitter_);
157 viewport_ = new Viewport(*this);
158 scrollarea_ = new CustomScrollArea(splitter_);
159 scrollarea_->setViewport(viewport_);
160 scrollarea_->setFrameShape(QFrame::NoFrame);
162 ruler_ = new Ruler(*this);
164 header_ = new Header(*this);
165 header_->setMinimumWidth(10); // So that the arrow tips show at least
167 // We put the header into a simple layout so that we can add the top margin,
168 // allowing us to make it line up with the bottom of the ruler
169 QWidget *header_container = new QWidget();
170 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
171 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
172 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
173 header_layout->addWidget(header_);
175 // To let the ruler and scrollarea be on the same split pane, we need a layout
176 QWidget *trace_container = new QWidget();
177 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
178 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
179 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
180 trace_layout->setContentsMargins(0, 0, 0, 0);
181 trace_layout->addWidget(ruler_);
182 trace_layout->addWidget(scrollarea_);
184 splitter_->addWidget(header_container);
185 splitter_->addWidget(trace_container);
186 splitter_->setHandleWidth(1); // Don't show a visible rubber band
187 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
188 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
189 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
190 splitter_->setStretchFactor(1, 1); // when the entire view is resized
191 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
193 viewport_->installEventFilter(this);
194 ruler_->installEventFilter(this);
195 header_->installEventFilter(this);
197 // Set up settings and event handlers
198 GlobalSettings settings;
199 colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
201 GlobalSettings::add_change_handler(this);
203 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
204 this, SLOT(h_scroll_value_changed(int)));
205 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
206 this, SLOT(v_scroll_value_changed()));
208 connect(header_, SIGNAL(selection_changed()),
209 ruler_, SLOT(clear_selection()));
210 connect(ruler_, SIGNAL(selection_changed()),
211 header_, SLOT(clear_selection()));
213 connect(header_, SIGNAL(selection_changed()),
214 this, SIGNAL(selection_changed()));
215 connect(ruler_, SIGNAL(selection_changed()),
216 this, SIGNAL(selection_changed()));
218 connect(splitter_, SIGNAL(splitterMoved(int, int)),
219 this, SLOT(on_splitter_moved()));
221 connect(&lazy_event_handler_, SIGNAL(timeout()),
222 this, SLOT(process_sticky_events()));
223 lazy_event_handler_.setSingleShot(true);
225 // Trigger the initial event manually. The default device has signals
226 // which were created before this object came into being
229 // make sure the transparent widgets are on the top
233 // Update the zoom state
234 calculate_tick_spacing();
236 // Make sure the standard bar's segment selector is in sync
237 set_segment_display_mode(segment_display_mode_);
242 GlobalSettings::remove_change_handler(this);
245 Session& View::session()
250 const Session& View::session() const
255 unordered_set< shared_ptr<Signal> > View::signals() const
260 void View::clear_signals()
262 ViewBase::clear_signalbases();
266 void View::add_signal(const shared_ptr<Signal> signal)
268 ViewBase::add_signalbase(signal->base());
269 signals_.insert(signal);
271 signal->set_segment_display_mode(segment_display_mode_);
272 signal->set_current_segment(current_segment_);
274 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
275 this, SLOT(on_signal_name_changed()));
279 void View::clear_decode_signals()
281 decode_traces_.clear();
284 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
286 shared_ptr<DecodeTrace> d(
287 new DecodeTrace(session_, signal, decode_traces_.size()));
288 decode_traces_.push_back(d);
290 d->set_segment_display_mode(segment_display_mode_);
291 d->set_current_segment(current_segment_);
293 connect(signal.get(), SIGNAL(name_changed(const QString&)),
294 this, SLOT(on_signal_name_changed()));
297 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
299 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
300 if ((*i)->base() == signal) {
301 decode_traces_.erase(i);
313 const View* View::view() const
318 Viewport* View::viewport()
323 const Viewport* View::viewport() const
328 void View::save_settings(QSettings &settings) const
330 settings.setValue("scale", scale_);
331 settings.setValue("v_offset",
332 scrollarea_->verticalScrollBar()->sliderPosition());
334 settings.setValue("splitter_state", splitter_->saveState());
335 settings.setValue("segment_display_mode", segment_display_mode_);
339 boost::archive::text_oarchive oa(ss);
340 oa << boost::serialization::make_nvp("ruler_shift", ruler_shift_);
341 settings.setValue("ruler_shift", QString::fromStdString(ss.str()));
345 boost::archive::text_oarchive oa(ss);
346 oa << boost::serialization::make_nvp("offset", offset_);
347 settings.setValue("offset", QString::fromStdString(ss.str()));
350 for (shared_ptr<Signal> signal : signals_) {
351 settings.beginGroup(signal->base()->internal_name());
352 signal->save_settings(settings);
357 void View::restore_settings(QSettings &settings)
359 // Note: It is assumed that this function is only called once,
360 // immediately after restoring a previous session.
362 if (settings.contains("scale"))
363 set_scale(settings.value("scale").toDouble());
365 if (settings.contains("ruler_shift")) {
366 util::Timestamp shift;
368 ss << settings.value("ruler_shift").toString().toStdString();
371 boost::archive::text_iarchive ia(ss);
372 ia >> boost::serialization::make_nvp("ruler_shift", shift);
373 ruler_shift_ = shift;
374 } catch (boost::archive::archive_exception) {
375 qDebug() << "Could not restore the view ruler shift";
379 if (settings.contains("offset")) {
380 util::Timestamp offset;
382 ss << settings.value("offset").toString().toStdString();
385 boost::archive::text_iarchive ia(ss);
386 ia >> boost::serialization::make_nvp("offset", offset);
387 // This also updates ruler_offset_
389 } catch (boost::archive::archive_exception) {
390 qDebug() << "Could not restore the view offset";
394 if (settings.contains("splitter_state"))
395 splitter_->restoreState(settings.value("splitter_state").toByteArray());
397 if (settings.contains("segment_display_mode"))
398 set_segment_display_mode(
399 (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
401 for (shared_ptr<Signal> signal : signals_) {
402 settings.beginGroup(signal->base()->internal_name());
403 signal->restore_settings(settings);
407 if (settings.contains("v_offset")) {
408 saved_v_offset_ = settings.value("v_offset").toInt();
409 set_v_offset(saved_v_offset_);
410 scroll_needs_defaults_ = false;
411 // Note: see eventFilter() for additional information
414 settings_restored_ = true;
415 suppress_zoom_to_fit_after_acq_ = true;
417 // Update the ruler so that it uses the new scale
418 calculate_tick_spacing();
421 vector< shared_ptr<TimeItem> > View::time_items() const
423 const vector<shared_ptr<Flag>> f(flags());
424 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
425 items.push_back(cursors_);
426 items.push_back(cursors_->first());
427 items.push_back(cursors_->second());
429 for (auto trigger_marker : trigger_markers_)
430 items.push_back(trigger_marker);
435 double View::scale() const
440 void View::set_scale(double scale)
442 if (scale_ != scale) {
448 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
450 if ((offset_ != offset) || force_update) {
452 ruler_offset_ = offset_ + ruler_shift_;
457 const Timestamp& View::offset() const
462 const Timestamp& View::ruler_offset() const
464 return ruler_offset_;
467 void View::set_zero_position(pv::util::Timestamp& position)
469 ruler_shift_ = -position;
471 // Force an immediate update of the offsets
472 set_offset(offset_, true);
476 void View::reset_zero_position()
480 // Force an immediate update of the offsets
481 set_offset(offset_, true);
485 int View::owner_visual_v_offset() const
487 return -scrollarea_->verticalScrollBar()->sliderPosition();
490 void View::set_v_offset(int offset)
492 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
497 unsigned int View::depth() const
502 uint32_t View::current_segment() const
504 return current_segment_;
507 pv::util::SIPrefix View::tick_prefix() const
512 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
514 if (tick_prefix_ != tick_prefix) {
515 tick_prefix_ = tick_prefix;
516 tick_prefix_changed();
520 unsigned int View::tick_precision() const
522 return tick_precision_;
525 void View::set_tick_precision(unsigned tick_precision)
527 if (tick_precision_ != tick_precision) {
528 tick_precision_ = tick_precision;
529 tick_precision_changed();
533 const pv::util::Timestamp& View::tick_period() const
538 unsigned int View::minor_tick_count() const
540 return minor_tick_count_;
543 void View::set_tick_period(const pv::util::Timestamp& tick_period)
545 if (tick_period_ != tick_period) {
546 tick_period_ = tick_period;
547 tick_period_changed();
551 TimeUnit View::time_unit() const
556 void View::set_time_unit(pv::util::TimeUnit time_unit)
558 if (time_unit_ != time_unit) {
559 time_unit_ = time_unit;
564 void View::set_current_segment(uint32_t segment_id)
566 current_segment_ = segment_id;
568 for (shared_ptr<Signal> signal : signals_)
569 signal->set_current_segment(current_segment_);
571 for (shared_ptr<DecodeTrace> dt : decode_traces_)
572 dt->set_current_segment(current_segment_);
575 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
577 trigger_markers_.clear();
578 for (util::Timestamp timestamp : triggers)
579 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
581 // When enabled, the first trigger for this segment is used as the zero position
582 GlobalSettings settings;
583 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
585 if (trigger_is_zero_time && (triggers.size() > 0))
586 set_zero_position(triggers.front());
590 segment_changed(segment_id);
593 bool View::segment_is_selectable() const
595 return segment_selectable_;
598 Trace::SegmentDisplayMode View::segment_display_mode() const
600 return segment_display_mode_;
603 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
605 trigger_markers_.clear();
607 segment_display_mode_ = mode;
609 for (shared_ptr<Signal> signal : signals_)
610 signal->set_segment_display_mode(mode);
612 uint32_t last_segment = session_.get_segment_count() - 1;
615 case Trace::ShowLastSegmentOnly:
616 if (current_segment_ != last_segment)
617 set_current_segment(last_segment);
620 case Trace::ShowLastCompleteSegmentOnly:
621 // Do nothing if we only have one segment so far
622 if (last_segment > 0) {
623 // If the last segment isn't complete, the previous one must be
624 uint32_t segment_id =
625 (session_.all_segments_complete(last_segment)) ?
626 last_segment : last_segment - 1;
628 if (current_segment_ != segment_id)
629 set_current_segment(segment_id);
633 case Trace::ShowSingleSegmentOnly:
634 case Trace::ShowAllSegments:
635 case Trace::ShowAccumulatedIntensity:
637 // Current segment remains as-is
641 segment_selectable_ = true;
643 if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
644 segment_selectable_ = false;
648 segment_display_mode_changed((int)mode, segment_selectable_);
651 void View::zoom(double steps)
653 zoom(steps, viewport_->width() / 2);
656 void View::zoom(double steps, int offset)
658 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
661 void View::zoom_fit(bool gui_state)
663 // Act as one-shot when stopped, toggle along with the GUI otherwise
664 if (session_.get_capture_state() == Session::Stopped) {
665 always_zoom_to_fit_ = false;
666 always_zoom_to_fit_changed(false);
668 always_zoom_to_fit_ = gui_state;
669 always_zoom_to_fit_changed(gui_state);
672 const pair<Timestamp, Timestamp> extents = get_time_extents();
673 const Timestamp delta = extents.second - extents.first;
674 if (delta < Timestamp("1e-12"))
678 const int w = viewport_->width();
682 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
683 set_scale_offset(scale.convert_to<double>(), extents.first);
686 void View::zoom_one_to_one()
688 using pv::data::SignalData;
690 // Make a set of all the visible data objects
691 set< shared_ptr<SignalData> > visible_data = get_visible_data();
692 if (visible_data.empty())
696 const int w = viewport_->width();
700 set_zoom(1.0 / session_.get_samplerate(), w / 2);
703 void View::set_scale_offset(double scale, const Timestamp& offset)
705 // Disable sticky scrolling / always zoom to fit when acquisition runs
706 // and user drags the viewport
707 if ((scale_ == scale) && (offset_ != offset) &&
708 (session_.get_capture_state() == Session::Running)) {
710 if (sticky_scrolling_) {
711 sticky_scrolling_ = false;
712 sticky_scrolling_changed(false);
715 if (always_zoom_to_fit_) {
716 always_zoom_to_fit_ = false;
717 always_zoom_to_fit_changed(false);
724 calculate_tick_spacing();
731 set< shared_ptr<SignalData> > View::get_visible_data() const
733 // Make a set of all the visible data objects
734 set< shared_ptr<SignalData> > visible_data;
735 for (const shared_ptr<Signal> sig : signals_)
737 visible_data.insert(sig->data());
742 pair<Timestamp, Timestamp> View::get_time_extents() const
744 boost::optional<Timestamp> left_time, right_time;
745 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
746 for (const shared_ptr<SignalData> d : visible_data) {
747 const vector< shared_ptr<Segment> > segments = d->segments();
748 for (const shared_ptr<Segment> &s : segments) {
749 double samplerate = s->samplerate();
750 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
752 const Timestamp start_time = s->start_time();
753 left_time = left_time ?
754 min(*left_time, start_time) :
756 right_time = right_time ?
757 max(*right_time, start_time + d->max_sample_count() / samplerate) :
758 start_time + d->max_sample_count() / samplerate;
762 if (!left_time || !right_time)
763 return make_pair(0, 0);
765 assert(*left_time < *right_time);
766 return make_pair(*left_time, *right_time);
769 void View::enable_show_sampling_points(bool state)
776 void View::enable_show_analog_minor_grid(bool state)
783 void View::enable_colored_bg(bool state)
789 bool View::colored_bg() const
794 bool View::cursors_shown() const
796 return show_cursors_;
799 void View::show_cursors(bool show)
801 show_cursors_ = show;
806 void View::centre_cursors()
808 const double time_width = scale_ * viewport_->width();
809 cursors_->first()->set_time(offset_ + time_width * 0.4);
810 cursors_->second()->set_time(offset_ + time_width * 0.6);
815 shared_ptr<CursorPair> View::cursors() const
820 void View::add_flag(const Timestamp& time)
822 flags_.push_back(make_shared<Flag>(*this, time,
823 QString("%1").arg(next_flag_text_)));
825 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
826 (next_flag_text_ + 1);
828 time_item_appearance_changed(true, true);
831 void View::remove_flag(shared_ptr<Flag> flag)
834 time_item_appearance_changed(true, true);
837 vector< shared_ptr<Flag> > View::flags() const
839 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
840 stable_sort(flags.begin(), flags.end(),
841 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
842 return a->time() < b->time();
848 const QPoint& View::hover_point() const
853 void View::restack_all_trace_tree_items()
855 // Make a list of owners that is sorted from deepest first
856 const vector<shared_ptr<TraceTreeItem>> items(
857 list_by_type<TraceTreeItem>());
858 set< TraceTreeItemOwner* > owners;
859 for (const auto &r : items)
860 owners.insert(r->owner());
861 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
862 sort(sorted_owners.begin(), sorted_owners.end(),
863 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
864 return a->depth() > b->depth(); });
866 // Restack the items recursively
867 for (auto &o : sorted_owners)
870 // Animate the items to their destination
871 for (const auto &i : items)
872 i->animate_to_layout_v_offset();
875 void View::on_setting_changed(const QString &key, const QVariant &value)
877 if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
878 on_settingViewTriggerIsZeroTime_changed(value);
881 void View::trigger_event(int segment_id, util::Timestamp location)
883 // TODO This doesn't work if we're showing multiple segments at once
884 if ((uint32_t)segment_id != current_segment_)
887 // Set zero location if the Key_View_TriggerIsZeroTime setting is set and
888 // if this is the first trigger for this segment.
889 GlobalSettings settings;
890 bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
892 size_t trigger_count = session_.get_triggers(current_segment_).size();
894 if (trigger_is_zero_time && trigger_count == 1)
895 set_zero_position(location);
897 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
900 void View::get_scroll_layout(double &length, Timestamp &offset) const
902 const pair<Timestamp, Timestamp> extents = get_time_extents();
903 length = ((extents.second - extents.first) / scale_).convert_to<double>();
904 offset = offset_ / scale_;
907 void View::set_zoom(double scale, int offset)
909 // Reset the "always zoom to fit" feature as the user changed the zoom
910 always_zoom_to_fit_ = false;
911 always_zoom_to_fit_changed(false);
913 const Timestamp cursor_offset = offset_ + scale_ * offset;
914 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
915 const Timestamp new_offset = cursor_offset - new_scale * offset;
916 set_scale_offset(new_scale.convert_to<double>(), new_offset);
919 void View::calculate_tick_spacing()
921 const double SpacingIncrement = 10.0f;
922 const double MinValueSpacing = 40.0f;
924 // Figure out the highest numeric value visible on a label
925 const QSize areaSize = viewport_->size();
926 const Timestamp max_time = max(fabs(offset_),
927 fabs(offset_ + scale_ * areaSize.width()));
929 double min_width = SpacingIncrement;
930 double label_width, tick_period_width;
932 QFontMetrics m(QApplication::font());
934 // Copies of the member variables with the same name, used in the calculation
935 // and written back afterwards, so that we don't emit signals all the time
936 // during the calculation.
937 pv::util::Timestamp tick_period = tick_period_;
938 pv::util::SIPrefix tick_prefix = tick_prefix_;
939 unsigned tick_precision = tick_precision_;
942 const double min_period = scale_ * min_width;
944 const int order = (int)floorf(log10f(min_period));
945 const pv::util::Timestamp order_decimal =
946 pow(pv::util::Timestamp(10), order);
948 // Allow for a margin of error so that a scale unit of 1 can be used.
949 // Otherwise, for a SU of 1 the tick period will almost always be below
950 // the min_period by a small amount - and thus skipped in favor of 2.
951 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
952 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
953 double tp_with_margin;
954 unsigned int unit = 0;
957 tp_with_margin = order_decimal.convert_to<double>() *
958 (ScaleUnits[unit++] + tp_margin);
959 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
961 minor_tick_count_ = (unit == 2) ? 4 : 5;
962 tick_period = order_decimal * ScaleUnits[unit - 1];
963 tick_prefix = static_cast<pv::util::SIPrefix>(
964 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
966 // Precision is the number of fractional digits required, not
967 // taking the prefix into account (and it must never be negative)
968 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
970 tick_period_width = (tick_period / scale_).convert_to<double>();
972 const QString label_text = Ruler::format_time_with_distance(
973 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
975 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
976 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
979 min_width += SpacingIncrement;
980 } while (tick_period_width < label_width);
982 set_tick_period(tick_period);
983 set_tick_prefix(tick_prefix);
984 set_tick_precision(tick_precision);
987 void View::adjust_top_margin()
991 const QSize areaSize = viewport_->size();
993 const pair<int, int> extents = v_extents();
994 const int top_margin = owner_visual_v_offset() + extents.first;
995 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
997 // Do we have empty space at the top while the last trace goes out of screen?
998 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
999 const int trace_height = extents.second - extents.first;
1001 // Center everything vertically if there is enough space
1002 if (areaSize.height() >= trace_height)
1003 set_v_offset(extents.first -
1004 ((areaSize.height() - trace_height) / 2));
1006 // Remove the top margin to make as many traces fit on screen as possible
1007 set_v_offset(extents.first);
1011 void View::update_scroll()
1014 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1015 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1017 const QSize areaSize = viewport_->size();
1019 // Set the horizontal scroll bar
1022 get_scroll_layout(length, offset);
1023 length = max(length - areaSize.width(), 0.0);
1025 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1027 hscrollbar->setPageStep(areaSize.width() / 2);
1028 hscrollbar->setSingleStep(major_tick_distance);
1030 updating_scroll_ = true;
1032 if (length < MaxScrollValue) {
1033 hscrollbar->setRange(0, length);
1034 hscrollbar->setSliderPosition(offset.convert_to<double>());
1036 hscrollbar->setRange(0, MaxScrollValue);
1037 hscrollbar->setSliderPosition(
1038 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1041 updating_scroll_ = false;
1043 // Set the vertical scrollbar
1044 vscrollbar->setPageStep(areaSize.height());
1045 vscrollbar->setSingleStep(areaSize.height() / 8);
1047 const pair<int, int> extents = v_extents();
1049 // Don't change the scrollbar range if there are no traces
1050 if (extents.first != extents.second)
1051 vscrollbar->setRange(extents.first - areaSize.height(),
1054 if (scroll_needs_defaults_)
1055 set_scroll_default();
1058 void View::reset_scroll()
1060 scrollarea_->verticalScrollBar()->setRange(0, 0);
1063 void View::set_scroll_default()
1067 const QSize areaSize = viewport_->size();
1069 const pair<int, int> extents = v_extents();
1070 const int trace_height = extents.second - extents.first;
1072 // Do all traces fit in the view?
1073 if (areaSize.height() >= trace_height)
1074 // Center all traces vertically
1075 set_v_offset(extents.first -
1076 ((areaSize.height() - trace_height) / 2));
1078 // Put the first trace at the top, letting the bottom ones overflow
1079 set_v_offset(extents.first);
1082 void View::determine_if_header_was_shrunk()
1084 const int header_pane_width = splitter_->sizes().front();
1085 const int header_width = header_->extended_size_hint().width();
1087 // Allow for a slight margin of error so that we also accept
1088 // slight differences when e.g. a label name change increased
1089 // the overall width
1090 header_was_shrunk_ = (header_pane_width < (header_width - 10));
1093 void View::resize_header_to_fit()
1095 // Setting the maximum width of the header widget doesn't work as
1096 // expected because the splitter would allow the user to make the
1097 // pane wider than that, creating empty space as a result.
1098 // To make this work, we stricly enforce the maximum width by
1099 // expanding the header unless the user shrunk it on purpose.
1100 // As we're then setting the width of the header pane, we set the
1101 // splitter to the maximum allowed position.
1103 int splitter_area_width = 0;
1104 for (int w : splitter_->sizes())
1105 splitter_area_width += w;
1107 // Make sure the header has enough horizontal space to show all labels fully
1108 QList<int> pane_sizes;
1109 pane_sizes.push_back(header_->extended_size_hint().width());
1110 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1111 splitter_->setSizes(pane_sizes);
1114 void View::update_layout()
1119 TraceTreeItemOwner* View::find_prevalent_trace_group(
1120 const shared_ptr<sigrok::ChannelGroup> &group,
1121 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1126 unordered_set<TraceTreeItemOwner*> owners;
1127 vector<TraceTreeItemOwner*> owner_list;
1129 // Make a set and a list of all the owners
1130 for (const auto &channel : group->channels()) {
1131 for (auto entry : signal_map) {
1132 if (entry.first->channel() == channel) {
1133 TraceTreeItemOwner *const o = (entry.second)->owner();
1134 owner_list.push_back(o);
1140 // Iterate through the list of owners, and find the most prevalent
1141 size_t max_prevalence = 0;
1142 TraceTreeItemOwner *prevalent_owner = nullptr;
1143 for (TraceTreeItemOwner *owner : owners) {
1144 const size_t prevalence = count_if(
1145 owner_list.begin(), owner_list.end(),
1146 [&](TraceTreeItemOwner *o) { return o == owner; });
1147 if (prevalence > max_prevalence) {
1148 max_prevalence = prevalence;
1149 prevalent_owner = owner;
1153 return prevalent_owner;
1156 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1157 const vector< shared_ptr<sigrok::Channel> > &channels,
1158 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1160 set< shared_ptr<Trace> > &add_list)
1162 vector< shared_ptr<Trace> > filtered_traces;
1164 for (const auto &channel : channels) {
1165 for (auto entry : signal_map) {
1166 if (entry.first->channel() == channel) {
1167 shared_ptr<Trace> trace = entry.second;
1168 const auto list_iter = add_list.find(trace);
1169 if (list_iter == add_list.end())
1172 filtered_traces.push_back(trace);
1173 add_list.erase(list_iter);
1178 return filtered_traces;
1181 void View::determine_time_unit()
1183 // Check whether we know the sample rate and hence can use time as the unit
1184 if (time_unit_ == util::TimeUnit::Samples) {
1185 // Check all signals but...
1186 for (const shared_ptr<Signal> signal : signals_) {
1187 const shared_ptr<SignalData> data = signal->data();
1189 // ...only check first segment of each
1190 const vector< shared_ptr<Segment> > segments = data->segments();
1191 if (!segments.empty())
1192 if (segments[0]->samplerate()) {
1193 set_time_unit(util::TimeUnit::Time);
1200 bool View::eventFilter(QObject *object, QEvent *event)
1202 const QEvent::Type type = event->type();
1203 if (type == QEvent::MouseMove) {
1205 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1206 if (object == viewport_)
1207 hover_point_ = mouse_event->pos();
1208 else if (object == ruler_)
1209 hover_point_ = QPoint(mouse_event->x(), 0);
1210 else if (object == header_)
1211 hover_point_ = QPoint(0, mouse_event->y());
1213 hover_point_ = QPoint(-1, -1);
1215 update_hover_point();
1217 } else if (type == QEvent::Leave) {
1218 hover_point_ = QPoint(-1, -1);
1219 update_hover_point();
1220 } else if (type == QEvent::Show) {
1222 // This is somewhat of a hack, unfortunately. We cannot use
1223 // set_v_offset() from within restore_settings() as the view
1224 // at that point is neither visible nor properly sized.
1225 // This is the least intrusive workaround I could come up
1226 // with: set the vertical offset (or scroll defaults) when
1227 // the view is shown, which happens after all widgets were
1228 // resized to their final sizes.
1231 if (settings_restored_)
1232 determine_if_header_was_shrunk();
1234 resize_header_to_fit();
1236 if (scroll_needs_defaults_) {
1237 set_scroll_default();
1238 scroll_needs_defaults_ = false;
1241 if (saved_v_offset_) {
1242 set_v_offset(saved_v_offset_);
1243 saved_v_offset_ = 0;
1247 return QObject::eventFilter(object, event);
1250 void View::resizeEvent(QResizeEvent* event)
1252 // Only adjust the top margin if we shrunk vertically
1253 if (event->size().height() < event->oldSize().height())
1254 adjust_top_margin();
1259 void View::update_hover_point()
1261 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1262 list_by_type<TraceTreeItem>());
1263 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1264 r->hover_point_changed(hover_point_);
1266 hover_point_changed(hover_point_);
1269 void View::row_item_appearance_changed(bool label, bool content)
1274 viewport_->update();
1277 void View::time_item_appearance_changed(bool label, bool content)
1282 // Make sure the header pane width is updated, too
1287 viewport_->update();
1290 void View::extents_changed(bool horz, bool vert)
1293 (horz ? TraceTreeItemHExtentsChanged : 0) |
1294 (vert ? TraceTreeItemVExtentsChanged : 0);
1296 lazy_event_handler_.start();
1299 void View::on_signal_name_changed()
1301 if (!header_was_shrunk_)
1302 resize_header_to_fit();
1305 void View::on_splitter_moved()
1307 // The header can only shrink when the splitter is moved manually
1308 determine_if_header_was_shrunk();
1310 if (!header_was_shrunk_)
1311 resize_header_to_fit();
1314 void View::h_scroll_value_changed(int value)
1316 if (updating_scroll_)
1319 // Disable sticky scrolling when user moves the horizontal scroll bar
1320 // during a running acquisition
1321 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1322 sticky_scrolling_ = false;
1323 sticky_scrolling_changed(false);
1326 const int range = scrollarea_->horizontalScrollBar()->maximum();
1327 if (range < MaxScrollValue)
1328 set_offset(scale_ * value);
1332 get_scroll_layout(length, offset);
1333 set_offset(scale_ * length * value / MaxScrollValue);
1337 viewport_->update();
1340 void View::v_scroll_value_changed()
1343 viewport_->update();
1346 void View::signals_changed()
1348 using sigrok::Channel;
1350 vector< shared_ptr<Channel> > channels;
1351 shared_ptr<sigrok::Device> sr_dev;
1352 bool signals_added_or_removed = false;
1354 // Do we need to set the vertical scrollbar to its default position later?
1355 // We do if there are no traces, i.e. the scroll bar has no range set
1356 bool reset_scrollbar =
1357 (scrollarea_->verticalScrollBar()->minimum() ==
1358 scrollarea_->verticalScrollBar()->maximum());
1360 if (!session_.device()) {
1364 sr_dev = session_.device()->device();
1366 channels = sr_dev->channels();
1369 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1371 // Make a list of traces that are being added, and a list of traces
1372 // that are being removed
1373 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1374 const set<shared_ptr<Trace>> prev_traces(
1375 prev_trace_list.begin(), prev_trace_list.end());
1377 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1379 #ifdef ENABLE_DECODE
1380 traces.insert(decode_traces_.begin(), decode_traces_.end());
1383 set< shared_ptr<Trace> > add_traces;
1384 set_difference(traces.begin(), traces.end(),
1385 prev_traces.begin(), prev_traces.end(),
1386 inserter(add_traces, add_traces.begin()));
1388 set< shared_ptr<Trace> > remove_traces;
1389 set_difference(prev_traces.begin(), prev_traces.end(),
1390 traces.begin(), traces.end(),
1391 inserter(remove_traces, remove_traces.begin()));
1393 // Make a look-up table of sigrok Channels to pulseview Signals
1394 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1396 for (const shared_ptr<Signal> &sig : signals_)
1397 signal_map[sig->base()] = sig;
1399 // Populate channel groups
1401 for (auto entry : sr_dev->channel_groups()) {
1402 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1404 if (group->channels().size() <= 1)
1407 // Find best trace group to add to
1408 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1411 // If there is no trace group, create one
1412 shared_ptr<TraceGroup> new_trace_group;
1414 new_trace_group.reset(new TraceGroup());
1415 owner = new_trace_group.get();
1418 // Extract traces for the trace group, removing them from
1420 const vector< shared_ptr<Trace> > new_traces_in_group =
1421 extract_new_traces_for_channels(group->channels(),
1422 signal_map, add_traces);
1424 // Add the traces to the group
1425 const pair<int, int> prev_v_extents = owner->v_extents();
1426 int offset = prev_v_extents.second - prev_v_extents.first;
1427 for (shared_ptr<Trace> trace : new_traces_in_group) {
1429 owner->add_child_item(trace);
1431 const pair<int, int> extents = trace->v_extents();
1432 if (trace->enabled())
1433 offset += -extents.first;
1434 trace->force_to_v_offset(offset);
1435 if (trace->enabled())
1436 offset += extents.second;
1439 if (new_trace_group) {
1440 // Assign proper vertical offsets to each channel in the group
1441 new_trace_group->restack_items();
1443 // If this is a new group, enqueue it in the new top level
1445 if (!new_traces_in_group.empty())
1446 new_top_level_items.push_back(new_trace_group);
1450 // Enqueue the remaining logic channels in a group
1451 vector< shared_ptr<Channel> > logic_channels;
1452 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1453 [](const shared_ptr<Channel>& c) {
1454 return c->type() == sigrok::ChannelType::LOGIC; });
1456 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1457 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1459 if (non_grouped_logic_signals.size() > 0) {
1460 const shared_ptr<TraceGroup> non_grouped_trace_group(
1461 make_shared<TraceGroup>());
1462 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1463 non_grouped_trace_group->add_child_item(trace);
1465 non_grouped_trace_group->restack_items();
1466 new_top_level_items.push_back(non_grouped_trace_group);
1469 // Enqueue the remaining channels as free ungrouped traces
1470 const vector< shared_ptr<Trace> > new_top_level_signals =
1471 extract_new_traces_for_channels(channels, signal_map, add_traces);
1472 new_top_level_items.insert(new_top_level_items.end(),
1473 new_top_level_signals.begin(), new_top_level_signals.end());
1475 // Enqueue any remaining traces i.e. decode traces
1476 new_top_level_items.insert(new_top_level_items.end(),
1477 add_traces.begin(), add_traces.end());
1479 // Remove any removed traces
1480 for (shared_ptr<Trace> trace : remove_traces) {
1481 TraceTreeItemOwner *const owner = trace->owner();
1483 owner->remove_child_item(trace);
1484 signals_added_or_removed = true;
1487 // Remove any empty trace groups
1488 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1489 if (group->child_items().size() == 0) {
1490 remove_child_item(group);
1494 // Add and position the pending top levels items
1495 int offset = v_extents().second;
1496 for (auto item : new_top_level_items) {
1497 add_child_item(item);
1499 // Position the item after the last item or at the top if there is none
1500 const pair<int, int> extents = item->v_extents();
1502 if (item->enabled())
1503 offset += -extents.first;
1505 item->force_to_v_offset(offset);
1507 if (item->enabled())
1508 offset += extents.second;
1509 signals_added_or_removed = true;
1513 if (signals_added_or_removed && !header_was_shrunk_)
1514 resize_header_to_fit();
1519 viewport_->update();
1521 if (reset_scrollbar)
1522 set_scroll_default();
1525 void View::capture_state_updated(int state)
1527 GlobalSettings settings;
1529 if (state == Session::Running) {
1530 set_time_unit(util::TimeUnit::Samples);
1532 trigger_markers_.clear();
1534 scale_at_acq_start_ = scale_;
1535 offset_at_acq_start_ = offset_;
1537 // Activate "always zoom to fit" if the setting is enabled and we're
1538 // the main view of this session (other trace views may be used for
1539 // zooming and we don't want to mess them up)
1540 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1541 if (is_main_view_ && state) {
1542 always_zoom_to_fit_ = true;
1543 always_zoom_to_fit_changed(always_zoom_to_fit_);
1546 // Enable sticky scrolling if the setting is enabled
1547 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1549 // Reset all traces to segment 0
1550 current_segment_ = 0;
1551 set_current_segment(current_segment_);
1554 if (state == Session::Stopped) {
1555 // After acquisition has stopped we need to re-calculate the ticks once
1556 // as it's otherwise done when the user pans or zooms, which is too late
1557 calculate_tick_spacing();
1559 // Reset "always zoom to fit", the acquisition has stopped
1560 if (always_zoom_to_fit_) {
1561 // Perform a final zoom-to-fit before disabling
1562 zoom_fit(always_zoom_to_fit_);
1563 always_zoom_to_fit_ = false;
1564 always_zoom_to_fit_changed(always_zoom_to_fit_);
1567 bool zoom_to_fit_after_acq =
1568 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1570 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1571 // we didn't restore settings in the meanwhile
1572 if (zoom_to_fit_after_acq &&
1573 !suppress_zoom_to_fit_after_acq_ &&
1574 (scale_ == scale_at_acq_start_) &&
1575 (offset_ == offset_at_acq_start_))
1576 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1578 suppress_zoom_to_fit_after_acq_ = false;
1582 void View::on_new_segment(int new_segment_id)
1584 on_segment_changed(new_segment_id);
1587 void View::on_segment_completed(int segment_id)
1589 on_segment_changed(segment_id);
1592 void View::on_segment_changed(int segment)
1594 switch (segment_display_mode_) {
1595 case Trace::ShowLastSegmentOnly:
1596 case Trace::ShowSingleSegmentOnly:
1597 set_current_segment(segment);
1600 case Trace::ShowLastCompleteSegmentOnly:
1601 // Only update if all segments are complete
1602 if (session_.all_segments_complete(segment))
1603 set_current_segment(segment);
1606 case Trace::ShowAllSegments:
1607 case Trace::ShowAccumulatedIntensity:
1613 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
1615 if (new_value.toBool()) {
1616 // The first trigger for this segment is used as the zero position
1617 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
1618 if (triggers.size() > 0)
1619 set_zero_position(triggers.front());
1621 reset_zero_position();
1624 void View::perform_delayed_view_update()
1626 if (always_zoom_to_fit_) {
1628 } else if (sticky_scrolling_) {
1629 // Make right side of the view sticky
1632 get_scroll_layout(length, offset);
1634 const QSize areaSize = viewport_->size();
1635 length = max(length - areaSize.width(), 0.0);
1637 set_offset(scale_ * length);
1640 determine_time_unit();
1643 viewport_->update();
1646 void View::process_sticky_events()
1648 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1650 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1651 restack_all_trace_tree_items();
1655 // Clear the sticky events
1659 } // namespace trace
1660 } // namespace views