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