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