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 class SignalBase;
  54 struct DecodeChannel;
  55 class DecodeSignal;
  56
  57 namespace decode {
  58 class Annotation;
  59 class Decoder;
  60 class Row;
  61 }
  62 }  // namespace data
  63
  64 namespace widgets {
  65 class DecoderGroupBox;
  66 }
  67
  68 namespace views {
  69 namespace trace {
  70
  71 class DecodeTrace : public Trace
  72 {
  73         Q_OBJECT
  74
  75 private:
  76         static const QColor ErrorBgColor;
  77         static const QColor NoDecodeColor;
  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 int MaxTraceUpdateRate;
  85
  86 public:
  87         DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
  88                 int index);
  89
  90         bool enabled() const;
  91
  92         shared_ptr<data::SignalBase> base() const;
  93
  94         /**
  95          * Computes the vertical extents of the contents of this row item.
  96          * @return A pair containing the minimum and maximum y-values.
  97          */
  98         pair<int, int> v_extents() const;
  99
 100         /**
 101          * Paints the background layer of the trace with a QPainter
 102          * @param p the QPainter to paint into.
 103          * @param pp the painting parameters object to paint with..
 104          */
 105         void paint_back(QPainter &p, ViewItemPaintParams &pp);
 106
 107         /**
 108          * Paints the mid-layer of the trace with a QPainter
 109          * @param p the QPainter to paint into.
 110          * @param pp the painting parameters object to paint with.
 111          */
 112         void paint_mid(QPainter &p, ViewItemPaintParams &pp);
 113
 114         /**
 115          * Paints the foreground layer of the trace with a QPainter
 116          * @param p the QPainter to paint into.
 117          * @param pp the painting parameters object to paint with.
 118          */
 119         void paint_fore(QPainter &p, ViewItemPaintParams &pp);
 120
 121         void populate_popup_form(QWidget *parent, QFormLayout *form);
 122
 123         QMenu* create_context_menu(QWidget *parent);
 124
 125         void delete_pressed();
 126
 127 private:
 128         void draw_annotations(vector<pv::data::decode::Annotation> annotations,
 129                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
 130                 QColor row_color, int row_title_width);
 131
 132         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
 133                 int h, const ViewItemPaintParams &pp, int y,
 134                 QColor row_color, int row_title_width) const;
 135
 136         void draw_annotation_block(vector<pv::data::decode::Annotation> annotations,
 137                 QPainter &p, int h, int y, QColor row_color) const;
 138
 139         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 140                 int h, double x, int y) const;
 141
 142         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 143                 int h, double start, double end, int y, const ViewItemPaintParams &pp,
 144                 int row_title_width) const;
 145
 146         void draw_error(QPainter &p, const QString &message,
 147                 const ViewItemPaintParams &pp);
 148
 149         void draw_unresolved_period(QPainter &p, int h, int left,
 150                 int right) const;
 151
 152         pair<double, double> get_pixels_offset_samples_per_pixel() const;
 153
 154         /**
 155          * Determines the start and end sample for a given pixel range.
 156          * @param x_start the X coordinate of the start sample in the view
 157          * @param x_end the X coordinate of the end sample in the view
 158          * @return Returns a pair containing the start sample and the end
 159          *      sample that correspond to the start and end coordinates.
 160          */
 161         pair<uint64_t, uint64_t> get_sample_range(int x_start, int x_end) const;
 162
 163         QColor get_row_color(int row_index) const;
 164         QColor get_annotation_color(QColor row_color, int annotation_index) const;
 165
 166         int get_row_at_point(const QPoint &point);
 167
 168         const QString get_annotation_at_point(const QPoint &point);
 169
 170         void create_decoder_form(int index,
 171                 shared_ptr<pv::data::decode::Decoder> &dec,
 172                 QWidget *parent, QFormLayout *form);
 173
 174         QComboBox* create_channel_selector(QWidget *parent,
 175                 const data::DecodeChannel *ch);
 176         QComboBox* create_channel_selector_init_state(QWidget *parent,
 177                 const data::DecodeChannel *ch);
 178
 179 public:
 180         void hover_point_changed(const QPoint &hp);
 181
 182 private Q_SLOTS:
 183         void on_new_annotations();
 184         void on_delayed_trace_update();
 185         void on_decode_reset();
 186         void on_decode_finished();
 187
 188         void on_delete();
 189
 190         void on_channel_selected(int);
 191
 192         void on_channels_updated();
 193
 194         void on_init_state_changed(int);
 195
 196         void on_stack_decoder(srd_decoder *decoder);
 197
 198         void on_delete_decoder(int index);
 199
 200         void on_show_hide_decoder(int index);
 201
 202 private:
 203         pv::Session &session_;
 204         shared_ptr<data::DecodeSignal> decode_signal_;
 205
 206         vector<data::decode::Row> visible_rows_;
 207         uint64_t decode_start_, decode_end_;
 208
 209         map<QComboBox*, uint16_t> channel_id_map_;  // channel selector -> decode channel ID
 210         map<QComboBox*, uint16_t> init_state_map_;  // init state selector -> decode channel ID
 211         list< shared_ptr<pv::binding::Decoder> > bindings_;
 212
 213         vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 214
 215         map<data::decode::Row, int> row_title_widths_;
 216         int row_height_, max_visible_rows_;
 217
 218         int min_useful_label_width_;
 219
 220         QSignalMapper delete_mapper_, show_hide_mapper_;
 221
 222         QTimer delayed_trace_updater_;
 223 };
 224
 225 } // namespace trace
 226 } // namespace views
 227 } // namespace pv
 228
 229 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP