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         const Ruler* ruler() const;
 149
 150         virtual void save_settings(QSettings &settings) const;
 151
 152         virtual void restore_settings(QSettings &settings);
 153
 154         /**
 155          * Gets a list of time markers.
 156          */
 157         vector< shared_ptr<TimeItem> > time_items() const;
 158
 159         shared_ptr<TimeItem> get_reference_time_item();
 160
 161         /**
 162          * Returns the view time scale in seconds per pixel.
 163          */
 164         double scale() const;
 165
 166         /**
 167          * Returns the internal view version of the time offset of the left edge
 168          * of the view in seconds.
 169          */
 170         const pv::util::Timestamp& offset() const;
 171
 172         /**
 173          * Returns the ruler version of the time offset of the left edge
 174          * of the view in seconds.
 175          */
 176         const pv::util::Timestamp& ruler_offset() const;
 177
 178         void set_zero_position(const pv::util::Timestamp& position);
 179
 180         void reset_zero_position();
 181
 182         pv::util::Timestamp zero_offset() const;
 183
 184         /**
 185          * Returns the vertical scroll offset.
 186          */
 187         int owner_visual_v_offset() const;
 188
 189         /**
 190          * Sets the visual v-offset.
 191          */
 192         void set_v_offset(int offset);
 193
 194         /**
 195          * Returns the SI prefix to apply to the graticule time markings.
 196          */
 197         pv::util::SIPrefix tick_prefix() const;
 198
 199         /**
 200          * Returns the number of fractional digits shown for the time markings.
 201          */
 202         unsigned int tick_precision() const;
 203
 204         /**
 205          * Returns period of the graticule time markings.
 206          */
 207         const pv::util::Timestamp& tick_period() const;
 208
 209         /**
 210          * Returns number of minor division ticks per time marking.
 211          */
 212         unsigned int minor_tick_count() const;
 213
 214         /**
 215          * Returns the unit of time currently used.
 216          */
 217         util::TimeUnit time_unit() const;
 218
 219         /**
 220          * Returns the number of nested parents that this row item owner has.
 221          */
 222         unsigned int depth() const;
 223
 224         /**
 225          * Returns the currently displayed segment, starting at 0.
 226          */
 227         uint32_t current_segment() const;
 228
 229         /**
 230          * Returns whether the currently shown segment can be influenced
 231          * (selected) or not.
 232          */
 233         bool segment_is_selectable() const;
 234
 235         Trace::SegmentDisplayMode segment_display_mode() const;
 236         void set_segment_display_mode(Trace::SegmentDisplayMode mode);
 237
 238         void zoom(double steps);
 239         void zoom(double steps, int offset);
 240
 241         void zoom_fit(bool gui_state);
 242
 243         /**
 244          * Sets the scale and offset.
 245          * @param scale The new view scale in seconds per pixel.
 246          * @param offset The view time offset in seconds.
 247          */
 248         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
 249
 250         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
 251
 252         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
 253
 254         /**
 255          * Enables or disables colored trace backgrounds. If they're not
 256          * colored then they will use alternating colors.
 257          */
 258         void enable_colored_bg(bool state);
 259
 260         /**
 261          * Returns true if the trace background should be drawn with a colored background.
 262          */
 263         bool colored_bg() const;
 264
 265         /**
 266          * Enable or disable showing sampling points.
 267          */
 268         void enable_show_sampling_points(bool state);
 269
 270         /**
 271          * Enable or disable showing the analog minor grid.
 272          */
 273         void enable_show_analog_minor_grid(bool state);
 274
 275         /**
 276          * Returns true if cursors are displayed. false otherwise.
 277          */
 278         bool cursors_shown() const;
 279
 280         /**
 281          * Shows or hides the cursors.
 282          */
 283         void show_cursors(bool show = true);
 284
 285         /**
 286          * Sets the cursors to the given offsets. You will still have to call show_cursors separately.
 287          */
 288         void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);
 289
 290         /**
 291          * Moves the cursors to a convenient position in the view.
 292          */
 293         void centre_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 unordered_map<shared_ptr<data::SignalBase>,
 407                         shared_ptr<Signal> > &signal_map);
 408
 409         static vector< shared_ptr<Trace> >
 410                 extract_new_traces_for_channels(
 411                 const vector< shared_ptr<sigrok::Channel> > &channels,
 412                 const unordered_map<shared_ptr<data::SignalBase>,
 413                         shared_ptr<Signal> > &signal_map,
 414                 set< shared_ptr<Trace> > &add_list);
 415
 416         void determine_time_unit();
 417
 418         bool eventFilter(QObject *object, QEvent *event);
 419
 420         virtual void contextMenuEvent(QContextMenuEvent *event);
 421
 422         void resizeEvent(QResizeEvent *event);
 423
 424         void update_hover_point();
 425
 426 public:
 427         void row_item_appearance_changed(bool label, bool content);
 428         void time_item_appearance_changed(bool label, bool content);
 429
 430         void extents_changed(bool horz, bool vert);
 431
 432 private Q_SLOTS:
 433
 434         void on_signal_name_changed();
 435         void on_splitter_moved();
 436
 437         void h_scroll_value_changed(int value);
 438         void v_scroll_value_changed();
 439
 440         void signals_changed();
 441         void capture_state_updated(int state);
 442
 443         void on_new_segment(int new_segment_id);
 444         void on_segment_completed(int new_segment_id);
 445         void on_segment_changed(int segment);
 446
 447         void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);
 448
 449         virtual void perform_delayed_view_update();
 450
 451         void process_sticky_events();
 452
 453         /**
 454          * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
 455          * signal if needed.
 456          */
 457         void set_offset(const pv::util::Timestamp& offset, bool force_update = false);
 458
 459         /**
 460          * Sets the 'scale_' member and emits the 'scale_changed'
 461          * signal if needed.
 462          */
 463         void set_scale(double scale);
 464
 465         /**
 466          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
 467          * signal if needed.
 468          */
 469         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
 470
 471         /**
 472          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
 473          * signal if needed.
 474          */
 475         void set_tick_precision(unsigned tick_precision);
 476
 477         /**
 478          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
 479          * signal if needed.
 480          */
 481         void set_tick_period(const pv::util::Timestamp& tick_period);
 482
 483         /**
 484          * Sets the 'time_unit' member and emits the 'time_unit_changed'
 485          * signal if needed.
 486          */
 487         void set_time_unit(pv::util::TimeUnit time_unit);
 488
 489         /**
 490          * Sets the current segment with the first segment starting at 0.
 491          */
 492         void set_current_segment(uint32_t segment_id);
 493
 494 private:
 495         CustomScrollArea *scrollarea_;
 496         Viewport *viewport_;
 497         Ruler *ruler_;
 498         Header *header_;
 499         QSplitter *splitter_;
 500
 501         unordered_set< shared_ptr<Signal> > signals_;
 502
 503 #ifdef ENABLE_DECODE
 504         vector< shared_ptr<DecodeTrace> > decode_traces_;
 505 #endif
 506
 507         Trace::SegmentDisplayMode segment_display_mode_;
 508
 509         /// Signals whether the user can change the currently shown segment.
 510         bool segment_selectable_;
 511
 512         /// The view time scale in seconds per pixel.
 513         double scale_;
 514
 515         /// The internal view version of the time offset in seconds.
 516         pv::util::Timestamp offset_;
 517         /// The ruler version of the time offset in seconds.
 518         pv::util::Timestamp ruler_offset_;
 519         /// The offset of the zero point in seconds.
 520         pv::util::Timestamp zero_offset_;
 521
 522         bool updating_scroll_;
 523         bool settings_restored_;
 524         bool header_was_shrunk_;
 525
 526         bool sticky_scrolling_;
 527         bool colored_bg_;
 528         bool always_zoom_to_fit_;
 529
 530         pv::util::Timestamp tick_period_;
 531         pv::util::SIPrefix tick_prefix_;
 532         unsigned int minor_tick_count_;
 533         unsigned int tick_precision_;
 534         util::TimeUnit time_unit_;
 535
 536         bool show_cursors_;
 537         shared_ptr<CursorPair> cursors_;
 538
 539         list< shared_ptr<Flag> > flags_;
 540         char next_flag_text_;
 541
 542         vector< shared_ptr<TriggerMarker> > trigger_markers_;
 543
 544         QWidget* hover_widget_;
 545         QPoint hover_point_;
 546         shared_ptr<Signal> signal_under_mouse_cursor_;
 547         uint16_t snap_distance_;
 548
 549         unsigned int sticky_events_;
 550         QTimer lazy_event_handler_;
 551
 552         // This is true when the defaults couldn't be set due to insufficient info
 553         bool scroll_needs_defaults_;
 554
 555         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
 556         int saved_v_offset_;
 557
 558         // These are used to determine whether the view was altered after acq started
 559         double scale_at_acq_start_;
 560         pv::util::Timestamp offset_at_acq_start_;
 561
 562         // Used to suppress performing a "zoom to fit" when the session stops. This
 563         // is needed when the view's settings are restored before acquisition ends.
 564         // In that case we want to keep the restored settings, not have a "zoom to fit"
 565         // mess them up.
 566         bool suppress_zoom_to_fit_after_acq_;
 567 };
 568
 569 } // namespace trace
 570 } // namespace views
 571 } // namespace pv
 572
 573 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP