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