]>
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 | /** | |
154 | * Returns the time offset of the left edge of the view in | |
155 | * seconds. | |
156 | */ | |
60d9b99a | 157 | const pv::util::Timestamp& offset() const; |
f8400017 JH |
158 | |
159 | /** | |
160 | * Returns the vertical scroll offset. | |
161 | */ | |
7ff0145f | 162 | int owner_visual_v_offset() const; |
adb4b10c | 163 | |
4d476647 JH |
164 | /** |
165 | * Sets the visual v-offset. | |
166 | */ | |
167 | void set_v_offset(int offset); | |
168 | ||
361c560e JH |
169 | /** |
170 | * Returns the SI prefix to apply to the graticule time markings. | |
171 | */ | |
d001f416 | 172 | pv::util::SIPrefix tick_prefix() const; |
361c560e | 173 | |
d40f4db7 SA |
174 | /** |
175 | * Returns the number of fractional digits shown for the time markings. | |
176 | */ | |
177 | unsigned int tick_precision() const; | |
178 | ||
361c560e JH |
179 | /** |
180 | * Returns period of the graticule time markings. | |
181 | */ | |
c677193d | 182 | const pv::util::Timestamp& tick_period() const; |
361c560e | 183 | |
ef454ad5 SA |
184 | /** |
185 | * Returns the unit of time currently used. | |
186 | */ | |
187 | util::TimeUnit time_unit() const; | |
188 | ||
3e769a37 JH |
189 | /** |
190 | * Returns the number of nested parents that this row item owner has. | |
191 | */ | |
192 | unsigned int depth() const; | |
193 | ||
7daebd05 SA |
194 | /** |
195 | * Returns whether the currently shown segment can be influenced | |
196 | * (selected) or not. | |
197 | */ | |
198 | bool segment_is_selectable() const; | |
199 | ||
200 | void set_segment_display_mode(Trace::SegmentDisplayMode mode); | |
201 | ||
adb4b10c | 202 | void zoom(double steps); |
17c0f398 | 203 | void zoom(double steps, int offset); |
adb4b10c | 204 | |
ce11b2ea | 205 | void zoom_fit(bool gui_state); |
ca46b534 | 206 | |
d1e7d82c JH |
207 | void zoom_one_to_one(); |
208 | ||
e2f5223b JH |
209 | /** |
210 | * Sets the scale and offset. | |
211 | * @param scale The new view scale in seconds per pixel. | |
212 | * @param offset The view time offset in seconds. | |
213 | */ | |
60d9b99a | 214 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); |
adb4b10c | 215 | |
6f925ba9 | 216 | set< shared_ptr<pv::data::SignalData> > get_visible_data() const; |
1bc6525b | 217 | |
6f925ba9 | 218 | pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; |
1bc6525b | 219 | |
574c568d SA |
220 | /** |
221 | * Enables or disables coloured trace backgrounds. If they're not | |
222 | * coloured then they will use alternating colors. | |
223 | */ | |
224 | void enable_coloured_bg(bool state); | |
225 | ||
48995388 JH |
226 | /** |
227 | * Returns true if the trace background should be drawn with a coloured background. | |
228 | */ | |
229 | bool coloured_bg() const; | |
230 | ||
051ba3b3 UH |
231 | /** |
232 | * Enable or disable showing sampling points. | |
233 | */ | |
234 | void enable_show_sampling_points(bool state); | |
235 | ||
8ad61f40 UH |
236 | /** |
237 | * Enable or disable showing the analog minor grid. | |
238 | */ | |
239 | void enable_show_analog_minor_grid(bool state); | |
240 | ||
f76af637 JH |
241 | /** |
242 | * Returns true if cursors are displayed. false otherwise. | |
243 | */ | |
244 | bool cursors_shown() const; | |
245 | ||
246 | /** | |
247 | * Shows or hides the cursors. | |
248 | */ | |
249 | void show_cursors(bool show = true); | |
250 | ||
b4d91e56 JH |
251 | /** |
252 | * Moves the cursors to a convenient position in the view. | |
253 | */ | |
254 | void centre_cursors(); | |
255 | ||
f76af637 JH |
256 | /** |
257 | * Returns a reference to the pair of cursors. | |
258 | */ | |
6f925ba9 | 259 | shared_ptr<CursorPair> cursors() const; |
58864c5c | 260 | |
8914fe79 JH |
261 | /** |
262 | * Adds a new flag at a specified time. | |
263 | */ | |
60d9b99a | 264 | void add_flag(const pv::util::Timestamp& time); |
8914fe79 JH |
265 | |
266 | /** | |
267 | * Removes a flag from the list. | |
268 | */ | |
6f925ba9 | 269 | void remove_flag(shared_ptr<Flag> flag); |
8914fe79 JH |
270 | |
271 | /** | |
272 | * Gets the list of flags. | |
273 | */ | |
6f925ba9 | 274 | vector< shared_ptr<Flag> > flags() const; |
8914fe79 | 275 | |
cbd80f64 JH |
276 | const QPoint& hover_point() const; |
277 | ||
af503b10 | 278 | void restack_all_trace_tree_items(); |
9cef9567 | 279 | |
e9213170 | 280 | Q_SIGNALS: |
873e8035 | 281 | void hover_point_changed(const QPoint &hp); |
cbd80f64 | 282 | |
8b454527 JH |
283 | void selection_changed(); |
284 | ||
4b0af0b6 JS |
285 | /// Emitted when the offset changed. |
286 | void offset_changed(); | |
287 | ||
288 | /// Emitted when the scale changed. | |
289 | void scale_changed(); | |
e0fc5810 | 290 | |
c7b03d9d SA |
291 | void sticky_scrolling_changed(bool state); |
292 | ||
ce11b2ea SA |
293 | void always_zoom_to_fit_changed(bool state); |
294 | ||
4b0af0b6 JS |
295 | /// Emitted when the tick_prefix changed. |
296 | void tick_prefix_changed(); | |
297 | ||
298 | /// Emitted when the tick_precision changed. | |
299 | void tick_precision_changed(); | |
300 | ||
301 | /// Emitted when the tick_period changed. | |
302 | void tick_period_changed(); | |
303 | ||
304 | /// Emitted when the time_unit changed. | |
305 | void time_unit_changed(); | |
306 | ||
7daebd05 SA |
307 | /// Emitted when the currently selected segment changed |
308 | void segment_changed(int segment_id); | |
309 | ||
310 | /// Emitted when the multi-segment display mode changed | |
311 | void segment_display_mode_changed(bool segment_selectable); | |
312 | ||
48257a69 SA |
313 | public Q_SLOTS: |
314 | void trigger_event(util::Timestamp location); | |
315 | ||
adb4b10c | 316 | private: |
60d9b99a | 317 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; |
3925091a JH |
318 | |
319 | /** | |
320 | * Simultaneously sets the zoom and offset. | |
321 | * @param scale The scale to set the view to in seconds per pixel. This | |
322 | * value is clamped between MinScale and MaxScale. | |
323 | * @param offset The offset of the left edge of the view in seconds. | |
324 | */ | |
d1e7d82c JH |
325 | void set_zoom(double scale, int offset); |
326 | ||
361c560e JH |
327 | /** |
328 | * Find a tick spacing and number formatting that does not cause | |
329 | * the values to collide. | |
330 | */ | |
331 | void calculate_tick_spacing(); | |
332 | ||
8a5fd81f SA |
333 | void adjust_top_margin(); |
334 | ||
adb4b10c JH |
335 | void update_scroll(); |
336 | ||
925763b0 SA |
337 | void reset_scroll(); |
338 | ||
339 | void set_scroll_default(); | |
340 | ||
9510aea0 | 341 | void determine_if_header_was_shrunk(); |
76750c41 | 342 | |
60c426a0 | 343 | void resize_header_to_fit(); |
33094993 | 344 | |
d7c0ca4a JH |
345 | void update_layout(); |
346 | ||
af503b10 | 347 | TraceTreeItemOwner* find_prevalent_trace_group( |
6f925ba9 UH |
348 | const shared_ptr<sigrok::ChannelGroup> &group, |
349 | const unordered_map<shared_ptr<data::SignalBase>, | |
350 | shared_ptr<Signal> > &signal_map); | |
cf124e47 | 351 | |
6f925ba9 | 352 | static vector< shared_ptr<Trace> > |
cf124e47 | 353 | extract_new_traces_for_channels( |
6f925ba9 UH |
354 | const vector< shared_ptr<sigrok::Channel> > &channels, |
355 | const unordered_map<shared_ptr<data::SignalBase>, | |
356 | shared_ptr<Signal> > &signal_map, | |
357 | set< shared_ptr<Trace> > &add_list); | |
448a72cf | 358 | |
ef454ad5 SA |
359 | void determine_time_unit(); |
360 | ||
cbd80f64 JH |
361 | bool eventFilter(QObject *object, QEvent *event); |
362 | ||
d9ea9628 | 363 | void resizeEvent(QResizeEvent *event); |
adb4b10c | 364 | |
873e8035 SA |
365 | void update_hover_point(); |
366 | ||
32218d3e | 367 | public: |
6e2c3c85 | 368 | void row_item_appearance_changed(bool label, bool content); |
98cfe4e8 | 369 | void time_item_appearance_changed(bool label, bool content); |
32218d3e JH |
370 | |
371 | void extents_changed(bool horz, bool vert); | |
372 | ||
e9213170 | 373 | private Q_SLOTS: |
cbd80f64 | 374 | |
00c518d6 | 375 | void on_signal_name_changed(); |
e0be5f21 | 376 | void on_splitter_moved(); |
2a9fcd62 | 377 | |
b16907d3 | 378 | void h_scroll_value_changed(int value); |
f8400017 | 379 | void v_scroll_value_changed(); |
adb4b10c | 380 | |
69dd2b03 | 381 | void signals_changed(); |
7ee199a7 | 382 | void capture_state_updated(int state); |
adb4b10c | 383 | |
4e86ec70 | 384 | void on_new_segment(int new_segment_id); |
526c8c00 SA |
385 | void on_segment_changed(int segment); |
386 | ||
5ed05b69 | 387 | virtual void perform_delayed_view_update(); |
c7b03d9d | 388 | |
32218d3e | 389 | void process_sticky_events(); |
d7c0ca4a | 390 | |
4b0af0b6 JS |
391 | /** |
392 | * Sets the 'offset_' member and emits the 'offset_changed' | |
393 | * signal if needed. | |
394 | */ | |
395 | void set_offset(const pv::util::Timestamp& offset); | |
396 | ||
397 | /** | |
398 | * Sets the 'scale_' member and emits the 'scale_changed' | |
399 | * signal if needed. | |
400 | */ | |
401 | void set_scale(double scale); | |
402 | ||
403 | /** | |
404 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
405 | * signal if needed. | |
406 | */ | |
407 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
408 | ||
409 | /** | |
410 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
411 | * signal if needed. | |
412 | */ | |
413 | void set_tick_precision(unsigned tick_precision); | |
414 | ||
415 | /** | |
416 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
417 | * signal if needed. | |
418 | */ | |
c677193d | 419 | void set_tick_period(const pv::util::Timestamp& tick_period); |
4b0af0b6 JS |
420 | |
421 | /** | |
422 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
423 | * signal if needed. | |
424 | */ | |
425 | void set_time_unit(pv::util::TimeUnit time_unit); | |
426 | ||
adb4b10c | 427 | private: |
33094993 | 428 | CustomScrollArea *scrollarea_; |
8dbbc7f0 JH |
429 | Viewport *viewport_; |
430 | Ruler *ruler_; | |
8dbbc7f0 | 431 | Header *header_; |
33094993 | 432 | QSplitter *splitter_; |
adb4b10c | 433 | |
6f925ba9 | 434 | unordered_set< shared_ptr<Signal> > signals_; |
47e9e7bb | 435 | |
bb7dd726 | 436 | #ifdef ENABLE_DECODE |
6f925ba9 | 437 | vector< shared_ptr<DecodeTrace> > decode_traces_; |
bb7dd726 SA |
438 | #endif |
439 | ||
526c8c00 SA |
440 | /// The ID of the currently displayed segment |
441 | int current_segment_; | |
7daebd05 SA |
442 | Trace::SegmentDisplayMode segment_display_mode_; |
443 | ||
444 | /// Signals whether the user can change the currently shown segment. | |
445 | bool segment_selectable_; | |
526c8c00 | 446 | |
e2f5223b | 447 | /// The view time scale in seconds per pixel. |
8dbbc7f0 | 448 | double scale_; |
e2f5223b JH |
449 | |
450 | /// The view time offset in seconds. | |
60d9b99a | 451 | pv::util::Timestamp offset_; |
adb4b10c | 452 | |
8dbbc7f0 | 453 | bool updating_scroll_; |
4cc2e925 | 454 | bool settings_restored_; |
9510aea0 | 455 | bool header_was_shrunk_; |
4cc2e925 | 456 | |
c7b03d9d | 457 | bool sticky_scrolling_; |
9eae6de4 | 458 | bool coloured_bg_; |
ce11b2ea | 459 | bool always_zoom_to_fit_; |
cbd80f64 | 460 | |
c677193d | 461 | pv::util::Timestamp tick_period_; |
d001f416 | 462 | pv::util::SIPrefix tick_prefix_; |
d40f4db7 | 463 | unsigned int tick_precision_; |
ef454ad5 | 464 | util::TimeUnit time_unit_; |
361c560e | 465 | |
8dbbc7f0 | 466 | bool show_cursors_; |
6f925ba9 | 467 | shared_ptr<CursorPair> cursors_; |
f76af637 | 468 | |
6f925ba9 | 469 | list< shared_ptr<Flag> > flags_; |
8914fe79 JH |
470 | char next_flag_text_; |
471 | ||
6f925ba9 | 472 | vector< shared_ptr<TriggerMarker> > trigger_markers_; |
1a2288a1 | 473 | |
8dbbc7f0 | 474 | QPoint hover_point_; |
32218d3e | 475 | |
8dbbc7f0 JH |
476 | unsigned int sticky_events_; |
477 | QTimer lazy_event_handler_; | |
925763b0 SA |
478 | |
479 | // This is true when the defaults couldn't be set due to insufficient info | |
e62bee73 | 480 | bool scroll_needs_defaults_; |
39ab01e7 SA |
481 | |
482 | // A nonzero value indicates the v offset to restore. See View::resizeEvent() | |
483 | int saved_v_offset_; | |
28ceff25 SA |
484 | |
485 | // These are used to determine whether the view was altered after acq started | |
486 | double scale_at_acq_start_; | |
487 | pv::util::Timestamp offset_at_acq_start_; | |
488 | ||
489 | // Used to suppress performing a "zoom to fit" when the session stops. This | |
490 | // is needed when the view's settings are restored before acquisition ends. | |
491 | // In that case we want to keep the restored settings, not have a "zoom to fit" | |
492 | // mess them up. | |
493 | bool suppress_zoom_to_fit_after_acq_; | |
adb4b10c JH |
494 | }; |
495 | ||
1573bf16 | 496 | } // namespace trace |
f4e57597 | 497 | } // namespace views |
cdf7bea7 JH |
498 | } // namespace pv |
499 | ||
f4e57597 | 500 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |