MainBar: Catch errors listing the config keys
[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
38 #include "cursorpair.hpp"
39 #include "flag.hpp"
40 #include "rowitemowner.hpp"
41
42 namespace pv {
43
44 class Session;
45
46 namespace view {
47
48 class CursorHeader;
49 class Header;
50 class Ruler;
51 class Viewport;
52
53 class View : public QAbstractScrollArea, public RowItemOwner {
54         Q_OBJECT
55
56 private:
57         enum StickyEvents {
58                 RowItemHExtentsChanged = 1,
59                 RowItemVExtentsChanged = 2
60         };
61
62 private:
63         static const double MaxScale;
64         static const double MinScale;
65
66         static const int MaxScrollValue;
67
68         static const int ScaleUnits[3];
69
70 public:
71         explicit View(Session &session, QWidget *parent = 0);
72
73         Session& session();
74         const Session& session() const;
75
76         /**
77          * Returns the view of the owner.
78          */
79         virtual pv::view::View* view();
80
81         /**
82          * Returns the view of the owner.
83          */
84         virtual const pv::view::View* view() const;
85
86         Viewport* viewport();
87
88         const Viewport* viewport() const;
89
90         /**
91          * Gets a list of time markers.
92          */
93         std::vector< std::shared_ptr<TimeItem> > time_items() const;
94
95         /**
96          * Returns the view time scale in seconds per pixel.
97          */
98         double scale() const;
99
100         /**
101          * Returns the time offset of the left edge of the view in
102          * seconds.
103          */
104         double offset() const;
105
106         /**
107          * Returns the vertical scroll offset.
108          */
109         int owner_visual_v_offset() const;
110
111         /**
112          * Sets the visual v-offset.
113          */
114         void set_v_offset(int offset);
115
116         /**
117          * Returns the SI prefix to apply to the graticule time markings.
118          */
119         unsigned int tick_prefix() const;
120
121         /**
122          * Returns period of the graticule time markings.
123          */
124         double tick_period() const;
125
126         /**
127          * Returns the number of nested parents that this row item owner has.
128          */
129         unsigned int depth() const;
130
131         void zoom(double steps);
132         void zoom(double steps, int offset);
133
134         void zoom_fit();
135
136         void zoom_one_to_one();
137
138         /**
139          * Sets the scale and offset.
140          * @param scale The new view scale in seconds per pixel.
141          * @param offset The view time offset in seconds.
142          */
143         void set_scale_offset(double scale, double offset);
144
145         std::set< std::shared_ptr<pv::data::SignalData> >
146                 get_visible_data() const;
147
148         std::pair<double, double> get_time_extents() const;
149
150         /**
151          * Returns true if cursors are displayed. false otherwise.
152          */
153         bool cursors_shown() const;
154
155         /**
156          * Shows or hides the cursors.
157          */
158         void show_cursors(bool show = true);
159
160         /**
161          * Moves the cursors to a convenient position in the view.
162          */
163         void centre_cursors();
164
165         /**
166          * Returns a reference to the pair of cursors.
167          */
168         std::shared_ptr<CursorPair> cursors() const;
169
170         /**
171          * Adds a new flag at a specified time.
172          */
173         void add_flag(double time);
174
175         /**
176          * Removes a flag from the list.
177          */
178         void remove_flag(std::shared_ptr<Flag> flag);
179
180         /**
181          * Gets the list of flags.
182          */
183         std::vector< std::shared_ptr<Flag> > flags() const;
184
185         const QPoint& hover_point() const;
186
187         void update_viewport();
188
189         void restack_all_row_items();
190
191 Q_SIGNALS:
192         void hover_point_changed();
193
194         void selection_changed();
195
196         void scale_offset_changed();
197
198 private:
199         void get_scroll_layout(double &length, double &offset) const;
200
201         /**
202          * Simultaneously sets the zoom and offset.
203          * @param scale The scale to set the view to in seconds per pixel. This
204          * value is clamped between MinScale and MaxScale.
205          * @param offset The offset of the left edge of the view in seconds.
206          */
207         void set_zoom(double scale, int offset);
208
209         /**
210          * Find a tick spacing and number formatting that does not cause
211          * the values to collide.
212          */
213         void calculate_tick_spacing();
214
215         void update_scroll();
216
217         void update_layout();
218
219         /**
220          * Satisifies RowItem functionality.
221          * @param p the QPainter to paint into.
222          * @param rect the rectangle of the header area.
223          * @param hover true if the label is being hovered over by the mouse.
224          */
225         void paint_label(QPainter &p, const QRect &rect, bool hover);
226
227         /**
228          * Computes the outline rectangle of a label.
229          * @param rect the rectangle of the header area.
230          * @return Returns the rectangle of the signal label.
231          */
232         QRectF label_rect(const QRectF &rect);
233
234         static bool add_channels_to_owner(
235                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
236                 RowItemOwner *owner, int &offset,
237                 std::unordered_map<std::shared_ptr<sigrok::Channel>,
238                         std::shared_ptr<Signal> > &signal_map,
239                 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
240                         std::function<bool (std::shared_ptr<RowItem>)>());
241
242         static void apply_offset(
243                 std::shared_ptr<RowItem> row_item, int &offset);
244
245 private:
246         bool eventFilter(QObject *object, QEvent *event);
247
248         bool viewportEvent(QEvent *e);
249
250         void resizeEvent(QResizeEvent *e);
251
252 public:
253         void row_item_appearance_changed(bool label, bool content);
254         void time_item_appearance_changed(bool label, bool content);
255
256         void extents_changed(bool horz, bool vert);
257
258 private Q_SLOTS:
259
260         void h_scroll_value_changed(int value);
261         void v_scroll_value_changed();
262
263         void signals_changed();
264         void data_updated();
265
266         void process_sticky_events();
267
268         void on_hover_point_changed();
269
270 private:
271         Session &session_;
272
273         Viewport *viewport_;
274         Ruler *ruler_;
275         Header *header_;
276
277         /// The view time scale in seconds per pixel.
278         double scale_;
279
280         /// The view time offset in seconds.
281         double offset_;
282
283         bool updating_scroll_;
284
285         double tick_period_;
286         unsigned int tick_prefix_;
287
288         bool show_cursors_;
289         std::shared_ptr<CursorPair> cursors_;
290
291         std::list< std::shared_ptr<Flag> > flags_;
292         char next_flag_text_;
293
294         QPoint hover_point_;
295
296         unsigned int sticky_events_;
297         QTimer lazy_event_handler_;
298 };
299
300 } // namespace view
301 } // namespace pv
302
303 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP