pv/view/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 <stdint.h>
  24
  25 #include <list>
  26 #include <memory>
  27 #include <set>
  28 #include <unordered_map>
  29 #include <vector>
  30
  31 #include <QAbstractScrollArea>
  32 #include <QSizeF>
  33 #include <QTimer>
  34
  35 #include <pv/data/signaldata.hpp>
  36 #include <pv/views/viewbase.hpp>
  37 #include <pv/util.hpp>
  38
  39 #include "cursorpair.hpp"
  40 #include "flag.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 views {
  59
  60 namespace TraceView {
  61
  62 class CursorHeader;
  63 class DecodeTrace;
  64 class Header;
  65 class Ruler;
  66 class Signal;
  67 class Trace;
  68 class Viewport;
  69 class TriggerMarker;
  70
  71 class CustomAbstractScrollArea : public QAbstractScrollArea {
  72         Q_OBJECT
  73
  74 public:
  75         CustomAbstractScrollArea(QWidget *parent = 0);
  76         void setViewportMargins(int left, int top, int right, int bottom);
  77         bool viewportEvent(QEvent *event);
  78 };
  79
  80 class View : public ViewBase, public TraceTreeItemOwner {
  81         Q_OBJECT
  82
  83 private:
  84         enum StickyEvents {
  85                 TraceTreeItemHExtentsChanged = 1,
  86                 TraceTreeItemVExtentsChanged = 2
  87         };
  88
  89 private:
  90         static const pv::util::Timestamp MaxScale;
  91         static const pv::util::Timestamp MinScale;
  92
  93         static const int MaxScrollValue;
  94         static const int MaxViewAutoUpdateRate;
  95
  96         static const int ScaleUnits[3];
  97
  98 public:
  99         explicit View(Session &session, bool is_main_view=false, QWidget *parent = 0);
 100
 101         Session& session();
 102         const Session& session() const;
 103
 104         /**
 105          * Returns the signals contained in this view.
 106          */
 107         unordered_set< shared_ptr<Signal> > signals() const;
 108
 109         virtual void clear_signals();
 110
 111         virtual void add_signal(const shared_ptr<Signal> signal);
 112
 113 #ifdef ENABLE_DECODE
 114         virtual void clear_decode_signals();
 115
 116         virtual void add_decode_signal(shared_ptr<data::SignalBase> signalbase);
 117
 118         virtual void remove_decode_signal(shared_ptr<data::SignalBase> signalbase);
 119 #endif
 120
 121         /**
 122          * Returns the view of the owner.
 123          */
 124         virtual View* view();
 125
 126         /**
 127          * Returns the view of the owner.
 128          */
 129         virtual const View* view() const;
 130
 131         Viewport* viewport();
 132
 133         const Viewport* viewport() const;
 134
 135         virtual void save_settings(QSettings &settings) const;
 136
 137         virtual void restore_settings(QSettings &settings);
 138
 139         /**
 140          * Gets a list of time markers.
 141          */
 142         vector< shared_ptr<TimeItem> > time_items() const;
 143
 144         /**
 145          * Returns the view time scale in seconds per pixel.
 146          */
 147         double scale() const;
 148
 149         /**
 150          * Returns the time offset of the left edge of the view in
 151          * seconds.
 152          */
 153         const pv::util::Timestamp& offset() const;
 154
 155         /**
 156          * Returns the vertical scroll offset.
 157          */
 158         int owner_visual_v_offset() const;
 159
 160         /**
 161          * Sets the visual v-offset.
 162          */
 163         void set_v_offset(int offset);
 164
 165         /**
 166          * Returns the SI prefix to apply to the graticule time markings.
 167          */
 168         pv::util::SIPrefix tick_prefix() const;
 169
 170         /**
 171          * Returns the number of fractional digits shown for the time markings.
 172          */
 173         unsigned int tick_precision() const;
 174
 175         /**
 176          * Returns period of the graticule time markings.
 177          */
 178         const pv::util::Timestamp& tick_period() const;
 179
 180         /**
 181          * Returns the unit of time currently used.
 182          */
 183         util::TimeUnit time_unit() const;
 184
 185         /**
 186          * Returns the number of nested parents that this row item owner has.
 187          */
 188         unsigned int depth() const;
 189
 190         void zoom(double steps);
 191         void zoom(double steps, int offset);
 192
 193         void zoom_fit(bool gui_state);
 194
 195         void zoom_one_to_one();
 196
 197         /**
 198          * Sets the scale and offset.
 199          * @param scale The new view scale in seconds per pixel.
 200          * @param offset The view time offset in seconds.
 201          */
 202         void set_scale_offset(double scale, const pv::util::Timestamp& offset);
 203
 204         set< shared_ptr<pv::data::SignalData> > get_visible_data() const;
 205
 206         pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
 207
 208         /**
 209          * Enables or disables coloured trace backgrounds. If they're not
 210          * coloured then they will use alternating colors.
 211          */
 212         void enable_coloured_bg(bool state);
 213
 214         /**
 215          * Enable or disable showing sampling points.
 216          */
 217         void enable_show_sampling_points(bool state);
 218
 219         /**
 220          * Returns true if cursors are displayed. false otherwise.
 221          */
 222         bool cursors_shown() const;
 223
 224         /**
 225          * Shows or hides the cursors.
 226          */
 227         void show_cursors(bool show = true);
 228
 229         /**
 230          * Moves the cursors to a convenient position in the view.
 231          */
 232         void centre_cursors();
 233
 234         /**
 235          * Returns a reference to the pair of cursors.
 236          */
 237         shared_ptr<CursorPair> cursors() const;
 238
 239         /**
 240          * Adds a new flag at a specified time.
 241          */
 242         void add_flag(const pv::util::Timestamp& time);
 243
 244         /**
 245          * Removes a flag from the list.
 246          */
 247         void remove_flag(shared_ptr<Flag> flag);
 248
 249         /**
 250          * Gets the list of flags.
 251          */
 252         vector< shared_ptr<Flag> > flags() const;
 253
 254         const QPoint& hover_point() const;
 255
 256         void restack_all_trace_tree_items();
 257
 258 Q_SIGNALS:
 259         void hover_point_changed();
 260
 261         void selection_changed();
 262
 263         /// Emitted when the offset changed.
 264         void offset_changed();
 265
 266         /// Emitted when the scale changed.
 267         void scale_changed();
 268
 269         void sticky_scrolling_changed(bool state);
 270
 271         void always_zoom_to_fit_changed(bool state);
 272
 273         /// Emitted when the tick_prefix changed.
 274         void tick_prefix_changed();
 275
 276         /// Emitted when the tick_precision changed.
 277         void tick_precision_changed();
 278
 279         /// Emitted when the tick_period changed.
 280         void tick_period_changed();
 281
 282         /// Emitted when the time_unit changed.
 283         void time_unit_changed();
 284
 285 public Q_SLOTS:
 286         void trigger_event(util::Timestamp location);
 287
 288 private:
 289         void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
 290
 291         /**
 292          * Simultaneously sets the zoom and offset.
 293          * @param scale The scale to set the view to in seconds per pixel. This
 294          * value is clamped between MinScale and MaxScale.
 295          * @param offset The offset of the left edge of the view in seconds.
 296          */
 297         void set_zoom(double scale, int offset);
 298
 299         /**
 300          * Find a tick spacing and number formatting that does not cause
 301          * the values to collide.
 302          */
 303         void calculate_tick_spacing();
 304
 305         void update_scroll();
 306
 307         void reset_scroll();
 308
 309         void set_scroll_default();
 310
 311         void update_layout();
 312
 313         TraceTreeItemOwner* find_prevalent_trace_group(
 314                 const shared_ptr<sigrok::ChannelGroup> &group,
 315                 const unordered_map<shared_ptr<data::SignalBase>,
 316                         shared_ptr<Signal> > &signal_map);
 317
 318         static vector< shared_ptr<Trace> >
 319                 extract_new_traces_for_channels(
 320                 const vector< shared_ptr<sigrok::Channel> > &channels,
 321                 const unordered_map<shared_ptr<data::SignalBase>,
 322                         shared_ptr<Signal> > &signal_map,
 323                 set< shared_ptr<Trace> > &add_list);
 324
 325         void determine_time_unit();
 326
 327         bool eventFilter(QObject *object, QEvent *event);
 328
 329         void resizeEvent(QResizeEvent *event);
 330
 331 public:
 332         void row_item_appearance_changed(bool label, bool content);
 333         void time_item_appearance_changed(bool label, bool content);
 334
 335         void extents_changed(bool horz, bool vert);
 336
 337 private Q_SLOTS:
 338
 339         void h_scroll_value_changed(int value);
 340         void v_scroll_value_changed();
 341
 342         void signals_changed();
 343         void capture_state_updated(int state);
 344         void data_updated();
 345
 346         void perform_delayed_view_update();
 347
 348         void process_sticky_events();
 349
 350         void on_hover_point_changed();
 351
 352         /**
 353          * Sets the 'offset_' member and emits the 'offset_changed'
 354          * signal if needed.
 355          */
 356         void set_offset(const pv::util::Timestamp& offset);
 357
 358         /**
 359          * Sets the 'scale_' member and emits the 'scale_changed'
 360          * signal if needed.
 361          */
 362         void set_scale(double scale);
 363
 364         /**
 365          * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
 366          * signal if needed.
 367          */
 368         void set_tick_prefix(pv::util::SIPrefix tick_prefix);
 369
 370         /**
 371          * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
 372          * signal if needed.
 373          */
 374         void set_tick_precision(unsigned tick_precision);
 375
 376         /**
 377          * Sets the 'tick_period_' member and emits the 'tick_period_changed'
 378          * signal if needed.
 379          */
 380         void set_tick_period(const pv::util::Timestamp& tick_period);
 381
 382         /**
 383          * Sets the 'time_unit' member and emits the 'time_unit_changed'
 384          * signal if needed.
 385          */
 386         void set_time_unit(pv::util::TimeUnit time_unit);
 387
 388 private:
 389         Viewport *viewport_;
 390         Ruler *ruler_;
 391         Header *header_;
 392
 393         unordered_set< shared_ptr<Signal> > signals_;
 394
 395 #ifdef ENABLE_DECODE
 396         vector< shared_ptr<DecodeTrace> > decode_traces_;
 397 #endif
 398
 399         CustomAbstractScrollArea scrollarea_;
 400
 401         /// The view time scale in seconds per pixel.
 402         double scale_;
 403
 404         /// The view time offset in seconds.
 405         pv::util::Timestamp offset_;
 406
 407         bool updating_scroll_;
 408         bool sticky_scrolling_;
 409         bool coloured_bg_;
 410         bool always_zoom_to_fit_;
 411         QTimer delayed_view_updater_;
 412
 413         pv::util::Timestamp tick_period_;
 414         pv::util::SIPrefix tick_prefix_;
 415         unsigned int tick_precision_;
 416         util::TimeUnit time_unit_;
 417
 418         bool show_cursors_;
 419         shared_ptr<CursorPair> cursors_;
 420
 421         list< shared_ptr<Flag> > flags_;
 422         char next_flag_text_;
 423
 424         vector< shared_ptr<TriggerMarker> > trigger_markers_;
 425
 426         QPoint hover_point_;
 427
 428         unsigned int sticky_events_;
 429         QTimer lazy_event_handler_;
 430
 431         // This is true when the defaults couldn't be set due to insufficient info
 432         bool scroll_needs_defaults_;
 433
 434         // A nonzero value indicates the v offset to restore. See View::resizeEvent()
 435         int saved_v_offset_;
 436
 437         bool size_finalized_;
 438 };
 439
 440 } // namespace TraceView
 441 } // namespace views
 442 } // namespace pv
 443
 444 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP