2
* $Id: snprintf.c,v 1.3 2000/11/29 11:21:31 bazsi Exp $
3
* Copyright Patrick Powell 1995
4
* This code is based on code written by Patrick Powell (papowell@astart.com)
5
* It may be used for any purpose as long as this notice remains intact
6
* on all source code distributions
9
/**************************************************************
11
* Patrick Powell Tue Apr 11 09:48:21 PDT 1995
12
* A bombproof version of doprnt (dopr) included.
13
* Sigh. This sort of thing is always nasty do deal with. Note that
14
* the version here does not include floating point...
16
* snprintf() is used instead of sprintf() as it does limit checks
17
* for string length. This covers a nasty loophole.
19
* The other functions are there to prevent NULL pointers from
20
* causing nast effects.
23
* Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
24
* This was ugly. It is still ugly. I opted out of floating point
25
* numbers, but the formatter understands just about everything
26
* from the normal C string format, at least as far as I can tell from
27
* the Solaris 2.5 printf(3S) man page.
29
* Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
30
* Ok, added some minimal floating point support, which means this
31
* probably requires libm on most operating systems. Don't yet
32
* support the exponent (e,E) and sigfig (g,G). Also, fmtint()
33
* was pretty badly broken, it just wasn't being exercised in ways
34
* which showed it, so that's been fixed. Also, formated the code
35
* to mutt conventions, and removed dead code left over from the
36
* original. Also, there is now a builtin-test, just compile with:
37
* gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
38
* and run snprintf for results.
40
* Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
41
* The PGP code was using unsigned hexadecimal formats.
42
* Unfortunately, unsigned formats simply didn't work.
44
* Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
45
* The original code assumed that both snprintf() and vsnprintf() were
46
* missing. Some systems only have snprintf() but not vsnprintf(), so
47
* the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
49
* Andrew Tridgell (tridge@samba.org) Oct 1998
50
* fixed handling of %.0f
51
* added test for HAVE_LONG_DOUBLE
53
**************************************************************/
57
#if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
61
#include <sys/types.h>
63
/* Define this as a fall through, HAVE_STDARG_H is probably already set */
65
#define HAVE_VARARGS_H
68
/* varargs declarations: */
70
#if defined(HAVE_STDARG_H)
72
# define HAVE_STDARGS /* let's hope that works everywhere (mj) */
73
# define VA_LOCAL_DECL va_list ap
74
# define VA_START(f) va_start(ap, f)
75
# define VA_SHIFT(v,t) ; /* no-op for ANSI */
76
# define VA_END va_end(ap)
78
# if defined(HAVE_VARARGS_H)
81
# define VA_LOCAL_DECL va_list ap
82
# define VA_START(f) va_start(ap) /* f is ignored! */
83
# define VA_SHIFT(v,t) v = va_arg(ap,t)
84
# define VA_END va_end(ap)
86
/*XX ** NO VARARGS ** XX*/
90
#ifdef HAVE_LONG_DOUBLE
91
#define LDOUBLE long double
93
#define LDOUBLE double
96
int snprintf (char *str, size_t count, const char *fmt, ...);
97
int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);
99
static void dopr (char *buffer, size_t maxlen, const char *format,
101
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
102
char *value, int flags, int min, int max);
103
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
104
long value, int base, int min, int max, int flags);
105
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
106
LDOUBLE fvalue, int min, int max, int flags);
107
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
110
* dopr(): poor man's version of doprintf
113
/* format read states */
114
#define DP_S_DEFAULT 0
123
/* format flags - Bits */
124
#define DP_F_MINUS (1 << 0)
125
#define DP_F_PLUS (1 << 1)
126
#define DP_F_SPACE (1 << 2)
127
#define DP_F_NUM (1 << 3)
128
#define DP_F_ZERO (1 << 4)
129
#define DP_F_UP (1 << 5)
130
#define DP_F_UNSIGNED (1 << 6)
132
/* Conversion Flags */
135
#define DP_C_LDOUBLE 3
137
#define char_to_int(p) (p - '0')
138
#define MAX(p,q) ((p >= q) ? p : q)
140
static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
153
state = DP_S_DEFAULT;
154
currlen = flags = cflags = min = 0;
158
while (state != DP_S_DONE)
160
if ((ch == '\0') || (currlen >= maxlen))
169
dopr_outch (buffer, &currlen, maxlen, ch);
203
min = 10*min + char_to_int (ch);
208
min = va_arg (args, int);
229
max = 10*max + char_to_int (ch);
234
max = va_arg (args, int);
242
/* Currently, we don't support Long Long, bummer */
254
cflags = DP_C_LDOUBLE;
267
if (cflags == DP_C_SHORT)
268
value = va_arg (args, short int);
269
else if (cflags == DP_C_LONG)
270
value = va_arg (args, long int);
272
value = va_arg (args, int);
273
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
276
flags |= DP_F_UNSIGNED;
277
if (cflags == DP_C_SHORT)
278
value = va_arg (args, unsigned short int);
279
else if (cflags == DP_C_LONG)
280
value = va_arg (args, unsigned long int);
282
value = va_arg (args, unsigned int);
283
fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
286
flags |= DP_F_UNSIGNED;
287
if (cflags == DP_C_SHORT)
288
value = va_arg (args, unsigned short int);
289
else if (cflags == DP_C_LONG)
290
value = va_arg (args, unsigned long int);
292
value = va_arg (args, unsigned int);
293
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
298
flags |= DP_F_UNSIGNED;
299
if (cflags == DP_C_SHORT)
300
value = va_arg (args, unsigned short int);
301
else if (cflags == DP_C_LONG)
302
value = va_arg (args, unsigned long int);
304
value = va_arg (args, unsigned int);
305
fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
308
if (cflags == DP_C_LDOUBLE)
309
fvalue = va_arg (args, LDOUBLE);
311
fvalue = va_arg (args, double);
312
/* um, floating point? */
313
fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
318
if (cflags == DP_C_LDOUBLE)
319
fvalue = va_arg (args, LDOUBLE);
321
fvalue = va_arg (args, double);
326
if (cflags == DP_C_LDOUBLE)
327
fvalue = va_arg (args, LDOUBLE);
329
fvalue = va_arg (args, double);
332
dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
335
strvalue = va_arg (args, char *);
337
max = maxlen; /* ie, no max */
338
fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
341
strvalue = va_arg (args, void *);
342
fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
345
if (cflags == DP_C_SHORT)
348
num = va_arg (args, short int *);
351
else if (cflags == DP_C_LONG)
354
num = va_arg (args, long int *);
360
num = va_arg (args, int *);
365
dopr_outch (buffer, &currlen, maxlen, ch);
368
/* not supported yet, treat as next char */
376
state = DP_S_DEFAULT;
377
flags = cflags = min = 0;
384
break; /* some picky compilers need this */
387
if (currlen < maxlen - 1)
388
buffer[currlen] = '\0';
390
buffer[maxlen - 1] = '\0';
393
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
394
char *value, int flags, int min, int max)
396
int padlen, strln; /* amount to pad */
404
for (strln = 0; value[strln]; ++strln); /* strlen */
405
padlen = min - strln;
408
if (flags & DP_F_MINUS)
409
padlen = -padlen; /* Left Justify */
411
while ((padlen > 0) && (cnt < max))
413
dopr_outch (buffer, currlen, maxlen, ' ');
417
while (*value && (cnt < max))
419
dopr_outch (buffer, currlen, maxlen, *value++);
422
while ((padlen < 0) && (cnt < max))
424
dopr_outch (buffer, currlen, maxlen, ' ');
430
/* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
432
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
433
long value, int base, int min, int max, int flags)
436
unsigned long uvalue;
439
int spadlen = 0; /* amount to space pad */
440
int zpadlen = 0; /* amount to zero pad */
448
if(!(flags & DP_F_UNSIGNED))
455
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
458
if (flags & DP_F_SPACE)
462
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
466
(caps? "0123456789ABCDEF":"0123456789abcdef")
467
[uvalue % (unsigned)base ];
468
uvalue = (uvalue / (unsigned)base );
469
} while(uvalue && (place < 20));
470
if (place == 20) place--;
473
zpadlen = max - place;
474
spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
475
if (zpadlen < 0) zpadlen = 0;
476
if (spadlen < 0) spadlen = 0;
477
if (flags & DP_F_ZERO)
479
zpadlen = MAX(zpadlen, spadlen);
482
if (flags & DP_F_MINUS)
483
spadlen = -spadlen; /* Left Justifty */
485
#ifdef DEBUG_SNPRINTF
486
dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
487
zpadlen, spadlen, min, max, place));
493
dopr_outch (buffer, currlen, maxlen, ' ');
499
dopr_outch (buffer, currlen, maxlen, signvalue);
506
dopr_outch (buffer, currlen, maxlen, '0');
513
dopr_outch (buffer, currlen, maxlen, convert[--place]);
515
/* Left Justified spaces */
516
while (spadlen < 0) {
517
dopr_outch (buffer, currlen, maxlen, ' ');
522
static LDOUBLE abs_val (LDOUBLE value)
524
LDOUBLE result = value;
532
static LDOUBLE pow10 (int exp)
545
static long round (LDOUBLE value)
550
value = value - intpart;
557
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
558
LDOUBLE fvalue, int min, int max, int flags)
566
int padlen = 0; /* amount to pad */
573
* AIX manpage says the default is 0, but Solaris says the default
574
* is 6, and sprintf on AIX defaults to 6
579
ufvalue = abs_val (fvalue);
584
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
587
if (flags & DP_F_SPACE)
591
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
597
* Sorry, we only support 9 digits past the decimal because of our
603
/* We "cheat" by converting the fractional part to integer by
604
* multiplying by a factor of 10
606
fracpart = round ((pow10 (max)) * (ufvalue - intpart));
608
if (fracpart >= pow10 (max))
611
fracpart -= pow10 (max);
614
#ifdef DEBUG_SNPRINTF
615
dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
618
/* Convert integer part */
621
(caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
622
intpart = (intpart / 10);
623
} while(intpart && (iplace < 20));
624
if (iplace == 20) iplace--;
625
iconvert[iplace] = 0;
627
/* Convert fractional part */
630
(caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
631
fracpart = (fracpart / 10);
632
} while(fracpart && (fplace < 20));
633
if (fplace == 20) fplace--;
634
fconvert[fplace] = 0;
636
/* -1 for decimal point, another -1 if we are printing a sign */
637
padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
638
zpadlen = max - fplace;
643
if (flags & DP_F_MINUS)
644
padlen = -padlen; /* Left Justifty */
646
if ((flags & DP_F_ZERO) && (padlen > 0))
650
dopr_outch (buffer, currlen, maxlen, signvalue);
656
dopr_outch (buffer, currlen, maxlen, '0');
662
dopr_outch (buffer, currlen, maxlen, ' ');
666
dopr_outch (buffer, currlen, maxlen, signvalue);
669
dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
672
* Decimal point. This should probably use locale to find the correct
677
dopr_outch (buffer, currlen, maxlen, '.');
680
dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
685
dopr_outch (buffer, currlen, maxlen, '0');
691
dopr_outch (buffer, currlen, maxlen, ' ');
696
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
698
if (*currlen < maxlen)
699
buffer[(*currlen)++] = c;
702
#ifndef HAVE_VSNPRINTF
703
int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
706
dopr(str, count, fmt, args);
709
#endif /* !HAVE_VSNPRINTF */
711
#ifndef HAVE_SNPRINTF
714
int snprintf (char *str,size_t count,const char *fmt,...)
716
int snprintf (va_alist) va_dcl
727
VA_SHIFT (str, char *);
728
VA_SHIFT (count, size_t );
729
VA_SHIFT (fmt, char *);
730
(void) vsnprintf(str, count, fmt, ap);
734
#endif /* !HAVE_SNPRINTF */
738
#define LONG_STRING 1024
742
char buf1[LONG_STRING];
743
char buf2[LONG_STRING];
760
double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
761
0.9996, 1.996, 4.136, 0};
774
long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
779
printf ("Testing snprintf format codes against system sprintf...\n");
781
for (x = 0; fp_fmt[x] != NULL ; x++)
782
for (y = 0; fp_nums[y] != 0 ; y++)
784
snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
785
sprintf (buf2, fp_fmt[x], fp_nums[y]);
786
if (strcmp (buf1, buf2))
788
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
789
fp_fmt[x], buf1, buf2);
795
for (x = 0; int_fmt[x] != NULL ; x++)
796
for (y = 0; int_nums[y] != 0 ; y++)
798
snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
799
sprintf (buf2, int_fmt[x], int_nums[y]);
800
if (strcmp (buf1, buf2))
802
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
803
int_fmt[x], buf1, buf2);
808
printf ("%d tests failed out of %d.\n", fail, num);
810
#endif /* SNPRINTF_TEST */
812
#endif /* !HAVE_SNPRINTF */