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 * Chris Frey <cdfrey@foursquare.net> 2012/09/05
42 * Removed varargs.h and all dependency on it.
44 **************************************************************/
48 #if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
52 #include <sys/types.h>
55 #define VA_LOCAL_DECL va_list ap
56 #define VA_START(f) va_start(ap, f)
57 #define VA_SHIFT(v,t) ; /* no-op for ANSI */
58 #define VA_END va_end(ap)
60 /*int snprintf (char *str, size_t count, const char *fmt, ...);*/
61 /*int vsnprintf (char *str, size_t count, const char *fmt, va_list arg);*/
63 static void dopr (char *buffer
, size_t maxlen
, const char *format
,
65 static void fmtstr (char *buffer
, size_t *currlen
, size_t maxlen
,
66 char *value
, int flags
, int min
, int max
);
67 static void fmtint (char *buffer
, size_t *currlen
, size_t maxlen
,
68 long value
, int base
, int min
, int max
, int flags
);
69 static void fmtfp (char *buffer
, size_t *currlen
, size_t maxlen
,
70 long double fvalue
, int min
, int max
, int flags
);
71 static void dopr_outch (char *buffer
, size_t *currlen
, size_t maxlen
, char c
);
74 * dopr(): poor man's version of doprintf
77 /* format read states */
78 #define DP_S_DEFAULT 0
87 /* format flags - Bits */
88 #define DP_F_MINUS (1 << 0)
89 #define DP_F_PLUS (1 << 1)
90 #define DP_F_SPACE (1 << 2)
91 #define DP_F_NUM (1 << 3)
92 #define DP_F_ZERO (1 << 4)
93 #define DP_F_UP (1 << 5)
94 #define DP_F_UNSIGNED (1 << 6)
96 /* Conversion Flags */
99 #define DP_C_LDOUBLE 3
101 #define char_to_int(p) (p - '0')
102 #define MAX(p,q) ((p >= q) ? p : q)
104 static void dopr (char *buffer
, size_t maxlen
, const char *format
, va_list args
)
117 state
= DP_S_DEFAULT
;
118 currlen
= flags
= cflags
= min
= 0;
122 while (state
!= DP_S_DONE
)
124 if ((ch
== '\0') || (currlen
>= maxlen
))
133 dopr_outch (buffer
, &currlen
, maxlen
, ch
);
165 if (isdigit((unsigned char)ch
))
167 min
= 10*min
+ char_to_int (ch
);
172 min
= va_arg (args
, int);
189 if (isdigit((unsigned char)ch
))
193 max
= 10*max
+ char_to_int (ch
);
198 max
= va_arg (args
, int);
206 /* Currently, we don't support Long Long, bummer */
218 cflags
= DP_C_LDOUBLE
;
231 if (cflags
== DP_C_SHORT
)
232 value
= va_arg (args
, int);
233 else if (cflags
== DP_C_LONG
)
234 value
= va_arg (args
, long int);
236 value
= va_arg (args
, int);
237 fmtint (buffer
, &currlen
, maxlen
, value
, 10, min
, max
, flags
);
240 flags
|= DP_F_UNSIGNED
;
241 if (cflags
== DP_C_SHORT
)
242 value
= va_arg (args
, unsigned int);
243 else if (cflags
== DP_C_LONG
)
244 value
= va_arg (args
, unsigned long int);
246 value
= va_arg (args
, unsigned int);
247 fmtint (buffer
, &currlen
, maxlen
, value
, 8, min
, max
, flags
);
250 flags
|= DP_F_UNSIGNED
;
251 if (cflags
== DP_C_SHORT
)
252 value
= va_arg (args
, unsigned int);
253 else if (cflags
== DP_C_LONG
)
254 value
= va_arg (args
, unsigned long int);
256 value
= va_arg (args
, unsigned int);
257 fmtint (buffer
, &currlen
, maxlen
, value
, 10, min
, max
, flags
);
262 flags
|= DP_F_UNSIGNED
;
263 if (cflags
== DP_C_SHORT
)
264 value
= va_arg (args
, unsigned int);
265 else if (cflags
== DP_C_LONG
)
266 value
= va_arg (args
, unsigned long int);
268 value
= va_arg (args
, unsigned int);
269 fmtint (buffer
, &currlen
, maxlen
, value
, 16, min
, max
, flags
);
272 if (cflags
== DP_C_LDOUBLE
)
273 fvalue
= va_arg (args
, long double);
275 fvalue
= va_arg (args
, double);
276 /* um, floating point? */
277 fmtfp (buffer
, &currlen
, maxlen
, fvalue
, min
, max
, flags
);
282 if (cflags
== DP_C_LDOUBLE
)
283 fvalue
= va_arg (args
, long double);
285 fvalue
= va_arg (args
, double);
290 if (cflags
== DP_C_LDOUBLE
)
291 fvalue
= va_arg (args
, long double);
293 fvalue
= va_arg (args
, double);
296 dopr_outch (buffer
, &currlen
, maxlen
, va_arg (args
, int));
299 strvalue
= va_arg (args
, char *);
301 max
= maxlen
; /* ie, no max */
302 fmtstr (buffer
, &currlen
, maxlen
, strvalue
, flags
, min
, max
);
305 strvalue
= va_arg (args
, void *);
306 fmtint (buffer
, &currlen
, maxlen
, (long) strvalue
, 16, min
, max
, flags
);
309 if (cflags
== DP_C_SHORT
)
312 num
= va_arg (args
, short int *);
315 else if (cflags
== DP_C_LONG
)
318 num
= va_arg (args
, long int *);
324 num
= va_arg (args
, int *);
329 dopr_outch (buffer
, &currlen
, maxlen
, ch
);
332 /* not supported yet, treat as next char */
340 state
= DP_S_DEFAULT
;
341 flags
= cflags
= min
= 0;
348 break; /* some picky compilers need this */
351 if (currlen
< maxlen
- 1)
352 buffer
[currlen
] = '\0';
354 buffer
[maxlen
- 1] = '\0';
357 static void fmtstr (char *buffer
, size_t *currlen
, size_t maxlen
,
358 char *value
, int flags
, int min
, int max
)
360 int padlen
, strln
; /* amount to pad */
368 for (strln
= 0; value
[strln
]; ++strln
); /* strlen */
369 padlen
= min
- strln
;
372 if (flags
& DP_F_MINUS
)
373 padlen
= -padlen
; /* Left Justify */
375 while ((padlen
> 0) && (cnt
< max
))
377 dopr_outch (buffer
, currlen
, maxlen
, ' ');
381 while (*value
&& (cnt
< max
))
383 dopr_outch (buffer
, currlen
, maxlen
, *value
++);
386 while ((padlen
< 0) && (cnt
< max
))
388 dopr_outch (buffer
, currlen
, maxlen
, ' ');
394 /* Have to handle DP_F_NUM (ie 0x and 0 alternates) */
396 static void fmtint (char *buffer
, size_t *currlen
, size_t maxlen
,
397 long value
, int base
, int min
, int max
, int flags
)
400 unsigned long uvalue
;
403 int spadlen
= 0; /* amount to space pad */
404 int zpadlen
= 0; /* amount to zero pad */
412 if(!(flags
& DP_F_UNSIGNED
))
419 if (flags
& DP_F_PLUS
) /* Do a sign (+/i) */
422 if (flags
& DP_F_SPACE
)
426 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
430 (caps
? "0123456789ABCDEF":"0123456789abcdef")
431 [uvalue
% (unsigned)base
];
432 uvalue
= (uvalue
/ (unsigned)base
);
433 } while(uvalue
&& (place
< 20));
434 if (place
== 20) place
--;
437 zpadlen
= max
- place
;
438 spadlen
= min
- MAX (max
, place
) - (signvalue
? 1 : 0);
439 if (zpadlen
< 0) zpadlen
= 0;
440 if (spadlen
< 0) spadlen
= 0;
441 if (flags
& DP_F_ZERO
)
443 zpadlen
= MAX(zpadlen
, spadlen
);
446 if (flags
& DP_F_MINUS
)
447 spadlen
= -spadlen
; /* Left Justifty */
449 #ifdef DEBUG_SNPRINTF
450 dprint (1, (debugfile
, "zpad: %d, spad: %d, min: %d, max: %d, place: %d\n",
451 zpadlen
, spadlen
, min
, max
, place
));
457 dopr_outch (buffer
, currlen
, maxlen
, ' ');
463 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
470 dopr_outch (buffer
, currlen
, maxlen
, '0');
477 dopr_outch (buffer
, currlen
, maxlen
, convert
[--place
]);
479 /* Left Justified spaces */
480 while (spadlen
< 0) {
481 dopr_outch (buffer
, currlen
, maxlen
, ' ');
486 static long double abs_val (long double value
)
488 long double result
= value
;
496 static long double pow10_ (int exp
)
498 long double result
= 1;
509 static long round_ (long double value
)
514 value
= value
- intpart
;
521 static void fmtfp (char *buffer
, size_t *currlen
, size_t maxlen
,
522 long double fvalue
, int min
, int max
, int flags
)
530 int padlen
= 0; /* amount to pad */
537 * AIX manpage says the default is 0, but Solaris says the default
538 * is 6, and sprintf on AIX defaults to 6
543 ufvalue
= abs_val (fvalue
);
548 if (flags
& DP_F_PLUS
) /* Do a sign (+/i) */
551 if (flags
& DP_F_SPACE
)
555 if (flags
& DP_F_UP
) caps
= 1; /* Should characters be upper case? */
561 * Sorry, we only support 9 digits past the decimal because of our
567 /* We "cheat" by converting the fractional part to integer by
568 * multiplying by a factor of 10
570 fracpart
= round_ ((pow10_ (max
)) * (ufvalue
- intpart
));
572 if (fracpart
>= pow10_ (max
))
575 fracpart
-= pow10_ (max
);
578 #ifdef DEBUG_SNPRINTF
579 dprint (1, (debugfile
, "fmtfp: %f =? %d.%d\n", fvalue
, intpart
, fracpart
));
582 /* Convert integer part */
585 (caps
? "0123456789ABCDEF":"0123456789abcdef")[intpart
% 10];
586 intpart
= (intpart
/ 10);
587 } while(intpart
&& (iplace
< 20));
588 if (iplace
== 20) iplace
--;
589 iconvert
[iplace
] = 0;
591 /* Convert fractional part */
594 (caps
? "0123456789ABCDEF":"0123456789abcdef")[fracpart
% 10];
595 fracpart
= (fracpart
/ 10);
596 } while(fracpart
&& (fplace
< 20));
597 if (fplace
== 20) fplace
--;
598 fconvert
[fplace
] = 0;
600 /* -1 for decimal point, another -1 if we are printing a sign */
601 padlen
= min
- iplace
- max
- 1 - ((signvalue
) ? 1 : 0);
602 zpadlen
= max
- fplace
;
607 if (flags
& DP_F_MINUS
)
608 padlen
= -padlen
; /* Left Justifty */
610 if ((flags
& DP_F_ZERO
) && (padlen
> 0))
614 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
620 dopr_outch (buffer
, currlen
, maxlen
, '0');
626 dopr_outch (buffer
, currlen
, maxlen
, ' ');
630 dopr_outch (buffer
, currlen
, maxlen
, signvalue
);
633 dopr_outch (buffer
, currlen
, maxlen
, iconvert
[--iplace
]);
636 * Decimal point. This should probably use locale to find the correct
639 dopr_outch (buffer
, currlen
, maxlen
, '.');
642 dopr_outch (buffer
, currlen
, maxlen
, fconvert
[--fplace
]);
646 dopr_outch (buffer
, currlen
, maxlen
, '0');
652 dopr_outch (buffer
, currlen
, maxlen
, ' ');
657 static void dopr_outch (char *buffer
, size_t *currlen
, size_t maxlen
, char c
)
659 if (*currlen
< maxlen
)
660 buffer
[(*currlen
)++] = c
;
662 #endif /* !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF) */
664 #ifndef HAVE_VSNPRINTF
665 int mutt_vsnprintf (char *str
, size_t count
, const char *fmt
, va_list args
)
668 dopr(str
, count
, fmt
, args
);
671 #endif /* !HAVE_VSNPRINTF */
673 #ifndef HAVE_SNPRINTF
674 int mutt_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) mutt_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 mutt_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 mutt_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_SNPRINTF */