Session: Fix issue #67 by improving error handling

[pulseview.git] / pv / util.hpp

diff --git a/pv/util.hpp b/pv/util.hpp
index 1c78b89f1831b802f16531a90bed7a489905d92f..67236c0dcc62420cf1be2a78bc0fa36a5f834d6f 100644 (file)
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -17,22 +17,32 @@
  * 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
 };
@@ -56,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.
  *
@@ -74,12 +89,27 @@ typedef boost::multiprecision::number<
  *
  * @return The formatted value.
  */
-QString format_time_si(
-       const Timestamp& v,
-       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 interprets the given 'precision'
@@ -96,12 +126,8 @@ QString format_time_si(
  *
  * @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.
@@ -116,14 +142,23 @@ QString format_time_si_adjusted(
  *
  * @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