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