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;
76 class CustomScrollArea : public QAbstractScrollArea
81 CustomScrollArea(QWidget *parent = nullptr);
82 bool viewportEvent(QEvent *event);
85 class View : public ViewBase, public TraceTreeItemOwner, public GlobalSettingsInterface
91 TraceTreeItemHExtentsChanged = 1,
92 TraceTreeItemVExtentsChanged = 2
96 static const pv::util::Timestamp MaxScale;
97 static const pv::util::Timestamp MinScale;
99 static const int MaxScrollValue;
101 static const int ScaleUnits[3];
104 explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
109 const Session& session() const;
112 * Returns the signals contained in this view.
114 unordered_set< shared_ptr<Signal> > signals() const;
116 virtual void clear_signals();
118 void add_signal(const shared_ptr<Signal> signal);
121 virtual void clear_decode_signals();
123 virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
125 virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
129 * Returns the view of the owner.
131 virtual View* view();
134 * Returns the view of the owner.
136 virtual const View* view() const;
138 Viewport* viewport();
140 const Viewport* viewport() const;
142 virtual void save_settings(QSettings &settings) const;
144 virtual void restore_settings(QSettings &settings);
147 * Gets a list of time markers.
149 vector< shared_ptr<TimeItem> > time_items() const;
152 * Returns the view time scale in seconds per pixel.
154 double scale() const;
157 * Returns the internal view version of the time offset of the left edge
158 * of the view in seconds.
160 const pv::util::Timestamp& offset() const;
163 * Returns the ruler version of the time offset of the left edge
164 * of the view in seconds.
166 const pv::util::Timestamp& ruler_offset() const;
168 void set_zero_position(pv::util::Timestamp& position);
170 void reset_zero_position();
173 * Returns the vertical scroll offset.
175 int owner_visual_v_offset() const;
178 * Sets the visual v-offset.
180 void set_v_offset(int offset);
183 * Returns the SI prefix to apply to the graticule time markings.
185 pv::util::SIPrefix tick_prefix() const;
188 * Returns the number of fractional digits shown for the time markings.
190 unsigned int tick_precision() const;
193 * Returns period of the graticule time markings.
195 const pv::util::Timestamp& tick_period() const;
198 * Returns number of minor division ticks per time marking.
200 unsigned int minor_tick_count() const;
203 * Returns the unit of time currently used.
205 util::TimeUnit time_unit() const;
208 * Returns the number of nested parents that this row item owner has.
210 unsigned int depth() const;
213 * Returns the currently displayed segment, starting at 0.
215 uint32_t current_segment() const;
218 * Returns whether the currently shown segment can be influenced
221 bool segment_is_selectable() const;
223 Trace::SegmentDisplayMode segment_display_mode() const;
224 void set_segment_display_mode(Trace::SegmentDisplayMode mode);
226 void zoom(double steps);
227 void zoom(double steps, int offset);
229 void zoom_fit(bool gui_state);
231 void zoom_one_to_one();
234 * Sets the scale and offset.
235 * @param scale The new view scale in seconds per pixel.
236 * @param offset The view time offset in seconds.
238 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
240 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
242 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
245 * Enables or disables coloured trace backgrounds. If they're not
246 * coloured then they will use alternating colors.
248 void enable_coloured_bg(bool state);
251 * Returns true if the trace background should be drawn with a coloured background.
253 bool coloured_bg() const;
256 * Enable or disable showing sampling points.
258 void enable_show_sampling_points(bool state);
261 * Enable or disable showing the analog minor grid.
263 void enable_show_analog_minor_grid(bool state);
266 * Returns true if cursors are displayed. false otherwise.
268 bool cursors_shown() const;
271 * Shows or hides the cursors.
273 void show_cursors(bool show = true);
276 * Moves the cursors to a convenient position in the view.
278 void centre_cursors();
281 * Returns a reference to the pair of cursors.
283 shared_ptr<CursorPair> cursors() const;
286 * Adds a new flag at a specified time.
288 void add_flag(const pv::util::Timestamp& time);
291 * Removes a flag from the list.
293 void remove_flag(shared_ptr<Flag> flag);
296 * Gets the list of flags.
298 vector< shared_ptr<Flag> > flags() const;
300 const QPoint& hover_point() const;
302 void restack_all_trace_tree_items();
304 void on_setting_changed(const QString &key, const QVariant &value);
307 void hover_point_changed(const QPoint &hp);
309 void selection_changed();
311 /// Emitted when the offset changed.
312 void offset_changed();
314 /// Emitted when the scale changed.
315 void scale_changed();
317 void sticky_scrolling_changed(bool state);
319 void always_zoom_to_fit_changed(bool state);
321 /// Emitted when the tick_prefix changed.
322 void tick_prefix_changed();
324 /// Emitted when the tick_precision changed.
325 void tick_precision_changed();
327 /// Emitted when the tick_period changed.
328 void tick_period_changed();
330 /// Emitted when the time_unit changed.
331 void time_unit_changed();
333 /// Emitted when the currently selected segment changed
334 void segment_changed(int segment_id);
336 /// Emitted when the multi-segment display mode changed
337 /// @param mode is a value of Trace::SegmentDisplayMode
338 void segment_display_mode_changed(int mode, bool segment_selectable);
341 void trigger_event(int segment_id, util::Timestamp location);
344 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
347 * Simultaneously sets the zoom and offset.
348 * @param scale The scale to set the view to in seconds per pixel. This
349 * value is clamped between MinScale and MaxScale.
350 * @param offset The offset of the left edge of the view in seconds.
352 void set_zoom(double scale, int offset);
355 * Find a tick spacing and number formatting that does not cause
356 * the values to collide.
358 void calculate_tick_spacing();
360 void adjust_top_margin();
362 void update_scroll();
366 void set_scroll_default();
368 void determine_if_header_was_shrunk();
370 void resize_header_to_fit();
372 void update_layout();
374 TraceTreeItemOwner* find_prevalent_trace_group(
375 const shared_ptr<sigrok::ChannelGroup> &group,
376 const unordered_map<shared_ptr<data::SignalBase>,
377 shared_ptr<Signal> > &signal_map);
379 static vector< shared_ptr<Trace> >
380 extract_new_traces_for_channels(
381 const vector< shared_ptr<sigrok::Channel> > &channels,
382 const unordered_map<shared_ptr<data::SignalBase>,
383 shared_ptr<Signal> > &signal_map,
384 set< shared_ptr<Trace> > &add_list);
386 void determine_time_unit();
388 bool eventFilter(QObject *object, QEvent *event);
390 void resizeEvent(QResizeEvent *event);
392 void update_hover_point();
395 void row_item_appearance_changed(bool label, bool content);
396 void time_item_appearance_changed(bool label, bool content);
398 void extents_changed(bool horz, bool vert);
402 void on_signal_name_changed();
403 void on_splitter_moved();
405 void h_scroll_value_changed(int value);
406 void v_scroll_value_changed();
408 void signals_changed();
409 void capture_state_updated(int state);
411 void on_new_segment(int new_segment_id);
412 void on_segment_completed(int new_segment_id);
413 void on_segment_changed(int segment);
415 void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
417 virtual void perform_delayed_view_update();
419 void process_sticky_events();
422 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
425 void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
428 * Sets the 'scale_' member and emits the 'scale_changed'
431 void set_scale(double scale);
434 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
437 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
440 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
443 void set_tick_precision(unsigned tick_precision);
446 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
449 void set_tick_period(const pv::util::Timestamp& tick_period);
452 * Sets the 'time_unit' member and emits the 'time_unit_changed'
455 void set_time_unit(pv::util::TimeUnit time_unit);
458 * Sets the current segment with the first segment starting at 0.
460 void set_current_segment(uint32_t segment_id);
463 CustomScrollArea *scrollarea_;
467 QSplitter *splitter_;
469 unordered_set< shared_ptr<Signal> > signals_;
472 vector< shared_ptr<DecodeTrace> > decode_traces_;
475 Trace::SegmentDisplayMode segment_display_mode_;
477 /// Signals whether the user can change the currently shown segment.
478 bool segment_selectable_;
480 /// The view time scale in seconds per pixel.
483 /// The internal view version of the time offset in seconds.
484 pv::util::Timestamp offset_;
485 /// The ruler version of the time offset in seconds.
486 pv::util::Timestamp ruler_offset_;
488 bool updating_scroll_;
489 bool settings_restored_;
490 bool header_was_shrunk_;
492 bool sticky_scrolling_;
494 bool always_zoom_to_fit_;
496 pv::util::Timestamp tick_period_;
497 pv::util::SIPrefix tick_prefix_;
498 unsigned int minor_tick_count_;
499 unsigned int tick_precision_;
500 util::TimeUnit time_unit_;
503 shared_ptr<CursorPair> cursors_;
505 list< shared_ptr<Flag> > flags_;
506 char next_flag_text_;
508 vector< shared_ptr<TriggerMarker> > trigger_markers_;
512 unsigned int sticky_events_;
513 QTimer lazy_event_handler_;
515 // This is true when the defaults couldn't be set due to insufficient info
516 bool scroll_needs_defaults_;
518 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
521 // These are used to determine whether the view was altered after acq started
522 double scale_at_acq_start_;
523 pv::util::Timestamp offset_at_acq_start_;
525 // Used to suppress performing a "zoom to fit" when the session stops. This
526 // is needed when the view's settings are restored before acquisition ends.
527 // In that case we want to keep the restored settings, not have a "zoom to fit"
529 bool suppress_zoom_to_fit_after_acq_;
536 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP