pv/view/decodetrace.h

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