Add a tooltip for the "Stack decoder" button/dropdown.
[pulseview.git] / pv / view / 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 <QTimer>
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 "tracetreeitemowner.hpp"
41
42 using std::list;
43 using std::unordered_map;
44 using std::unordered_set;
45 using std::set;
46 using std::shared_ptr;
47 using std::vector;
48
49 namespace sigrok {
50 class ChannelGroup;
51 }
52
53 namespace pv {
54
55 class Session;
56
57 namespace views {
58
59 namespace TraceView {
60
61 class CursorHeader;
62 class DecodeTrace;
63 class Header;
64 class Ruler;
65 class Signal;
66 class Trace;
67 class Viewport;
68 class TriggerMarker;
69
70 class CustomAbstractScrollArea : public QAbstractScrollArea
71 {
72         Q_OBJECT
73
74 public:
75         CustomAbstractScrollArea(QWidget *parent = nullptr);
76         void setViewportMargins(int left, int top, int right, int bottom);
77         bool viewportEvent(QEvent *event);
78 };
79
80 class View : public ViewBase, public TraceTreeItemOwner
81 {
82         Q_OBJECT
83
84 private:
85         enum StickyEvents {
86                 TraceTreeItemHExtentsChanged = 1,
87                 TraceTreeItemVExtentsChanged = 2
88         };
89
90 private:
91         static const pv::util::Timestamp MaxScale;
92         static const pv::util::Timestamp MinScale;
93
94         static const int MaxScrollValue;
95         static const int MaxViewAutoUpdateRate;
96
97         static const int ScaleUnits[3];
98
99 public:
100         explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
101
102         Session& session();
103         const Session& session() const;
104
105         /**
106          * Returns the signals contained in this view.
107          */
108         unordered_set< shared_ptr<Signal> > signals() const;
109
110         virtual void clear_signals();
111
112         virtual void add_signal(const shared_ptr<Signal> signal);
113
114 #ifdef ENABLE_DECODE
115         virtual void clear_decode_signals();
116
117         virtual void add_decode_signal(shared_ptr<data::SignalBase> signalbase);
118
119         virtual void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
120 #endif
121
122         /**
123          * Returns the view of the owner.
124          */
125         virtual View* view();
126
127         /**
128          * Returns the view of the owner.
129          */
130         virtual const View* view() const;
131
132         Viewport* viewport();
133
134         const Viewport* viewport() const;
135
136         virtual void save_settings(QSettings &settings) const;
137
138         virtual void restore_settings(QSettings &settings);
139
140         /**
141          * Gets a list of time markers.
142          */
143         vector< shared_ptr<TimeItem> > time_items() const;
144
145         /**
146          * Returns the view time scale in seconds per pixel.
147          */
148         double scale() const;
149
150         /**
151          * Returns the time offset of the left edge of the view in
152          * seconds.
153          */
154         const pv::util::Timestamp& offset() const;
155
156         /**
157          * Returns the vertical scroll offset.
158          */
159         int owner_visual_v_offset() const;
160
161         /**
162          * Sets the visual v-offset.
163          */
164         void set_v_offset(int offset);
165
166         /**
167          * Returns the SI prefix to apply to the graticule time markings.
168          */
169         pv::util::SIPrefix tick_prefix() const;
170
171         /**
172          * Returns the number of fractional digits shown for the time markings.
173          */
174         unsigned int tick_precision() const;
175
176         /**
177          * Returns period of the graticule time markings.
178          */
179         const pv::util::Timestamp& tick_period() const;
180
181         /**
182          * Returns the unit of time currently used.
183          */
184         util::TimeUnit time_unit() const;
185
186         /**
187          * Returns the number of nested parents that this row item owner has.
188          */
189         unsigned int depth() const;
190
191         void zoom(double steps);
192         void zoom(double steps, int offset);
193
194         void zoom_fit(bool gui_state);
195
196         void zoom_one_to_one();
197
198         /**
199          * Sets the scale and offset.
200          * @param scale The new view scale in seconds per pixel.
201          * @param offset The view time offset in seconds.
202          */
203         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
204
205         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
206
207         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
208
209         /**
210          * Enables or disables coloured trace backgrounds. If they're not
211          * coloured then they will use alternating colors.
212          */
213         void enable_coloured_bg(bool state);
214
215         /**
216          * Enable or disable showing sampling points.
217          */
218         void enable_show_sampling_points(bool state);
219
220         /**
221          * Returns true if cursors are displayed. false otherwise.
222          */
223         bool cursors_shown() const;
224
225         /**
226          * Shows or hides the cursors.
227          */
228         void show_cursors(bool show = true);
229
230         /**
231          * Moves the cursors to a convenient position in the view.
232          */
233         void centre_cursors();
234
235         /**
236          * Returns a reference to the pair of cursors.
237          */
238         shared_ptr<CursorPair> cursors() const;
239
240         /**
241          * Adds a new flag at a specified time.
242          */
243         void add_flag(const pv::util::Timestamp& time);
244
245         /**
246          * Removes a flag from the list.
247          */
248         void remove_flag(shared_ptr<Flag> flag);
249
250         /**
251          * Gets the list of flags.
252          */
253         vector< shared_ptr<Flag> > flags() const;
254
255         const QPoint& hover_point() const;
256
257         void restack_all_trace_tree_items();
258
259 Q_SIGNALS:
260         void hover_point_changed();
261
262         void selection_changed();
263
264         /// Emitted when the offset changed.
265         void offset_changed();
266
267         /// Emitted when the scale changed.
268         void scale_changed();
269
270         void sticky_scrolling_changed(bool state);
271
272         void always_zoom_to_fit_changed(bool state);
273
274         /// Emitted when the tick_prefix changed.
275         void tick_prefix_changed();
276
277         /// Emitted when the tick_precision changed.
278         void tick_precision_changed();
279
280         /// Emitted when the tick_period changed.
281         void tick_period_changed();
282
283         /// Emitted when the time_unit changed.
284         void time_unit_changed();
285
286 public Q_SLOTS:
287         void trigger_event(util::Timestamp location);
288
289 private:
290         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
291
292         /**
293          * Simultaneously sets the zoom and offset.
294          * @param scale The scale to set the view to in seconds per pixel. This
295          * value is clamped between MinScale and MaxScale.
296          * @param offset The offset of the left edge of the view in seconds.
297          */
298         void set_zoom(double scale, int offset);
299
300         /**
301          * Find a tick spacing and number formatting that does not cause
302          * the values to collide.
303          */
304         void calculate_tick_spacing();
305
306         void update_scroll();
307
308         void reset_scroll();
309
310         void set_scroll_default();
311
312         void update_layout();
313
314         TraceTreeItemOwner* find_prevalent_trace_group(
315                 const shared_ptr<sigrok::ChannelGroup> &group,
316                 const unordered_map<shared_ptr<data::SignalBase>,
317                         shared_ptr<Signal> > &signal_map);
318
319         static vector< shared_ptr<Trace> >
320                 extract_new_traces_for_channels(
321                 const vector< shared_ptr<sigrok::Channel> > &channels,
322                 const unordered_map<shared_ptr<data::SignalBase>,
323                         shared_ptr<Signal> > &signal_map,
324                 set< shared_ptr<Trace> > &add_list);
325
326         void determine_time_unit();
327
328         bool eventFilter(QObject *object, QEvent *event);
329
330         void resizeEvent(QResizeEvent *event);
331
332 public:
333         void row_item_appearance_changed(bool label, bool content);
334         void time_item_appearance_changed(bool label, bool content);
335
336         void extents_changed(bool horz, bool vert);
337
338 private Q_SLOTS:
339
340         void h_scroll_value_changed(int value);
341         void v_scroll_value_changed();
342
343         void signals_changed();
344         void capture_state_updated(int state);
345         void data_updated();
346
347         void perform_delayed_view_update();
348
349         void process_sticky_events();
350
351         void on_hover_point_changed();
352
353         /**
354          * Sets the 'offset_' member and emits the 'offset_changed'
355          * signal if needed.
356          */
357         void set_offset(const pv::util::Timestamp& offset);
358
359         /**
360          * Sets the 'scale_' member and emits the 'scale_changed'
361          * signal if needed.
362          */
363         void set_scale(double scale);
364
365         /**
366          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
367          * signal if needed.
368          */
369         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
370
371         /**
372          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
373          * signal if needed.
374          */
375         void set_tick_precision(unsigned tick_precision);
376
377         /**
378          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
379          * signal if needed.
380          */
381         void set_tick_period(const pv::util::Timestamp& tick_period);
382
383         /**
384          * Sets the 'time_unit' member and emits the 'time_unit_changed'
385          * signal if needed.
386          */
387         void set_time_unit(pv::util::TimeUnit time_unit);
388
389 private:
390         Viewport *viewport_;
391         Ruler *ruler_;
392         Header *header_;
393
394         unordered_set< shared_ptr<Signal> > signals_;
395
396 #ifdef ENABLE_DECODE
397         vector< shared_ptr<DecodeTrace> > decode_traces_;
398 #endif
399
400         CustomAbstractScrollArea scrollarea_;
401
402         /// The view time scale in seconds per pixel.
403         double scale_;
404
405         /// The view time offset in seconds.
406         pv::util::Timestamp offset_;
407
408         bool updating_scroll_;
409         bool sticky_scrolling_;
410         bool coloured_bg_;
411         bool always_zoom_to_fit_;
412         QTimer delayed_view_updater_;
413
414         pv::util::Timestamp tick_period_;
415         pv::util::SIPrefix tick_prefix_;
416         unsigned int tick_precision_;
417         util::TimeUnit time_unit_;
418
419         bool show_cursors_;
420         shared_ptr<CursorPair> cursors_;
421
422         list< shared_ptr<Flag> > flags_;
423         char next_flag_text_;
424
425         vector< shared_ptr<TriggerMarker> > trigger_markers_;
426
427         QPoint hover_point_;
428
429         unsigned int sticky_events_;
430         QTimer lazy_event_handler_;
431
432         // This is true when the defaults couldn't be set due to insufficient info
433         bool scroll_needs_defaults_;
434
435         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
436         int saved_v_offset_;
437
438         bool size_finalized_;
439 };
440
441 } // namespace TraceView
442 } // namespace views
443 } // namespace pv
444
445 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP