hush: move msh/lash config into hush.c, no code changes
[oweals/busybox.git] / libbb / human_readable.c
index 36783fac7d8a9efca5d018f716fabf1bb01acdf1..4228aaf4229bd35f3a4f92785931283434054a5e 100644 (file)
 /* vi: set sw=4 ts=4: */
 /*
- * Utility routines.
+ * June 30, 2001                 Manuel Novoa III
  *
- * Copyright (C) tons of folks.  Tracking down who wrote what
- * isn't something I'm going to worry about...  If you wrote something
- * here, please feel free to acknowledge your work.
+ * All-integer version (hey, not everyone has floating point) of
+ * make_human_readable_str, modified from similar code I had written
+ * for busybox several months ago.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * Notes:
+ *   1) I'm using an unsigned long long to hold the product size * block_size,
+ *      as df (which calls this routine) could request a representation of a
+ *      partition size in bytes > max of unsigned long.  If long longs aren't
+ *      available, it would be possible to do what's needed using polynomial
+ *      representations (say, powers of 1024) and manipulating coefficients.
+ *      The base ten "bytes" output could be handled similarly.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
+ *   2) This routine always outputs a decimal point and a tenths digit when
+ *      display_unit != 0.  Hence, it isn't uncommon for the returned string
+ *      to have a length of 5 or 6.
  *
- * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *      It might be nice to add a flag to indicate no decimal digits in
+ *      that case.  This could be either an additional parameter, or a
+ *      special value of display_unit.  Such a flag would also be nice for du.
  *
- * Based in part on code from sash, Copyright (c) 1999 by David I. Bell 
- * Permission has been granted to redistribute this code under the GPL.
+ *      Some code to omit the decimal point and tenths digit is sketched out
+ *      and "#if 0"'d below.
  *
+ * Licensed under GPLv2, see file LICENSE in this tarball for details.
  */
 
-#include <stdio.h>
 #include "libbb.h"
 
-static char buffer[10];
-static const char *suffixes[] = { "", "k", "M", "G", "T" };
-
-const char *make_human_readable_str(unsigned long val, unsigned long not_hr)
+const char* FAST_FUNC make_human_readable_str(unsigned long long val,
+       unsigned long block_size, unsigned long display_unit)
 {
-       int suffix, base;
-
-       if (not_hr)
-               sprintf(buffer, "%lu", val);
-       else
-               for (suffix = 0, base = 1; suffix < 5; suffix++, base <<= 10) {
-                       if (val < (base << 10)) {
-                               if (suffix && val < 10 * base)
-                                       sprintf(buffer, "%lu.%lu%s", val / base,
-                                                       (val % base) * 10 / base, suffixes[suffix]);
-                               else
-                                       sprintf(buffer, "%lu%s", val / base, suffixes[suffix]);
-                               break;
+       static const char unit_chars[] ALIGN1 = {
+               '\0', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y'
+       };
+
+       static char *str;
+
+       unsigned frac; /* 0..9 - the fractional digit */
+       const char *u;
+       const char *fmt;
+
+       if (val == 0)
+               return "0";
+
+       fmt = "%llu";
+       if (block_size > 1)
+               val *= block_size;
+       frac = 0;
+       u = unit_chars;
+
+       if (display_unit) {
+               val += display_unit/2;  /* Deal with rounding */
+               val /= display_unit;    /* Don't combine with the line above! */
+               /* will just print it as ulonglong (below) */
+       } else {
+               while ((val >= 1024)
+                /* && (u < unit_chars + sizeof(unit_chars) - 1) - always true */
+               ) {
+                       fmt = "%llu.%u%c";
+                       u++;
+                       frac = (((unsigned)val % 1024) * 10 + 1024/2) / 1024;
+                       val /= 1024;
+               }
+               if (frac >= 10) { /* we need to round up here */
+                       ++val;
+                       frac = 0;
+               }
+#if 1
+               /* If block_size is 0, dont print fractional part */
+               if (block_size == 0) {
+                       if (frac >= 5) {
+                               ++val;
                        }
+                       fmt = "%llu%*c";
+                       frac = 1;
+               }
+#endif
+       }
+
+       if (!str) {
+               /* sufficient for any width of val */
+               str = xmalloc(sizeof(val)*3 + 2 + 3);
+       }
+       sprintf(str, fmt, val, frac, *u);
+       return str;
+}
+
+
+/* vda's implementations of the similar idea */
+
+/* Convert unsigned long long value into compact 5-char representation.
+ * String is not terminated (buf[5] is untouched) */
+void FAST_FUNC smart_ulltoa5(unsigned long long ul, char buf[6], const char *scale)
+{
+       const char *fmt;
+       char c;
+       unsigned v, u, idx = 0;
+
+       if (ul > 99999) { // do not scale if 99999 or less
+               ul *= 10;
+               do {
+                       ul /= 1024;
+                       idx++;
+               } while (ul >= 100000);
+       }
+       v = ul; // ullong divisions are expensive, avoid them
+
+       fmt = " 123456789";
+       u = v / 10;
+       v = v % 10;
+       if (!idx) {
+               // 99999 or less: use "12345" format
+               // u is value/10, v is last digit
+               c = buf[0] = " 123456789"[u/1000];
+               if (c != ' ') fmt = "0123456789";
+               c = buf[1] = fmt[u/100%10];
+               if (c != ' ') fmt = "0123456789";
+               c = buf[2] = fmt[u/10%10];
+               if (c != ' ') fmt = "0123456789";
+               buf[3] = fmt[u%10];
+               buf[4] = "0123456789"[v];
+       } else {
+               // value has been scaled into 0..9999.9 range
+               // u is value, v is 1/10ths (allows for 92.1M format)
+               if (u >= 100) {
+                       // value is >= 100: use "1234M', " 123M" formats
+                       c = buf[0] = " 123456789"[u/1000];
+                       if (c != ' ') fmt = "0123456789";
+                       c = buf[1] = fmt[u/100%10];
+                       if (c != ' ') fmt = "0123456789";
+                       v = u % 10;
+                       u = u / 10;
+                       buf[2] = fmt[u%10];
+               } else {
+                       // value is < 100: use "92.1M" format
+                       c = buf[0] = " 123456789"[u/10];
+                       if (c != ' ') fmt = "0123456789";
+                       buf[1] = fmt[u%10];
+                       buf[2] = '.';
                }
+               buf[3] = "0123456789"[v];
+               buf[4] = scale[idx]; /* typically scale = " kmgt..." */
+       }
+}
+
+/* Convert unsigned long long value into compact 4-char
+ * representation. Examples: "1234", "1.2k", " 27M", "123T"
+ * String is not terminated (buf[4] is untouched) */
+void FAST_FUNC smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale)
+{
+       const char *fmt;
+       char c;
+       unsigned v, u, idx = 0;
 
-       return buffer;
+       if (ul > 9999) { // do not scale if 9999 or less
+               ul *= 10;
+               do {
+                       ul /= 1024;
+                       idx++;
+               } while (ul >= 10000);
+       }
+       v = ul; // ullong divisions are expensive, avoid them
+
+       fmt = " 123456789";
+       u = v / 10;
+       v = v % 10;
+       if (!idx) {
+               // 9999 or less: use "1234" format
+               // u is value/10, v is last digit
+               c = buf[0] = " 123456789"[u/100];
+               if (c != ' ') fmt = "0123456789";
+               c = buf[1] = fmt[u/10%10];
+               if (c != ' ') fmt = "0123456789";
+               buf[2] = fmt[u%10];
+               buf[3] = "0123456789"[v];
+       } else {
+               // u is value, v is 1/10ths (allows for 9.2M format)
+               if (u >= 10) {
+                       // value is >= 10: use "123M', " 12M" formats
+                       c = buf[0] = " 123456789"[u/100];
+                       if (c != ' ') fmt = "0123456789";
+                       v = u % 10;
+                       u = u / 10;
+                       buf[1] = fmt[u%10];
+               } else {
+                       // value is < 10: use "9.2M" format
+                       buf[0] = "0123456789"[u];
+                       buf[1] = '.';
+               }
+               buf[2] = "0123456789"[v];
+               buf[3] = scale[idx]; /* typically scale = " kmgt..." */
+       }
 }