Clarify what new code should not cast unused
[dragonfly.git] / lib / libutil / humanize_number.c
1 /*      $NetBSD: humanize_number.c,v 1.8 2004/07/27 01:56:24 enami Exp $        */
2 /* $DragonFly: src/lib/libutil/humanize_number.c,v 1.1 2004/11/05 17:05:26 dillon Exp $ */
3
4 /*
5  * Copyright (c) 1997, 1998, 1999, 2002 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
10  * NASA Ames Research Center, by Luke Mewburn and by Tomas Svensson.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  * 3. All advertising materials mentioning features or use of this software
21  *    must display the following acknowledgement:
22  *      This product includes software developed by the NetBSD
23  *      Foundation, Inc. and its contributors.
24  * 4. Neither the name of The NetBSD Foundation nor the names of its
25  *    contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  *
40  * $FreeBSD: /repoman/r/ncvs/src/lib/libutil/humanize_number.c,v 1.1.2.1 2004/09/28 18:24:10 pjd Exp $
41  */
42
43 #include <sys/cdefs.h>
44 #include <sys/types.h>
45 #include <assert.h>
46 #include <stdio.h>
47 #include <stdlib.h>
48 #include <string.h>
49 #include <locale.h>
50 #include <libutil.h>
51
52 int
53 humanize_number(char *buf, size_t len, int64_t bytes,
54     const char *suffix, int scale, int flags)
55 {
56         const char *prefixes, *sep;
57         int     b, i, r, maxscale, s1, s2, sign;
58         int64_t divisor, max;
59         size_t  baselen;
60
61         assert(buf != NULL);
62         assert(suffix != NULL);
63         assert(scale >= 0);
64
65         if (flags & HN_DIVISOR_1000) {
66                 /* SI for decimal multiplies */
67                 divisor = 1000;
68                 if (flags & HN_B)
69                         prefixes = "B\0k\0M\0G\0T\0P\0E";
70                 else
71                         prefixes = "\0\0k\0M\0G\0T\0P\0E";
72         } else {
73                 /*
74                  * binary multiplies
75                  * XXX IEC 60027-2 recommends Ki, Mi, Gi...
76                  */
77                 divisor = 1024;
78                 if (flags & HN_B)
79                         prefixes = "B\0K\0M\0G\0T\0P\0E";
80                 else
81                         prefixes = "\0\0K\0M\0G\0T\0P\0E";
82         }
83
84 #define SCALE2PREFIX(scale)     (&prefixes[(scale) << 1])
85         maxscale = 7;
86
87         if (scale >= maxscale &&
88             (scale & (HN_AUTOSCALE | HN_GETSCALE)) == 0)
89                 return (-1);
90
91         if (buf == NULL || suffix == NULL)
92                 return (-1);
93
94         if (len > 0)
95                 buf[0] = '\0';
96         if (bytes < 0) {
97                 sign = -1;
98                 bytes *= -100;
99                 baselen = 3;            /* sign, digit, prefix */
100         } else {
101                 sign = 1;
102                 bytes *= 100;
103                 baselen = 2;            /* digit, prefix */
104         }
105         if (flags & HN_NOSPACE)
106                 sep = "";
107         else {
108                 sep = " ";
109                 baselen++;
110         }
111         baselen += strlen(suffix);
112
113         /* Check if enough room for `x y' + suffix + `\0' */
114         if (len < baselen + 1)
115                 return (-1);
116
117         if (scale & (HN_AUTOSCALE | HN_GETSCALE)) {
118                 /* See if there is additional columns can be used. */
119                 for (max = 100, i = len - baselen; i-- > 0;)
120                         max *= 10;
121
122                 for (i = 0; bytes >= max && i < maxscale; i++)
123                         bytes /= divisor;
124
125                 if (scale & HN_GETSCALE)
126                         return (i);
127         } else
128                 for (i = 0; i < scale && i < maxscale; i++)
129                         bytes /= divisor;
130
131         /* If a value <= 9.9 after rounding and ... */
132         if (bytes < 995 && i > 0 && flags & HN_DECIMAL) {
133                 /* baselen + \0 + .N */
134                 if (len < baselen + 1 + 2)
135                         return (-1);
136                 b = ((int)bytes + 5) / 10;
137                 s1 = b / 10;
138                 s2 = b % 10;
139                 r = snprintf(buf, len, "%d%s%d%s%s%s",
140                     sign * s1, localeconv()->decimal_point, s2,
141                     sep, SCALE2PREFIX(i), suffix);
142         } else
143                 r = snprintf(buf, len, "%lld%s%s%s",
144                     /* LONGLONG */
145                     (long long)(sign * ((bytes + 50) / 100)),
146                     sep, SCALE2PREFIX(i), suffix);
147
148         return (r);
149 }