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),
132 updating_scroll_(false),
133 settings_restored_(false),
134 header_was_shrunk_(false),
135 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
136 always_zoom_to_fit_(false),
138 tick_prefix_(pv::util::SIPrefix::yocto),
140 time_unit_(util::TimeUnit::Time),
141 show_cursors_(false),
142 cursors_(new CursorPair(*this)),
143 next_flag_text_('A'),
145 hover_point_(-1, -1),
146 scroll_needs_defaults_(true),
148 scale_at_acq_start_(0),
149 offset_at_acq_start_(0),
150 suppress_zoom_to_fit_after_acq_(false)
152 QVBoxLayout *root_layout = new QVBoxLayout(this);
153 root_layout->setContentsMargins(0, 0, 0, 0);
154 root_layout->addWidget(splitter_);
156 viewport_ = new Viewport(*this);
157 scrollarea_ = new CustomScrollArea(splitter_);
158 scrollarea_->setViewport(viewport_);
159 scrollarea_->setFrameShape(QFrame::NoFrame);
161 ruler_ = new Ruler(*this);
163 header_ = new Header(*this);
164 header_->setMinimumWidth(10); // So that the arrow tips show at least
166 // We put the header into a simple layout so that we can add the top margin,
167 // allowing us to make it line up with the bottom of the ruler
168 QWidget *header_container = new QWidget();
169 header_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
170 QVBoxLayout *header_layout = new QVBoxLayout(header_container);
171 header_layout->setContentsMargins(0, ruler_->sizeHint().height(), 0, 0);
172 header_layout->addWidget(header_);
174 // To let the ruler and scrollarea be on the same split pane, we need a layout
175 QWidget *trace_container = new QWidget();
176 trace_container->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
177 QVBoxLayout *trace_layout = new QVBoxLayout(trace_container);
178 trace_layout->setSpacing(0); // We don't want space between the ruler and scrollarea
179 trace_layout->setContentsMargins(0, 0, 0, 0);
180 trace_layout->addWidget(ruler_);
181 trace_layout->addWidget(scrollarea_);
183 splitter_->addWidget(header_container);
184 splitter_->addWidget(trace_container);
185 splitter_->setHandleWidth(1); // Don't show a visible rubber band
186 splitter_->setCollapsible(0, false); // Prevent the header from collapsing
187 splitter_->setCollapsible(1, false); // Prevent the traces from collapsing
188 splitter_->setStretchFactor(0, 0); // Prevent the panes from being resized
189 splitter_->setStretchFactor(1, 1); // when the entire view is resized
190 splitter_->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
192 viewport_->installEventFilter(this);
193 ruler_->installEventFilter(this);
194 header_->installEventFilter(this);
196 // Set up settings and event handlers
197 GlobalSettings settings;
198 coloured_bg_ = settings.value(GlobalSettings::Key_View_ColouredBG).toBool();
200 connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
201 this, SLOT(h_scroll_value_changed(int)));
202 connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
203 this, SLOT(v_scroll_value_changed()));
205 connect(header_, SIGNAL(selection_changed()),
206 ruler_, SLOT(clear_selection()));
207 connect(ruler_, SIGNAL(selection_changed()),
208 header_, SLOT(clear_selection()));
210 connect(header_, SIGNAL(selection_changed()),
211 this, SIGNAL(selection_changed()));
212 connect(ruler_, SIGNAL(selection_changed()),
213 this, SIGNAL(selection_changed()));
215 connect(splitter_, SIGNAL(splitterMoved(int, int)),
216 this, SLOT(on_splitter_moved()));
218 connect(&lazy_event_handler_, SIGNAL(timeout()),
219 this, SLOT(process_sticky_events()));
220 lazy_event_handler_.setSingleShot(true);
222 // Trigger the initial event manually. The default device has signals
223 // which were created before this object came into being
226 // make sure the transparent widgets are on the top
230 // Update the zoom state
231 calculate_tick_spacing();
233 // Make sure the standard bar's segment selector is in sync
234 set_segment_display_mode(segment_display_mode_);
237 Session& View::session()
242 const Session& View::session() const
247 unordered_set< shared_ptr<Signal> > View::signals() const
252 void View::clear_signals()
254 ViewBase::clear_signalbases();
258 void View::add_signal(const shared_ptr<Signal> signal)
260 ViewBase::add_signalbase(signal->base());
261 signals_.insert(signal);
263 signal->set_segment_display_mode(segment_display_mode_);
264 signal->set_current_segment(current_segment_);
266 connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
267 this, SLOT(on_signal_name_changed()));
271 void View::clear_decode_signals()
273 decode_traces_.clear();
276 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
278 shared_ptr<DecodeTrace> d(
279 new DecodeTrace(session_, signal, decode_traces_.size()));
280 decode_traces_.push_back(d);
282 d->set_segment_display_mode(segment_display_mode_);
283 d->set_current_segment(current_segment_);
285 connect(signal.get(), SIGNAL(name_changed(const QString&)),
286 this, SLOT(on_signal_name_changed()));
289 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
291 for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
292 if ((*i)->base() == signal) {
293 decode_traces_.erase(i);
305 const View* View::view() const
310 Viewport* View::viewport()
315 const Viewport* View::viewport() const
320 void View::save_settings(QSettings &settings) const
322 settings.setValue("scale", scale_);
323 settings.setValue("v_offset",
324 scrollarea_->verticalScrollBar()->sliderPosition());
326 settings.setValue("splitter_state", splitter_->saveState());
329 boost::archive::text_oarchive oa(ss);
330 oa << boost::serialization::make_nvp("offset", offset_);
331 settings.setValue("offset", QString::fromStdString(ss.str()));
333 for (shared_ptr<Signal> signal : signals_) {
334 settings.beginGroup(signal->base()->internal_name());
335 signal->save_settings(settings);
340 void View::restore_settings(QSettings &settings)
342 // Note: It is assumed that this function is only called once,
343 // immediately after restoring a previous session.
345 if (settings.contains("scale"))
346 set_scale(settings.value("scale").toDouble());
348 if (settings.contains("offset")) {
349 util::Timestamp offset;
351 ss << settings.value("offset").toString().toStdString();
353 boost::archive::text_iarchive ia(ss);
354 ia >> boost::serialization::make_nvp("offset", offset);
359 if (settings.contains("splitter_state"))
360 splitter_->restoreState(settings.value("splitter_state").toByteArray());
362 for (shared_ptr<Signal> signal : signals_) {
363 settings.beginGroup(signal->base()->internal_name());
364 signal->restore_settings(settings);
368 if (settings.contains("v_offset")) {
369 saved_v_offset_ = settings.value("v_offset").toInt();
370 set_v_offset(saved_v_offset_);
371 scroll_needs_defaults_ = false;
372 // Note: see eventFilter() for additional information
375 settings_restored_ = true;
376 suppress_zoom_to_fit_after_acq_ = true;
378 // Update the ruler so that it uses the new scale
379 calculate_tick_spacing();
382 vector< shared_ptr<TimeItem> > View::time_items() const
384 const vector<shared_ptr<Flag>> f(flags());
385 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
386 items.push_back(cursors_);
387 items.push_back(cursors_->first());
388 items.push_back(cursors_->second());
390 for (auto trigger_marker : trigger_markers_)
391 items.push_back(trigger_marker);
396 double View::scale() const
401 void View::set_scale(double scale)
403 if (scale_ != scale) {
409 const Timestamp& View::offset() const
414 void View::set_offset(const pv::util::Timestamp& offset)
416 if (offset_ != offset) {
422 int View::owner_visual_v_offset() const
424 return -scrollarea_->verticalScrollBar()->sliderPosition();
427 void View::set_v_offset(int offset)
429 scrollarea_->verticalScrollBar()->setSliderPosition(offset);
434 unsigned int View::depth() const
439 pv::util::SIPrefix View::tick_prefix() const
444 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
446 if (tick_prefix_ != tick_prefix) {
447 tick_prefix_ = tick_prefix;
448 tick_prefix_changed();
452 unsigned int View::tick_precision() const
454 return tick_precision_;
457 void View::set_tick_precision(unsigned tick_precision)
459 if (tick_precision_ != tick_precision) {
460 tick_precision_ = tick_precision;
461 tick_precision_changed();
465 const pv::util::Timestamp& View::tick_period() const
470 void View::set_tick_period(const pv::util::Timestamp& tick_period)
472 if (tick_period_ != tick_period) {
473 tick_period_ = tick_period;
474 tick_period_changed();
478 TimeUnit View::time_unit() const
483 void View::set_time_unit(pv::util::TimeUnit time_unit)
485 if (time_unit_ != time_unit) {
486 time_unit_ = time_unit;
491 bool View::segment_is_selectable() const
493 return segment_selectable_;
496 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
498 for (shared_ptr<Signal> signal : signals_)
499 signal->set_segment_display_mode(mode);
503 segment_selectable_ = true;
505 if (mode == Trace::ShowLastSegmentOnly)
506 segment_selectable_ = false;
508 segment_display_mode_changed(segment_selectable_);
511 void View::zoom(double steps)
513 zoom(steps, viewport_->width() / 2);
516 void View::zoom(double steps, int offset)
518 set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
521 void View::zoom_fit(bool gui_state)
523 // Act as one-shot when stopped, toggle along with the GUI otherwise
524 if (session_.get_capture_state() == Session::Stopped) {
525 always_zoom_to_fit_ = false;
526 always_zoom_to_fit_changed(false);
528 always_zoom_to_fit_ = gui_state;
529 always_zoom_to_fit_changed(gui_state);
532 const pair<Timestamp, Timestamp> extents = get_time_extents();
533 const Timestamp delta = extents.second - extents.first;
534 if (delta < Timestamp("1e-12"))
538 const int w = viewport_->width();
542 const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
543 set_scale_offset(scale.convert_to<double>(), extents.first);
546 void View::zoom_one_to_one()
548 using pv::data::SignalData;
550 // Make a set of all the visible data objects
551 set< shared_ptr<SignalData> > visible_data = get_visible_data();
552 if (visible_data.empty())
556 const int w = viewport_->width();
560 set_zoom(1.0 / session_.get_samplerate(), w / 2);
563 void View::set_scale_offset(double scale, const Timestamp& offset)
565 // Disable sticky scrolling / always zoom to fit when acquisition runs
566 // and user drags the viewport
567 if ((scale_ == scale) && (offset_ != offset) &&
568 (session_.get_capture_state() == Session::Running)) {
570 if (sticky_scrolling_) {
571 sticky_scrolling_ = false;
572 sticky_scrolling_changed(false);
575 if (always_zoom_to_fit_) {
576 always_zoom_to_fit_ = false;
577 always_zoom_to_fit_changed(false);
584 calculate_tick_spacing();
591 set< shared_ptr<SignalData> > View::get_visible_data() const
593 // Make a set of all the visible data objects
594 set< shared_ptr<SignalData> > visible_data;
595 for (const shared_ptr<Signal> sig : signals_)
597 visible_data.insert(sig->data());
602 pair<Timestamp, Timestamp> View::get_time_extents() const
604 boost::optional<Timestamp> left_time, right_time;
605 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
606 for (const shared_ptr<SignalData> d : visible_data) {
607 const vector< shared_ptr<Segment> > segments = d->segments();
608 for (const shared_ptr<Segment> &s : segments) {
609 double samplerate = s->samplerate();
610 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
612 const Timestamp start_time = s->start_time();
613 left_time = left_time ?
614 min(*left_time, start_time) :
616 right_time = right_time ?
617 max(*right_time, start_time + d->max_sample_count() / samplerate) :
618 start_time + d->max_sample_count() / samplerate;
622 if (!left_time || !right_time)
623 return make_pair(0, 0);
625 assert(*left_time < *right_time);
626 return make_pair(*left_time, *right_time);
629 void View::enable_show_sampling_points(bool state)
636 void View::enable_show_analog_minor_grid(bool state)
643 void View::enable_coloured_bg(bool state)
645 coloured_bg_ = state;
649 bool View::coloured_bg() const
654 bool View::cursors_shown() const
656 return show_cursors_;
659 void View::show_cursors(bool show)
661 show_cursors_ = show;
666 void View::centre_cursors()
668 const double time_width = scale_ * viewport_->width();
669 cursors_->first()->set_time(offset_ + time_width * 0.4);
670 cursors_->second()->set_time(offset_ + time_width * 0.6);
675 shared_ptr<CursorPair> View::cursors() const
680 void View::add_flag(const Timestamp& time)
682 flags_.push_back(make_shared<Flag>(*this, time,
683 QString("%1").arg(next_flag_text_)));
685 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
686 (next_flag_text_ + 1);
688 time_item_appearance_changed(true, true);
691 void View::remove_flag(shared_ptr<Flag> flag)
694 time_item_appearance_changed(true, true);
697 vector< shared_ptr<Flag> > View::flags() const
699 vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
700 stable_sort(flags.begin(), flags.end(),
701 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
702 return a->time() < b->time();
708 const QPoint& View::hover_point() const
713 void View::restack_all_trace_tree_items()
715 // Make a list of owners that is sorted from deepest first
716 const vector<shared_ptr<TraceTreeItem>> items(
717 list_by_type<TraceTreeItem>());
718 set< TraceTreeItemOwner* > owners;
719 for (const auto &r : items)
720 owners.insert(r->owner());
721 vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
722 sort(sorted_owners.begin(), sorted_owners.end(),
723 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
724 return a->depth() > b->depth(); });
726 // Restack the items recursively
727 for (auto &o : sorted_owners)
730 // Animate the items to their destination
731 for (const auto &i : items)
732 i->animate_to_layout_v_offset();
735 void View::trigger_event(util::Timestamp location)
737 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
740 void View::get_scroll_layout(double &length, Timestamp &offset) const
742 const pair<Timestamp, Timestamp> extents = get_time_extents();
743 length = ((extents.second - extents.first) / scale_).convert_to<double>();
744 offset = offset_ / scale_;
747 void View::set_zoom(double scale, int offset)
749 // Reset the "always zoom to fit" feature as the user changed the zoom
750 always_zoom_to_fit_ = false;
751 always_zoom_to_fit_changed(false);
753 const Timestamp cursor_offset = offset_ + scale_ * offset;
754 const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
755 const Timestamp new_offset = cursor_offset - new_scale * offset;
756 set_scale_offset(new_scale.convert_to<double>(), new_offset);
759 void View::calculate_tick_spacing()
761 const double SpacingIncrement = 10.0f;
762 const double MinValueSpacing = 40.0f;
764 // Figure out the highest numeric value visible on a label
765 const QSize areaSize = viewport_->size();
766 const Timestamp max_time = max(fabs(offset_),
767 fabs(offset_ + scale_ * areaSize.width()));
769 double min_width = SpacingIncrement;
770 double label_width, tick_period_width;
772 QFontMetrics m(QApplication::font());
774 // Copies of the member variables with the same name, used in the calculation
775 // and written back afterwards, so that we don't emit signals all the time
776 // during the calculation.
777 pv::util::Timestamp tick_period = tick_period_;
778 pv::util::SIPrefix tick_prefix = tick_prefix_;
779 unsigned tick_precision = tick_precision_;
782 const double min_period = scale_ * min_width;
784 const int order = (int)floorf(log10f(min_period));
785 const pv::util::Timestamp order_decimal =
786 pow(pv::util::Timestamp(10), order);
788 // Allow for a margin of error so that a scale unit of 1 can be used.
789 // Otherwise, for a SU of 1 the tick period will almost always be below
790 // the min_period by a small amount - and thus skipped in favor of 2.
791 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
792 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
793 double tp_with_margin;
794 unsigned int unit = 0;
797 tp_with_margin = order_decimal.convert_to<double>() *
798 (ScaleUnits[unit++] + tp_margin);
799 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
801 tick_period = order_decimal * ScaleUnits[unit - 1];
802 tick_prefix = static_cast<pv::util::SIPrefix>(
803 (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
805 // Precision is the number of fractional digits required, not
806 // taking the prefix into account (and it must never be negative)
807 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
809 tick_period_width = (tick_period / scale_).convert_to<double>();
811 const QString label_text = Ruler::format_time_with_distance(
812 tick_period, max_time, tick_prefix, time_unit_, tick_precision);
814 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
815 Qt::AlignLeft | Qt::AlignTop, label_text).width() +
818 min_width += SpacingIncrement;
819 } while (tick_period_width < label_width);
821 set_tick_period(tick_period);
822 set_tick_prefix(tick_prefix);
823 set_tick_precision(tick_precision);
826 void View::adjust_top_margin()
830 const QSize areaSize = viewport_->size();
832 const pair<int, int> extents = v_extents();
833 const int top_margin = owner_visual_v_offset() + extents.first;
834 const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
836 // Do we have empty space at the top while the last trace goes out of screen?
837 if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
838 const int trace_height = extents.second - extents.first;
840 // Center everything vertically if there is enough space
841 if (areaSize.height() >= trace_height)
842 set_v_offset(extents.first -
843 ((areaSize.height() - trace_height) / 2));
845 // Remove the top margin to make as many traces fit on screen as possible
846 set_v_offset(extents.first);
850 void View::update_scroll()
853 QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
854 QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
856 const QSize areaSize = viewport_->size();
858 // Set the horizontal scroll bar
861 get_scroll_layout(length, offset);
862 length = max(length - areaSize.width(), 0.0);
864 int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
866 hscrollbar->setPageStep(areaSize.width() / 2);
867 hscrollbar->setSingleStep(major_tick_distance);
869 updating_scroll_ = true;
871 if (length < MaxScrollValue) {
872 hscrollbar->setRange(0, length);
873 hscrollbar->setSliderPosition(offset.convert_to<double>());
875 hscrollbar->setRange(0, MaxScrollValue);
876 hscrollbar->setSliderPosition(
877 (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
880 updating_scroll_ = false;
882 // Set the vertical scrollbar
883 vscrollbar->setPageStep(areaSize.height());
884 vscrollbar->setSingleStep(areaSize.height() / 8);
886 const pair<int, int> extents = v_extents();
888 // Don't change the scrollbar range if there are no traces
889 if (extents.first != extents.second)
890 vscrollbar->setRange(extents.first - areaSize.height(),
893 if (scroll_needs_defaults_)
894 set_scroll_default();
897 void View::reset_scroll()
899 scrollarea_->verticalScrollBar()->setRange(0, 0);
902 void View::set_scroll_default()
906 const QSize areaSize = viewport_->size();
908 const pair<int, int> extents = v_extents();
909 const int trace_height = extents.second - extents.first;
911 // Do all traces fit in the view?
912 if (areaSize.height() >= trace_height)
913 // Center all traces vertically
914 set_v_offset(extents.first -
915 ((areaSize.height() - trace_height) / 2));
917 // Put the first trace at the top, letting the bottom ones overflow
918 set_v_offset(extents.first);
921 void View::determine_if_header_was_shrunk()
923 const int header_pane_width = splitter_->sizes().front();
924 const int header_width = header_->extended_size_hint().width();
926 // Allow for a slight margin of error so that we also accept
927 // slight differences when e.g. a label name change increased
929 header_was_shrunk_ = (header_pane_width < (header_width - 10));
932 void View::resize_header_to_fit()
934 // Setting the maximum width of the header widget doesn't work as
935 // expected because the splitter would allow the user to make the
936 // pane wider than that, creating empty space as a result.
937 // To make this work, we stricly enforce the maximum width by
938 // expanding the header unless the user shrunk it on purpose.
939 // As we're then setting the width of the header pane, we set the
940 // splitter to the maximum allowed position.
942 int splitter_area_width = 0;
943 for (int w : splitter_->sizes())
944 splitter_area_width += w;
946 // Make sure the header has enough horizontal space to show all labels fully
947 QList<int> pane_sizes;
948 pane_sizes.push_back(header_->extended_size_hint().width());
949 pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
950 splitter_->setSizes(pane_sizes);
953 void View::update_layout()
958 TraceTreeItemOwner* View::find_prevalent_trace_group(
959 const shared_ptr<sigrok::ChannelGroup> &group,
960 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
965 unordered_set<TraceTreeItemOwner*> owners;
966 vector<TraceTreeItemOwner*> owner_list;
968 // Make a set and a list of all the owners
969 for (const auto &channel : group->channels()) {
970 for (auto entry : signal_map) {
971 if (entry.first->channel() == channel) {
972 TraceTreeItemOwner *const o = (entry.second)->owner();
973 owner_list.push_back(o);
979 // Iterate through the list of owners, and find the most prevalent
980 size_t max_prevalence = 0;
981 TraceTreeItemOwner *prevalent_owner = nullptr;
982 for (TraceTreeItemOwner *owner : owners) {
983 const size_t prevalence = count_if(
984 owner_list.begin(), owner_list.end(),
985 [&](TraceTreeItemOwner *o) { return o == owner; });
986 if (prevalence > max_prevalence) {
987 max_prevalence = prevalence;
988 prevalent_owner = owner;
992 return prevalent_owner;
995 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
996 const vector< shared_ptr<sigrok::Channel> > &channels,
997 const unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
999 set< shared_ptr<Trace> > &add_list)
1001 vector< shared_ptr<Trace> > filtered_traces;
1003 for (const auto &channel : channels) {
1004 for (auto entry : signal_map) {
1005 if (entry.first->channel() == channel) {
1006 shared_ptr<Trace> trace = entry.second;
1007 const auto list_iter = add_list.find(trace);
1008 if (list_iter == add_list.end())
1011 filtered_traces.push_back(trace);
1012 add_list.erase(list_iter);
1017 return filtered_traces;
1020 void View::determine_time_unit()
1022 // Check whether we know the sample rate and hence can use time as the unit
1023 if (time_unit_ == util::TimeUnit::Samples) {
1024 // Check all signals but...
1025 for (const shared_ptr<Signal> signal : signals_) {
1026 const shared_ptr<SignalData> data = signal->data();
1028 // ...only check first segment of each
1029 const vector< shared_ptr<Segment> > segments = data->segments();
1030 if (!segments.empty())
1031 if (segments[0]->samplerate()) {
1032 set_time_unit(util::TimeUnit::Time);
1039 bool View::eventFilter(QObject *object, QEvent *event)
1041 const QEvent::Type type = event->type();
1042 if (type == QEvent::MouseMove) {
1044 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1045 if (object == viewport_)
1046 hover_point_ = mouse_event->pos();
1047 else if (object == ruler_)
1048 hover_point_ = QPoint(mouse_event->x(), 0);
1049 else if (object == header_)
1050 hover_point_ = QPoint(0, mouse_event->y());
1052 hover_point_ = QPoint(-1, -1);
1054 update_hover_point();
1056 } else if (type == QEvent::Leave) {
1057 hover_point_ = QPoint(-1, -1);
1058 update_hover_point();
1059 } else if (type == QEvent::Show) {
1061 // This is somewhat of a hack, unfortunately. We cannot use
1062 // set_v_offset() from within restore_settings() as the view
1063 // at that point is neither visible nor properly sized.
1064 // This is the least intrusive workaround I could come up
1065 // with: set the vertical offset (or scroll defaults) when
1066 // the view is shown, which happens after all widgets were
1067 // resized to their final sizes.
1070 if (settings_restored_)
1071 determine_if_header_was_shrunk();
1073 resize_header_to_fit();
1075 if (scroll_needs_defaults_) {
1076 set_scroll_default();
1077 scroll_needs_defaults_ = false;
1080 if (saved_v_offset_) {
1081 set_v_offset(saved_v_offset_);
1082 saved_v_offset_ = 0;
1086 return QObject::eventFilter(object, event);
1089 void View::resizeEvent(QResizeEvent* event)
1091 // Only adjust the top margin if we shrunk vertically
1092 if (event->size().height() < event->oldSize().height())
1093 adjust_top_margin();
1098 void View::update_hover_point()
1100 const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1101 list_by_type<TraceTreeItem>());
1102 for (shared_ptr<TraceTreeItem> r : trace_tree_items)
1103 r->hover_point_changed(hover_point_);
1105 hover_point_changed(hover_point_);
1108 void View::row_item_appearance_changed(bool label, bool content)
1113 viewport_->update();
1116 void View::time_item_appearance_changed(bool label, bool content)
1121 // Make sure the header pane width is updated, too
1126 viewport_->update();
1129 void View::extents_changed(bool horz, bool vert)
1132 (horz ? TraceTreeItemHExtentsChanged : 0) |
1133 (vert ? TraceTreeItemVExtentsChanged : 0);
1135 lazy_event_handler_.start();
1138 void View::on_signal_name_changed()
1140 if (!header_was_shrunk_)
1141 resize_header_to_fit();
1144 void View::on_splitter_moved()
1146 // The header can only shrink when the splitter is moved manually
1147 determine_if_header_was_shrunk();
1149 if (!header_was_shrunk_)
1150 resize_header_to_fit();
1153 void View::h_scroll_value_changed(int value)
1155 if (updating_scroll_)
1158 // Disable sticky scrolling when user moves the horizontal scroll bar
1159 // during a running acquisition
1160 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1161 sticky_scrolling_ = false;
1162 sticky_scrolling_changed(false);
1165 const int range = scrollarea_->horizontalScrollBar()->maximum();
1166 if (range < MaxScrollValue)
1167 set_offset(scale_ * value);
1171 get_scroll_layout(length, offset);
1172 set_offset(scale_ * length * value / MaxScrollValue);
1176 viewport_->update();
1179 void View::v_scroll_value_changed()
1182 viewport_->update();
1185 void View::signals_changed()
1187 using sigrok::Channel;
1189 vector< shared_ptr<Channel> > channels;
1190 shared_ptr<sigrok::Device> sr_dev;
1191 bool signals_added_or_removed = false;
1193 // Do we need to set the vertical scrollbar to its default position later?
1194 // We do if there are no traces, i.e. the scroll bar has no range set
1195 bool reset_scrollbar =
1196 (scrollarea_->verticalScrollBar()->minimum() ==
1197 scrollarea_->verticalScrollBar()->maximum());
1199 if (!session_.device()) {
1203 sr_dev = session_.device()->device();
1205 channels = sr_dev->channels();
1208 vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1210 // Make a list of traces that are being added, and a list of traces
1211 // that are being removed
1212 const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1213 const set<shared_ptr<Trace>> prev_traces(
1214 prev_trace_list.begin(), prev_trace_list.end());
1216 set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1218 #ifdef ENABLE_DECODE
1219 traces.insert(decode_traces_.begin(), decode_traces_.end());
1222 set< shared_ptr<Trace> > add_traces;
1223 set_difference(traces.begin(), traces.end(),
1224 prev_traces.begin(), prev_traces.end(),
1225 inserter(add_traces, add_traces.begin()));
1227 set< shared_ptr<Trace> > remove_traces;
1228 set_difference(prev_traces.begin(), prev_traces.end(),
1229 traces.begin(), traces.end(),
1230 inserter(remove_traces, remove_traces.begin()));
1232 // Make a look-up table of sigrok Channels to pulseview Signals
1233 unordered_map<shared_ptr<data::SignalBase>, shared_ptr<Signal> >
1235 for (const shared_ptr<Signal> &sig : signals_)
1236 signal_map[sig->base()] = sig;
1238 // Populate channel groups
1240 for (auto entry : sr_dev->channel_groups()) {
1241 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1243 if (group->channels().size() <= 1)
1246 // Find best trace group to add to
1247 TraceTreeItemOwner *owner = find_prevalent_trace_group(
1250 // If there is no trace group, create one
1251 shared_ptr<TraceGroup> new_trace_group;
1253 new_trace_group.reset(new TraceGroup());
1254 owner = new_trace_group.get();
1257 // Extract traces for the trace group, removing them from
1259 const vector< shared_ptr<Trace> > new_traces_in_group =
1260 extract_new_traces_for_channels(group->channels(),
1261 signal_map, add_traces);
1263 // Add the traces to the group
1264 const pair<int, int> prev_v_extents = owner->v_extents();
1265 int offset = prev_v_extents.second - prev_v_extents.first;
1266 for (shared_ptr<Trace> trace : new_traces_in_group) {
1268 owner->add_child_item(trace);
1270 const pair<int, int> extents = trace->v_extents();
1271 if (trace->enabled())
1272 offset += -extents.first;
1273 trace->force_to_v_offset(offset);
1274 if (trace->enabled())
1275 offset += extents.second;
1278 if (new_trace_group) {
1279 // Assign proper vertical offsets to each channel in the group
1280 new_trace_group->restack_items();
1282 // If this is a new group, enqueue it in the new top level
1284 if (!new_traces_in_group.empty())
1285 new_top_level_items.push_back(new_trace_group);
1289 // Enqueue the remaining logic channels in a group
1290 vector< shared_ptr<Channel> > logic_channels;
1291 copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1292 [](const shared_ptr<Channel>& c) {
1293 return c->type() == sigrok::ChannelType::LOGIC; });
1295 const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1296 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1298 if (non_grouped_logic_signals.size() > 0) {
1299 const shared_ptr<TraceGroup> non_grouped_trace_group(
1300 make_shared<TraceGroup>());
1301 for (shared_ptr<Trace> trace : non_grouped_logic_signals)
1302 non_grouped_trace_group->add_child_item(trace);
1304 non_grouped_trace_group->restack_items();
1305 new_top_level_items.push_back(non_grouped_trace_group);
1308 // Enqueue the remaining channels as free ungrouped traces
1309 const vector< shared_ptr<Trace> > new_top_level_signals =
1310 extract_new_traces_for_channels(channels, signal_map, add_traces);
1311 new_top_level_items.insert(new_top_level_items.end(),
1312 new_top_level_signals.begin(), new_top_level_signals.end());
1314 // Enqueue any remaining traces i.e. decode traces
1315 new_top_level_items.insert(new_top_level_items.end(),
1316 add_traces.begin(), add_traces.end());
1318 // Remove any removed traces
1319 for (shared_ptr<Trace> trace : remove_traces) {
1320 TraceTreeItemOwner *const owner = trace->owner();
1322 owner->remove_child_item(trace);
1323 signals_added_or_removed = true;
1326 // Remove any empty trace groups
1327 for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1328 if (group->child_items().size() == 0) {
1329 remove_child_item(group);
1333 // Add and position the pending top levels items
1334 int offset = v_extents().second;
1335 for (auto item : new_top_level_items) {
1336 add_child_item(item);
1338 // Position the item after the last item or at the top if there is none
1339 const pair<int, int> extents = item->v_extents();
1341 if (item->enabled())
1342 offset += -extents.first;
1344 item->force_to_v_offset(offset);
1346 if (item->enabled())
1347 offset += extents.second;
1348 signals_added_or_removed = true;
1352 if (signals_added_or_removed && !header_was_shrunk_)
1353 resize_header_to_fit();
1358 viewport_->update();
1360 if (reset_scrollbar)
1361 set_scroll_default();
1364 void View::capture_state_updated(int state)
1366 GlobalSettings settings;
1368 if (state == Session::Running) {
1369 set_time_unit(util::TimeUnit::Samples);
1371 trigger_markers_.clear();
1373 scale_at_acq_start_ = scale_;
1374 offset_at_acq_start_ = offset_;
1376 // Activate "always zoom to fit" if the setting is enabled and we're
1377 // the main view of this session (other trace views may be used for
1378 // zooming and we don't want to mess them up)
1379 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1380 if (is_main_view_ && state) {
1381 always_zoom_to_fit_ = true;
1382 always_zoom_to_fit_changed(always_zoom_to_fit_);
1385 // Enable sticky scrolling if the setting is enabled
1386 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1389 if (state == Session::Stopped) {
1390 // After acquisition has stopped we need to re-calculate the ticks once
1391 // as it's otherwise done when the user pans or zooms, which is too late
1392 calculate_tick_spacing();
1394 // Reset "always zoom to fit", the acquisition has stopped
1395 if (always_zoom_to_fit_) {
1396 // Perform a final zoom-to-fit before disabling
1397 zoom_fit(always_zoom_to_fit_);
1398 always_zoom_to_fit_ = false;
1399 always_zoom_to_fit_changed(always_zoom_to_fit_);
1402 bool zoom_to_fit_after_acq =
1403 settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1405 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1406 // we didn't restore settings in the meanwhile
1407 if (zoom_to_fit_after_acq &&
1408 !suppress_zoom_to_fit_after_acq_ &&
1409 (scale_ == scale_at_acq_start_) &&
1410 (offset_ == offset_at_acq_start_))
1411 zoom_fit(false); // We're stopped, so the GUI state doesn't matter
1413 suppress_zoom_to_fit_after_acq_ = false;
1417 void View::on_new_segment(int new_segment_id)
1419 on_segment_changed(new_segment_id);
1420 segment_changed(new_segment_id);
1423 void View::on_segment_changed(int segment)
1425 switch (segment_display_mode_) {
1426 case Trace::ShowLastSegmentOnly:
1427 case Trace::ShowSingleSegmentOnly:
1428 current_segment_ = segment;
1429 for (shared_ptr<Signal> signal : signals_)
1430 signal->set_current_segment(current_segment_);
1431 for (shared_ptr<DecodeTrace> dt : decode_traces_)
1432 dt->set_current_segment(current_segment_);
1433 viewport_->update();
1436 case Trace::ShowAllSegments:
1437 case Trace::ShowAccumulatedIntensity:
1443 void View::perform_delayed_view_update()
1445 if (always_zoom_to_fit_) {
1447 } else if (sticky_scrolling_) {
1448 // Make right side of the view sticky
1451 get_scroll_layout(length, offset);
1453 const QSize areaSize = viewport_->size();
1454 length = max(length - areaSize.width(), 0.0);
1456 set_offset(scale_ * length);
1459 determine_time_unit();
1462 viewport_->update();
1465 void View::process_sticky_events()
1467 if (sticky_events_ & TraceTreeItemHExtentsChanged)
1469 if (sticky_events_ & TraceTreeItemVExtentsChanged) {
1470 restack_all_trace_tree_items();
1474 // Clear the sticky events
1478 } // namespace trace
1479 } // namespace views