Paint sampling points on the actual trace, not the center line
[pulseview.git] / pv / view / decodetrace.hpp
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 "trace.hpp"
24
25 #include <list>
26 #include <map>
27 #include <memory>
28 #include <vector>
29
30 #include <QSignalMapper>
31
32 #include <pv/binding/decoder.hpp>
33 #include <pv/data/decode/row.hpp>
34 #include <pv/data/signalbase.hpp>
35
36 using std::list;
37 using std::map;
38 using std::pair;
39 using std::shared_ptr;
40 using std::vector;
41
42 struct srd_channel;
43 struct srd_decoder;
44
45 class QComboBox;
46
47 namespace pv {
48
49 class Session;
50
51 namespace data {
52 class DecoderStack;
53 class SignalBase;
54
55 namespace decode {
56 class Annotation;
57 class Decoder;
58 class Row;
59 }
60 }
61
62 namespace widgets {
63 class DecoderGroupBox;
64 }
65
66 namespace views {
67 namespace TraceView {
68
69 class DecodeTrace : public Trace
70 {
71         Q_OBJECT
72
73 private:
74         struct ChannelSelector
75         {
76                 const QComboBox *combo_;
77                 const shared_ptr<pv::data::decode::Decoder> decoder_;
78                 const srd_channel *pdch_;
79         };
80
81 private:
82         static const QColor DecodeColours[4];
83         static const QColor ErrorBgColour;
84         static const QColor NoDecodeColour;
85
86         static const int ArrowSize;
87         static const double EndCapWidth;
88         static const int RowTitleMargin;
89         static const int DrawPadding;
90
91         static const QColor Colours[16];
92         static const QColor OutlineColours[16];
93
94 public:
95         DecodeTrace(pv::Session &session, shared_ptr<data::SignalBase> signalbase,
96                 int index);
97
98         bool enabled() const;
99
100         const shared_ptr<pv::data::DecoderStack>& decoder() const;
101
102         shared_ptr<data::SignalBase> base() const;
103
104         /**
105          * Computes the vertical extents of the contents of this row item.
106          * @return A pair containing the minimum and maximum y-values.
107          */
108         pair<int, int> v_extents() const;
109
110         /**
111          * Paints the background layer of the trace with a QPainter
112          * @param p the QPainter to paint into.
113          * @param pp the painting parameters object to paint with..
114          */
115         void paint_back(QPainter &p, ViewItemPaintParams &pp);
116
117         /**
118          * Paints the mid-layer of the trace with a QPainter
119          * @param p the QPainter to paint into.
120          * @param pp the painting parameters object to paint with.
121          */
122         void paint_mid(QPainter &p, ViewItemPaintParams &pp);
123
124         /**
125          * Paints the foreground layer of the trace with a QPainter
126          * @param p the QPainter to paint into.
127          * @param pp the painting parameters object to paint with.
128          */
129         void paint_fore(QPainter &p, ViewItemPaintParams &pp);
130
131         void populate_popup_form(QWidget *parent, QFormLayout *form);
132
133         QMenu* create_context_menu(QWidget *parent);
134
135         void delete_pressed();
136
137 private:
138         void draw_annotations(vector<pv::data::decode::Annotation> annotations,
139                 QPainter &p, int h, const ViewItemPaintParams &pp, int y,
140                 size_t base_colour, int row_title_width);
141
142         void draw_annotation(const pv::data::decode::Annotation &a, QPainter &p,
143                 int h, const ViewItemPaintParams &pp, int y,
144                 size_t base_colour, int row_title_width) const;
145
146         void draw_annotation_block(vector<pv::data::decode::Annotation> annotations,
147                 QPainter &p, int h, int y, size_t base_colour) const;
148
149         void draw_instant(const pv::data::decode::Annotation &a, QPainter &p,
150                 int h, double x, int y) const;
151
152         void draw_range(const pv::data::decode::Annotation &a, QPainter &p,
153                 int h, double start, double end, int y, const ViewItemPaintParams &pp,
154                 int row_title_width) const;
155
156         void draw_error(QPainter &p, const QString &message,
157                 const ViewItemPaintParams &pp);
158
159         void draw_unresolved_period(QPainter &p, int h, int left,
160                 int right) const;
161
162         pair<double, double> get_pixels_offset_samples_per_pixel() const;
163
164         /**
165          * Determines the start and end sample for a given pixel range.
166          * @param x_start the X coordinate of the start sample in the view
167          * @param x_end the X coordinate of the end sample in the view
168          * @return Returns a pair containing the start sample and the end
169          *      sample that correspond to the start and end coordinates.
170          */
171         pair<uint64_t, uint64_t> get_sample_range(int x_start, int x_end) const;
172
173         int get_row_at_point(const QPoint &point);
174
175         const QString get_annotation_at_point(const QPoint &point);
176
177         void create_decoder_form(int index,
178                 shared_ptr<pv::data::decode::Decoder> &dec,
179                 QWidget *parent, QFormLayout *form);
180
181         QComboBox* create_channel_selector(QWidget *parent,
182                 const shared_ptr<pv::data::decode::Decoder> &dec,
183                 const srd_channel *const pdch);
184
185         void commit_decoder_channels(shared_ptr<data::decode::Decoder> &dec);
186
187         void commit_channels();
188
189 public:
190         void hover_point_changed();
191
192 private Q_SLOTS:
193         void on_new_decode_data();
194
195         void on_delete();
196
197         void on_channel_selected(int);
198
199         void on_stack_decoder(srd_decoder *decoder);
200
201         void on_delete_decoder(int index);
202
203         void on_show_hide_decoder(int index);
204
205 private:
206         pv::Session &session_;
207
208         vector<data::decode::Row> visible_rows_;
209         uint64_t decode_start_, decode_end_;
210
211         list< shared_ptr<pv::binding::Decoder> > bindings_;
212
213         list<ChannelSelector> channel_selectors_;
214         vector<pv::widgets::DecoderGroupBox*> decoder_forms_;
215
216         map<data::decode::Row, int> row_title_widths_;
217         int row_height_, max_visible_rows_;
218
219         int min_useful_label_width_;
220
221         QSignalMapper delete_mapper_, show_hide_mapper_;
222 };
223
224 } // namespace TraceView
225 } // namespace views
226 } // namespace pv
227
228 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_DECODETRACE_HPP