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