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
32 #include <QPushButton>
33 #include <QSignalMapper>
36 #include <pv/binding/decoder.hpp>
37 #include <pv/data/decode/decoder.hpp>
38 #include <pv/data/decode/annotation.hpp>
39 #include <pv/data/decode/row.hpp>
40 #include <pv/data/signalbase.hpp>
47 using std::shared_ptr;
67 class DecoderGroupBox;
74 // When adding a field, make sure it's initialized properly in
75 // DecodeTrace::update_rows()
77 data::decode::Row decode_row;
78 unsigned int height, title_width;
79 bool exists, currently_visible, expand_marker_highlighted, expanded;
82 class DecodeTrace : public Trace
87 static const QColor ErrorBgColor;
88 static const QColor NoDecodeColor;
90 static const int ArrowSize;
91 static const double EndCapWidth;
92 static const int RowTitleMargin;
93 static const int DrawPadding;
95 static const int MaxTraceUpdateRate;
98 DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
103 bool enabled() const;
105 shared_ptr<data::SignalBase> base() const;
108 * Computes the vertical extents of the contents of this row item.
109 * @return A pair containing the minimum and maximum y-values.
111 pair<int, int> v_extents() const;
114 * Paints the background layer of the trace with a QPainter
115 * @param p the QPainter to paint into.
116 * @param pp the painting parameters object to paint with..
118 void paint_back(QPainter &p, ViewItemPaintParams &pp);
121 * Paints the mid-layer of the trace with a QPainter
122 * @param p the QPainter to paint into.
123 * @param pp the painting parameters object to paint with.
125 void paint_mid(QPainter &p, ViewItemPaintParams &pp);
128 * Paints the foreground layer of the trace with a QPainter
129 * @param p the QPainter to paint into.
130 * @param pp the painting parameters object to paint with.
132 void paint_fore(QPainter &p, ViewItemPaintParams &pp);
134 void populate_popup_form(QWidget *parent, QFormLayout *form);
136 QMenu* create_header_context_menu(QWidget *parent);
138 virtual QMenu* create_view_context_menu(QWidget *parent, QPoint &click_pos);
140 void delete_pressed();
143 void draw_annotations(vector<pv::data::decode::Annotation> annotations,
144 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
145 QColor row_color, int row_title_width);
147 void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
148 int h, const ViewItemPaintParams &pp, int y,
149 QColor row_color, int row_title_width) const;
151 void draw_annotation_block(qreal start, qreal end,
152 pv::data::decode::Annotation::Class ann_class, bool use_ann_format,
153 QPainter &p, int h, int y, QColor row_color) const;
155 void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
156 int h, qreal x, int y) const;
158 void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
159 int h, qreal start, qreal end, int y, const ViewItemPaintParams &pp,
160 int row_title_width) const;
162 void draw_error(QPainter &p, const QString &message,
163 const ViewItemPaintParams &pp);
165 void draw_unresolved_period(QPainter &p, int h, int left,
168 pair<double, double> get_pixels_offset_samples_per_pixel() const;
171 * Determines the start and end sample for a given pixel range.
172 * @param x_start the X coordinate of the start sample in the view
173 * @param x_end the X coordinate of the end sample in the view
174 * @return Returns a pair containing the start sample and the end
175 * sample that correspond to the start and end coordinates.
177 pair<uint64_t, uint64_t> get_view_sample_range(int x_start, int x_end) const;
179 QColor get_row_color(int row_index) const;
180 QColor get_annotation_color(QColor row_color, int annotation_index) const;
182 unsigned int get_row_y(const RowData* row) const;
184 RowData* get_row_at_point(const QPoint &point);
186 const QString get_annotation_at_point(const QPoint &point);
188 void update_stack_button();
190 void create_decoder_form(int index,
191 shared_ptr<pv::data::decode::Decoder> &dec,
192 QWidget *parent, QFormLayout *form);
194 QComboBox* create_channel_selector(QWidget *parent,
195 const data::decode::DecodeChannel *ch);
196 QComboBox* create_channel_selector_init_state(QWidget *parent,
197 const data::decode::DecodeChannel *ch);
199 void export_annotations(vector<data::decode::Annotation> *annotations) const;
204 virtual void hover_point_changed(const QPoint &hp);
207 void on_setting_changed(const QString &key, const QVariant &value);
209 void on_new_annotations();
210 void on_delayed_trace_update();
211 void on_decode_reset();
212 void on_decode_finished();
213 void on_pause_decode();
217 void on_channel_selected(int);
219 void on_channels_updated();
221 void on_init_state_changed(int);
223 void on_stack_decoder(srd_decoder *decoder);
225 void on_delete_decoder(int index);
227 void on_show_hide_decoder(int index);
229 void on_copy_annotation_to_clipboard();
231 void on_export_row();
232 void on_export_all_rows();
233 void on_export_row_with_cursor();
234 void on_export_all_rows_with_cursor();
235 void on_export_row_from_here();
236 void on_export_all_rows_from_here();
239 pv::Session &session_;
240 shared_ptr<data::DecodeSignal> decode_signal_;
242 deque<RowData> rows_;
243 mutable mutex row_modification_mutex_;
245 map<QComboBox*, uint16_t> channel_id_map_; // channel selector -> decode channel ID
246 map<QComboBox*, uint16_t> init_state_map_; // init state selector -> decode channel ID
247 list< shared_ptr<pv::binding::Decoder> > bindings_;
249 const data::decode::Row* selected_row_;
250 pair<uint64_t, uint64_t> selected_sample_range_;
252 vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
253 QPushButton* stack_button_;
255 unsigned int default_row_height_, visible_rows_, max_visible_rows_;
257 int min_useful_label_width_;
258 bool always_show_all_rows_;
260 QSignalMapper delete_mapper_, show_hide_mapper_;
262 QTimer delayed_trace_updater_;
269 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP