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