DecodeSignal: Add and use inclusive/exclusive sample count variant
[pulseview.git] / pv / views / trace / trace.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2013 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 #include <extdef.h>
21
22 #include <cassert>
23 #include <cmath>
24
25 #include <QApplication>
26 #include <QFormLayout>
27 #include <QKeyEvent>
28 #include <QLineEdit>
29
30 #include "trace.hpp"
31 #include "tracepalette.hpp"
32 #include "view.hpp"
33
34 #include "pv/globalsettings.hpp"
35 #include "pv/widgets/colorbutton.hpp"
36 #include "pv/widgets/popup.hpp"
37
38 using std::pair;
39 using std::shared_ptr;
40
41 namespace pv {
42 namespace views {
43 namespace trace {
44
45 const QPen Trace::AxisPen(QColor(0, 0, 0, 30 * 256 / 100));
46 const int Trace::LabelHitPadding = 2;
47
48 const QColor Trace::BrightGrayBGColor = QColor(0, 0, 0, 10 * 255 / 100);
49 const QColor Trace::DarkGrayBGColor = QColor(0, 0, 0, 15 * 255 / 100);
50
51 Trace::Trace(shared_ptr<data::SignalBase> channel) :
52         base_(channel),
53         axis_pen_(AxisPen),
54         segment_display_mode_(ShowLastSegmentOnly),  // Will be overwritten by View
55         current_segment_(0),
56         popup_(nullptr),
57         popup_form_(nullptr)
58 {
59         connect(channel.get(), SIGNAL(name_changed(const QString&)),
60                 this, SLOT(on_name_changed(const QString&)));
61         connect(channel.get(), SIGNAL(color_changed(const QColor&)),
62                 this, SLOT(on_color_changed(const QColor&)));
63
64         GlobalSettings::add_change_handler(this);
65
66         GlobalSettings settings;
67         show_hover_marker_ =
68                 settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
69 }
70
71 Trace::~Trace()
72 {
73         GlobalSettings::remove_change_handler(this);
74 }
75
76 shared_ptr<data::SignalBase> Trace::base() const
77 {
78         return base_;
79 }
80
81 void Trace::set_segment_display_mode(SegmentDisplayMode mode)
82 {
83         segment_display_mode_ = mode;
84
85         if (owner_)
86                 owner_->row_item_appearance_changed(true, true);
87 }
88
89 void Trace::on_setting_changed(const QString &key, const QVariant &value)
90 {
91         if (key == GlobalSettings::Key_View_ShowHoverMarker)
92                 show_hover_marker_ = value.toBool();
93 }
94
95 void Trace::paint_label(QPainter &p, const QRect &rect, bool hover)
96 {
97         const int y = get_visual_y();
98
99         p.setBrush(base_->color());
100
101         if (!enabled())
102                 return;
103
104         const QRectF r = label_rect(rect);
105
106         // When selected, move the arrow to the left so that the border can show
107         const QPointF offs = (selected()) ? QPointF(-2, 0) : QPointF(0, 0);
108
109         // Paint the label
110         const float label_arrow_length = r.height() / 2;
111         QPointF points[] = {
112                 offs + r.topLeft(),
113                 offs + QPointF(r.right() - label_arrow_length, r.top()),
114                 offs + QPointF(r.right(), y),
115                 offs + QPointF(r.right() - label_arrow_length, r.bottom()),
116                 offs + r.bottomLeft()
117         };
118         QPointF highlight_points[] = {
119                 offs + QPointF(r.left() + 1, r.top() + 1),
120                 offs + QPointF(r.right() - label_arrow_length, r.top() + 1),
121                 offs + QPointF(r.right() - 1, y),
122                 offs + QPointF(r.right() - label_arrow_length, r.bottom() - 1),
123                 offs + QPointF(r.left() + 1, r.bottom() - 1)
124         };
125
126         if (selected()) {
127                 p.setPen(highlight_pen());
128                 p.setBrush(Qt::transparent);
129                 p.drawPolygon(points, countof(points));
130         }
131
132         p.setPen(Qt::transparent);
133         p.setBrush(hover ? base_->color().lighter() : base_->color());
134         p.drawPolygon(points, countof(points));
135
136         p.setPen(base_->color().lighter());
137         p.setBrush(Qt::transparent);
138         p.drawPolygon(highlight_points, countof(highlight_points));
139
140         p.setPen(base_->color().darker());
141         p.setBrush(Qt::transparent);
142         p.drawPolygon(points, countof(points));
143
144         // Paint the text
145         p.setPen(select_text_color(base_->color()));
146         p.setFont(QApplication::font());
147         p.drawText(QRectF(r.x(), r.y(),
148                 r.width() - label_arrow_length, r.height()),
149                 Qt::AlignCenter | Qt::AlignVCenter, base_->name());
150 }
151
152 QMenu* Trace::create_context_menu(QWidget *parent)
153 {
154         QMenu *const menu = ViewItem::create_context_menu(parent);
155
156         return menu;
157 }
158
159 pv::widgets::Popup* Trace::create_popup(QWidget *parent)
160 {
161         using pv::widgets::Popup;
162
163         popup_ = new Popup(parent);
164         popup_->set_position(parent->mapToGlobal(
165                 drag_point(parent->rect())), Popup::Right);
166
167         create_popup_form();
168
169         connect(popup_, SIGNAL(closed()), this, SLOT(on_popup_closed()));
170
171         return popup_;
172 }
173
174 QRectF Trace::label_rect(const QRectF &rect) const
175 {
176         QFontMetrics m(QApplication::font());
177         const QSize text_size(
178                 m.boundingRect(QRect(), 0, base_->name()).width(), m.height());
179         const QSizeF label_size(
180                 text_size.width() + LabelPadding.width() * 2,
181                 ceilf((text_size.height() + LabelPadding.height() * 2) / 2) * 2);
182         const float half_height = label_size.height() / 2;
183         return QRectF(
184                 rect.right() - half_height - label_size.width() - 0.5,
185                 get_visual_y() + 0.5f - half_height,
186                 label_size.width() + half_height,
187                 label_size.height());
188 }
189
190 void Trace::set_current_segment(const int segment)
191 {
192         current_segment_ = segment;
193 }
194
195 int Trace::get_current_segment() const
196 {
197         return current_segment_;
198 }
199
200 void Trace::hover_point_changed(const QPoint &hp)
201 {
202         (void)hp;
203
204         if (owner_)
205                 owner_->row_item_appearance_changed(false, true);
206 }
207
208 void Trace::paint_back(QPainter &p, ViewItemPaintParams &pp)
209 {
210         const View *view = owner_->view();
211         assert(view);
212
213         if (view->colored_bg())
214                 p.setBrush(base_->bgcolor());
215         else
216                 p.setBrush(pp.next_bg_color_state() ? BrightGrayBGColor : DarkGrayBGColor);
217
218         p.setPen(QPen(Qt::NoPen));
219
220         const pair<int, int> extents = v_extents();
221         p.drawRect(pp.left(), get_visual_y() + extents.first,
222                 pp.width(), extents.second - extents.first);
223 }
224
225 void Trace::paint_axis(QPainter &p, ViewItemPaintParams &pp, int y)
226 {
227         p.setRenderHint(QPainter::Antialiasing, false);
228
229         p.setPen(axis_pen_);
230         p.drawLine(QPointF(pp.left(), y), QPointF(pp.right(), y));
231
232         p.setRenderHint(QPainter::Antialiasing, true);
233 }
234
235 void Trace::add_color_option(QWidget *parent, QFormLayout *form)
236 {
237         using pv::widgets::ColorButton;
238
239         ColorButton *const color_button = new ColorButton(
240                 TracePalette::Rows, TracePalette::Cols, parent);
241         color_button->set_palette(TracePalette::Colors);
242         color_button->set_color(base_->color());
243         connect(color_button, SIGNAL(selected(const QColor&)),
244                 this, SLOT(on_coloredit_changed(const QColor&)));
245
246         form->addRow(tr("Color"), color_button);
247 }
248
249 void Trace::paint_hover_marker(QPainter &p)
250 {
251         const View *view = owner_->view();
252         assert(view);
253
254         const int x = view->hover_point().x();
255
256         if (x == -1)
257                 return;
258
259         p.setPen(QPen(QColor(Qt::lightGray)));
260
261         const pair<int, int> extents = v_extents();
262
263         p.setRenderHint(QPainter::Antialiasing, false);
264         p.drawLine(x, get_visual_y() + extents.first,
265                 x, get_visual_y() + extents.second);
266         p.setRenderHint(QPainter::Antialiasing, true);
267 }
268
269 void Trace::create_popup_form()
270 {
271         // Clear the layout
272
273         // Transfer the layout and the child widgets to a temporary widget
274         // which we delete after the event was handled. This way, the layout
275         // and all widgets contained therein are deleted after the event was
276         // handled, leaving the parent popup_ time to handle the change.
277         if (popup_form_) {
278                 QWidget *suicidal = new QWidget();
279                 suicidal->setLayout(popup_form_);
280                 suicidal->deleteLater();
281         }
282
283         // Repopulate the popup
284         popup_form_ = new QFormLayout(popup_);
285         popup_->setLayout(popup_form_);
286         populate_popup_form(popup_, popup_form_);
287 }
288
289 void Trace::populate_popup_form(QWidget *parent, QFormLayout *form)
290 {
291         QLineEdit *const name_edit = new QLineEdit(parent);
292         name_edit->setText(base_->name());
293         connect(name_edit, SIGNAL(textChanged(const QString&)),
294                 this, SLOT(on_nameedit_changed(const QString&)));
295         form->addRow(tr("Name"), name_edit);
296
297         add_color_option(parent, form);
298 }
299
300 void Trace::on_name_changed(const QString &text)
301 {
302         /* This event handler is called by SignalBase when the name was changed there */
303         (void)text;
304
305         if (owner_) {
306                 owner_->extents_changed(true, false);
307                 owner_->row_item_appearance_changed(true, false);
308         }
309 }
310
311 void Trace::on_color_changed(const QColor &color)
312 {
313         /* This event handler is called by SignalBase when the color was changed there */
314         (void)color;
315
316         if (owner_)
317                 owner_->row_item_appearance_changed(true, true);
318 }
319
320 void Trace::on_popup_closed()
321 {
322         popup_ = nullptr;
323         popup_form_ = nullptr;
324 }
325
326 void Trace::on_nameedit_changed(const QString &name)
327 {
328         /* This event handler notifies SignalBase that the name changed */
329         base_->set_name(name);
330 }
331
332 void Trace::on_coloredit_changed(const QColor &color)
333 {
334         /* This event handler notifies SignalBase that the color changed */
335         base_->set_color(color);
336 }
337
338 } // namespace trace
339 } // namespace views
340 } // namespace pv