]>
Commit | Line | Data |
---|---|---|
adb4b10c | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
adb4b10c JH |
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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
7a01bd36 JH |
21 | #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP |
22 | #define PULSEVIEW_PV_VIEW_VIEW_HPP | |
adb4b10c JH |
23 | |
24 | #include <stdint.h> | |
25 | ||
8914fe79 | 26 | #include <list> |
f9abf97e | 27 | #include <memory> |
1bc6525b | 28 | #include <set> |
448a72cf | 29 | #include <unordered_map> |
38eeddea JH |
30 | #include <vector> |
31 | ||
adb4b10c | 32 | #include <QAbstractScrollArea> |
2e04f9bd | 33 | #include <QSizeF> |
32218d3e | 34 | #include <QTimer> |
adb4b10c | 35 | |
2acdb232 | 36 | #include <pv/data/signaldata.hpp> |
ef454ad5 | 37 | #include <pv/util.hpp> |
1bc6525b | 38 | |
2acdb232 | 39 | #include "cursorpair.hpp" |
8914fe79 | 40 | #include "flag.hpp" |
af503b10 | 41 | #include "tracetreeitemowner.hpp" |
f76af637 | 42 | |
cf124e47 JH |
43 | namespace sigrok { |
44 | class ChannelGroup; | |
45 | } | |
46 | ||
51e77110 JH |
47 | namespace pv { |
48 | ||
2b81ae46 | 49 | class Session; |
adb4b10c | 50 | |
cdf7bea7 JH |
51 | namespace view { |
52 | ||
84a0d458 | 53 | class CursorHeader; |
1d8dca91 | 54 | class Header; |
ccdd3ef5 | 55 | class Ruler; |
47e9e7bb | 56 | class Signal; |
cf124e47 | 57 | class Trace; |
cdf7bea7 | 58 | class Viewport; |
1a2288a1 | 59 | class TriggerMarker; |
cdf7bea7 | 60 | |
af503b10 | 61 | class View : public QAbstractScrollArea, public TraceTreeItemOwner { |
adb4b10c JH |
62 | Q_OBJECT |
63 | ||
32218d3e JH |
64 | private: |
65 | enum StickyEvents { | |
af503b10 JH |
66 | TraceTreeItemHExtentsChanged = 1, |
67 | TraceTreeItemVExtentsChanged = 2 | |
32218d3e JH |
68 | }; |
69 | ||
adb4b10c | 70 | private: |
60d9b99a JS |
71 | static const pv::util::Timestamp MaxScale; |
72 | static const pv::util::Timestamp MinScale; | |
adb4b10c | 73 | |
f25770e2 | 74 | static const int MaxScrollValue; |
c7b03d9d | 75 | static const int MaxViewAutoUpdateRate; |
f25770e2 | 76 | |
361c560e JH |
77 | static const int ScaleUnits[3]; |
78 | ||
adb4b10c | 79 | public: |
2b81ae46 | 80 | explicit View(Session &session, QWidget *parent = 0); |
adb4b10c | 81 | |
2b81ae46 JH |
82 | Session& session(); |
83 | const Session& session() const; | |
1d19ef83 | 84 | |
47e9e7bb SA |
85 | /** |
86 | * Returns the signals contained in this view. | |
87 | */ | |
88 | std::unordered_set< std::shared_ptr<view::Signal> > signals() const; | |
89 | ||
90 | void clear_signals(); | |
91 | ||
92 | void add_signal(const std::shared_ptr<view::Signal> signal); | |
93 | ||
eae6e30a JH |
94 | /** |
95 | * Returns the view of the owner. | |
96 | */ | |
97 | virtual pv::view::View* view(); | |
98 | ||
99 | /** | |
100 | * Returns the view of the owner. | |
101 | */ | |
102 | virtual const pv::view::View* view() const; | |
103 | ||
2ae445ba SA |
104 | Viewport* viewport(); |
105 | ||
106 | const Viewport* viewport() const; | |
107 | ||
2496bf45 JH |
108 | /** |
109 | * Gets a list of time markers. | |
110 | */ | |
111 | std::vector< std::shared_ptr<TimeItem> > time_items() const; | |
112 | ||
e2f5223b JH |
113 | /** |
114 | * Returns the view time scale in seconds per pixel. | |
115 | */ | |
adb4b10c | 116 | double scale() const; |
e2f5223b JH |
117 | |
118 | /** | |
119 | * Returns the time offset of the left edge of the view in | |
120 | * seconds. | |
121 | */ | |
60d9b99a | 122 | const pv::util::Timestamp& offset() const; |
f8400017 JH |
123 | |
124 | /** | |
125 | * Returns the vertical scroll offset. | |
126 | */ | |
7ff0145f | 127 | int owner_visual_v_offset() const; |
adb4b10c | 128 | |
4d476647 JH |
129 | /** |
130 | * Sets the visual v-offset. | |
131 | */ | |
132 | void set_v_offset(int offset); | |
133 | ||
361c560e JH |
134 | /** |
135 | * Returns the SI prefix to apply to the graticule time markings. | |
136 | */ | |
d001f416 | 137 | pv::util::SIPrefix tick_prefix() const; |
361c560e | 138 | |
d40f4db7 SA |
139 | /** |
140 | * Returns the number of fractional digits shown for the time markings. | |
141 | */ | |
142 | unsigned int tick_precision() const; | |
143 | ||
361c560e JH |
144 | /** |
145 | * Returns period of the graticule time markings. | |
146 | */ | |
c677193d | 147 | const pv::util::Timestamp& tick_period() const; |
361c560e | 148 | |
ef454ad5 SA |
149 | /** |
150 | * Returns the unit of time currently used. | |
151 | */ | |
152 | util::TimeUnit time_unit() const; | |
153 | ||
3e769a37 JH |
154 | /** |
155 | * Returns the number of nested parents that this row item owner has. | |
156 | */ | |
157 | unsigned int depth() const; | |
158 | ||
adb4b10c | 159 | void zoom(double steps); |
17c0f398 | 160 | void zoom(double steps, int offset); |
adb4b10c | 161 | |
ce11b2ea | 162 | void zoom_fit(bool gui_state); |
ca46b534 | 163 | |
d1e7d82c JH |
164 | void zoom_one_to_one(); |
165 | ||
e2f5223b JH |
166 | /** |
167 | * Sets the scale and offset. | |
168 | * @param scale The new view scale in seconds per pixel. | |
169 | * @param offset The view time offset in seconds. | |
170 | */ | |
60d9b99a | 171 | void set_scale_offset(double scale, const pv::util::Timestamp& offset); |
adb4b10c | 172 | |
f9abf97e | 173 | std::set< std::shared_ptr<pv::data::SignalData> > |
1bc6525b JH |
174 | get_visible_data() const; |
175 | ||
60d9b99a | 176 | std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const; |
1bc6525b | 177 | |
c7b03d9d SA |
178 | /** |
179 | * Enables or disables sticky scrolling, i.e. the view always shows | |
180 | * the most recent samples when capturing data. | |
181 | */ | |
182 | void enable_sticky_scrolling(bool state); | |
183 | ||
574c568d SA |
184 | /** |
185 | * Enables or disables coloured trace backgrounds. If they're not | |
186 | * coloured then they will use alternating colors. | |
187 | */ | |
188 | void enable_coloured_bg(bool state); | |
189 | ||
f76af637 JH |
190 | /** |
191 | * Returns true if cursors are displayed. false otherwise. | |
192 | */ | |
193 | bool cursors_shown() const; | |
194 | ||
195 | /** | |
196 | * Shows or hides the cursors. | |
197 | */ | |
198 | void show_cursors(bool show = true); | |
199 | ||
b4d91e56 JH |
200 | /** |
201 | * Moves the cursors to a convenient position in the view. | |
202 | */ | |
203 | void centre_cursors(); | |
204 | ||
f76af637 JH |
205 | /** |
206 | * Returns a reference to the pair of cursors. | |
207 | */ | |
5c5ce757 | 208 | std::shared_ptr<CursorPair> cursors() const; |
58864c5c | 209 | |
8914fe79 JH |
210 | /** |
211 | * Adds a new flag at a specified time. | |
212 | */ | |
60d9b99a | 213 | void add_flag(const pv::util::Timestamp& time); |
8914fe79 JH |
214 | |
215 | /** | |
216 | * Removes a flag from the list. | |
217 | */ | |
218 | void remove_flag(std::shared_ptr<Flag> flag); | |
219 | ||
220 | /** | |
221 | * Gets the list of flags. | |
222 | */ | |
223 | std::vector< std::shared_ptr<Flag> > flags() const; | |
224 | ||
cbd80f64 JH |
225 | const QPoint& hover_point() const; |
226 | ||
af503b10 | 227 | void restack_all_trace_tree_items(); |
9cef9567 | 228 | |
e9213170 | 229 | Q_SIGNALS: |
cbd80f64 JH |
230 | void hover_point_changed(); |
231 | ||
8b454527 JH |
232 | void selection_changed(); |
233 | ||
4b0af0b6 JS |
234 | /// Emitted when the offset changed. |
235 | void offset_changed(); | |
236 | ||
237 | /// Emitted when the scale changed. | |
238 | void scale_changed(); | |
e0fc5810 | 239 | |
c7b03d9d SA |
240 | void sticky_scrolling_changed(bool state); |
241 | ||
ce11b2ea SA |
242 | void always_zoom_to_fit_changed(bool state); |
243 | ||
4b0af0b6 JS |
244 | /// Emitted when the tick_prefix changed. |
245 | void tick_prefix_changed(); | |
246 | ||
247 | /// Emitted when the tick_precision changed. | |
248 | void tick_precision_changed(); | |
249 | ||
250 | /// Emitted when the tick_period changed. | |
251 | void tick_period_changed(); | |
252 | ||
253 | /// Emitted when the time_unit changed. | |
254 | void time_unit_changed(); | |
255 | ||
48257a69 SA |
256 | public Q_SLOTS: |
257 | void trigger_event(util::Timestamp location); | |
258 | ||
adb4b10c | 259 | private: |
60d9b99a | 260 | void get_scroll_layout(double &length, pv::util::Timestamp &offset) const; |
3925091a JH |
261 | |
262 | /** | |
263 | * Simultaneously sets the zoom and offset. | |
264 | * @param scale The scale to set the view to in seconds per pixel. This | |
265 | * value is clamped between MinScale and MaxScale. | |
266 | * @param offset The offset of the left edge of the view in seconds. | |
267 | */ | |
d1e7d82c JH |
268 | void set_zoom(double scale, int offset); |
269 | ||
361c560e JH |
270 | /** |
271 | * Find a tick spacing and number formatting that does not cause | |
272 | * the values to collide. | |
273 | */ | |
274 | void calculate_tick_spacing(); | |
275 | ||
adb4b10c JH |
276 | void update_scroll(); |
277 | ||
925763b0 SA |
278 | void reset_scroll(); |
279 | ||
280 | void set_scroll_default(); | |
281 | ||
d7c0ca4a JH |
282 | void update_layout(); |
283 | ||
af503b10 | 284 | TraceTreeItemOwner* find_prevalent_trace_group( |
cf124e47 | 285 | const std::shared_ptr<sigrok::ChannelGroup> &group, |
bf0edd2b | 286 | const std::unordered_map<std::shared_ptr<data::SignalBase>, |
cf124e47 JH |
287 | std::shared_ptr<Signal> > &signal_map); |
288 | ||
289 | static std::vector< std::shared_ptr<Trace> > | |
290 | extract_new_traces_for_channels( | |
448a72cf | 291 | const std::vector< std::shared_ptr<sigrok::Channel> > &channels, |
bf0edd2b | 292 | const std::unordered_map<std::shared_ptr<data::SignalBase>, |
448a72cf | 293 | std::shared_ptr<Signal> > &signal_map, |
cf124e47 | 294 | std::set< std::shared_ptr<Trace> > &add_list); |
448a72cf | 295 | |
ef454ad5 SA |
296 | void determine_time_unit(); |
297 | ||
cbd80f64 JH |
298 | bool eventFilter(QObject *object, QEvent *event); |
299 | ||
d9ea9628 | 300 | bool viewportEvent(QEvent *event); |
adb4b10c | 301 | |
d9ea9628 | 302 | void resizeEvent(QResizeEvent *event); |
adb4b10c | 303 | |
32218d3e | 304 | public: |
6e2c3c85 | 305 | void row_item_appearance_changed(bool label, bool content); |
98cfe4e8 | 306 | void time_item_appearance_changed(bool label, bool content); |
32218d3e JH |
307 | |
308 | void extents_changed(bool horz, bool vert); | |
309 | ||
e9213170 | 310 | private Q_SLOTS: |
cbd80f64 | 311 | |
b16907d3 | 312 | void h_scroll_value_changed(int value); |
f8400017 | 313 | void v_scroll_value_changed(); |
adb4b10c | 314 | |
69dd2b03 | 315 | void signals_changed(); |
7ee199a7 | 316 | void capture_state_updated(int state); |
adb4b10c JH |
317 | void data_updated(); |
318 | ||
c7b03d9d SA |
319 | void perform_delayed_view_update(); |
320 | ||
32218d3e | 321 | void process_sticky_events(); |
d7c0ca4a | 322 | |
33c62f44 JH |
323 | void on_hover_point_changed(); |
324 | ||
4b0af0b6 JS |
325 | /** |
326 | * Sets the 'offset_' member and emits the 'offset_changed' | |
327 | * signal if needed. | |
328 | */ | |
329 | void set_offset(const pv::util::Timestamp& offset); | |
330 | ||
331 | /** | |
332 | * Sets the 'scale_' member and emits the 'scale_changed' | |
333 | * signal if needed. | |
334 | */ | |
335 | void set_scale(double scale); | |
336 | ||
337 | /** | |
338 | * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed' | |
339 | * signal if needed. | |
340 | */ | |
341 | void set_tick_prefix(pv::util::SIPrefix tick_prefix); | |
342 | ||
343 | /** | |
344 | * Sets the 'tick_precision_' member and emits the 'tick_precision_changed' | |
345 | * signal if needed. | |
346 | */ | |
347 | void set_tick_precision(unsigned tick_precision); | |
348 | ||
349 | /** | |
350 | * Sets the 'tick_period_' member and emits the 'tick_period_changed' | |
351 | * signal if needed. | |
352 | */ | |
c677193d | 353 | void set_tick_period(const pv::util::Timestamp& tick_period); |
4b0af0b6 JS |
354 | |
355 | /** | |
356 | * Sets the 'time_unit' member and emits the 'time_unit_changed' | |
357 | * signal if needed. | |
358 | */ | |
359 | void set_time_unit(pv::util::TimeUnit time_unit); | |
360 | ||
adb4b10c | 361 | private: |
2b81ae46 | 362 | Session &session_; |
adb4b10c | 363 | |
8dbbc7f0 JH |
364 | Viewport *viewport_; |
365 | Ruler *ruler_; | |
8dbbc7f0 | 366 | Header *header_; |
adb4b10c | 367 | |
47e9e7bb SA |
368 | std::unordered_set< std::shared_ptr<view::Signal> > signals_; |
369 | ||
e2f5223b | 370 | /// The view time scale in seconds per pixel. |
8dbbc7f0 | 371 | double scale_; |
e2f5223b JH |
372 | |
373 | /// The view time offset in seconds. | |
60d9b99a | 374 | pv::util::Timestamp offset_; |
adb4b10c | 375 | |
8dbbc7f0 | 376 | bool updating_scroll_; |
c7b03d9d | 377 | bool sticky_scrolling_; |
ce11b2ea | 378 | bool always_zoom_to_fit_; |
c7b03d9d | 379 | QTimer delayed_view_updater_; |
cbd80f64 | 380 | |
c677193d | 381 | pv::util::Timestamp tick_period_; |
d001f416 | 382 | pv::util::SIPrefix tick_prefix_; |
d40f4db7 | 383 | unsigned int tick_precision_; |
ef454ad5 | 384 | util::TimeUnit time_unit_; |
361c560e | 385 | |
8dbbc7f0 | 386 | bool show_cursors_; |
5c5ce757 | 387 | std::shared_ptr<CursorPair> cursors_; |
f76af637 | 388 | |
8914fe79 JH |
389 | std::list< std::shared_ptr<Flag> > flags_; |
390 | char next_flag_text_; | |
391 | ||
92ff2b60 | 392 | std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_; |
1a2288a1 | 393 | |
8dbbc7f0 | 394 | QPoint hover_point_; |
32218d3e | 395 | |
8dbbc7f0 JH |
396 | unsigned int sticky_events_; |
397 | QTimer lazy_event_handler_; | |
925763b0 SA |
398 | |
399 | // This is true when the defaults couldn't be set due to insufficient info | |
400 | bool scroll_needs_defaults; | |
adb4b10c JH |
401 | }; |
402 | ||
cdf7bea7 JH |
403 | } // namespace view |
404 | } // namespace pv | |
405 | ||
7a01bd36 | 406 | #endif // PULSEVIEW_PV_VIEW_VIEW_HPP |