Trace View: Move ruler time conversion from View to Ruler
[pulseview.git] / pv / views / trace / ruler.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_RULER_HPP
21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_RULER_HPP
22
23 #include <functional>
24 #include <memory>
25
26 #include <boost/optional.hpp>
27
28 #include "marginwidget.hpp"
29 #include <pv/util.hpp>
30
31 using std::function;
32 using std::pair;
33 using std::shared_ptr;
34 using std::vector;
35
36 namespace RulerTest {
37 struct tick_position_test_0;
38 struct tick_position_test_1;
39 struct tick_position_test_2;
40 }
41
42 namespace pv {
43 namespace views {
44 namespace trace {
45
46 class TimeItem;
47 class ViewItem;
48
49 struct TickPositions
50 {
51         vector<pair<double, QString>> major;
52         vector<double> minor;
53 };
54
55 /**
56  * The Ruler class manages and displays the time scale above the trace canvas.
57  * It may also contain @ref TimeItem instances used to identify or highlight
58  * time-related information.
59  */
60 class Ruler : public MarginWidget
61 {
62         Q_OBJECT
63
64         friend struct RulerTest::tick_position_test_0;
65         friend struct RulerTest::tick_position_test_1;
66         friend struct RulerTest::tick_position_test_2;
67
68 private:
69         /// Height of the ruler in multipes of the text height
70         static const float RulerHeight;
71
72         /// Height of the hover arrow in multiples of the text height
73         static const float HoverArrowSize;
74
75 public:
76         Ruler(View &parent);
77
78         QSize sizeHint() const override;
79
80         /**
81          * The extended area that the header widget would like to be sized to.
82          * @remarks This area is the area specified by sizeHint, extended by
83          * the area to overlap the viewport.
84          */
85         QSize extended_size_hint() const override;
86
87         /**
88          * Formats a timestamp depending on its distance to another timestamp.
89          *
90          * Heuristic function, useful when multiple timestamps should be put side by
91          * side. The function procedes in the following order:
92          *   - If 't' is zero, "0" is returned.
93          *   - If 'unit' is 'TimeUnit::Samples', 'pv::util::format_time_si_adjusted()'
94          *     is used to format 't'.
95          *   - If a zoomed out view is detected (determined by 'precision' and
96          *     'distance'), 'pv::util::format_time_minutes() is used.
97          *   - For timestamps "near the origin" (determined by 'distance'),
98          *    'pv::util::format_time_si_adjusted()' is used.
99          *   - If none of the previous was true, 'pv::util::format_time_minutes()'
100          *     is used again.
101          *
102          * @param distance The distance between the timestamp to format and
103          *        an adjacent one.
104          * @param t The value to format
105          * @param prefix The SI prefix to use.
106          * @param unit The representation of the timestamp value.
107          * @param precision The number of digits after the decimal separator.
108          * @param sign Whether or not to add a sign also for positive numbers.
109          *
110          * @return The formated value.
111          */
112         static QString format_time_with_distance(
113                 const pv::util::Timestamp& distance,
114                 const pv::util::Timestamp& t,
115                 pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified,
116                 pv::util::TimeUnit unit = pv::util::TimeUnit::Time,
117                 unsigned precision = 0,
118                 bool sign = true);
119
120         pv::util::Timestamp get_absolute_time_from_x_pos(uint32_t x) const;
121         pv::util::Timestamp get_ruler_time_from_x_pos(uint32_t x) const;
122
123         pv::util::Timestamp get_ruler_time_from_absolute_time(const pv::util::Timestamp& abs_time) const;
124         pv::util::Timestamp get_absolute_time_from_ruler_time(const pv::util::Timestamp& ruler_time) const;
125
126 protected:
127         virtual void contextMenuEvent(QContextMenuEvent *event) override;
128         void resizeEvent(QResizeEvent*) override;
129
130 private:
131         /**
132          * Gets the time items.
133          */
134         vector< shared_ptr<ViewItem> > items() override;
135
136         /**
137          * Gets the first view item which has a label that contains @c pt .
138          * @param pt the point to search with.
139          * @return the view item that has been found, or and empty
140          *   @c shared_ptr if no item was found.
141          */
142         shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt) override;
143
144         void mouseDoubleClickEvent(QMouseEvent *event) override;
145
146         void paintEvent(QPaintEvent *event) override;
147
148         /**
149          * Draw a hover arrow under the cursor position.
150          * @param p The painter to draw into.
151          * @param text_height The height of a single text ascent.
152          */
153         void draw_hover_mark(QPainter &p, int text_height);
154
155         int calculate_text_height() const;
156
157         /**
158          * Calculates the major and minor tick positions.
159          *
160          * @param major_period The period between the major ticks.
161          * @param offset The virtual time at the left border of the ruler.
162          * @param scale The scale in seconds per pixel.
163          * @param width the Width of the ruler.
164          * @param format_function A function used to format the major tick times.
165          * @return An object of type 'TickPositions' that contains the major tick
166          *         positions together with the labels at that ticks, and the minor
167          *         tick positions.
168          */
169         static TickPositions calculate_tick_positions(
170                 const pv::util::Timestamp& major_period,
171                 const pv::util::Timestamp& offset,
172                 const double scale,
173                 const int width,
174                 const unsigned int minor_tick_count,
175                 function<QString(const pv::util::Timestamp&)> format_function);
176
177 private Q_SLOTS:
178         void on_hover_point_changed(const QWidget* widget, const QPoint &hp);
179
180         void invalidate_tick_position_cache();
181
182         void on_createMarker();
183         void on_setZeroPosition();
184         void on_toggleHoverMarker();
185
186 private:
187         /**
188          * Holds the tick positions so that they don't have to be recalculated on
189          * every redraw. Set by 'paintEvent()' when needed.
190          */
191         boost::optional<TickPositions> tick_position_cache_;
192
193         uint32_t context_menu_x_pos_;
194 };
195
196 } // namespace trace
197 } // namespace views
198 } // namespace pv
199
200 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_RULER_HPP