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_TRACE_VIEW_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACE_VIEW_HPP
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"
48 using std::shared_ptr;
74 class CustomScrollArea : public QAbstractScrollArea
79 CustomScrollArea(QWidget *parent = nullptr);
80 bool viewportEvent(QEvent *event);
83 class View : public ViewBase, public TraceTreeItemOwner, public GlobalSettingsInterface
89 TraceTreeItemHExtentsChanged = 1,
90 TraceTreeItemVExtentsChanged = 2
94 static const pv::util::Timestamp MaxScale;
95 static const pv::util::Timestamp MinScale;
97 static const int MaxScrollValue;
98 static const int ViewScrollMargin;
100 static const int ScaleUnits[3];
103 explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr);
107 virtual ViewType get_type() const;
110 * Resets the view to its default state after construction. It does however
111 * not reset the signal bases or any other connections with the session.
113 virtual void reset_view_state();
115 Session& session(); // This method is needed for TraceTreeItemOwner, not ViewBase
116 const Session& session() const; // This method is needed for TraceTreeItemOwner, not ViewBase
119 * Returns the signals contained in this view.
121 vector< shared_ptr<Signal> > signals() const;
123 shared_ptr<Signal> get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const;
125 virtual void clear_signalbases();
126 virtual void add_signalbase(const shared_ptr<data::SignalBase> signalbase);
127 virtual void remove_signalbase(const shared_ptr<data::SignalBase> signalbase);
130 virtual void clear_decode_signals();
132 virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
134 virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
137 void remove_trace(shared_ptr<Trace> trace);
139 shared_ptr<Signal> get_signal_under_mouse_cursor() const;
142 * Returns the view of the owner.
144 virtual View* view();
147 * Returns the view of the owner.
149 virtual const View* view() const;
151 Viewport* viewport();
152 const Viewport* viewport() const;
154 QAbstractScrollArea* scrollarea() const;
156 const Ruler* ruler() const;
158 virtual void save_settings(QSettings &settings) const;
159 virtual void restore_settings(QSettings &settings);
162 * Gets a list of time markers.
164 vector< shared_ptr<TimeItem> > time_items() const;
167 * Returns the view time scale in seconds per pixel.
169 double scale() const;
172 * Returns the internal view version of the time offset of the left edge
173 * of the view in seconds.
175 const pv::util::Timestamp& offset() const;
178 * Returns the ruler version of the time offset of the left edge
179 * of the view in seconds.
181 const pv::util::Timestamp& ruler_offset() const;
183 void set_zero_position(const pv::util::Timestamp& position);
185 void reset_zero_position();
187 pv::util::Timestamp zero_offset() const;
190 * Returns the vertical scroll offset.
192 int owner_visual_v_offset() const;
195 * Sets the visual v-offset.
197 void set_v_offset(int offset);
200 * Sets the visual h-offset.
202 void set_h_offset(int offset);
205 * Gets the length of the horizontal scrollbar.
207 int get_h_scrollbar_maximum() const;
210 * Returns the SI prefix to apply to the graticule time markings.
212 pv::util::SIPrefix tick_prefix() const;
215 * Returns the number of fractional digits shown for the time markings.
217 unsigned int tick_precision() const;
220 * Returns period of the graticule time markings.
222 const pv::util::Timestamp& tick_period() const;
225 * Returns number of minor division ticks per time marking.
227 unsigned int minor_tick_count() const;
230 * Returns the unit of time currently used.
232 util::TimeUnit time_unit() const;
235 * Returns the number of nested parents that this row item owner has.
237 unsigned int depth() const;
240 * Returns the currently displayed segment, starting at 0.
242 uint32_t current_segment() const;
245 * Returns whether the currently shown segment can be influenced
248 bool segment_is_selectable() const;
250 Trace::SegmentDisplayMode segment_display_mode() const;
251 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
253 void zoom(double steps);
254 void zoom(double steps, int offset);
256 void zoom_fit(bool gui_state);
258 virtual void focus_on_range(uint64_t start_sample, uint64_t end_sample);
261 * Sets the scale and offset.
262 * @param scale The new view scale in seconds per pixel.
263 * @param offset The view time offset in seconds.
265 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
267 vector< shared_ptr<pv::data::SignalData> > get_visible_data() const;
269 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
272 * Returns true if the trace background should be drawn with a colored background.
274 bool colored_bg() const;
277 * Returns true if cursors are displayed, false otherwise.
279 bool cursors_shown() const;
282 * Shows or hides the cursors.
284 void show_cursors(bool show = true);
287 * Sets the cursors to the given offsets.
288 * You still have to call show_cursors() separately.
290 void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);
293 * Moves the cursors to a convenient position in the view.
294 * You still have to call show_cursors() separately.
296 void center_cursors();
299 * Returns a reference to the pair of cursors.
301 shared_ptr<CursorPair> cursors() const;
304 * Adds a new flag at a specified time.
306 shared_ptr<Flag> add_flag(const pv::util::Timestamp& time);
309 * Removes a flag from the list.
311 void remove_flag(shared_ptr<Flag> flag);
314 * Gets the list of flags.
316 vector< shared_ptr<Flag> > flags() const;
318 const QPoint& hover_point() const;
319 const QWidget* hover_widget() const;
322 * Determines the closest level change (i.e. edge) to a given point, which
323 * is useful for e.g. the "snap to edge" functionality.
325 * @param p The current position of the mouse cursor
326 * @return The sample number of the nearest level change or -1 if none
328 int64_t get_nearest_level_change(const QPoint &p);
330 void restack_all_trace_tree_items();
332 int header_width() const;
334 void on_setting_changed(const QString &key, const QVariant &value);
337 void hover_point_changed(const QWidget* widget, const QPoint &hp);
339 void selection_changed();
341 /// Emitted when the offset changed.
342 void offset_changed();
344 /// Emitted when the scale changed.
345 void scale_changed();
347 void sticky_scrolling_changed(bool state);
349 void always_zoom_to_fit_changed(bool state);
351 /// Emitted when the tick_prefix changed.
352 void tick_prefix_changed();
354 /// Emitted when the tick_precision changed.
355 void tick_precision_changed();
357 /// Emitted when the tick_period changed.
358 void tick_period_changed();
360 /// Emitted when the time_unit changed.
361 void time_unit_changed();
363 /// Emitted when the currently selected segment changed
364 void segment_changed(int segment_id);
366 /// Emitted when the multi-segment display mode changed
367 /// @param mode is a value of Trace::SegmentDisplayMode
368 void segment_display_mode_changed(int mode, bool segment_selectable);
370 /// Emitted when the cursors are shown/hidden
371 void cursor_state_changed(bool show);
374 void trigger_event(int segment_id, util::Timestamp location);
377 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
380 * Simultaneously sets the zoom and offset.
381 * @param scale The scale to set the view to in seconds per pixel. This
382 * value is clamped between MinScale and MaxScale.
383 * @param offset The offset of the left edge of the view in seconds.
385 void set_zoom(double scale, int offset);
388 * Find a tick spacing and number formatting that does not cause
389 * the values to collide.
391 void calculate_tick_spacing();
393 void adjust_top_margin();
395 void update_scroll();
397 void set_scroll_default();
399 void determine_if_header_was_shrunk();
401 void resize_header_to_fit();
403 void update_layout();
405 TraceTreeItemOwner* find_prevalent_trace_group(
406 const shared_ptr<sigrok::ChannelGroup> &group,
407 const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map);
409 static vector< shared_ptr<Trace> >
410 extract_new_traces_for_channels(
411 const vector< shared_ptr<sigrok::Channel> > &channels,
412 const map<shared_ptr<data::SignalBase>, shared_ptr<Signal> > &signal_map,
413 set< shared_ptr<Trace> > &add_list);
415 void determine_time_unit();
417 bool eventFilter(QObject *object, QEvent *event);
419 virtual void contextMenuEvent(QContextMenuEvent *event);
421 void resizeEvent(QResizeEvent *event);
423 void update_view_range_metaobject() const;
424 void update_hover_point();
427 void row_item_appearance_changed(bool label, bool content);
428 void time_item_appearance_changed(bool label, bool content);
430 void extents_changed(bool horz, bool vert);
433 void on_signal_name_changed();
434 void on_splitter_moved();
436 void on_zoom_in_shortcut_triggered();
437 void on_zoom_out_shortcut_triggered();
438 void on_scroll_to_start_shortcut_triggered();
439 void on_scroll_to_end_shortcut_triggered();
441 void h_scroll_value_changed(int value);
442 void v_scroll_value_changed();
444 void on_grab_ruler(int ruler_id);
446 void signals_changed();
447 void capture_state_updated(int state);
449 void on_new_segment(int new_segment_id);
450 void on_segment_completed(int new_segment_id);
451 void on_segment_changed(int segment);
453 void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
455 virtual void perform_delayed_view_update();
457 void process_sticky_events();
460 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
463 void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
466 * Sets the 'scale_' member and emits the 'scale_changed'
469 void set_scale(double scale);
472 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
475 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
478 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
481 void set_tick_precision(unsigned tick_precision);
484 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
487 void set_tick_period(const pv::util::Timestamp& tick_period);
490 * Sets the 'time_unit' member and emits the 'time_unit_changed'
493 void set_time_unit(pv::util::TimeUnit time_unit);
496 * Sets the current segment with the first segment starting at 0.
498 void set_current_segment(uint32_t segment_id);
501 CustomScrollArea *scrollarea_;
505 QSplitter *splitter_;
507 QShortcut *zoom_in_shortcut_, *zoom_in_shortcut_2_;
508 QShortcut *zoom_out_shortcut_, *zoom_out_shortcut_2_;
509 QShortcut *home_shortcut_, *end_shortcut_;
510 QShortcut *grab_ruler_left_shortcut_, *grab_ruler_right_shortcut_;
511 QShortcut *cancel_grab_shortcut_;
513 mutable mutex signal_mutex_;
514 vector< shared_ptr<Signal> > signals_;
517 vector< shared_ptr<DecodeTrace> > decode_traces_;
520 Trace::SegmentDisplayMode segment_display_mode_;
522 /// Signals whether the user can change the currently shown segment.
523 bool segment_selectable_;
525 /// The view time scale in seconds per pixel.
528 /// The internal view version of the time offset in seconds.
529 pv::util::Timestamp offset_;
530 /// The ruler version of the time offset in seconds.
531 pv::util::Timestamp ruler_offset_;
532 /// The offset of the zero point in seconds.
533 pv::util::Timestamp zero_offset_;
534 /// Shows whether the user set a custom zero offset that we should keep
535 bool custom_zero_offset_set_;
537 bool updating_scroll_;
538 bool restoring_state_;
539 bool header_was_shrunk_;
541 bool sticky_scrolling_;
543 bool always_zoom_to_fit_;
545 pv::util::Timestamp tick_period_;
546 pv::util::SIPrefix tick_prefix_;
547 unsigned int minor_tick_count_;
548 unsigned int tick_precision_;
549 util::TimeUnit time_unit_;
552 shared_ptr<CursorPair> cursors_;
554 list< shared_ptr<Flag> > flags_;
555 char next_flag_text_;
557 vector< shared_ptr<TriggerMarker> > trigger_markers_;
559 QWidget* hover_widget_;
560 TimeMarker* grabbed_widget_;
562 shared_ptr<Signal> signal_under_mouse_cursor_;
563 uint16_t snap_distance_;
565 unsigned int sticky_events_;
566 QTimer lazy_event_handler_;
568 // This is true when the defaults couldn't be set due to insufficient info
569 bool scroll_needs_defaults_;
571 // The v offset to restore. See View::eventFilter()
574 // These are used to determine whether the view was altered after acq started
575 double scale_at_acq_start_;
576 pv::util::Timestamp offset_at_acq_start_;
583 #endif // PULSEVIEW_PV_VIEWS_TRACE_VIEW_HPP