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