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