]>
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 <stdint.h> | |
24 | ||
25 | #include <list> | |
26 | #include <memory> | |
27 | #include <set> | |
28 | #include <unordered_map> | |
29 | #include <vector> | |
30 | ||
31 | #include <QAbstractScrollArea> | |
32 | #include <QSizeF> | |
33 | #include <QTimer> | |
34 | ||
35 | #include <pv/data/signaldata.hpp> | |
36 | #include <pv/views/viewbase.hpp> | |
37 | #include <pv/util.hpp> | |
38 | ||
39 | #include "cursorpair.hpp" | |
40 | #include "flag.hpp" | |
41 | #include "tracetreeitemowner.hpp" | |
42 | ||
43 | namespace sigrok { | |
44 | class ChannelGroup; | |
45 | } | |
46 | ||
47 | namespace pv { | |
48 | ||
49 | class Session; | |
50 | ||
51 | namespace views { | |
52 | ||
53 | namespace TraceView { | |
54 | ||
55 | class CursorHeader; | |
56 | class DecodeTrace; | |
57 | class Header; | |
58 | class Ruler; | |
59 | class Signal; | |
60 | class Trace; | |
61 | class Viewport; | |
62 | class TriggerMarker; | |
63 | ||
64 | class CustomAbstractScrollArea : public QAbstractScrollArea { | |
65 | Q_OBJECT | |
66 | ||
67 | public: | |
68 | CustomAbstractScrollArea(QWidget *parent = 0); | |
69 | void setViewportMargins(int left, int top, int right, int bottom); | |
70 | bool viewportEvent(QEvent *event); | |
71 | }; | |
72 | ||
73 | class View : public ViewBase, public TraceTreeItemOwner { | |
74 | Q_OBJECT | |
75 | ||
76 | private: | |
77 | enum StickyEvents { | |
78 | TraceTreeItemHExtentsChanged = 1, | |
79 | TraceTreeItemVExtentsChanged = 2 | |
80 | }; | |
81 | ||
82 | private: | |
83 | static const pv::util::Timestamp MaxScale; | |
84 | static const pv::util::Timestamp MinScale; | |
85 | ||
86 | static const int MaxScrollValue; | |
87 | static const int MaxViewAutoUpdateRate; | |
88 | ||
89 | static const int ScaleUnits[3]; | |
90 | ||
91 | public: | |
92 | explicit View(Session &session, bool is_main_view=false, QWidget *parent = 0); | |
93 | ||
94 | Session& session(); | |
95 | const Session& session() const; | |
96 | ||
97 | /** | |
98 | * Returns the signals contained in this view. | |
99 | */ | |
100 | std::unordered_set< std::shared_ptr<Signal> > signals() const; | |
101 | ||
102 | virtual void clear_signals(); | |
103 | ||
104 | virtual void add_signal(const std::shared_ptr<Signal> signal); | |
105 | ||
106 | #ifdef ENABLE_DECODE | |
107 | virtual void clear_decode_signals(); | |
108 | ||
109 | virtual void add_decode_signal(std::shared_ptr<data::SignalBase> signalbase); | |
110 | ||
111 | virtual void remove_decode_signal(std::shared_ptr<data::SignalBase> signalbase); | |
112 | #endif | |
113 | ||
114 | /** | |
115 | * Returns the view of the owner. | |
116 | */ | |
117 | virtual View* view(); | |
118 | ||
119 | /** | |
120 | * Returns the view of the owner. | |
121 | */ | |
122 | virtual const View* view() const; | |
123 | ||
124 | Viewport* viewport(); | |
125 | ||
126 | const Viewport* viewport() const; | |
127 | ||
128 | virtual void save_settings(QSettings &settings) const; | |
129 | ||
130 | virtual void restore_settings(QSettings &settings); | |
131 | ||
132 | /** | |
133 | * Gets a list of time markers. | |
134 | */ | |
135 | std::vector< std::shared_ptr<TimeItem> > time_items() const; | |
136 | ||
137 | /** | |
138 | * Returns the view time scale in seconds per pixel. | |
139 | */ | |
140 | double scale() const; | |
141 | ||
142 | /** | |
143 | * Returns the time offset of the left edge of the view in | |
144 | * seconds. | |
145 | */ | |
146 | const pv::util::Timestamp& offset() const; | |
147 | ||
148 | /** | |
149 | * Returns the vertical scroll offset. | |
150 | */ | |
151 | int owner_visual_v_offset() const; | |
152 | ||
153 | /** | |
154 | * Sets the visual v-offset. | |
155 | */ | |
156 | void set_v_offset(int offset); | |
157 | ||
158 | /** | |
159 | * Returns the SI prefix to apply to the graticule time markings. | |
160 | */ | |
161 | pv::util::SIPrefix tick_prefix() const; | |
162 | ||
163 | /** | |
164 | * Returns the number of fractional digits shown for the time markings. | |
165 | */ | |
166 | unsigned int tick_precision() const; | |
167 | ||
168 | /** | |
169 | * Returns period of the graticule time markings. | |
170 | */ | |
171 | const pv::util::Timestamp& tick_period() const; | |
172 | ||
173 | /** | |
174 | * Returns the unit of time currently used. | |
175 | */ | |
176 | util::TimeUnit time_unit() const; | |
177 | ||
178 | /** | |
179 | * Returns the number of nested parents that this row item owner has. | |
180 | */ | |
181 | unsigned int depth() const; | |
182 | ||
183 | void zoom(double steps); | |
184 | void zoom(double steps, int offset); | |
185 | ||
186 | void zoom_fit(bool gui_state); | |
187 | ||
188 | void zoom_one_to_one(); | |
189 | ||
190 | /** | |
191 | * Sets the scale and offset. | |
192 | * @param scale The new view scale in seconds per pixel. | |
193 | * @param offset The view time offset in seconds. | |
194 | */ | |
195 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); | |
196 | ||
197 | std::set< std::shared_ptr<pv::data::SignalData> > | |
198 | get_visible_data() const; | |
199 | ||
200 | std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; | |
201 | ||
202 | /** | |
203 | * Enables or disables sticky scrolling, i.e. the view always shows | |
204 | * the most recent samples when capturing data. | |
205 | */ | |
206 | void enable_sticky_scrolling(bool state); | |
207 | ||
208 | /** | |
209 | * Toggle sticky scrolling. | |
210 | */ | |
211 | void toggle_sticky_scrolling(void); | |
212 | ||
213 | /** | |
214 | * Enables or disables coloured trace backgrounds. If they're not | |
215 | * coloured then they will use alternating colors. | |
216 | */ | |
217 | void enable_coloured_bg(bool state); | |
218 | ||
219 | /** | |
220 | * Returns true if cursors are displayed. false otherwise. | |
221 | */ | |
222 | bool cursors_shown() const; | |
223 | ||
224 | /** | |
225 | * Shows or hides the cursors. | |
226 | */ | |
227 | void show_cursors(bool show = true); | |
228 | ||
229 | /** | |
230 | * Moves the cursors to a convenient position in the view. | |
231 | */ | |
232 | void centre_cursors(); | |
233 | ||
234 | /** | |
235 | * Returns a reference to the pair of cursors. | |
236 | */ | |
237 | std::shared_ptr<CursorPair> cursors() const; | |
238 | ||
239 | /** | |
240 | * Adds a new flag at a specified time. | |
241 | */ | |
242 | void add_flag(const pv::util::Timestamp& time); | |
243 | ||
244 | /** | |
245 | * Removes a flag from the list. | |
246 | */ | |
247 | void remove_flag(std::shared_ptr<Flag> flag); | |
248 | ||
249 | /** | |
250 | * Gets the list of flags. | |
251 | */ | |
252 | std::vector< std::shared_ptr<Flag> > flags() const; | |
253 | ||
254 | const QPoint& hover_point() const; | |
255 | ||
256 | void restack_all_trace_tree_items(); | |
257 | ||
258 | Q_SIGNALS: | |
259 | void hover_point_changed(); | |
260 | ||
261 | void selection_changed(); | |
262 | ||
263 | /// Emitted when the offset changed. | |
264 | void offset_changed(); | |
265 | ||
266 | /// Emitted when the scale changed. | |
267 | void scale_changed(); | |
268 | ||
269 | void sticky_scrolling_changed(bool state); | |
270 | ||
271 | void always_zoom_to_fit_changed(bool state); | |
272 | ||
273 | /// Emitted when the tick_prefix changed. | |
274 | void tick_prefix_changed(); | |
275 | ||
276 | /// Emitted when the tick_precision changed. | |
277 | void tick_precision_changed(); | |
278 | ||
279 | /// Emitted when the tick_period changed. | |
280 | void tick_period_changed(); | |
281 | ||
282 | /// Emitted when the time_unit changed. | |
283 | void time_unit_changed(); | |
284 | ||
285 | public Q_SLOTS: | |
286 | void trigger_event(util::Timestamp location); | |
287 | ||
288 | private: | |
289 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; | |
290 | ||
291 | /** | |
292 | * Simultaneously sets the zoom and offset. | |
293 | * @param scale The scale to set the view to in seconds per pixel. This | |
294 | * value is clamped between MinScale and MaxScale. | |
295 | * @param offset The offset of the left edge of the view in seconds. | |
296 | */ | |
297 | void set_zoom(double scale, int offset); | |
298 | ||
299 | /** | |
300 | * Find a tick spacing and number formatting that does not cause | |
301 | * the values to collide. | |
302 | */ | |
303 | void calculate_tick_spacing(); | |
304 | ||
305 | void update_scroll(); | |
306 | ||
307 | void reset_scroll(); | |
308 | ||
309 | void set_scroll_default(); | |
310 | ||
311 | void update_layout(); | |
312 | ||
313 | TraceTreeItemOwner* find_prevalent_trace_group( | |
314 | const std::shared_ptr<sigrok::ChannelGroup> &group, | |
315 | const std::unordered_map<std::shared_ptr<data::SignalBase>, | |
316 | std::shared_ptr<Signal> > &signal_map); | |
317 | ||
318 | static std::vector< std::shared_ptr<Trace> > | |
319 | extract_new_traces_for_channels( | |
320 | const std::vector< std::shared_ptr<sigrok::Channel> > &channels, | |
321 | const std::unordered_map<std::shared_ptr<data::SignalBase>, | |
322 | std::shared_ptr<Signal> > &signal_map, | |
323 | std::set< std::shared_ptr<Trace> > &add_list); | |
324 | ||
325 | void determine_time_unit(); | |
326 | ||
327 | bool eventFilter(QObject *object, QEvent *event); | |
328 | ||
329 | void resizeEvent(QResizeEvent *event); | |
330 | ||
331 | public: | |
332 | void row_item_appearance_changed(bool label, bool content); | |
333 | void time_item_appearance_changed(bool label, bool content); | |
334 | ||
335 | void extents_changed(bool horz, bool vert); | |
336 | ||
337 | private Q_SLOTS: | |
338 | ||
339 | void h_scroll_value_changed(int value); | |
340 | void v_scroll_value_changed(); | |
341 | ||
342 | void signals_changed(); | |
343 | void capture_state_updated(int state); | |
344 | void data_updated(); | |
345 | ||
346 | void perform_delayed_view_update(); | |
347 | ||
348 | void process_sticky_events(); | |
349 | ||
350 | void on_hover_point_changed(); | |
351 | ||
352 | /** | |
353 | * Sets the 'offset_' member and emits the 'offset_changed' | |
354 | * signal if needed. | |
355 | */ | |
356 | void set_offset(const pv::util::Timestamp& offset); | |
357 | ||
358 | /** | |
359 | * Sets the 'scale_' member and emits the 'scale_changed' | |
360 | * signal if needed. | |
361 | */ | |
362 | void set_scale(double scale); | |
363 | ||
364 | /** | |
365 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
366 | * signal if needed. | |
367 | */ | |
368 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
369 | ||
370 | /** | |
371 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
372 | * signal if needed. | |
373 | */ | |
374 | void set_tick_precision(unsigned tick_precision); | |
375 | ||
376 | /** | |
377 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
378 | * signal if needed. | |
379 | */ | |
380 | void set_tick_period(const pv::util::Timestamp& tick_period); | |
381 | ||
382 | /** | |
383 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
384 | * signal if needed. | |
385 | */ | |
386 | void set_time_unit(pv::util::TimeUnit time_unit); | |
387 | ||
388 | private: | |
389 | Viewport *viewport_; | |
390 | Ruler *ruler_; | |
391 | Header *header_; | |
392 | ||
393 | std::unordered_set< std::shared_ptr<Signal> > signals_; | |
394 | ||
395 | #ifdef ENABLE_DECODE | |
396 | std::vector< std::shared_ptr<DecodeTrace> > decode_traces_; | |
397 | #endif | |
398 | ||
399 | CustomAbstractScrollArea scrollarea_; | |
400 | ||
401 | /// The view time scale in seconds per pixel. | |
402 | double scale_; | |
403 | ||
404 | /// The view time offset in seconds. | |
405 | pv::util::Timestamp offset_; | |
406 | ||
407 | bool updating_scroll_; | |
408 | bool sticky_scrolling_; | |
409 | bool coloured_bg_; | |
410 | bool always_zoom_to_fit_; | |
411 | QTimer delayed_view_updater_; | |
412 | ||
413 | pv::util::Timestamp tick_period_; | |
414 | pv::util::SIPrefix tick_prefix_; | |
415 | unsigned int tick_precision_; | |
416 | util::TimeUnit time_unit_; | |
417 | ||
418 | bool show_cursors_; | |
419 | std::shared_ptr<CursorPair> cursors_; | |
420 | ||
421 | std::list< std::shared_ptr<Flag> > flags_; | |
422 | char next_flag_text_; | |
423 | ||
424 | std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_; | |
425 | ||
426 | QPoint hover_point_; | |
427 | ||
428 | unsigned int sticky_events_; | |
429 | QTimer lazy_event_handler_; | |
430 | ||
431 | // This is true when the defaults couldn't be set due to insufficient info | |
432 | bool scroll_needs_defaults_; | |
433 | ||
434 | // A nonzero value indicates the v offset to restore. See View::resizeEvent() | |
435 | int saved_v_offset_; | |
436 | ||
437 | bool size_finalized_; | |
438 | }; | |
439 | ||
440 | } // namespace TraceView | |
441 | } // namespace views | |
442 | } // namespace pv | |
443 | ||
444 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP |