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