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