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