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