pv/views/trace/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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
  22
  23 #include "trace.hpp"
  24
  25 #include <list>
  26 #include <map>
  27 #include <memory>
  28 #include <vector>
  29
  30 #include <QColor>
  31 #include <QComboBox>
  32 #include <QSignalMapper>
  33 #include <QTimer>
  34
  35 #include <pv/binding/decoder.hpp>
  36 #include <pv/data/decode/row.hpp>
  37 #include <pv/data/signalbase.hpp>
  38
  39 using std::list;
  40 using std::map;
  41 using std::pair;
  42 using std::shared_ptr;
  43 using std::vector;
  44
  45 struct srd_channel;
  46 struct srd_decoder;
  47
  48 namespace pv {
  49
  50 class Session;
  51
  52 namespace data {
  53 struct DecodeChannel;
  54 class DecodeSignal;
  55
  56 namespace decode {
  57 class Decoder;
  58 }
  59 }  // namespace data
  60
  61 namespace widgets {
  62 class DecoderGroupBox;
  63 }
  64
  65 namespace views {
  66 namespace trace {
  67
  68 class DecodeTrace : public Trace
  69 {
  70         Q_OBJECT
  71
  72 private:
  73         static const QColor ErrorBgColor;
  74         static const QColor NoDecodeColor;
  75
  76         static const int ArrowSize;
  77         static const double EndCapWidth;
  78         static const int RowTitleMargin;
  79         static const int DrawPadding;
  80
  81         static const int MaxTraceUpdateRate;
  82
  83 public:
  84         DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
  85                 int index);
  86
  87         bool enabled() const;
  88
  89         shared_ptr<data::SignalBase> base() const;
  90
  91         /**
  92          * Computes the vertical extents of the contents of this row item.
  93          * @return A pair containing the minimum and maximum y-values.
  94          */
  95         pair<int, int> v_extents() const;
  96
  97         /**
  98          * Paints the background layer of the trace with a QPainter
  99          * @param p the QPainter to paint into.
 100          * @param pp the painting parameters object to paint with..
 101          */
 102         void paint_back(QPainter &p, ViewItemPaintParams &pp);
 103
 104         /**
 105          * Paints the mid-layer of the trace with a QPainter
 106          * @param p the QPainter to paint into.
 107          * @param pp the painting parameters object to paint with.
 108          */
 109         void paint_mid(QPainter &p, ViewItemPaintParams &pp);
 110
 111         /**
 112          * Paints the foreground layer of the trace with a QPainter
 113          * @param p the QPainter to paint into.
 114          * @param pp the painting parameters object to paint with.
 115          */
 116         void paint_fore(QPainter &p, ViewItemPaintParams &pp);
 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_annotations(vector<pv::data::decode::Annotation> annotations,
 126                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
 127                 QColor row_color, int row_title_width);
 128
 129         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
 130                 int h, const ViewItemPaintParams &pp, int y,
 131                 QColor row_color, int row_title_width) const;
 132
 133         void draw_annotation_block(vector<pv::data::decode::Annotation> annotations,
 134                 QPainter &p, int h, int y, QColor row_color) const;
 135
 136         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 137                 int h, double x, int y) const;
 138
 139         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 140                 int h, double start, double end, int y, const ViewItemPaintParams &pp,
 141                 int row_title_width) const;
 142
 143         void draw_error(QPainter &p, const QString &message,
 144                 const ViewItemPaintParams &pp);
 145
 146         void draw_unresolved_period(QPainter &p, int h, int left,
 147                 int right) const;
 148
 149         pair<double, double> get_pixels_offset_samples_per_pixel() const;
 150
 151         /**
 152          * Determines the start and end sample for a given pixel range.
 153          * @param x_start the X coordinate of the start sample in the view
 154          * @param x_end the X coordinate of the end sample in the view
 155          * @return Returns a pair containing the start sample and the end
 156          *      sample that correspond to the start and end coordinates.
 157          */
 158         pair<uint64_t, uint64_t> get_sample_range(int x_start, int x_end) const;
 159
 160         QColor get_row_color(int row_index) const;
 161         QColor get_annotation_color(QColor row_color, int annotation_index) const;
 162
 163         int get_row_at_point(const QPoint &point);
 164
 165         const QString get_annotation_at_point(const QPoint &point);
 166
 167         void create_decoder_form(int index,
 168                 shared_ptr<pv::data::decode::Decoder> &dec,
 169                 QWidget *parent, QFormLayout *form);
 170
 171         QComboBox* create_channel_selector(QWidget *parent,
 172                 const data::DecodeChannel *ch);
 173         QComboBox* create_channel_selector_init_state(QWidget *parent,
 174                 const data::DecodeChannel *ch);
 175
 176 public:
 177         void hover_point_changed(const QPoint &hp);
 178
 179 private Q_SLOTS:
 180         void on_new_annotations();
 181         void on_delayed_trace_update();
 182         void on_decode_reset();
 183         void on_decode_finished();
 184
 185         void on_delete();
 186
 187         void on_channel_selected(int);
 188
 189         void on_channels_updated();
 190
 191         void on_init_state_changed(int);
 192
 193         void on_stack_decoder(srd_decoder *decoder);
 194
 195         void on_delete_decoder(int index);
 196
 197         void on_show_hide_decoder(int index);
 198
 199 private:
 200         pv::Session &session_;
 201         shared_ptr<data::DecodeSignal> decode_signal_;
 202
 203         vector<data::decode::Row> visible_rows_;
 204         uint64_t decode_start_, decode_end_;
 205
 206         map<QComboBox*, uint16_t> channel_id_map_;  // channel selector -> decode channel ID
 207         map<QComboBox*, uint16_t> init_state_map_;  // init state selector -> decode channel ID
 208         list< shared_ptr<pv::binding::Decoder> > bindings_;
 209
 210         vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 211
 212         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         QTimer delayed_trace_updater_;
 220 };
 221
 222 } // namespace trace
 223 } // namespace views
 224 } // namespace pv
 225
 226 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP