pv/views/trace/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 <QSplitter>
  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 "trace.hpp"
  41 #include "tracetreeitemowner.hpp"
  42
  43 using std::list;
  44 using std::unordered_map;
  45 using std::unordered_set;
  46 using std::set;
  47 using std::shared_ptr;
  48 using std::vector;
  49
  50 namespace sigrok {
  51 class ChannelGroup;
  52 }
  53
  54 namespace pv {
  55
  56 class Session;
  57
  58 namespace data {
  59 class Logic;
  60 }
  61
  62 namespace views {
  63
  64 namespace trace {
  65
  66 class CursorHeader;
  67 class DecodeTrace;
  68 class Header;
  69 class Ruler;
  70 class Signal;
  71 class Trace;
  72 class Viewport;
  73 class TriggerMarker;
  74
  75 class CustomScrollArea : public QAbstractScrollArea
  76 {
  77         Q_OBJECT
  78
  79 public:
  80         CustomScrollArea(QWidget *parent = nullptr);
  81         bool viewportEvent(QEvent *event);
  82 };
  83
  84 class View : public ViewBase, public TraceTreeItemOwner
  85 {
  86         Q_OBJECT
  87
  88 private:
  89         enum StickyEvents {
  90                 TraceTreeItemHExtentsChanged = 1,
  91                 TraceTreeItemVExtentsChanged = 2
  92         };
  93
  94 private:
  95         static const pv::util::Timestamp MaxScale;
  96         static const pv::util::Timestamp MinScale;
  97
  98         static const int MaxScrollValue;
  99
 100         static const int ScaleUnits[3];
 101
 102 public:
 103         explicit View(Session &session, bool is_main_view=false, QWidget *parent = nullptr);
 104
 105         Session& session();
 106         const Session& session() const;
 107
 108         /**
 109          * Returns the signals contained in this view.
 110          */
 111         unordered_set< shared_ptr<Signal> > signals() const;
 112
 113         virtual void clear_signals();
 114
 115         void add_signal(const shared_ptr<Signal> signal);
 116
 117 #ifdef ENABLE_DECODE
 118         virtual void clear_decode_signals();
 119
 120         virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);
 121
 122         virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
 123 #endif
 124
 125         /**
 126          * Returns the view of the owner.
 127          */
 128         virtual View* view();
 129
 130         /**
 131          * Returns the view of the owner.
 132          */
 133         virtual const View* view() const;
 134
 135         Viewport* viewport();
 136
 137         const Viewport* viewport() const;
 138
 139         virtual void save_settings(QSettings &settings) const;
 140
 141         virtual void restore_settings(QSettings &settings);
 142
 143         /**
 144          * Gets a list of time markers.
 145          */
 146         vector< shared_ptr<TimeItem> > time_items() const;
 147
 148         /**
 149          * Returns the view time scale in seconds per pixel.
 150          */
 151         double scale() const;
 152
 153         /**
 154          * Returns the internal view version of the time offset of the left edge
 155          * of the view in seconds.
 156          */
 157         const pv::util::Timestamp& offset() const;
 158
 159         /**
 160          * Returns the ruler version of the time offset of the left edge
 161          * of the view in seconds.
 162          */
 163         const pv::util::Timestamp& ruler_offset() const;
 164
 165         /**
 166          * Returns the vertical scroll offset.
 167          */
 168         int owner_visual_v_offset() const;
 169
 170         /**
 171          * Sets the visual v-offset.
 172          */
 173         void set_v_offset(int offset);
 174
 175         /**
 176          * Returns the SI prefix to apply to the graticule time markings.
 177          */
 178         pv::util::SIPrefix tick_prefix() const;
 179
 180         /**
 181          * Returns the number of fractional digits shown for the time markings.
 182          */
 183         unsigned int tick_precision() const;
 184
 185         /**
 186          * Returns period of the graticule time markings.
 187          */
 188         const pv::util::Timestamp& tick_period() const;
 189
 190         /**
 191          * Returns the unit of time currently used.
 192          */
 193         util::TimeUnit time_unit() const;
 194
 195         /**
 196          * Returns the number of nested parents that this row item owner has.
 197          */
 198         unsigned int depth() const;
 199
 200         /**
 201          * Returns the currently displayed segment, starting at 0.
 202          */
 203         uint32_t current_segment() const;
 204
 205         /**
 206          * Returns whether the currently shown segment can be influenced
 207          * (selected) or not.
 208          */
 209         bool segment_is_selectable() const;
 210
 211         Trace::SegmentDisplayMode segment_display_mode() const;
 212         void set_segment_display_mode(Trace::SegmentDisplayMode mode);
 213
 214         void zoom(double steps);
 215         void zoom(double steps, int offset);
 216
 217         void zoom_fit(bool gui_state);
 218
 219         void zoom_one_to_one();
 220
 221         /**
 222          * Sets the scale and offset.
 223          * @param scale The new view scale in seconds per pixel.
 224          * @param offset The view time offset in seconds.
 225          */
 226         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
 227
 228         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
 229
 230         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
 231
 232         /**
 233          * Enables or disables coloured trace backgrounds. If they're not
 234          * coloured then they will use alternating colors.
 235          */
 236         void enable_coloured_bg(bool state);
 237
 238         /**
 239          * Returns true if the trace background should be drawn with a coloured background.
 240          */
 241         bool coloured_bg() const;
 242
 243         /**
 244          * Enable or disable showing sampling points.
 245          */
 246         void enable_show_sampling_points(bool state);
 247
 248         /**
 249          * Enable or disable showing the analog minor grid.
 250          */
 251         void enable_show_analog_minor_grid(bool state);
 252
 253         /**
 254          * Returns true if cursors are displayed. false otherwise.
 255          */
 256         bool cursors_shown() const;
 257
 258         /**
 259          * Shows or hides the cursors.
 260          */
 261         void show_cursors(bool show = true);
 262
 263         /**
 264          * Moves the cursors to a convenient position in the view.
 265          */
 266         void centre_cursors();
 267
 268         /**
 269          * Returns a reference to the pair of cursors.
 270          */
 271         shared_ptr<CursorPair> cursors() const;
 272
 273         /**
 274          * Adds a new flag at a specified time.
 275          */
 276         void add_flag(const pv::util::Timestamp& time);
 277
 278         /**
 279          * Removes a flag from the list.
 280          */
 281         void remove_flag(shared_ptr<Flag> flag);
 282
 283         /**
 284          * Gets the list of flags.
 285          */
 286         vector< shared_ptr<Flag> > flags() const;
 287
 288         const QPoint& hover_point() const;
 289
 290         void restack_all_trace_tree_items();
 291
 292 Q_SIGNALS:
 293         void hover_point_changed(const QPoint &hp);
 294
 295         void selection_changed();
 296
 297         /// Emitted when the offset changed.
 298         void offset_changed();
 299
 300         /// Emitted when the scale changed.
 301         void scale_changed();
 302
 303         void sticky_scrolling_changed(bool state);
 304
 305         void always_zoom_to_fit_changed(bool state);
 306
 307         /// Emitted when the tick_prefix changed.
 308         void tick_prefix_changed();
 309
 310         /// Emitted when the tick_precision changed.
 311         void tick_precision_changed();
 312
 313         /// Emitted when the tick_period changed.
 314         void tick_period_changed();
 315
 316         /// Emitted when the time_unit changed.
 317         void time_unit_changed();
 318
 319         /// Emitted when the currently selected segment changed
 320         void segment_changed(int segment_id);
 321
 322         /// Emitted when the multi-segment display mode changed
 323         /// @param mode is a value of Trace::SegmentDisplayMode
 324         void segment_display_mode_changed(int mode, bool segment_selectable);
 325
 326 public Q_SLOTS:
 327         void trigger_event(util::Timestamp location);
 328
 329 private:
 330         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
 331
 332         /**
 333          * Simultaneously sets the zoom and offset.
 334          * @param scale The scale to set the view to in seconds per pixel. This
 335          * value is clamped between MinScale and MaxScale.
 336          * @param offset The offset of the left edge of the view in seconds.
 337          */
 338         void set_zoom(double scale, int offset);
 339
 340         /**
 341          * Find a tick spacing and number formatting that does not cause
 342          * the values to collide.
 343          */
 344         void calculate_tick_spacing();
 345
 346         void adjust_top_margin();
 347
 348         void update_scroll();
 349
 350         void reset_scroll();
 351
 352         void set_scroll_default();
 353
 354         void determine_if_header_was_shrunk();
 355
 356         void resize_header_to_fit();
 357
 358         void update_layout();
 359
 360         TraceTreeItemOwner* find_prevalent_trace_group(
 361                 const shared_ptr<sigrok::ChannelGroup> &group,
 362                 const unordered_map<shared_ptr<data::SignalBase>,
 363                         shared_ptr<Signal> > &signal_map);
 364
 365         static vector< shared_ptr<Trace> >
 366                 extract_new_traces_for_channels(
 367                 const vector< shared_ptr<sigrok::Channel> > &channels,
 368                 const unordered_map<shared_ptr<data::SignalBase>,
 369                         shared_ptr<Signal> > &signal_map,
 370                 set< shared_ptr<Trace> > &add_list);
 371
 372         void determine_time_unit();
 373
 374         bool eventFilter(QObject *object, QEvent *event);
 375
 376         void resizeEvent(QResizeEvent *event);
 377
 378         void update_hover_point();
 379
 380 public:
 381         void row_item_appearance_changed(bool label, bool content);
 382         void time_item_appearance_changed(bool label, bool content);
 383
 384         void extents_changed(bool horz, bool vert);
 385
 386 private Q_SLOTS:
 387
 388         void on_signal_name_changed();
 389         void on_splitter_moved();
 390
 391         void h_scroll_value_changed(int value);
 392         void v_scroll_value_changed();
 393
 394         void signals_changed();
 395         void capture_state_updated(int state);
 396
 397         void on_new_segment(int new_segment_id);
 398         void on_segment_completed(int new_segment_id);
 399         void on_segment_changed(int segment);
 400
 401         virtual void perform_delayed_view_update();
 402
 403         void process_sticky_events();
 404
 405         /**
 406          * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
 407          * signal if needed.
 408          */
 409         void set_offset(const pv::util::Timestamp& offset);
 410
 411         /**
 412          * Sets the 'scale_' member and emits the 'scale_changed'
 413          * signal if needed.
 414          */
 415         void set_scale(double scale);
 416
 417         /**
 418          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
 419          * signal if needed.
 420          */
 421         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
 422
 423         /**
 424          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
 425          * signal if needed.
 426          */
 427         void set_tick_precision(unsigned tick_precision);
 428
 429         /**
 430          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
 431          * signal if needed.
 432          */
 433         void set_tick_period(const pv::util::Timestamp& tick_period);
 434
 435         /**
 436          * Sets the 'time_unit' member and emits the 'time_unit_changed'
 437          * signal if needed.
 438          */
 439         void set_time_unit(pv::util::TimeUnit time_unit);
 440
 441         /**
 442          * Sets the current segment with the first segment starting at 0.
 443          */
 444         void set_current_segment(uint32_t segment_id);
 445
 446 private:
 447         CustomScrollArea *scrollarea_;
 448         Viewport *viewport_;
 449         Ruler *ruler_;
 450         Header *header_;
 451         QSplitter *splitter_;
 452
 453         unordered_set< shared_ptr<Signal> > signals_;
 454
 455 #ifdef ENABLE_DECODE
 456         vector< shared_ptr<DecodeTrace> > decode_traces_;
 457 #endif
 458
 459         Trace::SegmentDisplayMode segment_display_mode_;
 460
 461         /// Signals whether the user can change the currently shown segment.
 462         bool segment_selectable_;
 463
 464         /// The view time scale in seconds per pixel.
 465         double scale_;
 466
 467         /// The internal view version of the time offset in seconds.
 468         pv::util::Timestamp offset_;
 469         /// The ruler version of the time offset in seconds.
 470         pv::util::Timestamp ruler_offset_;
 471
 472         bool updating_scroll_;
 473         bool settings_restored_;
 474         bool header_was_shrunk_;
 475
 476         bool sticky_scrolling_;
 477         bool coloured_bg_;
 478         bool always_zoom_to_fit_;
 479
 480         pv::util::Timestamp tick_period_;
 481         pv::util::SIPrefix tick_prefix_;
 482         unsigned int tick_precision_;
 483         util::TimeUnit time_unit_;
 484
 485         bool show_cursors_;
 486         shared_ptr<CursorPair> cursors_;
 487
 488         list< shared_ptr<Flag> > flags_;
 489         char next_flag_text_;
 490
 491         vector< shared_ptr<TriggerMarker> > trigger_markers_;
 492
 493         QPoint hover_point_;
 494
 495         unsigned int sticky_events_;
 496         QTimer lazy_event_handler_;
 497
 498         // This is true when the defaults couldn't be set due to insufficient info
 499         bool scroll_needs_defaults_;
 500
 501         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
 502         int saved_v_offset_;
 503
 504         // These are used to determine whether the view was altered after acq started
 505         double scale_at_acq_start_;
 506         pv::util::Timestamp offset_at_acq_start_;
 507
 508         // Used to suppress performing a "zoom to fit" when the session stops. This
 509         // is needed when the view's settings are restored before acquisition ends.
 510         // In that case we want to keep the restored settings, not have a "zoom to fit"
 511         // mess them up.
 512         bool suppress_zoom_to_fit_after_acq_;
 513 };
 514
 515 } // namespace trace
 516 } // namespace views
 517 } // namespace pv
 518
 519 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP