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/globalsettings.hpp>
35 #include <pv/util.hpp>
36 #include <pv/data/signaldata.hpp>
37 #include <pv/views/viewbase.hpp>
39 #include "cursorpair.hpp"
42 #include "tracetreeitemowner.hpp"
45 using std::unordered_map;
46 using std::unordered_set;
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;
99 static const int ScaleUnits[3];
102 explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
107 * Resets the view to its default state after construction. It does however
108 * not reset the signal bases or any other connections with the session.
110 virtual void reset_view_state();
113 const Session& session() const;
116 * Returns the signals contained in this view.
118 unordered_set< shared_ptr<Signal> > signals() const;
120 virtual void clear_signals();
122 void add_signal(const shared_ptr<Signal> signal);
125 virtual void clear_decode_signals();
127 virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
129 virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
132 shared_ptr<Signal> get_signal_under_mouse_cursor() const;
135 * Returns the view of the owner.
137 virtual View* view();
140 * Returns the view of the owner.
142 virtual const View* view() const;
144 Viewport* viewport();
146 const Viewport* viewport() const;
148 const Ruler* ruler() const;
150 virtual void save_settings(QSettings &settings) const;
152 virtual void restore_settings(QSettings &settings);
155 * Gets a list of time markers.
157 vector< shared_ptr<TimeItem> > time_items() const;
160 * Returns the view time scale in seconds per pixel.
162 double scale() const;
165 * Returns the internal view version of the time offset of the left edge
166 * of the view in seconds.
168 const pv::util::Timestamp& offset() const;
171 * Returns the ruler version of the time offset of the left edge
172 * of the view in seconds.
174 const pv::util::Timestamp& ruler_offset() const;
176 void set_zero_position(const pv::util::Timestamp& position);
178 void reset_zero_position();
181 * Returns the vertical scroll offset.
183 int owner_visual_v_offset() const;
186 * Sets the visual v-offset.
188 void set_v_offset(int offset);
191 * Returns the SI prefix to apply to the graticule time markings.
193 pv::util::SIPrefix tick_prefix() const;
196 * Returns the number of fractional digits shown for the time markings.
198 unsigned int tick_precision() const;
201 * Returns period of the graticule time markings.
203 const pv::util::Timestamp& tick_period() const;
206 * Returns number of minor division ticks per time marking.
208 unsigned int minor_tick_count() const;
211 * Returns the unit of time currently used.
213 util::TimeUnit time_unit() const;
216 * Returns the number of nested parents that this row item owner has.
218 unsigned int depth() const;
221 * Returns the currently displayed segment, starting at 0.
223 uint32_t current_segment() const;
226 * Returns whether the currently shown segment can be influenced
229 bool segment_is_selectable() const;
231 Trace::SegmentDisplayMode segment_display_mode() const;
232 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
234 void zoom(double steps);
235 void zoom(double steps, int offset);
237 void zoom_fit(bool gui_state);
240 * Sets the scale and offset.
241 * @param scale The new view scale in seconds per pixel.
242 * @param offset The view time offset in seconds.
244 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
246 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
248 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
251 * Enables or disables colored trace backgrounds. If they're not
252 * colored then they will use alternating colors.
254 void enable_colored_bg(bool state);
257 * Returns true if the trace background should be drawn with a colored background.
259 bool colored_bg() const;
262 * Enable or disable showing sampling points.
264 void enable_show_sampling_points(bool state);
267 * Enable or disable showing the analog minor grid.
269 void enable_show_analog_minor_grid(bool state);
272 * Returns true if cursors are displayed. false otherwise.
274 bool cursors_shown() const;
277 * Shows or hides the cursors.
279 void show_cursors(bool show = true);
282 * Moves the cursors to a convenient position in the view.
284 void centre_cursors();
287 * Returns a reference to the pair of cursors.
289 shared_ptr<CursorPair> cursors() const;
292 * Adds a new flag at a specified time.
294 void add_flag(const pv::util::Timestamp& time);
297 * Removes a flag from the list.
299 void remove_flag(shared_ptr<Flag> flag);
302 * Gets the list of flags.
304 vector< shared_ptr<Flag> > flags() const;
306 const QPoint& hover_point() const;
307 const QWidget* hover_widget() const;
310 * Determines the closest level change (i.e. edge) to a given point, which
311 * is useful for e.g. the "snap to edge" functionality.
313 * @param p The current position of the mouse cursor
314 * @return The sample number of the nearest level change or -1 if none
316 int64_t get_nearest_level_change(const QPoint &p);
318 void restack_all_trace_tree_items();
320 int header_width() const;
322 void on_setting_changed(const QString &key, const QVariant &value);
325 void hover_point_changed(const QWidget* widget, const QPoint &hp);
327 void selection_changed();
329 /// Emitted when the offset changed.
330 void offset_changed();
332 /// Emitted when the scale changed.
333 void scale_changed();
335 void sticky_scrolling_changed(bool state);
337 void always_zoom_to_fit_changed(bool state);
339 /// Emitted when the tick_prefix changed.
340 void tick_prefix_changed();
342 /// Emitted when the tick_precision changed.
343 void tick_precision_changed();
345 /// Emitted when the tick_period changed.
346 void tick_period_changed();
348 /// Emitted when the time_unit changed.
349 void time_unit_changed();
351 /// Emitted when the currently selected segment changed
352 void segment_changed(int segment_id);
354 /// Emitted when the multi-segment display mode changed
355 /// @param mode is a value of Trace::SegmentDisplayMode
356 void segment_display_mode_changed(int mode, bool segment_selectable);
358 /// Emitted when the cursors are shown/hidden
359 void cursor_state_changed(bool show);
362 void trigger_event(int segment_id, util::Timestamp location);
365 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
368 * Simultaneously sets the zoom and offset.
369 * @param scale The scale to set the view to in seconds per pixel. This
370 * value is clamped between MinScale and MaxScale.
371 * @param offset The offset of the left edge of the view in seconds.
373 void set_zoom(double scale, int offset);
376 * Find a tick spacing and number formatting that does not cause
377 * the values to collide.
379 void calculate_tick_spacing();
381 void adjust_top_margin();
383 void update_scroll();
387 void set_scroll_default();
389 void determine_if_header_was_shrunk();
391 void resize_header_to_fit();
393 void update_layout();
395 TraceTreeItemOwner* find_prevalent_trace_group(
396 const shared_ptr<sigrok::ChannelGroup> &group,
397 const unordered_map<shared_ptr<data::SignalBase>,
398 shared_ptr<Signal> > &signal_map);
400 static vector< shared_ptr<Trace> >
401 extract_new_traces_for_channels(
402 const vector< shared_ptr<sigrok::Channel> > &channels,
403 const unordered_map<shared_ptr<data::SignalBase>,
404 shared_ptr<Signal> > &signal_map,
405 set< shared_ptr<Trace> > &add_list);
407 void determine_time_unit();
409 bool eventFilter(QObject *object, QEvent *event);
411 virtual void contextMenuEvent(QContextMenuEvent *event);
413 void resizeEvent(QResizeEvent *event);
415 void update_hover_point();
418 void row_item_appearance_changed(bool label, bool content);
419 void time_item_appearance_changed(bool label, bool content);
421 void extents_changed(bool horz, bool vert);
425 void on_signal_name_changed();
426 void on_splitter_moved();
428 void h_scroll_value_changed(int value);
429 void v_scroll_value_changed();
431 void signals_changed();
432 void capture_state_updated(int state);
434 void on_new_segment(int new_segment_id);
435 void on_segment_completed(int new_segment_id);
436 void on_segment_changed(int segment);
438 void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
440 virtual void perform_delayed_view_update();
442 void process_sticky_events();
445 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
448 void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
451 * Sets the 'scale_' member and emits the 'scale_changed'
454 void set_scale(double scale);
457 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
460 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
463 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
466 void set_tick_precision(unsigned tick_precision);
469 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
472 void set_tick_period(const pv::util::Timestamp& tick_period);
475 * Sets the 'time_unit' member and emits the 'time_unit_changed'
478 void set_time_unit(pv::util::TimeUnit time_unit);
481 * Sets the current segment with the first segment starting at 0.
483 void set_current_segment(uint32_t segment_id);
486 CustomScrollArea *scrollarea_;
490 QSplitter *splitter_;
492 unordered_set< shared_ptr<Signal> > signals_;
495 vector< shared_ptr<DecodeTrace> > decode_traces_;
498 Trace::SegmentDisplayMode segment_display_mode_;
500 /// Signals whether the user can change the currently shown segment.
501 bool segment_selectable_;
503 /// The view time scale in seconds per pixel.
506 /// The internal view version of the time offset in seconds.
507 pv::util::Timestamp offset_;
508 /// The ruler version of the time offset in seconds.
509 pv::util::Timestamp ruler_offset_;
511 bool updating_scroll_;
512 bool settings_restored_;
513 bool header_was_shrunk_;
515 bool sticky_scrolling_;
517 bool always_zoom_to_fit_;
519 pv::util::Timestamp tick_period_;
520 pv::util::SIPrefix tick_prefix_;
521 unsigned int minor_tick_count_;
522 unsigned int tick_precision_;
523 util::TimeUnit time_unit_;
526 shared_ptr<CursorPair> cursors_;
528 list< shared_ptr<Flag> > flags_;
529 char next_flag_text_;
531 vector< shared_ptr<TriggerMarker> > trigger_markers_;
533 QWidget* hover_widget_;
535 shared_ptr<Signal> signal_under_mouse_cursor_;
536 uint16_t snap_distance_;
538 unsigned int sticky_events_;
539 QTimer lazy_event_handler_;
541 // This is true when the defaults couldn't be set due to insufficient info
542 bool scroll_needs_defaults_;
544 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
547 // These are used to determine whether the view was altered after acq started
548 double scale_at_acq_start_;
549 pv::util::Timestamp offset_at_acq_start_;
551 // Used to suppress performing a "zoom to fit" when the session stops. This
552 // is needed when the view's settings are restored before acquisition ends.
553 // In that case we want to keep the restored settings, not have a "zoom to fit"
555 bool suppress_zoom_to_fit_after_acq_;
562 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP