2 ** The "printf" code that follows dates from the 1980's. It is in
5 **************************************************************************
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
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 */
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 },
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.
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
120 static char et_getdigit(LONGDOUBLE_TYPE
*val
, int *cnt
){
123 if( (*cnt
)<=0 ) return '0';
128 *val
= (*val
- d
)*10.0;
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
;
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
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 */
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...")
212 assert( pAccum
->nChar
>0 || (pAccum
->printfFlags
&SQLITE_PRINTF_MALLOCED
)==0 );
215 if( (pAccum
->printfFlags
& SQLITE_PRINTF_SQLFUNC
)!=0 ){
216 pArgList
= va_arg(ap
, PrintfArguments
*);
221 for(; (c
=(*fmt
))!=0; ++fmt
){
225 fmt
= strchrnul(fmt
, '%');
227 do{ fmt
++; }while( *fmt
&& *fmt
!= '%' );
229 sqlite3_str_append(pAccum
, bufpt
, (int)(fmt
- bufpt
));
232 if( (c
=(*++fmt
))==0 ){
233 sqlite3_str_append(pAccum
, "%", 1);
236 /* Find out what flags are present */
237 flag_leftjustify
= flag_prefix
= cThousand
=
238 flag_alternateform
= flag_altform2
= flag_zeropad
= 0;
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 */
255 width
= (int)getIntArg(pArgList
);
257 width
= va_arg(ap
,int);
260 flag_leftjustify
= 1;
261 width
= width
>= -2147483647 ? -width
: 0;
266 while( c
>='0' && c
<='9' ){
267 wx
= wx
*10 + c
- '0';
270 testcase( wx
>0x7fffffff );
271 width
= wx
& 0x7fffffff;
274 #ifdef SQLITE_PRINTF_PRECISION_LIMIT
275 if( width
>SQLITE_PRINTF_PRECISION_LIMIT
){
276 width
= SQLITE_PRINTF_PRECISION_LIMIT
;
280 /* Get the precision */
285 precision
= (int)getIntArg(pArgList
);
287 precision
= va_arg(ap
,int);
291 precision
= precision
>= -2147483647 ? -precision
: -1;
295 while( c
>='0' && c
<='9' ){
296 px
= px
*10 + c
- '0';
299 testcase( px
>0x7fffffff );
300 precision
= px
& 0x7fffffff;
305 assert( precision
>=(-1) );
306 #ifdef SQLITE_PRINTF_PRECISION_LIMIT
307 if( precision
>SQLITE_PRINTF_PRECISION_LIMIT
){
308 precision
= SQLITE_PRINTF_PRECISION_LIMIT
;
313 /* Get the conversion type modifier */
324 /* Fetch the info entry for the field */
327 for(idx
=0; idx
<ArraySize(fmtinfo
); idx
++){
328 if( c
==fmtinfo
[idx
].fmttype
){
329 infop
= &fmtinfo
[idx
];
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
349 ** xtype The class of the conversion.
350 ** infop Pointer to the appropriate info struct.
354 flag_long
= sizeof(char*)==sizeof(i64
) ? 2 :
355 sizeof(char*)==sizeof(long int) ? 1 : 0;
356 /* Fall through into the next case */
360 /* Fall through into the next case */
362 if( infop
->flags
& FLAG_SIGNED
){
365 v
= getIntArg(pArgList
);
366 }else if( flag_long
){
370 v
= va_arg(ap
,long int);
376 if( v
==SMALLEST_INT64
){
377 longvalue
= ((u64
)1)<<63;
384 prefix
= flag_prefix
;
388 longvalue
= (u64
)getIntArg(pArgList
);
389 }else if( flag_long
){
391 longvalue
= va_arg(ap
,u64
);
393 longvalue
= va_arg(ap
,unsigned long int);
396 longvalue
= va_arg(ap
,unsigned int);
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 ){
408 u64 n
= (u64
)precision
+ 10 + precision
/3;
409 zOut
= zExtra
= sqlite3Malloc( n
);
411 setStrAccumError(pAccum
, SQLITE_NOMEM
);
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 ){
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 */
440 int nn
= (length
- 1)/3; /* Number of "," to insert */
441 int ix
= (length
- 1)%3 + 1;
443 for(idx
=0; nn
>0; idx
++){
444 bufpt
[idx
] = bufpt
[idx
+nn
];
447 bufpt
[++idx
] = cThousand
;
453 if( prefix
) *(--bufpt
) = prefix
; /* Add sign */
454 if( flag_alternateform
&& infop
->prefix
){ /* Add "0" or "0x" */
457 pre
= &aPrefix
[infop
->prefix
];
458 for(; (x
=(*pre
))!=0; pre
++) *(--bufpt
) = x
;
460 length
= (int)(&zOut
[nOut
-1]-bufpt
);
466 realvalue
= getDoubleArg(pArgList
);
468 realvalue
= va_arg(ap
,double);
470 #ifdef SQLITE_OMIT_FLOATING_POINT
473 if( precision
<0 ) precision
= 6; /* Set default precision */
475 realvalue
= -realvalue
;
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 */
486 if( sqlite3IsNaN((double)realvalue
) ){
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
++; }
497 while( realvalue
<1e-8 ){ realvalue
*= 1e8
; exp
-=8; }
498 while( realvalue
<1.0 ){ realvalue
*= 10.0; exp
--; }
502 memcpy(buf
+(prefix
!=0),"Inf",4);
503 length
= 3+(prefix
!=0);
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
){
521 precision
= precision
- exp
;
525 flag_rtz
= flag_altform2
;
532 if( MAX(e2
,0)+(i64
)precision
+(i64
)width
> etBUFSIZE
- 15 ){
534 = sqlite3Malloc( MAX(e2
,0)+(i64
)precision
+(i64
)width
+15 );
536 setStrAccumError(pAccum
, SQLITE_NOMEM
);
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 */
547 /* Digits prior to the decimal point */
552 *(bufpt
++) = et_getdigit(&realvalue
,&nsd
);
555 /* The decimal point */
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 );
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]=='.' ){
581 /* Add the "eNNN" suffix */
583 *(bufpt
++) = aDigits
[infop
->charset
];
585 *(bufpt
++) = '-'; exp
= -exp
;
590 *(bufpt
++) = (char)((exp
/100)+'0'); /* 100's digit */
593 *(bufpt
++) = (char)(exp
/10+'0'); /* 10's digit */
594 *(bufpt
++) = (char)(exp
%10+'0'); /* 1's digit */
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
);
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
){
608 int nPad
= width
- length
;
609 for(i
=width
; i
>=nPad
; i
--){
610 bufpt
[i
] = bufpt
[i
-nPad
];
613 while( nPad
-- ) bufpt
[i
++] = '0';
616 #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
620 *(va_arg(ap
,int*)) = pAccum
->nChar
;
631 bufpt
= getTextArg(pArgList
);
634 buf
[0] = c
= *(bufpt
++);
635 if( (c
&0xc0)==0xc0 ){
636 while( length
<4 && (bufpt
[0]&0xc0)==0x80 ){
637 buf
[length
++] = *(bufpt
++);
644 unsigned int ch
= va_arg(ap
,unsigned int);
648 }else if( ch
<0x00800 ){
649 buf
[0] = 0xc0 + (u8
)((ch
>>6)&0x1f);
650 buf
[1] = 0x80 + (u8
)(ch
& 0x3f);
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);
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);
666 width
-= precision
-1;
667 if( width
>1 && !flag_leftjustify
){
668 sqlite3_str_appendchar(pAccum
, width
-1, ' ');
671 while( precision
-- > 1 ){
672 sqlite3_str_append(pAccum
, buf
, length
);
677 goto adjust_width_for_utf8
;
681 bufpt
= getTextArg(pArgList
);
684 bufpt
= va_arg(ap
,char*);
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
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
;
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] ){
711 length
= (int)(z
- (unsigned char*)bufpt
);
713 for(length
=0; length
<precision
&& bufpt
[length
]; length
++){}
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 */
722 while( ii
>=0 ) if( (bufpt
[ii
--] & 0xc0)==0x80 ) width
++;
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
;
731 char q
= ((xtype
==etSQLESCAPE3
)?'"':'\''); /* Quote character */
735 escarg
= getTextArg(pArgList
);
737 escarg
= va_arg(ap
,char*);
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.
747 for(i
=n
=0; k
!=0 && (ch
=escarg
[i
])!=0; i
++, k
--){
749 if( flag_altform2
&& (ch
&0xc0)==0xc0 ){
750 while( (escarg
[i
+1]&0xc0)==0x80 ){ i
++; }
753 needQuote
= !isnull
&& xtype
==etSQLESCAPE2
;
756 bufpt
= zExtra
= sqlite3Malloc( n
);
758 setStrAccumError(pAccum
, SQLITE_NOMEM
);
765 if( needQuote
) bufpt
[j
++] = q
;
768 bufpt
[j
++] = ch
= escarg
[i
];
769 if( ch
==q
) bufpt
[j
++] = ch
;
771 if( needQuote
) bufpt
[j
++] = q
;
774 goto adjust_width_for_utf8
;
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
);
790 struct SrcList_item
*pItem
;
791 if( (pAccum
->printfFlags
& SQLITE_PRINTF_INTERNAL
)==0 ) return;
792 pSrc
= va_arg(ap
, SrcList
*);
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
);
806 assert( xtype
==etINVALID
);
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.
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
, ' ');
824 sqlite3_str_append(pAccum
, bufpt
, length
);
828 sqlite3DbFree(pAccum
->db
, zExtra
);
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
){
843 assert( p
->nChar
+(i64
)N
>= p
->nAlloc
); /* Only called if really needed */
845 testcase(p
->accError
==SQLITE_TOOBIG
);
846 testcase(p
->accError
==SQLITE_NOMEM
);
850 N
= p
->nAlloc
- p
->nChar
- 1;
851 setStrAccumError(p
, SQLITE_TOOBIG
);
854 char *zOld
= isMalloced(p
) ? p
->zText
: 0;
855 i64 szNew
= p
->nChar
;
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 */
862 if( szNew
> p
->mxAlloc
){
863 sqlite3_str_reset(p
);
864 setStrAccumError(p
, SQLITE_TOOBIG
);
867 p
->nAlloc
= (int)szNew
;
870 zNew
= sqlite3DbRealloc(p
->db
, zOld
, p
->nAlloc
);
872 zNew
= sqlite3_realloc64(zOld
, p
->nAlloc
);
875 assert( p
->zText
!=0 || p
->nChar
==0 );
876 if( !isMalloced(p
) && p
->nChar
>0 ) memcpy(zNew
, p
->zText
, p
->nChar
);
878 p
->nAlloc
= sqlite3DbMallocSize(p
->db
, zNew
);
879 p
->printfFlags
|= SQLITE_PRINTF_MALLOCED
;
881 sqlite3_str_reset(p
);
882 setStrAccumError(p
, SQLITE_NOMEM
);
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 ){
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
);
911 memcpy(&p
->zText
[p
->nChar
], z
, 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
);
924 assert( p
->accError
==0 || p
->nAlloc
==0 );
925 if( p
->nChar
+N
>= p
->nAlloc
){
926 enlargeAndAppend(p
,z
,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
){
949 assert( p
->mxAlloc
>0 && !isMalloced(p
) );
950 zText
= sqlite3DbMallocRaw(p
->db
, p
->nChar
+1 );
952 memcpy(zText
, p
->zText
, p
->nChar
+1);
953 p
->printfFlags
|= SQLITE_PRINTF_MALLOCED
;
955 setStrAccumError(p
, SQLITE_NOMEM
);
960 char *sqlite3StrAccumFinish(StrAccum
*p
){
962 p
->zText
[p
->nChar
] = 0;
963 if( p
->mxAlloc
>0 && !isMalloced(p
) ){
964 return strAccumFinishRealloc(p
);
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
){
984 if( p
!=0 && p
!=&sqlite3OomStr
){
985 z
= sqlite3StrAccumFinish(p
);
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;
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
;
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
1030 ** zBase: An initial buffer. May be NULL in which case the initial buffer
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
){
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
));
1051 sqlite3StrAccumInit(p
, 0, 0, 0,
1052 db
? db
->aLimit
[SQLITE_LIMIT_LENGTH
] : SQLITE_MAX_LENGTH
);
1060 ** Print into memory obtained from sqliteMalloc(). Use the internal
1061 ** %-conversion extensions.
1063 char *sqlite3VMPrintf(sqlite3
*db
, const char *zFormat
, va_list ap
){
1065 char zBase
[SQLITE_PRINT_BUF_SIZE
];
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
);
1080 ** Print into memory obtained from sqliteMalloc(). Use the internal
1081 ** %-conversion extensions.
1083 char *sqlite3MPrintf(sqlite3
*db
, const char *zFormat
, ...){
1086 va_start(ap
, zFormat
);
1087 z
= sqlite3VMPrintf(db
, zFormat
, ap
);
1093 ** Print into memory obtained from sqlite3_malloc(). Omit the internal
1094 ** %-conversion extensions.
1096 char *sqlite3_vmprintf(const char *zFormat
, va_list ap
){
1098 char zBase
[SQLITE_PRINT_BUF_SIZE
];
1101 #ifdef SQLITE_ENABLE_API_ARMOR
1103 (void)SQLITE_MISUSE_BKPT
;
1107 #ifndef SQLITE_OMIT_AUTOINIT
1108 if( sqlite3_initialize() ) return 0;
1110 sqlite3StrAccumInit(&acc
, 0, zBase
, sizeof(zBase
), SQLITE_MAX_LENGTH
);
1111 sqlite3_str_vappendf(&acc
, zFormat
, ap
);
1112 z
= sqlite3StrAccumFinish(&acc
);
1117 ** Print into memory obtained from sqlite3_malloc()(). Omit the internal
1118 ** %-conversion extensions.
1120 char *sqlite3_mprintf(const char *zFormat
, ...){
1123 #ifndef SQLITE_OMIT_AUTOINIT
1124 if( sqlite3_initialize() ) return 0;
1126 va_start(ap
, zFormat
);
1127 z
= sqlite3_vmprintf(zFormat
, ap
);
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
1143 ** sqlite3_vsnprintf() is the varargs version.
1145 char *sqlite3_vsnprintf(int n
, char *zBuf
, const char *zFormat
, va_list ap
){
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;
1155 sqlite3StrAccumInit(&acc
, 0, zBuf
, n
, 0);
1156 sqlite3_str_vappendf(&acc
, zFormat
, ap
);
1157 zBuf
[acc
.nChar
] = 0;
1160 char *sqlite3_snprintf(int n
, char *zBuf
, const char *zFormat
, ...){
1163 va_start(ap
,zFormat
);
1164 z
= sqlite3_vsnprintf(n
, zBuf
, zFormat
, ap
);
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
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
);
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
, ...){
1215 sqlite3StrAccumInit(&acc
, 0, zBuf
, sizeof(zBuf
), 0);
1216 va_start(ap
,zFormat
);
1217 sqlite3_str_vappendf(&acc
, zFormat
, 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
));
1226 fprintf(stdout
,"%s", zBuf
);
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
, ...){
1239 va_start(ap
,zFormat
);
1240 sqlite3_str_vappendf(p
, zFormat
, ap
);