Fix random clazy warnings

[pulseview.git] / pv / util.hpp

diff --git a/pv/util.hpp b/pv/util.hpp
index 71177ccf1e9c44504435fd15e3421ef242031446..dd7be222b073760b2ec5392ee222617d9717f869 100644 (file)
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -14,14 +14,15 @@
  * 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
 
 #include <cmath>
+#include <string>
+#include <vector>
 
 #ifndef Q_MOC_RUN
 #include <boost/multiprecision/cpp_dec_float.hpp>
@@ -30,6 +31,9 @@
 #include <QMetaType>
 #include <QString>
 
+using std::string;
+using std::vector;
+
 namespace pv {
 namespace util {
 
@@ -75,12 +79,27 @@ typedef boost::multiprecision::number<
  *
  * @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 interprets the given 'precision'
@@ -97,12 +116,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.
@@ -117,11 +132,11 @@ 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);
+
 } // namespace util
 } // namespace pv