1 /* human.h -- print human readable file size
3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 Free Software Foundation, Inc.
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, or (at your option)
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.
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 Foundation,
18 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
20 /* Written by Paul Eggert and Larry McVoy. */
39 /* A conservative bound on the maximum length of a human-readable string.
40 The output can be the square of the largest uintmax_t, so double
41 its size before converting to a bound.
42 302 / 1000 is ceil (log10 (2.0)). Add 1 for integer division truncation.
43 Also, the output can have a thousands separator between every digit,
44 so multiply by MB_LEN_MAX + 1 and then subtract MB_LEN_MAX.
45 Finally, append 3, the maximum length of a suffix. */
46 # define LONGEST_HUMAN_READABLE \
47 ((2 * sizeof (uintmax_t) * CHAR_BIT * 302 / 1000 + 1) * (MB_LEN_MAX + 1) \
50 /* Options for human_readable. */
53 /* Unless otherwise specified these options may be ORed together. */
55 /* The following three options are mutually exclusive. */
56 /* Round to plus infinity (default). */
58 /* Round to nearest, ties to even. */
59 human_round_to_nearest = 1,
60 /* Round to minus infinity. */
63 /* Group digits together, e.g. `1,000,000'. This uses the
64 locale-defined grouping; the traditional C locale does not group,
65 so this has effect only if some other locale is in use. */
66 human_group_digits = 4,
68 /* When autoscaling, suppress ".0" at end. */
69 human_suppress_point_zero = 8,
71 /* Scale output and use SI-style units, ignoring the output block size. */
74 /* Prefer base 1024 to base 1000. */
77 /* Append SI prefix, e.g. "k" or "M". */
80 /* Append "B" (if base 1000) or "iB" (if base 1024) to SI prefix. */
84 char *human_readable (uintmax_t, char *, int, uintmax_t, uintmax_t);
86 int human_options (char const *, bool, uintmax_t *);