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