View: Use list_by_type to get TraceTreeItems
[pulseview.git] / pv / util.cpp
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, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include "util.hpp"
22
23 #include <extdef.h>
24
25 #include <assert.h>
26
27 #include <algorithm>
28 #include <sstream>
29
30 #include <QTextStream>
31 #include <QDebug>
32
33 using namespace Qt;
34
35 namespace pv {
36 namespace util {
37
38 static QTextStream& operator<<(QTextStream& stream, SIPrefix prefix)
39 {
40         switch (prefix) {
41         case SIPrefix::yocto: return stream << 'y';
42         case SIPrefix::zepto: return stream << 'z';
43         case SIPrefix::atto:  return stream << 'a';
44         case SIPrefix::femto: return stream << 'f';
45         case SIPrefix::pico:  return stream << 'p';
46         case SIPrefix::nano:  return stream << 'n';
47         case SIPrefix::micro: return stream << QChar(0x03BC);
48         case SIPrefix::milli: return stream << 'm';
49         case SIPrefix::kilo:  return stream << 'k';
50         case SIPrefix::mega:  return stream << 'M';
51         case SIPrefix::giga:  return stream << 'G';
52         case SIPrefix::tera:  return stream << 'T';
53         case SIPrefix::peta:  return stream << 'P';
54         case SIPrefix::exa:   return stream << 'E';
55         case SIPrefix::zetta: return stream << 'Z';
56         case SIPrefix::yotta: return stream << 'Y';
57
58         default: return stream;
59         }
60 }
61
62 int exponent(SIPrefix prefix)
63 {
64         return 3 * (static_cast<int>(prefix) - static_cast<int>(SIPrefix::none));
65 }
66
67 static SIPrefix successor(SIPrefix prefix)
68 {
69         assert(prefix != SIPrefix::yotta);
70         return static_cast<SIPrefix>(static_cast<int>(prefix) + 1);
71 }
72
73 // Insert the timestamp value into the stream in fixed-point notation
74 // (and honor the precision)
75 static QTextStream& operator<<(QTextStream& stream, const Timestamp& t)
76 {
77         // The multiprecision types already have a function and a stream insertion
78         // operator to convert them to a string, however these functions abuse a
79         // precision value of zero to print all available decimal places instead of
80         // none, and the boost authors refuse to fix this because they don't want
81         // to break buggy code that relies on this bug.
82         // (https://svn.boost.org/trac/boost/ticket/10103)
83         // Therefore we have to work around the case where precision is zero.
84
85         int precision = stream.realNumberPrecision();
86
87         std::ostringstream ss;
88         ss << std::fixed;
89
90         if (stream.numberFlags() & QTextStream::ForceSign) {
91                 ss << std::showpos;
92         }
93
94         if (0 == precision) {
95                 ss
96                         << std::setprecision(1)
97                         << round(t);
98         } else {
99                 ss
100                         << std::setprecision(precision)
101                         << t;
102         }
103
104         std::string str(ss.str());
105         if (0 == precision) {
106                 // remove the separator and the unwanted decimal place
107                 str.resize(str.size() - 2);
108         }
109
110         return stream << QString::fromStdString(str);
111 }
112
113 QString format_time_si(
114         const Timestamp& v,
115         SIPrefix prefix,
116         unsigned int precision,
117         QString unit,
118         bool sign)
119 {
120         if (prefix == SIPrefix::unspecified) {
121                 // No prefix given, calculate it
122
123                 if (v.is_zero()) {
124                         prefix = SIPrefix::none;
125                 } else {
126                         int exp = exponent(SIPrefix::yotta);
127                         prefix = SIPrefix::yocto;
128                         while ((fabs(v) * pow(Timestamp(10), exp)) > 999 &&
129                                         prefix < SIPrefix::yotta) {
130                                 prefix = successor(prefix);
131                                 exp -= 3;
132                         }
133                 }
134         }
135
136         assert(prefix >= SIPrefix::yocto);
137         assert(prefix <= SIPrefix::yotta);
138
139         const Timestamp multiplier = pow(Timestamp(10), -exponent(prefix));
140
141         QString s;
142         QTextStream ts(&s);
143         if (sign && !v.is_zero())
144                 ts << forcesign;
145         ts
146                 << qSetRealNumberPrecision(precision)
147                 << (v * multiplier)
148                 << ' '
149                 << prefix
150                 << unit;
151
152         return s;
153 }
154
155 QString format_time_si_adjusted(
156         const Timestamp& t,
157         SIPrefix prefix,
158         unsigned precision,
159         QString unit,
160         bool sign)
161 {
162         // The precision is always given without taking the prefix into account
163         // so we need to deduct the number of decimals the prefix might imply
164         const int prefix_order = -exponent(prefix);
165
166         const unsigned int relative_prec =
167                 (prefix >= SIPrefix::none) ? precision :
168                 std::max((int)(precision - prefix_order), 0);
169
170         return format_time_si(t, prefix, relative_prec, unit, sign);
171 }
172
173
174 // Helper for 'format_time_minutes()'.
175 static QString pad_number(unsigned int number, int length)
176 {
177         return QString("%1").arg(number, length, 10, QChar('0'));
178 }
179
180 QString format_time_minutes(const Timestamp& t, signed precision, bool sign)
181 {
182         const Timestamp whole_seconds = floor(abs(t));
183         const Timestamp days = floor(whole_seconds / (60 * 60 * 24));
184         const unsigned int hours = fmod(whole_seconds / (60 * 60), 24).convert_to<uint>();
185         const unsigned int minutes = fmod(whole_seconds / 60, 60).convert_to<uint>();
186         const unsigned int seconds = fmod(whole_seconds, 60).convert_to<uint>();
187
188         QString s;
189         QTextStream ts(&s);
190
191         if (t < 0)
192                 ts << "-";
193         else if (sign)
194                 ts << "+";
195
196         bool use_padding = false;
197
198         // DD
199         if (days) {
200                 ts << days.str().c_str() << ":";
201                 use_padding = true;
202         }
203
204         // HH
205         if (hours || days) {
206                 ts << pad_number(hours, use_padding ? 2 : 0) << ":";
207                 use_padding = true;
208         }
209
210         // MM
211         ts << pad_number(minutes, use_padding ? 2 : 0);
212
213         ts << ":";
214
215         // SS
216         ts << pad_number(seconds, 2);
217
218         if (precision) {
219                 ts << ".";
220
221                 const Timestamp fraction = fabs(t) - whole_seconds;
222
223                 std::ostringstream ss;
224                 ss
225                         << std::fixed
226                         << std::setprecision(precision)
227                         << std::setfill('0')
228                         << fraction;
229                 std::string fs = ss.str();
230
231                 // Copy all digits, inserting spaces as unit separators
232                 for (int i = 1; i <= precision; i++) {
233                         // Start at index 2 to skip the "0." at the beginning
234                         ts << fs.at(1 + i);
235
236                         if ((i > 0) && (i % 3 == 0) && (i != precision))
237                                 ts << " ";
238                 }
239         }
240
241         return s;
242 }
243
244 } // namespace util
245 } // namespace pv