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