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();
180 pv::util::Timestamp zero_offset() const;
183 * Returns the vertical scroll offset.
185 int owner_visual_v_offset() const;
188 * Sets the visual v-offset.
190 void set_v_offset(int offset);
193 * Returns the SI prefix to apply to the graticule time markings.
195 pv::util::SIPrefix tick_prefix() const;
198 * Returns the number of fractional digits shown for the time markings.
200 unsigned int tick_precision() const;
203 * Returns period of the graticule time markings.
205 const pv::util::Timestamp& tick_period() const;
208 * Returns number of minor division ticks per time marking.
210 unsigned int minor_tick_count() const;
213 * Returns the unit of time currently used.
215 util::TimeUnit time_unit() const;
218 * Returns the number of nested parents that this row item owner has.
220 unsigned int depth() const;
223 * Returns the currently displayed segment, starting at 0.
225 uint32_t current_segment() const;
228 * Returns whether the currently shown segment can be influenced
231 bool segment_is_selectable() const;
233 Trace::SegmentDisplayMode segment_display_mode() const;
234 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
236 void zoom(double steps);
237 void zoom(double steps, int offset);
239 void zoom_fit(bool gui_state);
242 * Sets the scale and offset.
243 * @param scale The new view scale in seconds per pixel.
244 * @param offset The view time offset in seconds.
246 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
248 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
250 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
253 * Enables or disables colored trace backgrounds. If they're not
254 * colored then they will use alternating colors.
256 void enable_colored_bg(bool state);
259 * Returns true if the trace background should be drawn with a colored background.
261 bool colored_bg() const;
264 * Enable or disable showing sampling points.
266 void enable_show_sampling_points(bool state);
269 * Enable or disable showing the analog minor grid.
271 void enable_show_analog_minor_grid(bool state);
274 * Returns true if cursors are displayed. false otherwise.
276 bool cursors_shown() const;
279 * Shows or hides the cursors.
281 void show_cursors(bool show = true);
284 * Sets the cursors to the given offsets. You will still have to call show_cursors separately.
286 void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);
289 * Moves the cursors to a convenient position in the view.
291 void centre_cursors();
294 * Returns a reference to the pair of cursors.
296 shared_ptr<CursorPair> cursors() const;
299 * Adds a new flag at a specified time.
301 void add_flag(const pv::util::Timestamp& time);
304 * Removes a flag from the list.
306 void remove_flag(shared_ptr<Flag> flag);
309 * Gets the list of flags.
311 vector< shared_ptr<Flag> > flags() const;
313 const QPoint& hover_point() const;
314 const QWidget* hover_widget() const;
317 * Determines the closest level change (i.e. edge) to a given point, which
318 * is useful for e.g. the "snap to edge" functionality.
320 * @param p The current position of the mouse cursor
321 * @return The sample number of the nearest level change or -1 if none
323 int64_t get_nearest_level_change(const QPoint &p);
325 void restack_all_trace_tree_items();
327 int header_width() const;
329 void on_setting_changed(const QString &key, const QVariant &value);
332 void hover_point_changed(const QWidget* widget, const QPoint &hp);
334 void selection_changed();
336 /// Emitted when the offset changed.
337 void offset_changed();
339 /// Emitted when the scale changed.
340 void scale_changed();
342 void sticky_scrolling_changed(bool state);
344 void always_zoom_to_fit_changed(bool state);
346 /// Emitted when the tick_prefix changed.
347 void tick_prefix_changed();
349 /// Emitted when the tick_precision changed.
350 void tick_precision_changed();
352 /// Emitted when the tick_period changed.
353 void tick_period_changed();
355 /// Emitted when the time_unit changed.
356 void time_unit_changed();
358 /// Emitted when the currently selected segment changed
359 void segment_changed(int segment_id);
361 /// Emitted when the multi-segment display mode changed
362 /// @param mode is a value of Trace::SegmentDisplayMode
363 void segment_display_mode_changed(int mode, bool segment_selectable);
365 /// Emitted when the cursors are shown/hidden
366 void cursor_state_changed(bool show);
369 void trigger_event(int segment_id, util::Timestamp location);
372 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
375 * Simultaneously sets the zoom and offset.
376 * @param scale The scale to set the view to in seconds per pixel. This
377 * value is clamped between MinScale and MaxScale.
378 * @param offset The offset of the left edge of the view in seconds.
380 void set_zoom(double scale, int offset);
383 * Find a tick spacing and number formatting that does not cause
384 * the values to collide.
386 void calculate_tick_spacing();
388 void adjust_top_margin();
390 void update_scroll();
394 void set_scroll_default();
396 void determine_if_header_was_shrunk();
398 void resize_header_to_fit();
400 void update_layout();
402 TraceTreeItemOwner* find_prevalent_trace_group(
403 const shared_ptr<sigrok::ChannelGroup> &group,
404 const unordered_map<shared_ptr<data::SignalBase>,
405 shared_ptr<Signal> > &signal_map);
407 static vector< shared_ptr<Trace> >
408 extract_new_traces_for_channels(
409 const vector< shared_ptr<sigrok::Channel> > &channels,
410 const unordered_map<shared_ptr<data::SignalBase>,
411 shared_ptr<Signal> > &signal_map,
412 set< shared_ptr<Trace> > &add_list);
414 void determine_time_unit();
416 bool eventFilter(QObject *object, QEvent *event);
418 virtual void contextMenuEvent(QContextMenuEvent *event);
420 void resizeEvent(QResizeEvent *event);
422 void update_hover_point();
425 void row_item_appearance_changed(bool label, bool content);
426 void time_item_appearance_changed(bool label, bool content);
428 void extents_changed(bool horz, bool vert);
432 void on_signal_name_changed();
433 void on_splitter_moved();
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 unordered_set< shared_ptr<Signal> > signals_;
502 vector< shared_ptr<DecodeTrace> > decode_traces_;
505 Trace::SegmentDisplayMode segment_display_mode_;
507 /// Signals whether the user can change the currently shown segment.
508 bool segment_selectable_;
510 /// The view time scale in seconds per pixel.
513 /// The internal view version of the time offset in seconds.
514 pv::util::Timestamp offset_;
515 /// The ruler version of the time offset in seconds.
516 pv::util::Timestamp ruler_offset_;
517 /// The offset of the zero point in seconds.
518 pv::util::Timestamp zero_offset_;
520 bool updating_scroll_;
521 bool settings_restored_;
522 bool header_was_shrunk_;
524 bool sticky_scrolling_;
526 bool always_zoom_to_fit_;
528 pv::util::Timestamp tick_period_;
529 pv::util::SIPrefix tick_prefix_;
530 unsigned int minor_tick_count_;
531 unsigned int tick_precision_;
532 util::TimeUnit time_unit_;
535 shared_ptr<CursorPair> cursors_;
537 list< shared_ptr<Flag> > flags_;
538 char next_flag_text_;
540 vector< shared_ptr<TriggerMarker> > trigger_markers_;
542 QWidget* hover_widget_;
544 shared_ptr<Signal> signal_under_mouse_cursor_;
545 uint16_t snap_distance_;
547 unsigned int sticky_events_;
548 QTimer lazy_event_handler_;
550 // This is true when the defaults couldn't be set due to insufficient info
551 bool scroll_needs_defaults_;
553 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
556 // These are used to determine whether the view was altered after acq started
557 double scale_at_acq_start_;
558 pv::util::Timestamp offset_at_acq_start_;
560 // Used to suppress performing a "zoom to fit" when the session stops. This
561 // is needed when the view's settings are restored before acquisition ends.
562 // In that case we want to keep the restored settings, not have a "zoom to fit"
564 bool suppress_zoom_to_fit_after_acq_;
571 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP