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