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