2 ** The "printf" code that follows dates from the 1980's. It is in
3 ** the public domain. The original comments are included here for
4 ** completeness. They are very out-of-date but might be useful as
5 ** an historical reference. Most of the "enhancements" have been backed
6 ** out so that the functionality is now the same as standard printf().
8 **************************************************************************
10 ** The following modules is an enhanced replacement for the "printf" subroutines
11 ** found in the standard C library. The following enhancements are
14 ** + Additional functions. The standard set of "printf" functions
15 ** includes printf, fprintf, sprintf, vprintf, vfprintf, and
16 ** vsprintf. This module adds the following:
18 ** * snprintf -- Works like sprintf, but has an extra argument
19 ** which is the size of the buffer written to.
21 ** * mprintf -- Similar to sprintf. Writes output to memory
22 ** obtained from malloc.
24 ** * xprintf -- Calls a function to dispose of output.
26 ** * nprintf -- No output, but returns the number of characters
27 ** that would have been output by printf.
29 ** * A v- version (ex: vsnprintf) of every function is also
32 ** + A few extensions to the formatting notation are supported:
34 ** * The "=" flag (similar to "-") causes the output to be
35 ** be centered in the appropriately sized field.
37 ** * The %b field outputs an integer in binary notation.
39 ** * The %c field now accepts a precision. The character output
40 ** is repeated by the number of times the precision specifies.
42 ** * The %' field works like %c, but takes as its character the
43 ** next character of the format string, instead of the next
44 ** argument. For example, printf("%.78'-") prints 78 minus
45 ** signs, the same as printf("%.78c",'-').
47 ** + When compiled using GCC on a SPARC, this version of printf is
48 ** faster than the library printf for SUN OS 4.1.
50 ** + All functions are fully reentrant.
53 #include "sqliteInt.h"
56 ** Conversion types fall into various categories as defined by the
57 ** following enumeration.
59 #define etRADIX 1 /* Integer types. %d, %x, %o, and so forth */
60 #define etFLOAT 2 /* Floating point. %f */
61 #define etEXP 3 /* Exponentional notation. %e and %E */
62 #define etGENERIC 4 /* Floating or exponential, depending on exponent. %g */
63 #define etSIZE 5 /* Return number of characters processed so far. %n */
64 #define etSTRING 6 /* Strings. %s */
65 #define etDYNSTRING 7 /* Dynamically allocated strings. %z */
66 #define etPERCENT 8 /* Percent symbol. %% */
67 #define etCHARX 9 /* Characters. %c */
68 /* The rest are extensions, not normally found in printf() */
69 #define etSQLESCAPE 10 /* Strings with '\'' doubled. %q */
70 #define etSQLESCAPE2 11 /* Strings with '\'' doubled and enclosed in '',
71 NULL pointers replaced by SQL NULL. %Q */
72 #define etTOKEN 12 /* a pointer to a Token structure */
73 #define etSRCLIST 13 /* a pointer to a SrcList */
74 #define etPOINTER 14 /* The %p conversion */
75 #define etSQLESCAPE3 15 /* %w -> Strings with '\"' doubled */
76 #define etORDINAL 16 /* %r -> 1st, 2nd, 3rd, 4th, etc. English only */
78 #define etINVALID 0 /* Any unrecognized conversion type */
82 ** An "etByte" is an 8-bit unsigned value.
84 typedef unsigned char etByte;
87 ** Each builtin conversion character (ex: the 'd' in "%d") is described
88 ** by an instance of the following structure
90 typedef struct et_info { /* Information about each format field */
91 char fmttype; /* The format field code letter */
92 etByte base; /* The base for radix conversion */
93 etByte flags; /* One or more of FLAG_ constants below */
94 etByte type; /* Conversion paradigm */
95 etByte charset; /* Offset into aDigits[] of the digits string */
96 etByte prefix; /* Offset into aPrefix[] of the prefix string */
100 ** Allowed values for et_info.flags
102 #define FLAG_SIGNED 1 /* True if the value to convert is signed */
103 #define FLAG_INTERN 2 /* True if for internal use only */
104 #define FLAG_STRING 4 /* Allow infinity precision */
108 ** The following table is searched linearly, so it is good to put the
109 ** most frequently used conversion types first.
111 static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
112 static const char aPrefix[] = "-x0\000X0";
113 static const et_info fmtinfo[] = {
114 { 'd', 10, 1, etRADIX, 0, 0 },
115 { 's', 0, 4, etSTRING, 0, 0 },
116 { 'g', 0, 1, etGENERIC, 30, 0 },
117 { 'z', 0, 4, etDYNSTRING, 0, 0 },
118 { 'q', 0, 4, etSQLESCAPE, 0, 0 },
119 { 'Q', 0, 4, etSQLESCAPE2, 0, 0 },
120 { 'w', 0, 4, etSQLESCAPE3, 0, 0 },
121 { 'c', 0, 0, etCHARX, 0, 0 },
122 { 'o', 8, 0, etRADIX, 0, 2 },
123 { 'u', 10, 0, etRADIX, 0, 0 },
124 { 'x', 16, 0, etRADIX, 16, 1 },
125 { 'X', 16, 0, etRADIX, 0, 4 },
126 #ifndef SQLITE_OMIT_FLOATING_POINT
127 { 'f', 0, 1, etFLOAT, 0, 0 },
128 { 'e', 0, 1, etEXP, 30, 0 },
129 { 'E', 0, 1, etEXP, 14, 0 },
130 { 'G', 0, 1, etGENERIC, 14, 0 },
132 { 'i', 10, 1, etRADIX, 0, 0 },
133 { 'n', 0, 0, etSIZE, 0, 0 },
134 { '%', 0, 0, etPERCENT, 0, 0 },
135 { 'p', 16, 0, etPOINTER, 0, 1 },
137 /* All the rest have the FLAG_INTERN bit set and are thus for internal
139 { 'T', 0, 2, etTOKEN, 0, 0 },
140 { 'S', 0, 2, etSRCLIST, 0, 0 },
141 { 'r', 10, 3, etORDINAL, 0, 0 },
145 ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
146 ** conversions will work.
148 #ifndef SQLITE_OMIT_FLOATING_POINT
150 ** "*val" is a double such that 0.1 <= *val < 10.0
151 ** Return the ascii code for the leading digit of *val, then
152 ** multiply "*val" by 10.0 to renormalize.
155 ** input: *val = 3.14159
156 ** output: *val = 1.4159 function return = '3'
158 ** The counter *cnt is incremented each time. After counter exceeds
159 ** 16 (the number of significant digits in a 64-bit float) '0' is
162 static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
165 if( (*cnt)++ >= 16 ) return '0';
169 *val = (*val - d)*10.0;
172 #endif /* SQLITE_OMIT_FLOATING_POINT */
175 ** Append N space characters to the given string buffer.
177 static void appendSpace(StrAccum *pAccum, int N){
178 static const char zSpaces[] = " ";
179 while( N>=(int)sizeof(zSpaces)-1 ){
180 sqlite3StrAccumAppend(pAccum, zSpaces, sizeof(zSpaces)-1);
181 N -= sizeof(zSpaces)-1;
184 sqlite3StrAccumAppend(pAccum, zSpaces, N);
189 ** On machines with a small stack size, you can redefine the
190 ** SQLITE_PRINT_BUF_SIZE to be less than 350.
192 #ifndef SQLITE_PRINT_BUF_SIZE
193 # if defined(SQLITE_SMALL_STACK)
194 # define SQLITE_PRINT_BUF_SIZE 50
196 # define SQLITE_PRINT_BUF_SIZE 350
199 #define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */
202 ** The root program. All variations call this core.
205 ** func This is a pointer to a function taking three arguments
206 ** 1. A pointer to anything. Same as the "arg" parameter.
207 ** 2. A pointer to the list of characters to be output
208 ** (Note, this list is NOT null terminated.)
209 ** 3. An integer number of characters to be output.
210 ** (Note: This number might be zero.)
212 ** arg This is the pointer to anything which will be passed as the
213 ** first argument to "func". Use it for whatever you like.
215 ** fmt This is the format string, as in the usual print.
217 ** ap This is a pointer to a list of arguments. Same as in
221 ** The return value is the total number of characters sent to
222 ** the function "func". Returns -1 on a error.
224 ** Note that the order in which automatic variables are declared below
225 ** seems to make a big difference in determining how fast this beast
228 void sqlite3VXPrintf(
229 StrAccum *pAccum, /* Accumulate results here */
230 int useExtended, /* Allow extended %-conversions */
231 const char *fmt, /* Format string */
232 va_list ap /* arguments */
234 int c; /* Next character in the format string */
235 char *bufpt; /* Pointer to the conversion buffer */
236 int precision; /* Precision of the current field */
237 int length; /* Length of the field */
238 int idx; /* A general purpose loop counter */
239 int width; /* Width of the current field */
240 etByte flag_leftjustify; /* True if "-" flag is present */
241 etByte flag_plussign; /* True if "+" flag is present */
242 etByte flag_blanksign; /* True if " " flag is present */
243 etByte flag_alternateform; /* True if "#" flag is present */
244 etByte flag_altform2; /* True if "!" flag is present */
245 etByte flag_zeropad; /* True if field width constant starts with zero */
246 etByte flag_long; /* True if "l" flag is present */
247 etByte flag_longlong; /* True if the "ll" flag is present */
248 etByte done; /* Loop termination flag */
249 sqlite_uint64 longvalue; /* Value for integer types */
250 LONGDOUBLE_TYPE realvalue; /* Value for real types */
251 const et_info *infop; /* Pointer to the appropriate info structure */
252 char buf[etBUFSIZE]; /* Conversion buffer */
253 char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */
254 etByte xtype = 0; /* Conversion paradigm */
255 char *zExtra; /* Extra memory used for etTCLESCAPE conversions */
256 #ifndef SQLITE_OMIT_FLOATING_POINT
257 int exp, e2; /* exponent of real numbers */
258 double rounder; /* Used for rounding floating point values */
259 etByte flag_dp; /* True if decimal point should be shown */
260 etByte flag_rtz; /* True if trailing zeros should be removed */
261 etByte flag_exp; /* True to force display of the exponent */
262 int nsd; /* Number of significant digits returned */
267 for(; (c=(*fmt))!=0; ++fmt){
272 while( (c=(*++fmt))!='%' && c!=0 ) amt++;
273 sqlite3StrAccumAppend(pAccum, bufpt, amt);
276 if( (c=(*++fmt))==0 ){
277 sqlite3StrAccumAppend(pAccum, "%", 1);
280 /* Find out what flags are present */
281 flag_leftjustify = flag_plussign = flag_blanksign =
282 flag_alternateform = flag_altform2 = flag_zeropad = 0;
286 case '-': flag_leftjustify = 1; break;
287 case '+': flag_plussign = 1; break;
288 case ' ': flag_blanksign = 1; break;
289 case '#': flag_alternateform = 1; break;
290 case '!': flag_altform2 = 1; break;
291 case '0': flag_zeropad = 1; break;
292 default: done = 1; break;
294 }while( !done && (c=(*++fmt))!=0 );
295 /* Get the field width */
298 width = va_arg(ap,int);
300 flag_leftjustify = 1;
305 while( c>='0' && c<='9' ){
306 width = width*10 + c - '0';
310 if( width > etBUFSIZE-10 ){
311 width = etBUFSIZE-10;
313 /* Get the precision */
318 precision = va_arg(ap,int);
319 if( precision<0 ) precision = -precision;
322 while( c>='0' && c<='9' ){
323 precision = precision*10 + c - '0';
330 /* Get the conversion type modifier */
341 flag_long = flag_longlong = 0;
343 /* Fetch the info entry for the field */
346 for(idx=0; idx<ArraySize(fmtinfo); idx++){
347 if( c==fmtinfo[idx].fmttype ){
348 infop = &fmtinfo[idx];
349 if( useExtended || (infop->flags & FLAG_INTERN)==0 ){
360 /* Limit the precision to prevent overflowing buf[] during conversion */
361 if( precision>etBUFSIZE-40 && (infop->flags & FLAG_STRING)==0 ){
362 precision = etBUFSIZE-40;
366 ** At this point, variables are initialized as follows:
368 ** flag_alternateform TRUE if a '#' is present.
369 ** flag_altform2 TRUE if a '!' is present.
370 ** flag_plussign TRUE if a '+' is present.
371 ** flag_leftjustify TRUE if a '-' is present or if the
372 ** field width was negative.
373 ** flag_zeropad TRUE if the width began with 0.
374 ** flag_long TRUE if the letter 'l' (ell) prefixed
375 ** the conversion character.
376 ** flag_longlong TRUE if the letter 'll' (ell ell) prefixed
377 ** the conversion character.
378 ** flag_blanksign TRUE if a ' ' is present.
379 ** width The specified field width. This is
380 ** always non-negative. Zero is the default.
381 ** precision The specified precision. The default
383 ** xtype The class of the conversion.
384 ** infop Pointer to the appropriate info struct.
388 flag_longlong = sizeof(char*)==sizeof(i64);
389 flag_long = sizeof(char*)==sizeof(long int);
390 /* Fall through into the next case */
393 if( infop->flags & FLAG_SIGNED ){
397 }else if( flag_long ){
398 v = va_arg(ap,long int);
403 if( v==SMALLEST_INT64 ){
404 longvalue = ((u64)1)<<63;
411 if( flag_plussign ) prefix = '+';
412 else if( flag_blanksign ) prefix = ' ';
417 longvalue = va_arg(ap,u64);
418 }else if( flag_long ){
419 longvalue = va_arg(ap,unsigned long int);
421 longvalue = va_arg(ap,unsigned int);
425 if( longvalue==0 ) flag_alternateform = 0;
426 if( flag_zeropad && precision<width-(prefix!=0) ){
427 precision = width-(prefix!=0);
429 bufpt = &buf[etBUFSIZE-1];
430 if( xtype==etORDINAL ){
431 static const char zOrd[] = "thstndrd";
432 int x = (int)(longvalue % 10);
433 if( x>=4 || (longvalue/10)%10==1 ){
436 buf[etBUFSIZE-3] = zOrd[x*2];
437 buf[etBUFSIZE-2] = zOrd[x*2+1];
441 register const char *cset; /* Use registers for speed */
443 cset = &aDigits[infop->charset];
445 do{ /* Convert to ascii */
446 *(--bufpt) = cset[longvalue%base];
447 longvalue = longvalue/base;
448 }while( longvalue>0 );
450 length = (int)(&buf[etBUFSIZE-1]-bufpt);
451 for(idx=precision-length; idx>0; idx--){
452 *(--bufpt) = '0'; /* Zero pad */
454 if( prefix ) *(--bufpt) = prefix; /* Add sign */
455 if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */
458 pre = &aPrefix[infop->prefix];
459 for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
461 length = (int)(&buf[etBUFSIZE-1]-bufpt);
466 realvalue = va_arg(ap,double);
467 #ifdef SQLITE_OMIT_FLOATING_POINT
470 if( precision<0 ) precision = 6; /* Set default precision */
471 if( precision>etBUFSIZE/2-10 ) precision = etBUFSIZE/2-10;
473 realvalue = -realvalue;
476 if( flag_plussign ) prefix = '+';
477 else if( flag_blanksign ) prefix = ' ';
480 if( xtype==etGENERIC && precision>0 ) precision--;
482 /* Rounding works like BSD when the constant 0.4999 is used. Wierd! */
483 for(idx=precision, rounder=0.4999; idx>0; idx--, rounder*=0.1);
485 /* It makes more sense to use 0.5 */
486 for(idx=precision, rounder=0.5; idx>0; idx--, rounder*=0.1){}
488 if( xtype==etFLOAT ) realvalue += rounder;
489 /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
491 if( sqlite3IsNaN((double)realvalue) ){
497 while( realvalue>=1e32 && exp<=350 ){ realvalue *= 1e-32; exp+=32; }
498 while( realvalue>=1e8 && exp<=350 ){ realvalue *= 1e-8; exp+=8; }
499 while( realvalue>=10.0 && exp<=350 ){ realvalue *= 0.1; exp++; }
500 while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
501 while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
505 }else if( prefix=='+' ){
510 length = sqlite3Strlen30(bufpt);
516 ** If the field type is etGENERIC, then convert to either etEXP
517 ** or etFLOAT, as appropriate.
519 flag_exp = xtype==etEXP;
520 if( xtype!=etFLOAT ){
521 realvalue += rounder;
522 if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
524 if( xtype==etGENERIC ){
525 flag_rtz = !flag_alternateform;
526 if( exp<-4 || exp>precision ){
529 precision = precision - exp;
541 flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
542 /* The sign in front of the number */
546 /* Digits prior to the decimal point */
551 *(bufpt++) = et_getdigit(&realvalue,&nsd);
554 /* The decimal point */
558 /* "0" digits after the decimal point but before the first
559 ** significant digit of the number */
560 for(e2++; e2<0; precision--, e2++){
561 assert( precision>0 );
564 /* Significant digits after the decimal point */
565 while( (precision--)>0 ){
566 *(bufpt++) = et_getdigit(&realvalue,&nsd);
568 /* Remove trailing zeros and the "." if no digits follow the "." */
569 if( flag_rtz && flag_dp ){
570 while( bufpt[-1]=='0' ) *(--bufpt) = 0;
572 if( bufpt[-1]=='.' ){
580 /* Add the "eNNN" suffix */
581 if( flag_exp || xtype==etEXP ){
582 *(bufpt++) = aDigits[infop->charset];
584 *(bufpt++) = '-'; exp = -exp;
589 *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */
592 *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */
593 *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */
597 /* The converted number is in buf[] and zero terminated. Output it.
598 ** Note that the number is in the usual order, not reversed as with
599 ** integer conversions. */
600 length = (int)(bufpt-buf);
603 /* Special case: Add leading zeros if the flag_zeropad flag is
604 ** set and we are not left justified */
605 if( flag_zeropad && !flag_leftjustify && length < width){
607 int nPad = width - length;
608 for(i=width; i>=nPad; i--){
609 bufpt[i] = bufpt[i-nPad];
612 while( nPad-- ) bufpt[i++] = '0';
615 #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
618 *(va_arg(ap,int*)) = pAccum->nChar;
630 for(idx=1; idx<precision; idx++) buf[idx] = (char)c;
639 bufpt = va_arg(ap,char*);
642 }else if( xtype==etDYNSTRING ){
646 for(length=0; length<precision && bufpt[length]; length++){}
648 length = sqlite3Strlen30(bufpt);
654 int i, j, k, n, isnull;
657 char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */
658 char *escarg = va_arg(ap,char*);
660 if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
662 for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){
665 needQuote = !isnull && xtype==etSQLESCAPE2;
666 n += i + 1 + needQuote*2;
668 bufpt = zExtra = sqlite3Malloc( n );
670 pAccum->mallocFailed = 1;
677 if( needQuote ) bufpt[j++] = q;
680 bufpt[j++] = ch = escarg[i];
681 if( ch==q ) bufpt[j++] = ch;
683 if( needQuote ) bufpt[j++] = q;
686 /* The precision in %q and %Q means how many input characters to
687 ** consume, not the length of the output...
688 ** if( precision>=0 && precision<length ) length = precision; */
692 Token *pToken = va_arg(ap, Token*);
694 sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n);
700 SrcList *pSrc = va_arg(ap, SrcList*);
701 int k = va_arg(ap, int);
702 struct SrcList_item *pItem = &pSrc->a[k];
703 assert( k>=0 && k<pSrc->nSrc );
704 if( pItem->zDatabase ){
705 sqlite3StrAccumAppend(pAccum, pItem->zDatabase, -1);
706 sqlite3StrAccumAppend(pAccum, ".", 1);
708 sqlite3StrAccumAppend(pAccum, pItem->zName, -1);
713 assert( xtype==etINVALID );
716 }/* End switch over the format type */
718 ** The text of the conversion is pointed to by "bufpt" and is
719 ** "length" characters long. The field width is "width". Do
722 if( !flag_leftjustify ){
724 nspace = width-length;
726 appendSpace(pAccum, nspace);
730 sqlite3StrAccumAppend(pAccum, bufpt, length);
732 if( flag_leftjustify ){
734 nspace = width-length;
736 appendSpace(pAccum, nspace);
740 sqlite3_free(zExtra);
742 }/* End for loop over the format string */
743 } /* End of function */
746 ** Append N bytes of text from z to the StrAccum object.
748 void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){
749 assert( z!=0 || N==0 );
750 if( p->tooBig | p->mallocFailed ){
752 testcase(p->mallocFailed);
756 N = sqlite3Strlen30(z);
758 if( N==0 || NEVER(z==0) ){
761 if( p->nChar+N >= p->nAlloc ){
765 N = p->nAlloc - p->nChar - 1;
770 char *zOld = (p->zText==p->zBase ? 0 : p->zText);
771 i64 szNew = p->nChar;
773 if( szNew > p->mxAlloc ){
774 sqlite3StrAccumReset(p);
778 p->nAlloc = (int)szNew;
780 if( p->useMalloc==1 ){
781 zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc);
783 zNew = sqlite3_realloc(zOld, p->nAlloc);
786 if( zOld==0 ) memcpy(zNew, p->zText, p->nChar);
790 sqlite3StrAccumReset(p);
795 memcpy(&p->zText[p->nChar], z, N);
800 ** Finish off a string by making sure it is zero-terminated.
801 ** Return a pointer to the resulting string. Return a NULL
802 ** pointer if any kind of error was encountered.
804 char *sqlite3StrAccumFinish(StrAccum *p){
806 p->zText[p->nChar] = 0;
807 if( p->useMalloc && p->zText==p->zBase ){
808 if( p->useMalloc==1 ){
809 p->zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
811 p->zText = sqlite3_malloc(p->nChar+1);
814 memcpy(p->zText, p->zBase, p->nChar+1);
824 ** Reset an StrAccum string. Reclaim all malloced memory.
826 void sqlite3StrAccumReset(StrAccum *p){
827 if( p->zText!=p->zBase ){
828 if( p->useMalloc==1 ){
829 sqlite3DbFree(p->db, p->zText);
831 sqlite3_free(p->zText);
838 ** Initialize a string accumulator
840 void sqlite3StrAccumInit(StrAccum *p, char *zBase, int n, int mx){
841 p->zText = p->zBase = zBase;
852 ** Print into memory obtained from sqliteMalloc(). Use the internal
853 ** %-conversion extensions.
855 char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
857 char zBase[SQLITE_PRINT_BUF_SIZE];
860 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase),
861 db->aLimit[SQLITE_LIMIT_LENGTH]);
863 sqlite3VXPrintf(&acc, 1, zFormat, ap);
864 z = sqlite3StrAccumFinish(&acc);
865 if( acc.mallocFailed ){
866 db->mallocFailed = 1;
872 ** Print into memory obtained from sqliteMalloc(). Use the internal
873 ** %-conversion extensions.
875 char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
878 va_start(ap, zFormat);
879 z = sqlite3VMPrintf(db, zFormat, ap);
885 ** Like sqlite3MPrintf(), but call sqlite3DbFree() on zStr after formatting
886 ** the string and before returnning. This routine is intended to be used
887 ** to modify an existing string. For example:
889 ** x = sqlite3MPrintf(db, x, "prefix %s suffix", x);
892 char *sqlite3MAppendf(sqlite3 *db, char *zStr, const char *zFormat, ...){
895 va_start(ap, zFormat);
896 z = sqlite3VMPrintf(db, zFormat, ap);
898 sqlite3DbFree(db, zStr);
903 ** Print into memory obtained from sqlite3_malloc(). Omit the internal
904 ** %-conversion extensions.
906 char *sqlite3_vmprintf(const char *zFormat, va_list ap){
908 char zBase[SQLITE_PRINT_BUF_SIZE];
910 #ifndef SQLITE_OMIT_AUTOINIT
911 if( sqlite3_initialize() ) return 0;
913 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
915 sqlite3VXPrintf(&acc, 0, zFormat, ap);
916 z = sqlite3StrAccumFinish(&acc);
921 ** Print into memory obtained from sqlite3_malloc()(). Omit the internal
922 ** %-conversion extensions.
924 char *sqlite3_mprintf(const char *zFormat, ...){
927 #ifndef SQLITE_OMIT_AUTOINIT
928 if( sqlite3_initialize() ) return 0;
930 va_start(ap, zFormat);
931 z = sqlite3_vmprintf(zFormat, ap);
937 ** sqlite3_snprintf() works like snprintf() except that it ignores the
938 ** current locale settings. This is important for SQLite because we
939 ** are not able to use a "," as the decimal point in place of "." as
940 ** specified by some locales.
942 ** Oops: The first two arguments of sqlite3_snprintf() are backwards
943 ** from the snprintf() standard. Unfortunately, it is too late to change
944 ** this without breaking compatibility, so we just have to live with the
947 ** sqlite3_vsnprintf() is the varargs version.
949 char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){
951 if( n<=0 ) return zBuf;
952 sqlite3StrAccumInit(&acc, zBuf, n, 0);
954 sqlite3VXPrintf(&acc, 0, zFormat, ap);
955 return sqlite3StrAccumFinish(&acc);
957 char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
960 va_start(ap,zFormat);
961 z = sqlite3_vsnprintf(n, zBuf, zFormat, ap);
967 ** This is the routine that actually formats the sqlite3_log() message.
968 ** We house it in a separate routine from sqlite3_log() to avoid using
969 ** stack space on small-stack systems when logging is disabled.
971 ** sqlite3_log() must render into a static buffer. It cannot dynamically
972 ** allocate memory because it might be called while the memory allocator
975 static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){
976 StrAccum acc; /* String accumulator */
977 char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */
979 sqlite3StrAccumInit(&acc, zMsg, sizeof(zMsg), 0);
981 sqlite3VXPrintf(&acc, 0, zFormat, ap);
982 sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode,
983 sqlite3StrAccumFinish(&acc));
987 ** Format and write a message to the log if logging is enabled.
989 void sqlite3_log(int iErrCode, const char *zFormat, ...){
990 va_list ap; /* Vararg list */
991 if( sqlite3GlobalConfig.xLog ){
992 va_start(ap, zFormat);
993 renderLogMsg(iErrCode, zFormat, ap);
998 #if defined(SQLITE_DEBUG)
1000 ** A version of printf() that understands %lld. Used for debugging.
1001 ** The printf() built into some versions of windows does not understand %lld
1002 ** and segfaults if you give it a long long int.
1004 void sqlite3DebugPrintf(const char *zFormat, ...){
1008 sqlite3StrAccumInit(&acc, zBuf, sizeof(zBuf), 0);
1010 va_start(ap,zFormat);
1011 sqlite3VXPrintf(&acc, 0, zFormat, ap);
1013 sqlite3StrAccumFinish(&acc);
1014 fprintf(stdout,"%s", zBuf);
1019 #ifndef SQLITE_OMIT_TRACE
1021 ** variable-argument wrapper around sqlite3VXPrintf().
1023 void sqlite3XPrintf(StrAccum *p, const char *zFormat, ...){
1025 va_start(ap,zFormat);
1026 sqlite3VXPrintf(p, 1, zFormat, ap);