]> sigrok.org Git - pulseview.git/blame_incremental - pv/views/trace/decodetrace.hpp
Rework decoder infrastructure
[pulseview.git] / pv / views / trace / decodetrace.hpp
... / ...
CommitLineData
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 <QCheckBox>
32#include <QPolygon>
33#include <QPushButton>
34#include <QSignalMapper>
35#include <QTimer>
36
37#include <pv/binding/decoder.hpp>
38#include <pv/data/decode/decoder.hpp>
39#include <pv/data/decode/annotation.hpp>
40#include <pv/data/decode/row.hpp>
41#include <pv/data/signalbase.hpp>
42
43using std::deque;
44using std::list;
45using std::map;
46using std::mutex;
47using std::pair;
48using std::shared_ptr;
49using std::vector;
50
51using pv::data::decode::Row;
52
53struct srd_channel;
54struct srd_decoder;
55
56namespace pv {
57
58class Session;
59
60namespace data {
61struct DecodeChannel;
62class DecodeSignal;
63
64namespace decode {
65class Decoder;
66class Row;
67}
68} // namespace data
69
70namespace widgets {
71class DecoderGroupBox;
72}
73
74namespace views {
75namespace trace {
76
77struct DecodeTraceRow {
78 // When adding a field, make sure it's initialized properly in
79 // DecodeTrace::update_rows()
80
81 Row* decode_row;
82 unsigned int height, expanded_height, title_width, animation_step;
83 bool exists, currently_visible;
84 bool expand_marker_highlighted, expanding, expanded, collapsing;
85 QPolygon expand_marker_shape;
86 float anim_height, anim_shape;
87
88 QWidget* container;
89 QWidget* header_container;
90 QWidget* selector_container;
91 vector<QCheckBox*> selectors;
92};
93
94class DecodeTrace : public Trace
95{
96 Q_OBJECT
97
98private:
99 static const QColor ErrorBgColor;
100 static const QColor NoDecodeColor;
101 static const uint8_t ExpansionAreaHeaderAlpha;
102 static const uint8_t ExpansionAreaAlpha;
103
104 static const int ArrowSize;
105 static const double EndCapWidth;
106 static const int RowTitleMargin;
107 static const int DrawPadding;
108
109 static const int MaxTraceUpdateRate;
110 static const unsigned int AnimationDurationInTicks;
111
112public:
113 DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
114 int index);
115
116 ~DecodeTrace();
117
118 bool enabled() const;
119
120 shared_ptr<data::SignalBase> base() const;
121
122 /**
123 * Computes the vertical extents of the contents of this row item.
124 * @return A pair containing the minimum and maximum y-values.
125 */
126 pair<int, int> v_extents() const;
127
128 /**
129 * Paints the background layer of the trace with a QPainter
130 * @param p the QPainter to paint into.
131 * @param pp the painting parameters object to paint with..
132 */
133 void paint_back(QPainter &p, ViewItemPaintParams &pp);
134
135 /**
136 * Paints the mid-layer of the trace with a QPainter
137 * @param p the QPainter to paint into.
138 * @param pp the painting parameters object to paint with.
139 */
140 void paint_mid(QPainter &p, ViewItemPaintParams &pp);
141
142 /**
143 * Paints the foreground layer of the trace with a QPainter
144 * @param p the QPainter to paint into.
145 * @param pp the painting parameters object to paint with.
146 */
147 void paint_fore(QPainter &p, ViewItemPaintParams &pp);
148
149 void populate_popup_form(QWidget *parent, QFormLayout *form);
150
151 QMenu* create_header_context_menu(QWidget *parent);
152
153 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
154
155 virtual void delete_pressed();
156
157 virtual void hover_point_changed(const QPoint &hp);
158
159 virtual void mouse_left_press_event(const QMouseEvent* event);
160
161private:
162 void draw_annotations(vector<pv::data::decode::Annotation> annotations,
163 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
164 QColor row_color, int row_title_width);
165
166 void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
167 int h, const ViewItemPaintParams &pp, int y,
168 QColor row_color, int row_title_width) const;
169
170 void draw_annotation_block(qreal start, qreal end,
171 pv::data::decode::Annotation::Class ann_class, bool use_ann_format,
172 QPainter &p, int h, int y, QColor row_color) const;
173
174 void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
175 int h, qreal x, int y) const;
176
177 void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
178 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
179 int row_title_width) const;
180
181 void draw_error(QPainter &p, const QString &message,
182 const ViewItemPaintParams &pp);
183
184 void draw_unresolved_period(QPainter &p, int h, int left,
185 int right) const;
186
187 pair<double, double> get_pixels_offset_samples_per_pixel() const;
188
189 /**
190 * Determines the start and end sample for a given pixel range.
191 * @param x_start the X coordinate of the start sample in the view
192 * @param x_end the X coordinate of the end sample in the view
193 * @return Returns a pair containing the start sample and the end
194 * sample that correspond to the start and end coordinates.
195 */
196 pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;
197
198 QColor get_row_color(int row_index) const;
199 QColor get_annotation_color(QColor row_color, int annotation_index) const;
200
201 unsigned int get_row_y(const DecodeTraceRow* row) const;
202
203 DecodeTraceRow* get_row_at_point(const QPoint &point);
204
205 const QString get_annotation_at_point(const QPoint &point);
206
207 void update_stack_button();
208
209 void create_decoder_form(int index,
210 shared_ptr<pv::data::decode::Decoder> &dec,
211 QWidget *parent, QFormLayout *form);
212
213 QComboBox* create_channel_selector(QWidget *parent,
214 const data::decode::DecodeChannel *ch);
215 QComboBox* create_channel_selector_init_state(QWidget *parent,
216 const data::decode::DecodeChannel *ch);
217
218 void export_annotations(vector<data::decode::Annotation> *annotations) const;
219
220 void initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id);
221 void update_rows();
222
223 /**
224 * Sets row r to expanded state without forcing an update of the view
225 */
226 void set_row_expanded(DecodeTraceRow* r);
227
228 /**
229 * Sets row r to collapsed state without forcing an update of the view
230 */
231 void set_row_collapsed(DecodeTraceRow* r);
232
233 void update_expanded_rows();
234
235private Q_SLOTS:
236 void on_setting_changed(const QString &key, const QVariant &value);
237
238 void on_new_annotations();
239 void on_delayed_trace_update();
240 void on_decode_reset();
241 void on_decode_finished();
242 void on_pause_decode();
243
244 void on_delete();
245
246 void on_channel_selected(int);
247
248 void on_channels_updated();
249
250 void on_init_state_changed(int);
251
252 void on_stack_decoder(srd_decoder *decoder);
253
254 void on_delete_decoder(int index);
255
256 void on_show_hide_decoder(int index);
257 void on_show_hide_row(int row_id);
258 void on_show_hide_class(QWidget* sender);
259
260 void on_copy_annotation_to_clipboard();
261
262 void on_export_row();
263 void on_export_all_rows();
264 void on_export_row_with_cursor();
265 void on_export_all_rows_with_cursor();
266 void on_export_row_from_here();
267 void on_export_all_rows_from_here();
268
269 void on_animation_timer();
270
271private:
272 pv::Session &session_;
273 shared_ptr<data::DecodeSignal> decode_signal_;
274
275 deque<DecodeTraceRow> rows_;
276 mutable mutex row_modification_mutex_;
277
278 map<QComboBox*, uint16_t> channel_id_map_; // channel selector -> decode channel ID
279 map<QComboBox*, uint16_t> init_state_map_; // init state selector -> decode channel ID
280 list< shared_ptr<pv::binding::Decoder> > bindings_;
281
282 const Row* selected_row_;
283 pair<uint64_t, uint64_t> selected_sample_range_;
284
285 vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
286 QPushButton* stack_button_;
287
288 unsigned int default_row_height_, annotation_height_;
289 unsigned int visible_rows_, max_visible_rows_;
290
291 int min_useful_label_width_;
292 bool always_show_all_rows_;
293
294 QSignalMapper delete_mapper_, show_hide_mapper_;
295 QSignalMapper row_show_hide_mapper_, class_show_hide_mapper_;
296
297 QTimer delayed_trace_updater_, animation_timer_;
298
299 QPolygon default_marker_shape_;
300};
301
302} // namespace trace
303} // namespace views
304} // namespace pv
305
306#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP