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 class DecodeTrace : public Trace
91 static const QColor ErrorBgColor;
92 static const QColor NoDecodeColor;
94 static const int ArrowSize;
95 static const double EndCapWidth;
96 static const int RowTitleMargin;
97 static const int DrawPadding;
99 static const int MaxTraceUpdateRate;
100 static const unsigned int AnimationDurationInTicks;
103 DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
108 bool enabled() const;
110 shared_ptr<data::SignalBase> base() const;
113 * Computes the vertical extents of the contents of this row item.
114 * @return A pair containing the minimum and maximum y-values.
116 pair<int, int> v_extents() const;
119 * Paints the background layer of the trace with a QPainter
120 * @param p the QPainter to paint into.
121 * @param pp the painting parameters object to paint with..
123 void paint_back(QPainter &p, ViewItemPaintParams &pp);
126 * Paints the mid-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_mid(QPainter &p, ViewItemPaintParams &pp);
133 * Paints the foreground 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_fore(QPainter &p, ViewItemPaintParams &pp);
139 void populate_popup_form(QWidget *parent, QFormLayout *form);
141 QMenu* create_header_context_menu(QWidget *parent);
143 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
145 virtual void delete_pressed();
147 virtual void hover_point_changed(const QPoint &hp);
149 virtual void mouse_left_press_event(const QMouseEvent* event);
152 void draw_annotations(vector<pv::data::decode::Annotation> annotations,
153 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
154 QColor row_color, int row_title_width);
156 void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
157 int h, const ViewItemPaintParams &pp, int y,
158 QColor row_color, int row_title_width) const;
160 void draw_annotation_block(qreal start, qreal end,
161 pv::data::decode::Annotation::Class ann_class, bool use_ann_format,
162 QPainter &p, int h, int y, QColor row_color) const;
164 void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
165 int h, qreal x, int y) const;
167 void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
168 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
169 int row_title_width) const;
171 void draw_error(QPainter &p, const QString &message,
172 const ViewItemPaintParams &pp);
174 void draw_unresolved_period(QPainter &p, int h, int left,
177 pair<double, double> get_pixels_offset_samples_per_pixel() const;
180 * Determines the start and end sample for a given pixel range.
181 * @param x_start the X coordinate of the start sample in the view
182 * @param x_end the X coordinate of the end sample in the view
183 * @return Returns a pair containing the start sample and the end
184 * sample that correspond to the start and end coordinates.
186 pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;
188 QColor get_row_color(int row_index) const;
189 QColor get_annotation_color(QColor row_color, int annotation_index) const;
191 unsigned int get_row_y(const RowData* row) const;
193 RowData* get_row_at_point(const QPoint &point);
195 const QString get_annotation_at_point(const QPoint &point);
197 void update_stack_button();
199 void create_decoder_form(int index,
200 shared_ptr<pv::data::decode::Decoder> &dec,
201 QWidget *parent, QFormLayout *form);
203 QComboBox* create_channel_selector(QWidget *parent,
204 const data::decode::DecodeChannel *ch);
205 QComboBox* create_channel_selector_init_state(QWidget *parent,
206 const data::decode::DecodeChannel *ch);
208 void export_annotations(vector<data::decode::Annotation> *annotations) const;
213 void on_setting_changed(const QString &key, const QVariant &value);
215 void on_new_annotations();
216 void on_delayed_trace_update();
217 void on_decode_reset();
218 void on_decode_finished();
219 void on_pause_decode();
223 void on_channel_selected(int);
225 void on_channels_updated();
227 void on_init_state_changed(int);
229 void on_stack_decoder(srd_decoder *decoder);
231 void on_delete_decoder(int index);
233 void on_show_hide_decoder(int index);
235 void on_copy_annotation_to_clipboard();
237 void on_export_row();
238 void on_export_all_rows();
239 void on_export_row_with_cursor();
240 void on_export_all_rows_with_cursor();
241 void on_export_row_from_here();
242 void on_export_all_rows_from_here();
244 void on_animation_timer();
247 pv::Session &session_;
248 shared_ptr<data::DecodeSignal> decode_signal_;
250 deque<RowData> rows_;
251 mutable mutex row_modification_mutex_;
253 map<QComboBox*, uint16_t> channel_id_map_; // channel selector -> decode channel ID
254 map<QComboBox*, uint16_t> init_state_map_; // init state selector -> decode channel ID
255 list< shared_ptr<pv::binding::Decoder> > bindings_;
257 const data::decode::Row* selected_row_;
258 pair<uint64_t, uint64_t> selected_sample_range_;
260 vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
261 QPushButton* stack_button_;
263 unsigned int default_row_height_, annotation_height_;
264 unsigned int visible_rows_, max_visible_rows_;
266 int min_useful_label_width_;
267 bool always_show_all_rows_;
269 QSignalMapper delete_mapper_, show_hide_mapper_;
271 QTimer delayed_trace_updater_, animation_timer_;
273 QPolygon default_marker_shape_;
280 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP