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