1
/**************************************************************
3
* Patrick Powell Tue Apr 11 09:48:21 PDT 1995
4
* A bombproof version of doprnt (dopr) included.
5
* Sigh. This sort of thing is always nasty do deal with. Note that
6
* the version here does not include floating point...
8
* snprintf() is used instead of sprintf() as it does limit checks
9
* for string length. This covers a nasty loophole.
11
* The other functions are there to prevent NULL pointers from
12
* causing nast effects.
15
* Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
16
* This was ugly. It is still ugly. I opted out of floating point
17
* numbers, but the formatter understands just about everything
18
* from the normal C string format, at least as far as I can tell from
19
* the Solaris 2.5 printf(3S) man page.
21
* Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
22
* Ok, added some minimal floating point support, which means this
23
* probably requires libm on most operating systems. Don't yet
24
* support the exponent (e,E) and sigfig (g,G). Also, fmtint()
25
* was pretty badly broken, it just wasn't being exercised in ways
26
* which showed it, so that's been fixed. Also, formated the code
27
* to mutt conventions, and removed dead code left over from the
28
* original. Also, there is now a builtin-test, just compile with:
29
* gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
30
* and run snprintf for results.
32
* Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
33
* The PGP code was using unsigned hexadecimal formats.
34
* Unfortunately, unsigned formats simply didn't work.
36
* Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
37
* The original code assumed that both snprintf() and vsnprintf() were
38
* missing. Some systems only have snprintf() but not vsnprintf(), so
39
* the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
41
* Brian Stafford <brian@stafford.uklinux.net> 2002/01/28
42
* Removed calls to va_arg(ap, [unsigned] short); etc. This is because
43
* shorts are promoted to int when passed in a ... function argument and
44
* should be referred to as va_arg(ap, [unsigned] int); Added const to
45
* string argument types - snprintf does not modify the strings.
46
**************************************************************/
58
#if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
62
#include <sys/types.h>
64
/* Define this as a fall through, HAVE_STDARG_H is probably already set */
69
#define HAVE_VARARGS_H
72
/* varargs declarations: */
74
#if defined(HAVE_STDARG_H)
76
# define HAVE_STDARGS /* let's hope that works everywhere (mj) */
77
# define VA_LOCAL_DECL va_list ap
78
# define VA_START(f) va_start(ap, f)
79
# define VA_SHIFT(v,t) ; /* no-op for ANSI */
80
# define VA_END va_end(ap)
82
# if defined(HAVE_VARARGS_H)
85
# define VA_LOCAL_DECL va_list ap
86
# define VA_START(f) va_start(ap) /* f is ignored! */
87
# define VA_SHIFT(v,t) v = va_arg(ap,t)
88
# define VA_END va_end(ap)
90
/*XX ** NO VARARGS ** XX*/
94
/*int snprintf (char *str, size_t count, const char *fmt, ...);*/
95
/*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
97
static void dopr (char *buffer, size_t maxlen, const char *format,
99
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
100
const char *value, int flags, int min, int max);
101
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
102
long value, int base, int min, int max, int flags);
103
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
104
long double fvalue, int min, int max, int flags);
105
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
108
* dopr(): poor man's version of doprintf
111
/* format read states */
112
#define DP_S_DEFAULT 0
121
/* format flags - Bits */
122
#define DP_F_MINUS (1 << 0)
123
#define DP_F_PLUS (1 << 1)
124
#define DP_F_SPACE (1 << 2)
125
#define DP_F_NUM (1 << 3)
126
#define DP_F_ZERO (1 << 4)
127
#define DP_F_UP (1 << 5)
128
#define DP_F_UNSIGNED (1 << 6)
130
/* Conversion Flags */
133
#define DP_C_LDOUBLE 3
135
#define char_to_int(p) (p - '0')
136
#define MAX(p,q) ((p >= q) ? p : q)
138
static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
143
const char *strvalue;
151
state = DP_S_DEFAULT;
152
currlen = flags = cflags = min = 0;
156
while (state != DP_S_DONE)
158
if ((ch == '\0') || (currlen >= maxlen))
167
dopr_outch (buffer, &currlen, maxlen, ch);
199
if (isdigit((unsigned char)ch))
201
min = 10*min + char_to_int (ch);
206
min = va_arg (args, int);
223
if (isdigit((unsigned char)ch))
227
max = 10*max + char_to_int (ch);
232
max = va_arg (args, int);
240
/* Currently, we don't support Long Long, bummer */
252
cflags = DP_C_LDOUBLE;
265
if (cflags == DP_C_LONG)
266
value = va_arg (args, long int);
268
value = va_arg (args, int);
269
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
272
flags |= DP_F_UNSIGNED;
273
if (cflags == DP_C_LONG)
274
value = va_arg (args, unsigned long int);
276
value = va_arg (args, unsigned int);
277
fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
280
flags |= DP_F_UNSIGNED;
281
if (cflags == DP_C_LONG)
282
value = va_arg (args, unsigned long int);
284
value = va_arg (args, unsigned int);
285
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
290
flags |= DP_F_UNSIGNED;
291
if (cflags == DP_C_LONG)
292
value = va_arg (args, unsigned long int);
294
value = va_arg (args, unsigned int);
295
fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
298
if (cflags == DP_C_LDOUBLE)
299
fvalue = va_arg (args, long double);
301
fvalue = va_arg (args, double);
302
/* um, floating point? */
303
fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
308
if (cflags == DP_C_LDOUBLE)
309
fvalue = va_arg (args, long double);
311
fvalue = va_arg (args, double);
316
if (cflags == DP_C_LDOUBLE)
317
fvalue = va_arg (args, long double);
319
fvalue = va_arg (args, double);
322
dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
325
strvalue = va_arg (args, const char *);
327
max = maxlen; /* ie, no max */
328
fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
331
strvalue = va_arg (args, const void *);
332
fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
335
if (cflags == DP_C_SHORT)
338
num = va_arg (args, short int *);
341
else if (cflags == DP_C_LONG)
344
num = va_arg (args, long int *);
350
num = va_arg (args, int *);
355
dopr_outch (buffer, &currlen, maxlen, ch);
358
/* not supported yet, treat as next char */
366
state = DP_S_DEFAULT;
367
flags = cflags = min = 0;
374
break; /* some picky compilers need this */
377
if (currlen < maxlen - 1)
378
buffer[currlen] = '\0';
380
buffer[maxlen - 1] = '\0';
383
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
384
const char *value, int flags, int min, int max)
386
int padlen, strln; /* amount to pad */
394
for (strln = 0; value[strln]; ++strln); /* strlen */
395
padlen = min - strln;
398
if (flags & DP_F_MINUS)
399
padlen = -padlen; /* Left Justify */
401
while ((padlen > 0) && (cnt < max))
403
dopr_outch (buffer, currlen, maxlen, ' ');
407
while (*value && (cnt < max))
409
dopr_outch (buffer, currlen, maxlen, *value++);
412
while ((padlen < 0) && (cnt < max))
414
dopr_outch (buffer, currlen, maxlen, ' ');
420
/* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
422
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
423
long value, int base, int min, int max, int flags)
426
unsigned long uvalue;
429
int spadlen = 0; /* amount to space pad */
430
int zpadlen = 0; /* amount to zero pad */
438
if(!(flags & DP_F_UNSIGNED))
445
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
448
if (flags & DP_F_SPACE)
452
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
456
(caps? "0123456789ABCDEF":"0123456789abcdef")
457
[uvalue % (unsigned)base ];
458
uvalue = (uvalue / (unsigned)base );
459
} while(uvalue && (place < 20));
460
if (place == 20) place--;
463
zpadlen = max - place;
464
spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
465
if (zpadlen < 0) zpadlen = 0;
466
if (spadlen < 0) spadlen = 0;
467
if (flags & DP_F_ZERO)
469
zpadlen = MAX(zpadlen, spadlen);
472
if (flags & DP_F_MINUS)
473
spadlen = -spadlen; /* Left Justifty */
475
#ifdef DEBUG_SNPRINTF
476
dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
477
zpadlen, spadlen, min, max, place));
483
dopr_outch (buffer, currlen, maxlen, ' ');
489
dopr_outch (buffer, currlen, maxlen, signvalue);
496
dopr_outch (buffer, currlen, maxlen, '0');
503
dopr_outch (buffer, currlen, maxlen, convert[--place]);
505
/* Left Justified spaces */
506
while (spadlen < 0) {
507
dopr_outch (buffer, currlen, maxlen, ' ');
512
static long double abs_val (long double value)
514
long double result = value;
522
static long double pow10 (int exp)
524
long double result = 1;
535
static long round (long double value)
540
value = value - intpart;
547
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
548
long double fvalue, int min, int max, int flags)
556
int padlen = 0; /* amount to pad */
563
* AIX manpage says the default is 0, but Solaris says the default
564
* is 6, and sprintf on AIX defaults to 6
569
ufvalue = abs_val (fvalue);
574
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
577
if (flags & DP_F_SPACE)
581
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
587
* Sorry, we only support 9 digits past the decimal because of our
593
/* We "cheat" by converting the fractional part to integer by
594
* multiplying by a factor of 10
596
fracpart = round ((pow10 (max)) * (ufvalue - intpart));
598
if (fracpart >= pow10 (max))
601
fracpart -= pow10 (max);
604
#ifdef DEBUG_SNPRINTF
605
dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
608
/* Convert integer part */
611
(caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
612
intpart = (intpart / 10);
613
} while(intpart && (iplace < 20));
614
if (iplace == 20) iplace--;
615
iconvert[iplace] = 0;
617
/* Convert fractional part */
620
(caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
621
fracpart = (fracpart / 10);
622
} while(fracpart && (fplace < 20));
623
if (fplace == 20) fplace--;
624
fconvert[fplace] = 0;
626
/* -1 for decimal point, another -1 if we are printing a sign */
627
padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
628
zpadlen = max - fplace;
633
if (flags & DP_F_MINUS)
634
padlen = -padlen; /* Left Justifty */
636
if ((flags & DP_F_ZERO) && (padlen > 0))
640
dopr_outch (buffer, currlen, maxlen, signvalue);
646
dopr_outch (buffer, currlen, maxlen, '0');
652
dopr_outch (buffer, currlen, maxlen, ' ');
656
dopr_outch (buffer, currlen, maxlen, signvalue);
659
dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
662
* Decimal point. This should probably use locale to find the correct
665
dopr_outch (buffer, currlen, maxlen, '.');
668
dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
672
dopr_outch (buffer, currlen, maxlen, '0');
678
dopr_outch (buffer, currlen, maxlen, ' ');
683
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
685
if (*currlen < maxlen)
686
buffer[(*currlen)++] = c;
688
#endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
690
#ifndef HAVE_VSNPRINTF
691
int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
694
dopr(str, count, fmt, args);
697
#endif /* !HAVE_VSNPRINTF */
699
#ifndef HAVE_SNPRINTF
702
int snprintf (char *str,size_t count,const char *fmt,...)
704
int snprintf (va_alist) va_dcl
715
VA_SHIFT (str, char *);
716
VA_SHIFT (count, size_t );
717
VA_SHIFT (fmt, char *);
718
(void) vsnprintf(str, count, fmt, ap);
725
#define LONG_STRING 1024
729
char buf1[LONG_STRING];
730
char buf2[LONG_STRING];
745
double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
746
0.9996, 1.996, 4.136, 0};
759
long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
764
printf ("Testing snprintf format codes against system sprintf...\n");
766
for (x = 0; fp_fmt[x] != NULL ; x++)
767
for (y = 0; fp_nums[y] != 0 ; y++)
769
snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
770
sprintf (buf2, fp_fmt[x], fp_nums[y]);
771
if (strcmp (buf1, buf2))
773
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
774
fp_fmt[x], buf1, buf2);
780
for (x = 0; int_fmt[x] != NULL ; x++)
781
for (y = 0; int_nums[y] != 0 ; y++)
783
snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
784
sprintf (buf2, int_fmt[x], int_nums[y]);
785
if (strcmp (buf1, buf2))
787
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
788
int_fmt[x], buf1, buf2);
793
printf ("%d tests failed out of %d.\n", fail, num);
795
#endif /* SNPRINTF_TEST */
797
#endif /* !HAVE_SNPRINTF */