]>
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
adb4b10c JH |
18 | */ |
19 | ||
f4e57597 SA |
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP | |
adb4b10c | 22 | |
cafe470e | 23 | #include <cstdint> |
8914fe79 | 24 | #include <list> |
f9abf97e | 25 | #include <memory> |
1bc6525b | 26 | #include <set> |
448a72cf | 27 | #include <unordered_map> |
38eeddea JH |
28 | #include <vector> |
29 | ||
adb4b10c | 30 | #include <QAbstractScrollArea> |
2e04f9bd | 31 | #include <QSizeF> |
32218d3e | 32 | #include <QTimer> |
adb4b10c | 33 | |
2acdb232 | 34 | #include <pv/data/signaldata.hpp> |
ef454ad5 | 35 | #include <pv/util.hpp> |
aca9aa83 | 36 | #include <pv/views/viewbase.hpp> |
1bc6525b | 37 | |
2acdb232 | 38 | #include "cursorpair.hpp" |
8914fe79 | 39 | #include "flag.hpp" |
af503b10 | 40 | #include "tracetreeitemowner.hpp" |
f76af637 | 41 | |
6f925ba9 UH |
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 | ||
cf124e47 JH |
49 | namespace sigrok { |
50 | class ChannelGroup; | |
51 | } | |
52 | ||
51e77110 JH |
53 | namespace pv { |
54 | ||
2b81ae46 | 55 | class Session; |
adb4b10c | 56 | |
f4e57597 SA |
57 | namespace views { |
58 | ||
59 | namespace TraceView { | |
cdf7bea7 | 60 | |
84a0d458 | 61 | class CursorHeader; |
bb7dd726 | 62 | class DecodeTrace; |
1d8dca91 | 63 | class Header; |
ccdd3ef5 | 64 | class Ruler; |
47e9e7bb | 65 | class Signal; |
cf124e47 | 66 | class Trace; |
cdf7bea7 | 67 | class Viewport; |
1a2288a1 | 68 | class TriggerMarker; |
cdf7bea7 | 69 | |
c063290a UH |
70 | class CustomAbstractScrollArea : public QAbstractScrollArea |
71 | { | |
f4e57597 SA |
72 | Q_OBJECT |
73 | ||
74 | public: | |
f54fc97e | 75 | CustomAbstractScrollArea(QWidget *parent = nullptr); |
f4e57597 SA |
76 | void setViewportMargins(int left, int top, int right, int bottom); |
77 | bool viewportEvent(QEvent *event); | |
78 | }; | |
79 | ||
c063290a UH |
80 | class View : public ViewBase, public TraceTreeItemOwner |
81 | { | |
adb4b10c JH |
82 | Q_OBJECT |
83 | ||
32218d3e JH |
84 | private: |
85 | enum StickyEvents { | |
af503b10 JH |
86 | TraceTreeItemHExtentsChanged = 1, |
87 | TraceTreeItemVExtentsChanged = 2 | |
32218d3e JH |
88 | }; |
89 | ||
adb4b10c | 90 | private: |
60d9b99a JS |
91 | static const pv::util::Timestamp MaxScale; |
92 | static const pv::util::Timestamp MinScale; | |
adb4b10c | 93 | |
f25770e2 | 94 | static const int MaxScrollValue; |
c7b03d9d | 95 | static const int MaxViewAutoUpdateRate; |
f25770e2 | 96 | |
361c560e JH |
97 | static const int ScaleUnits[3]; |
98 | ||
adb4b10c | 99 | public: |
f54fc97e | 100 | explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr); |
adb4b10c | 101 | |
2b81ae46 JH |
102 | Session& session(); |
103 | const Session& session() const; | |
1d19ef83 | 104 | |
47e9e7bb SA |
105 | /** |
106 | * Returns the signals contained in this view. | |
107 | */ | |
6f925ba9 | 108 | unordered_set< shared_ptr<Signal> > signals() const; |
47e9e7bb | 109 | |
f4e57597 | 110 | virtual void clear_signals(); |
47e9e7bb | 111 | |
6f925ba9 | 112 | virtual void add_signal(const shared_ptr<Signal> signal); |
47e9e7bb | 113 | |
bb7dd726 | 114 | #ifdef ENABLE_DECODE |
f4e57597 | 115 | virtual void clear_decode_signals(); |
bb7dd726 | 116 | |
6f925ba9 | 117 | virtual void add_decode_signal(shared_ptr<data::SignalBase> signalbase); |
bb7dd726 | 118 | |
6f925ba9 | 119 | virtual void remove_decode_signal(shared_ptr<data::SignalBase> signalbase); |
bb7dd726 SA |
120 | #endif |
121 | ||
eae6e30a JH |
122 | /** |
123 | * Returns the view of the owner. | |
124 | */ | |
f4e57597 | 125 | virtual View* view(); |
eae6e30a JH |
126 | |
127 | /** | |
128 | * Returns the view of the owner. | |
129 | */ | |
f4e57597 | 130 | virtual const View* view() const; |
eae6e30a | 131 | |
2ae445ba SA |
132 | Viewport* viewport(); |
133 | ||
134 | const Viewport* viewport() const; | |
135 | ||
f4e57597 | 136 | virtual void save_settings(QSettings &settings) const; |
3a21afa6 | 137 | |
f4e57597 | 138 | virtual void restore_settings(QSettings &settings); |
3a21afa6 | 139 | |
2496bf45 JH |
140 | /** |
141 | * Gets a list of time markers. | |
142 | */ | |
6f925ba9 | 143 | vector< shared_ptr<TimeItem> > time_items() const; |
2496bf45 | 144 | |
e2f5223b JH |
145 | /** |
146 | * Returns the view time scale in seconds per pixel. | |
147 | */ | |
adb4b10c | 148 | double scale() const; |
e2f5223b JH |
149 | |
150 | /** | |
151 | * Returns the time offset of the left edge of the view in | |
152 | * seconds. | |
153 | */ | |
60d9b99a | 154 | const pv::util::Timestamp& offset() const; |
f8400017 JH |
155 | |
156 | /** | |
157 | * Returns the vertical scroll offset. | |
158 | */ | |
7ff0145f | 159 | int owner_visual_v_offset() const; |
adb4b10c | 160 | |
4d476647 JH |
161 | /** |
162 | * Sets the visual v-offset. | |
163 | */ | |
164 | void set_v_offset(int offset); | |
165 | ||
361c560e JH |
166 | /** |
167 | * Returns the SI prefix to apply to the graticule time markings. | |
168 | */ | |
d001f416 | 169 | pv::util::SIPrefix tick_prefix() const; |
361c560e | 170 | |
d40f4db7 SA |
171 | /** |
172 | * Returns the number of fractional digits shown for the time markings. | |
173 | */ | |
174 | unsigned int tick_precision() const; | |
175 | ||
361c560e JH |
176 | /** |
177 | * Returns period of the graticule time markings. | |
178 | */ | |
c677193d | 179 | const pv::util::Timestamp& tick_period() const; |
361c560e | 180 | |
ef454ad5 SA |
181 | /** |
182 | * Returns the unit of time currently used. | |
183 | */ | |
184 | util::TimeUnit time_unit() const; | |
185 | ||
3e769a37 JH |
186 | /** |
187 | * Returns the number of nested parents that this row item owner has. | |
188 | */ | |
189 | unsigned int depth() const; | |
190 | ||
adb4b10c | 191 | void zoom(double steps); |
17c0f398 | 192 | void zoom(double steps, int offset); |
adb4b10c | 193 | |
ce11b2ea | 194 | void zoom_fit(bool gui_state); |
ca46b534 | 195 | |
d1e7d82c JH |
196 | void zoom_one_to_one(); |
197 | ||
e2f5223b JH |
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 | */ | |
60d9b99a | 203 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); |
adb4b10c | 204 | |
6f925ba9 | 205 | set< shared_ptr<pv::data::SignalData> > get_visible_data() const; |
1bc6525b | 206 | |
6f925ba9 | 207 | pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; |
1bc6525b | 208 | |
574c568d SA |
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 | ||
051ba3b3 UH |
215 | /** |
216 | * Enable or disable showing sampling points. | |
217 | */ | |
218 | void enable_show_sampling_points(bool state); | |
219 | ||
8ad61f40 UH |
220 | /** |
221 | * Enable or disable showing the analog minor grid. | |
222 | */ | |
223 | void enable_show_analog_minor_grid(bool state); | |
224 | ||
f76af637 JH |
225 | /** |
226 | * Returns true if cursors are displayed. false otherwise. | |
227 | */ | |
228 | bool cursors_shown() const; | |
229 | ||
230 | /** | |
231 | * Shows or hides the cursors. | |
232 | */ | |
233 | void show_cursors(bool show = true); | |
234 | ||
b4d91e56 JH |
235 | /** |
236 | * Moves the cursors to a convenient position in the view. | |
237 | */ | |
238 | void centre_cursors(); | |
239 | ||
f76af637 JH |
240 | /** |
241 | * Returns a reference to the pair of cursors. | |
242 | */ | |
6f925ba9 | 243 | shared_ptr<CursorPair> cursors() const; |
58864c5c | 244 | |
8914fe79 JH |
245 | /** |
246 | * Adds a new flag at a specified time. | |
247 | */ | |
60d9b99a | 248 | void add_flag(const pv::util::Timestamp& time); |
8914fe79 JH |
249 | |
250 | /** | |
251 | * Removes a flag from the list. | |
252 | */ | |
6f925ba9 | 253 | void remove_flag(shared_ptr<Flag> flag); |
8914fe79 JH |
254 | |
255 | /** | |
256 | * Gets the list of flags. | |
257 | */ | |
6f925ba9 | 258 | vector< shared_ptr<Flag> > flags() const; |
8914fe79 | 259 | |
cbd80f64 JH |
260 | const QPoint& hover_point() const; |
261 | ||
af503b10 | 262 | void restack_all_trace_tree_items(); |
9cef9567 | 263 | |
e9213170 | 264 | Q_SIGNALS: |
cbd80f64 JH |
265 | void hover_point_changed(); |
266 | ||
8b454527 JH |
267 | void selection_changed(); |
268 | ||
4b0af0b6 JS |
269 | /// Emitted when the offset changed. |
270 | void offset_changed(); | |
271 | ||
272 | /// Emitted when the scale changed. | |
273 | void scale_changed(); | |
e0fc5810 | 274 | |
c7b03d9d SA |
275 | void sticky_scrolling_changed(bool state); |
276 | ||
ce11b2ea SA |
277 | void always_zoom_to_fit_changed(bool state); |
278 | ||
4b0af0b6 JS |
279 | /// Emitted when the tick_prefix changed. |
280 | void tick_prefix_changed(); | |
281 | ||
282 | /// Emitted when the tick_precision changed. | |
283 | void tick_precision_changed(); | |
284 | ||
285 | /// Emitted when the tick_period changed. | |
286 | void tick_period_changed(); | |
287 | ||
288 | /// Emitted when the time_unit changed. | |
289 | void time_unit_changed(); | |
290 | ||
48257a69 SA |
291 | public Q_SLOTS: |
292 | void trigger_event(util::Timestamp location); | |
293 | ||
adb4b10c | 294 | private: |
60d9b99a | 295 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; |
3925091a JH |
296 | |
297 | /** | |
298 | * Simultaneously sets the zoom and offset. | |
299 | * @param scale The scale to set the view to in seconds per pixel. This | |
300 | * value is clamped between MinScale and MaxScale. | |
301 | * @param offset The offset of the left edge of the view in seconds. | |
302 | */ | |
d1e7d82c JH |
303 | void set_zoom(double scale, int offset); |
304 | ||
361c560e JH |
305 | /** |
306 | * Find a tick spacing and number formatting that does not cause | |
307 | * the values to collide. | |
308 | */ | |
309 | void calculate_tick_spacing(); | |
310 | ||
adb4b10c JH |
311 | void update_scroll(); |
312 | ||
925763b0 SA |
313 | void reset_scroll(); |
314 | ||
315 | void set_scroll_default(); | |
316 | ||
d7c0ca4a JH |
317 | void update_layout(); |
318 | ||
af503b10 | 319 | TraceTreeItemOwner* find_prevalent_trace_group( |
6f925ba9 UH |
320 | const shared_ptr<sigrok::ChannelGroup> &group, |
321 | const unordered_map<shared_ptr<data::SignalBase>, | |
322 | shared_ptr<Signal> > &signal_map); | |
cf124e47 | 323 | |
6f925ba9 | 324 | static vector< shared_ptr<Trace> > |
cf124e47 | 325 | extract_new_traces_for_channels( |
6f925ba9 UH |
326 | const vector< shared_ptr<sigrok::Channel> > &channels, |
327 | const unordered_map<shared_ptr<data::SignalBase>, | |
328 | shared_ptr<Signal> > &signal_map, | |
329 | set< shared_ptr<Trace> > &add_list); | |
448a72cf | 330 | |
ef454ad5 SA |
331 | void determine_time_unit(); |
332 | ||
cbd80f64 JH |
333 | bool eventFilter(QObject *object, QEvent *event); |
334 | ||
d9ea9628 | 335 | void resizeEvent(QResizeEvent *event); |
adb4b10c | 336 | |
32218d3e | 337 | public: |
6e2c3c85 | 338 | void row_item_appearance_changed(bool label, bool content); |
98cfe4e8 | 339 | void time_item_appearance_changed(bool label, bool content); |
32218d3e JH |
340 | |
341 | void extents_changed(bool horz, bool vert); | |
342 | ||
e9213170 | 343 | private Q_SLOTS: |
cbd80f64 | 344 | |
b16907d3 | 345 | void h_scroll_value_changed(int value); |
f8400017 | 346 | void v_scroll_value_changed(); |
adb4b10c | 347 | |
69dd2b03 | 348 | void signals_changed(); |
7ee199a7 | 349 | void capture_state_updated(int state); |
adb4b10c JH |
350 | void data_updated(); |
351 | ||
c7b03d9d SA |
352 | void perform_delayed_view_update(); |
353 | ||
32218d3e | 354 | void process_sticky_events(); |
d7c0ca4a | 355 | |
33c62f44 JH |
356 | void on_hover_point_changed(); |
357 | ||
4b0af0b6 JS |
358 | /** |
359 | * Sets the 'offset_' member and emits the 'offset_changed' | |
360 | * signal if needed. | |
361 | */ | |
362 | void set_offset(const pv::util::Timestamp& offset); | |
363 | ||
364 | /** | |
365 | * Sets the 'scale_' member and emits the 'scale_changed' | |
366 | * signal if needed. | |
367 | */ | |
368 | void set_scale(double scale); | |
369 | ||
370 | /** | |
371 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
372 | * signal if needed. | |
373 | */ | |
374 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
375 | ||
376 | /** | |
377 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
378 | * signal if needed. | |
379 | */ | |
380 | void set_tick_precision(unsigned tick_precision); | |
381 | ||
382 | /** | |
383 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
384 | * signal if needed. | |
385 | */ | |
c677193d | 386 | void set_tick_period(const pv::util::Timestamp& tick_period); |
4b0af0b6 JS |
387 | |
388 | /** | |
389 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
390 | * signal if needed. | |
391 | */ | |
392 | void set_time_unit(pv::util::TimeUnit time_unit); | |
393 | ||
adb4b10c | 394 | private: |
8dbbc7f0 JH |
395 | Viewport *viewport_; |
396 | Ruler *ruler_; | |
8dbbc7f0 | 397 | Header *header_; |
adb4b10c | 398 | |
6f925ba9 | 399 | unordered_set< shared_ptr<Signal> > signals_; |
47e9e7bb | 400 | |
bb7dd726 | 401 | #ifdef ENABLE_DECODE |
6f925ba9 | 402 | vector< shared_ptr<DecodeTrace> > decode_traces_; |
bb7dd726 SA |
403 | #endif |
404 | ||
f4e57597 SA |
405 | CustomAbstractScrollArea scrollarea_; |
406 | ||
e2f5223b | 407 | /// The view time scale in seconds per pixel. |
8dbbc7f0 | 408 | double scale_; |
e2f5223b JH |
409 | |
410 | /// The view time offset in seconds. | |
60d9b99a | 411 | pv::util::Timestamp offset_; |
adb4b10c | 412 | |
8dbbc7f0 | 413 | bool updating_scroll_; |
c7b03d9d | 414 | bool sticky_scrolling_; |
9eae6de4 | 415 | bool coloured_bg_; |
ce11b2ea | 416 | bool always_zoom_to_fit_; |
c7b03d9d | 417 | QTimer delayed_view_updater_; |
cbd80f64 | 418 | |
c677193d | 419 | pv::util::Timestamp tick_period_; |
d001f416 | 420 | pv::util::SIPrefix tick_prefix_; |
d40f4db7 | 421 | unsigned int tick_precision_; |
ef454ad5 | 422 | util::TimeUnit time_unit_; |
361c560e | 423 | |
8dbbc7f0 | 424 | bool show_cursors_; |
6f925ba9 | 425 | shared_ptr<CursorPair> cursors_; |
f76af637 | 426 | |
6f925ba9 | 427 | list< shared_ptr<Flag> > flags_; |
8914fe79 JH |
428 | char next_flag_text_; |
429 | ||
6f925ba9 | 430 | vector< shared_ptr<TriggerMarker> > trigger_markers_; |
1a2288a1 | 431 | |
8dbbc7f0 | 432 | QPoint hover_point_; |
32218d3e | 433 | |
8dbbc7f0 JH |
434 | unsigned int sticky_events_; |
435 | QTimer lazy_event_handler_; | |
925763b0 SA |
436 | |
437 | // This is true when the defaults couldn't be set due to insufficient info | |
e62bee73 | 438 | bool scroll_needs_defaults_; |
39ab01e7 SA |
439 | |
440 | // A nonzero value indicates the v offset to restore. See View::resizeEvent() | |
441 | int saved_v_offset_; | |
ae5f6628 SA |
442 | |
443 | bool size_finalized_; | |
adb4b10c JH |
444 | }; |
445 | ||
f4e57597 SA |
446 | } // namespace TraceView |
447 | } // namespace views | |
cdf7bea7 JH |
448 | } // namespace pv |
449 | ||
f4e57597 | 450 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |