1 /****************************************************************************
5 *************************************************************************
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
11 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
12 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
13 * MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE AUTHORS AND
14 * CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
17 * A merge of Bjorn Reese's format() function and Daniel's dsprintf()
18 * 1.0. A full blooded printf() clone with full support for <num>$
19 * everywhere (parameters, widths and precisions) including variabled
20 * sized parameters (like doubles, long longs, long doubles and even
21 * void * in 64-bit architectures).
23 * Current restrictions:
24 * - Max 128 parameters
25 * - No 'long double' support.
27 * If you ever want truly portable and good *printf() clones, the project that
28 * took on from here is named 'Trio' and you find more details on the trio web
29 * page at http://daniel.haxx.se/trio/
34 #include <sys/types.h>
41 #include <curl/mprintf.h>
43 #ifndef SIZEOF_LONG_DOUBLE
44 #define SIZEOF_LONG_DOUBLE 0
49 #define LONG_LONG long long
53 /* The last #include file should be: */
58 #define BUFFSIZE 256 /* buffer for long-to-str and float-to-str calcs */
59 #define MAX_PARAMETERS 128 /* lame static limit */
69 # define TRUE ((char)(1 == 1))
70 # define FALSE ((char)(0 == 1))
75 /* Lower-case digits. */
76 static const char lower_digits[] = "0123456789abcdefghijklmnopqrstuvwxyz";
78 /* Upper-case digits. */
79 static const char upper_digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
81 #define OUTCHAR(x) done+=(stream(x, (FILE *)data)==-1?0:1)
83 /* Data type to read from the arglist */
94 FORMAT_WIDTH /* For internal use */
97 /* convertion and display flags */
101 FLAGS_SHOWSIGN = 1<<1,
106 FLAGS_LONGLONG = 1<<6,
107 FLAGS_LONGDOUBLE = 1<<7,
108 FLAGS_PAD_NIL = 1<<8,
109 FLAGS_UNSIGNED = 1<<9,
113 FLAGS_WIDTH = 1<<13, /* '*' or '*<num>$' used */
114 FLAGS_WIDTHPARAM = 1<<14, /* width PARAMETER was specified */
115 FLAGS_PREC = 1<<15, /* precision was specified */
116 FLAGS_PRECPARAM = 1<<16, /* precision PARAMETER was specified */
117 FLAGS_CHAR = 1<<17, /* %c story */
118 FLAGS_FLOATE = 1<<18, /* %e or %E */
119 FLAGS_FLOATG = 1<<19 /* %g or %G */
125 long width; /* width OR width parameter number */
126 long precision; /* precision OR precision parameter number */
135 #if 0 /*SIZEOF_LONG_DOUBLE */
148 char *buffer; /* allocated buffer */
149 size_t len; /* length of string */
150 size_t alloc; /* length of alloc */
153 int curl_msprintf(char *buffer, const char *format, ...);
155 static long dprintf_DollarString(char *input, char **end)
158 while(isdigit((int)*input)) {
160 number += *input-'0';
163 if(number && ('$'==*input++)) {
170 static BOOL dprintf_IsQualifierNoDollar(char c)
173 case '-': case '+': case ' ': case '#': case '.':
174 case '0': case '1': case '2': case '3': case '4':
175 case '5': case '6': case '7': case '8': case '9':
176 case 'h': case 'l': case 'L': case 'z': case 'q':
184 #ifdef DPRINTF_DEBUG2
185 int dprintf_Pass1Report(va_stack_t *vto, int max)
192 for(i=0; i<max; i++) {
194 switch(vto[i].type) {
210 case FORMAT_LONGLONG:
216 case FORMAT_LONGDOUBLE:
217 type = "long double";
224 for(bit=0; bit<31; bit++) {
225 flags = vto[i].flags & (1<<bit);
227 if(flags & FLAGS_SPACE)
228 strcat(buffer, "space ");
229 else if(flags & FLAGS_SHOWSIGN)
230 strcat(buffer, "plus ");
231 else if(flags & FLAGS_LEFT)
232 strcat(buffer, "left ");
233 else if(flags & FLAGS_ALT)
234 strcat(buffer, "alt ");
235 else if(flags & FLAGS_SHORT)
236 strcat(buffer, "short ");
237 else if(flags & FLAGS_LONG)
238 strcat(buffer, "long ");
239 else if(flags & FLAGS_LONGLONG)
240 strcat(buffer, "longlong ");
241 else if(flags & FLAGS_LONGDOUBLE)
242 strcat(buffer, "longdouble ");
243 else if(flags & FLAGS_PAD_NIL)
244 strcat(buffer, "padnil ");
245 else if(flags & FLAGS_UNSIGNED)
246 strcat(buffer, "unsigned ");
247 else if(flags & FLAGS_OCTAL)
248 strcat(buffer, "octal ");
249 else if(flags & FLAGS_HEX)
250 strcat(buffer, "hex ");
251 else if(flags & FLAGS_UPPER)
252 strcat(buffer, "upper ");
253 else if(flags & FLAGS_WIDTH)
254 strcat(buffer, "width ");
255 else if(flags & FLAGS_WIDTHPARAM)
256 strcat(buffer, "widthparam ");
257 else if(flags & FLAGS_PREC)
258 strcat(buffer, "precision ");
259 else if(flags & FLAGS_PRECPARAM)
260 strcat(buffer, "precparam ");
261 else if(flags & FLAGS_CHAR)
262 strcat(buffer, "char ");
263 else if(flags & FLAGS_FLOATE)
264 strcat(buffer, "floate ");
265 else if(flags & FLAGS_FLOATG)
266 strcat(buffer, "floatg ");
268 printf("REPORT: %d. %s [%s]\n", i, type, buffer);
276 /******************************************************************
279 * Create an index with the type of each parameter entry and its
280 * value (may vary in size)
282 ******************************************************************/
284 static long dprintf_Pass1(char *format, va_stack_t *vto, char **endpos,
300 continue; /* while */
305 /* Handle the positional case (N$) */
309 this_param = dprintf_DollarString(fmt, &fmt);
311 /* we got no positional, get the next counter */
312 this_param = param_num;
314 if (this_param > max_param)
315 max_param = this_param;
318 * The parameter with number 'i' should be used. Next, we need
319 * to get SIZE and TYPE of the parameter. Add the information
326 /* Handle the flags */
328 while (dprintf_IsQualifierNoDollar(*fmt)) {
331 flags |= FLAGS_SPACE;
334 flags |= FLAGS_SHOWSIGN;
338 flags &= ~FLAGS_PAD_NIL;
346 /* The precision is picked from a specified parameter */
348 flags |= FLAGS_PRECPARAM;
352 i = dprintf_DollarString(fmt, &fmt);
356 precision = param_num;
358 if (precision > max_param)
359 max_param = precision;
363 precision = strtol(fmt, &fmt, 10);
367 flags |= FLAGS_SHORT;
370 if (flags & FLAGS_LONG)
371 flags |= FLAGS_LONGLONG;
376 flags |= FLAGS_LONGDOUBLE;
379 flags |= FLAGS_LONGLONG;
382 /* the code below generates a warning if -Wunreachable-code is
384 if (sizeof(size_t) > sizeof(unsigned long))
385 flags |= FLAGS_LONGLONG;
386 if (sizeof(size_t) > sizeof(unsigned int))
390 #if SIZEOF_CURL_OFF_T > 4
391 flags |= FLAGS_LONGLONG;
397 if (!(flags & FLAGS_LEFT))
398 flags |= FLAGS_PAD_NIL;
400 case '1': case '2': case '3': case '4':
401 case '5': case '6': case '7': case '8': case '9':
402 flags |= FLAGS_WIDTH;
403 width = strtol(fmt-1, &fmt, 10);
405 case '*': /* Special case */
406 flags |= FLAGS_WIDTHPARAM;
409 i = dprintf_DollarString(fmt, &fmt);
414 if(width > max_param)
422 /* Handle the specifier */
431 vto[i].type = FORMAT_STRING;
434 vto[i].type = FORMAT_INTPTR;
437 vto[i].type = FORMAT_PTR;
440 vto[i].type = FORMAT_INT;
443 vto[i].type = FORMAT_INT;
444 flags |= FLAGS_UNSIGNED;
447 vto[i].type = FORMAT_INT;
448 flags |= FLAGS_OCTAL;
451 vto[i].type = FORMAT_INT;
455 vto[i].type = FORMAT_INT;
456 flags |= FLAGS_HEX|FLAGS_UPPER;
459 vto[i].type = FORMAT_INT;
463 vto[i].type = FORMAT_DOUBLE;
466 vto[i].type = FORMAT_DOUBLE;
467 flags |= FLAGS_FLOATE;
470 vto[i].type = FORMAT_DOUBLE;
471 flags |= FLAGS_FLOATE|FLAGS_UPPER;
474 vto[i].type = FORMAT_DOUBLE;
475 flags |= FLAGS_FLOATG;
478 vto[i].type = FORMAT_DOUBLE;
479 flags |= FLAGS_FLOATG|FLAGS_UPPER;
482 vto[i].type = FORMAT_UNKNOWN;
486 vto[i].flags = flags;
487 vto[i].width = width;
488 vto[i].precision = precision;
490 if (flags & FLAGS_WIDTHPARAM) {
491 /* we have the width specified from a parameter, so we make that
492 parameter's info setup properly */
493 vto[i].width = width - 1;
495 vto[i].type = FORMAT_WIDTH;
496 vto[i].flags = FLAGS_NEW;
497 vto[i].precision = vto[i].width = 0; /* can't use width or precision
500 if (flags & FLAGS_PRECPARAM) {
501 /* we have the precision specified from a parameter, so we make that
502 parameter's info setup properly */
503 vto[i].precision = precision - 1;
505 vto[i].type = FORMAT_WIDTH;
506 vto[i].flags = FLAGS_NEW;
507 vto[i].precision = vto[i].width = 0; /* can't use width or precision
510 *endpos++ = fmt + 1; /* end of this sequence */
514 #ifdef DPRINTF_DEBUG2
515 dprintf_Pass1Report(vto, max_param);
518 /* Read the arg list parameters into our data list */
519 for (i=0; i<max_param; i++) {
520 if ((i + 1 < max_param) && (vto[i + 1].type == FORMAT_WIDTH))
522 /* Width/precision arguments must be read before the main argument
523 * they are attached to
525 vto[i + 1].data.num = va_arg(arglist, int);
531 vto[i].data.str = va_arg(arglist, char *);
537 vto[i].data.ptr = va_arg(arglist, void *);
542 if(vto[i].flags & FLAGS_LONGLONG)
543 vto[i].data.lnum = va_arg(arglist, LONG_LONG);
546 if(vto[i].flags & FLAGS_LONG)
547 vto[i].data.num = va_arg(arglist, long);
549 vto[i].data.num = va_arg(arglist, int);
553 #if 0 /*SIZEOF_LONG_DOUBLE */
554 if(vto[i].flags & FLAGS_LONG)
555 vto[i].data.ldnum = va_arg(arglist, long double);
558 vto[i].data.dnum = va_arg(arglist, double);
562 /* Argument has been read. Silently convert it into an integer
565 vto[i].type = FORMAT_INT;
577 static int dprintf_formatf(
578 void *data, /* untouched by format(), just sent to the
579 stream() function in the first argument */
580 int (*stream)(int, FILE *), /* function pointer called for each
582 const char *format, /* %-formatted string */
583 va_list ap_save) /* list of parameters */
585 /* Base-36 digits for numbers. */
586 const char *digits = lower_digits;
588 /* Pointer into the format string. */
591 /* Number of characters written. */
594 long param; /* current parameter to read */
595 long param_num=0; /* parameter counter */
597 va_stack_t vto[MAX_PARAMETERS];
598 char *endpos[MAX_PARAMETERS];
605 /* Do the actual %-code parsing */
606 dprintf_Pass1((char *)format, vto, endpos, ap_save);
608 end = &endpos[0]; /* the initial end-position from the list dprintf_Pass1()
613 /* Format spec modifiers. */
616 /* Width of a field. */
619 /* Precision of a field. */
622 /* Decimal integer is negative. */
625 /* Base of a number to be written. */
628 /* Integral values to be written. */
630 unsigned LONG_LONG num;
637 /* This isn't a format spec, so write everything out until the next one
638 OR end of string is reached. */
641 } while(*++f && ('%' != *f));
647 /* Check for "%%". Note that although the ANSI standard lists
648 '%' as a conversion specifier, it says "The complete format
649 specification shall be `%%'," so we can avoid all the width
650 and precision processing. */
657 /* If this is a positional parameter, the position must follow imediately
658 after the %, thus create a %<num>$ sequence */
659 param=dprintf_DollarString(f, &f);
666 param_num++; /* increase this always to allow "%2$s %1$s %s" and then the
667 third %s will pick the 3rd argument */
671 /* pick up the specified width */
672 if(p->flags & FLAGS_WIDTHPARAM)
673 width = vto[p->width].data.num;
677 /* pick up the specified precision */
678 if(p->flags & FLAGS_PRECPARAM)
679 prec = vto[p->precision].data.num;
680 else if(p->flags & FLAGS_PREC)
685 alt = (p->flags & FLAGS_ALT)?TRUE:FALSE;
690 if(p->flags & FLAGS_CHAR) {
692 if (!(p->flags & FLAGS_LEFT))
696 if (p->flags & FLAGS_LEFT)
701 if(p->flags & FLAGS_UNSIGNED) {
702 /* Decimal unsigned integer. */
704 goto unsigned_number;
706 if(p->flags & FLAGS_OCTAL) {
707 /* Octal unsigned integer. */
709 goto unsigned_number;
711 if(p->flags & FLAGS_HEX) {
712 /* Hexadecimal unsigned integer. */
714 digits = (p->flags & FLAGS_UPPER)? upper_digits : lower_digits;
716 goto unsigned_number;
719 /* Decimal integer. */
723 if(p->flags & FLAGS_LONGLONG) {
725 is_neg = p->data.lnum < 0;
726 num = is_neg ? (- p->data.lnum) : p->data.lnum;
731 signed_num = (long) num;
733 is_neg = signed_num < 0;
734 num = is_neg ? (- signed_num) : signed_num;
739 /* Unsigned number of base BASE. */
743 /* Number of base BASE. */
745 char *workend = &work[sizeof(work) - 1];
748 /* Supply a default precision if none was given. */
752 /* Put the number in WORK. */
755 *w-- = digits[num % base];
758 width -= workend - w;
761 if (alt && base == 8 && prec <= 0) {
772 if (alt && base == 16)
775 if (is_neg || (p->flags & FLAGS_SHOWSIGN) || (p->flags & FLAGS_SPACE))
778 if (!(p->flags & FLAGS_LEFT) && !(p->flags & FLAGS_PAD_NIL))
784 else if (p->flags & FLAGS_SHOWSIGN)
786 else if (p->flags & FLAGS_SPACE)
789 if (alt && base == 16) {
791 if(p->flags & FLAGS_UPPER)
797 if (!(p->flags & FLAGS_LEFT) && (p->flags & FLAGS_PAD_NIL))
801 /* Write the number. */
802 while (++w <= workend) {
806 if (p->flags & FLAGS_LEFT)
815 static char null[] = "(nil)";
819 str = (char *) p->data.str;
821 /* Write null[] if there's space. */
822 if (prec == -1 || prec >= (long) sizeof(null) - 1) {
824 len = sizeof(null) - 1;
825 /* Disable quotes around (nil) */
826 p->flags &= (~FLAGS_ALT);
836 if (prec != -1 && (size_t) prec < len)
840 if (p->flags & FLAGS_ALT)
843 if (!(p->flags&FLAGS_LEFT))
849 if (p->flags&FLAGS_LEFT)
853 if (p->flags & FLAGS_ALT)
859 /* Generic pointer. */
862 ptr = (void *) p->data.ptr;
864 /* If the pointer is not NULL, write it as a %#x spec. */
866 digits = (p->flags & FLAGS_UPPER)? upper_digits : lower_digits;
868 num = (unsigned long) ptr;
873 /* Write "(nil)" for a nil pointer. */
874 static char strnil[] = "(nil)";
877 width -= sizeof(strnil) - 1;
878 if (p->flags & FLAGS_LEFT)
881 for (point = strnil; *point != '\0'; ++point)
883 if (! (p->flags & FLAGS_LEFT))
892 char formatbuf[32]="%";
896 if (p->flags & FLAGS_WIDTH)
898 else if (p->flags & FLAGS_WIDTHPARAM)
899 width = vto[p->width].data.num;
902 if (p->flags & FLAGS_PREC)
904 else if (p->flags & FLAGS_PRECPARAM)
905 prec = vto[p->precision].data.num;
907 if (p->flags & FLAGS_LEFT)
908 strcat(formatbuf, "-");
909 if (p->flags & FLAGS_SHOWSIGN)
910 strcat(formatbuf, "+");
911 if (p->flags & FLAGS_SPACE)
912 strcat(formatbuf, " ");
913 if (p->flags & FLAGS_ALT)
914 strcat(formatbuf, "#");
916 fptr=&formatbuf[strlen(formatbuf)];
919 /* RECURSIVE USAGE */
920 fptr += curl_msprintf(fptr, "%ld", width);
923 /* RECURSIVE USAGE */
924 fptr += curl_msprintf(fptr, ".%ld", prec);
926 if (p->flags & FLAGS_LONG)
929 if (p->flags & FLAGS_FLOATE)
930 strcat(fptr, p->flags&FLAGS_UPPER?"E":"e");
931 else if (p->flags & FLAGS_FLOATG)
932 strcat(fptr, (p->flags & FLAGS_UPPER) ? "G" : "g");
936 /* NOTE NOTE NOTE!! Not all sprintf() implementations returns number
937 of output characters */
938 #if 0 /*SIZEOF_LONG_DOUBLE*/
939 if (p->flags & FLAGS_LONG)
940 /* This is for support of the 'long double' type */
941 (sprintf)(work, formatbuf, p->data.ldnum);
944 (sprintf)(work, formatbuf, p->data.dnum);
946 for(fptr=work; *fptr; fptr++)
952 /* Answer the count of characters written. */
954 if (p->flags & FLAGS_LONGLONG)
955 *(LONG_LONG *) p->data.ptr = (LONG_LONG)done;
958 if (p->flags & FLAGS_LONG)
959 *(long *) p->data.ptr = (long)done;
960 else if (!(p->flags & FLAGS_SHORT))
961 *(int *) p->data.ptr = (int)done;
963 *(short *) p->data.ptr = (short)done;
969 f = *end++; /* goto end of %-code */
975 /* fputc() look-alike */
976 static int addbyter(int output, FILE *data)
978 struct nsprintf *infop=(struct nsprintf *)data;
980 if(infop->length < infop->max) {
981 /* only do this if we haven't reached max length yet */
982 infop->buffer[0] = (char)output; /* store */
983 infop->buffer++; /* increase pointer */
984 infop->length++; /* we are now one byte larger */
985 return output; /* fputc() returns like this on success */
990 int curl_mvsnprintf(char *buffer, size_t maxlength, const char *format,
994 struct nsprintf info;
996 info.buffer = buffer;
998 info.max = maxlength;
1000 retcode = dprintf_formatf(&info, addbyter, format, ap_save);
1002 /* we terminate this with a zero byte */
1003 if(info.max == info.length)
1004 /* we're at maximum, scrap the last letter */
1005 info.buffer[-1] = 0;
1012 int curl_msnprintf(char *buffer, size_t maxlength, const char *format, ...)
1015 va_list ap_save; /* argument pointer */
1016 va_start(ap_save, format);
1017 retcode = curl_mvsnprintf(buffer, maxlength, format, ap_save);
1022 /* fputc() look-alike */
1023 static int alloc_addbyter(int output, FILE *data)
1025 struct asprintf *infop=(struct asprintf *)data;
1027 if(!infop->buffer) {
1028 infop->buffer=(char *)malloc(32);
1030 return -1; /* fail */
1034 else if(infop->len+1 >= infop->alloc) {
1037 newptr = (char *)realloc(infop->buffer, infop->alloc*2);
1042 infop->buffer = newptr;
1046 infop->buffer[ infop->len ] = (char)output;
1050 return output; /* fputc() returns like this on success */
1053 char *curl_maprintf(const char *format, ...)
1055 va_list ap_save; /* argument pointer */
1057 struct asprintf info;
1063 va_start(ap_save, format);
1064 retcode = dprintf_formatf(&info, alloc_addbyter, format, ap_save);
1072 info.buffer[info.len] = 0; /* we terminate this with a zero byte */
1079 char *curl_mvaprintf(const char *format, va_list ap_save)
1082 struct asprintf info;
1088 retcode = dprintf_formatf(&info, alloc_addbyter, format, ap_save);
1096 info.buffer[info.len] = 0; /* we terminate this with a zero byte */
1103 static int storebuffer(int output, FILE *data)
1105 char **buffer = (char **)data;
1106 **buffer = (char)output;
1108 return output; /* act like fputc() ! */
1111 int curl_msprintf(char *buffer, const char *format, ...)
1113 va_list ap_save; /* argument pointer */
1115 va_start(ap_save, format);
1116 retcode = dprintf_formatf(&buffer, storebuffer, format, ap_save);
1118 *buffer=0; /* we terminate this with a zero byte */
1122 #ifndef WIN32 /* not needed on win32 */
1123 extern int fputc(int, FILE *);
1126 int curl_mprintf(const char *format, ...)
1129 va_list ap_save; /* argument pointer */
1130 va_start(ap_save, format);
1131 retcode = dprintf_formatf(stdout, fputc, format, ap_save);
1136 int curl_mfprintf(FILE *whereto, const char *format, ...)
1139 va_list ap_save; /* argument pointer */
1140 va_start(ap_save, format);
1141 retcode = dprintf_formatf(whereto, fputc, format, ap_save);
1146 int curl_mvsprintf(char *buffer, const char *format, va_list ap_save)
1149 retcode = dprintf_formatf(&buffer, storebuffer, format, ap_save);
1150 *buffer=0; /* we terminate this with a zero byte */
1154 int curl_mvprintf(const char *format, va_list ap_save)
1156 return dprintf_formatf(stdout, fputc, format, ap_save);
1159 int curl_mvfprintf(FILE *whereto, const char *format, va_list ap_save)
1161 return dprintf_formatf(whereto, fputc, format, ap_save);
1164 #ifdef DPRINTF_DEBUG
1172 long long test = 0x1000000000LL;
1173 curl_mprintf("%lld %lld %lld\n", one, two, test);
1176 curl_mprintf("%3d %5d\n", 10, 1998);
1178 ptr=curl_maprintf("test this then baby %s%s%s%s%s%s %d %d %d loser baby get a hit in yer face now!", "", "pretty long string pretty long string pretty long string pretty long string pretty long string", "/", "/", "/", "pretty long string", 1998, 1999, 2001);
1182 memset(ptr, 55, strlen(ptr)+1);
1187 curl_mprintf(buffer, "%s %s %d", "daniel", "stenberg", 19988);
1190 curl_mfprintf(stderr, "%s %#08x\n", "dummy", 65);
1192 printf("%s %#08x\n", "dummy", 65);
1194 double tryout = 3.14156592;
1195 curl_mprintf(buffer, "%.2g %G %f %e %E", tryout, tryout, tryout, tryout, tryout);
1197 printf("%.2g %G %f %e %E\n", tryout, tryout, tryout, tryout, tryout);