pv/view/view.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP
  22
  23 #include <cstdint>
  24 #include <list>
  25 #include <memory>
  26 #include <set>
  27 #include <unordered_map>
  28 #include <vector>
  29
  30 #include <QAbstractScrollArea>
  31 #include <QSizeF>
  32 #include <QTimer>
  33
  34 #include <pv/data/signaldata.hpp>
  35 #include <pv/util.hpp>
  36 #include <pv/views/viewbase.hpp>
  37
  38 #include "cursorpair.hpp"
  39 #include "flag.hpp"
  40 #include "tracetreeitemowner.hpp"
  41
  42 using std::list;
  43 using std::unordered_map;
  44 using std::unordered_set;
  45 using std::set;
  46 using std::shared_ptr;
  47 using std::vector;
  48
  49 namespace sigrok {
  50 class ChannelGroup;
  51 }
  52
  53 namespace pv {
  54
  55 class Session;
  56
  57 namespace views {
  58
  59 namespace TraceView {
  60
  61 class CursorHeader;
  62 class DecodeTrace;
  63 class Header;
  64 class Ruler;
  65 class Signal;
  66 class Trace;
  67 class Viewport;
  68 class TriggerMarker;
  69
  70 class CustomAbstractScrollArea : public QAbstractScrollArea
  71 {
  72         Q_OBJECT
  73
  74 public:
  75         CustomAbstractScrollArea(QWidget *parent = nullptr);
  76         void setViewportMargins(int left, int top, int right, int bottom);
  77         bool viewportEvent(QEvent *event);
  78 };
  79
  80 class View : public ViewBase, public TraceTreeItemOwner
  81 {
  82         Q_OBJECT
  83
  84 private:
  85         enum StickyEvents {
  86                 TraceTreeItemHExtentsChanged = 1,
  87                 TraceTreeItemVExtentsChanged = 2
  88         };
  89
  90 private:
  91         static const pv::util::Timestamp MaxScale;
  92         static const pv::util::Timestamp MinScale;
  93
  94         static const int MaxScrollValue;
  95         static const int MaxViewAutoUpdateRate;
  96
  97         static const int ScaleUnits[3];
  98
  99 public:
 100         explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
 101
 102         Session& session();
 103         const Session& session() const;
 104
 105         /**
 106          * Returns the signals contained in this view.
 107          */
 108         unordered_set< shared_ptr<Signal> > signals() const;
 109
 110         virtual void clear_signals();
 111
 112         virtual void add_signal(const shared_ptr<Signal> signal);
 113
 114 #ifdef ENABLE_DECODE
 115         virtual void clear_decode_signals();
 116
 117         virtual void add_decode_signal(shared_ptr<data::SignalBase> signalbase);
 118
 119         virtual void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
 120 #endif
 121
 122         /**
 123          * Returns the view of the owner.
 124          */
 125         virtual View* view();
 126
 127         /**
 128          * Returns the view of the owner.
 129          */
 130         virtual const View* view() const;
 131
 132         Viewport* viewport();
 133
 134         const Viewport* viewport() const;
 135
 136         virtual void save_settings(QSettings &settings) const;
 137
 138         virtual void restore_settings(QSettings &settings);
 139
 140         /**
 141          * Gets a list of time markers.
 142          */
 143         vector< shared_ptr<TimeItem> > time_items() const;
 144
 145         /**
 146          * Returns the view time scale in seconds per pixel.
 147          */
 148         double scale() const;
 149
 150         /**
 151          * Returns the time offset of the left edge of the view in
 152          * seconds.
 153          */
 154         const pv::util::Timestamp& offset() const;
 155
 156         /**
 157          * Returns the vertical scroll offset.
 158          */
 159         int owner_visual_v_offset() const;
 160
 161         /**
 162          * Sets the visual v-offset.
 163          */
 164         void set_v_offset(int offset);
 165
 166         /**
 167          * Returns the SI prefix to apply to the graticule time markings.
 168          */
 169         pv::util::SIPrefix tick_prefix() const;
 170
 171         /**
 172          * Returns the number of fractional digits shown for the time markings.
 173          */
 174         unsigned int tick_precision() const;
 175
 176         /**
 177          * Returns period of the graticule time markings.
 178          */
 179         const pv::util::Timestamp& tick_period() const;
 180
 181         /**
 182          * Returns the unit of time currently used.
 183          */
 184         util::TimeUnit time_unit() const;
 185
 186         /**
 187          * Returns the number of nested parents that this row item owner has.
 188          */
 189         unsigned int depth() const;
 190
 191         void zoom(double steps);
 192         void zoom(double steps, int offset);
 193
 194         void zoom_fit(bool gui_state);
 195
 196         void zoom_one_to_one();
 197
 198         /**
 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.
 202          */
 203         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
 204
 205         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
 206
 207         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
 208
 209         /**
 210          * Enables or disables coloured trace backgrounds. If they're not
 211          * coloured then they will use alternating colors.
 212          */
 213         void enable_coloured_bg(bool state);
 214
 215         /**
 216          * Returns true if the trace background should be drawn with a coloured background.
 217          */
 218         bool coloured_bg() const;
 219
 220         /**
 221          * Enable or disable showing sampling points.
 222          */
 223         void enable_show_sampling_points(bool state);
 224
 225         /**
 226          * Enable or disable showing the analog minor grid.
 227          */
 228         void enable_show_analog_minor_grid(bool state);
 229
 230         /**
 231          * Returns true if cursors are displayed. false otherwise.
 232          */
 233         bool cursors_shown() const;
 234
 235         /**
 236          * Shows or hides the cursors.
 237          */
 238         void show_cursors(bool show = true);
 239
 240         /**
 241          * Moves the cursors to a convenient position in the view.
 242          */
 243         void centre_cursors();
 244
 245         /**
 246          * Returns a reference to the pair of cursors.
 247          */
 248         shared_ptr<CursorPair> cursors() const;
 249
 250         /**
 251          * Adds a new flag at a specified time.
 252          */
 253         void add_flag(const pv::util::Timestamp& time);
 254
 255         /**
 256          * Removes a flag from the list.
 257          */
 258         void remove_flag(shared_ptr<Flag> flag);
 259
 260         /**
 261          * Gets the list of flags.
 262          */
 263         vector< shared_ptr<Flag> > flags() const;
 264
 265         const QPoint& hover_point() const;
 266
 267         void restack_all_trace_tree_items();
 268
 269 Q_SIGNALS:
 270         void hover_point_changed();
 271
 272         void selection_changed();
 273
 274         /// Emitted when the offset changed.
 275         void offset_changed();
 276
 277         /// Emitted when the scale changed.
 278         void scale_changed();
 279
 280         void sticky_scrolling_changed(bool state);
 281
 282         void always_zoom_to_fit_changed(bool state);
 283
 284         /// Emitted when the tick_prefix changed.
 285         void tick_prefix_changed();
 286
 287         /// Emitted when the tick_precision changed.
 288         void tick_precision_changed();
 289
 290         /// Emitted when the tick_period changed.
 291         void tick_period_changed();
 292
 293         /// Emitted when the time_unit changed.
 294         void time_unit_changed();
 295
 296 public Q_SLOTS:
 297         void trigger_event(util::Timestamp location);
 298
 299 private:
 300         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
 301
 302         /**
 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.
 307          */
 308         void set_zoom(double scale, int offset);
 309
 310         /**
 311          * Find a tick spacing and number formatting that does not cause
 312          * the values to collide.
 313          */
 314         void calculate_tick_spacing();
 315
 316         void update_scroll();
 317
 318         void reset_scroll();
 319
 320         void set_scroll_default();
 321
 322         void update_layout();
 323
 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);
 328
 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);
 335
 336         void determine_time_unit();
 337
 338         bool eventFilter(QObject *object, QEvent *event);
 339
 340         void resizeEvent(QResizeEvent *event);
 341
 342 public:
 343         void row_item_appearance_changed(bool label, bool content);
 344         void time_item_appearance_changed(bool label, bool content);
 345
 346         void extents_changed(bool horz, bool vert);
 347
 348 private Q_SLOTS:
 349
 350         void h_scroll_value_changed(int value);
 351         void v_scroll_value_changed();
 352
 353         void signals_changed();
 354         void capture_state_updated(int state);
 355         void data_updated();
 356
 357         void perform_delayed_view_update();
 358
 359         void process_sticky_events();
 360
 361         void on_hover_point_changed();
 362
 363         /**
 364          * Sets the 'offset_' member and emits the 'offset_changed'
 365          * signal if needed.
 366          */
 367         void set_offset(const pv::util::Timestamp& offset);
 368
 369         /**
 370          * Sets the 'scale_' member and emits the 'scale_changed'
 371          * signal if needed.
 372          */
 373         void set_scale(double scale);
 374
 375         /**
 376          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
 377          * signal if needed.
 378          */
 379         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
 380
 381         /**
 382          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
 383          * signal if needed.
 384          */
 385         void set_tick_precision(unsigned tick_precision);
 386
 387         /**
 388          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
 389          * signal if needed.
 390          */
 391         void set_tick_period(const pv::util::Timestamp& tick_period);
 392
 393         /**
 394          * Sets the 'time_unit' member and emits the 'time_unit_changed'
 395          * signal if needed.
 396          */
 397         void set_time_unit(pv::util::TimeUnit time_unit);
 398
 399 private:
 400         Viewport *viewport_;
 401         Ruler *ruler_;
 402         Header *header_;
 403
 404         unordered_set< shared_ptr<Signal> > signals_;
 405
 406 #ifdef ENABLE_DECODE
 407         vector< shared_ptr<DecodeTrace> > decode_traces_;
 408 #endif
 409
 410         CustomAbstractScrollArea scrollarea_;
 411
 412         /// The view time scale in seconds per pixel.
 413         double scale_;
 414
 415         /// The view time offset in seconds.
 416         pv::util::Timestamp offset_;
 417
 418         bool updating_scroll_;
 419         bool sticky_scrolling_;
 420         bool coloured_bg_;
 421         bool always_zoom_to_fit_;
 422         QTimer delayed_view_updater_;
 423
 424         pv::util::Timestamp tick_period_;
 425         pv::util::SIPrefix tick_prefix_;
 426         unsigned int tick_precision_;
 427         util::TimeUnit time_unit_;
 428
 429         bool show_cursors_;
 430         shared_ptr<CursorPair> cursors_;
 431
 432         list< shared_ptr<Flag> > flags_;
 433         char next_flag_text_;
 434
 435         vector< shared_ptr<TriggerMarker> > trigger_markers_;
 436
 437         QPoint hover_point_;
 438
 439         unsigned int sticky_events_;
 440         QTimer lazy_event_handler_;
 441
 442         // This is true when the defaults couldn't be set due to insufficient info
 443         bool scroll_needs_defaults_;
 444
 445         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
 446         int saved_v_offset_;
 447
 448         bool size_finalized_;
 449 };
 450
 451 } // namespace TraceView
 452 } // namespace views
 453 } // namespace pv
 454
 455 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP