Implement segment display mode handling and update notifications
[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/data/signaldata.hpp>
35 #include <pv/util.hpp>
36 #include <pv/views/viewbase.hpp>
37
38 #include "cursorpair.hpp"
39 #include "flag.hpp"
40 #include "trace.hpp"
41 #include "tracetreeitemowner.hpp"
42
43 using std::list;
44 using std::unordered_map;
45 using std::unordered_set;
46 using std::set;
47 using std::shared_ptr;
48 using std::vector;
49
50 namespace sigrok {
51 class ChannelGroup;
52 }
53
54 namespace pv {
55
56 class Session;
57
58 namespace data {
59 class Logic;
60 }
61
62 namespace views {
63
64 namespace trace {
65
66 class CursorHeader;
67 class DecodeTrace;
68 class Header;
69 class Ruler;
70 class Signal;
71 class Trace;
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
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, QWidget *parent = nullptr);
104
105         Session& session();
106         const Session& session() const;
107
108         /**
109          * Returns the signals contained in this view.
110          */
111         unordered_set< shared_ptr<Signal> > signals() const;
112
113         virtual void clear_signals();
114
115         void add_signal(const shared_ptr<Signal> signal);
116
117 #ifdef ENABLE_DECODE
118         virtual void clear_decode_signals();
119
120         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
121
122         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
123 #endif
124
125         /**
126          * Returns the view of the owner.
127          */
128         virtual View* view();
129
130         /**
131          * Returns the view of the owner.
132          */
133         virtual const View* view() const;
134
135         Viewport* viewport();
136
137         const Viewport* viewport() const;
138
139         virtual void save_settings(QSettings &settings) const;
140
141         virtual void restore_settings(QSettings &settings);
142
143         /**
144          * Gets a list of time markers.
145          */
146         vector< shared_ptr<TimeItem> > time_items() const;
147
148         /**
149          * Returns the view time scale in seconds per pixel.
150          */
151         double scale() const;
152
153         /**
154          * Returns the time offset of the left edge of the view in
155          * seconds.
156          */
157         const pv::util::Timestamp& offset() const;
158
159         /**
160          * Returns the vertical scroll offset.
161          */
162         int owner_visual_v_offset() const;
163
164         /**
165          * Sets the visual v-offset.
166          */
167         void set_v_offset(int offset);
168
169         /**
170          * Returns the SI prefix to apply to the graticule time markings.
171          */
172         pv::util::SIPrefix tick_prefix() const;
173
174         /**
175          * Returns the number of fractional digits shown for the time markings.
176          */
177         unsigned int tick_precision() const;
178
179         /**
180          * Returns period of the graticule time markings.
181          */
182         const pv::util::Timestamp& tick_period() const;
183
184         /**
185          * Returns the unit of time currently used.
186          */
187         util::TimeUnit time_unit() const;
188
189         /**
190          * Returns the number of nested parents that this row item owner has.
191          */
192         unsigned int depth() const;
193
194         /**
195          * Returns whether the currently shown segment can be influenced
196          * (selected) or not.
197          */
198         bool segment_is_selectable() const;
199
200         void set_segment_display_mode(Trace::SegmentDisplayMode mode);
201
202         void zoom(double steps);
203         void zoom(double steps, int offset);
204
205         void zoom_fit(bool gui_state);
206
207         void zoom_one_to_one();
208
209         /**
210          * Sets the scale and offset.
211          * @param scale The new view scale in seconds per pixel.
212          * @param offset The view time offset in seconds.
213          */
214         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
215
216         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
217
218         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
219
220         /**
221          * Enables or disables coloured trace backgrounds. If they're not
222          * coloured then they will use alternating colors.
223          */
224         void enable_coloured_bg(bool state);
225
226         /**
227          * Returns true if the trace background should be drawn with a coloured background.
228          */
229         bool coloured_bg() const;
230
231         /**
232          * Enable or disable showing sampling points.
233          */
234         void enable_show_sampling_points(bool state);
235
236         /**
237          * Enable or disable showing the analog minor grid.
238          */
239         void enable_show_analog_minor_grid(bool state);
240
241         /**
242          * Returns true if cursors are displayed. false otherwise.
243          */
244         bool cursors_shown() const;
245
246         /**
247          * Shows or hides the cursors.
248          */
249         void show_cursors(bool show = true);
250
251         /**
252          * Moves the cursors to a convenient position in the view.
253          */
254         void centre_cursors();
255
256         /**
257          * Returns a reference to the pair of cursors.
258          */
259         shared_ptr<CursorPair> cursors() const;
260
261         /**
262          * Adds a new flag at a specified time.
263          */
264         void add_flag(const pv::util::Timestamp& time);
265
266         /**
267          * Removes a flag from the list.
268          */
269         void remove_flag(shared_ptr<Flag> flag);
270
271         /**
272          * Gets the list of flags.
273          */
274         vector< shared_ptr<Flag> > flags() const;
275
276         const QPoint& hover_point() const;
277
278         void restack_all_trace_tree_items();
279
280 Q_SIGNALS:
281         void hover_point_changed(const QPoint &hp);
282
283         void selection_changed();
284
285         /// Emitted when the offset changed.
286         void offset_changed();
287
288         /// Emitted when the scale changed.
289         void scale_changed();
290
291         void sticky_scrolling_changed(bool state);
292
293         void always_zoom_to_fit_changed(bool state);
294
295         /// Emitted when the tick_prefix changed.
296         void tick_prefix_changed();
297
298         /// Emitted when the tick_precision changed.
299         void tick_precision_changed();
300
301         /// Emitted when the tick_period changed.
302         void tick_period_changed();
303
304         /// Emitted when the time_unit changed.
305         void time_unit_changed();
306
307         /// Emitted when the currently selected segment changed
308         void segment_changed(int segment_id);
309
310         /// Emitted when the multi-segment display mode changed
311         void segment_display_mode_changed(bool segment_selectable);
312
313 public Q_SLOTS:
314         void trigger_event(util::Timestamp location);
315
316 private:
317         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
318
319         /**
320          * Simultaneously sets the zoom and offset.
321          * @param scale The scale to set the view to in seconds per pixel. This
322          * value is clamped between MinScale and MaxScale.
323          * @param offset The offset of the left edge of the view in seconds.
324          */
325         void set_zoom(double scale, int offset);
326
327         /**
328          * Find a tick spacing and number formatting that does not cause
329          * the values to collide.
330          */
331         void calculate_tick_spacing();
332
333         void adjust_top_margin();
334
335         void update_scroll();
336
337         void reset_scroll();
338
339         void set_scroll_default();
340
341         void determine_if_header_was_shrunk();
342
343         void resize_header_to_fit();
344
345         void update_layout();
346
347         TraceTreeItemOwner* find_prevalent_trace_group(
348                 const shared_ptr<sigrok::ChannelGroup> &group,
349                 const unordered_map<shared_ptr<data::SignalBase>,
350                         shared_ptr<Signal> > &signal_map);
351
352         static vector< shared_ptr<Trace> >
353                 extract_new_traces_for_channels(
354                 const vector< shared_ptr<sigrok::Channel> > &channels,
355                 const unordered_map<shared_ptr<data::SignalBase>,
356                         shared_ptr<Signal> > &signal_map,
357                 set< shared_ptr<Trace> > &add_list);
358
359         void determine_time_unit();
360
361         bool eventFilter(QObject *object, QEvent *event);
362
363         void resizeEvent(QResizeEvent *event);
364
365         void update_hover_point();
366
367 public:
368         void row_item_appearance_changed(bool label, bool content);
369         void time_item_appearance_changed(bool label, bool content);
370
371         void extents_changed(bool horz, bool vert);
372
373 private Q_SLOTS:
374
375         void on_signal_name_changed();
376         void on_splitter_moved();
377
378         void h_scroll_value_changed(int value);
379         void v_scroll_value_changed();
380
381         void signals_changed();
382         void capture_state_updated(int state);
383
384         void on_new_segment(int new_segment_id);
385         void on_segment_changed(int segment);
386
387         virtual void perform_delayed_view_update();
388
389         void process_sticky_events();
390
391         /**
392          * Sets the 'offset_' member and emits the 'offset_changed'
393          * signal if needed.
394          */
395         void set_offset(const pv::util::Timestamp& offset);
396
397         /**
398          * Sets the 'scale_' member and emits the 'scale_changed'
399          * signal if needed.
400          */
401         void set_scale(double scale);
402
403         /**
404          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
405          * signal if needed.
406          */
407         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
408
409         /**
410          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
411          * signal if needed.
412          */
413         void set_tick_precision(unsigned tick_precision);
414
415         /**
416          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
417          * signal if needed.
418          */
419         void set_tick_period(const pv::util::Timestamp& tick_period);
420
421         /**
422          * Sets the 'time_unit' member and emits the 'time_unit_changed'
423          * signal if needed.
424          */
425         void set_time_unit(pv::util::TimeUnit time_unit);
426
427 private:
428         CustomScrollArea *scrollarea_;
429         Viewport *viewport_;
430         Ruler *ruler_;
431         Header *header_;
432         QSplitter *splitter_;
433
434         unordered_set< shared_ptr<Signal> > signals_;
435
436 #ifdef ENABLE_DECODE
437         vector< shared_ptr<DecodeTrace> > decode_traces_;
438 #endif
439
440         /// The ID of the currently displayed segment
441         int current_segment_;
442         Trace::SegmentDisplayMode segment_display_mode_;
443
444         /// Signals whether the user can change the currently shown segment.
445         bool segment_selectable_;
446
447         /// The view time scale in seconds per pixel.
448         double scale_;
449
450         /// The view time offset in seconds.
451         pv::util::Timestamp offset_;
452
453         bool updating_scroll_;
454         bool settings_restored_;
455         bool header_was_shrunk_;
456
457         bool sticky_scrolling_;
458         bool coloured_bg_;
459         bool always_zoom_to_fit_;
460
461         pv::util::Timestamp tick_period_;
462         pv::util::SIPrefix tick_prefix_;
463         unsigned int tick_precision_;
464         util::TimeUnit time_unit_;
465
466         bool show_cursors_;
467         shared_ptr<CursorPair> cursors_;
468
469         list< shared_ptr<Flag> > flags_;
470         char next_flag_text_;
471
472         vector< shared_ptr<TriggerMarker> > trigger_markers_;
473
474         QPoint hover_point_;
475
476         unsigned int sticky_events_;
477         QTimer lazy_event_handler_;
478
479         // This is true when the defaults couldn't be set due to insufficient info
480         bool scroll_needs_defaults_;
481
482         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
483         int saved_v_offset_;
484
485         // These are used to determine whether the view was altered after acq started
486         double scale_at_acq_start_;
487         pv::util::Timestamp offset_at_acq_start_;
488
489         // Used to suppress performing a "zoom to fit" when the session stops. This
490         // is needed when the view's settings are restored before acquisition ends.
491         // In that case we want to keep the restored settings, not have a "zoom to fit"
492         // mess them up.
493         bool suppress_zoom_to_fit_after_acq_;
494 };
495
496 } // namespace trace
497 } // namespace views
498 } // namespace pv
499
500 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP