pv/view/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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
  22 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
  23
  24 #include "trace.hpp"
  25
  26 #include <list>
  27 #include <map>
  28 #include <memory>
  29 #include <vector>
  30
  31 #include <QSignalMapper>
  32
  33 #include <pv/binding/decoder.hpp>
  34 #include <pv/data/signalbase.hpp>
  35 #include <pv/data/decode/row.hpp>
  36
  37 struct srd_channel;
  38 struct srd_decoder;
  39
  40 class QComboBox;
  41
  42 namespace pv {
  43
  44 class Session;
  45
  46 namespace data {
  47 class DecoderStack;
  48 class SignalBase;
  49
  50 namespace decode {
  51 class Annotation;
  52 class Decoder;
  53 class Row;
  54 }
  55 }
  56
  57 namespace widgets {
  58 class DecoderGroupBox;
  59 }
  60
  61 namespace views {
  62 namespace TraceView {
  63
  64 class DecodeTrace : public Trace
  65 {
  66         Q_OBJECT
  67
  68 private:
  69         struct ChannelSelector
  70         {
  71                 const QComboBox *combo_;
  72                 const std::shared_ptr<pv::data::decode::Decoder> decoder_;
  73                 const srd_channel *pdch_;
  74         };
  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 QColor Colours[16];
  87         static const QColor OutlineColours[16];
  88
  89 public:
  90         DecodeTrace(pv::Session &session, std::shared_ptr<data::SignalBase> signalbase,
  91                 int index);
  92
  93         bool enabled() const;
  94
  95         const std::shared_ptr<pv::data::DecoderStack>& decoder() const;
  96
  97         std::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         std::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, const 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, const 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, const 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(std::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(std::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         std::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         std::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                 std::shared_ptr<pv::data::decode::Decoder> &dec,
 174                 QWidget *parent, QFormLayout *form);
 175
 176         QComboBox* create_channel_selector(QWidget *parent,
 177                 const std::shared_ptr<pv::data::decode::Decoder> &dec,
 178                 const srd_channel *const pdch);
 179
 180         void commit_decoder_channels(
 181                 std::shared_ptr<data::decode::Decoder> &dec);
 182
 183         void commit_channels();
 184
 185 public:
 186         void hover_point_changed();
 187
 188 private Q_SLOTS:
 189         void on_new_decode_data();
 190
 191         void on_delete();
 192
 193         void on_channel_selected(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
 204         std::vector<data::decode::Row> visible_rows_;
 205         uint64_t decode_start_, decode_end_;
 206
 207         std::list< std::shared_ptr<pv::binding::Decoder> >
 208                 bindings_;
 209
 210         std::list<ChannelSelector> channel_selectors_;
 211         std::vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 212
 213         std::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
 221 } // namespace TraceView
 222 } // namespace views
 223 } // namespace pv
 224
 225 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP