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>
35 #include <pv/globalsettings.hpp>
36 #include <pv/util.hpp>
37 #include <pv/data/signaldata.hpp>
38 #include <pv/views/viewbase.hpp>
40 #include "cursorpair.hpp"
43 #include "tracetreeitemowner.hpp"
46 using std::unordered_map;
47 using std::unordered_set;
49 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, public GlobalSettingsInterface
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, QMainWindow *parent = nullptr);
108 * Resets the view to its default state after construction. It does however
109 * not reset the signal bases or any other connections with the session.
111 virtual void reset_view_state();
113 Session& session(); // This method is needed for TraceTreeItemOwner, not ViewBase
114 const Session& session() const; // This method is needed for TraceTreeItemOwner, not ViewBase
117 * Returns the signals contained in this view.
119 unordered_set< shared_ptr<Signal> > signals() const;
121 virtual void clear_signals();
123 void add_signal(const shared_ptr<Signal> signal);
126 virtual void clear_decode_signals();
128 virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
130 virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
133 shared_ptr<Signal> get_signal_under_mouse_cursor() const;
136 * Returns the view of the owner.
138 virtual View* view();
141 * Returns the view of the owner.
143 virtual const View* view() const;
145 Viewport* viewport();
147 const Viewport* viewport() const;
149 const Ruler* ruler() const;
151 virtual void save_settings(QSettings &settings) const;
153 virtual void restore_settings(QSettings &settings);
156 * Gets a list of time markers.
158 vector< shared_ptr<TimeItem> > time_items() const;
161 * Returns the view time scale in seconds per pixel.
163 double scale() const;
166 * Returns the internal view version of the time offset of the left edge
167 * of the view in seconds.
169 const pv::util::Timestamp& offset() const;
172 * Returns the ruler version of the time offset of the left edge
173 * of the view in seconds.
175 const pv::util::Timestamp& ruler_offset() const;
177 void set_zero_position(const pv::util::Timestamp& position);
179 void reset_zero_position();
181 pv::util::Timestamp zero_offset() const;
184 * Returns the vertical scroll offset.
186 int owner_visual_v_offset() const;
189 * Sets the visual v-offset.
191 void set_v_offset(int offset);
194 * Sets the visual h-offset.
196 void set_h_offset(int offset);
199 * Gets the length of the horizontal scrollbar.
201 int get_h_scrollbar_maximum() const;
204 * Returns the SI prefix to apply to the graticule time markings.
206 pv::util::SIPrefix tick_prefix() const;
209 * Returns the number of fractional digits shown for the time markings.
211 unsigned int tick_precision() const;
214 * Returns period of the graticule time markings.
216 const pv::util::Timestamp& tick_period() const;
219 * Returns number of minor division ticks per time marking.
221 unsigned int minor_tick_count() const;
224 * Returns the unit of time currently used.
226 util::TimeUnit time_unit() const;
229 * Returns the number of nested parents that this row item owner has.
231 unsigned int depth() const;
234 * Returns the currently displayed segment, starting at 0.
236 uint32_t current_segment() const;
239 * Returns whether the currently shown segment can be influenced
242 bool segment_is_selectable() const;
244 Trace::SegmentDisplayMode segment_display_mode() const;
245 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
247 void zoom(double steps);
248 void zoom(double steps, int offset);
250 void zoom_fit(bool gui_state);
253 * Sets the scale and offset.
254 * @param scale The new view scale in seconds per pixel.
255 * @param offset The view time offset in seconds.
257 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
259 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
261 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
264 * Returns true if the trace background should be drawn with a colored background.
266 bool colored_bg() const;
269 * Returns true if cursors are displayed. false otherwise.
271 bool cursors_shown() const;
274 * Shows or hides the cursors.
276 void show_cursors(bool show = true);
279 * Sets the cursors to the given offsets. You will still have to call show_cursors separately.
281 void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);
284 * Moves the cursors to a convenient position in the view.
286 void centre_cursors();
289 * Returns a reference to the pair of cursors.
291 shared_ptr<CursorPair> cursors() const;
294 * Adds a new flag at a specified time.
296 shared_ptr<Flag> add_flag(const pv::util::Timestamp& time);
299 * Removes a flag from the list.
301 void remove_flag(shared_ptr<Flag> flag);
304 * Gets the list of flags.
306 vector< shared_ptr<Flag> > flags() const;
308 const QPoint& hover_point() const;
309 const QWidget* hover_widget() const;
312 * Determines the closest level change (i.e. edge) to a given point, which
313 * is useful for e.g. the "snap to edge" functionality.
315 * @param p The current position of the mouse cursor
316 * @return The sample number of the nearest level change or -1 if none
318 int64_t get_nearest_level_change(const QPoint &p);
320 void restack_all_trace_tree_items();
322 int header_width() const;
324 void on_setting_changed(const QString &key, const QVariant &value);
327 void hover_point_changed(const QWidget* widget, const QPoint &hp);
329 void selection_changed();
331 /// Emitted when the offset changed.
332 void offset_changed();
334 /// Emitted when the scale changed.
335 void scale_changed();
337 void sticky_scrolling_changed(bool state);
339 void always_zoom_to_fit_changed(bool state);
341 /// Emitted when the tick_prefix changed.
342 void tick_prefix_changed();
344 /// Emitted when the tick_precision changed.
345 void tick_precision_changed();
347 /// Emitted when the tick_period changed.
348 void tick_period_changed();
350 /// Emitted when the time_unit changed.
351 void time_unit_changed();
353 /// Emitted when the currently selected segment changed
354 void segment_changed(int segment_id);
356 /// Emitted when the multi-segment display mode changed
357 /// @param mode is a value of Trace::SegmentDisplayMode
358 void segment_display_mode_changed(int mode, bool segment_selectable);
360 /// Emitted when the cursors are shown/hidden
361 void cursor_state_changed(bool show);
364 void trigger_event(int segment_id, util::Timestamp location);
367 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
370 * Simultaneously sets the zoom and offset.
371 * @param scale The scale to set the view to in seconds per pixel. This
372 * value is clamped between MinScale and MaxScale.
373 * @param offset The offset of the left edge of the view in seconds.
375 void set_zoom(double scale, int offset);
378 * Find a tick spacing and number formatting that does not cause
379 * the values to collide.
381 void calculate_tick_spacing();
383 void adjust_top_margin();
385 void update_scroll();
389 void set_scroll_default();
391 void determine_if_header_was_shrunk();
393 void resize_header_to_fit();
395 void update_layout();
397 TraceTreeItemOwner* find_prevalent_trace_group(
398 const shared_ptr<sigrok::ChannelGroup> &group,
399 const unordered_map<shared_ptr<data::SignalBase>,
400 shared_ptr<Signal> > &signal_map);
402 static vector< shared_ptr<Trace> >
403 extract_new_traces_for_channels(
404 const vector< shared_ptr<sigrok::Channel> > &channels,
405 const unordered_map<shared_ptr<data::SignalBase>,
406 shared_ptr<Signal> > &signal_map,
407 set< shared_ptr<Trace> > &add_list);
409 void determine_time_unit();
411 bool eventFilter(QObject *object, QEvent *event);
413 virtual void contextMenuEvent(QContextMenuEvent *event);
415 void resizeEvent(QResizeEvent *event);
417 void update_hover_point();
420 void row_item_appearance_changed(bool label, bool content);
421 void time_item_appearance_changed(bool label, bool content);
423 void extents_changed(bool horz, bool vert);
427 void on_signal_name_changed();
428 void on_splitter_moved();
430 void on_zoom_in_shortcut_triggered();
431 void on_zoom_out_shortcut_triggered();
432 void on_scroll_to_start_shortcut_triggered();
433 void on_scroll_to_end_shortcut_triggered();
435 void h_scroll_value_changed(int value);
436 void v_scroll_value_changed();
438 void signals_changed();
439 void capture_state_updated(int state);
441 void on_new_segment(int new_segment_id);
442 void on_segment_completed(int new_segment_id);
443 void on_segment_changed(int segment);
445 void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
447 virtual void perform_delayed_view_update();
449 void process_sticky_events();
452 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
455 void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
458 * Sets the 'scale_' member and emits the 'scale_changed'
461 void set_scale(double scale);
464 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
467 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
470 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
473 void set_tick_precision(unsigned tick_precision);
476 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
479 void set_tick_period(const pv::util::Timestamp& tick_period);
482 * Sets the 'time_unit' member and emits the 'time_unit_changed'
485 void set_time_unit(pv::util::TimeUnit time_unit);
488 * Sets the current segment with the first segment starting at 0.
490 void set_current_segment(uint32_t segment_id);
493 CustomScrollArea *scrollarea_;
497 QSplitter *splitter_;
499 QShortcut *zoom_in_shortcut_, *zoom_in_shortcut_2_;
500 QShortcut *zoom_out_shortcut_, *zoom_out_shortcut_2_;
501 QShortcut *home_shortcut_, *end_shortcut_;
503 unordered_set< shared_ptr<Signal> > signals_;
506 vector< shared_ptr<DecodeTrace> > decode_traces_;
509 Trace::SegmentDisplayMode segment_display_mode_;
511 /// Signals whether the user can change the currently shown segment.
512 bool segment_selectable_;
514 /// The view time scale in seconds per pixel.
517 /// The internal view version of the time offset in seconds.
518 pv::util::Timestamp offset_;
519 /// The ruler version of the time offset in seconds.
520 pv::util::Timestamp ruler_offset_;
521 /// The offset of the zero point in seconds.
522 pv::util::Timestamp zero_offset_;
524 bool updating_scroll_;
525 bool settings_restored_;
526 bool header_was_shrunk_;
528 bool sticky_scrolling_;
530 bool always_zoom_to_fit_;
532 pv::util::Timestamp tick_period_;
533 pv::util::SIPrefix tick_prefix_;
534 unsigned int minor_tick_count_;
535 unsigned int tick_precision_;
536 util::TimeUnit time_unit_;
539 shared_ptr<CursorPair> cursors_;
541 list< shared_ptr<Flag> > flags_;
542 char next_flag_text_;
544 vector< shared_ptr<TriggerMarker> > trigger_markers_;
546 QWidget* hover_widget_;
548 shared_ptr<Signal> signal_under_mouse_cursor_;
549 uint16_t snap_distance_;
551 unsigned int sticky_events_;
552 QTimer lazy_event_handler_;
554 // This is true when the defaults couldn't be set due to insufficient info
555 bool scroll_needs_defaults_;
557 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
560 // These are used to determine whether the view was altered after acq started
561 double scale_at_acq_start_;
562 pv::util::Timestamp offset_at_acq_start_;
564 // Used to suppress performing a "zoom to fit" when the session stops. This
565 // is needed when the view's settings are restored before acquisition ends.
566 // In that case we want to keep the restored settings, not have a "zoom to fit"
568 bool suppress_zoom_to_fit_after_acq_;
575 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP