]> sigrok.org Git - pulseview.git/blob - pv/views/trace/view.cpp
Refactor channel/signal handling
[pulseview.git] / pv / views / trace / view.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #ifdef ENABLE_DECODE
21 #include <libsigrokdecode/libsigrokdecode.h>
22 #endif
23
24 #include <extdef.h>
25
26 #include <algorithm>
27 #include <cassert>
28 #include <climits>
29 #include <cmath>
30 #include <iostream>
31 #include <iterator>
32
33 #include <QApplication>
34 #include <QDebug>
35 #include <QEvent>
36 #include <QFontMetrics>
37 #include <QMenu>
38 #include <QMouseEvent>
39 #include <QScrollBar>
40 #include <QVBoxLayout>
41
42 #include <libsigrokcxx/libsigrokcxx.hpp>
43
44 #include "analogsignal.hpp"
45 #include "header.hpp"
46 #include "logicsignal.hpp"
47 #include "ruler.hpp"
48 #include "signal.hpp"
49 #include "tracegroup.hpp"
50 #include "triggermarker.hpp"
51 #include "view.hpp"
52 #include "viewport.hpp"
53
54 #include "pv/metadata_obj.hpp"
55 #include "pv/data/logic.hpp"
56 #include "pv/data/logicsegment.hpp"
57 #include "pv/devices/device.hpp"
58 #include "pv/globalsettings.hpp"
59 #include "pv/session.hpp"
60 #include "pv/util.hpp"
61
62 #ifdef ENABLE_DECODE
63 #include "decodetrace.hpp"
64 #endif
65
66 using pv::data::SignalData;
67 using pv::data::Segment;
68 using pv::util::TimeUnit;
69 using pv::util::Timestamp;
70
71 using std::back_inserter;
72 using std::copy_if;
73 using std::count_if;
74 using std::inserter;
75 using std::lock_guard;
76 using std::max;
77 using std::make_pair;
78 using std::make_shared;
79 using std::min;
80 using std::numeric_limits;
81 using std::pair;
82 using std::set;
83 using std::set_difference;
84 using std::shared_ptr;
85 using std::vector;
86
87 namespace pv {
88 namespace views {
89 namespace trace {
90
91 const Timestamp View::MaxScale("1e9");
92 const Timestamp View::MinScale("1e-12");
93
94 const int View::MaxScrollValue = INT_MAX / 2;
95
96 /* Area at the top and bottom of the view that can't be scrolled out of sight */
97 const int View::ViewScrollMargin = 50;
98
99 const int View::ScaleUnits[3] = {1, 2, 5};
100
101 CustomScrollArea::CustomScrollArea(QWidget *parent) :
102         QAbstractScrollArea(parent)
103 {
104 }
105
106 bool CustomScrollArea::viewportEvent(QEvent *event)
107 {
108         switch (event->type()) {
109         case QEvent::Paint:
110         case QEvent::MouseButtonPress:
111         case QEvent::MouseButtonRelease:
112         case QEvent::MouseButtonDblClick:
113         case QEvent::MouseMove:
114         case QEvent::Wheel:
115         case QEvent::TouchBegin:
116         case QEvent::TouchUpdate:
117         case QEvent::TouchEnd:
118                 return false;
119         default:
120                 return QAbstractScrollArea::viewportEvent(event);
121         }
122 }
123
124 View::View(Session &session, bool is_main_view, QMainWindow *parent) :
125         ViewBase(session, is_main_view, parent),
126
127         // Note: Place defaults in View::reset_view_state(), not here
128         splitter_(new QSplitter()),
129         header_was_shrunk_(false),  // The splitter remains unchanged after a reset, so this goes here
130         sticky_scrolling_(false),  // Default setting is set in MainWindow::setup_ui()
131         scroll_needs_defaults_(true)
132 {
133         QVBoxLayout *root_layout = new QVBoxLayout(this);
134         root_layout->setContentsMargins(0, 0, 0, 0);
135         root_layout->addWidget(splitter_);
136
137         viewport_ = new Viewport(*this);
138         scrollarea_ = new CustomScrollArea(splitter_);
139         scrollarea_->setViewport(viewport_);
140         scrollarea_->setFrameShape(QFrame::NoFrame);
141
142         ruler_ = new Ruler(*this);
143
144         header_ = new Header(*this);
145         header_->setMinimumWidth(10);  // So that the arrow tips show at least
146
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_);
154
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_);
163
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);
172
173         viewport_->installEventFilter(this);
174         ruler_->installEventFilter(this);
175         header_->installEventFilter(this);
176
177         // Set up settings and event handlers
178         GlobalSettings settings;
179         colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
180         snap_distance_ = settings.value(GlobalSettings::Key_View_SnapDistance).toInt();
181
182         GlobalSettings::add_change_handler(this);
183
184         // Set up metadata objects and event handlers
185         if (is_main_view) {
186                 session_.metadata_obj_manager()->create_object(MetadataObjMainViewRange);
187                 session_.metadata_obj_manager()->create_object(MetadataObjMousePos);
188         }
189
190         // Set up UI event handlers
191         connect(scrollarea_->horizontalScrollBar(), SIGNAL(valueChanged(int)),
192                 this, SLOT(h_scroll_value_changed(int)));
193         connect(scrollarea_->verticalScrollBar(), SIGNAL(valueChanged(int)),
194                 this, SLOT(v_scroll_value_changed()));
195
196         connect(header_, SIGNAL(selection_changed()),
197                 ruler_, SLOT(clear_selection()));
198         connect(ruler_, SIGNAL(selection_changed()),
199                 header_, SLOT(clear_selection()));
200
201         connect(header_, SIGNAL(selection_changed()),
202                 this, SIGNAL(selection_changed()));
203         connect(ruler_, SIGNAL(selection_changed()),
204                 this, SIGNAL(selection_changed()));
205
206         connect(splitter_, SIGNAL(splitterMoved(int, int)),
207                 this, SLOT(on_splitter_moved()));
208
209         connect(&lazy_event_handler_, SIGNAL(timeout()),
210                 this, SLOT(process_sticky_events()));
211         lazy_event_handler_.setSingleShot(true);
212         lazy_event_handler_.setInterval(1000 / ViewBase::MaxViewAutoUpdateRate);
213
214         // Set up local keyboard shortcuts
215         zoom_in_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Plus), this,
216                 SLOT(on_zoom_in_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
217         zoom_in_shortcut_->setAutoRepeat(false);
218
219         zoom_out_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Minus), this,
220                 SLOT(on_zoom_out_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
221         zoom_out_shortcut_->setAutoRepeat(false);
222
223         zoom_in_shortcut_2_ = new QShortcut(QKeySequence(Qt::Key_Up), this,
224                 SLOT(on_zoom_in_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
225         zoom_out_shortcut_2_ = new QShortcut(QKeySequence(Qt::Key_Down), this,
226                 SLOT(on_zoom_out_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
227
228         home_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Home), this,
229                 SLOT(on_scroll_to_start_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
230         home_shortcut_->setAutoRepeat(false);
231
232         end_shortcut_ = new QShortcut(QKeySequence(Qt::Key_End), this,
233                 SLOT(on_scroll_to_end_shortcut_triggered()), nullptr, Qt::WidgetWithChildrenShortcut);
234         end_shortcut_->setAutoRepeat(false);
235
236         grab_ruler_left_shortcut_ = new QShortcut(QKeySequence(Qt::Key_1), this,
237                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
238         connect(grab_ruler_left_shortcut_, &QShortcut::activated,
239                 this, [=]{on_grab_ruler(1);});
240         grab_ruler_left_shortcut_->setAutoRepeat(false);
241
242         grab_ruler_right_shortcut_ = new QShortcut(QKeySequence(Qt::Key_2), this,
243                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
244         connect(grab_ruler_right_shortcut_, &QShortcut::activated,
245                 this, [=]{on_grab_ruler(2);});
246         grab_ruler_right_shortcut_->setAutoRepeat(false);
247
248         cancel_grab_shortcut_ = new QShortcut(QKeySequence(Qt::Key_Escape), this,
249                 nullptr, nullptr, Qt::WidgetWithChildrenShortcut);
250         connect(cancel_grab_shortcut_, &QShortcut::activated,
251                 this, [=]{grabbed_widget_ = nullptr;});
252         cancel_grab_shortcut_->setAutoRepeat(false);
253
254         // Trigger the initial event manually. The default device has signals
255         // which were created before this object came into being
256         signals_changed();
257
258         // Make sure the transparent widgets are on the top
259         ruler_->raise();
260         header_->raise();
261
262         reset_view_state();
263 }
264
265 View::~View()
266 {
267         GlobalSettings::remove_change_handler(this);
268 }
269
270 ViewType View::get_type() const
271 {
272         return ViewTypeTrace;
273 }
274
275 void View::reset_view_state()
276 {
277         ViewBase::reset_view_state();
278
279         segment_display_mode_ = Trace::ShowLastSegmentOnly;
280         segment_selectable_ = false;
281         scale_ = 1e-3;
282         offset_ = 0;
283         ruler_offset_ = 0;
284         zero_offset_ = 0;
285         custom_zero_offset_set_ = false;
286         updating_scroll_ = false;
287         settings_restored_ = false;
288         always_zoom_to_fit_ = false;
289         tick_period_ = 0;
290         tick_prefix_ = pv::util::SIPrefix::yocto;
291         tick_precision_ = 0;
292         time_unit_ = util::TimeUnit::Time;
293         show_cursors_ = false;
294         cursors_ = make_shared<CursorPair>(*this);
295         next_flag_text_ = 'A';
296         trigger_markers_.clear();
297         hover_widget_ = nullptr;
298         grabbed_widget_ = nullptr;
299         hover_point_ = QPoint(-1, -1);
300         scroll_needs_defaults_ = true;
301         saved_v_offset_ = 0;
302         scale_at_acq_start_ = 0;
303         offset_at_acq_start_ = 0;
304         suppress_zoom_to_fit_after_acq_ = false;
305
306         show_cursors_ = false;
307         cursor_state_changed(show_cursors_);
308         flags_.clear();
309
310         // Update the zoom state
311         calculate_tick_spacing();
312
313         // Make sure the standard bar's segment selector is in sync
314         set_segment_display_mode(segment_display_mode_);
315 }
316
317 Session& View::session()
318 {
319         return session_;
320 }
321
322 const Session& View::session() const
323 {
324         return session_;
325 }
326
327 vector< shared_ptr<Signal> > View::signals() const
328 {
329         return signals_;
330 }
331
332 shared_ptr<Signal> View::get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const
333 {
334         shared_ptr<Signal> ret_val;
335
336         for (const shared_ptr<Signal>& s : signals_)
337                 if (s->base() == base) {
338                         ret_val = s;
339                         break;
340                 }
341
342         return ret_val;
343 }
344
345 void View::clear_signalbases()
346 {
347         ViewBase::clear_signalbases();
348         signals_.clear();
349 }
350
351 void View::add_signalbase(const shared_ptr<data::SignalBase> signalbase)
352 {
353         ViewBase::add_signalbase(signalbase);
354
355         shared_ptr<Signal> signal;
356
357         switch (signalbase->type()) {
358         case SignalBase::LogicChannel:
359                 signal = shared_ptr<Signal>(new LogicSignal(session_, session_.device(), signalbase));
360                 break;
361
362         case SignalBase::AnalogChannel:
363                 signal = shared_ptr<Signal>(new AnalogSignal(session_, signalbase));
364                 break;
365
366         default:
367                 qDebug() << "Unknown signalbase type:" << signalbase->type();
368                 assert(false);
369                 break;
370         }
371
372         signals_.push_back(signal);
373
374         signal->set_segment_display_mode(segment_display_mode_);
375         signal->set_current_segment(current_segment_);
376
377         // Secondary views use the signal's settings in the main view
378         if (!is_main_view()) {
379                 shared_ptr<View> main_tv = dynamic_pointer_cast<View>(session_.main_view());
380                 shared_ptr<Signal> main_signal = main_tv->get_signal_by_signalbase(signalbase);
381                 if (main_signal)
382                         signal->restore_settings(main_signal->save_settings());
383         }
384
385         connect(signal->base().get(), SIGNAL(name_changed(const QString&)),
386                 this, SLOT(on_signal_name_changed()));
387 }
388
389 void View::remove_signalbase(const shared_ptr<data::SignalBase> signalbase)
390 {
391         ViewBase::remove_signalbase(signalbase);
392 }
393
394 #ifdef ENABLE_DECODE
395 void View::clear_decode_signals()
396 {
397         ViewBase::clear_decode_signals();
398         decode_traces_.clear();
399 }
400
401 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
402 {
403         ViewBase::add_decode_signal(signal);
404
405         shared_ptr<DecodeTrace> d(
406                 new DecodeTrace(session_, signal, decode_traces_.size()));
407         decode_traces_.push_back(d);
408
409         d->set_segment_display_mode(segment_display_mode_);
410         d->set_current_segment(current_segment_);
411
412         connect(signal.get(), SIGNAL(name_changed(const QString&)),
413                 this, SLOT(on_signal_name_changed()));
414 }
415
416 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
417 {
418         for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
419                 if ((*i)->base() == signal) {
420                         decode_traces_.erase(i);
421                         signals_changed();
422                         return;
423                 }
424
425         ViewBase::remove_decode_signal(signal);
426 }
427 #endif
428
429 shared_ptr<Signal> View::get_signal_under_mouse_cursor() const
430 {
431         return signal_under_mouse_cursor_;
432 }
433
434 View* View::view()
435 {
436         return this;
437 }
438
439 const View* View::view() const
440 {
441         return this;
442 }
443
444 Viewport* View::viewport()
445 {
446         return viewport_;
447 }
448
449 const Viewport* View::viewport() const
450 {
451         return viewport_;
452 }
453
454 QAbstractScrollArea* View::scrollarea() const
455 {
456         return scrollarea_;
457 }
458
459 const Ruler* View::ruler() const
460 {
461         return ruler_;
462 }
463
464 void View::save_settings(QSettings &settings) const
465 {
466         settings.setValue("scale", scale_);
467         settings.setValue("v_offset",
468                 scrollarea_->verticalScrollBar()->sliderPosition());
469
470         settings.setValue("splitter_state", splitter_->saveState());
471         settings.setValue("segment_display_mode", segment_display_mode_);
472
473         GlobalSettings::store_timestamp(settings, "offset", offset_);
474
475         if (custom_zero_offset_set_)
476                 GlobalSettings::store_timestamp(settings, "zero_offset", -zero_offset_);
477         else
478                 settings.remove("zero_offset");
479
480         for (const shared_ptr<Signal>& signal : signals_) {
481                 settings.beginGroup(signal->base()->internal_name());
482                 signal->save_settings(settings);
483                 settings.endGroup();
484         }
485 }
486
487 void View::restore_settings(QSettings &settings)
488 {
489         // Note: It is assumed that this function is only called once,
490         // immediately after restoring a previous session.
491
492         if (settings.contains("scale"))
493                 set_scale(settings.value("scale").toDouble());
494
495         if (settings.contains("offset")) {
496                 // This also updates ruler_offset_
497                 set_offset(GlobalSettings::restore_timestamp(settings, "offset"));
498         }
499
500         if (settings.contains("zero_offset"))
501                 set_zero_position(GlobalSettings::restore_timestamp(settings, "zero_offset"));
502
503         if (settings.contains("splitter_state"))
504                 splitter_->restoreState(settings.value("splitter_state").toByteArray());
505
506         if (settings.contains("segment_display_mode"))
507                 set_segment_display_mode(
508                         (Trace::SegmentDisplayMode)(settings.value("segment_display_mode").toInt()));
509
510         for (shared_ptr<Signal> signal : signals_) {
511                 settings.beginGroup(signal->base()->internal_name());
512                 signal->restore_settings(settings);
513                 settings.endGroup();
514         }
515
516         if (settings.contains("v_offset")) {
517                 saved_v_offset_ = settings.value("v_offset").toInt();
518                 set_v_offset(saved_v_offset_);
519                 scroll_needs_defaults_ = false;
520                 // Note: see eventFilter() for additional information
521         }
522
523         settings_restored_ = true;
524         suppress_zoom_to_fit_after_acq_ = true;
525
526         // Update the ruler so that it uses the new scale
527         calculate_tick_spacing();
528 }
529
530 vector< shared_ptr<TimeItem> > View::time_items() const
531 {
532         const vector<shared_ptr<Flag>> f(flags());
533         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
534
535         if (cursors_) {
536                 items.push_back(cursors_);
537                 items.push_back(cursors_->first());
538                 items.push_back(cursors_->second());
539         }
540
541         for (auto& trigger_marker : trigger_markers_)
542                 items.push_back(trigger_marker);
543
544         return items;
545 }
546
547 double View::scale() const
548 {
549         return scale_;
550 }
551
552 void View::set_scale(double scale)
553 {
554         if (scale_ != scale) {
555                 scale_ = scale;
556                 scale_changed();
557         }
558 }
559
560 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
561 {
562         if ((offset_ != offset) || force_update) {
563                 offset_ = offset;
564                 ruler_offset_ = offset_ + zero_offset_;
565
566                 const int w = viewport_->width();
567                 if (w > 0) {
568                         const double samplerate = session_.get_samplerate();
569                         // Note: sample_num = time * samplerate
570                         // Note: samples_per_pixel = samplerate * scale
571                         int64_t start_sample = (offset_ * samplerate).convert_to<int64_t>();
572                         int64_t end_sample = (offset_ * samplerate).convert_to<int64_t>() +
573                                 (w * session_.get_samplerate() * scale_);
574
575                         MetadataObject* md_obj =
576                                 session_.metadata_obj_manager()->find_object_by_type(MetadataObjMainViewRange);
577                         md_obj->set_value(MetadataValueStartSample, QVariant((qlonglong)start_sample));
578                         md_obj->set_value(MetadataValueEndSample, QVariant((qlonglong)end_sample));
579                 }
580
581                 offset_changed();
582         }
583 }
584
585 const Timestamp& View::offset() const
586 {
587         return offset_;
588 }
589
590 const Timestamp& View::ruler_offset() const
591 {
592         return ruler_offset_;
593 }
594
595 void View::set_zero_position(const pv::util::Timestamp& position)
596 {
597         zero_offset_ = -position;
598         custom_zero_offset_set_ = true;
599
600         // Force an immediate update of the offsets
601         set_offset(offset_, true);
602         ruler_->update();
603 }
604
605 void View::reset_zero_position()
606 {
607         zero_offset_ = 0;
608
609         // When enabled, the first trigger for this segment is used as the zero position
610         GlobalSettings settings;
611         bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
612
613         if (trigger_is_zero_time) {
614                 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
615
616                 if (triggers.size() > 0)
617                         zero_offset_ = triggers.front();
618         }
619
620         custom_zero_offset_set_ = false;
621
622         // Force an immediate update of the offsets
623         set_offset(offset_, true);
624         ruler_->update();
625 }
626
627 pv::util::Timestamp View::zero_offset() const
628 {
629         return zero_offset_;
630 }
631
632 int View::owner_visual_v_offset() const
633 {
634         return -scrollarea_->verticalScrollBar()->sliderPosition();
635 }
636
637 void View::set_v_offset(int offset)
638 {
639         scrollarea_->verticalScrollBar()->setSliderPosition(offset);
640         header_->update();
641         viewport_->update();
642 }
643
644 void View::set_h_offset(int offset)
645 {
646         scrollarea_->horizontalScrollBar()->setSliderPosition(offset);
647         header_->update();
648         viewport_->update();
649 }
650
651 int View::get_h_scrollbar_maximum() const
652 {
653         return scrollarea_->horizontalScrollBar()->maximum();
654 }
655
656 unsigned int View::depth() const
657 {
658         return 0;
659 }
660
661 uint32_t View::current_segment() const
662 {
663         return current_segment_;
664 }
665
666 pv::util::SIPrefix View::tick_prefix() const
667 {
668         return tick_prefix_;
669 }
670
671 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
672 {
673         if (tick_prefix_ != tick_prefix) {
674                 tick_prefix_ = tick_prefix;
675                 tick_prefix_changed();
676         }
677 }
678
679 unsigned int View::tick_precision() const
680 {
681         return tick_precision_;
682 }
683
684 void View::set_tick_precision(unsigned tick_precision)
685 {
686         if (tick_precision_ != tick_precision) {
687                 tick_precision_ = tick_precision;
688                 tick_precision_changed();
689         }
690 }
691
692 const pv::util::Timestamp& View::tick_period() const
693 {
694         return tick_period_;
695 }
696
697 unsigned int View::minor_tick_count() const
698 {
699         return minor_tick_count_;
700 }
701
702 void View::set_tick_period(const pv::util::Timestamp& tick_period)
703 {
704         if (tick_period_ != tick_period) {
705                 tick_period_ = tick_period;
706                 tick_period_changed();
707         }
708 }
709
710 TimeUnit View::time_unit() const
711 {
712         return time_unit_;
713 }
714
715 void View::set_time_unit(pv::util::TimeUnit time_unit)
716 {
717         if (time_unit_ != time_unit) {
718                 time_unit_ = time_unit;
719                 time_unit_changed();
720         }
721 }
722
723 void View::set_current_segment(uint32_t segment_id)
724 {
725         current_segment_ = segment_id;
726
727         for (const shared_ptr<Signal>& signal : signals_)
728                 signal->set_current_segment(current_segment_);
729 #ifdef ENABLE_DECODE
730         for (shared_ptr<DecodeTrace>& dt : decode_traces_)
731                 dt->set_current_segment(current_segment_);
732 #endif
733
734         vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
735
736         trigger_markers_.clear();
737         for (util::Timestamp timestamp : triggers)
738                 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
739
740         if (!custom_zero_offset_set_)
741                 reset_zero_position();
742
743         viewport_->update();
744
745         segment_changed(segment_id);
746 }
747
748 bool View::segment_is_selectable() const
749 {
750         return segment_selectable_;
751 }
752
753 Trace::SegmentDisplayMode View::segment_display_mode() const
754 {
755         return segment_display_mode_;
756 }
757
758 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
759 {
760         segment_display_mode_ = mode;
761
762         for (const shared_ptr<Signal>& signal : signals_)
763                 signal->set_segment_display_mode(mode);
764
765         uint32_t last_segment = session_.get_segment_count() - 1;
766
767         switch (mode) {
768         case Trace::ShowLastSegmentOnly:
769                 if (current_segment_ != last_segment)
770                         set_current_segment(last_segment);
771                 break;
772
773         case Trace::ShowLastCompleteSegmentOnly:
774                 // Do nothing if we only have one segment so far
775                 if (last_segment > 0) {
776                         // If the last segment isn't complete, the previous one must be
777                         uint32_t segment_id =
778                                 (session_.all_segments_complete(last_segment)) ?
779                                 last_segment : last_segment - 1;
780
781                         if (current_segment_ != segment_id)
782                                 set_current_segment(segment_id);
783                 }
784                 break;
785
786         case Trace::ShowSingleSegmentOnly:
787         case Trace::ShowAllSegments:
788         case Trace::ShowAccumulatedIntensity:
789         default:
790                 // Current segment remains as-is
791                 break;
792         }
793
794         segment_selectable_ = true;
795
796         if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
797                 segment_selectable_ = false;
798
799         viewport_->update();
800
801         segment_display_mode_changed((int)mode, segment_selectable_);
802 }
803
804 void View::zoom(double steps)
805 {
806         zoom(steps, viewport_->width() / 2);
807 }
808
809 void View::zoom(double steps, int offset)
810 {
811         set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
812 }
813
814 void View::zoom_fit(bool gui_state)
815 {
816         // Act as one-shot when stopped, toggle along with the GUI otherwise
817         if (session_.get_capture_state() == Session::Stopped) {
818                 always_zoom_to_fit_ = false;
819                 always_zoom_to_fit_changed(false);
820         } else {
821                 always_zoom_to_fit_ = gui_state;
822                 always_zoom_to_fit_changed(gui_state);
823         }
824
825         const pair<Timestamp, Timestamp> extents = get_time_extents();
826         const Timestamp delta = extents.second - extents.first;
827         if (delta < Timestamp("1e-12"))
828                 return;
829
830         assert(viewport_);
831         const int w = viewport_->width();
832         if (w <= 0)
833                 return;
834
835         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
836         set_scale_offset(scale.convert_to<double>(), extents.first);
837 }
838
839 void View::focus_on_range(uint64_t start_sample, uint64_t end_sample)
840 {
841         assert(viewport_);
842         const int w = viewport_->width();
843         if (w <= 0)
844                 return;
845
846         const double samplerate = session_.get_samplerate();
847
848         const uint64_t sample_delta = (end_sample - start_sample);
849
850         // Note: We add 20% margin on the left and 5% on the right
851         const Timestamp delta = (sample_delta * 1.25) / samplerate;
852
853         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
854         const Timestamp offset = (start_sample - sample_delta * 0.20) / samplerate;
855
856         set_scale_offset(scale.convert_to<double>(), offset);
857 }
858
859 void View::set_scale_offset(double scale, const Timestamp& offset)
860 {
861         // Disable sticky scrolling / always zoom to fit when acquisition runs
862         // and user drags the viewport
863         if ((scale_ == scale) && (offset_ != offset) &&
864                         (session_.get_capture_state() == Session::Running)) {
865
866                 if (sticky_scrolling_) {
867                         sticky_scrolling_ = false;
868                         sticky_scrolling_changed(false);
869                 }
870
871                 if (always_zoom_to_fit_) {
872                         always_zoom_to_fit_ = false;
873                         always_zoom_to_fit_changed(false);
874                 }
875         }
876
877         set_scale(scale);
878         set_offset(offset);
879
880         calculate_tick_spacing();
881
882         update_scroll();
883         ruler_->update();
884         viewport_->update();
885 }
886
887 vector< shared_ptr<SignalData> > View::get_visible_data() const
888 {
889         // Make a set of all the visible data objects
890         vector< shared_ptr<SignalData> > visible_data;
891         for (const shared_ptr<Signal>& sig : signals_)
892                 if (sig->enabled())
893                         visible_data.push_back(sig->data());
894
895         return visible_data;
896 }
897
898 pair<Timestamp, Timestamp> View::get_time_extents() const
899 {
900         boost::optional<Timestamp> left_time, right_time;
901
902         vector< shared_ptr<SignalData> > data;
903         if (signals_.size() == 0)
904                 return make_pair(0, 0);
905
906         data.push_back(signals_.front()->data());
907
908         for (const shared_ptr<SignalData>& d : data) {
909                 const vector< shared_ptr<Segment> > segments = d->segments();
910                 for (const shared_ptr<Segment>& s : segments) {
911                         double samplerate = s->samplerate();
912                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
913
914                         const Timestamp start_time = s->start_time();
915                         left_time = left_time ?
916                                 min(*left_time, start_time) :
917                                                 start_time;
918                         right_time = right_time ?
919                                 max(*right_time, start_time + d->max_sample_count() / samplerate) :
920                                                  start_time + d->max_sample_count() / samplerate;
921                 }
922         }
923
924         if (!left_time || !right_time)
925                 return make_pair(0, 0);
926
927         assert(*left_time <= *right_time);
928         return make_pair(*left_time, *right_time);
929 }
930
931 bool View::colored_bg() const
932 {
933         return colored_bg_;
934 }
935
936 bool View::cursors_shown() const
937 {
938         return show_cursors_;
939 }
940
941 void View::show_cursors(bool show)
942 {
943         if (show_cursors_ != show) {
944                 show_cursors_ = show;
945
946                 cursor_state_changed(show);
947                 ruler_->update();
948                 viewport_->update();
949         }
950 }
951
952 void View::set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second)
953 {
954         assert(cursors_);
955
956         cursors_->first()->set_time(first);
957         cursors_->second()->set_time(second);
958
959         ruler_->update();
960         viewport_->update();
961 }
962
963 void View::center_cursors()
964 {
965         assert(cursors_);
966
967         const double time_width = scale_ * viewport_->width();
968         cursors_->first()->set_time(offset_ + time_width * 0.4);
969         cursors_->second()->set_time(offset_ + time_width * 0.6);
970
971         ruler_->update();
972         viewport_->update();
973 }
974
975 shared_ptr<CursorPair> View::cursors() const
976 {
977         return cursors_;
978 }
979
980 shared_ptr<Flag> View::add_flag(const Timestamp& time)
981 {
982         shared_ptr<Flag> flag =
983                 make_shared<Flag>(*this, time, QString("%1").arg(next_flag_text_));
984         flags_.push_back(flag);
985
986         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
987                 (next_flag_text_ + 1);
988
989         time_item_appearance_changed(true, true);
990         return flag;
991 }
992
993 void View::remove_flag(shared_ptr<Flag> flag)
994 {
995         flags_.remove(flag);
996         time_item_appearance_changed(true, true);
997 }
998
999 vector< shared_ptr<Flag> > View::flags() const
1000 {
1001         vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
1002         stable_sort(flags.begin(), flags.end(),
1003                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
1004                         return a->time() < b->time();
1005                 });
1006
1007         return flags;
1008 }
1009
1010 const QPoint& View::hover_point() const
1011 {
1012         return hover_point_;
1013 }
1014
1015 const QWidget* View::hover_widget() const
1016 {
1017         return hover_widget_;
1018 }
1019
1020 int64_t View::get_nearest_level_change(const QPoint &p)
1021 {
1022         // Is snapping disabled?
1023         if (snap_distance_ == 0)
1024                 return -1;
1025
1026         struct entry_t {
1027                 entry_t(shared_ptr<Signal> s) :
1028                         signal(s), delta(numeric_limits<int64_t>::max()), sample(-1), is_dense(false) {}
1029                 shared_ptr<Signal> signal;
1030                 int64_t delta;
1031                 int64_t sample;
1032                 bool is_dense;
1033         };
1034
1035         vector<entry_t> list;
1036
1037         // Create list of signals to consider
1038         if (signal_under_mouse_cursor_)
1039                 list.emplace_back(signal_under_mouse_cursor_);
1040         else
1041                 for (shared_ptr<Signal> s : signals_) {
1042                         if (!s->enabled())
1043                                 continue;
1044
1045                         list.emplace_back(s);
1046                 }
1047
1048         // Get data for listed signals
1049         for (entry_t &e : list) {
1050                 // Calculate sample number from cursor position
1051                 const double samples_per_pixel = e.signal->base()->get_samplerate() * scale();
1052                 const int64_t x_offset = offset().convert_to<double>() / scale();
1053                 const int64_t sample_num = max(((x_offset + p.x()) * samples_per_pixel), 0.0);
1054
1055                 vector<data::LogicSegment::EdgePair> edges =
1056                         e.signal->get_nearest_level_changes(sample_num);
1057
1058                 if (edges.empty())
1059                         continue;
1060
1061                 // Check first edge
1062                 const int64_t first_sample_delta = abs(sample_num - edges.front().first);
1063                 const int64_t first_delta = first_sample_delta / samples_per_pixel;
1064                 e.delta = first_delta;
1065                 e.sample = edges.front().first;
1066
1067                 // Check second edge if available
1068                 if (edges.size() == 2) {
1069                         // Note: -1 because this is usually the right edge and sample points are left-aligned
1070                         const int64_t second_sample_delta = abs(sample_num - edges.back().first - 1);
1071                         const int64_t second_delta = second_sample_delta / samples_per_pixel;
1072
1073                         // If both edges are too close, we mark this signal as being dense
1074                         if ((first_delta + second_delta) <= snap_distance_)
1075                                 e.is_dense = true;
1076
1077                         if (second_delta < first_delta) {
1078                                 e.delta = second_delta;
1079                                 e.sample = edges.back().first;
1080                         }
1081                 }
1082         }
1083
1084         // Look for the best match: non-dense first, then dense
1085         entry_t *match = nullptr;
1086
1087         for (entry_t &e : list) {
1088                 if (e.delta > snap_distance_ || e.is_dense)
1089                         continue;
1090
1091                 if (match) {
1092                         if (e.delta < match->delta)
1093                                 match = &e;
1094                 } else
1095                         match = &e;
1096         }
1097
1098         if (!match) {
1099                 for (entry_t &e : list) {
1100                         if (!e.is_dense)
1101                                 continue;
1102
1103                         if (match) {
1104                                 if (e.delta < match->delta)
1105                                         match = &e;
1106                         } else
1107                                 match = &e;
1108                 }
1109         }
1110
1111         if (match) {
1112                 // Somewhat ugly hack to make TimeItem::drag_by() work
1113                 signal_under_mouse_cursor_ = match->signal;
1114
1115                 return match->sample;
1116         }
1117
1118         return -1;
1119 }
1120
1121 void View::restack_all_trace_tree_items()
1122 {
1123         // Make a list of owners that is sorted from deepest first
1124         const vector<shared_ptr<TraceTreeItem>> items(
1125                 list_by_type<TraceTreeItem>());
1126         set< TraceTreeItemOwner* > owners;
1127         for (const auto &r : items)
1128                 owners.insert(r->owner());
1129         vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
1130         sort(sorted_owners.begin(), sorted_owners.end(),
1131                 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
1132                         return a->depth() > b->depth(); });
1133
1134         // Restack the items recursively
1135         for (auto &o : sorted_owners)
1136                 o->restack_items();
1137
1138         // Animate the items to their destination
1139         for (const auto &i : items)
1140                 i->animate_to_layout_v_offset();
1141 }
1142
1143 int View::header_width() const
1144 {
1145          return header_->extended_size_hint().width();
1146 }
1147
1148 void View::on_setting_changed(const QString &key, const QVariant &value)
1149 {
1150         GlobalSettings settings;
1151
1152         if (key == GlobalSettings::Key_View_ColoredBG) {
1153                 colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
1154                 viewport_->update();
1155         }
1156
1157         if ((key == GlobalSettings::Key_View_ShowSamplingPoints) ||
1158            (key == GlobalSettings::Key_View_ShowAnalogMinorGrid))
1159                 viewport_->update();
1160
1161         if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
1162                 on_settingViewTriggerIsZeroTime_changed(value);
1163
1164         if (key == GlobalSettings::Key_View_SnapDistance)
1165                 snap_distance_ = settings.value(GlobalSettings::Key_View_SnapDistance).toInt();
1166 }
1167
1168 void View::trigger_event(int segment_id, util::Timestamp location)
1169 {
1170         // TODO This doesn't work if we're showing multiple segments at once
1171         if ((uint32_t)segment_id != current_segment_)
1172                 return;
1173
1174         if (!custom_zero_offset_set_)
1175                 reset_zero_position();
1176
1177         trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
1178 }
1179
1180 void View::get_scroll_layout(double &length, Timestamp &offset) const
1181 {
1182         const pair<Timestamp, Timestamp> extents = get_time_extents();
1183         length = ((extents.second - extents.first) / scale_).convert_to<double>();
1184         offset = offset_ / scale_;
1185 }
1186
1187 void View::set_zoom(double scale, int offset)
1188 {
1189         // Reset the "always zoom to fit" feature as the user changed the zoom
1190         always_zoom_to_fit_ = false;
1191         always_zoom_to_fit_changed(false);
1192
1193         const Timestamp cursor_offset = offset_ + scale_ * offset;
1194         const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
1195         const Timestamp new_offset = cursor_offset - new_scale * offset;
1196         set_scale_offset(new_scale.convert_to<double>(), new_offset);
1197 }
1198
1199 void View::calculate_tick_spacing()
1200 {
1201         const double SpacingIncrement = 10.0f;
1202         const double MinValueSpacing = 40.0f;
1203
1204         // Figure out the highest numeric value visible on a label
1205         const QSize areaSize = viewport_->size();
1206         const Timestamp max_time = max(fabs(offset_),
1207                 fabs(offset_ + scale_ * areaSize.width()));
1208
1209         double min_width = SpacingIncrement;
1210         double label_width, tick_period_width;
1211
1212         QFontMetrics m(QApplication::font());
1213
1214         // Copies of the member variables with the same name, used in the calculation
1215         // and written back afterwards, so that we don't emit signals all the time
1216         // during the calculation.
1217         pv::util::Timestamp tick_period = tick_period_;
1218         pv::util::SIPrefix tick_prefix = tick_prefix_;
1219         unsigned tick_precision = tick_precision_;
1220
1221         do {
1222                 const double min_period = scale_ * min_width;
1223
1224                 const int order = (int)floorf(log10f(min_period));
1225                 const pv::util::Timestamp order_decimal =
1226                         pow(pv::util::Timestamp(10), order);
1227
1228                 // Allow for a margin of error so that a scale unit of 1 can be used.
1229                 // Otherwise, for a SU of 1 the tick period will almost always be below
1230                 // the min_period by a small amount - and thus skipped in favor of 2.
1231                 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
1232                 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
1233                 double tp_with_margin;
1234                 unsigned int unit = 0;
1235
1236                 do {
1237                         tp_with_margin = order_decimal.convert_to<double>() *
1238                                 (ScaleUnits[unit++] + tp_margin);
1239                 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
1240
1241                 minor_tick_count_ = (unit == 2) ? 4 : 5;
1242                 tick_period = order_decimal * ScaleUnits[unit - 1];
1243                 tick_prefix = static_cast<pv::util::SIPrefix>(
1244                         (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
1245
1246                 // Precision is the number of fractional digits required, not
1247                 // taking the prefix into account (and it must never be negative)
1248                 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
1249
1250                 tick_period_width = (tick_period / scale_).convert_to<double>();
1251
1252                 const QString label_text = Ruler::format_time_with_distance(
1253                         tick_period, max_time, tick_prefix, time_unit_, tick_precision);
1254
1255                 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
1256                         Qt::AlignLeft | Qt::AlignTop, label_text).width() +
1257                                 MinValueSpacing;
1258
1259                 min_width += SpacingIncrement;
1260         } while (tick_period_width < label_width);
1261
1262         set_tick_period(tick_period);
1263         set_tick_prefix(tick_prefix);
1264         set_tick_precision(tick_precision);
1265 }
1266
1267 void View::adjust_top_margin()
1268 {
1269         assert(viewport_);
1270
1271         const QSize areaSize = viewport_->size();
1272
1273         const pair<int, int> extents = v_extents();
1274         const int top_margin = owner_visual_v_offset() + extents.first;
1275         const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1276
1277         // Do we have empty space at the top while the last trace goes out of screen?
1278         if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1279                 const int trace_height = extents.second - extents.first;
1280
1281                 // Center everything vertically if there is enough space
1282                 if (areaSize.height() >= trace_height)
1283                         set_v_offset(extents.first -
1284                                 ((areaSize.height() - trace_height) / 2));
1285                 else
1286                         // Remove the top margin to make as many traces fit on screen as possible
1287                         set_v_offset(extents.first);
1288         }
1289 }
1290
1291 void View::update_scroll()
1292 {
1293         assert(viewport_);
1294         QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1295         QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1296
1297         const QSize areaSize = viewport_->size();
1298
1299         // Set the horizontal scroll bar
1300         double length = 0;
1301         Timestamp offset;
1302         get_scroll_layout(length, offset);
1303         length = max(length - areaSize.width(), 0.0);
1304
1305         int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1306
1307         hscrollbar->setPageStep(areaSize.width() / 2);
1308         hscrollbar->setSingleStep(major_tick_distance);
1309
1310         updating_scroll_ = true;
1311
1312         if (length < MaxScrollValue) {
1313                 hscrollbar->setRange(0, length);
1314                 hscrollbar->setSliderPosition(offset.convert_to<double>());
1315         } else {
1316                 hscrollbar->setRange(0, MaxScrollValue);
1317                 hscrollbar->setSliderPosition(
1318                         (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1319         }
1320
1321         updating_scroll_ = false;
1322
1323         // Set the vertical scrollbar
1324         vscrollbar->setPageStep(areaSize.height());
1325         vscrollbar->setSingleStep(areaSize.height() / 8);
1326
1327         const pair<int, int> extents = v_extents();
1328
1329         // Don't change the scrollbar range if there are no traces
1330         if (extents.first != extents.second) {
1331                 int top_margin = ViewScrollMargin;
1332                 int btm_margin = ViewScrollMargin;
1333
1334                 vscrollbar->setRange(extents.first - areaSize.height() + top_margin,
1335                         extents.second - btm_margin);
1336         }
1337
1338         if (scroll_needs_defaults_) {
1339                 set_scroll_default();
1340                 scroll_needs_defaults_ = false;
1341         }
1342 }
1343
1344 void View::reset_scroll()
1345 {
1346         scrollarea_->verticalScrollBar()->setRange(0, 0);
1347 }
1348
1349 void View::set_scroll_default()
1350 {
1351         assert(viewport_);
1352
1353         const QSize areaSize = viewport_->size();
1354
1355         const pair<int, int> extents = v_extents();
1356         const int trace_height = extents.second - extents.first;
1357
1358         // Do all traces fit in the view?
1359         if (areaSize.height() >= trace_height)
1360                 // Center all traces vertically
1361                 set_v_offset(extents.first -
1362                         ((areaSize.height() - trace_height) / 2));
1363         else
1364                 // Put the first trace at the top, letting the bottom ones overflow
1365                 set_v_offset(extents.first);
1366 }
1367
1368 void View::determine_if_header_was_shrunk()
1369 {
1370         const int header_pane_width =
1371                 splitter_->sizes().front();  // clazy:exclude=detaching-temporary
1372
1373         // Allow for a slight margin of error so that we also accept
1374         // slight differences when e.g. a label name change increased
1375         // the overall width
1376         header_was_shrunk_ = (header_pane_width < (header_width() - 10));
1377 }
1378
1379 void View::resize_header_to_fit()
1380 {
1381         // Setting the maximum width of the header widget doesn't work as
1382         // expected because the splitter would allow the user to make the
1383         // pane wider than that, creating empty space as a result.
1384         // To make this work, we stricly enforce the maximum width by
1385         // expanding the header unless the user shrunk it on purpose.
1386         // As we're then setting the width of the header pane, we set the
1387         // splitter to the maximum allowed position.
1388
1389         int splitter_area_width = 0;
1390         for (int w : splitter_->sizes())  // clazy:exclude=range-loop
1391                 splitter_area_width += w;
1392
1393         // Make sure the header has enough horizontal space to show all labels fully
1394         QList<int> pane_sizes;
1395         pane_sizes.push_back(header_->extended_size_hint().width());
1396         pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1397         splitter_->setSizes(pane_sizes);
1398 }
1399
1400 void View::update_layout()
1401 {
1402         update_scroll();
1403 }
1404
1405 TraceTreeItemOwner* View::find_prevalent_trace_group(
1406         const shared_ptr<sigrok::ChannelGroup> &group,
1407         const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map)
1408 {
1409         assert(group);
1410
1411         set<TraceTreeItemOwner*> owners;
1412         vector<TraceTreeItemOwner*> owner_list;
1413
1414         // Make a set and a list of all the owners
1415         for (const auto& channel : group->channels()) {
1416                 for (auto& entry : signal_map) {
1417                         if (entry.first->channel() == channel) {
1418                                 TraceTreeItemOwner *const o = (entry.second)->owner();
1419                                 owner_list.push_back(o);
1420                                 owners.insert(o);
1421                         }
1422                 }
1423         }
1424
1425         // Iterate through the list of owners, and find the most prevalent
1426         size_t max_prevalence = 0;
1427         TraceTreeItemOwner *prevalent_owner = nullptr;
1428         for (TraceTreeItemOwner *owner : owners) {
1429                 const size_t prevalence = count_if(
1430                         owner_list.begin(), owner_list.end(),
1431                         [&](TraceTreeItemOwner *o) { return o == owner; });
1432                 if (prevalence > max_prevalence) {
1433                         max_prevalence = prevalence;
1434                         prevalent_owner = owner;
1435                 }
1436         }
1437
1438         return prevalent_owner;
1439 }
1440
1441 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1442         const vector< shared_ptr<sigrok::Channel> > &channels,
1443         const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map,
1444         set< shared_ptr<Trace> > &add_list)
1445 {
1446         vector< shared_ptr<Trace> > filtered_traces;
1447
1448         for (const auto& channel : channels) {
1449                 for (auto& entry : signal_map) {
1450                         if (entry.first->channel() == channel) {
1451                                 shared_ptr<Trace> trace = entry.second;
1452                                 const auto list_iter = add_list.find(trace);
1453                                 if (list_iter == add_list.end())
1454                                         continue;
1455
1456                                 filtered_traces.push_back(trace);
1457                                 add_list.erase(list_iter);
1458                         }
1459                 }
1460         }
1461
1462         return filtered_traces;
1463 }
1464
1465 void View::determine_time_unit()
1466 {
1467         // Check whether we know the sample rate and hence can use time as the unit
1468         if (time_unit_ == util::TimeUnit::Samples) {
1469                 // Check all signals but...
1470                 for (const shared_ptr<Signal>& signal : signals_) {
1471                         const shared_ptr<SignalData> data = signal->data();
1472
1473                         // ...only check first segment of each
1474                         const vector< shared_ptr<Segment> > segments = data->segments();
1475                         if (!segments.empty())
1476                                 if (segments[0]->samplerate()) {
1477                                         set_time_unit(util::TimeUnit::Time);
1478                                         break;
1479                                 }
1480                 }
1481         }
1482 }
1483
1484 bool View::eventFilter(QObject *object, QEvent *event)
1485 {
1486         const QEvent::Type type = event->type();
1487
1488         if (type == QEvent::MouseMove) {
1489
1490                 if (object)
1491                         hover_widget_ = qobject_cast<QWidget*>(object);
1492
1493                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1494                 if (object == viewport_)
1495                         hover_point_ = mouse_event->pos();
1496                 else if (object == ruler_)
1497                         hover_point_ = mouse_event->pos();
1498                 else if (object == header_)
1499                         hover_point_ = QPoint(0, mouse_event->y());
1500                 else
1501                         hover_point_ = QPoint(-1, -1);
1502
1503                 update_hover_point();
1504
1505                 if (grabbed_widget_) {
1506                         int64_t nearest = get_nearest_level_change(hover_point_);
1507                         pv::util::Timestamp mouse_time = offset_ + hover_point_.x() * scale_;
1508
1509                         if (nearest == -1) {
1510                                 grabbed_widget_->set_time(mouse_time);
1511                         } else {
1512                                 grabbed_widget_->set_time(nearest / get_signal_under_mouse_cursor()->base()->get_samplerate());
1513                         }
1514                 }
1515
1516         } else if (type == QEvent::MouseButtonPress) {
1517                 grabbed_widget_ = nullptr;
1518
1519                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1520                 if ((object == viewport_) && (mouse_event->button() & Qt::LeftButton)) {
1521                         // Send event to all trace tree items
1522                         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1523                                 list_by_type<TraceTreeItem>());
1524                         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1525                                 r->mouse_left_press_event(mouse_event);
1526                 }
1527         } else if (type == QEvent::Leave) {
1528                 hover_point_ = QPoint(-1, -1);
1529                 update_hover_point();
1530         } else if (type == QEvent::Show) {
1531
1532                 // This is somewhat of a hack, unfortunately. We cannot use
1533                 // set_v_offset() from within restore_settings() as the view
1534                 // at that point is neither visible nor properly sized.
1535                 // This is the least intrusive workaround I could come up
1536                 // with: set the vertical offset (or scroll defaults) when
1537                 // the view is shown, which happens after all widgets were
1538                 // resized to their final sizes.
1539                 update_layout();
1540
1541                 if (settings_restored_)
1542                         determine_if_header_was_shrunk();
1543                 else
1544                         resize_header_to_fit();
1545
1546                 if (scroll_needs_defaults_) {
1547                         set_scroll_default();
1548                         scroll_needs_defaults_ = false;
1549                 }
1550
1551                 if (saved_v_offset_) {
1552                         set_v_offset(saved_v_offset_);
1553                         saved_v_offset_ = 0;
1554                 }
1555         }
1556
1557         return QObject::eventFilter(object, event);
1558 }
1559
1560 void View::contextMenuEvent(QContextMenuEvent *event)
1561 {
1562         QPoint pos = event->pos() - QPoint(0, ruler_->sizeHint().height());
1563
1564         const shared_ptr<ViewItem> r = viewport_->get_mouse_over_item(pos);
1565         if (!r)
1566                 return;
1567
1568         QMenu *menu = r->create_view_context_menu(this, pos);
1569         if (menu)
1570                 menu->popup(event->globalPos());
1571 }
1572
1573 void View::resizeEvent(QResizeEvent* event)
1574 {
1575         // Only adjust the top margin if we shrunk vertically
1576         if (event->size().height() < event->oldSize().height())
1577                 adjust_top_margin();
1578
1579         update_layout();
1580 }
1581
1582 void View::update_hover_point()
1583 {
1584         // Determine signal that the mouse cursor is hovering over
1585         signal_under_mouse_cursor_.reset();
1586         if (hover_widget_ == this) {
1587                 for (const shared_ptr<Signal>& s : signals_) {
1588                         const pair<int, int> extents = s->v_extents();
1589                         const int top = s->get_visual_y() + extents.first;
1590                         const int btm = s->get_visual_y() + extents.second;
1591                         if ((hover_point_.y() >= top) && (hover_point_.y() <= btm)
1592                                 && s->base()->enabled())
1593                                 signal_under_mouse_cursor_ = s;
1594                 }
1595         }
1596
1597         // Update all trace tree items
1598         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1599                 list_by_type<TraceTreeItem>());
1600         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1601                 r->hover_point_changed(hover_point_);
1602
1603         // Notify this view's listeners
1604         hover_point_changed(hover_widget_, hover_point_);
1605
1606         // Hover point is -1 when invalid and 0 for the header
1607         if (hover_point_.x() > 0) {
1608                 // Notify global listeners
1609                 pv::util::Timestamp mouse_time = offset_ + hover_point_.x() * scale_;
1610                 int64_t sample_num = (mouse_time * session_.get_samplerate()).convert_to<int64_t>();
1611
1612                 MetadataObject* md_obj =
1613                         session_.metadata_obj_manager()->find_object_by_type(MetadataObjMousePos);
1614                 md_obj->set_value(MetadataValueStartSample, QVariant((qlonglong)sample_num));
1615         }
1616 }
1617
1618 void View::row_item_appearance_changed(bool label, bool content)
1619 {
1620         if (label)
1621                 header_->update();
1622         if (content)
1623                 viewport_->update();
1624 }
1625
1626 void View::time_item_appearance_changed(bool label, bool content)
1627 {
1628         if (label) {
1629                 ruler_->update();
1630
1631                 // Make sure the header pane width is updated, too
1632                 update_layout();
1633         }
1634
1635         if (content)
1636                 viewport_->update();
1637 }
1638
1639 void View::extents_changed(bool horz, bool vert)
1640 {
1641         sticky_events_ |=
1642                 (horz ? TraceTreeItemHExtentsChanged : 0) |
1643                 (vert ? TraceTreeItemVExtentsChanged : 0);
1644
1645         if (!lazy_event_handler_.isActive())
1646                 lazy_event_handler_.start();
1647 }
1648
1649 void View::on_signal_name_changed()
1650 {
1651         if (!header_was_shrunk_)
1652                 resize_header_to_fit();
1653 }
1654
1655 void View::on_splitter_moved()
1656 {
1657         // The header can only shrink when the splitter is moved manually
1658         determine_if_header_was_shrunk();
1659
1660         if (!header_was_shrunk_)
1661                 resize_header_to_fit();
1662 }
1663
1664 void View::on_zoom_in_shortcut_triggered()
1665 {
1666         zoom(1);
1667 }
1668
1669 void View::on_zoom_out_shortcut_triggered()
1670 {
1671         zoom(-1);
1672 }
1673
1674 void View::on_scroll_to_start_shortcut_triggered()
1675 {
1676         set_h_offset(0);
1677 }
1678
1679 void View::on_scroll_to_end_shortcut_triggered()
1680 {
1681         set_h_offset(get_h_scrollbar_maximum());
1682 }
1683
1684 void View::h_scroll_value_changed(int value)
1685 {
1686         if (updating_scroll_)
1687                 return;
1688
1689         // Disable sticky scrolling when user moves the horizontal scroll bar
1690         // during a running acquisition
1691         if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1692                 sticky_scrolling_ = false;
1693                 sticky_scrolling_changed(false);
1694         }
1695
1696         const int range = scrollarea_->horizontalScrollBar()->maximum();
1697         if (range < MaxScrollValue)
1698                 set_offset(scale_ * value);
1699         else {
1700                 double length = 0;
1701                 Timestamp offset;
1702                 get_scroll_layout(length, offset);
1703                 set_offset(scale_ * length * value / MaxScrollValue);
1704         }
1705
1706         ruler_->update();
1707         viewport_->update();
1708 }
1709
1710 void View::v_scroll_value_changed()
1711 {
1712         header_->update();
1713         viewport_->update();
1714 }
1715
1716 void View::on_grab_ruler(int ruler_id)
1717 {
1718         if (!cursors_shown()) {
1719                 center_cursors();
1720                 show_cursors();
1721         }
1722
1723         // Release the grabbed widget if its trigger hotkey was pressed twice
1724         if (ruler_id == 1)
1725                 grabbed_widget_ = (grabbed_widget_ == cursors_->first().get()) ?
1726                         nullptr : cursors_->first().get();
1727         else
1728                 grabbed_widget_ = (grabbed_widget_ == cursors_->second().get()) ?
1729                         nullptr : cursors_->second().get();
1730
1731         if (grabbed_widget_)
1732                 grabbed_widget_->set_time(ruler_->get_absolute_time_from_x_pos(
1733                         mapFromGlobal(QCursor::pos()).x() - header_width()));
1734 }
1735
1736 void View::signals_changed()
1737 {
1738         using sigrok::Channel;
1739
1740         lock_guard<mutex> lock(signal_mutex_);
1741
1742         vector< shared_ptr<Channel> > channels;
1743         shared_ptr<sigrok::Device> sr_dev;
1744         bool signals_added_or_removed = false;
1745
1746         // Do we need to set the vertical scrollbar to its default position later?
1747         // We do if there are no traces, i.e. the scroll bar has no range set
1748         bool reset_scrollbar =
1749                 (scrollarea_->verticalScrollBar()->minimum() ==
1750                         scrollarea_->verticalScrollBar()->maximum());
1751
1752         if (!session_.device()) {
1753                 reset_scroll();
1754                 signals_.clear();
1755         } else {
1756                 sr_dev = session_.device()->device();
1757                 assert(sr_dev);
1758                 channels = sr_dev->channels();
1759         }
1760
1761         vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1762
1763         // Make a list of traces that are being added, and a list of traces
1764         // that are being removed. The set_difference() algorithms require
1765         // both sets to be in the exact same order, which means that PD signals
1766         // must always be last as they interrupt the sort order otherwise
1767         const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1768         const set<shared_ptr<Trace>> prev_traces(
1769                 prev_trace_list.begin(), prev_trace_list.end());
1770
1771         set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1772
1773 #ifdef ENABLE_DECODE
1774         traces.insert(decode_traces_.begin(), decode_traces_.end());
1775 #endif
1776
1777         set< shared_ptr<Trace> > add_traces;
1778         set_difference(traces.begin(), traces.end(),
1779                 prev_traces.begin(), prev_traces.end(),
1780                 inserter(add_traces, add_traces.begin()));
1781
1782         set< shared_ptr<Trace> > remove_traces;
1783         set_difference(prev_traces.begin(), prev_traces.end(),
1784                 traces.begin(), traces.end(),
1785                 inserter(remove_traces, remove_traces.begin()));
1786
1787         // Make a look-up table of sigrok Channels to pulseview Signals
1788         map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > signal_map;
1789         for (const shared_ptr<Signal>& sig : signals_)
1790                 signal_map[sig->base()] = sig;
1791
1792         // Populate channel groups
1793         if (sr_dev)
1794                 for (auto& entry : sr_dev->channel_groups()) {
1795                         const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1796
1797                         if (group->channels().size() <= 1)
1798                                 continue;
1799
1800                         // Find best trace group to add to
1801                         TraceTreeItemOwner *owner = find_prevalent_trace_group(
1802                                 group, signal_map);
1803
1804                         // If there is no trace group, create one
1805                         shared_ptr<TraceGroup> new_trace_group;
1806                         if (!owner) {
1807                                 new_trace_group.reset(new TraceGroup());
1808                                 owner = new_trace_group.get();
1809                         }
1810
1811                         // Extract traces for the trace group, removing them from
1812                         // the add list
1813                         const vector< shared_ptr<Trace> > new_traces_in_group =
1814                                 extract_new_traces_for_channels(group->channels(),
1815                                         signal_map, add_traces);
1816
1817                         // Add the traces to the group
1818                         const pair<int, int> prev_v_extents = owner->v_extents();
1819                         int offset = prev_v_extents.second - prev_v_extents.first;
1820                         for (const shared_ptr<Trace>& trace : new_traces_in_group) {
1821                                 assert(trace);
1822                                 owner->add_child_item(trace);
1823
1824                                 const pair<int, int> extents = trace->v_extents();
1825                                 if (trace->enabled())
1826                                         offset += -extents.first;
1827                                 trace->force_to_v_offset(offset);
1828                                 if (trace->enabled())
1829                                         offset += extents.second;
1830                         }
1831
1832                         if (new_trace_group) {
1833                                 // Assign proper vertical offsets to each channel in the group
1834                                 new_trace_group->restack_items();
1835
1836                                 // If this is a new group, enqueue it in the new top level
1837                                 // items list
1838                                 if (!new_traces_in_group.empty())
1839                                         new_top_level_items.push_back(new_trace_group);
1840                         }
1841                 }
1842
1843         // Enqueue the remaining logic channels in a group
1844         vector< shared_ptr<Channel> > logic_channels;
1845         copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1846                 [](const shared_ptr<Channel>& c) {
1847                         return c->type() == sigrok::ChannelType::LOGIC; });
1848
1849         const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1850                 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1851
1852         if (non_grouped_logic_signals.size() > 0) {
1853                 const shared_ptr<TraceGroup> non_grouped_trace_group(
1854                         make_shared<TraceGroup>());
1855                 for (const shared_ptr<Trace>& trace : non_grouped_logic_signals)
1856                         non_grouped_trace_group->add_child_item(trace);
1857
1858                 non_grouped_trace_group->restack_items();
1859                 new_top_level_items.push_back(non_grouped_trace_group);
1860         }
1861
1862         // Enqueue the remaining channels as free ungrouped traces
1863         const vector< shared_ptr<Trace> > new_top_level_signals =
1864                 extract_new_traces_for_channels(channels, signal_map, add_traces);
1865         new_top_level_items.insert(new_top_level_items.end(),
1866                 new_top_level_signals.begin(), new_top_level_signals.end());
1867
1868         // Enqueue any remaining traces i.e. decode traces
1869         new_top_level_items.insert(new_top_level_items.end(),
1870                 add_traces.begin(), add_traces.end());
1871
1872         // Remove any removed traces
1873         for (const shared_ptr<Trace>& trace : remove_traces) {
1874                 TraceTreeItemOwner *const owner = trace->owner();
1875                 assert(owner);
1876                 owner->remove_child_item(trace);
1877                 signals_added_or_removed = true;
1878         }
1879
1880         // Remove any empty trace groups
1881         for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1882                 if (group->child_items().size() == 0) {
1883                         remove_child_item(group);
1884                         group.reset();
1885                 }
1886
1887         // Add and position the pending top levels items
1888         int offset = v_extents().second;
1889         for (shared_ptr<TraceTreeItem> item : new_top_level_items) {
1890                 add_child_item(item);
1891
1892                 // Position the item after the last item or at the top if there is none
1893                 const pair<int, int> extents = item->v_extents();
1894
1895                 if (item->enabled())
1896                         offset += -extents.first;
1897
1898                 item->force_to_v_offset(offset);
1899
1900                 if (item->enabled())
1901                         offset += extents.second;
1902                 signals_added_or_removed = true;
1903         }
1904
1905
1906         if (signals_added_or_removed && !header_was_shrunk_)
1907                 resize_header_to_fit();
1908
1909         update_layout();
1910
1911         header_->update();
1912         viewport_->update();
1913
1914         if (reset_scrollbar)
1915                 set_scroll_default();
1916 }
1917
1918 void View::capture_state_updated(int state)
1919 {
1920         GlobalSettings settings;
1921
1922         if (state == Session::Running) {
1923                 set_time_unit(util::TimeUnit::Samples);
1924
1925                 trigger_markers_.clear();
1926                 if (!custom_zero_offset_set_)
1927                         set_zero_position(0);
1928
1929                 scale_at_acq_start_ = scale_;
1930                 offset_at_acq_start_ = offset_;
1931
1932                 // Activate "always zoom to fit" if the setting is enabled and we're
1933                 // the main view of this session (other trace views may be used for
1934                 // zooming and we don't want to mess them up)
1935                 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1936                 if (is_main_view_ && state) {
1937                         always_zoom_to_fit_ = true;
1938                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1939                 }
1940
1941                 // Enable sticky scrolling if the setting is enabled
1942                 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1943
1944                 // Reset all traces to segment 0
1945                 current_segment_ = 0;
1946                 set_current_segment(current_segment_);
1947         }
1948
1949         if (state == Session::Stopped) {
1950                 // After acquisition has stopped we need to re-calculate the ticks once
1951                 // as it's otherwise done when the user pans or zooms, which is too late
1952                 calculate_tick_spacing();
1953
1954                 // Reset "always zoom to fit", the acquisition has stopped
1955                 if (always_zoom_to_fit_) {
1956                         // Perform a final zoom-to-fit before disabling
1957                         zoom_fit(always_zoom_to_fit_);
1958                         always_zoom_to_fit_ = false;
1959                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1960                 }
1961
1962                 bool zoom_to_fit_after_acq =
1963                         settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1964
1965                 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1966                 // we didn't restore settings in the meanwhile
1967                 if (zoom_to_fit_after_acq &&
1968                         !suppress_zoom_to_fit_after_acq_ &&
1969                         (scale_ == scale_at_acq_start_) &&
1970                         (offset_ == offset_at_acq_start_))
1971                         zoom_fit(false);  // We're stopped, so the GUI state doesn't matter
1972
1973                 suppress_zoom_to_fit_after_acq_ = false;
1974         }
1975 }
1976
1977 void View::on_new_segment(int new_segment_id)
1978 {
1979         on_segment_changed(new_segment_id);
1980 }
1981
1982 void View::on_segment_completed(int segment_id)
1983 {
1984         on_segment_changed(segment_id);
1985 }
1986
1987 void View::on_segment_changed(int segment)
1988 {
1989         switch (segment_display_mode_) {
1990         case Trace::ShowLastSegmentOnly:
1991         case Trace::ShowSingleSegmentOnly:
1992                 set_current_segment(segment);
1993                 break;
1994
1995         case Trace::ShowLastCompleteSegmentOnly:
1996                 // Only update if all segments are complete
1997                 if (session_.all_segments_complete(segment))
1998                         set_current_segment(segment);
1999                 break;
2000
2001         case Trace::ShowAllSegments:
2002         case Trace::ShowAccumulatedIntensity:
2003         default:
2004                 break;
2005         }
2006 }
2007
2008 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
2009 {
2010         (void)new_value;
2011
2012         if (!custom_zero_offset_set_)
2013                 reset_zero_position();
2014 }
2015
2016 void View::perform_delayed_view_update()
2017 {
2018         if (always_zoom_to_fit_) {
2019                 zoom_fit(true);
2020         } else if (sticky_scrolling_) {
2021                 // Make right side of the view sticky
2022                 double length = 0;
2023                 Timestamp offset;
2024                 get_scroll_layout(length, offset);
2025
2026                 const QSize areaSize = viewport_->size();
2027                 length = max(length - areaSize.width(), 0.0);
2028
2029                 set_offset(scale_ * length);
2030         }
2031
2032         determine_time_unit();
2033         update_scroll();
2034         ruler_->update();
2035         viewport_->update();
2036 }
2037
2038 void View::process_sticky_events()
2039 {
2040         if (sticky_events_ & TraceTreeItemHExtentsChanged)
2041                 update_layout();
2042         if (sticky_events_ & TraceTreeItemVExtentsChanged) {
2043                 restack_all_trace_tree_items();
2044                 update_scroll();
2045         }
2046
2047         // Clear the sticky events
2048         sticky_events_ = 0;
2049 }
2050
2051 } // namespace trace
2052 } // namespace views
2053 } // namespace pv