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
  33 #include <pv/binding/decoder.hpp>
  34 #include <pv/data/decode/row.hpp>
  35 #include <pv/data/signalbase.hpp>
  36
  37 using std::list;
  38 using std::map;
  39 using std::pair;
  40 using std::shared_ptr;
  41 using std::vector;
  42
  43 struct srd_channel;
  44 struct srd_decoder;
  45
  46 class QComboBox;
  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 }
  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 DecodeColours[4];
  77         static const QColor ErrorBgColour;
  78         static const QColor NoDecodeColour;
  79
  80         static const int ArrowSize;
  81         static const double EndCapWidth;
  82         static const int RowTitleMargin;
  83         static const int DrawPadding;
  84
  85         static const QColor Colours[16];
  86         static const QColor OutlineColours[16];
  87
  88 public:
  89         DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
  90                 int index);
  91
  92         bool enabled() const;
  93
  94         shared_ptr<data::SignalBase> base() const;
  95
  96         /**
  97          * Computes the vertical extents of the contents of this row item.
  98          * @return A pair containing the minimum and maximum y-values.
  99          */
 100         pair<int, int> v_extents() const;
 101
 102         /**
 103          * Paints the background layer of the trace with a QPainter
 104          * @param p the QPainter to paint into.
 105          * @param pp the painting parameters object to paint with..
 106          */
 107         void paint_back(QPainter &p, ViewItemPaintParams &pp);
 108
 109         /**
 110          * Paints the mid-layer of the trace with a QPainter
 111          * @param p the QPainter to paint into.
 112          * @param pp the painting parameters object to paint with.
 113          */
 114         void paint_mid(QPainter &p, ViewItemPaintParams &pp);
 115
 116         /**
 117          * Paints the foreground layer of the trace with a QPainter
 118          * @param p the QPainter to paint into.
 119          * @param pp the painting parameters object to paint with.
 120          */
 121         void paint_fore(QPainter &p, ViewItemPaintParams &pp);
 122
 123         void populate_popup_form(QWidget *parent, QFormLayout *form);
 124
 125         QMenu* create_context_menu(QWidget *parent);
 126
 127         void delete_pressed();
 128
 129 private:
 130         void draw_annotations(vector<pv::data::decode::Annotation> annotations,
 131                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
 132                 size_t base_colour, int row_title_width);
 133
 134         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
 135                 int h, const ViewItemPaintParams &pp, int y,
 136                 size_t base_colour, int row_title_width) const;
 137
 138         void draw_annotation_block(vector<pv::data::decode::Annotation> annotations,
 139                 QPainter &p, int h, int y, size_t base_colour) const;
 140
 141         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 142                 int h, double x, int y) const;
 143
 144         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 145                 int h, double start, double end, int y, const ViewItemPaintParams &pp,
 146                 int row_title_width) const;
 147
 148         void draw_error(QPainter &p, const QString &message,
 149                 const ViewItemPaintParams &pp);
 150
 151         void draw_unresolved_period(QPainter &p, int h, int left,
 152                 int right) const;
 153
 154         pair<double, double> get_pixels_offset_samples_per_pixel() const;
 155
 156         /**
 157          * Determines the start and end sample for a given pixel range.
 158          * @param x_start the X coordinate of the start sample in the view
 159          * @param x_end the X coordinate of the end sample in the view
 160          * @return Returns a pair containing the start sample and the end
 161          *      sample that correspond to the start and end coordinates.
 162          */
 163         pair<uint64_t, uint64_t> get_sample_range(int x_start, int x_end) 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         void hover_point_changed();
 180
 181 private Q_SLOTS:
 182         void on_new_annotations();
 183
 184         void on_delete();
 185
 186         void on_channel_selected(int);
 187
 188         void on_channels_updated();
 189
 190         void on_init_state_changed(int);
 191
 192         void on_stack_decoder(srd_decoder *decoder);
 193
 194         void on_delete_decoder(int index);
 195
 196         void on_show_hide_decoder(int index);
 197
 198 private:
 199         pv::Session &session_;
 200         shared_ptr<data::DecodeSignal> decode_signal_;
 201
 202         vector<data::decode::Row> visible_rows_;
 203         uint64_t decode_start_, decode_end_;
 204
 205         map<QComboBox*, uint16_t> channel_id_map_;  // channel selector -> decode channel ID
 206         map<QComboBox*, uint16_t> init_state_map_;  // init state selector -> decode channel ID
 207         list< shared_ptr<pv::binding::Decoder> > bindings_;
 208
 209         vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 210
 211         map<data::decode::Row, int> row_title_widths_;
 212         int row_height_, max_visible_rows_;
 213
 214         int min_useful_label_width_;
 215
 216         QSignalMapper delete_mapper_, show_hide_mapper_;
 217 };
 218
 219 } // namespace trace
 220 } // namespace views
 221 } // namespace pv
 222
 223 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP