2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
27 #include <unordered_map>
30 #include <QAbstractScrollArea>
34 #include <pv/data/signaldata.hpp>
35 #include <pv/util.hpp>
36 #include <pv/views/viewbase.hpp>
38 #include "cursorpair.hpp"
41 #include "tracetreeitemowner.hpp"
44 using std::unordered_map;
45 using std::unordered_set;
47 using std::shared_ptr;
75 class CustomScrollArea : public QAbstractScrollArea
80 CustomScrollArea(QWidget *parent = nullptr);
81 bool viewportEvent(QEvent *event);
84 class View : public ViewBase, public TraceTreeItemOwner
90 TraceTreeItemHExtentsChanged = 1,
91 TraceTreeItemVExtentsChanged = 2
95 static const pv::util::Timestamp MaxScale;
96 static const pv::util::Timestamp MinScale;
98 static const int MaxScrollValue;
100 static const int ScaleUnits[3];
103 explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
106 const Session& session() const;
109 * Returns the signals contained in this view.
111 unordered_set< shared_ptr<Signal> > signals() const;
113 virtual void clear_signals();
115 void add_signal(const shared_ptr<Signal> signal);
118 virtual void clear_decode_signals();
120 virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
122 virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
126 * Returns the view of the owner.
128 virtual View* view();
131 * Returns the view of the owner.
133 virtual const View* view() const;
135 Viewport* viewport();
137 const Viewport* viewport() const;
139 virtual void save_settings(QSettings &settings) const;
141 virtual void restore_settings(QSettings &settings);
144 * Gets a list of time markers.
146 vector< shared_ptr<TimeItem> > time_items() const;
149 * Returns the view time scale in seconds per pixel.
151 double scale() const;
154 * Returns the internal view version of the time offset of the left edge
155 * of the view in seconds.
157 const pv::util::Timestamp& offset() const;
160 * Returns the ruler version of the time offset of the left edge
161 * of the view in seconds.
163 const pv::util::Timestamp& ruler_offset() const;
166 * Returns the vertical scroll offset.
168 int owner_visual_v_offset() const;
171 * Sets the visual v-offset.
173 void set_v_offset(int offset);
176 * Returns the SI prefix to apply to the graticule time markings.
178 pv::util::SIPrefix tick_prefix() const;
181 * Returns the number of fractional digits shown for the time markings.
183 unsigned int tick_precision() const;
186 * Returns period of the graticule time markings.
188 const pv::util::Timestamp& tick_period() const;
191 * Returns the unit of time currently used.
193 util::TimeUnit time_unit() const;
196 * Returns the number of nested parents that this row item owner has.
198 unsigned int depth() const;
201 * Returns the currently displayed segment, starting at 0.
203 uint32_t current_segment() const;
206 * Returns whether the currently shown segment can be influenced
209 bool segment_is_selectable() const;
211 Trace::SegmentDisplayMode segment_display_mode() const;
212 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
214 void zoom(double steps);
215 void zoom(double steps, int offset);
217 void zoom_fit(bool gui_state);
219 void zoom_one_to_one();
222 * Sets the scale and offset.
223 * @param scale The new view scale in seconds per pixel.
224 * @param offset The view time offset in seconds.
226 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
228 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
230 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
233 * Enables or disables coloured trace backgrounds. If they're not
234 * coloured then they will use alternating colors.
236 void enable_coloured_bg(bool state);
239 * Returns true if the trace background should be drawn with a coloured background.
241 bool coloured_bg() const;
244 * Enable or disable showing sampling points.
246 void enable_show_sampling_points(bool state);
249 * Enable or disable showing the analog minor grid.
251 void enable_show_analog_minor_grid(bool state);
254 * Returns true if cursors are displayed. false otherwise.
256 bool cursors_shown() const;
259 * Shows or hides the cursors.
261 void show_cursors(bool show = true);
264 * Moves the cursors to a convenient position in the view.
266 void centre_cursors();
269 * Returns a reference to the pair of cursors.
271 shared_ptr<CursorPair> cursors() const;
274 * Adds a new flag at a specified time.
276 void add_flag(const pv::util::Timestamp& time);
279 * Removes a flag from the list.
281 void remove_flag(shared_ptr<Flag> flag);
284 * Gets the list of flags.
286 vector< shared_ptr<Flag> > flags() const;
288 const QPoint& hover_point() const;
290 void restack_all_trace_tree_items();
293 void hover_point_changed(const QPoint &hp);
295 void selection_changed();
297 /// Emitted when the offset changed.
298 void offset_changed();
300 /// Emitted when the scale changed.
301 void scale_changed();
303 void sticky_scrolling_changed(bool state);
305 void always_zoom_to_fit_changed(bool state);
307 /// Emitted when the tick_prefix changed.
308 void tick_prefix_changed();
310 /// Emitted when the tick_precision changed.
311 void tick_precision_changed();
313 /// Emitted when the tick_period changed.
314 void tick_period_changed();
316 /// Emitted when the time_unit changed.
317 void time_unit_changed();
319 /// Emitted when the currently selected segment changed
320 void segment_changed(int segment_id);
322 /// Emitted when the multi-segment display mode changed
323 /// @param mode is a value of Trace::SegmentDisplayMode
324 void segment_display_mode_changed(int mode, bool segment_selectable);
327 void trigger_event(util::Timestamp location);
330 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
333 * Simultaneously sets the zoom and offset.
334 * @param scale The scale to set the view to in seconds per pixel. This
335 * value is clamped between MinScale and MaxScale.
336 * @param offset The offset of the left edge of the view in seconds.
338 void set_zoom(double scale, int offset);
341 * Find a tick spacing and number formatting that does not cause
342 * the values to collide.
344 void calculate_tick_spacing();
346 void adjust_top_margin();
348 void update_scroll();
352 void set_scroll_default();
354 void determine_if_header_was_shrunk();
356 void resize_header_to_fit();
358 void update_layout();
360 TraceTreeItemOwner* find_prevalent_trace_group(
361 const shared_ptr<sigrok::ChannelGroup> &group,
362 const unordered_map<shared_ptr<data::SignalBase>,
363 shared_ptr<Signal> > &signal_map);
365 static vector< shared_ptr<Trace> >
366 extract_new_traces_for_channels(
367 const vector< shared_ptr<sigrok::Channel> > &channels,
368 const unordered_map<shared_ptr<data::SignalBase>,
369 shared_ptr<Signal> > &signal_map,
370 set< shared_ptr<Trace> > &add_list);
372 void determine_time_unit();
374 bool eventFilter(QObject *object, QEvent *event);
376 void resizeEvent(QResizeEvent *event);
378 void update_hover_point();
381 void row_item_appearance_changed(bool label, bool content);
382 void time_item_appearance_changed(bool label, bool content);
384 void extents_changed(bool horz, bool vert);
388 void on_signal_name_changed();
389 void on_splitter_moved();
391 void h_scroll_value_changed(int value);
392 void v_scroll_value_changed();
394 void signals_changed();
395 void capture_state_updated(int state);
397 void on_new_segment(int new_segment_id);
398 void on_segment_completed(int new_segment_id);
399 void on_segment_changed(int segment);
401 virtual void perform_delayed_view_update();
403 void process_sticky_events();
406 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
409 void set_offset(const pv::util::Timestamp& offset);
412 * Sets the 'scale_' member and emits the 'scale_changed'
415 void set_scale(double scale);
418 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
421 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
424 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
427 void set_tick_precision(unsigned tick_precision);
430 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
433 void set_tick_period(const pv::util::Timestamp& tick_period);
436 * Sets the 'time_unit' member and emits the 'time_unit_changed'
439 void set_time_unit(pv::util::TimeUnit time_unit);
442 * Sets the current segment with the first segment starting at 0.
444 void set_current_segment(uint32_t segment_id);
447 CustomScrollArea *scrollarea_;
451 QSplitter *splitter_;
453 unordered_set< shared_ptr<Signal> > signals_;
456 vector< shared_ptr<DecodeTrace> > decode_traces_;
459 Trace::SegmentDisplayMode segment_display_mode_;
461 /// Signals whether the user can change the currently shown segment.
462 bool segment_selectable_;
464 /// The view time scale in seconds per pixel.
467 /// The internal view version of the time offset in seconds.
468 pv::util::Timestamp offset_;
469 /// The ruler version of the time offset in seconds.
470 pv::util::Timestamp ruler_offset_;
472 bool updating_scroll_;
473 bool settings_restored_;
474 bool header_was_shrunk_;
476 bool sticky_scrolling_;
478 bool always_zoom_to_fit_;
480 pv::util::Timestamp tick_period_;
481 pv::util::SIPrefix tick_prefix_;
482 unsigned int tick_precision_;
483 util::TimeUnit time_unit_;
486 shared_ptr<CursorPair> cursors_;
488 list< shared_ptr<Flag> > flags_;
489 char next_flag_text_;
491 vector< shared_ptr<TriggerMarker> > trigger_markers_;
495 unsigned int sticky_events_;
496 QTimer lazy_event_handler_;
498 // This is true when the defaults couldn't be set due to insufficient info
499 bool scroll_needs_defaults_;
501 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
504 // These are used to determine whether the view was altered after acq started
505 double scale_at_acq_start_;
506 pv::util::Timestamp offset_at_acq_start_;
508 // Used to suppress performing a "zoom to fit" when the session stops. This
509 // is needed when the view's settings are restored before acquisition ends.
510 // In that case we want to keep the restored settings, not have a "zoom to fit"
512 bool suppress_zoom_to_fit_after_acq_;
519 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP