2 * snprintf.c -- formatted output to a string
4 * This is an implementation of snprintf() and vsnprintf()
5 * taken from the Apache web server. This is only used on
6 * systems which do not have a native version.
9 /* ====================================================================
10 * Copyright (c) 1995-1999 The Apache Group. All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in
21 * the documentation and/or other materials provided with the
24 * 3. All advertising materials mentioning features or use of this
25 * software must display the following acknowledgment:
26 * "This product includes software developed by the Apache Group
27 * for use in the Apache HTTP server project (http://www.apache.org/)."
29 * 4. The names "Apache Server" and "Apache Group" must not be used to
30 * endorse or promote products derived from this software without
31 * prior written permission. For written permission, please contact
34 * 5. Products derived from this software may not be called "Apache"
35 * nor may "Apache" appear in their names without prior written
36 * permission of the Apache Group.
38 * 6. Redistributions of any form whatsoever must retain the following
40 * "This product includes software developed by the Apache Group
41 * for use in the Apache HTTP server project (http://www.apache.org/)."
43 * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
44 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
46 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE GROUP OR
47 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
49 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
50 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
52 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
53 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54 * OF THE POSSIBILITY OF SUCH DAMAGE.
55 * ====================================================================
57 * This software consists of voluntary contributions made by many
58 * individuals on behalf of the Apache Group and was originally based
59 * on public domain software written at the National Center for
60 * Supercomputing Applications, University of Illinois, Urbana-Champaign.
61 * For more information on the Apache Group and the Apache HTTP server
62 * project, please see <http://www.apache.org/>.
64 * This code is based on, and used with the permission of, the
65 * SIO stdio-replacement strx_* functions by Panos Tsirigotis
66 * <panos@alumni.cs.colorado.edu> for xinetd.
71 #include <sys/types.h>
76 #include <netinet/in.h>
89 #define INT_NULL ((int *)0)
97 typedef WIDE_INT wide_int;
98 typedef unsigned WIDE_INT u_wide_int;
101 #define S_NULL "(null)"
104 #define FLOAT_DIGITS 6
105 #define EXPONENT_LENGTH 10
107 /* These macros allow correct support of 8-bit characters on systems which
108 * support 8-bit characters. Pretty dumb how the cast is required, but
109 * that's legacy libc for ya. These new macros do not support EOF like
110 * the standard macros do. Tough.
112 #define ap_isalpha(c) (isalpha(((unsigned char)(c))))
113 #define ap_isdigit(c) (isdigit(((unsigned char)(c))))
114 #define ap_islower(c) (islower(((unsigned char)(c))))
117 * NUM_BUF_SIZE is the size of the buffer used for arithmetic conversions
119 * XXX: this is a magic number; do not decrease it
121 #define NUM_BUF_SIZE 512
124 * cvt.c - IEEE floating point formatting routines for FreeBSD
125 * from GNU libc-4.6.27. Modified to be thread safe.
129 * ap_ecvt converts to decimal
130 * the number of digits is specified by ndigit
131 * decpt is set to the position of the decimal point
132 * sign is set to 0 for positive, 1 for negative
137 /* buf must have at least NDIG bytes */
138 static char *ap_cvt(double arg, int ndigits, int *decpt, int *sign, int eflag, char *buf)
142 register char *p, *p1;
144 if (ndigits >= NDIG - 1)
153 arg = modf(arg, &fi);
161 fj = modf(fi / 10, &fi);
162 *--p1 = (int) ((fj + .03) * 10) + '0';
165 while (p1 < &buf[NDIG])
167 } else if (arg > 0) {
168 while ((fj = arg * 10) < 1) {
181 while (p <= p1 && p < &buf[NDIG]) {
183 arg = modf(arg, &fj);
184 *p++ = (int) fj + '0';
186 if (p1 >= &buf[NDIG]) {
187 buf[NDIG - 1] = '\0';
210 static char *ap_ecvt(double arg, int ndigits, int *decpt, int *sign, char *buf)
212 return (ap_cvt(arg, ndigits, decpt, sign, 1, buf));
215 static char *ap_fcvt(double arg, int ndigits, int *decpt, int *sign, char *buf)
217 return (ap_cvt(arg, ndigits, decpt, sign, 0, buf));
221 * ap_gcvt - Floating output conversion to
222 * minimal length string
225 static char *ap_gcvt(double number, int ndigit, char *buf, boolean_e altform)
228 register char *p1, *p2;
232 p1 = ap_ecvt(number, ndigit, &decpt, &sign, buf1);
236 for (i = ndigit - 1; i > 0 && p1[i] == '0'; i--)
238 if ((decpt >= 0 && decpt - ndigit > 4)
239 || (decpt < 0 && decpt < -3)) { /* use E-style */
243 for (i = 1; i < ndigit; i++)
252 *p2++ = decpt / 100 + '0';
254 *p2++ = (decpt % 100) / 10 + '0';
255 *p2++ = decpt % 10 + '0';
265 for (i = 1; i <= ndigit; i++) {
270 if (ndigit < decpt) {
271 while (ndigit++ < decpt)
276 if (p2[-1] == '.' && !altform)
283 * The INS_CHAR macro inserts a character in the buffer and writes
284 * the buffer back to disk if necessary
285 * It uses the char pointers sp and bep:
286 * sp points to the next available character in the buffer
287 * bep points to the end-of-buffer+1
288 * While using this macro, note that the nextb pointer is NOT updated.
290 * NOTE: Evaluation of the c argument should not have any side-effects
292 #define INS_CHAR(c, sp, bep, cc) \
295 vbuff->curpos = sp; \
296 if (flush_func(vbuff)) \
298 sp = vbuff->curpos; \
299 bep = vbuff->endpos; \
305 #define NUM( c ) ( c - '0' )
307 #define STR_TO_DEC( str, num ) \
308 num = NUM( *str++ ) ; \
309 while ( ap_isdigit( *str ) ) \
312 num += NUM( *str++ ) ; \
316 * This macro does zero padding so that the precision
317 * requirement is satisfied. The padding is done by
318 * adding '0's to the left of the string that is going
321 #define FIX_PRECISION( adjust, precision, s, s_len ) \
323 while ( s_len < precision ) \
330 * Macro that does padding. The padding is done by printing
333 #define PAD( width, len, ch ) do \
335 INS_CHAR( ch, sp, bep, cc ) ; \
338 while ( width > len )
341 * Prefix the character ch to the string str
343 * Set the has_prefix flag
345 #define PREFIX( str, length, ch ) *--str = ch ; length++ ; has_prefix = YES
349 * Convert num to its decimal format.
351 * - a pointer to a string containing the number (no sign)
352 * - len contains the length of the string
353 * - is_negative is set to TRUE or FALSE depending on the sign
354 * of the number (always set to FALSE if is_unsigned is TRUE)
356 * The caller provides a buffer for the string: that is the buf_end argument
357 * which is a pointer to the END of the buffer + 1 (i.e. if the buffer
358 * is declared as buf[ 100 ], buf_end should be &buf[ 100 ])
360 static char *conv_10(register wide_int num, register bool_int is_unsigned,
361 register bool_int *is_negative, char *buf_end,
364 register char *p = buf_end;
365 register u_wide_int magnitude;
368 magnitude = (u_wide_int) num;
369 *is_negative = FALSE;
371 *is_negative = (num < 0);
374 * On a 2's complement machine, negating the most negative integer
375 * results in a number that cannot be represented as a signed integer.
376 * Here is what we do to obtain the number's magnitude:
377 * a. add 1 to the number
378 * b. negate it (becomes positive)
379 * c. convert it to unsigned
383 wide_int t = num + 1;
385 magnitude = ((u_wide_int) -t) + 1;
387 magnitude = (u_wide_int) num;
391 * We use a do-while loop so that we write at least 1 digit
394 register u_wide_int new_magnitude = magnitude / 10;
396 *--p = (char) (magnitude - new_magnitude * 10 + '0');
397 magnitude = new_magnitude;
407 static char *conv_in_addr(struct in_addr *ia, char *buf_end, int *len)
409 unsigned addr = ntohl(ia->s_addr);
411 bool_int is_negative;
414 p = conv_10((addr & 0x000000FF) , TRUE, &is_negative, p, &sub_len);
416 p = conv_10((addr & 0x0000FF00) >> 8, TRUE, &is_negative, p, &sub_len);
418 p = conv_10((addr & 0x00FF0000) >> 16, TRUE, &is_negative, p, &sub_len);
420 p = conv_10((addr & 0xFF000000) >> 24, TRUE, &is_negative, p, &sub_len);
428 static char *conv_sockaddr_in(struct sockaddr_in *si, char *buf_end, int *len)
431 bool_int is_negative;
434 p = conv_10(ntohs(si->sin_port), TRUE, &is_negative, p, &sub_len);
436 p = conv_in_addr(&si->sin_addr, p, &sub_len);
445 * Convert a floating point number to a string formats 'f', 'e' or 'E'.
446 * The result is placed in buf, and len denotes the length of the string
447 * The sign is returned in the is_negative argument (and is not placed
450 static char *conv_fp(register char format, register double num,
451 boolean_e add_dp, int precision, bool_int *is_negative,
454 register char *s = buf;
460 p = ap_fcvt(num, precision, &decimal_point, is_negative, buf1);
461 else /* either e or E format */
462 p = ap_ecvt(num, precision + 1, &decimal_point, is_negative, buf1);
465 * Check for Infinity and NaN
467 if (ap_isalpha(*p)) {
468 *len = strlen(strcpy(buf, p));
469 *is_negative = FALSE;
474 if (decimal_point <= 0) {
478 while (decimal_point++ < 0)
483 while (decimal_point-- > 0)
485 if (precision > 0 || add_dp)
490 if (precision > 0 || add_dp)
495 * copy the rest of p, the NUL is NOT copied
501 char temp[EXPONENT_LENGTH]; /* for exponent conversion */
503 bool_int exponent_is_negative;
505 *s++ = format; /* either e or E */
507 if (decimal_point != 0) {
508 p = conv_10((wide_int) decimal_point, FALSE,
509 &exponent_is_negative, &temp[EXPONENT_LENGTH],
511 *s++ = exponent_is_negative ? '-' : '+';
514 * Make sure the exponent has at least 2 digits
533 * Convert num to a base X number where X is a power of 2. nbits determines X.
534 * For example, if nbits is 3, we do base 8 conversion
536 * a pointer to a string containing the number
538 * The caller provides a buffer for the string: that is the buf_end argument
539 * which is a pointer to the END of the buffer + 1 (i.e. if the buffer
540 * is declared as buf[ 100 ], buf_end should be &buf[ 100 ])
542 static char *conv_p2(register u_wide_int num, register int nbits,
543 char format, char *buf_end, register int *len)
545 register int mask = (1 << nbits) - 1;
546 register char *p = buf_end;
547 static const char low_digits[] = "0123456789abcdef";
548 static const char upper_digits[] = "0123456789ABCDEF";
549 register const char *digits = (format == 'X') ? upper_digits : low_digits;
552 *--p = digits[num & mask];
563 * Do format conversion placing the output in buffer
565 int ap_vformatter(int (*flush_func)(ap_vformatter_buff *),
566 ap_vformatter_buff *vbuff, const char *fmt, va_list ap)
573 register char *s = NULL;
577 register int min_width = 0;
586 wide_int i_num = (wide_int) 0;
589 char num_buf[NUM_BUF_SIZE];
590 char char_buf[2]; /* for printing %% and %<unknown> */
596 boolean_e alternate_form;
597 boolean_e print_sign;
598 boolean_e print_blank;
599 boolean_e adjust_precision;
600 boolean_e adjust_width;
601 bool_int is_negative;
608 INS_CHAR(*fmt, sp, bep, cc);
611 * Default variable settings
614 alternate_form = print_sign = print_blank = NO;
621 * Try to avoid checking for flags, width or precision
623 if (!ap_islower(*fmt)) {
625 * Recognize flags: -, #, BLANK, +
630 else if (*fmt == '+')
632 else if (*fmt == '#')
633 alternate_form = YES;
634 else if (*fmt == ' ')
636 else if (*fmt == '0')
643 * Check if a width was specified
645 if (ap_isdigit(*fmt)) {
646 STR_TO_DEC(fmt, min_width);
648 } else if (*fmt == '*') {
649 min_width = va_arg(ap, int);
654 min_width = -min_width;
660 * Check if a precision was specified
662 * XXX: an unreasonable amount of precision may be specified
663 * resulting in overflow of num_buf. Currently we
664 * ignore this possibility.
667 adjust_precision = YES;
669 if (ap_isdigit(*fmt)) {
670 STR_TO_DEC(fmt, precision);
671 } else if (*fmt == '*') {
672 precision = va_arg(ap, int);
679 adjust_precision = NO;
681 adjust_precision = adjust_width = NO;
690 if (*fmt == 'h') /* "short" backward compatibility */
696 * Argument extraction and printing.
697 * First we determine the argument type.
698 * Then, we convert the argument to a string.
699 * On exit from the switch, s points to the string that
700 * must be printed, s_len has the length of the string
701 * The precision requirements, if any, are reflected in s_len.
703 * NOTE: pad_char may be set to '0' because of the 0 flag.
704 * It is reset to ' ' by non-numeric formats
709 i_num = va_arg(ap, u_wide_int);
711 i_num = (wide_int) va_arg(ap, unsigned int);
712 s = conv_10(i_num, 1, &is_negative,
713 &num_buf[NUM_BUF_SIZE], &s_len);
714 FIX_PRECISION(adjust_precision, precision, s, s_len);
720 i_num = va_arg(ap, wide_int);
722 i_num = (wide_int) va_arg(ap, int);
723 s = conv_10(i_num, 0, &is_negative,
724 &num_buf[NUM_BUF_SIZE], &s_len);
725 FIX_PRECISION(adjust_precision, precision, s, s_len);
731 else if (print_blank)
738 ui_num = va_arg(ap, u_wide_int);
740 ui_num = (u_wide_int) va_arg(ap, unsigned int);
741 s = conv_p2(ui_num, 3, *fmt,
742 &num_buf[NUM_BUF_SIZE], &s_len);
743 FIX_PRECISION(adjust_precision, precision, s, s_len);
744 if (alternate_form && *s != '0') {
754 ui_num = (u_wide_int) va_arg(ap, u_wide_int);
756 ui_num = (u_wide_int) va_arg(ap, unsigned int);
757 s = conv_p2(ui_num, 4, *fmt,
758 &num_buf[NUM_BUF_SIZE], &s_len);
759 FIX_PRECISION(adjust_precision, precision, s, s_len);
760 if (alternate_form && i_num != 0) {
761 *--s = *fmt; /* 'x' or 'X' */
769 s = va_arg(ap, char *);
772 if (adjust_precision && precision < s_len)
786 fp_num = va_arg(ap, double);
788 * * We use &num_buf[ 1 ], so that we have room for the sign
790 s = conv_fp(*fmt, fp_num, alternate_form,
791 (adjust_precision == NO) ? FLOAT_DIGITS : precision,
792 &is_negative, &num_buf[1], &s_len);
797 else if (print_blank)
804 if (adjust_precision == NO)
805 precision = FLOAT_DIGITS;
806 else if (precision == 0)
809 * * We use &num_buf[ 1 ], so that we have room for the sign
811 s = ap_gcvt(va_arg(ap, double), precision, &num_buf[1],
817 else if (print_blank)
822 if (alternate_form && (q = strchr(s, '.')) == NULL) {
824 s[s_len] = '\0'; /* delimit for following strchr() */
826 if (*fmt == 'G' && (q = strchr(s, 'e')) != NULL)
832 char_buf[0] = (char) (va_arg(ap, int));
848 *(va_arg(ap, int *)) = cc;
852 * This is where we extend the printf format, with a second
858 * If the pointer size is equal to the size of an unsigned
859 * integer we convert the pointer to a hex number, otherwise
860 * we print "%p" to indicate that we don't handle "%p".
863 ui_num = (u_wide_int) va_arg(ap, void *);
865 if (sizeof(char *) <= sizeof(u_wide_int))
866 s = conv_p2(ui_num, 4, 'x',
867 &num_buf[NUM_BUF_SIZE], &s_len);
876 /* print a struct sockaddr_in as a.b.c.d:port */
879 struct sockaddr_in *si;
881 si = va_arg(ap, struct sockaddr_in *);
883 s = conv_sockaddr_in(si, &num_buf[NUM_BUF_SIZE], &s_len);
884 if (adjust_precision && precision < s_len)
895 /* print a struct in_addr as a.b.c.d */
900 ia = va_arg(ap, struct in_addr *);
902 s = conv_in_addr(ia, &num_buf[NUM_BUF_SIZE], &s_len);
903 if (adjust_precision && precision < s_len)
915 /* if %p ends the string, oh well ignore it */
928 * The last character of the format string was %.
935 * The default case is for unrecognized %'s.
936 * We print %<char> to help the user identify what
937 * option is not understood.
938 * This is also useful in case the user wants to pass
939 * the output of format_converter to another function
940 * that understands some other %<char> (like syslog).
941 * Note that we can't point s inside fmt because the
942 * unknown <char> could be preceded by width etc.
953 if (prefix_char != NUL && s != S_NULL && s != char_buf) {
958 if (adjust_width && adjust == RIGHT && min_width > s_len) {
959 if (pad_char == '0' && prefix_char != NUL) {
960 INS_CHAR(*s, sp, bep, cc);
965 PAD(min_width, s_len, pad_char);
969 * Print the string s.
971 for (i = s_len; i != 0; i--) {
972 INS_CHAR(*s, sp, bep, cc);
976 if (adjust_width && adjust == LEFT && min_width > s_len)
977 PAD(min_width, s_len, pad_char);
986 static int snprintf_flush(ap_vformatter_buff *vbuff)
988 /* if the buffer fills we have to abort immediately, there is no way
989 * to "flush" a snprintf... there's nowhere to flush it to.
995 int snprintf(char *buf, size_t len, const char *format,...)
999 ap_vformatter_buff vbuff;
1004 /* save one byte for nul terminator */
1006 vbuff.endpos = buf + len - 1;
1007 va_start(ap, format);
1008 cc = ap_vformatter(snprintf_flush, &vbuff, format, ap);
1010 *vbuff.curpos = '\0';
1011 return (cc == -1) ? len : cc;
1015 int vsnprintf(char *buf, size_t len, const char *format, va_list ap)
1018 ap_vformatter_buff vbuff;
1023 /* save one byte for nul terminator */
1025 vbuff.endpos = buf + len - 1;
1026 cc = ap_vformatter(snprintf_flush, &vbuff, format, ap);
1027 *vbuff.curpos = '\0';
1028 return (cc == -1) ? len : cc;