2
* Copyright Patrick Powell 1995
3
* This code is based on code written by Patrick Powell (papowell@astart.com)
4
* It may be used for any purpose as long as this notice remains intact
5
* on all source code distributions
8
/**************************************************************
10
* Patrick Powell Tue Apr 11 09:48:21 PDT 1995
11
* A bombproof version of doprnt (dopr) included.
12
* Sigh. This sort of thing is always nasty do deal with. Note that
13
* the version here does not include floating point...
15
* snprintf() is used instead of sprintf() as it does limit checks
16
* for string length. This covers a nasty loophole.
18
* The other functions are there to prevent NULL pointers from
19
* causing nast effects.
22
* Brandon Long <blong@fiction.net> 9/15/96 for mutt 0.43
23
* This was ugly. It is still ugly. I opted out of floating point
24
* numbers, but the formatter understands just about everything
25
* from the normal C string format, at least as far as I can tell from
26
* the Solaris 2.5 printf(3S) man page.
28
* Brandon Long <blong@fiction.net> 10/22/97 for mutt 0.87.1
29
* Ok, added some minimal floating point support, which means this
30
* probably requires libm on most operating systems. Don't yet
31
* support the exponent (e, E) and sigfig (g, G). Also, fmtint()
32
* was pretty badly broken, it just wasn't being exercised in ways
33
* which showed it, so that's been fixed. Also, formated the code
34
* to mutt conventions, and removed dead code left over from the
35
* original. Also, there is now a builtin-test, just compile with:
36
* gcc -DTEST_SNPRINTF -o snprintf snprintf.c -lm
37
* and run snprintf for results.
39
* Thomas Roessler <roessler@guug.de> 01/27/98 for mutt 0.89i
40
* The PGP code was using unsigned hexadecimal formats.
41
* Unfortunately, unsigned formats simply didn't work.
43
* Michael Elkins <me@cs.hmc.edu> 03/05/98 for mutt 0.90.8
44
* The original code assumed that both snprintf() and vsnprintf() were
45
* missing. Some systems only have snprintf() but not vsnprintf(), so
46
* the code is now broken down under HAVE_SNPRINTF and HAVE_VSNPRINTF.
48
* Andrew Tridgell (tridge@samba.org) Oct 1998
49
* fixed handling of %.0f
50
* added test for HAVE_LONG_DOUBLE
52
* Chris Kirmse (ckirmse@yahoo.com) May 2003
53
* fixed handling of leading zeros in the fractional part of a float.
55
* Andrea Mazzoleni May 2003
56
* added minimal support for %g.
58
**************************************************************/
64
/* moved above the #ifdef to avoid warning about empty c-files */
67
#include <sys/types.h>
69
#if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
71
/* varargs declarations: */
73
#if defined(HAVE_STDARG_H)
75
# define HAVE_STDARGS /* let's hope that works everywhere (mj) */
76
# define VA_LOCAL_DECL va_list ap
77
# define VA_START(f) va_start(ap, f)
78
# define VA_SHIFT(v, t) ; /* no-op for ANSI */
79
# define VA_END va_end(ap)
81
# if defined(HAVE_VARARGS_H)
84
# define VA_LOCAL_DECL va_list ap
85
# define VA_START(f) va_start(ap) /* f is ignored! */
86
# define VA_SHIFT(v, t) v = va_arg(ap, t)
87
# define VA_END va_end(ap)
90
/*XX ** NO VARARGS ** XX*/
94
#ifdef HAVE_LONG_DOUBLE
95
#define LDOUBLE long double
97
#define LDOUBLE double
100
int snprintf (char *str, size_t count, const char *fmt, ...);
101
int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);
103
static void dopr (char *buffer, size_t maxlen, const char *format,
105
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
106
char *value, int flags, int min, int max);
107
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
108
long value, int base, int min, int max, int flags);
109
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
110
LDOUBLE fvalue, int min, int max, int flags);
111
static void fmtfpg (char *buffer, size_t *currlen, size_t maxlen,
112
LDOUBLE fvalue, int min, int max, int flags);
113
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
116
* dopr(): poor man's version of doprintf
119
/* format read states */
120
#define DP_S_DEFAULT 0
129
/* format flags - Bits */
130
#define DP_F_MINUS (1 << 0)
131
#define DP_F_PLUS (1 << 1)
132
#define DP_F_SPACE (1 << 2)
133
#define DP_F_NUM (1 << 3)
134
#define DP_F_ZERO (1 << 4)
135
#define DP_F_UP (1 << 5)
136
#define DP_F_UNSIGNED (1 << 6)
138
/* Conversion Flags */
141
#define DP_C_LDOUBLE 3
143
#define char_to_int(p) (p - '0')
144
#define MAX(p, q) ((p >= q) ? p : q)
146
static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
159
state = DP_S_DEFAULT;
160
currlen = flags = cflags = min = 0;
164
while (state != DP_S_DONE)
166
if ((ch == '\0') || (currlen >= maxlen))
175
dopr_outch (buffer, &currlen, maxlen, ch);
209
min = 10*min + char_to_int (ch);
214
min = va_arg (args, int);
235
max = 10*max + char_to_int (ch);
240
max = va_arg (args, int);
248
/* Currently, we don't support Long Long, bummer */
260
cflags = DP_C_LDOUBLE;
273
if (cflags == DP_C_SHORT)
274
value = va_arg (args, int);
275
else if (cflags == DP_C_LONG)
276
value = va_arg (args, long int);
278
value = va_arg (args, int);
279
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
282
flags |= DP_F_UNSIGNED;
283
if (cflags == DP_C_SHORT)
284
value = va_arg (args, unsigned int);
285
else if (cflags == DP_C_LONG)
286
value = va_arg (args, unsigned long int);
288
value = va_arg (args, unsigned int);
289
fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
292
flags |= DP_F_UNSIGNED;
293
if (cflags == DP_C_SHORT)
294
value = va_arg (args, unsigned int);
295
else if (cflags == DP_C_LONG)
296
value = va_arg (args, unsigned long int);
298
value = va_arg (args, unsigned int);
299
fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
304
flags |= DP_F_UNSIGNED;
305
if (cflags == DP_C_SHORT)
306
value = va_arg (args, unsigned int);
307
else if (cflags == DP_C_LONG)
308
value = va_arg (args, unsigned long int);
310
value = va_arg (args, unsigned int);
311
fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
314
if (cflags == DP_C_LDOUBLE)
315
fvalue = va_arg (args, LDOUBLE);
317
fvalue = va_arg (args, double);
318
/* um, floating point? */
319
fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
324
if (cflags == DP_C_LDOUBLE)
325
fvalue = va_arg (args, LDOUBLE);
327
fvalue = va_arg (args, double);
332
if (cflags == DP_C_LDOUBLE)
333
fvalue = va_arg (args, LDOUBLE);
335
fvalue = va_arg (args, double);
336
fmtfpg (buffer, &currlen, maxlen, fvalue, min, max, flags);
339
dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
342
strvalue = va_arg (args, char *);
344
max = maxlen; /* ie, no max */
345
fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
348
strvalue = va_arg (args, void *);
349
fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
352
if (cflags == DP_C_SHORT)
355
num = va_arg (args, short int *);
358
else if (cflags == DP_C_LONG)
361
num = va_arg (args, long int *);
367
num = va_arg (args, int *);
372
dopr_outch (buffer, &currlen, maxlen, ch);
375
/* not supported yet, treat as next char */
383
state = DP_S_DEFAULT;
384
flags = cflags = min = 0;
391
break; /* some picky compilers need this */
394
if (currlen < maxlen - 1)
395
buffer[currlen] = '\0';
397
buffer[maxlen - 1] = '\0';
400
static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
401
char *value, int flags, int min, int max)
403
int padlen, strln; /* amount to pad */
411
for (strln = 0; value[strln]; ++strln); /* strlen */
412
padlen = min - strln;
415
if (flags & DP_F_MINUS)
416
padlen = -padlen; /* Left Justify */
418
while ((padlen > 0) && (cnt < max))
420
dopr_outch (buffer, currlen, maxlen, ' ');
424
while (*value && (cnt < max))
426
dopr_outch (buffer, currlen, maxlen, *value++);
429
while ((padlen < 0) && (cnt < max))
431
dopr_outch (buffer, currlen, maxlen, ' ');
437
/* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
439
static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
440
long value, int base, int min, int max, int flags)
443
unsigned long uvalue;
446
int spadlen = 0; /* amount to space pad */
447
int zpadlen = 0; /* amount to zero pad */
455
if(!(flags & DP_F_UNSIGNED))
462
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
465
if (flags & DP_F_SPACE)
469
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
473
(caps? "0123456789ABCDEF":"0123456789abcdef")
474
[uvalue % (unsigned)base ];
475
uvalue = (uvalue / (unsigned)base );
476
} while(uvalue && (place < 20));
477
if (place == 20) place--;
480
zpadlen = max - place;
481
spadlen = min - MAX (max, place) - (signvalue ? 1 : 0);
482
if (zpadlen < 0) zpadlen = 0;
483
if (spadlen < 0) spadlen = 0;
484
if (flags & DP_F_ZERO)
486
zpadlen = MAX(zpadlen, spadlen);
489
if (flags & DP_F_MINUS)
490
spadlen = -spadlen; /* Left Justifty */
492
#ifdef DEBUG_SNPRINTF
493
dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
494
zpadlen, spadlen, min, max, place));
500
dopr_outch (buffer, currlen, maxlen, ' ');
506
dopr_outch (buffer, currlen, maxlen, signvalue);
513
dopr_outch (buffer, currlen, maxlen, '0');
520
dopr_outch (buffer, currlen, maxlen, convert[--place]);
522
/* Left Justified spaces */
523
while (spadlen < 0) {
524
dopr_outch (buffer, currlen, maxlen, ' ');
529
static LDOUBLE abs_val (LDOUBLE value)
531
LDOUBLE result = value;
539
static LDOUBLE pow10 (int exp)
552
static long round (LDOUBLE value)
557
value = value - intpart;
564
static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
565
LDOUBLE fvalue, int min, int max, int flags)
573
int padlen = 0; /* amount to pad */
580
* AIX manpage says the default is 0, but Solaris says the default
581
* is 6, and sprintf on AIX defaults to 6
586
ufvalue = abs_val (fvalue);
591
if (flags & DP_F_PLUS) /* Do a sign (+/i) */
594
if (flags & DP_F_SPACE)
598
if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
604
* Sorry, we only support 9 digits past the decimal because of our
610
/* We "cheat" by converting the fractional part to integer by
611
* multiplying by a factor of 10
613
fracpart = round ((pow10 (max)) * (ufvalue - intpart));
615
if (fracpart >= pow10 (max))
618
fracpart -= pow10 (max);
621
#ifdef DEBUG_SNPRINTF
622
dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
625
/* Convert integer part */
628
(caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
629
intpart = (intpart / 10);
630
} while(intpart && (iplace < 20));
631
if (iplace == 20) iplace--;
632
iconvert[iplace] = 0;
634
/* Convert fractional part */
637
(caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
638
fracpart = (fracpart / 10);
639
} while(fracpart && (fplace < 20));
640
if (fplace == 20) fplace--;
641
fconvert[fplace] = 0;
643
/* -1 for decimal point, another -1 if we are printing a sign */
644
padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
645
zpadlen = max - fplace;
650
if (flags & DP_F_MINUS)
651
padlen = -padlen; /* Left Justifty */
653
if ((flags & DP_F_ZERO) && (padlen > 0))
657
dopr_outch (buffer, currlen, maxlen, signvalue);
663
dopr_outch (buffer, currlen, maxlen, '0');
669
dopr_outch (buffer, currlen, maxlen, ' ');
673
dopr_outch (buffer, currlen, maxlen, signvalue);
676
dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
679
* Decimal point. This should probably use locale to find the correct
685
dopr_outch (buffer, currlen, maxlen, '.');
687
/* print leading zeros of the fractional part */
688
for (i=0;i<max - fplace;i++)
690
dopr_outch(buffer,currlen,maxlen,'0');
695
dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
700
dopr_outch (buffer, currlen, maxlen, '0');
706
dopr_outch (buffer, currlen, maxlen, ' ');
711
static void fmtfpg (char *buffer, size_t *currlen, size_t maxlen,
712
LDOUBLE fvalue, int min, int max, int flags)
714
size_t len = *currlen;
716
fmtfp(buffer, currlen, maxlen, fvalue, min, max, flags);
717
/* remove ending 0 after '.' */
718
for(i=len;i<*currlen;++i)
719
if (buffer[i] == '.')
722
while (*currlen>0 && buffer[*currlen - 1]=='0')
724
if (*currlen>0 && buffer[*currlen - 1]=='.')
729
static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
731
if (*currlen < maxlen)
732
buffer[(*currlen)++] = c;
735
#ifndef HAVE_VSNPRINTF
736
int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
739
dopr(str, count, fmt, args);
742
#endif /* !HAVE_VSNPRINTF */
744
#ifndef HAVE_SNPRINTF
747
int snprintf (char *str, size_t count, const char *fmt, ...)
749
int snprintf (va_alist) va_dcl
760
VA_SHIFT (str, char *);
761
VA_SHIFT (count, size_t );
762
VA_SHIFT (fmt, char *);
763
(void) vsnprintf(str, count, fmt, ap);
767
#endif /* !HAVE_SNPRINTF */
771
#define LONG_STRING 1024
775
char buf1[LONG_STRING];
776
char buf2[LONG_STRING];
793
double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
794
0.9996, 1.996, 4.136, 1.05, 0};
807
long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
812
printf ("Testing snprintf format codes against system sprintf...\n");
814
for (x = 0; fp_fmt[x] != NULL ; x++)
815
for (y = 0; fp_nums[y] != 0 ; y++)
817
snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
818
sprintf (buf2, fp_fmt[x], fp_nums[y]);
819
if (strcmp (buf1, buf2))
821
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
822
fp_fmt[x], buf1, buf2);
828
for (x = 0; int_fmt[x] != NULL ; x++)
829
for (y = 0; int_nums[y] != 0 ; y++)
831
snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
832
sprintf (buf2, int_fmt[x], int_nums[y]);
833
if (strcmp (buf1, buf2))
835
printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
836
int_fmt[x], buf1, buf2);
841
printf ("%d tests failed out of %d.\n", fail, num);
843
#endif /* SNPRINTF_TEST */
845
#endif /* !HAVE_SNPRINTF */