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