Fix #626 by stopping acquisition gracefully
[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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
22 #define PULSEVIEW_PV_VIEW_VIEW_HPP
23
24 #include <stdint.h>
25
26 #include <list>
27 #include <memory>
28 #include <set>
29 #include <unordered_map>
30 #include <vector>
31
32 #include <QAbstractScrollArea>
33 #include <QSizeF>
34 #include <QTimer>
35
36 #include <pv/data/signaldata.hpp>
37 #include <pv/util.hpp>
38
39 #include "cursorpair.hpp"
40 #include "flag.hpp"
41 #include "rowitemowner.hpp"
42
43 namespace sigrok {
44 class ChannelGroup;
45 }
46
47 namespace pv {
48
49 class Session;
50
51 namespace view {
52
53 class CursorHeader;
54 class Header;
55 class Ruler;
56 class Trace;
57 class Viewport;
58
59 class View : public QAbstractScrollArea, public RowItemOwner {
60         Q_OBJECT
61
62 private:
63         enum StickyEvents {
64                 RowItemHExtentsChanged = 1,
65                 RowItemVExtentsChanged = 2
66         };
67
68 private:
69         static const double MaxScale;
70         static const double MinScale;
71
72         static const int MaxScrollValue;
73         static const int MaxViewAutoUpdateRate;
74
75         static const int ScaleUnits[3];
76
77 public:
78         explicit View(Session &session, QWidget *parent = 0);
79
80         Session& session();
81         const Session& session() const;
82
83         /**
84          * Returns the view of the owner.
85          */
86         virtual pv::view::View* view();
87
88         /**
89          * Returns the view of the owner.
90          */
91         virtual const pv::view::View* view() const;
92
93         Viewport* viewport();
94
95         const Viewport* viewport() const;
96
97         /**
98          * Gets a list of time markers.
99          */
100         std::vector< std::shared_ptr<TimeItem> > time_items() const;
101
102         /**
103          * Returns the view time scale in seconds per pixel.
104          */
105         double scale() const;
106
107         /**
108          * Returns the time offset of the left edge of the view in
109          * seconds.
110          */
111         double offset() const;
112
113         /**
114          * Returns the vertical scroll offset.
115          */
116         int owner_visual_v_offset() const;
117
118         /**
119          * Sets the visual v-offset.
120          */
121         void set_v_offset(int offset);
122
123         /**
124          * Returns the SI prefix to apply to the graticule time markings.
125          */
126         unsigned int tick_prefix() const;
127
128         /**
129          * Returns the number of fractional digits shown for the time markings.
130          */
131         unsigned int tick_precision() const;
132
133         /**
134          * Returns period of the graticule time markings.
135          */
136         double tick_period() const;
137
138         /**
139          * Returns the unit of time currently used.
140          */
141         util::TimeUnit time_unit() const;
142
143         /**
144          * Returns the number of nested parents that this row item owner has.
145          */
146         unsigned int depth() const;
147
148         void zoom(double steps);
149         void zoom(double steps, int offset);
150
151         void zoom_fit(bool gui_state);
152
153         void zoom_one_to_one();
154
155         /**
156          * Sets the scale and offset.
157          * @param scale The new view scale in seconds per pixel.
158          * @param offset The view time offset in seconds.
159          */
160         void set_scale_offset(double scale, double offset);
161
162         std::set< std::shared_ptr<pv::data::SignalData> >
163                 get_visible_data() const;
164
165         std::pair<double, double> get_time_extents() const;
166
167         /**
168          * Enables or disables sticky scrolling, i.e. the view always shows
169          * the most recent samples when capturing data.
170          */
171         void enable_sticky_scrolling(bool state);
172
173         /**
174          * Returns true if cursors are displayed. false otherwise.
175          */
176         bool cursors_shown() const;
177
178         /**
179          * Shows or hides the cursors.
180          */
181         void show_cursors(bool show = true);
182
183         /**
184          * Moves the cursors to a convenient position in the view.
185          */
186         void centre_cursors();
187
188         /**
189          * Returns a reference to the pair of cursors.
190          */
191         std::shared_ptr<CursorPair> cursors() const;
192
193         /**
194          * Adds a new flag at a specified time.
195          */
196         void add_flag(double time);
197
198         /**
199          * Removes a flag from the list.
200          */
201         void remove_flag(std::shared_ptr<Flag> flag);
202
203         /**
204          * Gets the list of flags.
205          */
206         std::vector< std::shared_ptr<Flag> > flags() const;
207
208         const QPoint& hover_point() const;
209
210         void update_viewport();
211
212         void restack_all_row_items();
213
214 Q_SIGNALS:
215         void hover_point_changed();
216
217         void selection_changed();
218
219         void scale_offset_changed();
220
221         void sticky_scrolling_changed(bool state);
222
223         void always_zoom_to_fit_changed(bool state);
224
225 private:
226         void get_scroll_layout(double &length, double &offset) const;
227
228         /**
229          * Simultaneously sets the zoom and offset.
230          * @param scale The scale to set the view to in seconds per pixel. This
231          * value is clamped between MinScale and MaxScale.
232          * @param offset The offset of the left edge of the view in seconds.
233          */
234         void set_zoom(double scale, int offset);
235
236         /**
237          * Find a tick spacing and number formatting that does not cause
238          * the values to collide.
239          */
240         void calculate_tick_spacing();
241
242         void update_scroll();
243
244         void update_layout();
245
246         /**
247          * Satisifies RowItem functionality.
248          * @param p the QPainter to paint into.
249          * @param rect the rectangle of the header area.
250          * @param hover true if the label is being hovered over by the mouse.
251          */
252         void paint_label(QPainter &p, const QRect &rect, bool hover);
253
254         /**
255          * Computes the outline rectangle of a label.
256          * @param rect the rectangle of the header area.
257          * @return Returns the rectangle of the signal label.
258          */
259         QRectF label_rect(const QRectF &rect);
260
261         RowItemOwner* find_prevalent_trace_group(
262                 const std::shared_ptr<sigrok::ChannelGroup> &group,
263                 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
264                         std::shared_ptr<Signal> > &signal_map);
265
266         static std::vector< std::shared_ptr<Trace> >
267                 extract_new_traces_for_channels(
268                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
269                 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
270                         std::shared_ptr<Signal> > &signal_map,
271                 std::set< std::shared_ptr<Trace> > &add_list);
272
273         void determine_time_unit();
274
275 private:
276         bool eventFilter(QObject *object, QEvent *event);
277
278         bool viewportEvent(QEvent *e);
279
280         void resizeEvent(QResizeEvent *e);
281
282 public:
283         void row_item_appearance_changed(bool label, bool content);
284         void time_item_appearance_changed(bool label, bool content);
285
286         void extents_changed(bool horz, bool vert);
287
288 private Q_SLOTS:
289
290         void h_scroll_value_changed(int value);
291         void v_scroll_value_changed();
292
293         void signals_changed();
294         void capture_state_updated(int state);
295         void data_updated();
296
297         void perform_delayed_view_update();
298
299         void process_sticky_events();
300
301         void on_hover_point_changed();
302
303 private:
304         Session &session_;
305
306         Viewport *viewport_;
307         Ruler *ruler_;
308         Header *header_;
309
310         /// The view time scale in seconds per pixel.
311         double scale_;
312
313         /// The view time offset in seconds.
314         double offset_;
315
316         bool updating_scroll_;
317         bool sticky_scrolling_;
318         bool always_zoom_to_fit_;
319         QTimer delayed_view_updater_;
320
321         double tick_period_;
322         unsigned int tick_prefix_;
323         unsigned int tick_precision_;
324         util::TimeUnit time_unit_;
325
326         bool show_cursors_;
327         std::shared_ptr<CursorPair> cursors_;
328
329         std::list< std::shared_ptr<Flag> > flags_;
330         char next_flag_text_;
331
332         QPoint hover_point_;
333
334         unsigned int sticky_events_;
335         QTimer lazy_event_handler_;
336 };
337
338 } // namespace view
339 } // namespace pv
340
341 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP