2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_UTIL_HPP
21 #define PULSEVIEW_PV_UTIL_HPP
28 #include <boost/multiprecision/cpp_dec_float.hpp>
33 #include <QFontMetrics>
58 /// Returns the exponent that corresponds to a given prefix.
59 int exponent(SIPrefix prefix);
61 /// Timestamp type providing yoctosecond resolution.
62 typedef boost::multiprecision::number<
63 boost::multiprecision::cpp_dec_float<24>,
64 boost::multiprecision::et_off> Timestamp;
67 * Chooses a prefix so that the value in front of the decimal point is between 1 and 999.
69 SIPrefix determine_value_prefix(double v);
72 * Formats a given timestamp with the specified SI prefix.
74 * If 'prefix' is left 'unspecified', the function chooses a prefix so that
75 * the value in front of the decimal point is between 1 and 999.
77 * The default value "s" for the unit argument makes the most sense when
78 * formatting time values, but a different value can be given if the function
79 * is reused to format a value of another quantity.
81 * @param t The value to format.
82 * @param prefix The SI prefix to use.
83 * @param precision The number of digits after the decimal separator.
84 * @param unit The unit of quantity.
85 * @param sign Whether or not to add a sign also for positive numbers.
87 * @return The formatted value.
89 QString format_time_si(const Timestamp& v,
90 SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
91 QString unit = "s", bool sign = true);
94 * Formats a given value into a representation using SI units.
96 * If 'prefix' is left 'unspecified', the function chooses a prefix so that
97 * the value in front of the decimal point is between 1 and 999.
99 * @param value The value to format.
100 * @param prefix The SI prefix to use.
101 * @param precision The number of digits after the decimal separator.
102 * @param unit The unit of quantity.
103 * @param sign Whether or not to add a sign also for positive numbers.
105 * @return The formatted value.
107 QString format_value_si(double v,
108 SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
109 QString unit = "", bool sign = true);
112 * Wrapper around 'format_time_si()' that interprets the given 'precision'
113 * value as the number of decimal places if the timestamp would be formatted
114 * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
115 * match the given 'prefix'
117 * @param t The value to format.
118 * @param prefix The SI prefix to use.
119 * @param precision The number of digits after the decimal separator if the
120 * 'prefix' would be 'SIPrefix::none', see above for more information.
121 * @param unit The unit of quantity.
122 * @param sign Whether or not to add a sign also for positive numbers.
124 * @return The formatted value.
126 QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
127 unsigned precision = 0, QString unit = "s", bool sign = true);
130 * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
132 * "DD" and "HH" are left out if they would be "00" (but if "DD" is generated,
133 * "HH" is also always generated. The "MM:SS" part is always produced, the
134 * number of subsecond digits can be influenced using the 'precision' parameter.
136 * @param t The value to format.
137 * @param precision The number of digits after the decimal separator.
138 * @param sign Whether or not to add a sign also for positive numbers.
140 * @return The formatted value.
142 QString format_time_minutes(const Timestamp& t, signed precision = 0,
145 vector<string> split_string(string text, string separator);
148 * Return the width of a string in a given font.
149 * @param[in] metric metrics of the font
150 * @param[in] string the string whose width should be determined
152 * @return width of the string in pixels
154 std::streamsize text_width(const QFontMetrics &metric, const QString &string);
159 Q_DECLARE_METATYPE(pv::util::Timestamp)
161 #endif // PULSEVIEW_PV_UTIL_HPP