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