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