2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP
33 #include <QElapsedTimer>
35 #include <QPushButton>
36 #include <QSignalMapper>
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>
45 #define DECODETRACE_SHOW_RENDER_TIME 0
52 using std::shared_ptr;
55 using pv::data::SignalBase;
56 using pv::data::decode::Annotation;
57 using pv::data::decode::Decoder;
58 using pv::data::decode::Row;
78 class DecoderGroupBox;
84 class ContainerWidget;
86 struct DecodeTraceRow {
87 // When adding a field, make sure it's initialized properly in
88 // DecodeTrace::update_rows()
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;
97 ContainerWidget* container;
98 QWidget* header_container;
99 QWidget* selector_container;
100 vector<QCheckBox*> selectors;
103 map<uint32_t, QColor> ann_class_color;
104 map<uint32_t, QColor> ann_class_dark_color;
107 class ContainerWidget : public QWidget
112 ContainerWidget(QWidget *parent = nullptr);
114 virtual void resizeEvent(QResizeEvent* event);
117 void widgetResized(QWidget* sender);
120 class DecodeTrace : public Trace
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;
132 static const int ArrowSize;
133 static const double EndCapWidth;
134 static const int RowTitleMargin;
135 static const int DrawPadding;
137 static const int MaxTraceUpdateRate;
138 static const int AnimationDurationInTicks;
139 static const int HiddenRowHideDelay;
142 DecodeTrace(pv::Session &session, shared_ptr<SignalBase> signalbase,
147 bool enabled() const;
149 shared_ptr<SignalBase> base() const;
152 * Computes the vertical extents of the contents of this row item.
153 * @return A pair containing the minimum and maximum y-values.
155 pair<int, int> v_extents() const;
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..
162 void paint_back(QPainter &p, ViewItemPaintParams &pp);
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.
169 void paint_mid(QPainter &p, ViewItemPaintParams &pp);
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.
176 void paint_fore(QPainter &p, ViewItemPaintParams &pp);
178 void populate_popup_form(QWidget *parent, QFormLayout *form);
180 QMenu* create_header_context_menu(QWidget *parent);
182 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
184 virtual void delete_pressed();
186 virtual void hover_point_changed(const QPoint &hp);
188 virtual void mouse_left_press_event(const QMouseEvent* event);
191 void draw_annotations(deque<const Annotation*>& annotations, QPainter &p,
192 const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row);
194 void draw_annotation(const Annotation* a, QPainter &p,
195 const ViewItemPaintParams &pp, int y, const DecodeTraceRow& row) const;
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;
200 void draw_instant(const Annotation* a, QPainter &p, qreal x, int y) const;
202 void draw_range(const Annotation* a, QPainter &p, qreal start, qreal end,
203 int y, const ViewItemPaintParams &pp, int row_title_width) const;
205 void draw_error(QPainter &p, const QString &message, const ViewItemPaintParams &pp);
207 void draw_unresolved_period(QPainter &p, int left, int right) const;
209 pair<double, double> get_pixels_offset_samples_per_pixel() const;
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.
218 pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;
220 QColor get_row_color(int row_index) const;
221 QColor get_annotation_color(QColor row_color, int annotation_index) const;
223 unsigned int get_row_y(const DecodeTraceRow* row) const;
225 DecodeTraceRow* get_row_at_point(const QPoint &point);
227 const QString get_annotation_at_point(const QPoint &point);
229 void update_stack_button();
231 void create_decoder_form(int index, shared_ptr<Decoder> &dec,
232 QWidget *parent, QFormLayout *form);
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);
239 void export_annotations(deque<const Annotation*>& annotations) const;
241 void initialize_row_widgets(DecodeTraceRow* r, unsigned int row_id);
245 * Sets row r to expanded state without forcing an update of the view
247 void set_row_expanded(DecodeTraceRow* r);
250 * Sets row r to collapsed state without forcing an update of the view
252 void set_row_collapsed(DecodeTraceRow* r);
254 void update_expanded_rows();
257 void on_setting_changed(const QString &key, const QVariant &value);
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();
267 void on_channel_selected(int);
269 void on_channels_updated();
271 void on_init_state_changed(int);
273 void on_stack_decoder(srd_decoder *decoder);
275 void on_delete_decoder(int index);
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);
284 void on_copy_annotation_to_clipboard();
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();
293 void on_animation_timer();
294 void on_hide_hidden_rows();
297 pv::Session &session_;
298 shared_ptr<data::DecodeSignal> decode_signal_;
300 deque<DecodeTraceRow> rows_;
301 mutable mutex row_modification_mutex_;
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_;
307 const Row* selected_row_;
308 pair<uint64_t, uint64_t> selected_sample_range_;
310 vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
311 QPushButton* stack_button_;
313 unsigned int default_row_height_, annotation_height_;
314 unsigned int visible_rows_, max_visible_rows_;
316 int min_useful_label_width_;
317 bool always_show_all_rows_, show_hidden_rows_;
319 QSignalMapper delete_mapper_, show_hide_mapper_;
320 QSignalMapper row_show_hide_mapper_, class_show_hide_mapper_;
322 QTimer delayed_trace_updater_, animation_timer_, delayed_hidden_row_hider_;
324 QPolygon default_marker_shape_;
326 #if DECODETRACE_SHOW_RENDER_TIME
327 QElapsedTimer render_time_;
335 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP