Implement expansion marker animation and its infrastructure
[pulseview.git] / pv / views / trace / view.hpp
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 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
22
23 #include <cstdint>
24 #include <list>
25 #include <memory>
26 #include <set>
27 #include <unordered_map>
28 #include <vector>
29
30 #include <QAbstractScrollArea>
31 #include <QShortcut>
32 #include <QSizeF>
33 #include <QSplitter>
34
35 #include <pv/globalsettings.hpp>
36 #include <pv/util.hpp>
37 #include <pv/data/signaldata.hpp>
38 #include <pv/views/viewbase.hpp>
39
40 #include "cursorpair.hpp"
41 #include "flag.hpp"
42 #include "trace.hpp"
43 #include "tracetreeitemowner.hpp"
44
45 using std::list;
46 using std::unordered_map;
47 using std::unordered_set;
48 using std::set;
49 using std::shared_ptr;
50 using std::vector;
51
52 namespace sigrok {
53 class ChannelGroup;
54 }
55
56 namespace pv {
57
58 class Session;
59
60 namespace data {
61 class Logic;
62 }
63
64 namespace views {
65
66 namespace trace {
67
68 class DecodeTrace;
69 class Header;
70 class Ruler;
71 class Signal;
72 class Viewport;
73 class TriggerMarker;
74
75 class CustomScrollArea : public QAbstractScrollArea
76 {
77         Q_OBJECT
78
79 public:
80         CustomScrollArea(QWidget *parent = nullptr);
81         bool viewportEvent(QEvent *event);
82 };
83
84 class View : public ViewBase, public TraceTreeItemOwner, public GlobalSettingsInterface
85 {
86         Q_OBJECT
87
88 private:
89         enum StickyEvents {
90                 TraceTreeItemHExtentsChanged = 1,
91                 TraceTreeItemVExtentsChanged = 2
92         };
93
94 private:
95         static const pv::util::Timestamp MaxScale;
96         static const pv::util::Timestamp MinScale;
97
98         static const int MaxScrollValue;
99
100         static const int ScaleUnits[3];
101
102 public:
103         explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr);
104
105         ~View();
106
107         virtual ViewType get_type() const;
108
109         /**
110          * Resets the view to its default state after construction. It does however
111          * not reset the signal bases or any other connections with the session.
112          */
113         virtual void reset_view_state();
114
115         Session& session();  // This method is needed for TraceTreeItemOwner, not ViewBase
116         const Session& session() const;  // This method is needed for TraceTreeItemOwner, not ViewBase
117
118         /**
119          * Returns the signals contained in this view.
120          */
121         unordered_set< shared_ptr<Signal> > signals() const;
122
123         shared_ptr<Signal> get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const;
124
125         virtual void clear_signals();
126
127         void add_signal(const shared_ptr<Signal> signal);
128
129 #ifdef ENABLE_DECODE
130         virtual void clear_decode_signals();
131
132         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
133
134         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
135 #endif
136
137         shared_ptr<Signal> get_signal_under_mouse_cursor() const;
138
139         /**
140          * Returns the view of the owner.
141          */
142         virtual View* view();
143
144         /**
145          * Returns the view of the owner.
146          */
147         virtual const View* view() const;
148
149         Viewport* viewport();
150         const Viewport* viewport() const;
151
152         const Ruler* ruler() const;
153
154         virtual void save_settings(QSettings &settings) const;
155
156         virtual void restore_settings(QSettings &settings);
157
158         /**
159          * Gets a list of time markers.
160          */
161         vector< shared_ptr<TimeItem> > time_items() const;
162
163         /**
164          * Returns the view time scale in seconds per pixel.
165          */
166         double scale() const;
167
168         /**
169          * Returns the internal view version of the time offset of the left edge
170          * of the view in seconds.
171          */
172         const pv::util::Timestamp& offset() const;
173
174         /**
175          * Returns the ruler version of the time offset of the left edge
176          * of the view in seconds.
177          */
178         const pv::util::Timestamp& ruler_offset() const;
179
180         void set_zero_position(const pv::util::Timestamp& position);
181
182         void reset_zero_position();
183
184         pv::util::Timestamp zero_offset() const;
185
186         /**
187          * Returns the vertical scroll offset.
188          */
189         int owner_visual_v_offset() const;
190
191         /**
192          * Sets the visual v-offset.
193          */
194         void set_v_offset(int offset);
195
196         /**
197          * Sets the visual h-offset.
198          */
199         void set_h_offset(int offset);
200
201         /**
202          * Gets the length of the horizontal scrollbar.
203          */
204         int get_h_scrollbar_maximum() const;
205
206         /**
207          * Returns the SI prefix to apply to the graticule time markings.
208          */
209         pv::util::SIPrefix tick_prefix() const;
210
211         /**
212          * Returns the number of fractional digits shown for the time markings.
213          */
214         unsigned int tick_precision() const;
215
216         /**
217          * Returns period of the graticule time markings.
218          */
219         const pv::util::Timestamp& tick_period() const;
220
221         /**
222          * Returns number of minor division ticks per time marking.
223          */
224         unsigned int minor_tick_count() const;
225
226         /**
227          * Returns the unit of time currently used.
228          */
229         util::TimeUnit time_unit() const;
230
231         /**
232          * Returns the number of nested parents that this row item owner has.
233          */
234         unsigned int depth() const;
235
236         /**
237          * Returns the currently displayed segment, starting at 0.
238          */
239         uint32_t current_segment() const;
240
241         /**
242          * Returns whether the currently shown segment can be influenced
243          * (selected) or not.
244          */
245         bool segment_is_selectable() const;
246
247         Trace::SegmentDisplayMode segment_display_mode() const;
248         void set_segment_display_mode(Trace::SegmentDisplayMode mode);
249
250         void zoom(double steps);
251         void zoom(double steps, int offset);
252
253         void zoom_fit(bool gui_state);
254
255         /**
256          * Sets the scale and offset.
257          * @param scale The new view scale in seconds per pixel.
258          * @param offset The view time offset in seconds.
259          */
260         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
261
262         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
263
264         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
265
266         /**
267          * Returns true if the trace background should be drawn with a colored background.
268          */
269         bool colored_bg() const;
270
271         /**
272          * Returns true if cursors are displayed. false otherwise.
273          */
274         bool cursors_shown() const;
275
276         /**
277          * Shows or hides the cursors.
278          */
279         void show_cursors(bool show = true);
280
281         /**
282          * Sets the cursors to the given offsets. You will still have to call show_cursors separately.
283          */
284         void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);
285
286         /**
287          * Moves the cursors to a convenient position in the view.
288          */
289         void centre_cursors();
290
291         /**
292          * Returns a reference to the pair of cursors.
293          */
294         shared_ptr<CursorPair> cursors() const;
295
296         /**
297          * Adds a new flag at a specified time.
298          */
299         shared_ptr<Flag> add_flag(const pv::util::Timestamp& time);
300
301         /**
302          * Removes a flag from the list.
303          */
304         void remove_flag(shared_ptr<Flag> flag);
305
306         /**
307          * Gets the list of flags.
308          */
309         vector< shared_ptr<Flag> > flags() const;
310
311         const QPoint& hover_point() const;
312         const QWidget* hover_widget() const;
313
314         /**
315          * Determines the closest level change (i.e. edge) to a given point, which
316          * is useful for e.g. the "snap to edge" functionality.
317          *
318          * @param p The current position of the mouse cursor
319          * @return The sample number of the nearest level change or -1 if none
320          */
321         int64_t get_nearest_level_change(const QPoint &p);
322
323         void restack_all_trace_tree_items();
324
325         int header_width() const;
326
327         void on_setting_changed(const QString &key, const QVariant &value);
328
329 Q_SIGNALS:
330         void hover_point_changed(const QWidget* widget, const QPoint &hp);
331
332         void selection_changed();
333
334         /// Emitted when the offset changed.
335         void offset_changed();
336
337         /// Emitted when the scale changed.
338         void scale_changed();
339
340         void sticky_scrolling_changed(bool state);
341
342         void always_zoom_to_fit_changed(bool state);
343
344         /// Emitted when the tick_prefix changed.
345         void tick_prefix_changed();
346
347         /// Emitted when the tick_precision changed.
348         void tick_precision_changed();
349
350         /// Emitted when the tick_period changed.
351         void tick_period_changed();
352
353         /// Emitted when the time_unit changed.
354         void time_unit_changed();
355
356         /// Emitted when the currently selected segment changed
357         void segment_changed(int segment_id);
358
359         /// Emitted when the multi-segment display mode changed
360         /// @param mode is a value of Trace::SegmentDisplayMode
361         void segment_display_mode_changed(int mode, bool segment_selectable);
362
363         /// Emitted when the cursors are shown/hidden
364         void cursor_state_changed(bool show);
365
366 public Q_SLOTS:
367         void trigger_event(int segment_id, util::Timestamp location);
368
369 private:
370         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
371
372         /**
373          * Simultaneously sets the zoom and offset.
374          * @param scale The scale to set the view to in seconds per pixel. This
375          * value is clamped between MinScale and MaxScale.
376          * @param offset The offset of the left edge of the view in seconds.
377          */
378         void set_zoom(double scale, int offset);
379
380         /**
381          * Find a tick spacing and number formatting that does not cause
382          * the values to collide.
383          */
384         void calculate_tick_spacing();
385
386         void adjust_top_margin();
387
388         void update_scroll();
389
390         void reset_scroll();
391
392         void set_scroll_default();
393
394         void determine_if_header_was_shrunk();
395
396         void resize_header_to_fit();
397
398         void update_layout();
399
400         TraceTreeItemOwner* find_prevalent_trace_group(
401                 const shared_ptr<sigrok::ChannelGroup> &group,
402                 const unordered_map<shared_ptr<data::SignalBase>,
403                         shared_ptr<Signal> > &signal_map);
404
405         static vector< shared_ptr<Trace> >
406                 extract_new_traces_for_channels(
407                 const vector< shared_ptr<sigrok::Channel> > &channels,
408                 const unordered_map<shared_ptr<data::SignalBase>,
409                         shared_ptr<Signal> > &signal_map,
410                 set< shared_ptr<Trace> > &add_list);
411
412         void determine_time_unit();
413
414         bool eventFilter(QObject *object, QEvent *event);
415
416         virtual void contextMenuEvent(QContextMenuEvent *event);
417
418         void resizeEvent(QResizeEvent *event);
419
420         void update_hover_point();
421
422 public:
423         void row_item_appearance_changed(bool label, bool content);
424         void time_item_appearance_changed(bool label, bool content);
425
426         void extents_changed(bool horz, bool vert);
427
428 private Q_SLOTS:
429         void on_signal_name_changed();
430         void on_splitter_moved();
431
432         void on_zoom_in_shortcut_triggered();
433         void on_zoom_out_shortcut_triggered();
434         void on_scroll_to_start_shortcut_triggered();
435         void on_scroll_to_end_shortcut_triggered();
436
437         void h_scroll_value_changed(int value);
438         void v_scroll_value_changed();
439
440         void signals_changed();
441         void capture_state_updated(int state);
442
443         void on_new_segment(int new_segment_id);
444         void on_segment_completed(int new_segment_id);
445         void on_segment_changed(int segment);
446
447         void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
448
449         virtual void perform_delayed_view_update();
450
451         void process_sticky_events();
452
453         /**
454          * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
455          * signal if needed.
456          */
457         void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
458
459         /**
460          * Sets the 'scale_' member and emits the 'scale_changed'
461          * signal if needed.
462          */
463         void set_scale(double scale);
464
465         /**
466          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
467          * signal if needed.
468          */
469         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
470
471         /**
472          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
473          * signal if needed.
474          */
475         void set_tick_precision(unsigned tick_precision);
476
477         /**
478          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
479          * signal if needed.
480          */
481         void set_tick_period(const pv::util::Timestamp& tick_period);
482
483         /**
484          * Sets the 'time_unit' member and emits the 'time_unit_changed'
485          * signal if needed.
486          */
487         void set_time_unit(pv::util::TimeUnit time_unit);
488
489         /**
490          * Sets the current segment with the first segment starting at 0.
491          */
492         void set_current_segment(uint32_t segment_id);
493
494 private:
495         CustomScrollArea *scrollarea_;
496         Viewport *viewport_;
497         Ruler *ruler_;
498         Header *header_;
499         QSplitter *splitter_;
500
501         QShortcut *zoom_in_shortcut_, *zoom_in_shortcut_2_;
502         QShortcut *zoom_out_shortcut_, *zoom_out_shortcut_2_;
503         QShortcut *home_shortcut_, *end_shortcut_;
504
505         unordered_set< shared_ptr<Signal> > signals_;
506
507 #ifdef ENABLE_DECODE
508         vector< shared_ptr<DecodeTrace> > decode_traces_;
509 #endif
510
511         Trace::SegmentDisplayMode segment_display_mode_;
512
513         /// Signals whether the user can change the currently shown segment.
514         bool segment_selectable_;
515
516         /// The view time scale in seconds per pixel.
517         double scale_;
518
519         /// The internal view version of the time offset in seconds.
520         pv::util::Timestamp offset_;
521         /// The ruler version of the time offset in seconds.
522         pv::util::Timestamp ruler_offset_;
523         /// The offset of the zero point in seconds.
524         pv::util::Timestamp zero_offset_;
525
526         bool updating_scroll_;
527         bool settings_restored_;
528         bool header_was_shrunk_;
529
530         bool sticky_scrolling_;
531         bool colored_bg_;
532         bool always_zoom_to_fit_;
533
534         pv::util::Timestamp tick_period_;
535         pv::util::SIPrefix tick_prefix_;
536         unsigned int minor_tick_count_;
537         unsigned int tick_precision_;
538         util::TimeUnit time_unit_;
539
540         bool show_cursors_;
541         shared_ptr<CursorPair> cursors_;
542
543         list< shared_ptr<Flag> > flags_;
544         char next_flag_text_;
545
546         vector< shared_ptr<TriggerMarker> > trigger_markers_;
547
548         QWidget* hover_widget_;
549         QPoint hover_point_;
550         shared_ptr<Signal> signal_under_mouse_cursor_;
551         uint16_t snap_distance_;
552
553         unsigned int sticky_events_;
554         QTimer lazy_event_handler_;
555
556         // This is true when the defaults couldn't be set due to insufficient info
557         bool scroll_needs_defaults_;
558
559         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
560         int saved_v_offset_;
561
562         // These are used to determine whether the view was altered after acq started
563         double scale_at_acq_start_;
564         pv::util::Timestamp offset_at_acq_start_;
565
566         // Used to suppress performing a "zoom to fit" when the session stops. This
567         // is needed when the view's settings are restored before acquisition ends.
568         // In that case we want to keep the restored settings, not have a "zoom to fit"
569         // mess them up.
570         bool suppress_zoom_to_fit_after_acq_;
571 };
572
573 } // namespace trace
574 } // namespace views
575 } // namespace pv
576
577 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP