X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Futil.hpp;h=49ae04b2dbc024814e61e88428dc896e8949e0b2;hp=5be379035bd875ae4bf3e6636444b89a5903519a;hb=HEAD;hpb=3ccf0f7f5b1b31ac628a983a2becee6f4c4c1507

diff --git a/pv/util.hpp b/pv/util.hpp
index 5be37903..67236c0d 100644
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -14,24 +14,35 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef PULSEVIEW_UTIL_HPP
-#define PULSEVIEW_UTIL_HPP
+#ifndef PULSEVIEW_PV_UTIL_HPP
+#define PULSEVIEW_PV_UTIL_HPP
 
 #include <cmath>
+#include <string>
+#include <vector>
+
+#ifndef Q_MOC_RUN
+// Workaround for https://github.com/boostorg/serialization/issues/186
+#include <boost/serialization/nvp.hpp>
 
 #include <boost/multiprecision/cpp_dec_float.hpp>
+#endif
 
 #include <QMetaType>
 #include <QString>
+#include <QFontMetrics>
+
+using std::string;
+using std::vector;
 
 namespace pv {
 namespace util {
 
 enum class TimeUnit {
+	None = 0,
 	Time = 1,
 	Samples = 2
 };
@@ -55,6 +66,11 @@ typedef boost::multiprecision::number<
 	boost::multiprecision::cpp_dec_float<24>,
 	boost::multiprecision::et_off> Timestamp;
 
+/**
+ * Chooses a prefix so that the value in front of the decimal point is between 1 and 999.
+ */
+SIPrefix determine_value_prefix(double v);
+
 /**
  * Formats a given timestamp with the specified SI prefix.
  *
@@ -71,19 +87,34 @@ typedef boost::multiprecision::number<
  * @param unit The unit of quantity.
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time_si(
-	const Timestamp& t,
-	SIPrefix prefix = SIPrefix::unspecified,
-	unsigned precision = 0,
-	QString unit = "s",
-	bool sign = true);
+QString format_time_si(const Timestamp& v,
+	SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
+	QString unit = "s", bool sign = true);
+
+/**
+ * Formats a given value into a representation using SI units.
+ *
+ * If 'prefix' is left 'unspecified', the function chooses a prefix so that
+ * the value in front of the decimal point is between 1 and 999.
+ *
+ * @param value The value to format.
+ * @param prefix The SI prefix to use.
+ * @param precision The number of digits after the decimal separator.
+ * @param unit The unit of quantity.
+ * @param sign Whether or not to add a sign also for positive numbers.
+ *
+ * @return The formatted value.
+ */
+QString format_value_si(double v,
+	SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
+	QString unit = "", bool sign = true);
 
 /**
- * Wrapper around 'format_time_si()' that interpretes the given 'precision'
+ * Wrapper around 'format_time_si()' that interprets the given 'precision'
  * value as the number of decimal places if the timestamp would be formatted
- * without a SI prefix (using 'SIPrefix::none') and adjustes the precision to
+ * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
  * match the given 'prefix'
  *
  * @param t The value to format.
@@ -93,14 +124,10 @@ QString format_time_si(
  * @param unit The unit of quantity.
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time_si_adjusted(
-	const Timestamp& t,
-	SIPrefix prefix,
-	unsigned precision = 0,
-	QString unit = "s",
-	bool sign = true);
+QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
+	unsigned precision = 0, QString unit = "s", bool sign = true);
 
 /**
  * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
@@ -113,16 +140,25 @@ QString format_time_si_adjusted(
  * @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.
+ * @return The formatted value.
  */
-QString format_time_minutes(
-	const Timestamp& t,
-	signed precision = 0,
+QString format_time_minutes(const Timestamp& t, signed precision = 0,
 	bool sign = true);
 
+vector<string> split_string(string text, string separator);
+
+/**
+ * Return the width of a string in a given font.
+ * @param[in] metric metrics of the font
+ * @param[in] string the string whose width should be determined
+ *
+ * @return width of the string in pixels
+ */
+std::streamsize text_width(const QFontMetrics &metric, const QString &string);
+
 } // namespace util
 } // namespace pv
 
 Q_DECLARE_METATYPE(pv::util::Timestamp)
 
-#endif // PULSEVIEW_UTIL_HPP
+#endif // PULSEVIEW_PV_UTIL_HPP