pv/view/decodetrace.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_DECODETRACE_H
  22 #define PULSEVIEW_PV_VIEW_DECODETRACE_H
  23
  24 #include "trace.hpp"
  25
  26 #include <list>
  27 #include <map>
  28 #include <memory>
  29
  30 #include <QSignalMapper>
  31
  32 #include <pv/prop/binding/decoderoptions.hpp>
  33 #include <pv/data/decode/row.hpp>
  34
  35 struct srd_channel;
  36 struct srd_decoder;
  37
  38 class QComboBox;
  39
  40 namespace pv {
  41
  42 class SigSession;
  43
  44 namespace data {
  45 class DecoderStack;
  46
  47 namespace decode {
  48 class Annotation;
  49 class Decoder;
  50 class Row;
  51 }
  52 }
  53
  54 namespace widgets {
  55 class DecoderGroupBox;
  56 }
  57
  58 namespace view {
  59
  60 class DecodeTrace : public Trace
  61 {
  62         Q_OBJECT
  63
  64 private:
  65         struct ChannelSelector
  66         {
  67                 const QComboBox *combo_;
  68                 const std::shared_ptr<pv::data::decode::Decoder> decoder_;
  69                 const srd_channel *pdch_;
  70         };
  71
  72 private:
  73         static const QColor DecodeColours[4];
  74         static const QColor ErrorBgColour;
  75         static const QColor NoDecodeColour;
  76
  77         static const int ArrowSize;
  78         static const double EndCapWidth;
  79         static const int DrawPadding;
  80
  81         static const QColor Colours[16];
  82         static const QColor OutlineColours[16];
  83
  84 public:
  85         DecodeTrace(pv::SigSession &session,
  86                 std::shared_ptr<pv::data::DecoderStack> decoder_stack,
  87                 int index);
  88
  89         bool enabled() const;
  90
  91         const std::shared_ptr<pv::data::DecoderStack>& decoder() const;
  92
  93         /**
  94          * Computes the vertical extents of the contents of this row item.
  95          * @return A pair containing the minimum and maximum y-values.
  96          */
  97         std::pair<int, int> v_extents() const;
  98
  99         /**
 100          * Paints the background layer of the trace with a QPainter
 101          * @param p the QPainter to paint into.
 102          * @param left the x-coordinate of the left edge of the signal.
 103          * @param right the x-coordinate of the right edge of the signal.
 104          **/
 105         void paint_back(QPainter &p, int left, int right);
 106
 107         /**
 108          * Paints the mid-layer of the trace with a QPainter
 109          * @param p the QPainter to paint into.
 110          * @param left the x-coordinate of the left edge of the signal
 111          * @param right the x-coordinate of the right edge of the signal
 112          **/
 113         void paint_mid(QPainter &p, int left, int right);
 114
 115         /**
 116          * Paints the foreground layer of the trace with a QPainter
 117          * @param p the QPainter to paint into.
 118          * @param left the x-coordinate of the left edge of the signal
 119          * @param right the x-coordinate of the right edge of the signal
 120          **/
 121         void paint_fore(QPainter &p, int left, int right);
 122
 123         void populate_popup_form(QWidget *parent, QFormLayout *form);
 124
 125         QMenu* create_context_menu(QWidget *parent);
 126
 127         void delete_pressed();
 128
 129 private:
 130         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
 131                 QColor text_colour, int text_height, int left, int right, int y,
 132                 size_t base_colour) const;
 133
 134         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 135                 QColor fill, QColor outline, QColor text_color, int h, double x,
 136                 int y) const;
 137
 138         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 139                 QColor fill, QColor outline, QColor text_color, int h, double start,
 140                 double end, int y) const;
 141
 142         void draw_error(QPainter &p, const QString &message,
 143                 int left, int right);
 144
 145         void draw_unresolved_period(QPainter &p, int h, int left,
 146                 int right) const;
 147
 148         std::pair<double, double> get_pixels_offset_samples_per_pixel() const;
 149
 150         /**
 151          * Determines the start and end sample for a given pixel range.
 152          * @param x_start the X coordinate of the start sample in the view
 153          * @param x_end the X coordinate of the end sample in the view
 154          * @return Returns a pair containing the start sample and the end
 155          *      sample that correspond to the start and end coordinates.
 156          */
 157         std::pair<uint64_t, uint64_t> get_sample_range(int x_start, int x_end) const;
 158
 159         int get_row_at_point(const QPoint &point);
 160
 161         const QString get_annotation_at_point(const QPoint &point);
 162
 163         void hide_hover_annotation();
 164
 165         void create_decoder_form(int index,
 166                 std::shared_ptr<pv::data::decode::Decoder> &dec,
 167                 QWidget *parent, QFormLayout *form);
 168
 169         QComboBox* create_channel_selector(QWidget *parent,
 170                 const std::shared_ptr<pv::data::decode::Decoder> &dec,
 171                 const srd_channel *const pdch);
 172
 173         void commit_decoder_channels(
 174                 std::shared_ptr<data::decode::Decoder> &dec);
 175
 176         void commit_channels();
 177
 178 public:
 179         void hover_point_changed();
 180
 181 private Q_SLOTS:
 182         void on_new_decode_data();
 183
 184         void on_delete();
 185
 186         void on_channel_selected(int);
 187
 188         void on_stack_decoder(srd_decoder *decoder);
 189
 190         void on_delete_decoder(int index);
 191
 192         void on_show_hide_decoder(int index);
 193
 194 private:
 195         pv::SigSession &session_;
 196         std::shared_ptr<pv::data::DecoderStack> decoder_stack_;
 197
 198         uint64_t decode_start_, decode_end_;
 199
 200         std::list< std::shared_ptr<pv::prop::binding::DecoderOptions> >
 201                 bindings_;
 202
 203         std::list<ChannelSelector> channel_selectors_;
 204         std::vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 205
 206         std::vector<data::decode::Row> visible_rows_;
 207         int text_height_, row_height_;
 208
 209         QSignalMapper delete_mapper_, show_hide_mapper_;
 210 };
 211
 212 } // namespace view
 213 } // namespace pv
 214
 215 #endif // PULSEVIEW_PV_VIEW_DECODETRACE_H