]>
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> |
33094993 | 32 | #include <QSplitter> |
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" |
7daebd05 | 40 | #include "trace.hpp" |
af503b10 | 41 | #include "tracetreeitemowner.hpp" |
f76af637 | 42 | |
6f925ba9 UH |
43 | using std::list; |
44 | using std::unordered_map; | |
45 | using std::unordered_set; | |
46 | using std::set; | |
47 | using std::shared_ptr; | |
48 | using std::vector; | |
49 | ||
cf124e47 JH |
50 | namespace sigrok { |
51 | class ChannelGroup; | |
52 | } | |
53 | ||
51e77110 JH |
54 | namespace pv { |
55 | ||
2b81ae46 | 56 | class Session; |
adb4b10c | 57 | |
5ed05b69 SA |
58 | namespace data { |
59 | class Logic; | |
60 | } | |
61 | ||
f4e57597 SA |
62 | namespace views { |
63 | ||
1573bf16 | 64 | namespace trace { |
cdf7bea7 | 65 | |
84a0d458 | 66 | class CursorHeader; |
bb7dd726 | 67 | class DecodeTrace; |
1d8dca91 | 68 | class Header; |
ccdd3ef5 | 69 | class Ruler; |
47e9e7bb | 70 | class Signal; |
cf124e47 | 71 | class Trace; |
cdf7bea7 | 72 | class Viewport; |
1a2288a1 | 73 | class TriggerMarker; |
cdf7bea7 | 74 | |
33094993 | 75 | class CustomScrollArea : public QAbstractScrollArea |
c063290a | 76 | { |
f4e57597 SA |
77 | Q_OBJECT |
78 | ||
79 | public: | |
33094993 | 80 | CustomScrollArea(QWidget *parent = nullptr); |
f4e57597 SA |
81 | bool viewportEvent(QEvent *event); |
82 | }; | |
83 | ||
c063290a UH |
84 | class View : public ViewBase, public TraceTreeItemOwner |
85 | { | |
adb4b10c JH |
86 | Q_OBJECT |
87 | ||
32218d3e JH |
88 | private: |
89 | enum StickyEvents { | |
af503b10 JH |
90 | TraceTreeItemHExtentsChanged = 1, |
91 | TraceTreeItemVExtentsChanged = 2 | |
32218d3e JH |
92 | }; |
93 | ||
adb4b10c | 94 | private: |
60d9b99a JS |
95 | static const pv::util::Timestamp MaxScale; |
96 | static const pv::util::Timestamp MinScale; | |
adb4b10c | 97 | |
f25770e2 JH |
98 | static const int MaxScrollValue; |
99 | ||
361c560e JH |
100 | static const int ScaleUnits[3]; |
101 | ||
adb4b10c | 102 | public: |
f54fc97e | 103 | explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr); |
adb4b10c | 104 | |
2b81ae46 JH |
105 | Session& session(); |
106 | const Session& session() const; | |
1d19ef83 | 107 | |
47e9e7bb SA |
108 | /** |
109 | * Returns the signals contained in this view. | |
110 | */ | |
6f925ba9 | 111 | unordered_set< shared_ptr<Signal> > signals() const; |
47e9e7bb | 112 | |
f4e57597 | 113 | virtual void clear_signals(); |
47e9e7bb | 114 | |
5ed05b69 | 115 | void add_signal(const shared_ptr<Signal> signal); |
47e9e7bb | 116 | |
bb7dd726 | 117 | #ifdef ENABLE_DECODE |
f4e57597 | 118 | virtual void clear_decode_signals(); |
bb7dd726 | 119 | |
ad908057 | 120 | virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal); |
bb7dd726 | 121 | |
ad908057 | 122 | virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal); |
bb7dd726 SA |
123 | #endif |
124 | ||
eae6e30a JH |
125 | /** |
126 | * Returns the view of the owner. | |
127 | */ | |
f4e57597 | 128 | virtual View* view(); |
eae6e30a JH |
129 | |
130 | /** | |
131 | * Returns the view of the owner. | |
132 | */ | |
f4e57597 | 133 | virtual const View* view() const; |
eae6e30a | 134 | |
2ae445ba SA |
135 | Viewport* viewport(); |
136 | ||
137 | const Viewport* viewport() const; | |
138 | ||
f4e57597 | 139 | virtual void save_settings(QSettings &settings) const; |
3a21afa6 | 140 | |
f4e57597 | 141 | virtual void restore_settings(QSettings &settings); |
3a21afa6 | 142 | |
2496bf45 JH |
143 | /** |
144 | * Gets a list of time markers. | |
145 | */ | |
6f925ba9 | 146 | vector< shared_ptr<TimeItem> > time_items() const; |
2496bf45 | 147 | |
e2f5223b JH |
148 | /** |
149 | * Returns the view time scale in seconds per pixel. | |
150 | */ | |
adb4b10c | 151 | double scale() const; |
e2f5223b JH |
152 | |
153 | /** | |
ffc00fdd C |
154 | * Returns the internal view version of the time offset of the left edge |
155 | * of the view in seconds. | |
e2f5223b | 156 | */ |
60d9b99a | 157 | const pv::util::Timestamp& offset() const; |
f8400017 | 158 | |
ffc00fdd C |
159 | /** |
160 | * Returns the ruler version of the time offset of the left edge | |
161 | * of the view in seconds. | |
162 | */ | |
163 | const pv::util::Timestamp& ruler_offset() const; | |
164 | ||
f8400017 JH |
165 | /** |
166 | * Returns the vertical scroll offset. | |
167 | */ | |
7ff0145f | 168 | int owner_visual_v_offset() const; |
adb4b10c | 169 | |
4d476647 JH |
170 | /** |
171 | * Sets the visual v-offset. | |
172 | */ | |
173 | void set_v_offset(int offset); | |
174 | ||
361c560e JH |
175 | /** |
176 | * Returns the SI prefix to apply to the graticule time markings. | |
177 | */ | |
d001f416 | 178 | pv::util::SIPrefix tick_prefix() const; |
361c560e | 179 | |
d40f4db7 SA |
180 | /** |
181 | * Returns the number of fractional digits shown for the time markings. | |
182 | */ | |
183 | unsigned int tick_precision() const; | |
184 | ||
361c560e JH |
185 | /** |
186 | * Returns period of the graticule time markings. | |
187 | */ | |
c677193d | 188 | const pv::util::Timestamp& tick_period() const; |
361c560e | 189 | |
4a076157 C |
190 | /** |
191 | * Returns number of minor division ticks per time marking. | |
192 | */ | |
193 | unsigned int minor_tick_count() const; | |
194 | ||
ef454ad5 SA |
195 | /** |
196 | * Returns the unit of time currently used. | |
197 | */ | |
198 | util::TimeUnit time_unit() const; | |
199 | ||
3e769a37 JH |
200 | /** |
201 | * Returns the number of nested parents that this row item owner has. | |
202 | */ | |
203 | unsigned int depth() const; | |
204 | ||
89914a86 SA |
205 | /** |
206 | * Returns the currently displayed segment, starting at 0. | |
207 | */ | |
208 | uint32_t current_segment() const; | |
209 | ||
7daebd05 SA |
210 | /** |
211 | * Returns whether the currently shown segment can be influenced | |
212 | * (selected) or not. | |
213 | */ | |
214 | bool segment_is_selectable() const; | |
215 | ||
89914a86 | 216 | Trace::SegmentDisplayMode segment_display_mode() const; |
7daebd05 SA |
217 | void set_segment_display_mode(Trace::SegmentDisplayMode mode); |
218 | ||
adb4b10c | 219 | void zoom(double steps); |
17c0f398 | 220 | void zoom(double steps, int offset); |
adb4b10c | 221 | |
ce11b2ea | 222 | void zoom_fit(bool gui_state); |
ca46b534 | 223 | |
d1e7d82c JH |
224 | void zoom_one_to_one(); |
225 | ||
e2f5223b JH |
226 | /** |
227 | * Sets the scale and offset. | |
228 | * @param scale The new view scale in seconds per pixel. | |
229 | * @param offset The view time offset in seconds. | |
230 | */ | |
60d9b99a | 231 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); |
adb4b10c | 232 | |
6f925ba9 | 233 | set< shared_ptr<pv::data::SignalData> > get_visible_data() const; |
1bc6525b | 234 | |
6f925ba9 | 235 | pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; |
1bc6525b | 236 | |
574c568d SA |
237 | /** |
238 | * Enables or disables coloured trace backgrounds. If they're not | |
239 | * coloured then they will use alternating colors. | |
240 | */ | |
241 | void enable_coloured_bg(bool state); | |
242 | ||
48995388 JH |
243 | /** |
244 | * Returns true if the trace background should be drawn with a coloured background. | |
245 | */ | |
246 | bool coloured_bg() const; | |
247 | ||
051ba3b3 UH |
248 | /** |
249 | * Enable or disable showing sampling points. | |
250 | */ | |
251 | void enable_show_sampling_points(bool state); | |
252 | ||
8ad61f40 UH |
253 | /** |
254 | * Enable or disable showing the analog minor grid. | |
255 | */ | |
256 | void enable_show_analog_minor_grid(bool state); | |
257 | ||
f76af637 JH |
258 | /** |
259 | * Returns true if cursors are displayed. false otherwise. | |
260 | */ | |
261 | bool cursors_shown() const; | |
262 | ||
263 | /** | |
264 | * Shows or hides the cursors. | |
265 | */ | |
266 | void show_cursors(bool show = true); | |
267 | ||
b4d91e56 JH |
268 | /** |
269 | * Moves the cursors to a convenient position in the view. | |
270 | */ | |
271 | void centre_cursors(); | |
272 | ||
f76af637 JH |
273 | /** |
274 | * Returns a reference to the pair of cursors. | |
275 | */ | |
6f925ba9 | 276 | shared_ptr<CursorPair> cursors() const; |
58864c5c | 277 | |
8914fe79 JH |
278 | /** |
279 | * Adds a new flag at a specified time. | |
280 | */ | |
60d9b99a | 281 | void add_flag(const pv::util::Timestamp& time); |
8914fe79 JH |
282 | |
283 | /** | |
284 | * Removes a flag from the list. | |
285 | */ | |
6f925ba9 | 286 | void remove_flag(shared_ptr<Flag> flag); |
8914fe79 JH |
287 | |
288 | /** | |
289 | * Gets the list of flags. | |
290 | */ | |
6f925ba9 | 291 | vector< shared_ptr<Flag> > flags() const; |
8914fe79 | 292 | |
cbd80f64 JH |
293 | const QPoint& hover_point() const; |
294 | ||
af503b10 | 295 | void restack_all_trace_tree_items(); |
9cef9567 | 296 | |
e9213170 | 297 | Q_SIGNALS: |
873e8035 | 298 | void hover_point_changed(const QPoint &hp); |
cbd80f64 | 299 | |
8b454527 JH |
300 | void selection_changed(); |
301 | ||
4b0af0b6 JS |
302 | /// Emitted when the offset changed. |
303 | void offset_changed(); | |
304 | ||
305 | /// Emitted when the scale changed. | |
306 | void scale_changed(); | |
e0fc5810 | 307 | |
c7b03d9d SA |
308 | void sticky_scrolling_changed(bool state); |
309 | ||
ce11b2ea SA |
310 | void always_zoom_to_fit_changed(bool state); |
311 | ||
4b0af0b6 JS |
312 | /// Emitted when the tick_prefix changed. |
313 | void tick_prefix_changed(); | |
314 | ||
315 | /// Emitted when the tick_precision changed. | |
316 | void tick_precision_changed(); | |
317 | ||
318 | /// Emitted when the tick_period changed. | |
319 | void tick_period_changed(); | |
320 | ||
321 | /// Emitted when the time_unit changed. | |
322 | void time_unit_changed(); | |
323 | ||
7daebd05 SA |
324 | /// Emitted when the currently selected segment changed |
325 | void segment_changed(int segment_id); | |
326 | ||
327 | /// Emitted when the multi-segment display mode changed | |
89914a86 SA |
328 | /// @param mode is a value of Trace::SegmentDisplayMode |
329 | void segment_display_mode_changed(int mode, bool segment_selectable); | |
7daebd05 | 330 | |
48257a69 SA |
331 | public Q_SLOTS: |
332 | void trigger_event(util::Timestamp location); | |
333 | ||
adb4b10c | 334 | private: |
60d9b99a | 335 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; |
3925091a JH |
336 | |
337 | /** | |
338 | * Simultaneously sets the zoom and offset. | |
339 | * @param scale The scale to set the view to in seconds per pixel. This | |
340 | * value is clamped between MinScale and MaxScale. | |
341 | * @param offset The offset of the left edge of the view in seconds. | |
342 | */ | |
d1e7d82c JH |
343 | void set_zoom(double scale, int offset); |
344 | ||
361c560e JH |
345 | /** |
346 | * Find a tick spacing and number formatting that does not cause | |
347 | * the values to collide. | |
348 | */ | |
349 | void calculate_tick_spacing(); | |
350 | ||
8a5fd81f SA |
351 | void adjust_top_margin(); |
352 | ||
adb4b10c JH |
353 | void update_scroll(); |
354 | ||
925763b0 SA |
355 | void reset_scroll(); |
356 | ||
357 | void set_scroll_default(); | |
358 | ||
9510aea0 | 359 | void determine_if_header_was_shrunk(); |
76750c41 | 360 | |
60c426a0 | 361 | void resize_header_to_fit(); |
33094993 | 362 | |
d7c0ca4a JH |
363 | void update_layout(); |
364 | ||
af503b10 | 365 | TraceTreeItemOwner* find_prevalent_trace_group( |
6f925ba9 UH |
366 | const shared_ptr<sigrok::ChannelGroup> &group, |
367 | const unordered_map<shared_ptr<data::SignalBase>, | |
368 | shared_ptr<Signal> > &signal_map); | |
cf124e47 | 369 | |
6f925ba9 | 370 | static vector< shared_ptr<Trace> > |
cf124e47 | 371 | extract_new_traces_for_channels( |
6f925ba9 UH |
372 | const vector< shared_ptr<sigrok::Channel> > &channels, |
373 | const unordered_map<shared_ptr<data::SignalBase>, | |
374 | shared_ptr<Signal> > &signal_map, | |
375 | set< shared_ptr<Trace> > &add_list); | |
448a72cf | 376 | |
ef454ad5 SA |
377 | void determine_time_unit(); |
378 | ||
cbd80f64 JH |
379 | bool eventFilter(QObject *object, QEvent *event); |
380 | ||
d9ea9628 | 381 | void resizeEvent(QResizeEvent *event); |
adb4b10c | 382 | |
873e8035 SA |
383 | void update_hover_point(); |
384 | ||
32218d3e | 385 | public: |
6e2c3c85 | 386 | void row_item_appearance_changed(bool label, bool content); |
98cfe4e8 | 387 | void time_item_appearance_changed(bool label, bool content); |
32218d3e JH |
388 | |
389 | void extents_changed(bool horz, bool vert); | |
390 | ||
e9213170 | 391 | private Q_SLOTS: |
cbd80f64 | 392 | |
00c518d6 | 393 | void on_signal_name_changed(); |
e0be5f21 | 394 | void on_splitter_moved(); |
2a9fcd62 | 395 | |
b16907d3 | 396 | void h_scroll_value_changed(int value); |
f8400017 | 397 | void v_scroll_value_changed(); |
adb4b10c | 398 | |
69dd2b03 | 399 | void signals_changed(); |
7ee199a7 | 400 | void capture_state_updated(int state); |
adb4b10c | 401 | |
4e86ec70 | 402 | void on_new_segment(int new_segment_id); |
558ad6ce | 403 | void on_segment_completed(int new_segment_id); |
526c8c00 SA |
404 | void on_segment_changed(int segment); |
405 | ||
5ed05b69 | 406 | virtual void perform_delayed_view_update(); |
c7b03d9d | 407 | |
32218d3e | 408 | void process_sticky_events(); |
d7c0ca4a | 409 | |
4b0af0b6 | 410 | /** |
ffc00fdd | 411 | * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed' |
4b0af0b6 JS |
412 | * signal if needed. |
413 | */ | |
414 | void set_offset(const pv::util::Timestamp& offset); | |
415 | ||
416 | /** | |
417 | * Sets the 'scale_' member and emits the 'scale_changed' | |
418 | * signal if needed. | |
419 | */ | |
420 | void set_scale(double scale); | |
421 | ||
422 | /** | |
423 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
424 | * signal if needed. | |
425 | */ | |
426 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
427 | ||
428 | /** | |
429 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
430 | * signal if needed. | |
431 | */ | |
432 | void set_tick_precision(unsigned tick_precision); | |
433 | ||
434 | /** | |
435 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
436 | * signal if needed. | |
437 | */ | |
c677193d | 438 | void set_tick_period(const pv::util::Timestamp& tick_period); |
4b0af0b6 JS |
439 | |
440 | /** | |
441 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
442 | * signal if needed. | |
443 | */ | |
444 | void set_time_unit(pv::util::TimeUnit time_unit); | |
445 | ||
558ad6ce SA |
446 | /** |
447 | * Sets the current segment with the first segment starting at 0. | |
448 | */ | |
449 | void set_current_segment(uint32_t segment_id); | |
450 | ||
adb4b10c | 451 | private: |
33094993 | 452 | CustomScrollArea *scrollarea_; |
8dbbc7f0 JH |
453 | Viewport *viewport_; |
454 | Ruler *ruler_; | |
8dbbc7f0 | 455 | Header *header_; |
33094993 | 456 | QSplitter *splitter_; |
adb4b10c | 457 | |
6f925ba9 | 458 | unordered_set< shared_ptr<Signal> > signals_; |
47e9e7bb | 459 | |
bb7dd726 | 460 | #ifdef ENABLE_DECODE |
6f925ba9 | 461 | vector< shared_ptr<DecodeTrace> > decode_traces_; |
bb7dd726 SA |
462 | #endif |
463 | ||
7daebd05 SA |
464 | Trace::SegmentDisplayMode segment_display_mode_; |
465 | ||
466 | /// Signals whether the user can change the currently shown segment. | |
467 | bool segment_selectable_; | |
526c8c00 | 468 | |
e2f5223b | 469 | /// The view time scale in seconds per pixel. |
8dbbc7f0 | 470 | double scale_; |
e2f5223b | 471 | |
ffc00fdd | 472 | /// The internal view version of the time offset in seconds. |
60d9b99a | 473 | pv::util::Timestamp offset_; |
ffc00fdd C |
474 | /// The ruler version of the time offset in seconds. |
475 | pv::util::Timestamp ruler_offset_; | |
adb4b10c | 476 | |
8dbbc7f0 | 477 | bool updating_scroll_; |
4cc2e925 | 478 | bool settings_restored_; |
9510aea0 | 479 | bool header_was_shrunk_; |
4cc2e925 | 480 | |
c7b03d9d | 481 | bool sticky_scrolling_; |
9eae6de4 | 482 | bool coloured_bg_; |
ce11b2ea | 483 | bool always_zoom_to_fit_; |
cbd80f64 | 484 | |
c677193d | 485 | pv::util::Timestamp tick_period_; |
d001f416 | 486 | pv::util::SIPrefix tick_prefix_; |
4a076157 | 487 | unsigned int minor_tick_count_; |
d40f4db7 | 488 | unsigned int tick_precision_; |
ef454ad5 | 489 | util::TimeUnit time_unit_; |
361c560e | 490 | |
8dbbc7f0 | 491 | bool show_cursors_; |
6f925ba9 | 492 | shared_ptr<CursorPair> cursors_; |
f76af637 | 493 | |
6f925ba9 | 494 | list< shared_ptr<Flag> > flags_; |
8914fe79 JH |
495 | char next_flag_text_; |
496 | ||
6f925ba9 | 497 | vector< shared_ptr<TriggerMarker> > trigger_markers_; |
1a2288a1 | 498 | |
8dbbc7f0 | 499 | QPoint hover_point_; |
32218d3e | 500 | |
8dbbc7f0 JH |
501 | unsigned int sticky_events_; |
502 | QTimer lazy_event_handler_; | |
925763b0 SA |
503 | |
504 | // This is true when the defaults couldn't be set due to insufficient info | |
e62bee73 | 505 | bool scroll_needs_defaults_; |
39ab01e7 SA |
506 | |
507 | // A nonzero value indicates the v offset to restore. See View::resizeEvent() | |
508 | int saved_v_offset_; | |
28ceff25 SA |
509 | |
510 | // These are used to determine whether the view was altered after acq started | |
511 | double scale_at_acq_start_; | |
512 | pv::util::Timestamp offset_at_acq_start_; | |
513 | ||
514 | // Used to suppress performing a "zoom to fit" when the session stops. This | |
515 | // is needed when the view's settings are restored before acquisition ends. | |
516 | // In that case we want to keep the restored settings, not have a "zoom to fit" | |
517 | // mess them up. | |
518 | bool suppress_zoom_to_fit_after_acq_; | |
adb4b10c JH |
519 | }; |
520 | ||
1573bf16 | 521 | } // namespace trace |
f4e57597 | 522 | } // namespace views |
cdf7bea7 JH |
523 | } // namespace pv |
524 | ||
f4e57597 | 525 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |