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/decoder.hpp>
  38 #include <pv/data/decode/annotation.hpp>
  39 #include <pv/data/decode/row.hpp>
  40 #include <pv/data/signalbase.hpp>
  41
  42 using std::list;
  43 using std::map;
  44 using std::pair;
  45 using std::shared_ptr;
  46 using std::vector;
  47
  48 struct srd_channel;
  49 struct srd_decoder;
  50
  51 namespace pv {
  52
  53 class Session;
  54
  55 namespace data {
  56 struct DecodeChannel;
  57 class DecodeSignal;
  58
  59 namespace decode {
  60 class Decoder;
  61 }
  62 }  // namespace data
  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 ErrorBgColor;
  77         static const QColor NoDecodeColor;
  78
  79         static const int ArrowSize;
  80         static const double EndCapWidth;
  81         static const int RowTitleMargin;
  82         static const int DrawPadding;
  83
  84         static const int MaxTraceUpdateRate;
  85
  86 public:
  87         DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
  88                 int index);
  89
  90         ~DecodeTrace();
  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_header_context_menu(QWidget *parent);
 126
 127         virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
 128
 129         void delete_pressed();
 130
 131 private:
 132         void draw_annotations(vector<pv::data::decode::Annotation> annotations,
 133                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
 134                 QColor row_color, int row_title_width);
 135
 136         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
 137                 int h, const ViewItemPaintParams &pp, int y,
 138                 QColor row_color, int row_title_width) const;
 139
 140         void draw_annotation_block(qreal start, qreal end,
 141                 pv::data::decode::Annotation::Class ann_class, bool use_ann_format,
 142                 QPainter &p, int h, int y, QColor row_color) const;
 143
 144         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
 145                 int h, qreal x, int y) const;
 146
 147         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
 148                 int h, qreal start, qreal 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_view_sample_range(int x_start, int x_end) const;
 167
 168         QColor get_row_color(int row_index) const;
 169         QColor get_annotation_color(QColor row_color, int annotation_index) const;
 170
 171         int get_row_at_point(const QPoint &point);
 172
 173         const QString get_annotation_at_point(const QPoint &point);
 174
 175         void update_stack_button();
 176
 177         void create_decoder_form(int index,
 178                 shared_ptr<pv::data::decode::Decoder> &dec,
 179                 QWidget *parent, QFormLayout *form);
 180
 181         QComboBox* create_channel_selector(QWidget *parent,
 182                 const data::decode::DecodeChannel *ch);
 183         QComboBox* create_channel_selector_init_state(QWidget *parent,
 184                 const data::decode::DecodeChannel *ch);
 185
 186         void export_annotations(vector<data::decode::Annotation> *annotations) const;
 187
 188 public:
 189         virtual void hover_point_changed(const QPoint &hp);
 190
 191 private Q_SLOTS:
 192         void on_setting_changed(const QString &key, const QVariant &value);
 193
 194         void on_new_annotations();
 195         void on_delayed_trace_update();
 196         void on_decode_reset();
 197         void on_decode_finished();
 198         void on_pause_decode();
 199
 200         void on_delete();
 201
 202         void on_channel_selected(int);
 203
 204         void on_channels_updated();
 205
 206         void on_init_state_changed(int);
 207
 208         void on_stack_decoder(srd_decoder *decoder);
 209
 210         void on_delete_decoder(int index);
 211
 212         void on_show_hide_decoder(int index);
 213
 214         void on_copy_annotation_to_clipboard();
 215
 216         void on_export_row();
 217         void on_export_all_rows();
 218         void on_export_row_with_cursor();
 219         void on_export_all_rows_with_cursor();
 220         void on_export_row_from_here();
 221         void on_export_all_rows_from_here();
 222
 223 private:
 224         pv::Session &session_;
 225         shared_ptr<data::DecodeSignal> decode_signal_;
 226
 227         vector<data::decode::Row> visible_rows_;
 228         bool always_show_all_rows_;
 229
 230         map<QComboBox*, uint16_t> channel_id_map_;  // channel selector -> decode channel ID
 231         map<QComboBox*, uint16_t> init_state_map_;  // init state selector -> decode channel ID
 232         list< shared_ptr<pv::binding::Decoder> > bindings_;
 233
 234         data::decode::Row *selected_row_;
 235         pair<uint64_t, uint64_t> selected_sample_range_;
 236
 237         vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
 238         QPushButton* stack_button_;
 239
 240         map<data::decode::Row, int> row_title_widths_;
 241         int row_height_, max_visible_rows_;
 242
 243         int min_useful_label_width_;
 244
 245         QSignalMapper delete_mapper_, show_hide_mapper_;
 246
 247         QTimer delayed_trace_updater_;
 248 };
 249
 250 } // namespace trace
 251 } // namespace views
 252 } // namespace pv
 253
 254 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP