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/data/signaldata.hpp>
35 #include <pv/util.hpp>
36 #include <pv/views/viewbase.hpp>
38 #include "cursorpair.hpp"
40 #include "tracetreeitemowner.hpp"
43 using std::unordered_map;
44 using std::unordered_set;
46 using std::shared_ptr;
70 class CustomAbstractScrollArea : public QAbstractScrollArea
75 CustomAbstractScrollArea(QWidget *parent = nullptr);
76 void setViewportMargins(int left, int top, int right, int bottom);
77 bool viewportEvent(QEvent *event);
80 class View : public ViewBase, public TraceTreeItemOwner
86 TraceTreeItemHExtentsChanged = 1,
87 TraceTreeItemVExtentsChanged = 2
91 static const pv::util::Timestamp MaxScale;
92 static const pv::util::Timestamp MinScale;
94 static const int MaxScrollValue;
95 static const int MaxViewAutoUpdateRate;
97 static const int ScaleUnits[3];
100 explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
103 const Session& session() const;
106 * Returns the signals contained in this view.
108 unordered_set< shared_ptr<Signal> > signals() const;
110 virtual void clear_signals();
112 virtual void add_signal(const shared_ptr<Signal> signal);
115 virtual void clear_decode_signals();
117 virtual void add_decode_signal(shared_ptr<data::SignalBase> signalbase);
119 virtual void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
123 * Returns the view of the owner.
125 virtual View* view();
128 * Returns the view of the owner.
130 virtual const View* view() const;
132 Viewport* viewport();
134 const Viewport* viewport() const;
136 virtual void save_settings(QSettings &settings) const;
138 virtual void restore_settings(QSettings &settings);
141 * Gets a list of time markers.
143 vector< shared_ptr<TimeItem> > time_items() const;
146 * Returns the view time scale in seconds per pixel.
148 double scale() const;
151 * Returns the time offset of the left edge of the view in
154 const pv::util::Timestamp& offset() const;
157 * Returns the vertical scroll offset.
159 int owner_visual_v_offset() const;
162 * Sets the visual v-offset.
164 void set_v_offset(int offset);
167 * Returns the SI prefix to apply to the graticule time markings.
169 pv::util::SIPrefix tick_prefix() const;
172 * Returns the number of fractional digits shown for the time markings.
174 unsigned int tick_precision() const;
177 * Returns period of the graticule time markings.
179 const pv::util::Timestamp& tick_period() const;
182 * Returns the unit of time currently used.
184 util::TimeUnit time_unit() const;
187 * Returns the number of nested parents that this row item owner has.
189 unsigned int depth() const;
191 void zoom(double steps);
192 void zoom(double steps, int offset);
194 void zoom_fit(bool gui_state);
196 void zoom_one_to_one();
199 * Sets the scale and offset.
200 * @param scale The new view scale in seconds per pixel.
201 * @param offset The view time offset in seconds.
203 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
205 set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
207 pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
210 * Enables or disables coloured trace backgrounds. If they're not
211 * coloured then they will use alternating colors.
213 void enable_coloured_bg(bool state);
216 * Returns true if the trace background should be drawn with a coloured background.
218 bool coloured_bg() const;
221 * Enable or disable showing sampling points.
223 void enable_show_sampling_points(bool state);
226 * Enable or disable showing the analog minor grid.
228 void enable_show_analog_minor_grid(bool state);
231 * Returns true if cursors are displayed. false otherwise.
233 bool cursors_shown() const;
236 * Shows or hides the cursors.
238 void show_cursors(bool show = true);
241 * Moves the cursors to a convenient position in the view.
243 void centre_cursors();
246 * Returns a reference to the pair of cursors.
248 shared_ptr<CursorPair> cursors() const;
251 * Adds a new flag at a specified time.
253 void add_flag(const pv::util::Timestamp& time);
256 * Removes a flag from the list.
258 void remove_flag(shared_ptr<Flag> flag);
261 * Gets the list of flags.
263 vector< shared_ptr<Flag> > flags() const;
265 const QPoint& hover_point() const;
267 void restack_all_trace_tree_items();
270 void hover_point_changed();
272 void selection_changed();
274 /// Emitted when the offset changed.
275 void offset_changed();
277 /// Emitted when the scale changed.
278 void scale_changed();
280 void sticky_scrolling_changed(bool state);
282 void always_zoom_to_fit_changed(bool state);
284 /// Emitted when the tick_prefix changed.
285 void tick_prefix_changed();
287 /// Emitted when the tick_precision changed.
288 void tick_precision_changed();
290 /// Emitted when the tick_period changed.
291 void tick_period_changed();
293 /// Emitted when the time_unit changed.
294 void time_unit_changed();
297 void trigger_event(util::Timestamp location);
300 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
303 * Simultaneously sets the zoom and offset.
304 * @param scale The scale to set the view to in seconds per pixel. This
305 * value is clamped between MinScale and MaxScale.
306 * @param offset The offset of the left edge of the view in seconds.
308 void set_zoom(double scale, int offset);
311 * Find a tick spacing and number formatting that does not cause
312 * the values to collide.
314 void calculate_tick_spacing();
316 void update_scroll();
320 void set_scroll_default();
322 void update_layout();
324 TraceTreeItemOwner* find_prevalent_trace_group(
325 const shared_ptr<sigrok::ChannelGroup> &group,
326 const unordered_map<shared_ptr<data::SignalBase>,
327 shared_ptr<Signal> > &signal_map);
329 static vector< shared_ptr<Trace> >
330 extract_new_traces_for_channels(
331 const vector< shared_ptr<sigrok::Channel> > &channels,
332 const unordered_map<shared_ptr<data::SignalBase>,
333 shared_ptr<Signal> > &signal_map,
334 set< shared_ptr<Trace> > &add_list);
336 void determine_time_unit();
338 bool eventFilter(QObject *object, QEvent *event);
340 void resizeEvent(QResizeEvent *event);
343 void row_item_appearance_changed(bool label, bool content);
344 void time_item_appearance_changed(bool label, bool content);
346 void extents_changed(bool horz, bool vert);
350 void h_scroll_value_changed(int value);
351 void v_scroll_value_changed();
353 void signals_changed();
354 void capture_state_updated(int state);
357 void perform_delayed_view_update();
359 void process_sticky_events();
361 void on_hover_point_changed();
364 * Sets the 'offset_' member and emits the 'offset_changed'
367 void set_offset(const pv::util::Timestamp& offset);
370 * Sets the 'scale_' member and emits the 'scale_changed'
373 void set_scale(double scale);
376 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
379 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
382 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
385 void set_tick_precision(unsigned tick_precision);
388 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
391 void set_tick_period(const pv::util::Timestamp& tick_period);
394 * Sets the 'time_unit' member and emits the 'time_unit_changed'
397 void set_time_unit(pv::util::TimeUnit time_unit);
404 unordered_set< shared_ptr<Signal> > signals_;
407 vector< shared_ptr<DecodeTrace> > decode_traces_;
410 CustomAbstractScrollArea scrollarea_;
412 /// The view time scale in seconds per pixel.
415 /// The view time offset in seconds.
416 pv::util::Timestamp offset_;
418 bool updating_scroll_;
419 bool sticky_scrolling_;
421 bool always_zoom_to_fit_;
422 QTimer delayed_view_updater_;
424 pv::util::Timestamp tick_period_;
425 pv::util::SIPrefix tick_prefix_;
426 unsigned int tick_precision_;
427 util::TimeUnit time_unit_;
430 shared_ptr<CursorPair> cursors_;
432 list< shared_ptr<Flag> > flags_;
433 char next_flag_text_;
435 vector< shared_ptr<TriggerMarker> > trigger_markers_;
439 unsigned int sticky_events_;
440 QTimer lazy_event_handler_;
442 // This is true when the defaults couldn't be set due to insufficient info
443 bool scroll_needs_defaults_;
445 // A nonzero value indicates the v offset to restore. See View::resizeEvent()
448 bool size_finalized_;
451 } // namespace TraceView
455 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP