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