xref: /sqlite-3.40.0/src/printf.c (revision a3f06598)
1 /*
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().
7 **
8 ** $Id: printf.c,v 1.102 2009/04/08 16:10:04 drh Exp $
9 **
10 **************************************************************************
11 **
12 ** The following modules is an enhanced replacement for the "printf" subroutines
13 ** found in the standard C library.  The following enhancements are
14 ** supported:
15 **
16 **      +  Additional functions.  The standard set of "printf" functions
17 **         includes printf, fprintf, sprintf, vprintf, vfprintf, and
18 **         vsprintf.  This module adds the following:
19 **
20 **           *  snprintf -- Works like sprintf, but has an extra argument
21 **                          which is the size of the buffer written to.
22 **
23 **           *  mprintf --  Similar to sprintf.  Writes output to memory
24 **                          obtained from malloc.
25 **
26 **           *  xprintf --  Calls a function to dispose of output.
27 **
28 **           *  nprintf --  No output, but returns the number of characters
29 **                          that would have been output by printf.
30 **
31 **           *  A v- version (ex: vsnprintf) of every function is also
32 **              supplied.
33 **
34 **      +  A few extensions to the formatting notation are supported:
35 **
36 **           *  The "=" flag (similar to "-") causes the output to be
37 **              be centered in the appropriately sized field.
38 **
39 **           *  The %b field outputs an integer in binary notation.
40 **
41 **           *  The %c field now accepts a precision.  The character output
42 **              is repeated by the number of times the precision specifies.
43 **
44 **           *  The %' field works like %c, but takes as its character the
45 **              next character of the format string, instead of the next
46 **              argument.  For example,  printf("%.78'-")  prints 78 minus
47 **              signs, the same as  printf("%.78c",'-').
48 **
49 **      +  When compiled using GCC on a SPARC, this version of printf is
50 **         faster than the library printf for SUN OS 4.1.
51 **
52 **      +  All functions are fully reentrant.
53 **
54 */
55 #include "sqliteInt.h"
56 
57 /*
58 ** Conversion types fall into various categories as defined by the
59 ** following enumeration.
60 */
61 #define etRADIX       1 /* Integer types.  %d, %x, %o, and so forth */
62 #define etFLOAT       2 /* Floating point.  %f */
63 #define etEXP         3 /* Exponentional notation. %e and %E */
64 #define etGENERIC     4 /* Floating or exponential, depending on exponent. %g */
65 #define etSIZE        5 /* Return number of characters processed so far. %n */
66 #define etSTRING      6 /* Strings. %s */
67 #define etDYNSTRING   7 /* Dynamically allocated strings. %z */
68 #define etPERCENT     8 /* Percent symbol. %% */
69 #define etCHARX       9 /* Characters. %c */
70 /* The rest are extensions, not normally found in printf() */
71 #define etSQLESCAPE  10 /* Strings with '\'' doubled.  %q */
72 #define etSQLESCAPE2 11 /* Strings with '\'' doubled and enclosed in '',
73                           NULL pointers replaced by SQL NULL.  %Q */
74 #define etTOKEN      12 /* a pointer to a Token structure */
75 #define etSRCLIST    13 /* a pointer to a SrcList */
76 #define etPOINTER    14 /* The %p conversion */
77 #define etSQLESCAPE3 15 /* %w -> Strings with '\"' doubled */
78 #define etORDINAL    16 /* %r -> 1st, 2nd, 3rd, 4th, etc.  English only */
79 
80 #define etINVALID     0 /* Any unrecognized conversion type */
81 
82 
83 /*
84 ** An "etByte" is an 8-bit unsigned value.
85 */
86 typedef unsigned char etByte;
87 
88 /*
89 ** Each builtin conversion character (ex: the 'd' in "%d") is described
90 ** by an instance of the following structure
91 */
92 typedef struct et_info {   /* Information about each format field */
93   char fmttype;            /* The format field code letter */
94   etByte base;             /* The base for radix conversion */
95   etByte flags;            /* One or more of FLAG_ constants below */
96   etByte type;             /* Conversion paradigm */
97   etByte charset;          /* Offset into aDigits[] of the digits string */
98   etByte prefix;           /* Offset into aPrefix[] of the prefix string */
99 } et_info;
100 
101 /*
102 ** Allowed values for et_info.flags
103 */
104 #define FLAG_SIGNED  1     /* True if the value to convert is signed */
105 #define FLAG_INTERN  2     /* True if for internal use only */
106 #define FLAG_STRING  4     /* Allow infinity precision */
107 
108 
109 /*
110 ** The following table is searched linearly, so it is good to put the
111 ** most frequently used conversion types first.
112 */
113 static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
114 static const char aPrefix[] = "-x0\000X0";
115 static const et_info fmtinfo[] = {
116   {  'd', 10, 1, etRADIX,      0,  0 },
117   {  's',  0, 4, etSTRING,     0,  0 },
118   {  'g',  0, 1, etGENERIC,    30, 0 },
119   {  'z',  0, 4, etDYNSTRING,  0,  0 },
120   {  'q',  0, 4, etSQLESCAPE,  0,  0 },
121   {  'Q',  0, 4, etSQLESCAPE2, 0,  0 },
122   {  'w',  0, 4, etSQLESCAPE3, 0,  0 },
123   {  'c',  0, 0, etCHARX,      0,  0 },
124   {  'o',  8, 0, etRADIX,      0,  2 },
125   {  'u', 10, 0, etRADIX,      0,  0 },
126   {  'x', 16, 0, etRADIX,      16, 1 },
127   {  'X', 16, 0, etRADIX,      0,  4 },
128 #ifndef SQLITE_OMIT_FLOATING_POINT
129   {  'f',  0, 1, etFLOAT,      0,  0 },
130   {  'e',  0, 1, etEXP,        30, 0 },
131   {  'E',  0, 1, etEXP,        14, 0 },
132   {  'G',  0, 1, etGENERIC,    14, 0 },
133 #endif
134   {  'i', 10, 1, etRADIX,      0,  0 },
135   {  'n',  0, 0, etSIZE,       0,  0 },
136   {  '%',  0, 0, etPERCENT,    0,  0 },
137   {  'p', 16, 0, etPOINTER,    0,  1 },
138 
139 /* All the rest have the FLAG_INTERN bit set and are thus for internal
140 ** use only */
141   {  'T',  0, 2, etTOKEN,      0,  0 },
142   {  'S',  0, 2, etSRCLIST,    0,  0 },
143   {  'r', 10, 3, etORDINAL,    0,  0 },
144 };
145 
146 /*
147 ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
148 ** conversions will work.
149 */
150 #ifndef SQLITE_OMIT_FLOATING_POINT
151 /*
152 ** "*val" is a double such that 0.1 <= *val < 10.0
153 ** Return the ascii code for the leading digit of *val, then
154 ** multiply "*val" by 10.0 to renormalize.
155 **
156 ** Example:
157 **     input:     *val = 3.14159
158 **     output:    *val = 1.4159    function return = '3'
159 **
160 ** The counter *cnt is incremented each time.  After counter exceeds
161 ** 16 (the number of significant digits in a 64-bit float) '0' is
162 ** always returned.
163 */
164 static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
165   int digit;
166   LONGDOUBLE_TYPE d;
167   if( (*cnt)++ >= 16 ) return '0';
168   digit = (int)*val;
169   d = digit;
170   digit += '0';
171   *val = (*val - d)*10.0;
172   return (char)digit;
173 }
174 #endif /* SQLITE_OMIT_FLOATING_POINT */
175 
176 /*
177 ** Append N space characters to the given string buffer.
178 */
179 static void appendSpace(StrAccum *pAccum, int N){
180   static const char zSpaces[] = "                             ";
181   while( N>=(int)sizeof(zSpaces)-1 ){
182     sqlite3StrAccumAppend(pAccum, zSpaces, sizeof(zSpaces)-1);
183     N -= sizeof(zSpaces)-1;
184   }
185   if( N>0 ){
186     sqlite3StrAccumAppend(pAccum, zSpaces, N);
187   }
188 }
189 
190 /*
191 ** On machines with a small stack size, you can redefine the
192 ** SQLITE_PRINT_BUF_SIZE to be less than 350.  But beware - for
193 ** smaller values some %f conversions may go into an infinite loop.
194 */
195 #ifndef SQLITE_PRINT_BUF_SIZE
196 # define SQLITE_PRINT_BUF_SIZE 350
197 #endif
198 #define etBUFSIZE SQLITE_PRINT_BUF_SIZE  /* Size of the output buffer */
199 
200 /*
201 ** The root program.  All variations call this core.
202 **
203 ** INPUTS:
204 **   func   This is a pointer to a function taking three arguments
205 **            1. A pointer to anything.  Same as the "arg" parameter.
206 **            2. A pointer to the list of characters to be output
207 **               (Note, this list is NOT null terminated.)
208 **            3. An integer number of characters to be output.
209 **               (Note: This number might be zero.)
210 **
211 **   arg    This is the pointer to anything which will be passed as the
212 **          first argument to "func".  Use it for whatever you like.
213 **
214 **   fmt    This is the format string, as in the usual print.
215 **
216 **   ap     This is a pointer to a list of arguments.  Same as in
217 **          vfprint.
218 **
219 ** OUTPUTS:
220 **          The return value is the total number of characters sent to
221 **          the function "func".  Returns -1 on a error.
222 **
223 ** Note that the order in which automatic variables are declared below
224 ** seems to make a big difference in determining how fast this beast
225 ** will run.
226 */
227 void sqlite3VXPrintf(
228   StrAccum *pAccum,                  /* Accumulate results here */
229   int useExtended,                   /* Allow extended %-conversions */
230   const char *fmt,                   /* Format string */
231   va_list ap                         /* arguments */
232 ){
233   int c;                     /* Next character in the format string */
234   char *bufpt;               /* Pointer to the conversion buffer */
235   int precision;             /* Precision of the current field */
236   int length;                /* Length of the field */
237   int idx;                   /* A general purpose loop counter */
238   int width;                 /* Width of the current field */
239   etByte flag_leftjustify;   /* True if "-" flag is present */
240   etByte flag_plussign;      /* True if "+" flag is present */
241   etByte flag_blanksign;     /* True if " " flag is present */
242   etByte flag_alternateform; /* True if "#" flag is present */
243   etByte flag_altform2;      /* True if "!" flag is present */
244   etByte flag_zeropad;       /* True if field width constant starts with zero */
245   etByte flag_long;          /* True if "l" flag is present */
246   etByte flag_longlong;      /* True if the "ll" flag is present */
247   etByte done;               /* Loop termination flag */
248   sqlite_uint64 longvalue;   /* Value for integer types */
249   LONGDOUBLE_TYPE realvalue; /* Value for real types */
250   const et_info *infop;      /* Pointer to the appropriate info structure */
251   char buf[etBUFSIZE];       /* Conversion buffer */
252   char prefix;               /* Prefix character.  "+" or "-" or " " or '\0'. */
253   etByte xtype = 0;          /* Conversion paradigm */
254   char *zExtra;              /* Extra memory used for etTCLESCAPE conversions */
255 #ifndef SQLITE_OMIT_FLOATING_POINT
256   int  exp, e2;              /* exponent of real numbers */
257   double rounder;            /* Used for rounding floating point values */
258   etByte flag_dp;            /* True if decimal point should be shown */
259   etByte flag_rtz;           /* True if trailing zeros should be removed */
260   etByte flag_exp;           /* True to force display of the exponent */
261   int nsd;                   /* Number of significant digits returned */
262 #endif
263 
264   length = 0;
265   bufpt = 0;
266   for(; (c=(*fmt))!=0; ++fmt){
267     if( c!='%' ){
268       int amt;
269       bufpt = (char *)fmt;
270       amt = 1;
271       while( (c=(*++fmt))!='%' && c!=0 ) amt++;
272       sqlite3StrAccumAppend(pAccum, bufpt, amt);
273       if( c==0 ) break;
274     }
275     if( (c=(*++fmt))==0 ){
276       sqlite3StrAccumAppend(pAccum, "%", 1);
277       break;
278     }
279     /* Find out what flags are present */
280     flag_leftjustify = flag_plussign = flag_blanksign =
281      flag_alternateform = flag_altform2 = flag_zeropad = 0;
282     done = 0;
283     do{
284       switch( c ){
285         case '-':   flag_leftjustify = 1;     break;
286         case '+':   flag_plussign = 1;        break;
287         case ' ':   flag_blanksign = 1;       break;
288         case '#':   flag_alternateform = 1;   break;
289         case '!':   flag_altform2 = 1;        break;
290         case '0':   flag_zeropad = 1;         break;
291         default:    done = 1;                 break;
292       }
293     }while( !done && (c=(*++fmt))!=0 );
294     /* Get the field width */
295     width = 0;
296     if( c=='*' ){
297       width = va_arg(ap,int);
298       if( width<0 ){
299         flag_leftjustify = 1;
300         width = -width;
301       }
302       c = *++fmt;
303     }else{
304       while( c>='0' && c<='9' ){
305         width = width*10 + c - '0';
306         c = *++fmt;
307       }
308     }
309     if( width > etBUFSIZE-10 ){
310       width = etBUFSIZE-10;
311     }
312     /* Get the precision */
313     if( c=='.' ){
314       precision = 0;
315       c = *++fmt;
316       if( c=='*' ){
317         precision = va_arg(ap,int);
318         if( precision<0 ) precision = -precision;
319         c = *++fmt;
320       }else{
321         while( c>='0' && c<='9' ){
322           precision = precision*10 + c - '0';
323           c = *++fmt;
324         }
325       }
326     }else{
327       precision = -1;
328     }
329     /* Get the conversion type modifier */
330     if( c=='l' ){
331       flag_long = 1;
332       c = *++fmt;
333       if( c=='l' ){
334         flag_longlong = 1;
335         c = *++fmt;
336       }else{
337         flag_longlong = 0;
338       }
339     }else{
340       flag_long = flag_longlong = 0;
341     }
342     /* Fetch the info entry for the field */
343     infop = &fmtinfo[0];
344     xtype = etINVALID;
345     for(idx=0; idx<ArraySize(fmtinfo); idx++){
346       if( c==fmtinfo[idx].fmttype ){
347         infop = &fmtinfo[idx];
348         if( useExtended || (infop->flags & FLAG_INTERN)==0 ){
349           xtype = infop->type;
350         }else{
351           return;
352         }
353         break;
354       }
355     }
356     zExtra = 0;
357 
358 
359     /* Limit the precision to prevent overflowing buf[] during conversion */
360     if( precision>etBUFSIZE-40 && (infop->flags & FLAG_STRING)==0 ){
361       precision = etBUFSIZE-40;
362     }
363 
364     /*
365     ** At this point, variables are initialized as follows:
366     **
367     **   flag_alternateform          TRUE if a '#' is present.
368     **   flag_altform2               TRUE if a '!' is present.
369     **   flag_plussign               TRUE if a '+' is present.
370     **   flag_leftjustify            TRUE if a '-' is present or if the
371     **                               field width was negative.
372     **   flag_zeropad                TRUE if the width began with 0.
373     **   flag_long                   TRUE if the letter 'l' (ell) prefixed
374     **                               the conversion character.
375     **   flag_longlong               TRUE if the letter 'll' (ell ell) prefixed
376     **                               the conversion character.
377     **   flag_blanksign              TRUE if a ' ' is present.
378     **   width                       The specified field width.  This is
379     **                               always non-negative.  Zero is the default.
380     **   precision                   The specified precision.  The default
381     **                               is -1.
382     **   xtype                       The class of the conversion.
383     **   infop                       Pointer to the appropriate info struct.
384     */
385     switch( xtype ){
386       case etPOINTER:
387         flag_longlong = sizeof(char*)==sizeof(i64);
388         flag_long = sizeof(char*)==sizeof(long int);
389         /* Fall through into the next case */
390       case etORDINAL:
391       case etRADIX:
392         if( infop->flags & FLAG_SIGNED ){
393           i64 v;
394           if( flag_longlong )   v = va_arg(ap,i64);
395           else if( flag_long )  v = va_arg(ap,long int);
396           else                  v = va_arg(ap,int);
397           if( v<0 ){
398             longvalue = -v;
399             prefix = '-';
400           }else{
401             longvalue = v;
402             if( flag_plussign )        prefix = '+';
403             else if( flag_blanksign )  prefix = ' ';
404             else                       prefix = 0;
405           }
406         }else{
407           if( flag_longlong )   longvalue = va_arg(ap,u64);
408           else if( flag_long )  longvalue = va_arg(ap,unsigned long int);
409           else                  longvalue = va_arg(ap,unsigned int);
410           prefix = 0;
411         }
412         if( longvalue==0 ) flag_alternateform = 0;
413         if( flag_zeropad && precision<width-(prefix!=0) ){
414           precision = width-(prefix!=0);
415         }
416         bufpt = &buf[etBUFSIZE-1];
417         if( xtype==etORDINAL ){
418           static const char zOrd[] = "thstndrd";
419           int x = (int)(longvalue % 10);
420           if( x>=4 || (longvalue/10)%10==1 ){
421             x = 0;
422           }
423           buf[etBUFSIZE-3] = zOrd[x*2];
424           buf[etBUFSIZE-2] = zOrd[x*2+1];
425           bufpt -= 2;
426         }
427         {
428           register const char *cset;      /* Use registers for speed */
429           register int base;
430           cset = &aDigits[infop->charset];
431           base = infop->base;
432           do{                                           /* Convert to ascii */
433             *(--bufpt) = cset[longvalue%base];
434             longvalue = longvalue/base;
435           }while( longvalue>0 );
436         }
437         length = (int)(&buf[etBUFSIZE-1]-bufpt);
438         for(idx=precision-length; idx>0; idx--){
439           *(--bufpt) = '0';                             /* Zero pad */
440         }
441         if( prefix ) *(--bufpt) = prefix;               /* Add sign */
442         if( flag_alternateform && infop->prefix ){      /* Add "0" or "0x" */
443           const char *pre;
444           char x;
445           pre = &aPrefix[infop->prefix];
446           for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
447         }
448         length = (int)(&buf[etBUFSIZE-1]-bufpt);
449         break;
450       case etFLOAT:
451       case etEXP:
452       case etGENERIC:
453         realvalue = va_arg(ap,double);
454 #ifndef SQLITE_OMIT_FLOATING_POINT
455         if( precision<0 ) precision = 6;         /* Set default precision */
456         if( precision>etBUFSIZE/2-10 ) precision = etBUFSIZE/2-10;
457         if( realvalue<0.0 ){
458           realvalue = -realvalue;
459           prefix = '-';
460         }else{
461           if( flag_plussign )          prefix = '+';
462           else if( flag_blanksign )    prefix = ' ';
463           else                         prefix = 0;
464         }
465         if( xtype==etGENERIC && precision>0 ) precision--;
466 #if 0
467         /* Rounding works like BSD when the constant 0.4999 is used.  Wierd! */
468         for(idx=precision, rounder=0.4999; idx>0; idx--, rounder*=0.1);
469 #else
470         /* It makes more sense to use 0.5 */
471         for(idx=precision, rounder=0.5; idx>0; idx--, rounder*=0.1){}
472 #endif
473         if( xtype==etFLOAT ) realvalue += rounder;
474         /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
475         exp = 0;
476         if( sqlite3IsNaN((double)realvalue) ){
477           bufpt = "NaN";
478           length = 3;
479           break;
480         }
481         if( realvalue>0.0 ){
482           while( realvalue>=1e32 && exp<=350 ){ realvalue *= 1e-32; exp+=32; }
483           while( realvalue>=1e8 && exp<=350 ){ realvalue *= 1e-8; exp+=8; }
484           while( realvalue>=10.0 && exp<=350 ){ realvalue *= 0.1; exp++; }
485           while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
486           while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
487           if( exp>350 ){
488             if( prefix=='-' ){
489               bufpt = "-Inf";
490             }else if( prefix=='+' ){
491               bufpt = "+Inf";
492             }else{
493               bufpt = "Inf";
494             }
495             length = sqlite3Strlen30(bufpt);
496             break;
497           }
498         }
499         bufpt = buf;
500         /*
501         ** If the field type is etGENERIC, then convert to either etEXP
502         ** or etFLOAT, as appropriate.
503         */
504         flag_exp = xtype==etEXP;
505         if( xtype!=etFLOAT ){
506           realvalue += rounder;
507           if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
508         }
509         if( xtype==etGENERIC ){
510           flag_rtz = !flag_alternateform;
511           if( exp<-4 || exp>precision ){
512             xtype = etEXP;
513           }else{
514             precision = precision - exp;
515             xtype = etFLOAT;
516           }
517         }else{
518           flag_rtz = 0;
519         }
520         if( xtype==etEXP ){
521           e2 = 0;
522         }else{
523           e2 = exp;
524         }
525         nsd = 0;
526         flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
527         /* The sign in front of the number */
528         if( prefix ){
529           *(bufpt++) = prefix;
530         }
531         /* Digits prior to the decimal point */
532         if( e2<0 ){
533           *(bufpt++) = '0';
534         }else{
535           for(; e2>=0; e2--){
536             *(bufpt++) = et_getdigit(&realvalue,&nsd);
537           }
538         }
539         /* The decimal point */
540         if( flag_dp ){
541           *(bufpt++) = '.';
542         }
543         /* "0" digits after the decimal point but before the first
544         ** significant digit of the number */
545         for(e2++; e2<0; precision--, e2++){
546           assert( precision>0 );
547           *(bufpt++) = '0';
548         }
549         /* Significant digits after the decimal point */
550         while( (precision--)>0 ){
551           *(bufpt++) = et_getdigit(&realvalue,&nsd);
552         }
553         /* Remove trailing zeros and the "." if no digits follow the "." */
554         if( flag_rtz && flag_dp ){
555           while( bufpt[-1]=='0' ) *(--bufpt) = 0;
556           assert( bufpt>buf );
557           if( bufpt[-1]=='.' ){
558             if( flag_altform2 ){
559               *(bufpt++) = '0';
560             }else{
561               *(--bufpt) = 0;
562             }
563           }
564         }
565         /* Add the "eNNN" suffix */
566         if( flag_exp || xtype==etEXP ){
567           *(bufpt++) = aDigits[infop->charset];
568           if( exp<0 ){
569             *(bufpt++) = '-'; exp = -exp;
570           }else{
571             *(bufpt++) = '+';
572           }
573           if( exp>=100 ){
574             *(bufpt++) = (char)((exp/100)+'0');        /* 100's digit */
575             exp %= 100;
576           }
577           *(bufpt++) = (char)(exp/10+'0');             /* 10's digit */
578           *(bufpt++) = (char)(exp%10+'0');             /* 1's digit */
579         }
580         *bufpt = 0;
581 
582         /* The converted number is in buf[] and zero terminated. Output it.
583         ** Note that the number is in the usual order, not reversed as with
584         ** integer conversions. */
585         length = (int)(bufpt-buf);
586         bufpt = buf;
587 
588         /* Special case:  Add leading zeros if the flag_zeropad flag is
589         ** set and we are not left justified */
590         if( flag_zeropad && !flag_leftjustify && length < width){
591           int i;
592           int nPad = width - length;
593           for(i=width; i>=nPad; i--){
594             bufpt[i] = bufpt[i-nPad];
595           }
596           i = prefix!=0;
597           while( nPad-- ) bufpt[i++] = '0';
598           length = width;
599         }
600 #endif
601         break;
602       case etSIZE:
603         *(va_arg(ap,int*)) = pAccum->nChar;
604         length = width = 0;
605         break;
606       case etPERCENT:
607         buf[0] = '%';
608         bufpt = buf;
609         length = 1;
610         break;
611       case etCHARX:
612         c = va_arg(ap,int);
613         buf[0] = (char)c;
614         if( precision>=0 ){
615           for(idx=1; idx<precision; idx++) buf[idx] = (char)c;
616           length = precision;
617         }else{
618           length =1;
619         }
620         bufpt = buf;
621         break;
622       case etSTRING:
623       case etDYNSTRING:
624         bufpt = va_arg(ap,char*);
625         if( bufpt==0 ){
626           bufpt = "";
627         }else if( xtype==etDYNSTRING ){
628           zExtra = bufpt;
629         }
630         if( precision>=0 ){
631           for(length=0; length<precision && bufpt[length]; length++){}
632         }else{
633           length = sqlite3Strlen30(bufpt);
634         }
635         break;
636       case etSQLESCAPE:
637       case etSQLESCAPE2:
638       case etSQLESCAPE3: {
639         int i, j, n, isnull;
640         int needQuote;
641         char ch;
642         char q = ((xtype==etSQLESCAPE3)?'"':'\'');   /* Quote character */
643         char *escarg = va_arg(ap,char*);
644         isnull = escarg==0;
645         if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
646         for(i=n=0; (ch=escarg[i])!=0; i++){
647           if( ch==q )  n++;
648         }
649         needQuote = !isnull && xtype==etSQLESCAPE2;
650         n += i + 1 + needQuote*2;
651         if( n>etBUFSIZE ){
652           bufpt = zExtra = sqlite3Malloc( n );
653           if( bufpt==0 ){
654             pAccum->mallocFailed = 1;
655             return;
656           }
657         }else{
658           bufpt = buf;
659         }
660         j = 0;
661         if( needQuote ) bufpt[j++] = q;
662         for(i=0; (ch=escarg[i])!=0; i++){
663           bufpt[j++] = ch;
664           if( ch==q ) bufpt[j++] = ch;
665         }
666         if( needQuote ) bufpt[j++] = q;
667         bufpt[j] = 0;
668         length = j;
669         /* The precision is ignored on %q and %Q */
670         /* if( precision>=0 && precision<length ) length = precision; */
671         break;
672       }
673       case etTOKEN: {
674         Token *pToken = va_arg(ap, Token*);
675         if( pToken ){
676           sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n);
677         }
678         length = width = 0;
679         break;
680       }
681       case etSRCLIST: {
682         SrcList *pSrc = va_arg(ap, SrcList*);
683         int k = va_arg(ap, int);
684         struct SrcList_item *pItem = &pSrc->a[k];
685         assert( k>=0 && k<pSrc->nSrc );
686         if( pItem->zDatabase ){
687           sqlite3StrAccumAppend(pAccum, pItem->zDatabase, -1);
688           sqlite3StrAccumAppend(pAccum, ".", 1);
689         }
690         sqlite3StrAccumAppend(pAccum, pItem->zName, -1);
691         length = width = 0;
692         break;
693       }
694       default: {
695         assert( xtype==etINVALID );
696         return;
697       }
698     }/* End switch over the format type */
699     /*
700     ** The text of the conversion is pointed to by "bufpt" and is
701     ** "length" characters long.  The field width is "width".  Do
702     ** the output.
703     */
704     if( !flag_leftjustify ){
705       register int nspace;
706       nspace = width-length;
707       if( nspace>0 ){
708         appendSpace(pAccum, nspace);
709       }
710     }
711     if( length>0 ){
712       sqlite3StrAccumAppend(pAccum, bufpt, length);
713     }
714     if( flag_leftjustify ){
715       register int nspace;
716       nspace = width-length;
717       if( nspace>0 ){
718         appendSpace(pAccum, nspace);
719       }
720     }
721     if( zExtra ){
722       sqlite3_free(zExtra);
723     }
724   }/* End for loop over the format string */
725 } /* End of function */
726 
727 /*
728 ** Append N bytes of text from z to the StrAccum object.
729 */
730 void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){
731   assert( z!=0 || N==0 );
732   if( p->tooBig | p->mallocFailed ){
733     testcase(p->tooBig);
734     testcase(p->mallocFailed);
735     return;
736   }
737   if( N<0 ){
738     N = sqlite3Strlen30(z);
739   }
740   if( N==0 || NEVER(z==0) ){
741     return;
742   }
743   if( p->nChar+N >= p->nAlloc ){
744     char *zNew;
745     if( !p->useMalloc ){
746       p->tooBig = 1;
747       N = p->nAlloc - p->nChar - 1;
748       if( N<=0 ){
749         return;
750       }
751     }else{
752       i64 szNew = p->nChar;
753       szNew += N + 1;
754       if( szNew > p->mxAlloc ){
755         sqlite3StrAccumReset(p);
756         p->tooBig = 1;
757         return;
758       }else{
759         p->nAlloc = (int)szNew;
760       }
761       zNew = sqlite3DbMallocRaw(p->db, p->nAlloc );
762       if( zNew ){
763         memcpy(zNew, p->zText, p->nChar);
764         sqlite3StrAccumReset(p);
765         p->zText = zNew;
766       }else{
767         p->mallocFailed = 1;
768         sqlite3StrAccumReset(p);
769         return;
770       }
771     }
772   }
773   memcpy(&p->zText[p->nChar], z, N);
774   p->nChar += N;
775 }
776 
777 /*
778 ** Finish off a string by making sure it is zero-terminated.
779 ** Return a pointer to the resulting string.  Return a NULL
780 ** pointer if any kind of error was encountered.
781 */
782 char *sqlite3StrAccumFinish(StrAccum *p){
783   if( p->zText ){
784     p->zText[p->nChar] = 0;
785     if( p->useMalloc && p->zText==p->zBase ){
786       p->zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
787       if( p->zText ){
788         memcpy(p->zText, p->zBase, p->nChar+1);
789       }else{
790         p->mallocFailed = 1;
791       }
792     }
793   }
794   return p->zText;
795 }
796 
797 /*
798 ** Reset an StrAccum string.  Reclaim all malloced memory.
799 */
800 void sqlite3StrAccumReset(StrAccum *p){
801   if( p->zText!=p->zBase ){
802     sqlite3DbFree(p->db, p->zText);
803   }
804   p->zText = 0;
805 }
806 
807 /*
808 ** Initialize a string accumulator
809 */
810 void sqlite3StrAccumInit(StrAccum *p, char *zBase, int n, int mx){
811   p->zText = p->zBase = zBase;
812   p->db = 0;
813   p->nChar = 0;
814   p->nAlloc = n;
815   p->mxAlloc = mx;
816   p->useMalloc = 1;
817   p->tooBig = 0;
818   p->mallocFailed = 0;
819 }
820 
821 /*
822 ** Print into memory obtained from sqliteMalloc().  Use the internal
823 ** %-conversion extensions.
824 */
825 char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
826   char *z;
827   char zBase[SQLITE_PRINT_BUF_SIZE];
828   StrAccum acc;
829   assert( db!=0 );
830   sqlite3StrAccumInit(&acc, zBase, sizeof(zBase),
831                       db->aLimit[SQLITE_LIMIT_LENGTH]);
832   acc.db = db;
833   sqlite3VXPrintf(&acc, 1, zFormat, ap);
834   z = sqlite3StrAccumFinish(&acc);
835   if( acc.mallocFailed ){
836     db->mallocFailed = 1;
837   }
838   return z;
839 }
840 
841 /*
842 ** Print into memory obtained from sqliteMalloc().  Use the internal
843 ** %-conversion extensions.
844 */
845 char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
846   va_list ap;
847   char *z;
848   va_start(ap, zFormat);
849   z = sqlite3VMPrintf(db, zFormat, ap);
850   va_end(ap);
851   return z;
852 }
853 
854 /*
855 ** Like sqlite3MPrintf(), but call sqlite3DbFree() on zStr after formatting
856 ** the string and before returnning.  This routine is intended to be used
857 ** to modify an existing string.  For example:
858 **
859 **       x = sqlite3MPrintf(db, x, "prefix %s suffix", x);
860 **
861 */
862 char *sqlite3MAppendf(sqlite3 *db, char *zStr, const char *zFormat, ...){
863   va_list ap;
864   char *z;
865   va_start(ap, zFormat);
866   z = sqlite3VMPrintf(db, zFormat, ap);
867   va_end(ap);
868   sqlite3DbFree(db, zStr);
869   return z;
870 }
871 
872 /*
873 ** Print into memory obtained from sqlite3_malloc().  Omit the internal
874 ** %-conversion extensions.
875 */
876 char *sqlite3_vmprintf(const char *zFormat, va_list ap){
877   char *z;
878   char zBase[SQLITE_PRINT_BUF_SIZE];
879   StrAccum acc;
880 #ifndef SQLITE_OMIT_AUTOINIT
881   if( sqlite3_initialize() ) return 0;
882 #endif
883   sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
884   sqlite3VXPrintf(&acc, 0, zFormat, ap);
885   z = sqlite3StrAccumFinish(&acc);
886   return z;
887 }
888 
889 /*
890 ** Print into memory obtained from sqlite3_malloc()().  Omit the internal
891 ** %-conversion extensions.
892 */
893 char *sqlite3_mprintf(const char *zFormat, ...){
894   va_list ap;
895   char *z;
896 #ifndef SQLITE_OMIT_AUTOINIT
897   if( sqlite3_initialize() ) return 0;
898 #endif
899   va_start(ap, zFormat);
900   z = sqlite3_vmprintf(zFormat, ap);
901   va_end(ap);
902   return z;
903 }
904 
905 /*
906 ** sqlite3_snprintf() works like snprintf() except that it ignores the
907 ** current locale settings.  This is important for SQLite because we
908 ** are not able to use a "," as the decimal point in place of "." as
909 ** specified by some locales.
910 */
911 char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
912   char *z;
913   va_list ap;
914   StrAccum acc;
915 
916   if( n<=0 ){
917     return zBuf;
918   }
919   sqlite3StrAccumInit(&acc, zBuf, n, 0);
920   acc.useMalloc = 0;
921   va_start(ap,zFormat);
922   sqlite3VXPrintf(&acc, 0, zFormat, ap);
923   va_end(ap);
924   z = sqlite3StrAccumFinish(&acc);
925   return z;
926 }
927 
928 #if defined(SQLITE_DEBUG)
929 /*
930 ** A version of printf() that understands %lld.  Used for debugging.
931 ** The printf() built into some versions of windows does not understand %lld
932 ** and segfaults if you give it a long long int.
933 */
934 void sqlite3DebugPrintf(const char *zFormat, ...){
935   va_list ap;
936   StrAccum acc;
937   char zBuf[500];
938   sqlite3StrAccumInit(&acc, zBuf, sizeof(zBuf), 0);
939   acc.useMalloc = 0;
940   va_start(ap,zFormat);
941   sqlite3VXPrintf(&acc, 0, zFormat, ap);
942   va_end(ap);
943   sqlite3StrAccumFinish(&acc);
944   fprintf(stdout,"%s", zBuf);
945   fflush(stdout);
946 }
947 #endif
948