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