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 <QPushButton>
34 #include <QSignalMapper>
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>
48 using std::shared_ptr;
68 class DecoderGroupBox;
75 // When adding a field, make sure it's initialized properly in
76 // DecodeTrace::update_rows()
78 data::decode::Row decode_row;
79 unsigned int height, expanded_height, title_width, animation_step;
80 bool exists, currently_visible;
81 bool expand_marker_highlighted, expanding, expanded, collapsing;
82 QPolygon expand_marker_shape;
83 float anim_height, anim_shape;
86 QWidget* header_container;
87 QWidget* selector_container;
88 vector<QCheckBox*> selectors;
91 class DecodeTrace : public Trace
96 static const QColor ErrorBgColor;
97 static const QColor NoDecodeColor;
98 static const uint8_t ExpansionAreaHeaderAlpha;
99 static const uint8_t ExpansionAreaAlpha;
101 static const int ArrowSize;
102 static const double EndCapWidth;
103 static const int RowTitleMargin;
104 static const int DrawPadding;
106 static const int MaxTraceUpdateRate;
107 static const unsigned int AnimationDurationInTicks;
110 DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
115 bool enabled() const;
117 shared_ptr<data::SignalBase> base() const;
120 * Computes the vertical extents of the contents of this row item.
121 * @return A pair containing the minimum and maximum y-values.
123 pair<int, int> v_extents() const;
126 * Paints the background layer of the trace with a QPainter
127 * @param p the QPainter to paint into.
128 * @param pp the painting parameters object to paint with..
130 void paint_back(QPainter &p, ViewItemPaintParams &pp);
133 * Paints the mid-layer of the trace with a QPainter
134 * @param p the QPainter to paint into.
135 * @param pp the painting parameters object to paint with.
137 void paint_mid(QPainter &p, ViewItemPaintParams &pp);
140 * Paints the foreground layer of the trace with a QPainter
141 * @param p the QPainter to paint into.
142 * @param pp the painting parameters object to paint with.
144 void paint_fore(QPainter &p, ViewItemPaintParams &pp);
146 void populate_popup_form(QWidget *parent, QFormLayout *form);
148 QMenu* create_header_context_menu(QWidget *parent);
150 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
152 virtual void delete_pressed();
154 virtual void hover_point_changed(const QPoint &hp);
156 virtual void mouse_left_press_event(const QMouseEvent* event);
159 void draw_annotations(vector<pv::data::decode::Annotation> annotations,
160 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
161 QColor row_color, int row_title_width);
163 void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
164 int h, const ViewItemPaintParams &pp, int y,
165 QColor row_color, int row_title_width) const;
167 void draw_annotation_block(qreal start, qreal end,
168 pv::data::decode::Annotation::Class ann_class, bool use_ann_format,
169 QPainter &p, int h, int y, QColor row_color) const;
171 void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
172 int h, qreal x, int y) const;
174 void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
175 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
176 int row_title_width) const;
178 void draw_error(QPainter &p, const QString &message,
179 const ViewItemPaintParams &pp);
181 void draw_unresolved_period(QPainter &p, int h, int left,
184 pair<double, double> get_pixels_offset_samples_per_pixel() const;
187 * Determines the start and end sample for a given pixel range.
188 * @param x_start the X coordinate of the start sample in the view
189 * @param x_end the X coordinate of the end sample in the view
190 * @return Returns a pair containing the start sample and the end
191 * sample that correspond to the start and end coordinates.
193 pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;
195 QColor get_row_color(int row_index) const;
196 QColor get_annotation_color(QColor row_color, int annotation_index) const;
198 unsigned int get_row_y(const RowData* row) const;
200 RowData* get_row_at_point(const QPoint &point);
202 const QString get_annotation_at_point(const QPoint &point);
204 void update_stack_button();
206 void create_decoder_form(int index,
207 shared_ptr<pv::data::decode::Decoder> &dec,
208 QWidget *parent, QFormLayout *form);
210 QComboBox* create_channel_selector(QWidget *parent,
211 const data::decode::DecodeChannel *ch);
212 QComboBox* create_channel_selector_init_state(QWidget *parent,
213 const data::decode::DecodeChannel *ch);
215 void export_annotations(vector<data::decode::Annotation> *annotations) const;
220 * Sets row r to expanded state without forcing an update of the view
222 void set_row_expanded(RowData* r);
225 * Sets row r to collapsed state without forcing an update of the view
227 void set_row_collapsed(RowData* r);
229 void update_expanded_rows();
232 void on_setting_changed(const QString &key, const QVariant &value);
234 void on_new_annotations();
235 void on_delayed_trace_update();
236 void on_decode_reset();
237 void on_decode_finished();
238 void on_pause_decode();
242 void on_channel_selected(int);
244 void on_channels_updated();
246 void on_init_state_changed(int);
248 void on_stack_decoder(srd_decoder *decoder);
250 void on_delete_decoder(int index);
252 void on_show_hide_decoder(int index);
253 void on_show_hide_row(int index);
255 void on_copy_annotation_to_clipboard();
257 void on_export_row();
258 void on_export_all_rows();
259 void on_export_row_with_cursor();
260 void on_export_all_rows_with_cursor();
261 void on_export_row_from_here();
262 void on_export_all_rows_from_here();
264 void on_animation_timer();
267 pv::Session &session_;
268 shared_ptr<data::DecodeSignal> decode_signal_;
270 deque<RowData> rows_;
271 mutable mutex row_modification_mutex_;
273 map<QComboBox*, uint16_t> channel_id_map_; // channel selector -> decode channel ID
274 map<QComboBox*, uint16_t> init_state_map_; // init state selector -> decode channel ID
275 list< shared_ptr<pv::binding::Decoder> > bindings_;
277 const data::decode::Row* selected_row_;
278 pair<uint64_t, uint64_t> selected_sample_range_;
280 vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
281 QPushButton* stack_button_;
283 unsigned int default_row_height_, annotation_height_;
284 unsigned int visible_rows_, max_visible_rows_;
286 int min_useful_label_width_;
287 bool always_show_all_rows_;
289 QSignalMapper delete_mapper_, show_hide_mapper_, row_show_hide_mapper_;
291 QTimer delayed_trace_updater_, animation_timer_;
293 QPolygon default_marker_shape_;
300 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP