]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
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, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP | |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP | |
22 | ||
23 | #include <cstdint> | |
24 | #include <list> | |
25 | #include <memory> | |
26 | #include <set> | |
27 | #include <unordered_map> | |
28 | #include <vector> | |
29 | ||
30 | #include <QAbstractScrollArea> | |
31 | #include <QShortcut> | |
32 | #include <QSizeF> | |
33 | #include <QSplitter> | |
34 | ||
35 | #include <pv/globalsettings.hpp> | |
36 | #include <pv/util.hpp> | |
37 | #include <pv/data/signaldata.hpp> | |
38 | #include <pv/views/viewbase.hpp> | |
39 | ||
40 | #include "cursorpair.hpp" | |
41 | #include "flag.hpp" | |
42 | #include "trace.hpp" | |
43 | #include "tracetreeitemowner.hpp" | |
44 | ||
45 | using std::list; | |
46 | using std::unordered_map; | |
47 | using std::unordered_set; | |
48 | using std::set; | |
49 | using std::shared_ptr; | |
50 | using std::vector; | |
51 | ||
52 | namespace sigrok { | |
53 | class ChannelGroup; | |
54 | } | |
55 | ||
56 | namespace pv { | |
57 | ||
58 | class Session; | |
59 | ||
60 | namespace data { | |
61 | class Logic; | |
62 | } | |
63 | ||
64 | namespace views { | |
65 | ||
66 | namespace trace { | |
67 | ||
68 | class DecodeTrace; | |
69 | class Header; | |
70 | class Ruler; | |
71 | class Signal; | |
72 | class Viewport; | |
73 | class TriggerMarker; | |
74 | ||
75 | class CustomScrollArea : public QAbstractScrollArea | |
76 | { | |
77 | Q_OBJECT | |
78 | ||
79 | public: | |
80 | CustomScrollArea(QWidget *parent = nullptr); | |
81 | bool viewportEvent(QEvent *event); | |
82 | }; | |
83 | ||
84 | class View : public ViewBase, public TraceTreeItemOwner, public GlobalSettingsInterface | |
85 | { | |
86 | Q_OBJECT | |
87 | ||
88 | private: | |
89 | enum StickyEvents { | |
90 | TraceTreeItemHExtentsChanged = 1, | |
91 | TraceTreeItemVExtentsChanged = 2 | |
92 | }; | |
93 | ||
94 | private: | |
95 | static const pv::util::Timestamp MaxScale; | |
96 | static const pv::util::Timestamp MinScale; | |
97 | ||
98 | static const int MaxScrollValue; | |
99 | ||
100 | static const int ScaleUnits[3]; | |
101 | ||
102 | public: | |
103 | explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr); | |
104 | ||
105 | ~View(); | |
106 | ||
107 | virtual ViewType get_type() const; | |
108 | ||
109 | /** | |
110 | * Resets the view to its default state after construction. It does however | |
111 | * not reset the signal bases or any other connections with the session. | |
112 | */ | |
113 | virtual void reset_view_state(); | |
114 | ||
115 | Session& session(); // This method is needed for TraceTreeItemOwner, not ViewBase | |
116 | const Session& session() const; // This method is needed for TraceTreeItemOwner, not ViewBase | |
117 | ||
118 | /** | |
119 | * Returns the signals contained in this view. | |
120 | */ | |
121 | unordered_set< shared_ptr<Signal> > signals() const; | |
122 | ||
123 | shared_ptr<Signal> get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const; | |
124 | ||
125 | virtual void clear_signals(); | |
126 | ||
127 | void add_signal(const shared_ptr<Signal> signal); | |
128 | ||
129 | #ifdef ENABLE_DECODE | |
130 | virtual void clear_decode_signals(); | |
131 | ||
132 | virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal); | |
133 | ||
134 | virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal); | |
135 | #endif | |
136 | ||
137 | shared_ptr<Signal> get_signal_under_mouse_cursor() const; | |
138 | ||
139 | /** | |
140 | * Returns the view of the owner. | |
141 | */ | |
142 | virtual View* view(); | |
143 | ||
144 | /** | |
145 | * Returns the view of the owner. | |
146 | */ | |
147 | virtual const View* view() const; | |
148 | ||
149 | Viewport* viewport(); | |
150 | const Viewport* viewport() const; | |
151 | ||
152 | QAbstractScrollArea* scrollarea() const; | |
153 | ||
154 | const Ruler* ruler() const; | |
155 | ||
156 | virtual void save_settings(QSettings &settings) const; | |
157 | ||
158 | virtual void restore_settings(QSettings &settings); | |
159 | ||
160 | /** | |
161 | * Gets a list of time markers. | |
162 | */ | |
163 | vector< shared_ptr<TimeItem> > time_items() const; | |
164 | ||
165 | /** | |
166 | * Returns the view time scale in seconds per pixel. | |
167 | */ | |
168 | double scale() const; | |
169 | ||
170 | /** | |
171 | * Returns the internal view version of the time offset of the left edge | |
172 | * of the view in seconds. | |
173 | */ | |
174 | const pv::util::Timestamp& offset() const; | |
175 | ||
176 | /** | |
177 | * Returns the ruler version of the time offset of the left edge | |
178 | * of the view in seconds. | |
179 | */ | |
180 | const pv::util::Timestamp& ruler_offset() const; | |
181 | ||
182 | void set_zero_position(const pv::util::Timestamp& position); | |
183 | ||
184 | void reset_zero_position(); | |
185 | ||
186 | pv::util::Timestamp zero_offset() const; | |
187 | ||
188 | /** | |
189 | * Returns the vertical scroll offset. | |
190 | */ | |
191 | int owner_visual_v_offset() const; | |
192 | ||
193 | /** | |
194 | * Sets the visual v-offset. | |
195 | */ | |
196 | void set_v_offset(int offset); | |
197 | ||
198 | /** | |
199 | * Sets the visual h-offset. | |
200 | */ | |
201 | void set_h_offset(int offset); | |
202 | ||
203 | /** | |
204 | * Gets the length of the horizontal scrollbar. | |
205 | */ | |
206 | int get_h_scrollbar_maximum() const; | |
207 | ||
208 | /** | |
209 | * Returns the SI prefix to apply to the graticule time markings. | |
210 | */ | |
211 | pv::util::SIPrefix tick_prefix() const; | |
212 | ||
213 | /** | |
214 | * Returns the number of fractional digits shown for the time markings. | |
215 | */ | |
216 | unsigned int tick_precision() const; | |
217 | ||
218 | /** | |
219 | * Returns period of the graticule time markings. | |
220 | */ | |
221 | const pv::util::Timestamp& tick_period() const; | |
222 | ||
223 | /** | |
224 | * Returns number of minor division ticks per time marking. | |
225 | */ | |
226 | unsigned int minor_tick_count() const; | |
227 | ||
228 | /** | |
229 | * Returns the unit of time currently used. | |
230 | */ | |
231 | util::TimeUnit time_unit() const; | |
232 | ||
233 | /** | |
234 | * Returns the number of nested parents that this row item owner has. | |
235 | */ | |
236 | unsigned int depth() const; | |
237 | ||
238 | /** | |
239 | * Returns the currently displayed segment, starting at 0. | |
240 | */ | |
241 | uint32_t current_segment() const; | |
242 | ||
243 | /** | |
244 | * Returns whether the currently shown segment can be influenced | |
245 | * (selected) or not. | |
246 | */ | |
247 | bool segment_is_selectable() const; | |
248 | ||
249 | Trace::SegmentDisplayMode segment_display_mode() const; | |
250 | void set_segment_display_mode(Trace::SegmentDisplayMode mode); | |
251 | ||
252 | void zoom(double steps); | |
253 | void zoom(double steps, int offset); | |
254 | ||
255 | void zoom_fit(bool gui_state); | |
256 | ||
257 | /** | |
258 | * Sets the scale and offset. | |
259 | * @param scale The new view scale in seconds per pixel. | |
260 | * @param offset The view time offset in seconds. | |
261 | */ | |
262 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); | |
263 | ||
264 | set< shared_ptr<pv::data::SignalData> > get_visible_data() const; | |
265 | ||
266 | pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; | |
267 | ||
268 | /** | |
269 | * Returns true if the trace background should be drawn with a colored background. | |
270 | */ | |
271 | bool colored_bg() const; | |
272 | ||
273 | /** | |
274 | * Returns true if cursors are displayed, false otherwise. | |
275 | */ | |
276 | bool cursors_shown() const; | |
277 | ||
278 | /** | |
279 | * Shows or hides the cursors. | |
280 | */ | |
281 | void show_cursors(bool show = true); | |
282 | ||
283 | /** | |
284 | * Sets the cursors to the given offsets. | |
285 | * You still have to call show_cursors() separately. | |
286 | */ | |
287 | void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second); | |
288 | ||
289 | /** | |
290 | * Moves the cursors to a convenient position in the view. | |
291 | * You still have to call show_cursors() separately. | |
292 | */ | |
293 | void center_cursors(); | |
294 | ||
295 | /** | |
296 | * Returns a reference to the pair of cursors. | |
297 | */ | |
298 | shared_ptr<CursorPair> cursors() const; | |
299 | ||
300 | /** | |
301 | * Adds a new flag at a specified time. | |
302 | */ | |
303 | shared_ptr<Flag> add_flag(const pv::util::Timestamp& time); | |
304 | ||
305 | /** | |
306 | * Removes a flag from the list. | |
307 | */ | |
308 | void remove_flag(shared_ptr<Flag> flag); | |
309 | ||
310 | /** | |
311 | * Gets the list of flags. | |
312 | */ | |
313 | vector< shared_ptr<Flag> > flags() const; | |
314 | ||
315 | const QPoint& hover_point() const; | |
316 | const QWidget* hover_widget() const; | |
317 | ||
318 | /** | |
319 | * Determines the closest level change (i.e. edge) to a given point, which | |
320 | * is useful for e.g. the "snap to edge" functionality. | |
321 | * | |
322 | * @param p The current position of the mouse cursor | |
323 | * @return The sample number of the nearest level change or -1 if none | |
324 | */ | |
325 | int64_t get_nearest_level_change(const QPoint &p); | |
326 | ||
327 | void restack_all_trace_tree_items(); | |
328 | ||
329 | int header_width() const; | |
330 | ||
331 | void on_setting_changed(const QString &key, const QVariant &value); | |
332 | ||
333 | Q_SIGNALS: | |
334 | void hover_point_changed(const QWidget* widget, const QPoint &hp); | |
335 | ||
336 | void selection_changed(); | |
337 | ||
338 | /// Emitted when the offset changed. | |
339 | void offset_changed(); | |
340 | ||
341 | /// Emitted when the scale changed. | |
342 | void scale_changed(); | |
343 | ||
344 | void sticky_scrolling_changed(bool state); | |
345 | ||
346 | void always_zoom_to_fit_changed(bool state); | |
347 | ||
348 | /// Emitted when the tick_prefix changed. | |
349 | void tick_prefix_changed(); | |
350 | ||
351 | /// Emitted when the tick_precision changed. | |
352 | void tick_precision_changed(); | |
353 | ||
354 | /// Emitted when the tick_period changed. | |
355 | void tick_period_changed(); | |
356 | ||
357 | /// Emitted when the time_unit changed. | |
358 | void time_unit_changed(); | |
359 | ||
360 | /// Emitted when the currently selected segment changed | |
361 | void segment_changed(int segment_id); | |
362 | ||
363 | /// Emitted when the multi-segment display mode changed | |
364 | /// @param mode is a value of Trace::SegmentDisplayMode | |
365 | void segment_display_mode_changed(int mode, bool segment_selectable); | |
366 | ||
367 | /// Emitted when the cursors are shown/hidden | |
368 | void cursor_state_changed(bool show); | |
369 | ||
370 | public Q_SLOTS: | |
371 | void trigger_event(int segment_id, util::Timestamp location); | |
372 | ||
373 | private: | |
374 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; | |
375 | ||
376 | /** | |
377 | * Simultaneously sets the zoom and offset. | |
378 | * @param scale The scale to set the view to in seconds per pixel. This | |
379 | * value is clamped between MinScale and MaxScale. | |
380 | * @param offset The offset of the left edge of the view in seconds. | |
381 | */ | |
382 | void set_zoom(double scale, int offset); | |
383 | ||
384 | /** | |
385 | * Find a tick spacing and number formatting that does not cause | |
386 | * the values to collide. | |
387 | */ | |
388 | void calculate_tick_spacing(); | |
389 | ||
390 | void adjust_top_margin(); | |
391 | ||
392 | void update_scroll(); | |
393 | ||
394 | void reset_scroll(); | |
395 | ||
396 | void set_scroll_default(); | |
397 | ||
398 | void determine_if_header_was_shrunk(); | |
399 | ||
400 | void resize_header_to_fit(); | |
401 | ||
402 | void update_layout(); | |
403 | ||
404 | TraceTreeItemOwner* find_prevalent_trace_group( | |
405 | const shared_ptr<sigrok::ChannelGroup> &group, | |
406 | const unordered_map<shared_ptr<data::SignalBase>, | |
407 | shared_ptr<Signal> > &signal_map); | |
408 | ||
409 | static vector< shared_ptr<Trace> > | |
410 | extract_new_traces_for_channels( | |
411 | const vector< shared_ptr<sigrok::Channel> > &channels, | |
412 | const unordered_map<shared_ptr<data::SignalBase>, | |
413 | shared_ptr<Signal> > &signal_map, | |
414 | set< shared_ptr<Trace> > &add_list); | |
415 | ||
416 | void determine_time_unit(); | |
417 | ||
418 | bool eventFilter(QObject *object, QEvent *event); | |
419 | ||
420 | virtual void contextMenuEvent(QContextMenuEvent *event); | |
421 | ||
422 | void resizeEvent(QResizeEvent *event); | |
423 | ||
424 | void update_hover_point(); | |
425 | ||
426 | public: | |
427 | void row_item_appearance_changed(bool label, bool content); | |
428 | void time_item_appearance_changed(bool label, bool content); | |
429 | ||
430 | void extents_changed(bool horz, bool vert); | |
431 | ||
432 | private Q_SLOTS: | |
433 | void on_signal_name_changed(); | |
434 | void on_splitter_moved(); | |
435 | ||
436 | void on_zoom_in_shortcut_triggered(); | |
437 | void on_zoom_out_shortcut_triggered(); | |
438 | void on_scroll_to_start_shortcut_triggered(); | |
439 | void on_scroll_to_end_shortcut_triggered(); | |
440 | ||
441 | void h_scroll_value_changed(int value); | |
442 | void v_scroll_value_changed(); | |
443 | ||
444 | void on_grab_ruler(int ruler_id); | |
445 | ||
446 | void signals_changed(); | |
447 | void capture_state_updated(int state); | |
448 | ||
449 | void on_new_segment(int new_segment_id); | |
450 | void on_segment_completed(int new_segment_id); | |
451 | void on_segment_changed(int segment); | |
452 | ||
453 | void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value); | |
454 | ||
455 | virtual void perform_delayed_view_update(); | |
456 | ||
457 | void process_sticky_events(); | |
458 | ||
459 | /** | |
460 | * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed' | |
461 | * signal if needed. | |
462 | */ | |
463 | void set_offset(const pv::util::Timestamp& offset, bool force_update = false); | |
464 | ||
465 | /** | |
466 | * Sets the 'scale_' member and emits the 'scale_changed' | |
467 | * signal if needed. | |
468 | */ | |
469 | void set_scale(double scale); | |
470 | ||
471 | /** | |
472 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
473 | * signal if needed. | |
474 | */ | |
475 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
476 | ||
477 | /** | |
478 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
479 | * signal if needed. | |
480 | */ | |
481 | void set_tick_precision(unsigned tick_precision); | |
482 | ||
483 | /** | |
484 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
485 | * signal if needed. | |
486 | */ | |
487 | void set_tick_period(const pv::util::Timestamp& tick_period); | |
488 | ||
489 | /** | |
490 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
491 | * signal if needed. | |
492 | */ | |
493 | void set_time_unit(pv::util::TimeUnit time_unit); | |
494 | ||
495 | /** | |
496 | * Sets the current segment with the first segment starting at 0. | |
497 | */ | |
498 | void set_current_segment(uint32_t segment_id); | |
499 | ||
500 | private: | |
501 | CustomScrollArea *scrollarea_; | |
502 | Viewport *viewport_; | |
503 | Ruler *ruler_; | |
504 | Header *header_; | |
505 | QSplitter *splitter_; | |
506 | ||
507 | QShortcut *zoom_in_shortcut_, *zoom_in_shortcut_2_; | |
508 | QShortcut *zoom_out_shortcut_, *zoom_out_shortcut_2_; | |
509 | QShortcut *home_shortcut_, *end_shortcut_; | |
510 | QShortcut *grab_ruler_left_shortcut_, *grab_ruler_right_shortcut_; | |
511 | QShortcut *cancel_grab_shortcut_; | |
512 | ||
513 | unordered_set< shared_ptr<Signal> > signals_; | |
514 | ||
515 | #ifdef ENABLE_DECODE | |
516 | vector< shared_ptr<DecodeTrace> > decode_traces_; | |
517 | #endif | |
518 | ||
519 | Trace::SegmentDisplayMode segment_display_mode_; | |
520 | ||
521 | /// Signals whether the user can change the currently shown segment. | |
522 | bool segment_selectable_; | |
523 | ||
524 | /// The view time scale in seconds per pixel. | |
525 | double scale_; | |
526 | ||
527 | /// The internal view version of the time offset in seconds. | |
528 | pv::util::Timestamp offset_; | |
529 | /// The ruler version of the time offset in seconds. | |
530 | pv::util::Timestamp ruler_offset_; | |
531 | /// The offset of the zero point in seconds. | |
532 | pv::util::Timestamp zero_offset_; | |
533 | /// Shows whether the user set a custom zero offset that we should keep | |
534 | bool custom_zero_offset_set_; | |
535 | ||
536 | bool updating_scroll_; | |
537 | bool settings_restored_; | |
538 | bool header_was_shrunk_; | |
539 | ||
540 | bool sticky_scrolling_; | |
541 | bool colored_bg_; | |
542 | bool always_zoom_to_fit_; | |
543 | ||
544 | pv::util::Timestamp tick_period_; | |
545 | pv::util::SIPrefix tick_prefix_; | |
546 | unsigned int minor_tick_count_; | |
547 | unsigned int tick_precision_; | |
548 | util::TimeUnit time_unit_; | |
549 | ||
550 | bool show_cursors_; | |
551 | shared_ptr<CursorPair> cursors_; | |
552 | ||
553 | list< shared_ptr<Flag> > flags_; | |
554 | char next_flag_text_; | |
555 | ||
556 | vector< shared_ptr<TriggerMarker> > trigger_markers_; | |
557 | ||
558 | QWidget* hover_widget_; | |
559 | TimeMarker* grabbed_widget_; | |
560 | QPoint hover_point_; | |
561 | shared_ptr<Signal> signal_under_mouse_cursor_; | |
562 | uint16_t snap_distance_; | |
563 | ||
564 | unsigned int sticky_events_; | |
565 | QTimer lazy_event_handler_; | |
566 | ||
567 | // This is true when the defaults couldn't be set due to insufficient info | |
568 | bool scroll_needs_defaults_; | |
569 | ||
570 | // A nonzero value indicates the v offset to restore. See View::resizeEvent() | |
571 | int saved_v_offset_; | |
572 | ||
573 | // These are used to determine whether the view was altered after acq started | |
574 | double scale_at_acq_start_; | |
575 | pv::util::Timestamp offset_at_acq_start_; | |
576 | ||
577 | // Used to suppress performing a "zoom to fit" when the session stops. This | |
578 | // is needed when the view's settings are restored before acquisition ends. | |
579 | // In that case we want to keep the restored settings, not have a "zoom to fit" | |
580 | // mess them up. | |
581 | bool suppress_zoom_to_fit_after_acq_; | |
582 | }; | |
583 | ||
584 | } // namespace trace | |
585 | } // namespace views | |
586 | } // namespace pv | |
587 | ||
588 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |