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
  29 #include <QTextStream>
  30 #include <QDebug>
  31
  32 using namespace Qt;
  33
  34 namespace pv {
  35 namespace util {
  36
  37 static const QString SIPrefixes[17] =
  38         {"y", "z", "a", "f", "p", "n", QChar(0x03BC), "m", "", "k", "M", "G",
  39         "T", "P", "E", "Z", "Y"};
  40 const int FirstSIPrefix = 8;
  41 const int FirstSIPrefixPower = -(FirstSIPrefix * 3);
  42 const double MinTimeDelta = 1e-15; // Anything below 1 fs can be considered zero
  43
  44 QString format_si_value(double v, QString unit, int prefix,
  45         unsigned int precision, bool sign)
  46 {
  47         if (prefix < 0) {
  48                 int exp = -FirstSIPrefixPower;
  49
  50                 prefix = 0;
  51                 while ((fabs(v) * pow(10.0, exp)) > 999.0 &&
  52                         prefix < (int)(countof(SIPrefixes) - 1)) {
  53                         prefix++;
  54                         exp -= 3;
  55                 }
  56         }
  57
  58         assert(prefix >= 0);
  59         assert(prefix < (int)countof(SIPrefixes));
  60
  61         const double multiplier = pow(10.0,
  62                 (int)- prefix * 3 - FirstSIPrefixPower);
  63
  64         QString s;
  65         QTextStream ts(&s);
  66         if (sign)
  67                 ts << forcesign;
  68         ts << fixed << qSetRealNumberPrecision(precision) <<
  69                 (v  * multiplier) << " " << SIPrefixes[prefix] << unit;
  70
  71         return s;
  72 }
  73
  74 static QString pad_number(unsigned int number, int length)
  75 {
  76         return QString("%1").arg(number, length, 10, QChar('0'));
  77 }
  78
  79 static QString format_time_in_full(double t, signed precision, bool force_sign)
  80 {
  81         const unsigned int whole_seconds = abs((int) t);
  82         const unsigned int days = whole_seconds / (60 * 60 * 24);
  83         const unsigned int hours = (whole_seconds / (60 * 60)) % 24;
  84         const unsigned int minutes = (whole_seconds / 60) % 60;
  85         const unsigned int seconds = whole_seconds % 60;
  86
  87         QString s;
  88         QTextStream ts(&s);
  89
  90         if (force_sign && (t >= 0))
  91                 ts << "+";
  92         if (t < 0)
  93                 ts << "-";
  94
  95         bool use_padding = false;
  96
  97         if (days) {
  98                 ts << days << ":";
  99                 use_padding = true;
 100         }
 101
 102         if (hours || days) {
 103                 ts << pad_number(hours, use_padding ? 2 : 0) << ":";
 104                 use_padding = true;
 105         }
 106
 107         if (minutes || hours || days) {
 108                 ts << pad_number(minutes, use_padding ? 2 : 0);
 109                 use_padding = true;
 110
 111                 // We're not showing any seconds with a negative precision
 112                 if (precision >= 0)
 113                          ts << ":";
 114         }
 115
 116         // precision < 0: Use DD:HH:MM format
 117         // precision = 0: Use DD:HH:MM:SS format
 118         // precision > 0: Use DD:HH:MM:SS.mmm nnn ppp fff format
 119         if (precision >= 0) {
 120                 ts << pad_number(seconds, use_padding ? 2 : 0);
 121
 122                 const double fraction = fabs(t) - whole_seconds;
 123
 124                 if (precision > 0 && precision < 1000) {
 125                         QString fs = QString("%1").arg(fraction, -(2 + precision), 'f',
 126                                 precision, QChar('0'));
 127
 128                         ts << ".";
 129
 130                         // Copy all digits, inserting spaces as unit separators
 131                         for (int i = 1; i <= precision; i++) {
 132                                 // Start at index 2 to skip the "0." at the beginning
 133                                 ts << fs[1 + i];
 134
 135                                 if ((i > 0) && (i % 3 == 0))
 136                                         ts << " ";
 137                         }
 138                 }
 139         }
 140
 141         return s;
 142 }
 143
 144 static QString format_time_with_si(double t, QString unit, int prefix,
 145         unsigned int precision, bool sign)
 146 {
 147         // The precision is always given without taking the prefix into account
 148         // so we need to deduct the number of decimals the prefix might imply
 149         const int prefix_order =
 150                 -(prefix * 3 + pv::util::FirstSIPrefixPower);
 151
 152         const unsigned int relative_prec =
 153                 (prefix >= pv::util::FirstSIPrefix) ? precision :
 154                 std::max((int)(precision - prefix_order), 0);
 155
 156         return format_si_value(t, unit, prefix, relative_prec, sign);
 157 }
 158
 159 QString format_time(double t, int prefix, TimeUnit unit,
 160         unsigned int precision, double step_size, bool sign)
 161 {
 162         // Make 0 appear as 0, not random +0 or -0
 163         if (fabs(t) < MinTimeDelta)
 164                 return "0";
 165
 166         // If we have to use samples then we have no alternative formats
 167         if (unit == Samples)
 168                 return format_time_with_si(t, "sa", prefix, precision, sign);
 169
 170         // View zoomed way out -> low precision (0), high step size (>=60s)
 171         // -> DD:HH:MM
 172         if ((precision == 0) && (step_size >= 60))
 173                 return format_time_in_full(t, -1, sign);
 174
 175         // View in "normal" range -> medium precision, medium step size
 176         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than 60 seconds
 177         // View zoomed way in -> high precision (>3), low step size (<1s)
 178         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than 60 seconds
 179         if (abs(t) < 60)
 180                 return format_time_with_si(t, "s", prefix, precision, sign);
 181         else
 182                 return format_time_in_full(t, precision, sign);
 183 }
 184
 185 QString format_second(double second)
 186 {
 187         return format_si_value(second, "s", -1, 0, false);
 188 }
 189
 190 } // namespace util
 191 } // namespace pv