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