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 **************************************************************/
45 #ifdef HAVE_LOCAL_SNPRINTF
47 #if defined(HAVE_STRING_H)
50 #if defined(HAVE_STRINGS_H)
55 #ifdef HAVE_SYS_TYPES_H
56 #include <sys/types.h>
61 #define HAVE_STDARGS /* let's hope that works everywhere (mj) */
62 #define VA_LOCAL_DECL va_list ap
63 #define VA_START(f) va_start(ap, f)
64 #define VA_SHIFT(v,t) ; /* no-op for ANSI */
65 #define VA_END va_end(ap)
67 static void dopr (char *buffer, size_t maxlen, const char *format,
69 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
70 char *value, int flags, int min, int max);
71 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
72 long value, int base, int min, int max, int flags);
73 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
74 long double fvalue, int min, int max, int flags);
75 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c );
78 * dopr(): poor man's version of doprintf
81 /* format read states */
82 #define DP_S_DEFAULT 0
91 /* format flags - Bits */
92 #define DP_F_MINUS (1 << 0)
93 #define DP_F_PLUS (1 << 1)
94 #define DP_F_SPACE (1 << 2)
95 #define DP_F_NUM (1 << 3)
96 #define DP_F_ZERO (1 << 4)
97 #define DP_F_UP (1 << 5)
98 #define DP_F_UNSIGNED (1 << 6)
100 /* Conversion Flags */
103 #define DP_C_LDOUBLE 3
105 #define char_to_int(p) (p - '0')
106 #define THEMAX(p,q) (((p) >= (q)) ? (p) : (q))
108 static void dopr (char *buffer, size_t maxlen, const char *format, va_list args)
121 state = DP_S_DEFAULT;
122 currlen = flags = cflags = min = 0;
126 while (state != DP_S_DONE)
128 if ((ch == '\0') || (currlen >= maxlen))
137 dopr_outch (buffer, &currlen, maxlen, ch);
169 if (isdigit((int)ch))
171 min = 10*min + char_to_int (ch);
176 min = va_arg (args, int);
193 if (isdigit((int)ch))
197 max = 10*max + char_to_int (ch);
202 max = va_arg (args, int);
210 /* Currently, we don't support Long Long, bummer */
222 cflags = DP_C_LDOUBLE;
235 if (cflags == DP_C_SHORT)
236 value = va_arg (args, short int);
237 else if (cflags == DP_C_LONG)
238 value = va_arg (args, long int);
240 value = va_arg (args, int);
241 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
244 flags |= DP_F_UNSIGNED;
245 if (cflags == DP_C_SHORT)
246 value = va_arg (args, unsigned short int);
247 else if (cflags == DP_C_LONG)
248 value = va_arg (args, unsigned long int);
250 value = va_arg (args, unsigned int);
251 fmtint (buffer, &currlen, maxlen, value, 8, min, max, flags);
254 flags |= DP_F_UNSIGNED;
255 if (cflags == DP_C_SHORT)
256 value = va_arg (args, unsigned short int);
257 else if (cflags == DP_C_LONG)
258 value = va_arg (args, unsigned long int);
260 value = va_arg (args, unsigned int);
261 fmtint (buffer, &currlen, maxlen, value, 10, min, max, flags);
266 flags |= DP_F_UNSIGNED;
267 if (cflags == DP_C_SHORT)
268 value = va_arg (args, unsigned short int);
269 else if (cflags == DP_C_LONG)
270 value = va_arg (args, unsigned long int);
272 value = va_arg (args, unsigned int);
273 fmtint (buffer, &currlen, maxlen, value, 16, min, max, flags);
276 if (cflags == DP_C_LDOUBLE)
277 fvalue = va_arg (args, long double);
279 fvalue = va_arg (args, double);
280 /* um, floating point? */
281 fmtfp (buffer, &currlen, maxlen, fvalue, min, max, flags);
286 if (cflags == DP_C_LDOUBLE)
287 fvalue = va_arg (args, long double);
289 fvalue = va_arg (args, double);
294 if (cflags == DP_C_LDOUBLE)
295 fvalue = va_arg (args, long double);
297 fvalue = va_arg (args, double);
300 dopr_outch (buffer, &currlen, maxlen, va_arg (args, int));
303 strvalue = va_arg (args, char *);
305 max = maxlen; /* ie, no max */
306 fmtstr (buffer, &currlen, maxlen, strvalue, flags, min, max);
309 strvalue = va_arg (args, void *);
310 fmtint (buffer, &currlen, maxlen, (long) strvalue, 16, min, max, flags);
313 if (cflags == DP_C_SHORT)
316 num = va_arg (args, short int *);
319 else if (cflags == DP_C_LONG)
322 num = va_arg (args, long int *);
328 num = va_arg (args, int *);
333 dopr_outch (buffer, &currlen, maxlen, ch);
336 /* not supported yet, treat as next char */
344 state = DP_S_DEFAULT;
345 flags = cflags = min = 0;
352 break; /* some picky compilers need this */
355 if (currlen < maxlen - 1)
356 buffer[currlen] = '\0';
358 buffer[maxlen - 1] = '\0';
361 static void fmtstr (char *buffer, size_t *currlen, size_t maxlen,
362 char *value, int flags, int min, int max)
364 int padlen, strln; /* amount to pad */
372 for (strln = 0; value[strln]; ++strln); /* strlen */
373 padlen = min - strln;
376 if (flags & DP_F_MINUS)
377 padlen = -padlen; /* Left Justify */
379 while ((padlen > 0) && (cnt < max))
381 dopr_outch (buffer, currlen, maxlen, ' ');
385 while (*value && (cnt < max))
387 dopr_outch (buffer, currlen, maxlen, *value++);
390 while ((padlen < 0) && (cnt < max))
392 dopr_outch (buffer, currlen, maxlen, ' ');
398 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
400 static void fmtint (char *buffer, size_t *currlen, size_t maxlen,
401 long value, int base, int min, int max, int flags)
404 unsigned long uvalue;
407 int spadlen = 0; /* amount to space pad */
408 int zpadlen = 0; /* amount to zero pad */
416 if(!(flags & DP_F_UNSIGNED))
423 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
426 if (flags & DP_F_SPACE)
430 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
434 (caps? "0123456789ABCDEF":"0123456789abcdef")
435 [uvalue % (unsigned)base ];
436 uvalue = (uvalue / (unsigned)base );
437 } while(uvalue && (place < 20));
438 if (place == 20) place--;
441 zpadlen = max - place;
442 spadlen = min - THEMAX (max, place) - (signvalue ? 1 : 0);
443 if (zpadlen < 0) zpadlen = 0;
444 if (spadlen < 0) spadlen = 0;
445 if (flags & DP_F_ZERO)
447 zpadlen = THEMAX(zpadlen, spadlen);
450 if (flags & DP_F_MINUS)
451 spadlen = -spadlen; /* Left Justifty */
453 #ifdef DEBUG_SNPRINTF
454 dprint (1, (debugfile, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
455 zpadlen, spadlen, min, max, place));
461 dopr_outch (buffer, currlen, maxlen, ' ');
467 dopr_outch (buffer, currlen, maxlen, signvalue);
474 dopr_outch (buffer, currlen, maxlen, '0');
481 dopr_outch (buffer, currlen, maxlen, convert[--place]);
483 /* Left Justified spaces */
484 while (spadlen < 0) {
485 dopr_outch (buffer, currlen, maxlen, ' ');
490 static long double abs_val (long double value)
492 long double result = value;
500 static long double pow10 (int exp)
502 long double result = 1;
513 static long round (long double value)
518 value = value - intpart;
525 static void fmtfp (char *buffer, size_t *currlen, size_t maxlen,
526 long double fvalue, int min, int max, int flags)
534 int padlen = 0; /* amount to pad */
541 * AIX manpage says the default is 0, but Solaris says the default
542 * is 6, and sprintf on AIX defaults to 6
547 ufvalue = abs_val (fvalue);
552 if (flags & DP_F_PLUS) /* Do a sign (+/i) */
555 if (flags & DP_F_SPACE)
559 if (flags & DP_F_UP) caps = 1; /* Should characters be upper case? */
565 * Sorry, we only support 9 digits past the decimal because of our
571 /* We "cheat" by converting the fractional part to integer by
572 * multiplying by a factor of 10
574 fracpart = round ((pow10 (max)) * (ufvalue - intpart));
576 if (fracpart >= pow10 (max))
579 fracpart -= pow10 (max);
582 #ifdef DEBUG_SNPRINTF
583 dprint (1, (debugfile, "fmtfp: %f =? %d.%d\n", fvalue, intpart, fracpart));
586 /* Convert integer part */
589 (caps? "0123456789ABCDEF":"0123456789abcdef")[intpart % 10];
590 intpart = (intpart / 10);
591 } while(intpart && (iplace < 20));
592 if (iplace == 20) iplace--;
593 iconvert[iplace] = 0;
595 /* Convert fractional part */
598 (caps? "0123456789ABCDEF":"0123456789abcdef")[fracpart % 10];
599 fracpart = (fracpart / 10);
600 } while(fracpart && (fplace < 20));
601 if (fplace == 20) fplace--;
602 fconvert[fplace] = 0;
604 /* -1 for decimal point, another -1 if we are printing a sign */
605 padlen = min - iplace - max - 1 - ((signvalue) ? 1 : 0);
606 zpadlen = max - fplace;
611 if (flags & DP_F_MINUS)
612 padlen = -padlen; /* Left Justifty */
614 if ((flags & DP_F_ZERO) && (padlen > 0))
618 dopr_outch (buffer, currlen, maxlen, signvalue);
624 dopr_outch (buffer, currlen, maxlen, '0');
630 dopr_outch (buffer, currlen, maxlen, ' ');
634 dopr_outch (buffer, currlen, maxlen, signvalue);
637 dopr_outch (buffer, currlen, maxlen, iconvert[--iplace]);
640 * Decimal point. This should probably use locale to find the correct
643 dopr_outch (buffer, currlen, maxlen, '.');
646 dopr_outch (buffer, currlen, maxlen, fconvert[--fplace]);
650 dopr_outch (buffer, currlen, maxlen, '0');
656 dopr_outch (buffer, currlen, maxlen, ' ');
661 static void dopr_outch (char *buffer, size_t *currlen, size_t maxlen, char c)
663 if (*currlen < maxlen)
664 buffer[(*currlen)++] = c;
667 int vsnprintf (char *str, size_t count, const char *fmt, va_list args)
670 dopr(str, count, fmt, args);
674 int snprintf (char *str,size_t count,const char *fmt,...)
679 VA_SHIFT (str, char *);
680 VA_SHIFT (count, size_t );
681 VA_SHIFT (fmt, char *);
682 (void) vsnprintf(str, count, fmt, ap);
689 #define LONG_STRING 1024
693 char buf1[LONG_STRING];
694 char buf2[LONG_STRING];
709 double fp_nums[] = { -1.5, 134.21, 91340.2, 341.1234, 0203.9, 0.96, 0.996,
710 0.9996, 1.996, 4.136, 0};
723 long int_nums[] = { -1, 134, 91340, 341, 0203, 0};
728 printf ("Testing snprintf format codes against system sprintf...\n");
730 for (x = 0; fp_fmt[x] != NULL ; x++)
731 for (y = 0; fp_nums[y] != 0 ; y++)
733 snprintf (buf1, sizeof (buf1), fp_fmt[x], fp_nums[y]);
734 sprintf (buf2, fp_fmt[x], fp_nums[y]);
735 if (strcmp (buf1, buf2))
737 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
738 fp_fmt[x], buf1, buf2);
744 for (x = 0; int_fmt[x] != NULL ; x++)
745 for (y = 0; int_nums[y] != 0 ; y++)
747 snprintf (buf1, sizeof (buf1), int_fmt[x], int_nums[y]);
748 sprintf (buf2, int_fmt[x], int_nums[y]);
749 if (strcmp (buf1, buf2))
751 printf("snprintf doesn't match Format: %s\n\tsnprintf = %s\n\tsprintf = %s\n",
752 int_fmt[x], buf1, buf2);
757 printf ("%d tests failed out of %d.\n", fail, num);
759 #endif /* SNPRINTF_TEST */
761 #endif /* !HAVE_LOCAL_SNPRINTF */