]>
Commit | Line | Data |
---|---|---|
adb4b10c | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
adb4b10c JH |
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 | ||
7a01bd36 JH |
21 | #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP |
22 | #define PULSEVIEW_PV_VIEW_VIEW_HPP | |
adb4b10c JH |
23 | |
24 | #include <stdint.h> | |
25 | ||
8914fe79 | 26 | #include <list> |
f9abf97e | 27 | #include <memory> |
1bc6525b | 28 | #include <set> |
448a72cf | 29 | #include <unordered_map> |
38eeddea JH |
30 | #include <vector> |
31 | ||
adb4b10c | 32 | #include <QAbstractScrollArea> |
2e04f9bd | 33 | #include <QSizeF> |
32218d3e | 34 | #include <QTimer> |
adb4b10c | 35 | |
2acdb232 | 36 | #include <pv/data/signaldata.hpp> |
ef454ad5 | 37 | #include <pv/util.hpp> |
1bc6525b | 38 | |
2acdb232 | 39 | #include "cursorpair.hpp" |
8914fe79 | 40 | #include "flag.hpp" |
af503b10 | 41 | #include "tracetreeitemowner.hpp" |
f76af637 | 42 | |
cf124e47 JH |
43 | namespace sigrok { |
44 | class ChannelGroup; | |
45 | } | |
46 | ||
51e77110 JH |
47 | namespace pv { |
48 | ||
2b81ae46 | 49 | class Session; |
adb4b10c | 50 | |
cdf7bea7 JH |
51 | namespace view { |
52 | ||
84a0d458 | 53 | class CursorHeader; |
1d8dca91 | 54 | class Header; |
ccdd3ef5 | 55 | class Ruler; |
cf124e47 | 56 | class Trace; |
cdf7bea7 | 57 | class Viewport; |
1a2288a1 | 58 | class TriggerMarker; |
cdf7bea7 | 59 | |
af503b10 | 60 | class View : public QAbstractScrollArea, public TraceTreeItemOwner { |
adb4b10c JH |
61 | Q_OBJECT |
62 | ||
32218d3e JH |
63 | private: |
64 | enum StickyEvents { | |
af503b10 JH |
65 | TraceTreeItemHExtentsChanged = 1, |
66 | TraceTreeItemVExtentsChanged = 2 | |
32218d3e JH |
67 | }; |
68 | ||
adb4b10c | 69 | private: |
60d9b99a JS |
70 | static const pv::util::Timestamp MaxScale; |
71 | static const pv::util::Timestamp MinScale; | |
adb4b10c | 72 | |
f25770e2 | 73 | static const int MaxScrollValue; |
c7b03d9d | 74 | static const int MaxViewAutoUpdateRate; |
f25770e2 | 75 | |
361c560e JH |
76 | static const int ScaleUnits[3]; |
77 | ||
adb4b10c | 78 | public: |
2b81ae46 | 79 | explicit View(Session &session, QWidget *parent = 0); |
adb4b10c | 80 | |
2b81ae46 JH |
81 | Session& session(); |
82 | const Session& session() const; | |
1d19ef83 | 83 | |
eae6e30a JH |
84 | /** |
85 | * Returns the view of the owner. | |
86 | */ | |
87 | virtual pv::view::View* view(); | |
88 | ||
89 | /** | |
90 | * Returns the view of the owner. | |
91 | */ | |
92 | virtual const pv::view::View* view() const; | |
93 | ||
2ae445ba SA |
94 | Viewport* viewport(); |
95 | ||
96 | const Viewport* viewport() const; | |
97 | ||
e081bf3d SA |
98 | const QSize header_size() const; |
99 | ||
2496bf45 JH |
100 | /** |
101 | * Gets a list of time markers. | |
102 | */ | |
103 | std::vector< std::shared_ptr<TimeItem> > time_items() const; | |
104 | ||
e2f5223b JH |
105 | /** |
106 | * Returns the view time scale in seconds per pixel. | |
107 | */ | |
adb4b10c | 108 | double scale() const; |
e2f5223b JH |
109 | |
110 | /** | |
111 | * Returns the time offset of the left edge of the view in | |
112 | * seconds. | |
113 | */ | |
60d9b99a | 114 | const pv::util::Timestamp& offset() const; |
f8400017 JH |
115 | |
116 | /** | |
117 | * Returns the vertical scroll offset. | |
118 | */ | |
7ff0145f | 119 | int owner_visual_v_offset() const; |
adb4b10c | 120 | |
4d476647 JH |
121 | /** |
122 | * Sets the visual v-offset. | |
123 | */ | |
124 | void set_v_offset(int offset); | |
125 | ||
361c560e JH |
126 | /** |
127 | * Returns the SI prefix to apply to the graticule time markings. | |
128 | */ | |
d001f416 | 129 | pv::util::SIPrefix tick_prefix() const; |
361c560e | 130 | |
d40f4db7 SA |
131 | /** |
132 | * Returns the number of fractional digits shown for the time markings. | |
133 | */ | |
134 | unsigned int tick_precision() const; | |
135 | ||
361c560e JH |
136 | /** |
137 | * Returns period of the graticule time markings. | |
138 | */ | |
c677193d | 139 | const pv::util::Timestamp& tick_period() const; |
361c560e | 140 | |
ef454ad5 SA |
141 | /** |
142 | * Returns the unit of time currently used. | |
143 | */ | |
144 | util::TimeUnit time_unit() const; | |
145 | ||
3e769a37 JH |
146 | /** |
147 | * Returns the number of nested parents that this row item owner has. | |
148 | */ | |
149 | unsigned int depth() const; | |
150 | ||
adb4b10c | 151 | void zoom(double steps); |
17c0f398 | 152 | void zoom(double steps, int offset); |
adb4b10c | 153 | |
ce11b2ea | 154 | void zoom_fit(bool gui_state); |
ca46b534 | 155 | |
d1e7d82c JH |
156 | void zoom_one_to_one(); |
157 | ||
e2f5223b JH |
158 | /** |
159 | * Sets the scale and offset. | |
160 | * @param scale The new view scale in seconds per pixel. | |
161 | * @param offset The view time offset in seconds. | |
162 | */ | |
60d9b99a | 163 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); |
adb4b10c | 164 | |
f9abf97e | 165 | std::set< std::shared_ptr<pv::data::SignalData> > |
1bc6525b JH |
166 | get_visible_data() const; |
167 | ||
60d9b99a | 168 | std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; |
1bc6525b | 169 | |
c7b03d9d SA |
170 | /** |
171 | * Enables or disables sticky scrolling, i.e. the view always shows | |
172 | * the most recent samples when capturing data. | |
173 | */ | |
174 | void enable_sticky_scrolling(bool state); | |
175 | ||
574c568d SA |
176 | /** |
177 | * Enables or disables coloured trace backgrounds. If they're not | |
178 | * coloured then they will use alternating colors. | |
179 | */ | |
180 | void enable_coloured_bg(bool state); | |
181 | ||
f76af637 JH |
182 | /** |
183 | * Returns true if cursors are displayed. false otherwise. | |
184 | */ | |
185 | bool cursors_shown() const; | |
186 | ||
187 | /** | |
188 | * Shows or hides the cursors. | |
189 | */ | |
190 | void show_cursors(bool show = true); | |
191 | ||
b4d91e56 JH |
192 | /** |
193 | * Moves the cursors to a convenient position in the view. | |
194 | */ | |
195 | void centre_cursors(); | |
196 | ||
f76af637 JH |
197 | /** |
198 | * Returns a reference to the pair of cursors. | |
199 | */ | |
5c5ce757 | 200 | std::shared_ptr<CursorPair> cursors() const; |
58864c5c | 201 | |
8914fe79 JH |
202 | /** |
203 | * Adds a new flag at a specified time. | |
204 | */ | |
60d9b99a | 205 | void add_flag(const pv::util::Timestamp& time); |
8914fe79 JH |
206 | |
207 | /** | |
208 | * Removes a flag from the list. | |
209 | */ | |
210 | void remove_flag(std::shared_ptr<Flag> flag); | |
211 | ||
212 | /** | |
213 | * Gets the list of flags. | |
214 | */ | |
215 | std::vector< std::shared_ptr<Flag> > flags() const; | |
216 | ||
cbd80f64 JH |
217 | const QPoint& hover_point() const; |
218 | ||
9cef9567 | 219 | void update_viewport(); |
7ff0145f | 220 | |
af503b10 | 221 | void restack_all_trace_tree_items(); |
9cef9567 | 222 | |
e9213170 | 223 | Q_SIGNALS: |
cbd80f64 JH |
224 | void hover_point_changed(); |
225 | ||
8b454527 JH |
226 | void selection_changed(); |
227 | ||
4b0af0b6 JS |
228 | /// Emitted when the offset changed. |
229 | void offset_changed(); | |
230 | ||
231 | /// Emitted when the scale changed. | |
232 | void scale_changed(); | |
e0fc5810 | 233 | |
c7b03d9d SA |
234 | void sticky_scrolling_changed(bool state); |
235 | ||
ce11b2ea SA |
236 | void always_zoom_to_fit_changed(bool state); |
237 | ||
4b0af0b6 JS |
238 | /// Emitted when the tick_prefix changed. |
239 | void tick_prefix_changed(); | |
240 | ||
241 | /// Emitted when the tick_precision changed. | |
242 | void tick_precision_changed(); | |
243 | ||
244 | /// Emitted when the tick_period changed. | |
245 | void tick_period_changed(); | |
246 | ||
247 | /// Emitted when the time_unit changed. | |
248 | void time_unit_changed(); | |
249 | ||
48257a69 SA |
250 | public Q_SLOTS: |
251 | void trigger_event(util::Timestamp location); | |
252 | ||
adb4b10c | 253 | private: |
60d9b99a | 254 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; |
3925091a JH |
255 | |
256 | /** | |
257 | * Simultaneously sets the zoom and offset. | |
258 | * @param scale The scale to set the view to in seconds per pixel. This | |
259 | * value is clamped between MinScale and MaxScale. | |
260 | * @param offset The offset of the left edge of the view in seconds. | |
261 | */ | |
d1e7d82c JH |
262 | void set_zoom(double scale, int offset); |
263 | ||
361c560e JH |
264 | /** |
265 | * Find a tick spacing and number formatting that does not cause | |
266 | * the values to collide. | |
267 | */ | |
268 | void calculate_tick_spacing(); | |
269 | ||
adb4b10c JH |
270 | void update_scroll(); |
271 | ||
d7c0ca4a JH |
272 | void update_layout(); |
273 | ||
eae6e30a | 274 | /** |
af503b10 | 275 | * Satisifies TraceTreeItem functionality. |
eae6e30a | 276 | * @param p the QPainter to paint into. |
b3f44329 | 277 | * @param rect the rectangle of the header area. |
eae6e30a JH |
278 | * @param hover true if the label is being hovered over by the mouse. |
279 | */ | |
b3f44329 | 280 | void paint_label(QPainter &p, const QRect &rect, bool hover); |
eae6e30a JH |
281 | |
282 | /** | |
283 | * Computes the outline rectangle of a label. | |
b3f44329 | 284 | * @param rect the rectangle of the header area. |
eae6e30a JH |
285 | * @return Returns the rectangle of the signal label. |
286 | */ | |
b3f44329 | 287 | QRectF label_rect(const QRectF &rect); |
eae6e30a | 288 | |
af503b10 | 289 | TraceTreeItemOwner* find_prevalent_trace_group( |
cf124e47 JH |
290 | const std::shared_ptr<sigrok::ChannelGroup> &group, |
291 | const std::unordered_map<std::shared_ptr<sigrok::Channel>, | |
292 | std::shared_ptr<Signal> > &signal_map); | |
293 | ||
294 | static std::vector< std::shared_ptr<Trace> > | |
295 | extract_new_traces_for_channels( | |
448a72cf | 296 | const std::vector< std::shared_ptr<sigrok::Channel> > &channels, |
cf124e47 | 297 | const std::unordered_map<std::shared_ptr<sigrok::Channel>, |
448a72cf | 298 | std::shared_ptr<Signal> > &signal_map, |
cf124e47 | 299 | std::set< std::shared_ptr<Trace> > &add_list); |
448a72cf | 300 | |
ef454ad5 SA |
301 | void determine_time_unit(); |
302 | ||
cbd80f64 JH |
303 | bool eventFilter(QObject *object, QEvent *event); |
304 | ||
adb4b10c JH |
305 | bool viewportEvent(QEvent *e); |
306 | ||
307 | void resizeEvent(QResizeEvent *e); | |
308 | ||
32218d3e | 309 | public: |
6e2c3c85 | 310 | void row_item_appearance_changed(bool label, bool content); |
98cfe4e8 | 311 | void time_item_appearance_changed(bool label, bool content); |
32218d3e JH |
312 | |
313 | void extents_changed(bool horz, bool vert); | |
314 | ||
e9213170 | 315 | private Q_SLOTS: |
cbd80f64 | 316 | |
b16907d3 | 317 | void h_scroll_value_changed(int value); |
f8400017 | 318 | void v_scroll_value_changed(); |
adb4b10c | 319 | |
69dd2b03 | 320 | void signals_changed(); |
7ee199a7 | 321 | void capture_state_updated(int state); |
adb4b10c JH |
322 | void data_updated(); |
323 | ||
c7b03d9d SA |
324 | void perform_delayed_view_update(); |
325 | ||
32218d3e | 326 | void process_sticky_events(); |
d7c0ca4a | 327 | |
33c62f44 JH |
328 | void on_hover_point_changed(); |
329 | ||
4b0af0b6 JS |
330 | /** |
331 | * Sets the 'offset_' member and emits the 'offset_changed' | |
332 | * signal if needed. | |
333 | */ | |
334 | void set_offset(const pv::util::Timestamp& offset); | |
335 | ||
336 | /** | |
337 | * Sets the 'scale_' member and emits the 'scale_changed' | |
338 | * signal if needed. | |
339 | */ | |
340 | void set_scale(double scale); | |
341 | ||
342 | /** | |
343 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
344 | * signal if needed. | |
345 | */ | |
346 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
347 | ||
348 | /** | |
349 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
350 | * signal if needed. | |
351 | */ | |
352 | void set_tick_precision(unsigned tick_precision); | |
353 | ||
354 | /** | |
355 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
356 | * signal if needed. | |
357 | */ | |
c677193d | 358 | void set_tick_period(const pv::util::Timestamp& tick_period); |
4b0af0b6 JS |
359 | |
360 | /** | |
361 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
362 | * signal if needed. | |
363 | */ | |
364 | void set_time_unit(pv::util::TimeUnit time_unit); | |
365 | ||
adb4b10c | 366 | private: |
2b81ae46 | 367 | Session &session_; |
adb4b10c | 368 | |
8dbbc7f0 JH |
369 | Viewport *viewport_; |
370 | Ruler *ruler_; | |
8dbbc7f0 | 371 | Header *header_; |
adb4b10c | 372 | |
e2f5223b | 373 | /// The view time scale in seconds per pixel. |
8dbbc7f0 | 374 | double scale_; |
e2f5223b JH |
375 | |
376 | /// The view time offset in seconds. | |
60d9b99a | 377 | pv::util::Timestamp offset_; |
adb4b10c | 378 | |
8dbbc7f0 | 379 | bool updating_scroll_; |
c7b03d9d | 380 | bool sticky_scrolling_; |
ce11b2ea | 381 | bool always_zoom_to_fit_; |
c7b03d9d | 382 | QTimer delayed_view_updater_; |
cbd80f64 | 383 | |
c677193d | 384 | pv::util::Timestamp tick_period_; |
d001f416 | 385 | pv::util::SIPrefix tick_prefix_; |
d40f4db7 | 386 | unsigned int tick_precision_; |
ef454ad5 | 387 | util::TimeUnit time_unit_; |
361c560e | 388 | |
8dbbc7f0 | 389 | bool show_cursors_; |
5c5ce757 | 390 | std::shared_ptr<CursorPair> cursors_; |
f76af637 | 391 | |
8914fe79 JH |
392 | std::list< std::shared_ptr<Flag> > flags_; |
393 | char next_flag_text_; | |
394 | ||
92ff2b60 | 395 | std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_; |
1a2288a1 | 396 | |
8dbbc7f0 | 397 | QPoint hover_point_; |
32218d3e | 398 | |
8dbbc7f0 JH |
399 | unsigned int sticky_events_; |
400 | QTimer lazy_event_handler_; | |
adb4b10c JH |
401 | }; |
402 | ||
cdf7bea7 JH |
403 | } // namespace view |
404 | } // namespace pv | |
405 | ||
7a01bd36 | 406 | #endif // PULSEVIEW_PV_VIEW_VIEW_HPP |