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_H
  22 #define PULSEVIEW_PV_VIEW_VIEW_H
  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
  38 #include "cursorpair.hpp"
  39 #include "flag.hpp"
  40 #include "rowitemowner.hpp"
  41
  42 namespace pv {
  43
  44 class Session;
  45
  46 namespace view {
  47
  48 class CursorHeader;
  49 class Header;
  50 class Ruler;
  51 class Viewport;
  52
  53 class View : public QAbstractScrollArea, public RowItemOwner {
  54         Q_OBJECT
  55
  56 private:
  57         enum StickyEvents {
  58                 RowItemHExtentsChanged = 1,
  59                 RowItemVExtentsChanged = 2
  60         };
  61
  62 private:
  63         static const double MaxScale;
  64         static const double MinScale;
  65
  66         static const int MaxScrollValue;
  67
  68         static const int ScaleUnits[3];
  69
  70 public:
  71         explicit View(Session &session, QWidget *parent = 0);
  72
  73         Session& session();
  74         const Session& session() const;
  75
  76         /**
  77          * Returns the view of the owner.
  78          */
  79         virtual pv::view::View* view();
  80
  81         /**
  82          * Returns the view of the owner.
  83          */
  84         virtual const pv::view::View* view() const;
  85
  86         Viewport* viewport();
  87
  88         const Viewport* viewport() const;
  89
  90         /**
  91          * Gets a list of time markers.
  92          */
  93         std::vector< std::shared_ptr<TimeItem> > time_items() const;
  94
  95         /**
  96          * Returns the view time scale in seconds per pixel.
  97          */
  98         double scale() const;
  99
 100         /**
 101          * Returns the time offset of the left edge of the view in
 102          * seconds.
 103          */
 104         double offset() const;
 105
 106         /**
 107          * Returns the vertical scroll offset.
 108          */
 109         int owner_visual_v_offset() const;
 110
 111         /**
 112          * Returns the SI prefix to apply to the graticule time markings.
 113          */
 114         unsigned int tick_prefix() const;
 115
 116         /**
 117          * Returns period of the graticule time markings.
 118          */
 119         double tick_period() const;
 120
 121         /**
 122          * Returns the number of nested parents that this row item owner has.
 123          */
 124         unsigned int depth() const;
 125
 126         void zoom(double steps);
 127         void zoom(double steps, int offset);
 128
 129         void zoom_fit();
 130
 131         void zoom_one_to_one();
 132
 133         /**
 134          * Sets the scale and offset.
 135          * @param scale The new view scale in seconds per pixel.
 136          * @param offset The view time offset in seconds.
 137          */
 138         void set_scale_offset(double scale, double offset);
 139
 140         std::set< std::shared_ptr<pv::data::SignalData> >
 141                 get_visible_data() const;
 142
 143         std::pair<double, double> get_time_extents() const;
 144
 145         /**
 146          * Returns true if cursors are displayed. false otherwise.
 147          */
 148         bool cursors_shown() const;
 149
 150         /**
 151          * Shows or hides the cursors.
 152          */
 153         void show_cursors(bool show = true);
 154
 155         /**
 156          * Moves the cursors to a convenient position in the view.
 157          */
 158         void centre_cursors();
 159
 160         /**
 161          * Returns a reference to the pair of cursors.
 162          */
 163         std::shared_ptr<CursorPair> cursors() const;
 164
 165         /**
 166          * Adds a new flag at a specified time.
 167          */
 168         void add_flag(double time);
 169
 170         /**
 171          * Removes a flag from the list.
 172          */
 173         void remove_flag(std::shared_ptr<Flag> flag);
 174
 175         /**
 176          * Gets the list of flags.
 177          */
 178         std::vector< std::shared_ptr<Flag> > flags() const;
 179
 180         const QPoint& hover_point() const;
 181
 182         void update_viewport();
 183
 184         void restack_all_row_items();
 185
 186 Q_SIGNALS:
 187         void hover_point_changed();
 188
 189         void selection_changed();
 190
 191         void scale_offset_changed();
 192
 193 private:
 194         void get_scroll_layout(double &length, double &offset) const;
 195
 196         /**
 197          * Simultaneously sets the zoom and offset.
 198          * @param scale The scale to set the view to in seconds per pixel. This
 199          * value is clamped between MinScale and MaxScale.
 200          * @param offset The offset of the left edge of the view in seconds.
 201          */
 202         void set_zoom(double scale, int offset);
 203
 204         /**
 205          * Find a tick spacing and number formatting that does not cause
 206          * the values to collide.
 207          */
 208         void calculate_tick_spacing();
 209
 210         void update_scroll();
 211
 212         void update_layout();
 213
 214         /**
 215          * Satisifies RowItem functionality.
 216          * @param p the QPainter to paint into.
 217          * @param rect the rectangle of the header area.
 218          * @param hover true if the label is being hovered over by the mouse.
 219          */
 220         void paint_label(QPainter &p, const QRect &rect, bool hover);
 221
 222         /**
 223          * Computes the outline rectangle of a label.
 224          * @param rect the rectangle of the header area.
 225          * @return Returns the rectangle of the signal label.
 226          */
 227         QRectF label_rect(const QRectF &rect);
 228
 229         static bool add_channels_to_owner(
 230                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
 231                 RowItemOwner *owner, int &offset,
 232                 std::unordered_map<std::shared_ptr<sigrok::Channel>,
 233                         std::shared_ptr<Signal> > &signal_map,
 234                 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
 235                         std::function<bool (std::shared_ptr<RowItem>)>());
 236
 237         static void apply_offset(
 238                 std::shared_ptr<RowItem> row_item, int &offset);
 239
 240 private:
 241         bool eventFilter(QObject *object, QEvent *event);
 242
 243         bool viewportEvent(QEvent *e);
 244
 245         void resizeEvent(QResizeEvent *e);
 246
 247 public:
 248         void row_item_appearance_changed(bool label, bool content);
 249         void time_item_appearance_changed(bool label, bool content);
 250
 251         void extents_changed(bool horz, bool vert);
 252
 253 private Q_SLOTS:
 254
 255         void h_scroll_value_changed(int value);
 256         void v_scroll_value_changed();
 257
 258         void signals_changed();
 259         void data_updated();
 260
 261         void process_sticky_events();
 262
 263         void on_hover_point_changed();
 264
 265 private:
 266         Session &session_;
 267
 268         Viewport *viewport_;
 269         Ruler *ruler_;
 270         Header *header_;
 271
 272         /// The view time scale in seconds per pixel.
 273         double scale_;
 274
 275         /// The view time offset in seconds.
 276         double offset_;
 277
 278         bool updating_scroll_;
 279
 280         double tick_period_;
 281         unsigned int tick_prefix_;
 282
 283         bool show_cursors_;
 284         std::shared_ptr<CursorPair> cursors_;
 285
 286         std::list< std::shared_ptr<Flag> > flags_;
 287         char next_flag_text_;
 288
 289         QPoint hover_point_;
 290
 291         unsigned int sticky_events_;
 292         QTimer lazy_event_handler_;
 293 };
 294
 295 } // namespace view
 296 } // namespace pv
 297
 298 #endif // PULSEVIEW_PV_VIEW_VIEW_H