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