X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fview%2Fruler.hpp;h=cf63eaff7c7cb27ae0b2ec451801bda05b23677d;hp=50bbf2cdc0038075d8fbdea98cc0ba2b3af938fa;hb=2220e94218298b208041c5e828595d9e1b842c88;hpb=7a01bd3654ed046216308fa64edfd79be7cd525f

diff --git a/pv/view/ruler.hpp b/pv/view/ruler.hpp
index 50bbf2cd..cf63eaff 100644
--- a/pv/view/ruler.hpp
+++ b/pv/view/ruler.hpp
@@ -21,9 +21,19 @@
 #ifndef PULSEVIEW_PV_VIEW_RULER_HPP
 #define PULSEVIEW_PV_VIEW_RULER_HPP
 
+#include <functional>
 #include <memory>
 
+#include <boost/optional.hpp>
+
 #include "marginwidget.hpp"
+#include <pv/util.hpp>
+
+namespace RulerTest {
+class tick_position_test_0;
+class tick_position_test_1;
+class tick_position_test_2;
+}
 
 namespace pv {
 namespace view {
@@ -35,6 +45,10 @@ class Ruler : public MarginWidget
 {
 	Q_OBJECT
 
+	friend class RulerTest::tick_position_test_0;
+	friend class RulerTest::tick_position_test_1;
+	friend class RulerTest::tick_position_test_2;
+
 private:
 
 	/// Height of the ruler in multipes of the text height
@@ -58,6 +72,39 @@ public:
 	 */
 	QSize extended_size_hint() const;
 
+	/**
+	 * Formats a timestamp depending on its distance to another timestamp.
+	 *
+	 * Heuristic function, useful when multiple timestamps should be put side by
+	 * side. The function procedes in the following order:
+	 *   - If 't' is zero, "0" is returned.
+	 *   - If 'unit' is 'TimeUnit::Samples', 'pv::util::format_time_si_adjusted()'
+	 *     is used to format 't'.
+	 *   - If a zoomed out view is detected (determined by 'precision' and
+	 *     'distance'), 'pv::util::format_time_minutes() is used.
+	 *   - For timestamps "near the origin" (determined by 'distance'),
+	 *    'pv::util::format_time_si_adjusted()' is used.
+	 *   - If none of the previous was true, 'pv::util::format_time_minutes()'
+	 *     is used again.
+	 *
+	 * @param distance The distance between the timestamp to format and
+	 *        an adjacent one.
+	 * @param t The value to format
+	 * @param prefix The SI prefix to use.
+	 * @param unit The representation of the timestamp value.
+	 * @param precision The number of digits after the decimal separator.
+	 * @param sign Whether or not to add a sign also for positive numbers.
+	 *
+	 * @return The formated value.
+	 */
+	static QString format_time_with_distance(
+		const pv::util::Timestamp& distance,
+		const pv::util::Timestamp& t,
+		pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified,
+		pv::util::TimeUnit unit = pv::util::TimeUnit::Time,
+		unsigned precision = 0,
+		bool sign = true);
+
 private:
 	/**
 	 * Gets the time items.
@@ -73,12 +120,10 @@ private:
 	std::shared_ptr<pv::view::ViewItem> get_mouse_over_item(
 		const QPoint &pt);
 
-private:
 	void paintEvent(QPaintEvent *event);
 
 	void mouseDoubleClickEvent(QMouseEvent *e);
 
-private:
 	/**
 	 * Draw a hover arrow under the cursor position.
 	 * @param p The painter to draw into.
@@ -88,8 +133,45 @@ private:
 
 	int calculate_text_height() const;
 
+	struct TickPositions
+	{
+		std::vector<std::pair<double, QString>> major;
+		std::vector<double> minor;
+	};
+
+	/**
+	 * Holds the tick positions so that they don't have to be recalculated on
+	 * every redraw. Set by 'paintEvent()' when needed.
+	 */
+	boost::optional<TickPositions> tick_position_cache_;
+
+	/**
+	 * Calculates the major and minor tick positions.
+	 *
+	 * @param major_period The period between the major ticks.
+	 * @param offset The time at the left border of the ruler.
+	 * @param scale The scale in seconds per pixel.
+	 * @param width the Width of the ruler.
+	 * @param format_function A function used to format the major tick times.
+	 * @return An object of type 'TickPositions' that contains the major tick
+	 *         positions together with the labels at that ticks, and the minor
+	 *         tick positions.
+	 */
+	static TickPositions calculate_tick_positions(
+		const pv::util::Timestamp& major_period,
+		const pv::util::Timestamp& offset,
+		const double scale,
+		const int width,
+		std::function<QString(const pv::util::Timestamp&)> format_function);
+
+protected:
+	void resizeEvent(QResizeEvent*) override;
+
 private Q_SLOTS:
 	void hover_point_changed();
+
+	// Resets the 'tick_position_cache_'.
+	void invalidate_tick_position_cache();
 };
 
 } // namespace view