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