DecoderSelector: Use proxy model to permit sorting
[pulseview.git] / pv / util.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #ifndef PULSEVIEW_UTIL_HPP
21 #define PULSEVIEW_UTIL_HPP
22
23 #include <cmath>
24 #include <string>
25 #include <vector>
26
27 #ifndef Q_MOC_RUN
28 #include <boost/multiprecision/cpp_dec_float.hpp>
29 #endif
30
31 #include <QMetaType>
32 #include <QString>
33
34 using std::string;
35 using std::vector;
36
37 namespace pv {
38 namespace util {
39
40 enum class TimeUnit {
41         Time = 1,
42         Samples = 2
43 };
44
45 enum class SIPrefix {
46         unspecified = -1,
47         yocto, zepto,
48         atto, femto, pico,
49         nano, micro, milli,
50         none,
51         kilo, mega, giga,
52         tera, peta, exa,
53         zetta, yotta
54 };
55
56 /// Returns the exponent that corresponds to a given prefix.
57 int exponent(SIPrefix prefix);
58
59 /// Timestamp type providing yoctosecond resolution.
60 typedef boost::multiprecision::number<
61         boost::multiprecision::cpp_dec_float<24>,
62         boost::multiprecision::et_off> Timestamp;
63
64 /**
65  * Formats a given timestamp with the specified SI prefix.
66  *
67  * If 'prefix' is left 'unspecified', the function chooses a prefix so that
68  * the value in front of the decimal point is between 1 and 999.
69  *
70  * The default value "s" for the unit argument makes the most sense when
71  * formatting time values, but a different value can be given if the function
72  * is reused to format a value of another quantity.
73  *
74  * @param t The value to format.
75  * @param prefix The SI prefix to use.
76  * @param precision The number of digits after the decimal separator.
77  * @param unit The unit of quantity.
78  * @param sign Whether or not to add a sign also for positive numbers.
79  *
80  * @return The formatted value.
81  */
82 QString format_time_si(const Timestamp& v,
83         SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
84         QString unit = "s", bool sign = true);
85
86 /**
87  * Formats a given value into a representation using SI units.
88  *
89  * If 'prefix' is left 'unspecified', the function chooses a prefix so that
90  * the value in front of the decimal point is between 1 and 999.
91  *
92  * @param value The value to format.
93  * @param prefix The SI prefix to use.
94  * @param precision The number of digits after the decimal separator.
95  * @param unit The unit of quantity.
96  * @param sign Whether or not to add a sign also for positive numbers.
97  *
98  * @return The formatted value.
99  */
100 QString format_value_si(double v,
101         SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
102         QString unit = "", bool sign = true);
103
104 /**
105  * Wrapper around 'format_time_si()' that interprets the given 'precision'
106  * value as the number of decimal places if the timestamp would be formatted
107  * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
108  * match the given 'prefix'
109  *
110  * @param t The value to format.
111  * @param prefix The SI prefix to use.
112  * @param precision The number of digits after the decimal separator if the
113  *        'prefix' would be 'SIPrefix::none', see above for more information.
114  * @param unit The unit of quantity.
115  * @param sign Whether or not to add a sign also for positive numbers.
116  *
117  * @return The formatted value.
118  */
119 QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
120         unsigned precision = 0, QString unit = "s", bool sign = true);
121
122 /**
123  * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
124  *
125  * "DD" and "HH" are left out if they would be "00" (but if "DD" is generated,
126  * "HH" is also always generated. The "MM:SS" part is always produced, the
127  * number of subsecond digits can be influenced using the 'precision' parameter.
128  *
129  * @param t The value to format.
130  * @param precision The number of digits after the decimal separator.
131  * @param sign Whether or not to add a sign also for positive numbers.
132  *
133  * @return The formatted value.
134  */
135 QString format_time_minutes(const Timestamp& t, signed precision = 0,
136         bool sign = true);
137
138 vector<string> split_string(string text, string separator);
139
140 } // namespace util
141 } // namespace pv
142
143 Q_DECLARE_METATYPE(pv::util::Timestamp)
144
145 #endif // PULSEVIEW_UTIL_HPP