Use QMenu->popup() instead of QMenu->exec() everywhere
[pulseview.git] / pv / views / trace / ruler.cpp
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 #include <extdef.h>
21
22 #include <QApplication>
23 #include <QFontMetrics>
24 #include <QMenu>
25 #include <QMouseEvent>
26
27 #include <pv/globalsettings.hpp>
28
29 #include "ruler.hpp"
30 #include "view.hpp"
31
32 using namespace Qt;
33
34 using std::function;
35 using std::max;
36 using std::min;
37 using std::shared_ptr;
38 using std::vector;
39
40 namespace pv {
41 namespace views {
42 namespace trace {
43
44 const float Ruler::RulerHeight = 2.5f; // x Text Height
45
46 const float Ruler::HoverArrowSize = 0.5f; // x Text Height
47
48 Ruler::Ruler(View &parent) :
49         MarginWidget(parent)
50 {
51         setMouseTracking(true);
52
53         connect(&view_, SIGNAL(hover_point_changed(QPoint)),
54                 this, SLOT(hover_point_changed(QPoint)));
55         connect(&view_, SIGNAL(offset_changed()),
56                 this, SLOT(invalidate_tick_position_cache()));
57         connect(&view_, SIGNAL(scale_changed()),
58                 this, SLOT(invalidate_tick_position_cache()));
59         connect(&view_, SIGNAL(tick_prefix_changed()),
60                 this, SLOT(invalidate_tick_position_cache()));
61         connect(&view_, SIGNAL(tick_precision_changed()),
62                 this, SLOT(invalidate_tick_position_cache()));
63         connect(&view_, SIGNAL(tick_period_changed()),
64                 this, SLOT(invalidate_tick_position_cache()));
65         connect(&view_, SIGNAL(time_unit_changed()),
66                 this, SLOT(invalidate_tick_position_cache()));
67 }
68
69 QSize Ruler::sizeHint() const
70 {
71         const int text_height = calculate_text_height();
72         return QSize(0, RulerHeight * text_height);
73 }
74
75 QSize Ruler::extended_size_hint() const
76 {
77         QRectF max_rect;
78         vector< shared_ptr<TimeItem> > items(view_.time_items());
79         for (auto &i : items)
80                 max_rect = max_rect.united(i->label_rect(QRect()));
81         return QSize(0, sizeHint().height() - max_rect.top() / 2 +
82                 ViewItem::HighlightRadius);
83 }
84
85 QString Ruler::format_time_with_distance(
86         const pv::util::Timestamp& distance,
87         const pv::util::Timestamp& t,
88         pv::util::SIPrefix prefix,
89         pv::util::TimeUnit unit,
90         unsigned precision,
91         bool sign)
92 {
93         const unsigned limit = 60;
94
95         if (t.is_zero())
96                 return "0";
97
98         // If we have to use samples then we have no alternative formats
99         if (unit == pv::util::TimeUnit::Samples)
100                 return pv::util::format_time_si_adjusted(t, prefix, precision, "sa", sign);
101
102         // View zoomed way out -> low precision (0), big distance (>=60s)
103         // -> DD:HH:MM
104         if ((precision == 0) && (distance >= limit))
105                 return pv::util::format_time_minutes(t, 0, sign);
106
107         // View in "normal" range -> medium precision, medium step size
108         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
109         // View zoomed way in -> high precision (>3), low step size (<1s)
110         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
111         if (abs(t) < limit)
112                 return pv::util::format_time_si_adjusted(t, prefix, precision, "s", sign);
113         else
114                 return pv::util::format_time_minutes(t, precision, sign);
115 }
116
117 pv::util::Timestamp Ruler::get_time_from_x_pos(uint32_t x)
118 {
119         return view_.ruler_offset() + ((double)x + 0.5) * view_.scale();
120 }
121
122 void Ruler::contextMenuEvent(QContextMenuEvent *event)
123 {
124         context_menu_x_pos_ = event->pos().x();
125
126         QMenu *const menu = new QMenu(this);
127
128         QAction *const create_marker = new QAction(tr("Create marker here"), this);
129         connect(create_marker, SIGNAL(triggered()), this, SLOT(on_createMarker()));
130         menu->addAction(create_marker);
131
132         QAction *const toggle_hover_marker = new QAction(this);
133         connect(toggle_hover_marker, SIGNAL(triggered()), this, SLOT(on_toggleHoverMarker()));
134         menu->addAction(toggle_hover_marker);
135
136         GlobalSettings settings;
137         const bool hover_marker_shown =
138                 settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
139         toggle_hover_marker->setText(hover_marker_shown ?
140                 tr("Disable mouse hover marker") : tr("Enable mouse hover marker"));
141
142         menu->popup(event->globalPos());
143 }
144
145 void Ruler::resizeEvent(QResizeEvent*)
146 {
147         // the tick calculation depends on the width of this widget
148         invalidate_tick_position_cache();
149 }
150
151 vector< shared_ptr<ViewItem> > Ruler::items()
152 {
153         const vector< shared_ptr<TimeItem> > time_items(view_.time_items());
154         return vector< shared_ptr<ViewItem> >(
155                 time_items.begin(), time_items.end());
156 }
157
158 shared_ptr<ViewItem> Ruler::get_mouse_over_item(const QPoint &pt)
159 {
160         const vector< shared_ptr<TimeItem> > items(view_.time_items());
161         for (auto i = items.rbegin(); i != items.rend(); i++)
162                 if ((*i)->enabled() && (*i)->label_rect(rect()).contains(pt))
163                         return *i;
164         return nullptr;
165 }
166
167 void Ruler::mouseDoubleClickEvent(QMouseEvent *event)
168 {
169         view_.add_flag(get_time_from_x_pos(event->x()));
170 }
171
172 void Ruler::paintEvent(QPaintEvent*)
173 {
174         if (!tick_position_cache_) {
175                 auto ffunc = [this](const pv::util::Timestamp& t) {
176                         return format_time_with_distance(
177                                 this->view_.tick_period(),
178                                 t,
179                                 this->view_.tick_prefix(),
180                                 this->view_.time_unit(),
181                                 this->view_.tick_precision());
182                 };
183
184                 tick_position_cache_ = calculate_tick_positions(
185                         view_.tick_period(),
186                         view_.ruler_offset(),
187                         view_.scale(),
188                         width(),
189                         view_.minor_tick_count(),
190                         ffunc);
191         }
192
193         const int ValueMargin = 3;
194
195         const int text_height = calculate_text_height();
196         const int ruler_height = RulerHeight * text_height;
197         const int major_tick_y1 = text_height + ValueMargin * 2;
198         const int minor_tick_y1 = (major_tick_y1 + ruler_height) / 2;
199
200         QPainter p(this);
201
202         // Draw the tick marks
203         p.setPen(palette().color(foregroundRole()));
204
205         for (const auto& tick: tick_position_cache_->major) {
206                 const int leftedge = 0;
207                 const int rightedge = width();
208                 const int x_tick = tick.first;
209                 if ((x_tick > leftedge) && (x_tick < rightedge)) {
210                         const int x_left_bound = QFontMetrics(font()).width(tick.second) / 2;
211                         const int x_right_bound = rightedge - x_left_bound;
212                         const int x_legend = min(max(x_tick, x_left_bound), x_right_bound);
213                         p.drawText(x_legend, ValueMargin, 0, text_height,
214                                 AlignCenter | AlignTop | TextDontClip, tick.second);
215                         p.drawLine(QPointF(x_tick, major_tick_y1),
216                         QPointF(tick.first, ruler_height));
217                 }
218         }
219
220         for (const auto& tick: tick_position_cache_->minor) {
221                 p.drawLine(QPointF(tick, minor_tick_y1),
222                                 QPointF(tick, ruler_height));
223         }
224
225         // Draw the hover mark
226         draw_hover_mark(p, text_height);
227
228         p.setRenderHint(QPainter::Antialiasing);
229
230         // The cursor labels are not drawn with the arrows exactly on the
231         // bottom line of the widget, because then the selection shadow
232         // would be clipped away.
233         const QRect r = rect().adjusted(0, 0, 0, -ViewItem::HighlightRadius);
234
235         // Draw the items
236         const vector< shared_ptr<TimeItem> > items(view_.time_items());
237         for (auto &i : items) {
238                 const bool highlight = !item_dragging_ &&
239                         i->label_rect(r).contains(mouse_point_);
240                 i->paint_label(p, r, highlight);
241         }
242 }
243
244 void Ruler::draw_hover_mark(QPainter &p, int text_height)
245 {
246         const int x = view_.hover_point().x();
247
248         if (x == -1)
249                 return;
250
251         p.setPen(QPen(Qt::NoPen));
252         p.setBrush(QBrush(palette().color(foregroundRole())));
253
254         const int b = RulerHeight * text_height;
255         const float hover_arrow_size = HoverArrowSize * text_height;
256         const QPointF points[] = {
257                 QPointF(x, b),
258                 QPointF(x - hover_arrow_size, b - hover_arrow_size),
259                 QPointF(x + hover_arrow_size, b - hover_arrow_size)
260         };
261         p.drawPolygon(points, countof(points));
262 }
263
264 int Ruler::calculate_text_height() const
265 {
266         return QFontMetrics(font()).ascent();
267 }
268
269 TickPositions Ruler::calculate_tick_positions(
270         const pv::util::Timestamp& major_period,
271         const pv::util::Timestamp& offset,
272         const double scale,
273         const int width,
274         const unsigned int minor_tick_count,
275         function<QString(const pv::util::Timestamp&)> format_function)
276 {
277         TickPositions tp;
278
279         const pv::util::Timestamp minor_period = major_period / minor_tick_count;
280         const pv::util::Timestamp first_major_division = floor(offset / major_period);
281         const pv::util::Timestamp first_minor_division = ceil(offset / minor_period);
282         const pv::util::Timestamp t0 = first_major_division * major_period;
283
284         int division = (round(first_minor_division -
285                 first_major_division * minor_tick_count)).convert_to<int>() - 1;
286
287         double x;
288
289         do {
290                 pv::util::Timestamp t = t0 + division * minor_period;
291                 x = ((t - offset) / scale).convert_to<double>();
292
293                 if (division % minor_tick_count == 0) {
294                         // Recalculate 't' without using 'minor_period' which is a fraction
295                         t = t0 + division / minor_tick_count * major_period;
296                         tp.major.emplace_back(x, format_function(t));
297                 } else {
298                         tp.minor.emplace_back(x);
299                 }
300
301                 division++;
302         } while (x < width);
303
304         return tp;
305 }
306
307 void Ruler::hover_point_changed(const QPoint &hp)
308 {
309         (void)hp;
310
311         update();
312 }
313
314 void Ruler::invalidate_tick_position_cache()
315 {
316         tick_position_cache_ = boost::none;
317 }
318
319 void Ruler::on_createMarker()
320 {
321         view_.add_flag(get_time_from_x_pos(context_menu_x_pos_));
322 }
323
324 void Ruler::on_toggleHoverMarker()
325 {
326         GlobalSettings settings;
327         const bool state = settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
328         settings.setValue(GlobalSettings::Key_View_ShowHoverMarker, !state);
329 }
330
331 } // namespace trace
332 } // namespace views
333 } // namespace pv