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