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         int owner_visual_v_offset() const;
 106
 107         /**
 108          * Returns the SI prefix to apply to the graticule time markings.
 109          */
 110         unsigned int tick_prefix() const;
 111
 112         /**
 113          * Returns period of the graticule time markings.
 114          */
 115         double tick_period() const;
 116
 117         /**
 118          * Returns the number of nested parents that this row item owner has.
 119          */
 120         unsigned int depth() const;
 121
 122         void zoom(double steps);
 123         void zoom(double steps, int offset);
 124
 125         void zoom_fit();
 126
 127         void zoom_one_to_one();
 128
 129         /**
 130          * Sets the scale and offset.
 131          * @param scale The new view scale in seconds per pixel.
 132          * @param offset The view time offset in seconds.
 133          */
 134         void set_scale_offset(double scale, double offset);
 135
 136         std::set< std::shared_ptr<pv::data::SignalData> >
 137                 get_visible_data() const;
 138
 139         std::pair<double, double> get_time_extents() const;
 140
 141         /**
 142          * Returns true if cursors are displayed. false otherwise.
 143          */
 144         bool cursors_shown() const;
 145
 146         /**
 147          * Shows or hides the cursors.
 148          */
 149         void show_cursors(bool show = true);
 150
 151         /**
 152          * Moves the cursors to a convenient position in the view.
 153          */
 154         void centre_cursors();
 155
 156         /**
 157          * Returns a reference to the pair of cursors.
 158          */
 159         std::shared_ptr<CursorPair> cursors() const;
 160
 161         /**
 162          * Adds a new flag at a specified time.
 163          */
 164         void add_flag(double time);
 165
 166         /**
 167          * Removes a flag from the list.
 168          */
 169         void remove_flag(std::shared_ptr<Flag> flag);
 170
 171         /**
 172          * Gets the list of flags.
 173          */
 174         std::vector< std::shared_ptr<Flag> > flags() const;
 175
 176         const QPoint& hover_point() const;
 177
 178         void update_viewport();
 179
 180         void restack_all_row_items();
 181
 182 Q_SIGNALS:
 183         void hover_point_changed();
 184
 185         void selection_changed();
 186
 187         void scale_offset_changed();
 188
 189 private:
 190         void get_scroll_layout(double &length, double &offset) const;
 191
 192         /**
 193          * Simultaneously sets the zoom and offset.
 194          * @param scale The scale to set the view to in seconds per pixel. This
 195          * value is clamped between MinScale and MaxScale.
 196          * @param offset The offset of the left edge of the view in seconds.
 197          */
 198         void set_zoom(double scale, int offset);
 199
 200         /**
 201          * Find a tick spacing and number formatting that does not cause
 202          * the values to collide.
 203          */
 204         void calculate_tick_spacing();
 205
 206         void update_scroll();
 207
 208         void update_layout();
 209
 210         /**
 211          * Satisifies RowItem functionality.
 212          * @param p the QPainter to paint into.
 213          * @param rect the rectangle of the header area.
 214          * @param hover true if the label is being hovered over by the mouse.
 215          */
 216         void paint_label(QPainter &p, const QRect &rect, bool hover);
 217
 218         /**
 219          * Computes the outline rectangle of a label.
 220          * @param rect the rectangle of the header area.
 221          * @return Returns the rectangle of the signal label.
 222          */
 223         QRectF label_rect(const QRectF &rect);
 224
 225         static bool add_channels_to_owner(
 226                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
 227                 RowItemOwner *owner, int &offset,
 228                 std::unordered_map<std::shared_ptr<sigrok::Channel>,
 229                         std::shared_ptr<Signal> > &signal_map,
 230                 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
 231                         std::function<bool (std::shared_ptr<RowItem>)>());
 232
 233         static void apply_offset(
 234                 std::shared_ptr<RowItem> row_item, int &offset);
 235
 236 private:
 237         bool eventFilter(QObject *object, QEvent *event);
 238
 239         bool viewportEvent(QEvent *e);
 240
 241         void resizeEvent(QResizeEvent *e);
 242
 243 public:
 244         void row_item_appearance_changed(bool label, bool content);
 245         void time_item_appearance_changed(bool label, bool content);
 246
 247         void extents_changed(bool horz, bool vert);
 248
 249 private Q_SLOTS:
 250
 251         void h_scroll_value_changed(int value);
 252         void v_scroll_value_changed(int value);
 253
 254         void signals_changed();
 255         void data_updated();
 256
 257         void process_sticky_events();
 258
 259         void on_hover_point_changed();
 260
 261 private:
 262         Session &session_;
 263
 264         Viewport *viewport_;
 265         Ruler *ruler_;
 266         Header *header_;
 267
 268         /// The view time scale in seconds per pixel.
 269         double scale_;
 270
 271         /// The view time offset in seconds.
 272         double offset_;
 273
 274         int v_offset_;
 275         bool updating_scroll_;
 276
 277         double tick_period_;
 278         unsigned int tick_prefix_;
 279
 280         bool show_cursors_;
 281         std::shared_ptr<CursorPair> cursors_;
 282
 283         std::list< std::shared_ptr<Flag> > flags_;
 284         char next_flag_text_;
 285
 286         QPoint hover_point_;
 287
 288         unsigned int sticky_events_;
 289         QTimer lazy_event_handler_;
 290 };
 291
 292 } // namespace view
 293 } // namespace pv
 294
 295 #endif // PULSEVIEW_PV_VIEW_VIEW_H