Avoid leaving view-definitions with an incomplete set of column names/types in
[sqlite.git] / src / printf.c
blob71296ac907f9219f1cb6e81c7662c88d8813df1b
1 /*
2 ** The "printf" code that follows dates from the 1980's. It is in
3 ** the public domain.
4 **
5 **************************************************************************
6 **
7 ** This file contains code for a set of "printf"-like routines. These
8 ** routines format strings much like the printf() from the standard C
9 ** library, though the implementation here has enhancements to support
10 ** SQLite.
12 #include "sqliteInt.h"
15 ** Conversion types fall into various categories as defined by the
16 ** following enumeration.
18 #define etRADIX 0 /* non-decimal integer types. %x %o */
19 #define etFLOAT 1 /* Floating point. %f */
20 #define etEXP 2 /* Exponentional notation. %e and %E */
21 #define etGENERIC 3 /* Floating or exponential, depending on exponent. %g */
22 #define etSIZE 4 /* Return number of characters processed so far. %n */
23 #define etSTRING 5 /* Strings. %s */
24 #define etDYNSTRING 6 /* Dynamically allocated strings. %z */
25 #define etPERCENT 7 /* Percent symbol. %% */
26 #define etCHARX 8 /* Characters. %c */
27 /* The rest are extensions, not normally found in printf() */
28 #define etSQLESCAPE 9 /* Strings with '\'' doubled. %q */
29 #define etSQLESCAPE2 10 /* Strings with '\'' doubled and enclosed in '',
30 NULL pointers replaced by SQL NULL. %Q */
31 #define etTOKEN 11 /* a pointer to a Token structure */
32 #define etSRCLIST 12 /* a pointer to a SrcList */
33 #define etPOINTER 13 /* The %p conversion */
34 #define etSQLESCAPE3 14 /* %w -> Strings with '\"' doubled */
35 #define etORDINAL 15 /* %r -> 1st, 2nd, 3rd, 4th, etc. English only */
36 #define etDECIMAL 16 /* %d or %u, but not %x, %o */
38 #define etINVALID 17 /* Any unrecognized conversion type */
42 ** An "etByte" is an 8-bit unsigned value.
44 typedef unsigned char etByte;
47 ** Each builtin conversion character (ex: the 'd' in "%d") is described
48 ** by an instance of the following structure
50 typedef struct et_info { /* Information about each format field */
51 char fmttype; /* The format field code letter */
52 etByte base; /* The base for radix conversion */
53 etByte flags; /* One or more of FLAG_ constants below */
54 etByte type; /* Conversion paradigm */
55 etByte charset; /* Offset into aDigits[] of the digits string */
56 etByte prefix; /* Offset into aPrefix[] of the prefix string */
57 } et_info;
60 ** Allowed values for et_info.flags
62 #define FLAG_SIGNED 1 /* True if the value to convert is signed */
63 #define FLAG_STRING 4 /* Allow infinite precision */
67 ** The following table is searched linearly, so it is good to put the
68 ** most frequently used conversion types first.
70 static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
71 static const char aPrefix[] = "-x0\000X0";
72 static const et_info fmtinfo[] = {
73 { 'd', 10, 1, etDECIMAL, 0, 0 },
74 { 's', 0, 4, etSTRING, 0, 0 },
75 { 'g', 0, 1, etGENERIC, 30, 0 },
76 { 'z', 0, 4, etDYNSTRING, 0, 0 },
77 { 'q', 0, 4, etSQLESCAPE, 0, 0 },
78 { 'Q', 0, 4, etSQLESCAPE2, 0, 0 },
79 { 'w', 0, 4, etSQLESCAPE3, 0, 0 },
80 { 'c', 0, 0, etCHARX, 0, 0 },
81 { 'o', 8, 0, etRADIX, 0, 2 },
82 { 'u', 10, 0, etDECIMAL, 0, 0 },
83 { 'x', 16, 0, etRADIX, 16, 1 },
84 { 'X', 16, 0, etRADIX, 0, 4 },
85 #ifndef SQLITE_OMIT_FLOATING_POINT
86 { 'f', 0, 1, etFLOAT, 0, 0 },
87 { 'e', 0, 1, etEXP, 30, 0 },
88 { 'E', 0, 1, etEXP, 14, 0 },
89 { 'G', 0, 1, etGENERIC, 14, 0 },
90 #endif
91 { 'i', 10, 1, etDECIMAL, 0, 0 },
92 { 'n', 0, 0, etSIZE, 0, 0 },
93 { '%', 0, 0, etPERCENT, 0, 0 },
94 { 'p', 16, 0, etPOINTER, 0, 1 },
96 /* All the rest are undocumented and are for internal use only */
97 { 'T', 0, 0, etTOKEN, 0, 0 },
98 { 'S', 0, 0, etSRCLIST, 0, 0 },
99 { 'r', 10, 1, etORDINAL, 0, 0 },
103 ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
104 ** conversions will work.
106 #ifndef SQLITE_OMIT_FLOATING_POINT
108 ** "*val" is a double such that 0.1 <= *val < 10.0
109 ** Return the ascii code for the leading digit of *val, then
110 ** multiply "*val" by 10.0 to renormalize.
112 ** Example:
113 ** input: *val = 3.14159
114 ** output: *val = 1.4159 function return = '3'
116 ** The counter *cnt is incremented each time. After counter exceeds
117 ** 16 (the number of significant digits in a 64-bit float) '0' is
118 ** always returned.
120 static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
121 int digit;
122 LONGDOUBLE_TYPE d;
123 if( (*cnt)<=0 ) return '0';
124 (*cnt)--;
125 digit = (int)*val;
126 d = digit;
127 digit += '0';
128 *val = (*val - d)*10.0;
129 return (char)digit;
131 #endif /* SQLITE_OMIT_FLOATING_POINT */
134 ** Set the StrAccum object to an error mode.
136 static void setStrAccumError(StrAccum *p, u8 eError){
137 assert( eError==SQLITE_NOMEM || eError==SQLITE_TOOBIG );
138 p->accError = eError;
139 p->nAlloc = 0;
143 ** Extra argument values from a PrintfArguments object
145 static sqlite3_int64 getIntArg(PrintfArguments *p){
146 if( p->nArg<=p->nUsed ) return 0;
147 return sqlite3_value_int64(p->apArg[p->nUsed++]);
149 static double getDoubleArg(PrintfArguments *p){
150 if( p->nArg<=p->nUsed ) return 0.0;
151 return sqlite3_value_double(p->apArg[p->nUsed++]);
153 static char *getTextArg(PrintfArguments *p){
154 if( p->nArg<=p->nUsed ) return 0;
155 return (char*)sqlite3_value_text(p->apArg[p->nUsed++]);
160 ** On machines with a small stack size, you can redefine the
161 ** SQLITE_PRINT_BUF_SIZE to be something smaller, if desired.
163 #ifndef SQLITE_PRINT_BUF_SIZE
164 # define SQLITE_PRINT_BUF_SIZE 70
165 #endif
166 #define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */
169 ** Render a string given by "fmt" into the StrAccum object.
171 void sqlite3_str_vappendf(
172 sqlite3_str *pAccum, /* Accumulate results here */
173 const char *fmt, /* Format string */
174 va_list ap /* arguments */
176 int c; /* Next character in the format string */
177 char *bufpt; /* Pointer to the conversion buffer */
178 int precision; /* Precision of the current field */
179 int length; /* Length of the field */
180 int idx; /* A general purpose loop counter */
181 int width; /* Width of the current field */
182 etByte flag_leftjustify; /* True if "-" flag is present */
183 etByte flag_prefix; /* '+' or ' ' or 0 for prefix */
184 etByte flag_alternateform; /* True if "#" flag is present */
185 etByte flag_altform2; /* True if "!" flag is present */
186 etByte flag_zeropad; /* True if field width constant starts with zero */
187 etByte flag_long; /* 1 for the "l" flag, 2 for "ll", 0 by default */
188 etByte done; /* Loop termination flag */
189 etByte cThousand; /* Thousands separator for %d and %u */
190 etByte xtype = etINVALID; /* Conversion paradigm */
191 u8 bArgList; /* True for SQLITE_PRINTF_SQLFUNC */
192 char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */
193 sqlite_uint64 longvalue; /* Value for integer types */
194 LONGDOUBLE_TYPE realvalue; /* Value for real types */
195 const et_info *infop; /* Pointer to the appropriate info structure */
196 char *zOut; /* Rendering buffer */
197 int nOut; /* Size of the rendering buffer */
198 char *zExtra = 0; /* Malloced memory used by some conversion */
199 #ifndef SQLITE_OMIT_FLOATING_POINT
200 int exp, e2; /* exponent of real numbers */
201 int nsd; /* Number of significant digits returned */
202 double rounder; /* Used for rounding floating point values */
203 etByte flag_dp; /* True if decimal point should be shown */
204 etByte flag_rtz; /* True if trailing zeros should be removed */
205 #endif
206 PrintfArguments *pArgList = 0; /* Arguments for SQLITE_PRINTF_SQLFUNC */
207 char buf[etBUFSIZE]; /* Conversion buffer */
209 /* pAccum never starts out with an empty buffer that was obtained from
210 ** malloc(). This precondition is required by the mprintf("%z...")
211 ** optimization. */
212 assert( pAccum->nChar>0 || (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
214 bufpt = 0;
215 if( (pAccum->printfFlags & SQLITE_PRINTF_SQLFUNC)!=0 ){
216 pArgList = va_arg(ap, PrintfArguments*);
217 bArgList = 1;
218 }else{
219 bArgList = 0;
221 for(; (c=(*fmt))!=0; ++fmt){
222 if( c!='%' ){
223 bufpt = (char *)fmt;
224 #if HAVE_STRCHRNUL
225 fmt = strchrnul(fmt, '%');
226 #else
227 do{ fmt++; }while( *fmt && *fmt != '%' );
228 #endif
229 sqlite3_str_append(pAccum, bufpt, (int)(fmt - bufpt));
230 if( *fmt==0 ) break;
232 if( (c=(*++fmt))==0 ){
233 sqlite3_str_append(pAccum, "%", 1);
234 break;
236 /* Find out what flags are present */
237 flag_leftjustify = flag_prefix = cThousand =
238 flag_alternateform = flag_altform2 = flag_zeropad = 0;
239 done = 0;
241 switch( c ){
242 case '-': flag_leftjustify = 1; break;
243 case '+': flag_prefix = '+'; break;
244 case ' ': flag_prefix = ' '; break;
245 case '#': flag_alternateform = 1; break;
246 case '!': flag_altform2 = 1; break;
247 case '0': flag_zeropad = 1; break;
248 case ',': cThousand = ','; break;
249 default: done = 1; break;
251 }while( !done && (c=(*++fmt))!=0 );
252 /* Get the field width */
253 if( c=='*' ){
254 if( bArgList ){
255 width = (int)getIntArg(pArgList);
256 }else{
257 width = va_arg(ap,int);
259 if( width<0 ){
260 flag_leftjustify = 1;
261 width = width >= -2147483647 ? -width : 0;
263 c = *++fmt;
264 }else{
265 unsigned wx = 0;
266 while( c>='0' && c<='9' ){
267 wx = wx*10 + c - '0';
268 c = *++fmt;
270 testcase( wx>0x7fffffff );
271 width = wx & 0x7fffffff;
273 assert( width>=0 );
274 #ifdef SQLITE_PRINTF_PRECISION_LIMIT
275 if( width>SQLITE_PRINTF_PRECISION_LIMIT ){
276 width = SQLITE_PRINTF_PRECISION_LIMIT;
278 #endif
280 /* Get the precision */
281 if( c=='.' ){
282 c = *++fmt;
283 if( c=='*' ){
284 if( bArgList ){
285 precision = (int)getIntArg(pArgList);
286 }else{
287 precision = va_arg(ap,int);
289 c = *++fmt;
290 if( precision<0 ){
291 precision = precision >= -2147483647 ? -precision : -1;
293 }else{
294 unsigned px = 0;
295 while( c>='0' && c<='9' ){
296 px = px*10 + c - '0';
297 c = *++fmt;
299 testcase( px>0x7fffffff );
300 precision = px & 0x7fffffff;
302 }else{
303 precision = -1;
305 assert( precision>=(-1) );
306 #ifdef SQLITE_PRINTF_PRECISION_LIMIT
307 if( precision>SQLITE_PRINTF_PRECISION_LIMIT ){
308 precision = SQLITE_PRINTF_PRECISION_LIMIT;
310 #endif
313 /* Get the conversion type modifier */
314 if( c=='l' ){
315 flag_long = 1;
316 c = *++fmt;
317 if( c=='l' ){
318 flag_long = 2;
319 c = *++fmt;
321 }else{
322 flag_long = 0;
324 /* Fetch the info entry for the field */
325 infop = &fmtinfo[0];
326 xtype = etINVALID;
327 for(idx=0; idx<ArraySize(fmtinfo); idx++){
328 if( c==fmtinfo[idx].fmttype ){
329 infop = &fmtinfo[idx];
330 xtype = infop->type;
331 break;
336 ** At this point, variables are initialized as follows:
338 ** flag_alternateform TRUE if a '#' is present.
339 ** flag_altform2 TRUE if a '!' is present.
340 ** flag_prefix '+' or ' ' or zero
341 ** flag_leftjustify TRUE if a '-' is present or if the
342 ** field width was negative.
343 ** flag_zeropad TRUE if the width began with 0.
344 ** flag_long 1 for "l", 2 for "ll"
345 ** width The specified field width. This is
346 ** always non-negative. Zero is the default.
347 ** precision The specified precision. The default
348 ** is -1.
349 ** xtype The class of the conversion.
350 ** infop Pointer to the appropriate info struct.
352 switch( xtype ){
353 case etPOINTER:
354 flag_long = sizeof(char*)==sizeof(i64) ? 2 :
355 sizeof(char*)==sizeof(long int) ? 1 : 0;
356 /* Fall through into the next case */
357 case etORDINAL:
358 case etRADIX:
359 cThousand = 0;
360 /* Fall through into the next case */
361 case etDECIMAL:
362 if( infop->flags & FLAG_SIGNED ){
363 i64 v;
364 if( bArgList ){
365 v = getIntArg(pArgList);
366 }else if( flag_long ){
367 if( flag_long==2 ){
368 v = va_arg(ap,i64) ;
369 }else{
370 v = va_arg(ap,long int);
372 }else{
373 v = va_arg(ap,int);
375 if( v<0 ){
376 if( v==SMALLEST_INT64 ){
377 longvalue = ((u64)1)<<63;
378 }else{
379 longvalue = -v;
381 prefix = '-';
382 }else{
383 longvalue = v;
384 prefix = flag_prefix;
386 }else{
387 if( bArgList ){
388 longvalue = (u64)getIntArg(pArgList);
389 }else if( flag_long ){
390 if( flag_long==2 ){
391 longvalue = va_arg(ap,u64);
392 }else{
393 longvalue = va_arg(ap,unsigned long int);
395 }else{
396 longvalue = va_arg(ap,unsigned int);
398 prefix = 0;
400 if( longvalue==0 ) flag_alternateform = 0;
401 if( flag_zeropad && precision<width-(prefix!=0) ){
402 precision = width-(prefix!=0);
404 if( precision<etBUFSIZE-10-etBUFSIZE/3 ){
405 nOut = etBUFSIZE;
406 zOut = buf;
407 }else{
408 u64 n = (u64)precision + 10 + precision/3;
409 zOut = zExtra = sqlite3Malloc( n );
410 if( zOut==0 ){
411 setStrAccumError(pAccum, SQLITE_NOMEM);
412 return;
414 nOut = (int)n;
416 bufpt = &zOut[nOut-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;
423 *(--bufpt) = zOrd[x*2+1];
424 *(--bufpt) = zOrd[x*2];
427 const char *cset = &aDigits[infop->charset];
428 u8 base = infop->base;
429 do{ /* Convert to ascii */
430 *(--bufpt) = cset[longvalue%base];
431 longvalue = longvalue/base;
432 }while( longvalue>0 );
434 length = (int)(&zOut[nOut-1]-bufpt);
435 while( precision>length ){
436 *(--bufpt) = '0'; /* Zero pad */
437 length++;
439 if( cThousand ){
440 int nn = (length - 1)/3; /* Number of "," to insert */
441 int ix = (length - 1)%3 + 1;
442 bufpt -= nn;
443 for(idx=0; nn>0; idx++){
444 bufpt[idx] = bufpt[idx+nn];
445 ix--;
446 if( ix==0 ){
447 bufpt[++idx] = cThousand;
448 nn--;
449 ix = 3;
453 if( prefix ) *(--bufpt) = prefix; /* Add sign */
454 if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */
455 const char *pre;
456 char x;
457 pre = &aPrefix[infop->prefix];
458 for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
460 length = (int)(&zOut[nOut-1]-bufpt);
461 break;
462 case etFLOAT:
463 case etEXP:
464 case etGENERIC:
465 if( bArgList ){
466 realvalue = getDoubleArg(pArgList);
467 }else{
468 realvalue = va_arg(ap,double);
470 #ifdef SQLITE_OMIT_FLOATING_POINT
471 length = 0;
472 #else
473 if( precision<0 ) precision = 6; /* Set default precision */
474 if( realvalue<0.0 ){
475 realvalue = -realvalue;
476 prefix = '-';
477 }else{
478 prefix = flag_prefix;
480 if( xtype==etGENERIC && precision>0 ) precision--;
481 testcase( precision>0xfff );
482 for(idx=precision&0xfff, rounder=0.5; idx>0; idx--, rounder*=0.1){}
483 if( xtype==etFLOAT ) realvalue += rounder;
484 /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
485 exp = 0;
486 if( sqlite3IsNaN((double)realvalue) ){
487 bufpt = "NaN";
488 length = 3;
489 break;
491 if( realvalue>0.0 ){
492 LONGDOUBLE_TYPE scale = 1.0;
493 while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;}
494 while( realvalue>=1e10*scale && exp<=350 ){ scale *= 1e10; exp+=10; }
495 while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; }
496 realvalue /= scale;
497 while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
498 while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
499 if( exp>350 ){
500 bufpt = buf;
501 buf[0] = prefix;
502 memcpy(buf+(prefix!=0),"Inf",4);
503 length = 3+(prefix!=0);
504 break;
507 bufpt = buf;
509 ** If the field type is etGENERIC, then convert to either etEXP
510 ** or etFLOAT, as appropriate.
512 if( xtype!=etFLOAT ){
513 realvalue += rounder;
514 if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
516 if( xtype==etGENERIC ){
517 flag_rtz = !flag_alternateform;
518 if( exp<-4 || exp>precision ){
519 xtype = etEXP;
520 }else{
521 precision = precision - exp;
522 xtype = etFLOAT;
524 }else{
525 flag_rtz = flag_altform2;
527 if( xtype==etEXP ){
528 e2 = 0;
529 }else{
530 e2 = exp;
532 if( MAX(e2,0)+(i64)precision+(i64)width > etBUFSIZE - 15 ){
533 bufpt = zExtra
534 = sqlite3Malloc( MAX(e2,0)+(i64)precision+(i64)width+15 );
535 if( bufpt==0 ){
536 setStrAccumError(pAccum, SQLITE_NOMEM);
537 return;
540 zOut = bufpt;
541 nsd = 16 + flag_altform2*10;
542 flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
543 /* The sign in front of the number */
544 if( prefix ){
545 *(bufpt++) = prefix;
547 /* Digits prior to the decimal point */
548 if( e2<0 ){
549 *(bufpt++) = '0';
550 }else{
551 for(; e2>=0; e2--){
552 *(bufpt++) = et_getdigit(&realvalue,&nsd);
555 /* The decimal point */
556 if( flag_dp ){
557 *(bufpt++) = '.';
559 /* "0" digits after the decimal point but before the first
560 ** significant digit of the number */
561 for(e2++; e2<0; precision--, e2++){
562 assert( precision>0 );
563 *(bufpt++) = '0';
565 /* Significant digits after the decimal point */
566 while( (precision--)>0 ){
567 *(bufpt++) = et_getdigit(&realvalue,&nsd);
569 /* Remove trailing zeros and the "." if no digits follow the "." */
570 if( flag_rtz && flag_dp ){
571 while( bufpt[-1]=='0' ) *(--bufpt) = 0;
572 assert( bufpt>zOut );
573 if( bufpt[-1]=='.' ){
574 if( flag_altform2 ){
575 *(bufpt++) = '0';
576 }else{
577 *(--bufpt) = 0;
581 /* Add the "eNNN" suffix */
582 if( xtype==etEXP ){
583 *(bufpt++) = aDigits[infop->charset];
584 if( exp<0 ){
585 *(bufpt++) = '-'; exp = -exp;
586 }else{
587 *(bufpt++) = '+';
589 if( exp>=100 ){
590 *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */
591 exp %= 100;
593 *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */
594 *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */
596 *bufpt = 0;
598 /* The converted number is in buf[] and zero terminated. Output it.
599 ** Note that the number is in the usual order, not reversed as with
600 ** integer conversions. */
601 length = (int)(bufpt-zOut);
602 bufpt = zOut;
604 /* Special case: Add leading zeros if the flag_zeropad flag is
605 ** set and we are not left justified */
606 if( flag_zeropad && !flag_leftjustify && length < width){
607 int i;
608 int nPad = width - length;
609 for(i=width; i>=nPad; i--){
610 bufpt[i] = bufpt[i-nPad];
612 i = prefix!=0;
613 while( nPad-- ) bufpt[i++] = '0';
614 length = width;
616 #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
617 break;
618 case etSIZE:
619 if( !bArgList ){
620 *(va_arg(ap,int*)) = pAccum->nChar;
622 length = width = 0;
623 break;
624 case etPERCENT:
625 buf[0] = '%';
626 bufpt = buf;
627 length = 1;
628 break;
629 case etCHARX:
630 if( bArgList ){
631 bufpt = getTextArg(pArgList);
632 length = 1;
633 if( bufpt ){
634 buf[0] = c = *(bufpt++);
635 if( (c&0xc0)==0xc0 ){
636 while( length<4 && (bufpt[0]&0xc0)==0x80 ){
637 buf[length++] = *(bufpt++);
640 }else{
641 buf[0] = 0;
643 }else{
644 unsigned int ch = va_arg(ap,unsigned int);
645 if( ch<0x00080 ){
646 buf[0] = ch & 0xff;
647 length = 1;
648 }else if( ch<0x00800 ){
649 buf[0] = 0xc0 + (u8)((ch>>6)&0x1f);
650 buf[1] = 0x80 + (u8)(ch & 0x3f);
651 length = 2;
652 }else if( ch<0x10000 ){
653 buf[0] = 0xe0 + (u8)((ch>>12)&0x0f);
654 buf[1] = 0x80 + (u8)((ch>>6) & 0x3f);
655 buf[2] = 0x80 + (u8)(ch & 0x3f);
656 length = 3;
657 }else{
658 buf[0] = 0xf0 + (u8)((ch>>18) & 0x07);
659 buf[1] = 0x80 + (u8)((ch>>12) & 0x3f);
660 buf[2] = 0x80 + (u8)((ch>>6) & 0x3f);
661 buf[3] = 0x80 + (u8)(ch & 0x3f);
662 length = 4;
665 if( precision>1 ){
666 width -= precision-1;
667 if( width>1 && !flag_leftjustify ){
668 sqlite3_str_appendchar(pAccum, width-1, ' ');
669 width = 0;
671 while( precision-- > 1 ){
672 sqlite3_str_append(pAccum, buf, length);
675 bufpt = buf;
676 flag_altform2 = 1;
677 goto adjust_width_for_utf8;
678 case etSTRING:
679 case etDYNSTRING:
680 if( bArgList ){
681 bufpt = getTextArg(pArgList);
682 xtype = etSTRING;
683 }else{
684 bufpt = va_arg(ap,char*);
686 if( bufpt==0 ){
687 bufpt = "";
688 }else if( xtype==etDYNSTRING ){
689 if( pAccum->nChar==0 && pAccum->mxAlloc && width==0 && precision<0 ){
690 /* Special optimization for sqlite3_mprintf("%z..."):
691 ** Extend an existing memory allocation rather than creating
692 ** a new one. */
693 assert( (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
694 pAccum->zText = bufpt;
695 pAccum->nAlloc = sqlite3DbMallocSize(pAccum->db, bufpt);
696 pAccum->nChar = 0x7fffffff & (int)strlen(bufpt);
697 pAccum->printfFlags |= SQLITE_PRINTF_MALLOCED;
698 length = 0;
699 break;
701 zExtra = bufpt;
703 if( precision>=0 ){
704 if( flag_altform2 ){
705 /* Set length to the number of bytes needed in order to display
706 ** precision characters */
707 unsigned char *z = (unsigned char*)bufpt;
708 while( precision-- > 0 && z[0] ){
709 SQLITE_SKIP_UTF8(z);
711 length = (int)(z - (unsigned char*)bufpt);
712 }else{
713 for(length=0; length<precision && bufpt[length]; length++){}
715 }else{
716 length = 0x7fffffff & (int)strlen(bufpt);
718 adjust_width_for_utf8:
719 if( flag_altform2 && width>0 ){
720 /* Adjust width to account for extra bytes in UTF-8 characters */
721 int ii = length - 1;
722 while( ii>=0 ) if( (bufpt[ii--] & 0xc0)==0x80 ) width++;
724 break;
725 case etSQLESCAPE: /* %q: Escape ' characters */
726 case etSQLESCAPE2: /* %Q: Escape ' and enclose in '...' */
727 case etSQLESCAPE3: { /* %w: Escape " characters */
728 int i, j, k, n, isnull;
729 int needQuote;
730 char ch;
731 char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */
732 char *escarg;
734 if( bArgList ){
735 escarg = getTextArg(pArgList);
736 }else{
737 escarg = va_arg(ap,char*);
739 isnull = escarg==0;
740 if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
741 /* For %q, %Q, and %w, the precision is the number of byte (or
742 ** characters if the ! flags is present) to use from the input.
743 ** Because of the extra quoting characters inserted, the number
744 ** of output characters may be larger than the precision.
746 k = precision;
747 for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){
748 if( ch==q ) n++;
749 if( flag_altform2 && (ch&0xc0)==0xc0 ){
750 while( (escarg[i+1]&0xc0)==0x80 ){ i++; }
753 needQuote = !isnull && xtype==etSQLESCAPE2;
754 n += i + 3;
755 if( n>etBUFSIZE ){
756 bufpt = zExtra = sqlite3Malloc( n );
757 if( bufpt==0 ){
758 setStrAccumError(pAccum, SQLITE_NOMEM);
759 return;
761 }else{
762 bufpt = buf;
764 j = 0;
765 if( needQuote ) bufpt[j++] = q;
766 k = i;
767 for(i=0; i<k; i++){
768 bufpt[j++] = ch = escarg[i];
769 if( ch==q ) bufpt[j++] = ch;
771 if( needQuote ) bufpt[j++] = q;
772 bufpt[j] = 0;
773 length = j;
774 goto adjust_width_for_utf8;
776 case etTOKEN: {
777 Token *pToken;
778 if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
779 pToken = va_arg(ap, Token*);
780 assert( bArgList==0 );
781 if( pToken && pToken->n ){
782 sqlite3_str_append(pAccum, (const char*)pToken->z, pToken->n);
784 length = width = 0;
785 break;
787 case etSRCLIST: {
788 SrcList *pSrc;
789 int k;
790 struct SrcList_item *pItem;
791 if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
792 pSrc = va_arg(ap, SrcList*);
793 k = va_arg(ap, int);
794 pItem = &pSrc->a[k];
795 assert( bArgList==0 );
796 assert( k>=0 && k<pSrc->nSrc );
797 if( pItem->zDatabase ){
798 sqlite3_str_appendall(pAccum, pItem->zDatabase);
799 sqlite3_str_append(pAccum, ".", 1);
801 sqlite3_str_appendall(pAccum, pItem->zName);
802 length = width = 0;
803 break;
805 default: {
806 assert( xtype==etINVALID );
807 return;
809 }/* End switch over the format type */
811 ** The text of the conversion is pointed to by "bufpt" and is
812 ** "length" characters long. The field width is "width". Do
813 ** the output. Both length and width are in bytes, not characters,
814 ** at this point. If the "!" flag was present on string conversions
815 ** indicating that width and precision should be expressed in characters,
816 ** then the values have been translated prior to reaching this point.
818 width -= length;
819 if( width>0 ){
820 if( !flag_leftjustify ) sqlite3_str_appendchar(pAccum, width, ' ');
821 sqlite3_str_append(pAccum, bufpt, length);
822 if( flag_leftjustify ) sqlite3_str_appendchar(pAccum, width, ' ');
823 }else{
824 sqlite3_str_append(pAccum, bufpt, length);
827 if( zExtra ){
828 sqlite3DbFree(pAccum->db, zExtra);
829 zExtra = 0;
831 }/* End for loop over the format string */
832 } /* End of function */
835 ** Enlarge the memory allocation on a StrAccum object so that it is
836 ** able to accept at least N more bytes of text.
838 ** Return the number of bytes of text that StrAccum is able to accept
839 ** after the attempted enlargement. The value returned might be zero.
841 static int sqlite3StrAccumEnlarge(StrAccum *p, int N){
842 char *zNew;
843 assert( p->nChar+(i64)N >= p->nAlloc ); /* Only called if really needed */
844 if( p->accError ){
845 testcase(p->accError==SQLITE_TOOBIG);
846 testcase(p->accError==SQLITE_NOMEM);
847 return 0;
849 if( p->mxAlloc==0 ){
850 N = p->nAlloc - p->nChar - 1;
851 setStrAccumError(p, SQLITE_TOOBIG);
852 return N;
853 }else{
854 char *zOld = isMalloced(p) ? p->zText : 0;
855 i64 szNew = p->nChar;
856 szNew += N + 1;
857 if( szNew+p->nChar<=p->mxAlloc ){
858 /* Force exponential buffer size growth as long as it does not overflow,
859 ** to avoid having to call this routine too often */
860 szNew += p->nChar;
862 if( szNew > p->mxAlloc ){
863 sqlite3_str_reset(p);
864 setStrAccumError(p, SQLITE_TOOBIG);
865 return 0;
866 }else{
867 p->nAlloc = (int)szNew;
869 if( p->db ){
870 zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc);
871 }else{
872 zNew = sqlite3_realloc64(zOld, p->nAlloc);
874 if( zNew ){
875 assert( p->zText!=0 || p->nChar==0 );
876 if( !isMalloced(p) && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar);
877 p->zText = zNew;
878 p->nAlloc = sqlite3DbMallocSize(p->db, zNew);
879 p->printfFlags |= SQLITE_PRINTF_MALLOCED;
880 }else{
881 sqlite3_str_reset(p);
882 setStrAccumError(p, SQLITE_NOMEM);
883 return 0;
886 return N;
890 ** Append N copies of character c to the given string buffer.
892 void sqlite3_str_appendchar(sqlite3_str *p, int N, char c){
893 testcase( p->nChar + (i64)N > 0x7fffffff );
894 if( p->nChar+(i64)N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ){
895 return;
897 while( (N--)>0 ) p->zText[p->nChar++] = c;
901 ** The StrAccum "p" is not large enough to accept N new bytes of z[].
902 ** So enlarge if first, then do the append.
904 ** This is a helper routine to sqlite3_str_append() that does special-case
905 ** work (enlarging the buffer) using tail recursion, so that the
906 ** sqlite3_str_append() routine can use fast calling semantics.
908 static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){
909 N = sqlite3StrAccumEnlarge(p, N);
910 if( N>0 ){
911 memcpy(&p->zText[p->nChar], z, N);
912 p->nChar += N;
917 ** Append N bytes of text from z to the StrAccum object. Increase the
918 ** size of the memory allocation for StrAccum if necessary.
920 void sqlite3_str_append(sqlite3_str *p, const char *z, int N){
921 assert( z!=0 || N==0 );
922 assert( p->zText!=0 || p->nChar==0 || p->accError );
923 assert( N>=0 );
924 assert( p->accError==0 || p->nAlloc==0 );
925 if( p->nChar+N >= p->nAlloc ){
926 enlargeAndAppend(p,z,N);
927 }else if( N ){
928 assert( p->zText );
929 p->nChar += N;
930 memcpy(&p->zText[p->nChar-N], z, N);
935 ** Append the complete text of zero-terminated string z[] to the p string.
937 void sqlite3_str_appendall(sqlite3_str *p, const char *z){
938 sqlite3_str_append(p, z, sqlite3Strlen30(z));
943 ** Finish off a string by making sure it is zero-terminated.
944 ** Return a pointer to the resulting string. Return a NULL
945 ** pointer if any kind of error was encountered.
947 static SQLITE_NOINLINE char *strAccumFinishRealloc(StrAccum *p){
948 char *zText;
949 assert( p->mxAlloc>0 && !isMalloced(p) );
950 zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
951 if( zText ){
952 memcpy(zText, p->zText, p->nChar+1);
953 p->printfFlags |= SQLITE_PRINTF_MALLOCED;
954 }else{
955 setStrAccumError(p, SQLITE_NOMEM);
957 p->zText = zText;
958 return zText;
960 char *sqlite3StrAccumFinish(StrAccum *p){
961 if( p->zText ){
962 p->zText[p->nChar] = 0;
963 if( p->mxAlloc>0 && !isMalloced(p) ){
964 return strAccumFinishRealloc(p);
967 return p->zText;
971 ** This singleton is an sqlite3_str object that is returned if
972 ** sqlite3_malloc() fails to provide space for a real one. This
973 ** sqlite3_str object accepts no new text and always returns
974 ** an SQLITE_NOMEM error.
976 static sqlite3_str sqlite3OomStr = {
977 0, 0, 0, 0, 0, SQLITE_NOMEM, 0
980 /* Finalize a string created using sqlite3_str_new().
982 char *sqlite3_str_finish(sqlite3_str *p){
983 char *z;
984 if( p!=0 && p!=&sqlite3OomStr ){
985 z = sqlite3StrAccumFinish(p);
986 sqlite3_free(p);
987 }else{
988 z = 0;
990 return z;
993 /* Return any error code associated with p */
994 int sqlite3_str_errcode(sqlite3_str *p){
995 return p ? p->accError : SQLITE_NOMEM;
998 /* Return the current length of p in bytes */
999 int sqlite3_str_length(sqlite3_str *p){
1000 return p ? p->nChar : 0;
1003 /* Return the current value for p */
1004 char *sqlite3_str_value(sqlite3_str *p){
1005 if( p==0 || p->nChar==0 ) return 0;
1006 p->zText[p->nChar] = 0;
1007 return p->zText;
1011 ** Reset an StrAccum string. Reclaim all malloced memory.
1013 void sqlite3_str_reset(StrAccum *p){
1014 if( isMalloced(p) ){
1015 sqlite3DbFree(p->db, p->zText);
1016 p->printfFlags &= ~SQLITE_PRINTF_MALLOCED;
1018 p->nAlloc = 0;
1019 p->nChar = 0;
1020 p->zText = 0;
1024 ** Initialize a string accumulator.
1026 ** p: The accumulator to be initialized.
1027 ** db: Pointer to a database connection. May be NULL. Lookaside
1028 ** memory is used if not NULL. db->mallocFailed is set appropriately
1029 ** when not NULL.
1030 ** zBase: An initial buffer. May be NULL in which case the initial buffer
1031 ** is malloced.
1032 ** n: Size of zBase in bytes. If total space requirements never exceed
1033 ** n then no memory allocations ever occur.
1034 ** mx: Maximum number of bytes to accumulate. If mx==0 then no memory
1035 ** allocations will ever occur.
1037 void sqlite3StrAccumInit(StrAccum *p, sqlite3 *db, char *zBase, int n, int mx){
1038 p->zText = zBase;
1039 p->db = db;
1040 p->nAlloc = n;
1041 p->mxAlloc = mx;
1042 p->nChar = 0;
1043 p->accError = 0;
1044 p->printfFlags = 0;
1047 /* Allocate and initialize a new dynamic string object */
1048 sqlite3_str *sqlite3_str_new(sqlite3 *db){
1049 sqlite3_str *p = sqlite3_malloc64(sizeof(*p));
1050 if( p ){
1051 sqlite3StrAccumInit(p, 0, 0, 0,
1052 db ? db->aLimit[SQLITE_LIMIT_LENGTH] : SQLITE_MAX_LENGTH);
1053 }else{
1054 p = &sqlite3OomStr;
1056 return p;
1060 ** Print into memory obtained from sqliteMalloc(). Use the internal
1061 ** %-conversion extensions.
1063 char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
1064 char *z;
1065 char zBase[SQLITE_PRINT_BUF_SIZE];
1066 StrAccum acc;
1067 assert( db!=0 );
1068 sqlite3StrAccumInit(&acc, db, zBase, sizeof(zBase),
1069 db->aLimit[SQLITE_LIMIT_LENGTH]);
1070 acc.printfFlags = SQLITE_PRINTF_INTERNAL;
1071 sqlite3_str_vappendf(&acc, zFormat, ap);
1072 z = sqlite3StrAccumFinish(&acc);
1073 if( acc.accError==SQLITE_NOMEM ){
1074 sqlite3OomFault(db);
1076 return z;
1080 ** Print into memory obtained from sqliteMalloc(). Use the internal
1081 ** %-conversion extensions.
1083 char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
1084 va_list ap;
1085 char *z;
1086 va_start(ap, zFormat);
1087 z = sqlite3VMPrintf(db, zFormat, ap);
1088 va_end(ap);
1089 return z;
1093 ** Print into memory obtained from sqlite3_malloc(). Omit the internal
1094 ** %-conversion extensions.
1096 char *sqlite3_vmprintf(const char *zFormat, va_list ap){
1097 char *z;
1098 char zBase[SQLITE_PRINT_BUF_SIZE];
1099 StrAccum acc;
1101 #ifdef SQLITE_ENABLE_API_ARMOR
1102 if( zFormat==0 ){
1103 (void)SQLITE_MISUSE_BKPT;
1104 return 0;
1106 #endif
1107 #ifndef SQLITE_OMIT_AUTOINIT
1108 if( sqlite3_initialize() ) return 0;
1109 #endif
1110 sqlite3StrAccumInit(&acc, 0, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
1111 sqlite3_str_vappendf(&acc, zFormat, ap);
1112 z = sqlite3StrAccumFinish(&acc);
1113 return z;
1117 ** Print into memory obtained from sqlite3_malloc()(). Omit the internal
1118 ** %-conversion extensions.
1120 char *sqlite3_mprintf(const char *zFormat, ...){
1121 va_list ap;
1122 char *z;
1123 #ifndef SQLITE_OMIT_AUTOINIT
1124 if( sqlite3_initialize() ) return 0;
1125 #endif
1126 va_start(ap, zFormat);
1127 z = sqlite3_vmprintf(zFormat, ap);
1128 va_end(ap);
1129 return z;
1133 ** sqlite3_snprintf() works like snprintf() except that it ignores the
1134 ** current locale settings. This is important for SQLite because we
1135 ** are not able to use a "," as the decimal point in place of "." as
1136 ** specified by some locales.
1138 ** Oops: The first two arguments of sqlite3_snprintf() are backwards
1139 ** from the snprintf() standard. Unfortunately, it is too late to change
1140 ** this without breaking compatibility, so we just have to live with the
1141 ** mistake.
1143 ** sqlite3_vsnprintf() is the varargs version.
1145 char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){
1146 StrAccum acc;
1147 if( n<=0 ) return zBuf;
1148 #ifdef SQLITE_ENABLE_API_ARMOR
1149 if( zBuf==0 || zFormat==0 ) {
1150 (void)SQLITE_MISUSE_BKPT;
1151 if( zBuf ) zBuf[0] = 0;
1152 return zBuf;
1154 #endif
1155 sqlite3StrAccumInit(&acc, 0, zBuf, n, 0);
1156 sqlite3_str_vappendf(&acc, zFormat, ap);
1157 zBuf[acc.nChar] = 0;
1158 return zBuf;
1160 char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
1161 char *z;
1162 va_list ap;
1163 va_start(ap,zFormat);
1164 z = sqlite3_vsnprintf(n, zBuf, zFormat, ap);
1165 va_end(ap);
1166 return z;
1170 ** This is the routine that actually formats the sqlite3_log() message.
1171 ** We house it in a separate routine from sqlite3_log() to avoid using
1172 ** stack space on small-stack systems when logging is disabled.
1174 ** sqlite3_log() must render into a static buffer. It cannot dynamically
1175 ** allocate memory because it might be called while the memory allocator
1176 ** mutex is held.
1178 ** sqlite3_str_vappendf() might ask for *temporary* memory allocations for
1179 ** certain format characters (%q) or for very large precisions or widths.
1180 ** Care must be taken that any sqlite3_log() calls that occur while the
1181 ** memory mutex is held do not use these mechanisms.
1183 static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){
1184 StrAccum acc; /* String accumulator */
1185 char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */
1187 sqlite3StrAccumInit(&acc, 0, zMsg, sizeof(zMsg), 0);
1188 sqlite3_str_vappendf(&acc, zFormat, ap);
1189 sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode,
1190 sqlite3StrAccumFinish(&acc));
1194 ** Format and write a message to the log if logging is enabled.
1196 void sqlite3_log(int iErrCode, const char *zFormat, ...){
1197 va_list ap; /* Vararg list */
1198 if( sqlite3GlobalConfig.xLog ){
1199 va_start(ap, zFormat);
1200 renderLogMsg(iErrCode, zFormat, ap);
1201 va_end(ap);
1205 #if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
1207 ** A version of printf() that understands %lld. Used for debugging.
1208 ** The printf() built into some versions of windows does not understand %lld
1209 ** and segfaults if you give it a long long int.
1211 void sqlite3DebugPrintf(const char *zFormat, ...){
1212 va_list ap;
1213 StrAccum acc;
1214 char zBuf[500];
1215 sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
1216 va_start(ap,zFormat);
1217 sqlite3_str_vappendf(&acc, zFormat, ap);
1218 va_end(ap);
1219 sqlite3StrAccumFinish(&acc);
1220 #ifdef SQLITE_OS_TRACE_PROC
1222 extern void SQLITE_OS_TRACE_PROC(const char *zBuf, int nBuf);
1223 SQLITE_OS_TRACE_PROC(zBuf, sizeof(zBuf));
1225 #else
1226 fprintf(stdout,"%s", zBuf);
1227 fflush(stdout);
1228 #endif
1230 #endif
1234 ** variable-argument wrapper around sqlite3_str_vappendf(). The bFlags argument
1235 ** can contain the bit SQLITE_PRINTF_INTERNAL enable internal formats.
1237 void sqlite3_str_appendf(StrAccum *p, const char *zFormat, ...){
1238 va_list ap;
1239 va_start(ap,zFormat);
1240 sqlite3_str_vappendf(p, zFormat, ap);
1241 va_end(ap);