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