Reordered argument handling
[pulseview.git] / pv / view / 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifdef ENABLE_DECODE
22 #include <libsigrokdecode/libsigrokdecode.h>
23 #endif
24
25 #include <extdef.h>
26
27 #include <cassert>
28 #include <climits>
29 #include <cmath>
30 #include <mutex>
31 #include <unordered_set>
32
33 #include <QApplication>
34 #include <QEvent>
35 #include <QFontMetrics>
36 #include <QMouseEvent>
37 #include <QScrollBar>
38
39 #include <libsigrokcxx/libsigrokcxx.hpp>
40
41 #include "decodetrace.hpp"
42 #include "header.hpp"
43 #include "logicsignal.hpp"
44 #include "ruler.hpp"
45 #include "signal.hpp"
46 #include "tracegroup.hpp"
47 #include "view.hpp"
48 #include "viewport.hpp"
49
50 #include "pv/session.hpp"
51 #include "pv/devices/device.hpp"
52 #include "pv/data/logic.hpp"
53 #include "pv/data/logicsegment.hpp"
54 #include "pv/util.hpp"
55
56 using boost::shared_lock;
57 using boost::shared_mutex;
58
59 using pv::data::SignalData;
60 using pv::data::Segment;
61 using pv::util::format_time;
62
63 using std::deque;
64 using std::dynamic_pointer_cast;
65 using std::list;
66 using std::lock_guard;
67 using std::max;
68 using std::make_pair;
69 using std::min;
70 using std::pair;
71 using std::set;
72 using std::shared_ptr;
73 using std::unordered_map;
74 using std::unordered_set;
75 using std::vector;
76 using std::weak_ptr;
77
78 namespace pv {
79 namespace view {
80
81 const double View::MaxScale = 1e9;
82 const double View::MinScale = 1e-15;
83
84 const int View::MaxScrollValue = INT_MAX / 2;
85
86 const int View::ScaleUnits[3] = {1, 2, 5};
87
88 View::View(Session &session, QWidget *parent) :
89         QAbstractScrollArea(parent),
90         session_(session),
91         viewport_(new Viewport(*this)),
92         ruler_(new Ruler(*this)),
93         header_(new Header(*this)),
94         scale_(1e-6),
95         offset_(0),
96         updating_scroll_(false),
97         tick_period_(0.0),
98         tick_prefix_(0),
99         show_cursors_(false),
100         cursors_(new CursorPair(*this)),
101         next_flag_text_('A'),
102         hover_point_(-1, -1)
103 {
104         connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
105                 this, SLOT(h_scroll_value_changed(int)));
106         connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
107                 this, SLOT(v_scroll_value_changed()));
108
109         connect(&session_, SIGNAL(signals_changed()),
110                 this, SLOT(signals_changed()));
111         connect(&session_, SIGNAL(capture_state_changed(int)),
112                 this, SLOT(data_updated()));
113         connect(&session_, SIGNAL(data_received()),
114                 this, SLOT(data_updated()));
115         connect(&session_, SIGNAL(frame_ended()),
116                 this, SLOT(data_updated()));
117
118         connect(header_, SIGNAL(selection_changed()),
119                 ruler_, SLOT(clear_selection()));
120         connect(ruler_, SIGNAL(selection_changed()),
121                 header_, SLOT(clear_selection()));
122
123         connect(header_, SIGNAL(selection_changed()),
124                 this, SIGNAL(selection_changed()));
125         connect(ruler_, SIGNAL(selection_changed()),
126                 this, SIGNAL(selection_changed()));
127
128         connect(this, SIGNAL(hover_point_changed()),
129                 this, SLOT(on_hover_point_changed()));
130
131         connect(&lazy_event_handler_, SIGNAL(timeout()),
132                 this, SLOT(process_sticky_events()));
133         lazy_event_handler_.setSingleShot(true);
134
135         setViewport(viewport_);
136
137         viewport_->installEventFilter(this);
138         ruler_->installEventFilter(this);
139         header_->installEventFilter(this);
140
141         // Trigger the initial event manually. The default device has signals
142         // which were created before this object came into being
143         signals_changed();
144
145         // make sure the transparent widgets are on the top
146         ruler_->raise();
147         header_->raise();
148
149         // Update the zoom state
150         calculate_tick_spacing();
151 }
152
153 Session& View::session()
154 {
155         return session_;
156 }
157
158 const Session& View::session() const
159 {
160         return session_;
161 }
162
163 View* View::view()
164 {
165         return this;
166 }
167
168 const View* View::view() const
169 {
170         return this;
171 }
172
173 Viewport* View::viewport()
174 {
175         return viewport_;
176 }
177
178 const Viewport* View::viewport() const
179 {
180         return viewport_;
181 }
182
183 vector< shared_ptr<TimeItem> > View::time_items() const
184 {
185         const vector<shared_ptr<Flag>> f(flags());
186         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
187         items.push_back(cursors_);
188         items.push_back(cursors_->first());
189         items.push_back(cursors_->second());
190         return items;
191 }
192
193 double View::scale() const
194 {
195         return scale_;
196 }
197
198 double View::offset() const
199 {
200         return offset_;
201 }
202
203 int View::owner_visual_v_offset() const
204 {
205         return -verticalScrollBar()->sliderPosition();
206 }
207
208 void View::set_v_offset(int offset)
209 {
210         verticalScrollBar()->setSliderPosition(offset);
211         header_->update();
212         viewport_->update();
213 }
214
215 unsigned int View::depth() const
216 {
217         return 0;
218 }
219
220 unsigned int View::tick_prefix() const
221 {
222         return tick_prefix_;
223 }
224
225 double View::tick_period() const
226 {
227         return tick_period_;
228 }
229
230 void View::zoom(double steps)
231 {
232         zoom(steps, viewport_->width() / 2);
233 }
234
235 void View::zoom(double steps, int offset)
236 {
237         set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
238 }
239
240 void View::zoom_fit()
241 {
242         const pair<double, double> extents = get_time_extents();
243         const double delta = extents.second - extents.first;
244         if (delta < 1e-12)
245                 return;
246
247         assert(viewport_);
248         const int w = viewport_->width();
249         if (w <= 0)
250                 return;
251
252         const double scale = max(min(delta / w, MaxScale), MinScale);
253         set_scale_offset(scale, extents.first);
254 }
255
256 void View::zoom_one_to_one()
257 {
258         using pv::data::SignalData;
259
260         // Make a set of all the visible data objects
261         set< shared_ptr<SignalData> > visible_data = get_visible_data();
262         if (visible_data.empty())
263                 return;
264
265         double samplerate = 0.0;
266         for (const shared_ptr<SignalData> d : visible_data) {
267                 assert(d);
268                 const vector< shared_ptr<Segment> > segments =
269                         d->segments();
270                 for (const shared_ptr<Segment> &s : segments)
271                         samplerate = max(samplerate, s->samplerate());
272         }
273
274         if (samplerate == 0.0)
275                 return;
276
277         assert(viewport_);
278         const int w = viewport_->width();
279         if (w <= 0)
280                 return;
281
282         set_zoom(1.0 / samplerate, w / 2);
283 }
284
285 void View::set_scale_offset(double scale, double offset)
286 {
287         scale_ = scale;
288         offset_ = offset;
289
290         calculate_tick_spacing();
291
292         update_scroll();
293         ruler_->update();
294         viewport_->update();
295         scale_offset_changed();
296 }
297
298 set< shared_ptr<SignalData> > View::get_visible_data() const
299 {
300         shared_lock<shared_mutex> lock(session().signals_mutex());
301         const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
302
303         // Make a set of all the visible data objects
304         set< shared_ptr<SignalData> > visible_data;
305         for (const shared_ptr<Signal> sig : sigs)
306                 if (sig->enabled())
307                         visible_data.insert(sig->data());
308
309         return visible_data;
310 }
311
312 pair<double, double> View::get_time_extents() const
313 {
314         double left_time = DBL_MAX, right_time = DBL_MIN;
315         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
316         for (const shared_ptr<SignalData> d : visible_data)
317         {
318                 const vector< shared_ptr<Segment> > segments =
319                         d->segments();
320                 for (const shared_ptr<Segment> &s : segments) {
321                         double samplerate = s->samplerate();
322                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
323
324                         const double start_time = s->start_time();
325                         left_time = min(left_time, start_time);
326                         right_time = max(right_time, start_time +
327                                 d->max_sample_count() / samplerate);
328                 }
329         }
330
331         if (left_time == DBL_MAX && right_time == DBL_MIN)
332                 return make_pair(0.0, 0.0);
333
334         assert(left_time < right_time);
335         return make_pair(left_time, right_time);
336 }
337
338 bool View::cursors_shown() const
339 {
340         return show_cursors_;
341 }
342
343 void View::show_cursors(bool show)
344 {
345         show_cursors_ = show;
346         ruler_->update();
347         viewport_->update();
348 }
349
350 void View::centre_cursors()
351 {
352         const double time_width = scale_ * viewport_->width();
353         cursors_->first()->set_time(offset_ + time_width * 0.4);
354         cursors_->second()->set_time(offset_ + time_width * 0.6);
355         ruler_->update();
356         viewport_->update();
357 }
358
359 std::shared_ptr<CursorPair> View::cursors() const
360 {
361         return cursors_;
362 }
363
364 void View::add_flag(double time)
365 {
366         flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
367                 QString("%1").arg(next_flag_text_))));
368         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
369                 (next_flag_text_ + 1);
370         time_item_appearance_changed(true, true);
371 }
372
373 void View::remove_flag(std::shared_ptr<Flag> flag)
374 {
375         flags_.remove(flag);
376         time_item_appearance_changed(true, true);
377 }
378
379 vector< std::shared_ptr<Flag> > View::flags() const
380 {
381         vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
382         stable_sort(flags.begin(), flags.end(),
383                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
384                         return a->time() < b->time();
385                 });
386
387         return flags;
388 }
389
390 const QPoint& View::hover_point() const
391 {
392         return hover_point_;
393 }
394
395 void View::update_viewport()
396 {
397         assert(viewport_);
398         viewport_->update();
399         header_->update();
400 }
401
402 void View::restack_all_row_items()
403 {
404         // Make a set of owners
405         unordered_set< RowItemOwner* > owners;
406         for (const auto &r : *this)
407                 owners.insert(r->owner());
408
409         // Make a list that is sorted from deepest first
410         vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
411         sort(sorted_owners.begin(), sorted_owners.end(),
412                 [](const RowItemOwner* a, const RowItemOwner *b) {
413                         return a->depth() > b->depth(); });
414
415         // Restack the items recursively
416         for (auto &o : sorted_owners)
417                 o->restack_items();
418
419         // Animate the items to their destination
420         for (const auto &r : *this)
421                 r->animate_to_layout_v_offset();
422 }
423
424 void View::get_scroll_layout(double &length, double &offset) const
425 {
426         const pair<double, double> extents = get_time_extents();
427         length = (extents.second - extents.first) / scale_;
428         offset = offset_ / scale_;
429 }
430
431 void View::set_zoom(double scale, int offset)
432 {
433         const double cursor_offset = offset_ + scale_ * offset;
434         const double new_scale = max(min(scale, MaxScale), MinScale);
435         const double new_offset = cursor_offset - new_scale * offset;
436         set_scale_offset(new_scale, new_offset);
437 }
438
439 void View::calculate_tick_spacing()
440 {
441         const double SpacingIncrement = 32.0f;
442         const double MinValueSpacing = 32.0f;
443
444         double min_width = SpacingIncrement, typical_width;
445
446         QFontMetrics m(QApplication::font());
447
448         do {
449                 const double min_period = scale_ * min_width;
450
451                 const int order = (int)floorf(log10f(min_period));
452                 const double order_decimal = pow(10.0, order);
453
454                 unsigned int unit = 0;
455
456                 do {
457                         tick_period_ = order_decimal * ScaleUnits[unit++];
458                 } while (tick_period_ < min_period &&
459                         unit < countof(ScaleUnits));
460
461                 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
462
463                 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
464                         Qt::AlignLeft | Qt::AlignTop,
465                         format_time(offset_, tick_prefix_)).width() +
466                                 MinValueSpacing;
467
468                 min_width += SpacingIncrement;
469
470         } while(typical_width > tick_period_ / scale_);
471 }
472
473 void View::update_scroll()
474 {
475         assert(viewport_);
476
477         const QSize areaSize = viewport_->size();
478
479         // Set the horizontal scroll bar
480         double length = 0, offset = 0;
481         get_scroll_layout(length, offset);
482         length = max(length - areaSize.width(), 0.0);
483
484         int major_tick_distance = tick_period_ / scale_;
485
486         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
487         horizontalScrollBar()->setSingleStep(major_tick_distance);
488
489         updating_scroll_ = true;
490
491         if (length < MaxScrollValue) {
492                 horizontalScrollBar()->setRange(0, length);
493                 horizontalScrollBar()->setSliderPosition(offset);
494         } else {
495                 horizontalScrollBar()->setRange(0, MaxScrollValue);
496                 horizontalScrollBar()->setSliderPosition(
497                         offset_ * MaxScrollValue / (scale_ * length));
498         }
499
500         updating_scroll_ = false;
501
502         // Set the vertical scrollbar
503         verticalScrollBar()->setPageStep(areaSize.height());
504         verticalScrollBar()->setSingleStep(areaSize.height() / 8);
505
506         const pair<int, int> extents = v_extents();
507         verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
508                 extents.second - (areaSize.height() / 2));
509 }
510
511 void View::update_layout()
512 {
513         setViewportMargins(
514                 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
515                 ruler_->sizeHint().height(), 0, 0);
516         ruler_->setGeometry(viewport_->x(), 0,
517                 viewport_->width(), ruler_->extended_size_hint().height());
518         header_->setGeometry(0, viewport_->y(),
519                 header_->extended_size_hint().width(), viewport_->height());
520         update_scroll();
521 }
522
523 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
524 {
525         (void)p;
526         (void)rect;
527         (void)hover;
528 }
529
530 QRectF View::label_rect(const QRectF &rect)
531 {
532         (void)rect;
533         return QRectF();
534 }
535
536 bool View::add_channels_to_owner(
537         const vector< shared_ptr<sigrok::Channel> > &channels,
538         RowItemOwner *owner, int &offset,
539         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
540                 &signal_map,
541         std::function<bool (shared_ptr<RowItem>)> filter_func)
542 {
543         bool any_added = false;
544
545         assert(owner);
546
547         for (const auto &channel : channels)
548         {
549                 const auto iter = signal_map.find(channel);
550                 if (iter == signal_map.end() ||
551                         (filter_func && !filter_func((*iter).second)))
552                         continue;
553
554                 shared_ptr<RowItem> row_item = (*iter).second;
555                 owner->add_child_item(row_item);
556                 apply_offset(row_item, offset);
557                 signal_map.erase(iter);
558
559                 any_added = true;
560         }
561
562         return any_added;
563 }
564
565 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
566         assert(row_item);
567         const pair<int, int> extents = row_item->v_extents();
568         if (row_item->enabled())
569                 offset += -extents.first;
570         row_item->force_to_v_offset(offset);
571         if (row_item->enabled())
572                 offset += extents.second;
573 }
574
575 bool View::eventFilter(QObject *object, QEvent *event)
576 {
577         const QEvent::Type type = event->type();
578         if (type == QEvent::MouseMove) {
579
580                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
581                 if (object == viewport_)
582                         hover_point_ = mouse_event->pos();
583                 else if (object == ruler_)
584                         hover_point_ = QPoint(mouse_event->x(), 0);
585                 else if (object == header_)
586                         hover_point_ = QPoint(0, mouse_event->y());
587                 else
588                         hover_point_ = QPoint(-1, -1);
589
590                 hover_point_changed();
591
592         } else if (type == QEvent::Leave) {
593                 hover_point_ = QPoint(-1, -1);
594                 hover_point_changed();
595         }
596
597         return QObject::eventFilter(object, event);
598 }
599
600 bool View::viewportEvent(QEvent *e)
601 {
602         switch(e->type()) {
603         case QEvent::Paint:
604         case QEvent::MouseButtonPress:
605         case QEvent::MouseButtonRelease:
606         case QEvent::MouseButtonDblClick:
607         case QEvent::MouseMove:
608         case QEvent::Wheel:
609         case QEvent::TouchBegin:
610         case QEvent::TouchUpdate:
611         case QEvent::TouchEnd:
612                 return false;
613
614         default:
615                 return QAbstractScrollArea::viewportEvent(e);
616         }
617 }
618
619 void View::resizeEvent(QResizeEvent*)
620 {
621         update_layout();
622 }
623
624 void View::row_item_appearance_changed(bool label, bool content)
625 {
626         if (label)
627                 header_->update();
628         if (content)
629                 viewport_->update();
630 }
631
632 void View::time_item_appearance_changed(bool label, bool content)
633 {
634         if (label)
635                 ruler_->update();
636         if (content)
637                 viewport_->update();
638 }
639
640 void View::extents_changed(bool horz, bool vert)
641 {
642         sticky_events_ |=
643                 (horz ? RowItemHExtentsChanged : 0) |
644                 (vert ? RowItemVExtentsChanged : 0);
645         lazy_event_handler_.start();
646 }
647
648 void View::h_scroll_value_changed(int value)
649 {
650         if (updating_scroll_)
651                 return;
652
653         const int range = horizontalScrollBar()->maximum();
654         if (range < MaxScrollValue)
655                 offset_ = scale_ * value;
656         else {
657                 double length = 0, offset;
658                 get_scroll_layout(length, offset);
659                 offset_ = scale_ * length * value / MaxScrollValue;
660         }
661
662         ruler_->update();
663         viewport_->update();
664 }
665
666 void View::v_scroll_value_changed()
667 {
668         header_->update();
669         viewport_->update();
670 }
671
672 void View::signals_changed()
673 {
674         int offset = 0;
675
676         // Populate the traces
677         clear_child_items();
678
679         shared_ptr<sigrok::Device> device = session_.device()->device();
680         assert(device);
681
682         // Collect a set of signals
683         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
684                 signal_map;
685
686         shared_lock<shared_mutex> lock(session_.signals_mutex());
687         const unordered_set< shared_ptr<Signal> > &sigs(session_.signals());
688
689         for (const shared_ptr<Signal> &sig : sigs)
690                 signal_map[sig->channel()] = sig;
691
692         // Populate channel groups
693         for (auto entry : device->channel_groups())
694         {
695                 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
696
697                 if (group->channels().size() <= 1)
698                         continue;
699
700                 shared_ptr<TraceGroup> trace_group(new TraceGroup());
701                 int child_offset = 0;
702                 if (add_channels_to_owner(group->channels(),
703                         trace_group.get(), child_offset, signal_map))
704                 {
705                         add_child_item(trace_group);
706                         apply_offset(trace_group, offset);
707                 }
708         }
709
710         // Add the remaining logic channels
711         shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
712         int child_offset = 0;
713
714         if (add_channels_to_owner(device->channels(),
715                 logic_trace_group.get(), child_offset, signal_map,
716                 [](shared_ptr<RowItem> r) -> bool {
717                         return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
718                         }))
719
720         {
721                 add_child_item(logic_trace_group);
722                 apply_offset(logic_trace_group, offset);
723         }
724
725         // Add the remaining channels
726         add_channels_to_owner(device->channels(), this, offset, signal_map);
727         assert(signal_map.empty());
728
729         // Add decode signals
730 #ifdef ENABLE_DECODE
731         const vector< shared_ptr<DecodeTrace> > decode_sigs(
732                 session().get_decode_signals());
733         for (auto s : decode_sigs) {
734                 add_child_item(s);
735                 apply_offset(s, offset);
736         }
737 #endif
738
739         update_layout();
740 }
741
742 void View::data_updated()
743 {
744         // Update the scroll bars
745         update_scroll();
746
747         // Repaint the view
748         viewport_->update();
749 }
750
751 void View::process_sticky_events()
752 {
753         if (sticky_events_ & RowItemHExtentsChanged)
754                 update_layout();
755         if (sticky_events_ & RowItemVExtentsChanged) {
756                 restack_all_row_items();
757                 update_scroll();
758         }
759
760         // Clear the sticky events
761         sticky_events_ = 0;
762 }
763
764 void View::on_hover_point_changed()
765 {
766         for (shared_ptr<RowItem> r : *this)
767                 r->hover_point_changed();
768 }
769
770 } // namespace view
771 } // namespace pv