]> sigrok.org Git - pulseview.git/blob - pv/views/trace/view.cpp
Fix a compiler warning
[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         settings_restored_ = 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         saved_v_offset_ = 0;
304         scale_at_acq_start_ = 0;
305         offset_at_acq_start_ = 0;
306         suppress_zoom_to_fit_after_acq_ = false;
307
308         show_cursors_ = false;
309         cursor_state_changed(show_cursors_);
310         flags_.clear();
311
312         // Update the zoom state
313         calculate_tick_spacing();
314
315         // Make sure the standard bar's segment selector is in sync
316         set_segment_display_mode(segment_display_mode_);
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                 saved_v_offset_ = settings.value("v_offset").toInt();
545                 set_v_offset(saved_v_offset_);
546                 scroll_needs_defaults_ = false;
547                 // Note: see eventFilter() for additional information
548         }
549
550         settings_restored_ = true;
551         suppress_zoom_to_fit_after_acq_ = true;
552
553         // Update the ruler so that it uses the new scale
554         calculate_tick_spacing();
555 }
556
557 vector< shared_ptr<TimeItem> > View::time_items() const
558 {
559         const vector<shared_ptr<Flag>> f(flags());
560         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
561
562         if (cursors_) {
563                 items.push_back(cursors_);
564                 items.push_back(cursors_->first());
565                 items.push_back(cursors_->second());
566         }
567
568         for (auto& trigger_marker : trigger_markers_)
569                 items.push_back(trigger_marker);
570
571         return items;
572 }
573
574 double View::scale() const
575 {
576         return scale_;
577 }
578
579 void View::set_scale(double scale)
580 {
581         if (scale_ != scale) {
582                 scale_ = scale;
583                 scale_changed();
584         }
585 }
586
587 void View::set_offset(const pv::util::Timestamp& offset, bool force_update)
588 {
589         if ((offset_ != offset) || force_update) {
590                 offset_ = offset;
591                 ruler_offset_ = offset_ + zero_offset_;
592
593                 const int w = viewport_->width();
594                 if (w > 0) {
595                         const double samplerate = session_.get_samplerate();
596                         // Note: sample_num = time * samplerate
597                         // Note: samples_per_pixel = samplerate * scale
598                         int64_t start_sample = (offset_ * samplerate).convert_to<int64_t>();
599                         int64_t end_sample = (offset_ * samplerate).convert_to<int64_t>() +
600                                 (w * session_.get_samplerate() * scale_);
601
602                         MetadataObject* md_obj =
603                                 session_.metadata_obj_manager()->find_object_by_type(MetadataObjMainViewRange);
604                         md_obj->set_value(MetadataValueStartSample, QVariant((qlonglong)start_sample));
605                         md_obj->set_value(MetadataValueEndSample, QVariant((qlonglong)end_sample));
606                 }
607
608                 offset_changed();
609         }
610 }
611
612 const Timestamp& View::offset() const
613 {
614         return offset_;
615 }
616
617 const Timestamp& View::ruler_offset() const
618 {
619         return ruler_offset_;
620 }
621
622 void View::set_zero_position(const pv::util::Timestamp& position)
623 {
624         zero_offset_ = -position;
625         custom_zero_offset_set_ = true;
626
627         // Force an immediate update of the offsets
628         set_offset(offset_, true);
629         ruler_->update();
630 }
631
632 void View::reset_zero_position()
633 {
634         zero_offset_ = 0;
635
636         // When enabled, the first trigger for this segment is used as the zero position
637         GlobalSettings settings;
638         bool trigger_is_zero_time = settings.value(GlobalSettings::Key_View_TriggerIsZeroTime).toBool();
639
640         if (trigger_is_zero_time) {
641                 vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
642
643                 if (triggers.size() > 0)
644                         zero_offset_ = triggers.front();
645         }
646
647         custom_zero_offset_set_ = false;
648
649         // Force an immediate update of the offsets
650         set_offset(offset_, true);
651         ruler_->update();
652 }
653
654 pv::util::Timestamp View::zero_offset() const
655 {
656         return zero_offset_;
657 }
658
659 int View::owner_visual_v_offset() const
660 {
661         return -scrollarea_->verticalScrollBar()->sliderPosition();
662 }
663
664 void View::set_v_offset(int offset)
665 {
666         scrollarea_->verticalScrollBar()->setSliderPosition(offset);
667         header_->update();
668         viewport_->update();
669 }
670
671 void View::set_h_offset(int offset)
672 {
673         scrollarea_->horizontalScrollBar()->setSliderPosition(offset);
674         header_->update();
675         viewport_->update();
676 }
677
678 int View::get_h_scrollbar_maximum() const
679 {
680         return scrollarea_->horizontalScrollBar()->maximum();
681 }
682
683 unsigned int View::depth() const
684 {
685         return 0;
686 }
687
688 uint32_t View::current_segment() const
689 {
690         return current_segment_;
691 }
692
693 pv::util::SIPrefix View::tick_prefix() const
694 {
695         return tick_prefix_;
696 }
697
698 void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
699 {
700         if (tick_prefix_ != tick_prefix) {
701                 tick_prefix_ = tick_prefix;
702                 tick_prefix_changed();
703         }
704 }
705
706 unsigned int View::tick_precision() const
707 {
708         return tick_precision_;
709 }
710
711 void View::set_tick_precision(unsigned tick_precision)
712 {
713         if (tick_precision_ != tick_precision) {
714                 tick_precision_ = tick_precision;
715                 tick_precision_changed();
716         }
717 }
718
719 const pv::util::Timestamp& View::tick_period() const
720 {
721         return tick_period_;
722 }
723
724 unsigned int View::minor_tick_count() const
725 {
726         return minor_tick_count_;
727 }
728
729 void View::set_tick_period(const pv::util::Timestamp& tick_period)
730 {
731         if (tick_period_ != tick_period) {
732                 tick_period_ = tick_period;
733                 tick_period_changed();
734         }
735 }
736
737 TimeUnit View::time_unit() const
738 {
739         return time_unit_;
740 }
741
742 void View::set_time_unit(pv::util::TimeUnit time_unit)
743 {
744         if (time_unit_ != time_unit) {
745                 time_unit_ = time_unit;
746                 time_unit_changed();
747         }
748 }
749
750 void View::set_current_segment(uint32_t segment_id)
751 {
752         current_segment_ = segment_id;
753
754         for (const shared_ptr<Signal>& signal : signals_)
755                 signal->set_current_segment(current_segment_);
756 #ifdef ENABLE_DECODE
757         for (shared_ptr<DecodeTrace>& dt : decode_traces_)
758                 dt->set_current_segment(current_segment_);
759 #endif
760
761         vector<util::Timestamp> triggers = session_.get_triggers(current_segment_);
762
763         trigger_markers_.clear();
764         for (util::Timestamp timestamp : triggers)
765                 trigger_markers_.push_back(make_shared<TriggerMarker>(*this, timestamp));
766
767         if (!custom_zero_offset_set_)
768                 reset_zero_position();
769
770         viewport_->update();
771
772         segment_changed(segment_id);
773 }
774
775 bool View::segment_is_selectable() const
776 {
777         return segment_selectable_;
778 }
779
780 Trace::SegmentDisplayMode View::segment_display_mode() const
781 {
782         return segment_display_mode_;
783 }
784
785 void View::set_segment_display_mode(Trace::SegmentDisplayMode mode)
786 {
787         segment_display_mode_ = mode;
788
789         for (const shared_ptr<Signal>& signal : signals_)
790                 signal->set_segment_display_mode(mode);
791
792         uint32_t last_segment = session_.get_segment_count() - 1;
793
794         switch (mode) {
795         case Trace::ShowLastSegmentOnly:
796                 if (current_segment_ != last_segment)
797                         set_current_segment(last_segment);
798                 break;
799
800         case Trace::ShowLastCompleteSegmentOnly:
801                 // Do nothing if we only have one segment so far
802                 if (last_segment > 0) {
803                         // If the last segment isn't complete, the previous one must be
804                         uint32_t segment_id =
805                                 (session_.all_segments_complete(last_segment)) ?
806                                 last_segment : last_segment - 1;
807
808                         if (current_segment_ != segment_id)
809                                 set_current_segment(segment_id);
810                 }
811                 break;
812
813         case Trace::ShowSingleSegmentOnly:
814         case Trace::ShowAllSegments:
815         case Trace::ShowAccumulatedIntensity:
816         default:
817                 // Current segment remains as-is
818                 break;
819         }
820
821         segment_selectable_ = true;
822
823         if ((mode == Trace::ShowAllSegments) || (mode == Trace::ShowAccumulatedIntensity))
824                 segment_selectable_ = false;
825
826         viewport_->update();
827
828         segment_display_mode_changed((int)mode, segment_selectable_);
829 }
830
831 void View::zoom(double steps)
832 {
833         zoom(steps, viewport_->width() / 2);
834 }
835
836 void View::zoom(double steps, int offset)
837 {
838         set_zoom(scale_ * pow(3.0 / 2.0, -steps), offset);
839 }
840
841 void View::zoom_fit(bool gui_state)
842 {
843         // Act as one-shot when stopped, toggle along with the GUI otherwise
844         if (session_.get_capture_state() == Session::Stopped) {
845                 always_zoom_to_fit_ = false;
846                 always_zoom_to_fit_changed(false);
847         } else {
848                 always_zoom_to_fit_ = gui_state;
849                 always_zoom_to_fit_changed(gui_state);
850         }
851
852         const pair<Timestamp, Timestamp> extents = get_time_extents();
853         const Timestamp delta = extents.second - extents.first;
854         if (delta < Timestamp("1e-12"))
855                 return;
856
857         assert(viewport_);
858         const int w = viewport_->width();
859         if (w <= 0)
860                 return;
861
862         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
863         set_scale_offset(scale.convert_to<double>(), extents.first);
864 }
865
866 void View::focus_on_range(uint64_t start_sample, uint64_t end_sample)
867 {
868         assert(viewport_);
869         const int w = viewport_->width();
870         if (w <= 0)
871                 return;
872
873         const double samplerate = session_.get_samplerate();
874
875         const uint64_t sample_delta = (end_sample - start_sample);
876
877         // Note: We add 20% margin on the left and 5% on the right
878         const Timestamp delta = (sample_delta * 1.25) / samplerate;
879
880         const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
881         const Timestamp offset = (start_sample - sample_delta * 0.20) / samplerate;
882
883         set_scale_offset(scale.convert_to<double>(), offset);
884 }
885
886 void View::set_scale_offset(double scale, const Timestamp& offset)
887 {
888         // Disable sticky scrolling / always zoom to fit when acquisition runs
889         // and user drags the viewport
890         if ((scale_ == scale) && (offset_ != offset) &&
891                         (session_.get_capture_state() == Session::Running)) {
892
893                 if (sticky_scrolling_) {
894                         sticky_scrolling_ = false;
895                         sticky_scrolling_changed(false);
896                 }
897
898                 if (always_zoom_to_fit_) {
899                         always_zoom_to_fit_ = false;
900                         always_zoom_to_fit_changed(false);
901                 }
902         }
903
904         set_scale(scale);
905         set_offset(offset);
906
907         calculate_tick_spacing();
908
909         update_scroll();
910         ruler_->update();
911         viewport_->update();
912 }
913
914 vector< shared_ptr<SignalData> > View::get_visible_data() const
915 {
916         // Make a set of all the visible data objects
917         vector< shared_ptr<SignalData> > visible_data;
918         for (const shared_ptr<Signal>& sig : signals_)
919                 if (sig->enabled())
920                         visible_data.push_back(sig->data());
921
922         return visible_data;
923 }
924
925 pair<Timestamp, Timestamp> View::get_time_extents() const
926 {
927         boost::optional<Timestamp> left_time, right_time;
928
929         vector< shared_ptr<SignalData> > data;
930         if (signals_.size() == 0)
931                 return make_pair(0, 0);
932
933         data.push_back(signals_.front()->data());
934
935         for (const shared_ptr<SignalData>& d : data) {
936                 const vector< shared_ptr<Segment> > segments = d->segments();
937                 for (const shared_ptr<Segment>& s : segments) {
938                         double samplerate = s->samplerate();
939                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
940
941                         const Timestamp start_time = s->start_time();
942                         left_time = left_time ?
943                                 min(*left_time, start_time) :
944                                                 start_time;
945                         right_time = right_time ?
946                                 max(*right_time, start_time + d->max_sample_count() / samplerate) :
947                                                  start_time + d->max_sample_count() / samplerate;
948                 }
949         }
950
951         if (!left_time || !right_time)
952                 return make_pair(0, 0);
953
954         assert(*left_time <= *right_time);
955         return make_pair(*left_time, *right_time);
956 }
957
958 bool View::colored_bg() const
959 {
960         return colored_bg_;
961 }
962
963 bool View::cursors_shown() const
964 {
965         return show_cursors_;
966 }
967
968 void View::show_cursors(bool show)
969 {
970         if (show_cursors_ != show) {
971                 show_cursors_ = show;
972
973                 cursor_state_changed(show);
974                 ruler_->update();
975                 viewport_->update();
976         }
977 }
978
979 void View::set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second)
980 {
981         assert(cursors_);
982
983         cursors_->first()->set_time(first);
984         cursors_->second()->set_time(second);
985
986         ruler_->update();
987         viewport_->update();
988 }
989
990 void View::center_cursors()
991 {
992         assert(cursors_);
993
994         const double time_width = scale_ * viewport_->width();
995         cursors_->first()->set_time(offset_ + time_width * 0.4);
996         cursors_->second()->set_time(offset_ + time_width * 0.6);
997
998         ruler_->update();
999         viewport_->update();
1000 }
1001
1002 shared_ptr<CursorPair> View::cursors() const
1003 {
1004         return cursors_;
1005 }
1006
1007 shared_ptr<Flag> View::add_flag(const Timestamp& time)
1008 {
1009         shared_ptr<Flag> flag =
1010                 make_shared<Flag>(*this, time, QString("%1").arg(next_flag_text_));
1011         flags_.push_back(flag);
1012
1013         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
1014                 (next_flag_text_ + 1);
1015
1016         time_item_appearance_changed(true, true);
1017         return flag;
1018 }
1019
1020 void View::remove_flag(shared_ptr<Flag> flag)
1021 {
1022         flags_.remove(flag);
1023         time_item_appearance_changed(true, true);
1024 }
1025
1026 vector< shared_ptr<Flag> > View::flags() const
1027 {
1028         vector< shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
1029         stable_sort(flags.begin(), flags.end(),
1030                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
1031                         return a->time() < b->time();
1032                 });
1033
1034         return flags;
1035 }
1036
1037 const QPoint& View::hover_point() const
1038 {
1039         return hover_point_;
1040 }
1041
1042 const QWidget* View::hover_widget() const
1043 {
1044         return hover_widget_;
1045 }
1046
1047 int64_t View::get_nearest_level_change(const QPoint &p)
1048 {
1049         // Is snapping disabled?
1050         if (snap_distance_ == 0)
1051                 return -1;
1052
1053         struct entry_t {
1054                 entry_t(shared_ptr<Signal> s) :
1055                         signal(s), delta(numeric_limits<int64_t>::max()), sample(-1), is_dense(false) {}
1056                 shared_ptr<Signal> signal;
1057                 int64_t delta;
1058                 int64_t sample;
1059                 bool is_dense;
1060         };
1061
1062         vector<entry_t> list;
1063
1064         // Create list of signals to consider
1065         if (signal_under_mouse_cursor_)
1066                 list.emplace_back(signal_under_mouse_cursor_);
1067         else
1068                 for (shared_ptr<Signal> s : signals_) {
1069                         if (!s->enabled())
1070                                 continue;
1071
1072                         list.emplace_back(s);
1073                 }
1074
1075         // Get data for listed signals
1076         for (entry_t &e : list) {
1077                 // Calculate sample number from cursor position
1078                 const double samples_per_pixel = e.signal->base()->get_samplerate() * scale();
1079                 const int64_t x_offset = offset().convert_to<double>() / scale();
1080                 const int64_t sample_num = max(((x_offset + p.x()) * samples_per_pixel), 0.0);
1081
1082                 vector<data::LogicSegment::EdgePair> edges =
1083                         e.signal->get_nearest_level_changes(sample_num);
1084
1085                 if (edges.empty())
1086                         continue;
1087
1088                 // Check first edge
1089                 const int64_t first_sample_delta = abs(sample_num - edges.front().first);
1090                 const int64_t first_delta = first_sample_delta / samples_per_pixel;
1091                 e.delta = first_delta;
1092                 e.sample = edges.front().first;
1093
1094                 // Check second edge if available
1095                 if (edges.size() == 2) {
1096                         // Note: -1 because this is usually the right edge and sample points are left-aligned
1097                         const int64_t second_sample_delta = abs(sample_num - edges.back().first - 1);
1098                         const int64_t second_delta = second_sample_delta / samples_per_pixel;
1099
1100                         // If both edges are too close, we mark this signal as being dense
1101                         if ((first_delta + second_delta) <= snap_distance_)
1102                                 e.is_dense = true;
1103
1104                         if (second_delta < first_delta) {
1105                                 e.delta = second_delta;
1106                                 e.sample = edges.back().first;
1107                         }
1108                 }
1109         }
1110
1111         // Look for the best match: non-dense first, then dense
1112         entry_t *match = nullptr;
1113
1114         for (entry_t &e : list) {
1115                 if (e.delta > snap_distance_ || e.is_dense)
1116                         continue;
1117
1118                 if (match) {
1119                         if (e.delta < match->delta)
1120                                 match = &e;
1121                 } else
1122                         match = &e;
1123         }
1124
1125         if (!match) {
1126                 for (entry_t &e : list) {
1127                         if (!e.is_dense)
1128                                 continue;
1129
1130                         if (match) {
1131                                 if (e.delta < match->delta)
1132                                         match = &e;
1133                         } else
1134                                 match = &e;
1135                 }
1136         }
1137
1138         if (match) {
1139                 // Somewhat ugly hack to make TimeItem::drag_by() work
1140                 signal_under_mouse_cursor_ = match->signal;
1141
1142                 return match->sample;
1143         }
1144
1145         return -1;
1146 }
1147
1148 void View::restack_all_trace_tree_items()
1149 {
1150         // Make a list of owners that is sorted from deepest first
1151         const vector<shared_ptr<TraceTreeItem>> items(
1152                 list_by_type<TraceTreeItem>());
1153         set< TraceTreeItemOwner* > owners;
1154         for (const auto &r : items)
1155                 owners.insert(r->owner());
1156         vector< TraceTreeItemOwner* > sorted_owners(owners.begin(), owners.end());
1157         sort(sorted_owners.begin(), sorted_owners.end(),
1158                 [](const TraceTreeItemOwner* a, const TraceTreeItemOwner *b) {
1159                         return a->depth() > b->depth(); });
1160
1161         // Restack the items recursively
1162         for (auto &o : sorted_owners)
1163                 o->restack_items();
1164
1165         // Animate the items to their destination
1166         for (const auto &i : items)
1167                 i->animate_to_layout_v_offset();
1168 }
1169
1170 int View::header_width() const
1171 {
1172          return header_->extended_size_hint().width();
1173 }
1174
1175 void View::on_setting_changed(const QString &key, const QVariant &value)
1176 {
1177         GlobalSettings settings;
1178
1179         if (key == GlobalSettings::Key_View_ColoredBG) {
1180                 colored_bg_ = settings.value(GlobalSettings::Key_View_ColoredBG).toBool();
1181                 viewport_->update();
1182         }
1183
1184         if ((key == GlobalSettings::Key_View_ShowSamplingPoints) ||
1185            (key == GlobalSettings::Key_View_ShowAnalogMinorGrid))
1186                 viewport_->update();
1187
1188         if (key == GlobalSettings::Key_View_TriggerIsZeroTime)
1189                 on_settingViewTriggerIsZeroTime_changed(value);
1190
1191         if (key == GlobalSettings::Key_View_SnapDistance)
1192                 snap_distance_ = settings.value(GlobalSettings::Key_View_SnapDistance).toInt();
1193 }
1194
1195 void View::trigger_event(int segment_id, util::Timestamp location)
1196 {
1197         // TODO This doesn't work if we're showing multiple segments at once
1198         if ((uint32_t)segment_id != current_segment_)
1199                 return;
1200
1201         if (!custom_zero_offset_set_)
1202                 reset_zero_position();
1203
1204         trigger_markers_.push_back(make_shared<TriggerMarker>(*this, location));
1205 }
1206
1207 void View::get_scroll_layout(double &length, Timestamp &offset) const
1208 {
1209         const pair<Timestamp, Timestamp> extents = get_time_extents();
1210         length = ((extents.second - extents.first) / scale_).convert_to<double>();
1211         offset = offset_ / scale_;
1212 }
1213
1214 void View::set_zoom(double scale, int offset)
1215 {
1216         // Reset the "always zoom to fit" feature as the user changed the zoom
1217         always_zoom_to_fit_ = false;
1218         always_zoom_to_fit_changed(false);
1219
1220         const Timestamp cursor_offset = offset_ + scale_ * offset;
1221         const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
1222         const Timestamp new_offset = cursor_offset - new_scale * offset;
1223         set_scale_offset(new_scale.convert_to<double>(), new_offset);
1224 }
1225
1226 void View::calculate_tick_spacing()
1227 {
1228         const double SpacingIncrement = 10.0f;
1229         const double MinValueSpacing = 40.0f;
1230
1231         // Figure out the highest numeric value visible on a label
1232         const QSize areaSize = viewport_->size();
1233         const Timestamp max_time = max(fabs(offset_),
1234                 fabs(offset_ + scale_ * areaSize.width()));
1235
1236         double min_width = SpacingIncrement;
1237         double label_width, tick_period_width;
1238
1239         QFontMetrics m(QApplication::font());
1240
1241         // Copies of the member variables with the same name, used in the calculation
1242         // and written back afterwards, so that we don't emit signals all the time
1243         // during the calculation.
1244         pv::util::Timestamp tick_period = tick_period_;
1245         pv::util::SIPrefix tick_prefix = tick_prefix_;
1246         unsigned tick_precision = tick_precision_;
1247
1248         do {
1249                 const double min_period = scale_ * min_width;
1250
1251                 const int order = (int)floorf(log10f(min_period));
1252                 const pv::util::Timestamp order_decimal =
1253                         pow(pv::util::Timestamp(10), order);
1254
1255                 // Allow for a margin of error so that a scale unit of 1 can be used.
1256                 // Otherwise, for a SU of 1 the tick period will almost always be below
1257                 // the min_period by a small amount - and thus skipped in favor of 2.
1258                 // Note: margin assumes that SU[0] and SU[1] contain the smallest values
1259                 double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
1260                 double tp_with_margin;
1261                 unsigned int unit = 0;
1262
1263                 do {
1264                         tp_with_margin = order_decimal.convert_to<double>() *
1265                                 (ScaleUnits[unit++] + tp_margin);
1266                 } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
1267
1268                 minor_tick_count_ = (unit == 2) ? 4 : 5;
1269                 tick_period = order_decimal * ScaleUnits[unit - 1];
1270                 tick_prefix = static_cast<pv::util::SIPrefix>(
1271                         (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3);
1272
1273                 // Precision is the number of fractional digits required, not
1274                 // taking the prefix into account (and it must never be negative)
1275                 tick_precision = max(ceil(log10(1 / tick_period)).convert_to<int>(), 0);
1276
1277                 tick_period_width = (tick_period / scale_).convert_to<double>();
1278
1279                 const QString label_text = Ruler::format_time_with_distance(
1280                         tick_period, max_time, tick_prefix, time_unit_, tick_precision);
1281
1282                 label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
1283                         Qt::AlignLeft | Qt::AlignTop, label_text).width() +
1284                                 MinValueSpacing;
1285
1286                 min_width += SpacingIncrement;
1287         } while (tick_period_width < label_width);
1288
1289         set_tick_period(tick_period);
1290         set_tick_prefix(tick_prefix);
1291         set_tick_precision(tick_precision);
1292 }
1293
1294 void View::adjust_top_margin()
1295 {
1296         assert(viewport_);
1297
1298         const QSize areaSize = viewport_->size();
1299
1300         const pair<int, int> extents = v_extents();
1301         const int top_margin = owner_visual_v_offset() + extents.first;
1302         const int trace_bottom = owner_visual_v_offset() + extents.first + extents.second;
1303
1304         // Do we have empty space at the top while the last trace goes out of screen?
1305         if ((top_margin > 0) && (trace_bottom > areaSize.height())) {
1306                 const int trace_height = extents.second - extents.first;
1307
1308                 // Center everything vertically if there is enough space
1309                 if (areaSize.height() >= trace_height)
1310                         set_v_offset(extents.first -
1311                                 ((areaSize.height() - trace_height) / 2));
1312                 else
1313                         // Remove the top margin to make as many traces fit on screen as possible
1314                         set_v_offset(extents.first);
1315         }
1316 }
1317
1318 void View::update_scroll()
1319 {
1320         assert(viewport_);
1321         QScrollBar *hscrollbar = scrollarea_->horizontalScrollBar();
1322         QScrollBar *vscrollbar = scrollarea_->verticalScrollBar();
1323
1324         const QSize areaSize = viewport_->size();
1325
1326         // Set the horizontal scroll bar
1327         double length = 0;
1328         Timestamp offset;
1329         get_scroll_layout(length, offset);
1330         length = max(length - areaSize.width(), 0.0);
1331
1332         int major_tick_distance = (tick_period_ / scale_).convert_to<int>();
1333
1334         hscrollbar->setPageStep(areaSize.width() / 2);
1335         hscrollbar->setSingleStep(major_tick_distance);
1336
1337         updating_scroll_ = true;
1338
1339         if (length < MaxScrollValue) {
1340                 hscrollbar->setRange(0, length);
1341                 hscrollbar->setSliderPosition(offset.convert_to<double>());
1342         } else {
1343                 hscrollbar->setRange(0, MaxScrollValue);
1344                 hscrollbar->setSliderPosition(
1345                         (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
1346         }
1347
1348         updating_scroll_ = false;
1349
1350         // Set the vertical scrollbar
1351         vscrollbar->setPageStep(areaSize.height());
1352         vscrollbar->setSingleStep(areaSize.height() / 8);
1353
1354         const pair<int, int> extents = v_extents();
1355
1356         // Don't change the scrollbar range if there are no traces
1357         if (extents.first != extents.second) {
1358                 int top_margin = ViewScrollMargin;
1359                 int btm_margin = ViewScrollMargin;
1360
1361                 vscrollbar->setRange(extents.first - areaSize.height() + top_margin,
1362                         extents.second - btm_margin);
1363         }
1364
1365         if (scroll_needs_defaults_) {
1366                 set_scroll_default();
1367                 scroll_needs_defaults_ = false;
1368         }
1369 }
1370
1371 void View::reset_scroll()
1372 {
1373         scrollarea_->verticalScrollBar()->setRange(0, 0);
1374 }
1375
1376 void View::set_scroll_default()
1377 {
1378         assert(viewport_);
1379
1380         const QSize areaSize = viewport_->size();
1381
1382         const pair<int, int> extents = v_extents();
1383         const int trace_height = extents.second - extents.first;
1384
1385         // Do all traces fit in the view?
1386         if (areaSize.height() >= trace_height)
1387                 // Center all traces vertically
1388                 set_v_offset(extents.first -
1389                         ((areaSize.height() - trace_height) / 2));
1390         else
1391                 // Put the first trace at the top, letting the bottom ones overflow
1392                 set_v_offset(extents.first);
1393 }
1394
1395 void View::determine_if_header_was_shrunk()
1396 {
1397         const int header_pane_width =
1398                 splitter_->sizes().front();  // clazy:exclude=detaching-temporary
1399
1400         // Allow for a slight margin of error so that we also accept
1401         // slight differences when e.g. a label name change increased
1402         // the overall width
1403         header_was_shrunk_ = (header_pane_width < (header_width() - 10));
1404 }
1405
1406 void View::resize_header_to_fit()
1407 {
1408         // Setting the maximum width of the header widget doesn't work as
1409         // expected because the splitter would allow the user to make the
1410         // pane wider than that, creating empty space as a result.
1411         // To make this work, we stricly enforce the maximum width by
1412         // expanding the header unless the user shrunk it on purpose.
1413         // As we're then setting the width of the header pane, we set the
1414         // splitter to the maximum allowed position.
1415
1416         int splitter_area_width = 0;
1417         for (int w : splitter_->sizes())  // clazy:exclude=range-loop
1418                 splitter_area_width += w;
1419
1420         // Make sure the header has enough horizontal space to show all labels fully
1421         QList<int> pane_sizes;
1422         pane_sizes.push_back(header_->extended_size_hint().width());
1423         pane_sizes.push_back(splitter_area_width - header_->extended_size_hint().width());
1424         splitter_->setSizes(pane_sizes);
1425 }
1426
1427 void View::update_layout()
1428 {
1429         update_scroll();
1430 }
1431
1432 TraceTreeItemOwner* View::find_prevalent_trace_group(
1433         const shared_ptr<sigrok::ChannelGroup> &group,
1434         const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map)
1435 {
1436         assert(group);
1437
1438         set<TraceTreeItemOwner*> owners;
1439         vector<TraceTreeItemOwner*> owner_list;
1440
1441         // Make a set and a list of all the owners
1442         for (const auto& channel : group->channels()) {
1443                 for (auto& entry : signal_map) {
1444                         if (entry.first->channel() == channel) {
1445                                 TraceTreeItemOwner *const o = (entry.second)->owner();
1446                                 owner_list.push_back(o);
1447                                 owners.insert(o);
1448                         }
1449                 }
1450         }
1451
1452         // Iterate through the list of owners, and find the most prevalent
1453         size_t max_prevalence = 0;
1454         TraceTreeItemOwner *prevalent_owner = nullptr;
1455         for (TraceTreeItemOwner *owner : owners) {
1456                 const size_t prevalence = count_if(
1457                         owner_list.begin(), owner_list.end(),
1458                         [&](TraceTreeItemOwner *o) { return o == owner; });
1459                 if (prevalence > max_prevalence) {
1460                         max_prevalence = prevalence;
1461                         prevalent_owner = owner;
1462                 }
1463         }
1464
1465         return prevalent_owner;
1466 }
1467
1468 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
1469         const vector< shared_ptr<sigrok::Channel> > &channels,
1470         const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map,
1471         set< shared_ptr<Trace> > &add_list)
1472 {
1473         vector< shared_ptr<Trace> > filtered_traces;
1474
1475         for (const auto& channel : channels) {
1476                 for (auto& entry : signal_map) {
1477                         if (entry.first->channel() == channel) {
1478                                 shared_ptr<Trace> trace = entry.second;
1479                                 const auto list_iter = add_list.find(trace);
1480                                 if (list_iter == add_list.end())
1481                                         continue;
1482
1483                                 filtered_traces.push_back(trace);
1484                                 add_list.erase(list_iter);
1485                         }
1486                 }
1487         }
1488
1489         return filtered_traces;
1490 }
1491
1492 void View::determine_time_unit()
1493 {
1494         // Check whether we know the sample rate and hence can use time as the unit
1495         if (time_unit_ == util::TimeUnit::Samples) {
1496                 // Check all signals but...
1497                 for (const shared_ptr<Signal>& signal : signals_) {
1498                         const shared_ptr<SignalData> data = signal->data();
1499
1500                         // ...only check first segment of each
1501                         const vector< shared_ptr<Segment> > segments = data->segments();
1502                         if (!segments.empty())
1503                                 if (segments[0]->samplerate()) {
1504                                         set_time_unit(util::TimeUnit::Time);
1505                                         break;
1506                                 }
1507                 }
1508         }
1509 }
1510
1511 bool View::eventFilter(QObject *object, QEvent *event)
1512 {
1513         const QEvent::Type type = event->type();
1514
1515         if (type == QEvent::MouseMove) {
1516
1517                 if (object)
1518                         hover_widget_ = qobject_cast<QWidget*>(object);
1519
1520                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1521                 if (object == viewport_)
1522                         hover_point_ = mouse_event->pos();
1523                 else if (object == ruler_)
1524                         hover_point_ = mouse_event->pos();
1525                 else if (object == header_)
1526                         hover_point_ = QPoint(0, mouse_event->y());
1527                 else
1528                         hover_point_ = QPoint(-1, -1);
1529
1530                 update_hover_point();
1531
1532                 if (grabbed_widget_) {
1533                         int64_t nearest = get_nearest_level_change(hover_point_);
1534                         pv::util::Timestamp mouse_time = offset_ + hover_point_.x() * scale_;
1535
1536                         if (nearest == -1) {
1537                                 grabbed_widget_->set_time(mouse_time);
1538                         } else {
1539                                 grabbed_widget_->set_time(nearest / get_signal_under_mouse_cursor()->base()->get_samplerate());
1540                         }
1541                 }
1542
1543         } else if (type == QEvent::MouseButtonPress) {
1544                 grabbed_widget_ = nullptr;
1545
1546                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
1547                 if ((object == viewport_) && (mouse_event->button() & Qt::LeftButton)) {
1548                         // Send event to all trace tree items
1549                         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1550                                 list_by_type<TraceTreeItem>());
1551                         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1552                                 r->mouse_left_press_event(mouse_event);
1553                 }
1554         } else if (type == QEvent::Leave) {
1555                 hover_point_ = QPoint(-1, -1);
1556                 update_hover_point();
1557         } else if (type == QEvent::Show) {
1558
1559                 // This is somewhat of a hack, unfortunately. We cannot use
1560                 // set_v_offset() from within restore_settings() as the view
1561                 // at that point is neither visible nor properly sized.
1562                 // This is the least intrusive workaround I could come up
1563                 // with: set the vertical offset (or scroll defaults) when
1564                 // the view is shown, which happens after all widgets were
1565                 // resized to their final sizes.
1566                 update_layout();
1567
1568                 if (settings_restored_)
1569                         determine_if_header_was_shrunk();
1570                 else
1571                         resize_header_to_fit();
1572
1573                 if (scroll_needs_defaults_) {
1574                         set_scroll_default();
1575                         scroll_needs_defaults_ = false;
1576                 }
1577
1578                 if (saved_v_offset_) {
1579                         set_v_offset(saved_v_offset_);
1580                         saved_v_offset_ = 0;
1581                 }
1582         }
1583
1584         return QObject::eventFilter(object, event);
1585 }
1586
1587 void View::contextMenuEvent(QContextMenuEvent *event)
1588 {
1589         QPoint pos = event->pos() - QPoint(0, ruler_->sizeHint().height());
1590
1591         const shared_ptr<ViewItem> r = viewport_->get_mouse_over_item(pos);
1592         if (!r)
1593                 return;
1594
1595         QMenu *menu = r->create_view_context_menu(this, pos);
1596         if (menu)
1597                 menu->popup(event->globalPos());
1598 }
1599
1600 void View::resizeEvent(QResizeEvent* event)
1601 {
1602         // Only adjust the top margin if we shrunk vertically
1603         if (event->size().height() < event->oldSize().height())
1604                 adjust_top_margin();
1605
1606         update_layout();
1607 }
1608
1609 void View::update_hover_point()
1610 {
1611         // Determine signal that the mouse cursor is hovering over
1612         signal_under_mouse_cursor_.reset();
1613         if (hover_widget_ == this) {
1614                 for (const shared_ptr<Signal>& s : signals_) {
1615                         const pair<int, int> extents = s->v_extents();
1616                         const int top = s->get_visual_y() + extents.first;
1617                         const int btm = s->get_visual_y() + extents.second;
1618                         if ((hover_point_.y() >= top) && (hover_point_.y() <= btm)
1619                                 && s->base()->enabled())
1620                                 signal_under_mouse_cursor_ = s;
1621                 }
1622         }
1623
1624         // Update all trace tree items
1625         const vector<shared_ptr<TraceTreeItem>> trace_tree_items(
1626                 list_by_type<TraceTreeItem>());
1627         for (const shared_ptr<TraceTreeItem>& r : trace_tree_items)
1628                 r->hover_point_changed(hover_point_);
1629
1630         // Notify this view's listeners
1631         hover_point_changed(hover_widget_, hover_point_);
1632
1633         // Hover point is -1 when invalid and 0 for the header
1634         if (hover_point_.x() > 0) {
1635                 // Notify global listeners
1636                 pv::util::Timestamp mouse_time = offset_ + hover_point_.x() * scale_;
1637                 int64_t sample_num = (mouse_time * session_.get_samplerate()).convert_to<int64_t>();
1638
1639                 MetadataObject* md_obj =
1640                         session_.metadata_obj_manager()->find_object_by_type(MetadataObjMousePos);
1641                 md_obj->set_value(MetadataValueStartSample, QVariant((qlonglong)sample_num));
1642         }
1643 }
1644
1645 void View::row_item_appearance_changed(bool label, bool content)
1646 {
1647         if (label)
1648                 header_->update();
1649         if (content)
1650                 viewport_->update();
1651 }
1652
1653 void View::time_item_appearance_changed(bool label, bool content)
1654 {
1655         if (label) {
1656                 ruler_->update();
1657
1658                 // Make sure the header pane width is updated, too
1659                 update_layout();
1660         }
1661
1662         if (content)
1663                 viewport_->update();
1664 }
1665
1666 void View::extents_changed(bool horz, bool vert)
1667 {
1668         sticky_events_ |=
1669                 (horz ? TraceTreeItemHExtentsChanged : 0) |
1670                 (vert ? TraceTreeItemVExtentsChanged : 0);
1671
1672         if (!lazy_event_handler_.isActive())
1673                 lazy_event_handler_.start();
1674 }
1675
1676 void View::on_signal_name_changed()
1677 {
1678         if (!header_was_shrunk_)
1679                 resize_header_to_fit();
1680 }
1681
1682 void View::on_splitter_moved()
1683 {
1684         // The header can only shrink when the splitter is moved manually
1685         determine_if_header_was_shrunk();
1686
1687         if (!header_was_shrunk_)
1688                 resize_header_to_fit();
1689 }
1690
1691 void View::on_zoom_in_shortcut_triggered()
1692 {
1693         zoom(1);
1694 }
1695
1696 void View::on_zoom_out_shortcut_triggered()
1697 {
1698         zoom(-1);
1699 }
1700
1701 void View::on_scroll_to_start_shortcut_triggered()
1702 {
1703         set_h_offset(0);
1704 }
1705
1706 void View::on_scroll_to_end_shortcut_triggered()
1707 {
1708         set_h_offset(get_h_scrollbar_maximum());
1709 }
1710
1711 void View::h_scroll_value_changed(int value)
1712 {
1713         if (updating_scroll_)
1714                 return;
1715
1716         // Disable sticky scrolling when user moves the horizontal scroll bar
1717         // during a running acquisition
1718         if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
1719                 sticky_scrolling_ = false;
1720                 sticky_scrolling_changed(false);
1721         }
1722
1723         const int range = scrollarea_->horizontalScrollBar()->maximum();
1724         if (range < MaxScrollValue)
1725                 set_offset(scale_ * value);
1726         else {
1727                 double length = 0;
1728                 Timestamp offset;
1729                 get_scroll_layout(length, offset);
1730                 set_offset(scale_ * length * value / MaxScrollValue);
1731         }
1732
1733         ruler_->update();
1734         viewport_->update();
1735 }
1736
1737 void View::v_scroll_value_changed()
1738 {
1739         header_->update();
1740         viewport_->update();
1741 }
1742
1743 void View::on_grab_ruler(int ruler_id)
1744 {
1745         if (!cursors_shown()) {
1746                 center_cursors();
1747                 show_cursors();
1748         }
1749
1750         // Release the grabbed widget if its trigger hotkey was pressed twice
1751         if (ruler_id == 1)
1752                 grabbed_widget_ = (grabbed_widget_ == cursors_->first().get()) ?
1753                         nullptr : cursors_->first().get();
1754         else
1755                 grabbed_widget_ = (grabbed_widget_ == cursors_->second().get()) ?
1756                         nullptr : cursors_->second().get();
1757
1758         if (grabbed_widget_)
1759                 grabbed_widget_->set_time(ruler_->get_absolute_time_from_x_pos(
1760                         mapFromGlobal(QCursor::pos()).x() - header_width()));
1761 }
1762
1763 void View::signals_changed()
1764 {
1765         using sigrok::Channel;
1766
1767         lock_guard<mutex> lock(signal_mutex_);
1768
1769         vector< shared_ptr<Channel> > channels;
1770         shared_ptr<sigrok::Device> sr_dev;
1771         bool signals_added_or_removed = false;
1772
1773         // Do we need to set the vertical scrollbar to its default position later?
1774         // We do if there are no traces, i.e. the scroll bar has no range set
1775         bool reset_scrollbar =
1776                 (scrollarea_->verticalScrollBar()->minimum() ==
1777                         scrollarea_->verticalScrollBar()->maximum());
1778
1779         if (!session_.device()) {
1780                 reset_scroll();
1781                 signals_.clear();
1782         } else {
1783                 sr_dev = session_.device()->device();
1784                 assert(sr_dev);
1785                 channels = sr_dev->channels();
1786         }
1787
1788         vector< shared_ptr<TraceTreeItem> > new_top_level_items;
1789
1790         // Make a list of traces that are being added, and a list of traces
1791         // that are being removed. The set_difference() algorithms require
1792         // both sets to be in the exact same order, which means that PD signals
1793         // must always be last as they interrupt the sort order otherwise
1794         const vector<shared_ptr<Trace>> prev_trace_list = list_by_type<Trace>();
1795         const set<shared_ptr<Trace>> prev_traces(
1796                 prev_trace_list.begin(), prev_trace_list.end());
1797
1798         set< shared_ptr<Trace> > traces(signals_.begin(), signals_.end());
1799
1800 #ifdef ENABLE_DECODE
1801         traces.insert(decode_traces_.begin(), decode_traces_.end());
1802 #endif
1803         set< shared_ptr<Trace> > add_traces;
1804         set_difference(traces.begin(), traces.end(),
1805                 prev_traces.begin(), prev_traces.end(),
1806                 inserter(add_traces, add_traces.begin()));
1807
1808         set< shared_ptr<Trace> > remove_traces;
1809         set_difference(prev_traces.begin(), prev_traces.end(),
1810                 traces.begin(), traces.end(),
1811                 inserter(remove_traces, remove_traces.begin()));
1812
1813         // Make a look-up table of sigrok Channels to pulseview Signals
1814         map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > signal_map;
1815         for (const shared_ptr<Signal>& sig : signals_)
1816                 signal_map[sig->base()] = sig;
1817
1818         // Populate channel groups
1819         if (sr_dev)
1820                 for (auto& entry : sr_dev->channel_groups()) {
1821                         const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
1822
1823                         if (group->channels().size() <= 1)
1824                                 continue;
1825
1826                         // Find best trace group to add to
1827                         TraceTreeItemOwner *owner = find_prevalent_trace_group(
1828                                 group, signal_map);
1829
1830                         // If there is no trace group, create one
1831                         shared_ptr<TraceGroup> new_trace_group;
1832                         if (!owner) {
1833                                 new_trace_group.reset(new TraceGroup());
1834                                 owner = new_trace_group.get();
1835                         }
1836
1837                         // Extract traces for the trace group, removing them from
1838                         // the add list
1839                         const vector< shared_ptr<Trace> > new_traces_in_group =
1840                                 extract_new_traces_for_channels(group->channels(),
1841                                         signal_map, add_traces);
1842
1843                         // Add the traces to the group
1844                         const pair<int, int> prev_v_extents = owner->v_extents();
1845                         int offset = prev_v_extents.second - prev_v_extents.first;
1846                         for (const shared_ptr<Trace>& trace : new_traces_in_group) {
1847                                 assert(trace);
1848                                 owner->add_child_item(trace);
1849
1850                                 const pair<int, int> extents = trace->v_extents();
1851                                 if (trace->enabled())
1852                                         offset += -extents.first;
1853                                 trace->force_to_v_offset(offset);
1854                                 if (trace->enabled())
1855                                         offset += extents.second;
1856                         }
1857
1858                         if (new_trace_group) {
1859                                 // Assign proper vertical offsets to each channel in the group
1860                                 new_trace_group->restack_items();
1861
1862                                 // If this is a new group, enqueue it in the new top level
1863                                 // items list
1864                                 if (!new_traces_in_group.empty())
1865                                         new_top_level_items.push_back(new_trace_group);
1866                         }
1867                 }
1868
1869         // Enqueue the remaining logic channels in a group
1870         vector< shared_ptr<Channel> > logic_channels;
1871         copy_if(channels.begin(), channels.end(), back_inserter(logic_channels),
1872                 [](const shared_ptr<Channel>& c) {
1873                         return c->type() == sigrok::ChannelType::LOGIC; });
1874
1875         const vector< shared_ptr<Trace> > non_grouped_logic_signals =
1876                 extract_new_traces_for_channels(logic_channels, signal_map, add_traces);
1877
1878         if (non_grouped_logic_signals.size() > 0) {
1879                 const shared_ptr<TraceGroup> non_grouped_trace_group(
1880                         make_shared<TraceGroup>());
1881                 for (const shared_ptr<Trace>& trace : non_grouped_logic_signals)
1882                         non_grouped_trace_group->add_child_item(trace);
1883
1884                 non_grouped_trace_group->restack_items();
1885                 new_top_level_items.push_back(non_grouped_trace_group);
1886         }
1887
1888         // Enqueue the remaining channels as free ungrouped traces
1889         const vector< shared_ptr<Trace> > new_top_level_signals =
1890                 extract_new_traces_for_channels(channels, signal_map, add_traces);
1891         new_top_level_items.insert(new_top_level_items.end(),
1892                 new_top_level_signals.begin(), new_top_level_signals.end());
1893
1894         // Enqueue any remaining traces i.e. decode traces
1895         new_top_level_items.insert(new_top_level_items.end(),
1896                 add_traces.begin(), add_traces.end());
1897
1898         // Remove any removed traces
1899         for (const shared_ptr<Trace>& trace : remove_traces) {
1900                 TraceTreeItemOwner *const owner = trace->owner();
1901                 assert(owner);
1902                 owner->remove_child_item(trace);
1903                 signals_added_or_removed = true;
1904         }
1905
1906         // Remove any empty trace groups
1907         for (shared_ptr<TraceGroup> group : list_by_type<TraceGroup>())
1908                 if (group->child_items().size() == 0) {
1909                         remove_child_item(group);
1910                         group.reset();
1911                 }
1912
1913         // Add and position the pending top levels items
1914         int offset = v_extents().second;
1915         for (shared_ptr<TraceTreeItem> item : new_top_level_items) {
1916                 // items may already have gained an owner when they were added to a group above
1917                 if (item->owner())
1918                         continue;
1919
1920                 add_child_item(item);
1921
1922                 // Position the item after the last item or at the top if there is none
1923                 const pair<int, int> extents = item->v_extents();
1924
1925                 if (item->enabled())
1926                         offset += -extents.first;
1927
1928                 item->force_to_v_offset(offset);
1929
1930                 if (item->enabled())
1931                         offset += extents.second;
1932                 signals_added_or_removed = true;
1933         }
1934
1935
1936         if (signals_added_or_removed && !header_was_shrunk_)
1937                 resize_header_to_fit();
1938
1939         update_layout();
1940
1941         header_->update();
1942         viewport_->update();
1943
1944         if (reset_scrollbar)
1945                 set_scroll_default();
1946 }
1947
1948 void View::capture_state_updated(int state)
1949 {
1950         GlobalSettings settings;
1951
1952         if (state == Session::Running) {
1953                 set_time_unit(util::TimeUnit::Samples);
1954
1955                 trigger_markers_.clear();
1956                 if (!custom_zero_offset_set_)
1957                         set_zero_position(0);
1958
1959                 scale_at_acq_start_ = scale_;
1960                 offset_at_acq_start_ = offset_;
1961
1962                 // Activate "always zoom to fit" if the setting is enabled and we're
1963                 // the main view of this session (other trace views may be used for
1964                 // zooming and we don't want to mess them up)
1965                 bool state = settings.value(GlobalSettings::Key_View_ZoomToFitDuringAcq).toBool();
1966                 if (is_main_view_ && state) {
1967                         always_zoom_to_fit_ = true;
1968                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1969                 }
1970
1971                 // Enable sticky scrolling if the setting is enabled
1972                 sticky_scrolling_ = settings.value(GlobalSettings::Key_View_StickyScrolling).toBool();
1973
1974                 // Reset all traces to segment 0
1975                 current_segment_ = 0;
1976                 set_current_segment(current_segment_);
1977         }
1978
1979         if (state == Session::Stopped) {
1980                 // After acquisition has stopped we need to re-calculate the ticks once
1981                 // as it's otherwise done when the user pans or zooms, which is too late
1982                 calculate_tick_spacing();
1983
1984                 // Reset "always zoom to fit", the acquisition has stopped
1985                 if (always_zoom_to_fit_) {
1986                         // Perform a final zoom-to-fit before disabling
1987                         zoom_fit(always_zoom_to_fit_);
1988                         always_zoom_to_fit_ = false;
1989                         always_zoom_to_fit_changed(always_zoom_to_fit_);
1990                 }
1991
1992                 bool zoom_to_fit_after_acq =
1993                         settings.value(GlobalSettings::Key_View_ZoomToFitAfterAcq).toBool();
1994
1995                 // Only perform zoom-to-fit if the user hasn't altered the viewport and
1996                 // we didn't restore settings in the meanwhile
1997                 if (zoom_to_fit_after_acq &&
1998                         !suppress_zoom_to_fit_after_acq_ &&
1999                         (scale_ == scale_at_acq_start_) &&
2000                         (offset_ == offset_at_acq_start_))
2001                         zoom_fit(false);  // We're stopped, so the GUI state doesn't matter
2002
2003                 suppress_zoom_to_fit_after_acq_ = false;
2004         }
2005 }
2006
2007 void View::on_new_segment(int new_segment_id)
2008 {
2009         on_segment_changed(new_segment_id);
2010 }
2011
2012 void View::on_segment_completed(int segment_id)
2013 {
2014         on_segment_changed(segment_id);
2015 }
2016
2017 void View::on_segment_changed(int segment)
2018 {
2019         switch (segment_display_mode_) {
2020         case Trace::ShowLastSegmentOnly:
2021         case Trace::ShowSingleSegmentOnly:
2022                 set_current_segment(segment);
2023                 break;
2024
2025         case Trace::ShowLastCompleteSegmentOnly:
2026                 // Only update if all segments are complete
2027                 if (session_.all_segments_complete(segment))
2028                         set_current_segment(segment);
2029                 break;
2030
2031         case Trace::ShowAllSegments:
2032         case Trace::ShowAccumulatedIntensity:
2033         default:
2034                 break;
2035         }
2036 }
2037
2038 void View::on_settingViewTriggerIsZeroTime_changed(const QVariant new_value)
2039 {
2040         (void)new_value;
2041
2042         if (!custom_zero_offset_set_)
2043                 reset_zero_position();
2044 }
2045
2046 void View::perform_delayed_view_update()
2047 {
2048         if (always_zoom_to_fit_) {
2049                 zoom_fit(true);
2050         } else if (sticky_scrolling_) {
2051                 // Make right side of the view sticky
2052                 double length = 0;
2053                 Timestamp offset;
2054                 get_scroll_layout(length, offset);
2055
2056                 const QSize areaSize = viewport_->size();
2057                 length = max(length - areaSize.width(), 0.0);
2058
2059                 set_offset(scale_ * length);
2060         }
2061
2062         determine_time_unit();
2063         update_scroll();
2064         ruler_->update();
2065         viewport_->update();
2066 }
2067
2068 void View::process_sticky_events()
2069 {
2070         if (sticky_events_ & TraceTreeItemHExtentsChanged)
2071                 update_layout();
2072         if (sticky_events_ & TraceTreeItemVExtentsChanged) {
2073                 restack_all_trace_tree_items();
2074                 update_scroll();
2075         }
2076
2077         // Clear the sticky events
2078         sticky_events_ = 0;
2079 }
2080
2081 } // namespace trace
2082 } // namespace views
2083 } // namespace pv