blob: 9fea2d6ef0cea9c22491c15dd67b48038d897c76 [file] [log] [blame]
drha18c5682000-10-08 22:20:57 +00001/*
2** The "printf" code that follows dates from the 1980's. It is in
drh38b41492015-06-08 15:08:15 +00003** the public domain.
drhe84a3062004-02-02 12:29:25 +00004**
5**************************************************************************
drha18c5682000-10-08 22:20:57 +00006**
drhed1fddf2011-10-12 18:52:59 +00007** 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
mistachkinf5b5f9b2015-06-08 17:42:57 +000010** SQLite.
drha18c5682000-10-08 22:20:57 +000011*/
12#include "sqliteInt.h"
drh7c68d602000-10-11 19:28:51 +000013
drha18c5682000-10-08 22:20:57 +000014/*
drha18c5682000-10-08 22:20:57 +000015** Conversion types fall into various categories as defined by the
16** following enumeration.
17*/
drh2c338a92017-02-10 19:38:36 +000018#define etRADIX 0 /* non-decimal integer types. %x %o */
drhad5a9d72016-05-05 11:53:12 +000019#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 */
drha18c5682000-10-08 22:20:57 +000027/* The rest are extensions, not normally found in printf() */
drhad5a9d72016-05-05 11:53:12 +000028#define etSQLESCAPE 9 /* Strings with '\'' doubled. %q */
29#define etSQLESCAPE2 10 /* Strings with '\'' doubled and enclosed in '',
chw0cfcf3f2002-06-16 04:55:48 +000030 NULL pointers replaced by SQL NULL. %Q */
drhad5a9d72016-05-05 11:53:12 +000031#define etTOKEN 11 /* a pointer to a Token structure */
drha9799932021-03-19 13:00:28 +000032#define etSRCITEM 12 /* a pointer to a SrcItem */
drhad5a9d72016-05-05 11:53:12 +000033#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 */
drh2c338a92017-02-10 19:38:36 +000036#define etDECIMAL 16 /* %d or %u, but not %x, %o */
drhe84a3062004-02-02 12:29:25 +000037
drh2c338a92017-02-10 19:38:36 +000038#define etINVALID 17 /* Any unrecognized conversion type */
drh874ba042009-04-08 16:10:04 +000039
drhe84a3062004-02-02 12:29:25 +000040
41/*
42** An "etByte" is an 8-bit unsigned value.
43*/
44typedef unsigned char etByte;
drha18c5682000-10-08 22:20:57 +000045
46/*
47** Each builtin conversion character (ex: the 'd' in "%d") is described
48** by an instance of the following structure
49*/
50typedef struct et_info { /* Information about each format field */
drhe84a3062004-02-02 12:29:25 +000051 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 */
drh76ff3a02004-09-24 22:32:30 +000055 etByte charset; /* Offset into aDigits[] of the digits string */
56 etByte prefix; /* Offset into aPrefix[] of the prefix string */
drha18c5682000-10-08 22:20:57 +000057} et_info;
58
59/*
drhe84a3062004-02-02 12:29:25 +000060** Allowed values for et_info.flags
61*/
drh2c338a92017-02-10 19:38:36 +000062#define FLAG_SIGNED 1 /* True if the value to convert is signed */
63#define FLAG_STRING 4 /* Allow infinite precision */
drhe84a3062004-02-02 12:29:25 +000064
65
66/*
drha18c5682000-10-08 22:20:57 +000067** The following table is searched linearly, so it is good to put the
68** most frequently used conversion types first.
69*/
drh76ff3a02004-09-24 22:32:30 +000070static const char aDigits[] = "0123456789ABCDEF0123456789abcdef";
71static const char aPrefix[] = "-x0\000X0";
drh57196282004-10-06 15:41:16 +000072static const et_info fmtinfo[] = {
drh2c338a92017-02-10 19:38:36 +000073 { 'd', 10, 1, etDECIMAL, 0, 0 },
drh4794f732004-11-05 17:17:50 +000074 { 's', 0, 4, etSTRING, 0, 0 },
drh557cc602005-08-13 12:59:14 +000075 { 'g', 0, 1, etGENERIC, 30, 0 },
drh153c62c2007-08-24 03:51:33 +000076 { 'z', 0, 4, etDYNSTRING, 0, 0 },
drh4794f732004-11-05 17:17:50 +000077 { 'q', 0, 4, etSQLESCAPE, 0, 0 },
78 { 'Q', 0, 4, etSQLESCAPE2, 0, 0 },
danielk1977f3b863e2007-06-24 06:32:17 +000079 { 'w', 0, 4, etSQLESCAPE3, 0, 0 },
drh76ff3a02004-09-24 22:32:30 +000080 { 'c', 0, 0, etCHARX, 0, 0 },
81 { 'o', 8, 0, etRADIX, 0, 2 },
drh2c338a92017-02-10 19:38:36 +000082 { 'u', 10, 0, etDECIMAL, 0, 0 },
drh76ff3a02004-09-24 22:32:30 +000083 { 'x', 16, 0, etRADIX, 16, 1 },
84 { 'X', 16, 0, etRADIX, 0, 4 },
drhb37df7b2005-10-13 02:09:49 +000085#ifndef SQLITE_OMIT_FLOATING_POINT
drh76ff3a02004-09-24 22:32:30 +000086 { 'f', 0, 1, etFLOAT, 0, 0 },
87 { 'e', 0, 1, etEXP, 30, 0 },
88 { 'E', 0, 1, etEXP, 14, 0 },
drh76ff3a02004-09-24 22:32:30 +000089 { 'G', 0, 1, etGENERIC, 14, 0 },
drhb37df7b2005-10-13 02:09:49 +000090#endif
drh2c338a92017-02-10 19:38:36 +000091 { 'i', 10, 1, etDECIMAL, 0, 0 },
drh76ff3a02004-09-24 22:32:30 +000092 { 'n', 0, 0, etSIZE, 0, 0 },
93 { '%', 0, 0, etPERCENT, 0, 0 },
94 { 'p', 16, 0, etPOINTER, 0, 1 },
drh7e3ff5d2009-04-08 11:49:42 +000095
drh8236f682017-01-04 00:26:28 +000096 /* All the rest are undocumented and are for internal use only */
97 { 'T', 0, 0, etTOKEN, 0, 0 },
drha9799932021-03-19 13:00:28 +000098 { 'S', 0, 0, etSRCITEM, 0, 0 },
drh8236f682017-01-04 00:26:28 +000099 { 'r', 10, 1, etORDINAL, 0, 0 },
drha18c5682000-10-08 22:20:57 +0000100};
drha18c5682000-10-08 22:20:57 +0000101
drha9799932021-03-19 13:00:28 +0000102/* Notes:
103**
104** %S Takes a pointer to SrcItem. Shows name or database.name
drh2f2091b2021-03-20 15:46:01 +0000105** %!S Like %S but prefer the zName over the zAlias
drha9799932021-03-19 13:00:28 +0000106*/
107
drha0ed86b2019-05-24 22:58:16 +0000108/* Floating point constants used for rounding */
109static const double arRound[] = {
110 5.0e-01, 5.0e-02, 5.0e-03, 5.0e-04, 5.0e-05,
111 5.0e-06, 5.0e-07, 5.0e-08, 5.0e-09, 5.0e-10,
112};
113
drha18c5682000-10-08 22:20:57 +0000114/*
drhb37df7b2005-10-13 02:09:49 +0000115** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point
drha18c5682000-10-08 22:20:57 +0000116** conversions will work.
117*/
drhb37df7b2005-10-13 02:09:49 +0000118#ifndef SQLITE_OMIT_FLOATING_POINT
drha18c5682000-10-08 22:20:57 +0000119/*
120** "*val" is a double such that 0.1 <= *val < 10.0
121** Return the ascii code for the leading digit of *val, then
122** multiply "*val" by 10.0 to renormalize.
123**
124** Example:
125** input: *val = 3.14159
126** output: *val = 1.4159 function return = '3'
127**
128** The counter *cnt is incremented each time. After counter exceeds
129** 16 (the number of significant digits in a 64-bit float) '0' is
130** always returned.
131*/
drhea678832008-12-10 19:26:22 +0000132static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){
drha18c5682000-10-08 22:20:57 +0000133 int digit;
drh384eef32004-01-07 03:04:27 +0000134 LONGDOUBLE_TYPE d;
drh72b3fbc2012-06-19 03:11:25 +0000135 if( (*cnt)<=0 ) return '0';
136 (*cnt)--;
drha18c5682000-10-08 22:20:57 +0000137 digit = (int)*val;
138 d = digit;
139 digit += '0';
140 *val = (*val - d)*10.0;
drhea678832008-12-10 19:26:22 +0000141 return (char)digit;
drha18c5682000-10-08 22:20:57 +0000142}
drhb37df7b2005-10-13 02:09:49 +0000143#endif /* SQLITE_OMIT_FLOATING_POINT */
drha18c5682000-10-08 22:20:57 +0000144
drh79158e12005-09-06 21:40:45 +0000145/*
drha6353a32013-12-09 19:03:26 +0000146** Set the StrAccum object to an error mode.
147*/
drhf06db3e2021-10-01 00:25:06 +0000148void sqlite3StrAccumSetError(StrAccum *p, u8 eError){
drh0cdbe1a2018-05-09 13:46:26 +0000149 assert( eError==SQLITE_NOMEM || eError==SQLITE_TOOBIG );
drha6353a32013-12-09 19:03:26 +0000150 p->accError = eError;
drh255a81f2019-02-22 15:42:10 +0000151 if( p->mxAlloc ) sqlite3_str_reset(p);
drhc3dcdba2019-04-09 21:32:46 +0000152 if( eError==SQLITE_TOOBIG ) sqlite3ErrorToParser(p->db, eError);
drha6353a32013-12-09 19:03:26 +0000153}
154
155/*
drha5c14162013-12-17 15:03:06 +0000156** Extra argument values from a PrintfArguments object
157*/
158static sqlite3_int64 getIntArg(PrintfArguments *p){
159 if( p->nArg<=p->nUsed ) return 0;
160 return sqlite3_value_int64(p->apArg[p->nUsed++]);
161}
162static double getDoubleArg(PrintfArguments *p){
163 if( p->nArg<=p->nUsed ) return 0.0;
164 return sqlite3_value_double(p->apArg[p->nUsed++]);
165}
166static char *getTextArg(PrintfArguments *p){
167 if( p->nArg<=p->nUsed ) return 0;
168 return (char*)sqlite3_value_text(p->apArg[p->nUsed++]);
169}
170
drh29642252019-02-01 20:29:04 +0000171/*
172** Allocate memory for a temporary buffer needed for printf rendering.
173**
174** If the requested size of the temp buffer is larger than the size
175** of the output buffer in pAccum, then cause an SQLITE_TOOBIG error.
176** Do the size check before the memory allocation to prevent rogue
177** SQL from requesting large allocations using the precision or width
178** field of the printf() function.
179*/
180static char *printfTempBuf(sqlite3_str *pAccum, sqlite3_int64 n){
181 char *z;
drh255a81f2019-02-22 15:42:10 +0000182 if( pAccum->accError ) return 0;
drh29642252019-02-01 20:29:04 +0000183 if( n>pAccum->nAlloc && n>pAccum->mxAlloc ){
drhf06db3e2021-10-01 00:25:06 +0000184 sqlite3StrAccumSetError(pAccum, SQLITE_TOOBIG);
drh29642252019-02-01 20:29:04 +0000185 return 0;
186 }
187 z = sqlite3DbMallocRaw(pAccum->db, n);
188 if( z==0 ){
drhf06db3e2021-10-01 00:25:06 +0000189 sqlite3StrAccumSetError(pAccum, SQLITE_NOMEM);
drh29642252019-02-01 20:29:04 +0000190 }
191 return z;
192}
drha5c14162013-12-17 15:03:06 +0000193
194/*
drh79158e12005-09-06 21:40:45 +0000195** On machines with a small stack size, you can redefine the
drhed1fddf2011-10-12 18:52:59 +0000196** SQLITE_PRINT_BUF_SIZE to be something smaller, if desired.
drh79158e12005-09-06 21:40:45 +0000197*/
198#ifndef SQLITE_PRINT_BUF_SIZE
drh59eedf72011-10-11 17:54:54 +0000199# define SQLITE_PRINT_BUF_SIZE 70
drh79158e12005-09-06 21:40:45 +0000200#endif
201#define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */
drha18c5682000-10-08 22:20:57 +0000202
203/*
drhdd6c33d2020-05-23 19:58:07 +0000204** Hard limit on the precision of floating-point conversions.
205*/
206#ifndef SQLITE_PRINTF_PRECISION_LIMIT
207# define SQLITE_FP_PRECISION_LIMIT 100000000
208#endif
209
210/*
drhed1fddf2011-10-12 18:52:59 +0000211** Render a string given by "fmt" into the StrAccum object.
drha18c5682000-10-08 22:20:57 +0000212*/
drh0cdbe1a2018-05-09 13:46:26 +0000213void sqlite3_str_vappendf(
214 sqlite3_str *pAccum, /* Accumulate results here */
drha5c14162013-12-17 15:03:06 +0000215 const char *fmt, /* Format string */
216 va_list ap /* arguments */
drha18c5682000-10-08 22:20:57 +0000217){
drhe84a3062004-02-02 12:29:25 +0000218 int c; /* Next character in the format string */
219 char *bufpt; /* Pointer to the conversion buffer */
220 int precision; /* Precision of the current field */
221 int length; /* Length of the field */
222 int idx; /* A general purpose loop counter */
drhe84a3062004-02-02 12:29:25 +0000223 int width; /* Width of the current field */
224 etByte flag_leftjustify; /* True if "-" flag is present */
drh2c338a92017-02-10 19:38:36 +0000225 etByte flag_prefix; /* '+' or ' ' or 0 for prefix */
drhe84a3062004-02-02 12:29:25 +0000226 etByte flag_alternateform; /* True if "#" flag is present */
drh531fe872005-08-13 13:40:42 +0000227 etByte flag_altform2; /* True if "!" flag is present */
drhe84a3062004-02-02 12:29:25 +0000228 etByte flag_zeropad; /* True if field width constant starts with zero */
drh2c338a92017-02-10 19:38:36 +0000229 etByte flag_long; /* 1 for the "l" flag, 2 for "ll", 0 by default */
drh3e9aeec2005-08-13 13:39:02 +0000230 etByte done; /* Loop termination flag */
drh2c338a92017-02-10 19:38:36 +0000231 etByte cThousand; /* Thousands separator for %d and %u */
drhad5a9d72016-05-05 11:53:12 +0000232 etByte xtype = etINVALID; /* Conversion paradigm */
drha5c14162013-12-17 15:03:06 +0000233 u8 bArgList; /* True for SQLITE_PRINTF_SQLFUNC */
drhed1fddf2011-10-12 18:52:59 +0000234 char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */
drh27436af2006-03-28 23:57:17 +0000235 sqlite_uint64 longvalue; /* Value for integer types */
drh384eef32004-01-07 03:04:27 +0000236 LONGDOUBLE_TYPE realvalue; /* Value for real types */
drh57196282004-10-06 15:41:16 +0000237 const et_info *infop; /* Pointer to the appropriate info structure */
drh59eedf72011-10-11 17:54:54 +0000238 char *zOut; /* Rendering buffer */
239 int nOut; /* Size of the rendering buffer */
drhaf8f5132014-10-29 18:20:18 +0000240 char *zExtra = 0; /* Malloced memory used by some conversion */
drhb37df7b2005-10-13 02:09:49 +0000241#ifndef SQLITE_OMIT_FLOATING_POINT
drh557cc602005-08-13 12:59:14 +0000242 int exp, e2; /* exponent of real numbers */
drhed1fddf2011-10-12 18:52:59 +0000243 int nsd; /* Number of significant digits returned */
drhe84a3062004-02-02 12:29:25 +0000244 double rounder; /* Used for rounding floating point values */
245 etByte flag_dp; /* True if decimal point should be shown */
246 etByte flag_rtz; /* True if trailing zeros should be removed */
drha18c5682000-10-08 22:20:57 +0000247#endif
drha5c14162013-12-17 15:03:06 +0000248 PrintfArguments *pArgList = 0; /* Arguments for SQLITE_PRINTF_SQLFUNC */
drhed1fddf2011-10-12 18:52:59 +0000249 char buf[etBUFSIZE]; /* Conversion buffer */
drha18c5682000-10-08 22:20:57 +0000250
drhcc398962018-02-20 15:23:37 +0000251 /* pAccum never starts out with an empty buffer that was obtained from
252 ** malloc(). This precondition is required by the mprintf("%z...")
253 ** optimization. */
254 assert( pAccum->nChar>0 || (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
255
drha18c5682000-10-08 22:20:57 +0000256 bufpt = 0;
drh8236f682017-01-04 00:26:28 +0000257 if( (pAccum->printfFlags & SQLITE_PRINTF_SQLFUNC)!=0 ){
258 pArgList = va_arg(ap, PrintfArguments*);
259 bArgList = 1;
drha5c14162013-12-17 15:03:06 +0000260 }else{
drh8236f682017-01-04 00:26:28 +0000261 bArgList = 0;
drha5c14162013-12-17 15:03:06 +0000262 }
drha18c5682000-10-08 22:20:57 +0000263 for(; (c=(*fmt))!=0; ++fmt){
264 if( c!='%' ){
drha18c5682000-10-08 22:20:57 +0000265 bufpt = (char *)fmt;
drh760b1592014-09-18 01:50:09 +0000266#if HAVE_STRCHRNUL
267 fmt = strchrnul(fmt, '%');
268#else
269 do{ fmt++; }while( *fmt && *fmt != '%' );
270#endif
drh0cdbe1a2018-05-09 13:46:26 +0000271 sqlite3_str_append(pAccum, bufpt, (int)(fmt - bufpt));
drh760b1592014-09-18 01:50:09 +0000272 if( *fmt==0 ) break;
drha18c5682000-10-08 22:20:57 +0000273 }
274 if( (c=(*++fmt))==0 ){
drh0cdbe1a2018-05-09 13:46:26 +0000275 sqlite3_str_append(pAccum, "%", 1);
drha18c5682000-10-08 22:20:57 +0000276 break;
277 }
278 /* Find out what flags are present */
drh2c338a92017-02-10 19:38:36 +0000279 flag_leftjustify = flag_prefix = cThousand =
drh557cc602005-08-13 12:59:14 +0000280 flag_alternateform = flag_altform2 = flag_zeropad = 0;
drh3e9aeec2005-08-13 13:39:02 +0000281 done = 0;
drh9a6d01b2019-02-01 18:46:41 +0000282 width = 0;
283 flag_long = 0;
284 precision = -1;
drha18c5682000-10-08 22:20:57 +0000285 do{
286 switch( c ){
drh3e9aeec2005-08-13 13:39:02 +0000287 case '-': flag_leftjustify = 1; break;
drh2c338a92017-02-10 19:38:36 +0000288 case '+': flag_prefix = '+'; break;
289 case ' ': flag_prefix = ' '; break;
drh3e9aeec2005-08-13 13:39:02 +0000290 case '#': flag_alternateform = 1; break;
291 case '!': flag_altform2 = 1; break;
292 case '0': flag_zeropad = 1; break;
drh2c338a92017-02-10 19:38:36 +0000293 case ',': cThousand = ','; break;
drh3e9aeec2005-08-13 13:39:02 +0000294 default: done = 1; break;
drh9a6d01b2019-02-01 18:46:41 +0000295 case 'l': {
296 flag_long = 1;
297 c = *++fmt;
298 if( c=='l' ){
299 c = *++fmt;
300 flag_long = 2;
301 }
302 done = 1;
303 break;
304 }
305 case '1': case '2': case '3': case '4': case '5':
306 case '6': case '7': case '8': case '9': {
307 unsigned wx = c - '0';
308 while( (c = *++fmt)>='0' && c<='9' ){
309 wx = wx*10 + c - '0';
310 }
311 testcase( wx>0x7fffffff );
312 width = wx & 0x7fffffff;
313#ifdef SQLITE_PRINTF_PRECISION_LIMIT
314 if( width>SQLITE_PRINTF_PRECISION_LIMIT ){
315 width = SQLITE_PRINTF_PRECISION_LIMIT;
316 }
317#endif
318 if( c!='.' && c!='l' ){
319 done = 1;
320 }else{
321 fmt--;
322 }
323 break;
324 }
325 case '*': {
326 if( bArgList ){
327 width = (int)getIntArg(pArgList);
328 }else{
329 width = va_arg(ap,int);
330 }
331 if( width<0 ){
332 flag_leftjustify = 1;
333 width = width >= -2147483647 ? -width : 0;
334 }
335#ifdef SQLITE_PRINTF_PRECISION_LIMIT
336 if( width>SQLITE_PRINTF_PRECISION_LIMIT ){
337 width = SQLITE_PRINTF_PRECISION_LIMIT;
338 }
339#endif
340 if( (c = fmt[1])!='.' && c!='l' ){
341 c = *++fmt;
342 done = 1;
343 }
344 break;
345 }
346 case '.': {
347 c = *++fmt;
348 if( c=='*' ){
349 if( bArgList ){
350 precision = (int)getIntArg(pArgList);
351 }else{
352 precision = va_arg(ap,int);
353 }
354 if( precision<0 ){
355 precision = precision >= -2147483647 ? -precision : -1;
356 }
357 c = *++fmt;
358 }else{
359 unsigned px = 0;
360 while( c>='0' && c<='9' ){
361 px = px*10 + c - '0';
362 c = *++fmt;
363 }
364 testcase( px>0x7fffffff );
365 precision = px & 0x7fffffff;
366 }
367#ifdef SQLITE_PRINTF_PRECISION_LIMIT
368 if( precision>SQLITE_PRINTF_PRECISION_LIMIT ){
369 precision = SQLITE_PRINTF_PRECISION_LIMIT;
370 }
371#endif
372 if( c=='l' ){
373 --fmt;
374 }else{
375 done = 1;
376 }
377 break;
378 }
drha18c5682000-10-08 22:20:57 +0000379 }
drh3e9aeec2005-08-13 13:39:02 +0000380 }while( !done && (c=(*++fmt))!=0 );
dan8c069142015-04-07 14:38:57 +0000381
drha18c5682000-10-08 22:20:57 +0000382 /* Fetch the info entry for the field */
drh874ba042009-04-08 16:10:04 +0000383 infop = &fmtinfo[0];
384 xtype = etINVALID;
danielk197700e13612008-11-17 19:18:54 +0000385 for(idx=0; idx<ArraySize(fmtinfo); idx++){
drha18c5682000-10-08 22:20:57 +0000386 if( c==fmtinfo[idx].fmttype ){
387 infop = &fmtinfo[idx];
drh8236f682017-01-04 00:26:28 +0000388 xtype = infop->type;
drha18c5682000-10-08 22:20:57 +0000389 break;
390 }
391 }
drh43617e92006-03-06 20:55:46 +0000392
drha18c5682000-10-08 22:20:57 +0000393 /*
394 ** At this point, variables are initialized as follows:
395 **
396 ** flag_alternateform TRUE if a '#' is present.
drh3e9aeec2005-08-13 13:39:02 +0000397 ** flag_altform2 TRUE if a '!' is present.
drh2c338a92017-02-10 19:38:36 +0000398 ** flag_prefix '+' or ' ' or zero
drha18c5682000-10-08 22:20:57 +0000399 ** flag_leftjustify TRUE if a '-' is present or if the
400 ** field width was negative.
401 ** flag_zeropad TRUE if the width began with 0.
drh2c338a92017-02-10 19:38:36 +0000402 ** flag_long 1 for "l", 2 for "ll"
drha18c5682000-10-08 22:20:57 +0000403 ** width The specified field width. This is
404 ** always non-negative. Zero is the default.
405 ** precision The specified precision. The default
406 ** is -1.
407 ** xtype The class of the conversion.
408 ** infop Pointer to the appropriate info struct.
409 */
drhb6907e22020-05-25 15:41:03 +0000410 assert( width>=0 );
411 assert( precision>=(-1) );
drha18c5682000-10-08 22:20:57 +0000412 switch( xtype ){
drhfe63d1c2004-09-08 20:13:04 +0000413 case etPOINTER:
drh2c338a92017-02-10 19:38:36 +0000414 flag_long = sizeof(char*)==sizeof(i64) ? 2 :
415 sizeof(char*)==sizeof(long int) ? 1 : 0;
drh08b92082020-08-10 14:18:00 +0000416 /* no break */ deliberate_fall_through
drh9a993342007-12-13 02:45:31 +0000417 case etORDINAL:
drh2c338a92017-02-10 19:38:36 +0000418 case etRADIX:
419 cThousand = 0;
drh08b92082020-08-10 14:18:00 +0000420 /* no break */ deliberate_fall_through
drh2c338a92017-02-10 19:38:36 +0000421 case etDECIMAL:
drhe84a3062004-02-02 12:29:25 +0000422 if( infop->flags & FLAG_SIGNED ){
drhe9707672004-06-25 01:10:48 +0000423 i64 v;
drha5c14162013-12-17 15:03:06 +0000424 if( bArgList ){
425 v = getIntArg(pArgList);
drheeb23a42009-05-04 20:20:16 +0000426 }else if( flag_long ){
drh2c338a92017-02-10 19:38:36 +0000427 if( flag_long==2 ){
428 v = va_arg(ap,i64) ;
429 }else{
430 v = va_arg(ap,long int);
431 }
drheeb23a42009-05-04 20:20:16 +0000432 }else{
433 v = va_arg(ap,int);
434 }
drhe9707672004-06-25 01:10:48 +0000435 if( v<0 ){
drhe2678b92020-08-28 12:58:21 +0000436 testcase( v==SMALLEST_INT64 );
437 testcase( v==(-1) );
438 longvalue = ~v;
439 longvalue++;
drhe9707672004-06-25 01:10:48 +0000440 prefix = '-';
danielk1977cfcdaef2004-05-12 07:33:33 +0000441 }else{
drhe9707672004-06-25 01:10:48 +0000442 longvalue = v;
drh2c338a92017-02-10 19:38:36 +0000443 prefix = flag_prefix;
danielk1977cfcdaef2004-05-12 07:33:33 +0000444 }
drhe9707672004-06-25 01:10:48 +0000445 }else{
drha5c14162013-12-17 15:03:06 +0000446 if( bArgList ){
447 longvalue = (u64)getIntArg(pArgList);
drheeb23a42009-05-04 20:20:16 +0000448 }else if( flag_long ){
drh2c338a92017-02-10 19:38:36 +0000449 if( flag_long==2 ){
450 longvalue = va_arg(ap,u64);
451 }else{
452 longvalue = va_arg(ap,unsigned long int);
453 }
drheeb23a42009-05-04 20:20:16 +0000454 }else{
455 longvalue = va_arg(ap,unsigned int);
456 }
drhe9707672004-06-25 01:10:48 +0000457 prefix = 0;
458 }
459 if( longvalue==0 ) flag_alternateform = 0;
drha18c5682000-10-08 22:20:57 +0000460 if( flag_zeropad && precision<width-(prefix!=0) ){
461 precision = width-(prefix!=0);
drh9adf9ac2002-05-15 11:44:13 +0000462 }
drh2c338a92017-02-10 19:38:36 +0000463 if( precision<etBUFSIZE-10-etBUFSIZE/3 ){
drh59eedf72011-10-11 17:54:54 +0000464 nOut = etBUFSIZE;
465 zOut = buf;
466 }else{
drh7ba03ea2019-02-01 21:08:27 +0000467 u64 n;
468 n = (u64)precision + 10;
469 if( cThousand ) n += precision/3;
drh29642252019-02-01 20:29:04 +0000470 zOut = zExtra = printfTempBuf(pAccum, n);
471 if( zOut==0 ) return;
drh5f429952017-03-20 16:34:18 +0000472 nOut = (int)n;
drh59eedf72011-10-11 17:54:54 +0000473 }
474 bufpt = &zOut[nOut-1];
drh9a993342007-12-13 02:45:31 +0000475 if( xtype==etORDINAL ){
drh43f6e062007-12-13 17:50:22 +0000476 static const char zOrd[] = "thstndrd";
drhea678832008-12-10 19:26:22 +0000477 int x = (int)(longvalue % 10);
drh43f6e062007-12-13 17:50:22 +0000478 if( x>=4 || (longvalue/10)%10==1 ){
479 x = 0;
480 }
drh59eedf72011-10-11 17:54:54 +0000481 *(--bufpt) = zOrd[x*2+1];
482 *(--bufpt) = zOrd[x*2];
drh9a993342007-12-13 02:45:31 +0000483 }
drha18c5682000-10-08 22:20:57 +0000484 {
drh0e682092014-03-17 15:06:57 +0000485 const char *cset = &aDigits[infop->charset];
486 u8 base = infop->base;
drha18c5682000-10-08 22:20:57 +0000487 do{ /* Convert to ascii */
488 *(--bufpt) = cset[longvalue%base];
489 longvalue = longvalue/base;
490 }while( longvalue>0 );
drh9adf9ac2002-05-15 11:44:13 +0000491 }
drh59eedf72011-10-11 17:54:54 +0000492 length = (int)(&zOut[nOut-1]-bufpt);
drh2c338a92017-02-10 19:38:36 +0000493 while( precision>length ){
drha18c5682000-10-08 22:20:57 +0000494 *(--bufpt) = '0'; /* Zero pad */
drh2c338a92017-02-10 19:38:36 +0000495 length++;
496 }
497 if( cThousand ){
498 int nn = (length - 1)/3; /* Number of "," to insert */
499 int ix = (length - 1)%3 + 1;
500 bufpt -= nn;
501 for(idx=0; nn>0; idx++){
502 bufpt[idx] = bufpt[idx+nn];
503 ix--;
504 if( ix==0 ){
505 bufpt[++idx] = cThousand;
506 nn--;
507 ix = 3;
508 }
509 }
drh9adf9ac2002-05-15 11:44:13 +0000510 }
drha18c5682000-10-08 22:20:57 +0000511 if( prefix ) *(--bufpt) = prefix; /* Add sign */
512 if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */
drh76ff3a02004-09-24 22:32:30 +0000513 const char *pre;
514 char x;
515 pre = &aPrefix[infop->prefix];
drhaf005fb2008-07-09 16:51:51 +0000516 for(; (x=(*pre))!=0; pre++) *(--bufpt) = x;
drha18c5682000-10-08 22:20:57 +0000517 }
drh59eedf72011-10-11 17:54:54 +0000518 length = (int)(&zOut[nOut-1]-bufpt);
drha18c5682000-10-08 22:20:57 +0000519 break;
520 case etFLOAT:
521 case etEXP:
522 case etGENERIC:
drha5c14162013-12-17 15:03:06 +0000523 if( bArgList ){
524 realvalue = getDoubleArg(pArgList);
525 }else{
526 realvalue = va_arg(ap,double);
527 }
drh69ef7032010-03-04 17:11:31 +0000528#ifdef SQLITE_OMIT_FLOATING_POINT
529 length = 0;
530#else
drha18c5682000-10-08 22:20:57 +0000531 if( precision<0 ) precision = 6; /* Set default precision */
drhdd6c33d2020-05-23 19:58:07 +0000532#ifdef SQLITE_FP_PRECISION_LIMIT
533 if( precision>SQLITE_FP_PRECISION_LIMIT ){
534 precision = SQLITE_FP_PRECISION_LIMIT;
535 }
536#endif
drha18c5682000-10-08 22:20:57 +0000537 if( realvalue<0.0 ){
538 realvalue = -realvalue;
539 prefix = '-';
drh9adf9ac2002-05-15 11:44:13 +0000540 }else{
drh2c338a92017-02-10 19:38:36 +0000541 prefix = flag_prefix;
drh9adf9ac2002-05-15 11:44:13 +0000542 }
drh3e9aeec2005-08-13 13:39:02 +0000543 if( xtype==etGENERIC && precision>0 ) precision--;
drha30d22a2015-04-07 13:28:41 +0000544 testcase( precision>0xfff );
drha0ed86b2019-05-24 22:58:16 +0000545 idx = precision & 0xfff;
546 rounder = arRound[idx%10];
547 while( idx>=10 ){ rounder *= 1.0e-10; idx -= 10; }
548 if( xtype==etFLOAT ){
drhef7d5182019-05-27 00:29:15 +0000549 double rx = (double)realvalue;
550 sqlite3_uint64 u;
551 int ex;
552 memcpy(&u, &rx, sizeof(u));
553 ex = -1023 + (int)((u>>52)&0x7ff);
554 if( precision+(ex/3) < 15 ) rounder += realvalue*3e-16;
drha0ed86b2019-05-24 22:58:16 +0000555 realvalue += rounder;
556 }
drha18c5682000-10-08 22:20:57 +0000557 /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */
558 exp = 0;
drhea678832008-12-10 19:26:22 +0000559 if( sqlite3IsNaN((double)realvalue) ){
drh53c14022007-05-10 17:23:11 +0000560 bufpt = "NaN";
561 length = 3;
562 break;
563 }
drha18c5682000-10-08 22:20:57 +0000564 if( realvalue>0.0 ){
drh72b3fbc2012-06-19 03:11:25 +0000565 LONGDOUBLE_TYPE scale = 1.0;
drh4ef94132012-06-19 03:35:05 +0000566 while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;}
drh2a8f6712015-09-02 21:00:48 +0000567 while( realvalue>=1e10*scale && exp<=350 ){ scale *= 1e10; exp+=10; }
drh72b3fbc2012-06-19 03:11:25 +0000568 while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; }
569 realvalue /= scale;
drh93a960a2008-07-10 00:32:42 +0000570 while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; }
571 while( realvalue<1.0 ){ realvalue *= 10.0; exp--; }
drhaf005fb2008-07-09 16:51:51 +0000572 if( exp>350 ){
drh2a8f6712015-09-02 21:00:48 +0000573 bufpt = buf;
574 buf[0] = prefix;
575 memcpy(buf+(prefix!=0),"Inf",4);
576 length = 3+(prefix!=0);
drha18c5682000-10-08 22:20:57 +0000577 break;
578 }
drh9adf9ac2002-05-15 11:44:13 +0000579 }
drha18c5682000-10-08 22:20:57 +0000580 bufpt = buf;
581 /*
582 ** If the field type is etGENERIC, then convert to either etEXP
583 ** or etFLOAT, as appropriate.
584 */
drha18c5682000-10-08 22:20:57 +0000585 if( xtype!=etFLOAT ){
586 realvalue += rounder;
587 if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; }
588 }
589 if( xtype==etGENERIC ){
590 flag_rtz = !flag_alternateform;
591 if( exp<-4 || exp>precision ){
592 xtype = etEXP;
593 }else{
594 precision = precision - exp;
595 xtype = etFLOAT;
596 }
drh9adf9ac2002-05-15 11:44:13 +0000597 }else{
drh72b3fbc2012-06-19 03:11:25 +0000598 flag_rtz = flag_altform2;
drh9adf9ac2002-05-15 11:44:13 +0000599 }
drh557cc602005-08-13 12:59:14 +0000600 if( xtype==etEXP ){
601 e2 = 0;
602 }else{
603 e2 = exp;
604 }
drh29642252019-02-01 20:29:04 +0000605 {
606 i64 szBufNeeded; /* Size of a temporary buffer needed */
607 szBufNeeded = MAX(e2,0)+(i64)precision+(i64)width+15;
608 if( szBufNeeded > etBUFSIZE ){
609 bufpt = zExtra = printfTempBuf(pAccum, szBufNeeded);
610 if( bufpt==0 ) return;
drh59eedf72011-10-11 17:54:54 +0000611 }
612 }
613 zOut = bufpt;
drh72b3fbc2012-06-19 03:11:25 +0000614 nsd = 16 + flag_altform2*10;
drhea678832008-12-10 19:26:22 +0000615 flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2;
drh557cc602005-08-13 12:59:14 +0000616 /* The sign in front of the number */
617 if( prefix ){
618 *(bufpt++) = prefix;
619 }
620 /* Digits prior to the decimal point */
621 if( e2<0 ){
622 *(bufpt++) = '0';
623 }else{
624 for(; e2>=0; e2--){
625 *(bufpt++) = et_getdigit(&realvalue,&nsd);
drha18c5682000-10-08 22:20:57 +0000626 }
drh9adf9ac2002-05-15 11:44:13 +0000627 }
drh557cc602005-08-13 12:59:14 +0000628 /* The decimal point */
629 if( flag_dp ){
630 *(bufpt++) = '.';
631 }
632 /* "0" digits after the decimal point but before the first
633 ** significant digit of the number */
drhaf005fb2008-07-09 16:51:51 +0000634 for(e2++; e2<0; precision--, e2++){
635 assert( precision>0 );
drh557cc602005-08-13 12:59:14 +0000636 *(bufpt++) = '0';
637 }
638 /* Significant digits after the decimal point */
639 while( (precision--)>0 ){
640 *(bufpt++) = et_getdigit(&realvalue,&nsd);
641 }
642 /* Remove trailing zeros and the "." if no digits follow the "." */
643 if( flag_rtz && flag_dp ){
drh3e9aeec2005-08-13 13:39:02 +0000644 while( bufpt[-1]=='0' ) *(--bufpt) = 0;
drh59eedf72011-10-11 17:54:54 +0000645 assert( bufpt>zOut );
drh3e9aeec2005-08-13 13:39:02 +0000646 if( bufpt[-1]=='.' ){
drh557cc602005-08-13 12:59:14 +0000647 if( flag_altform2 ){
648 *(bufpt++) = '0';
649 }else{
650 *(--bufpt) = 0;
651 }
652 }
653 }
654 /* Add the "eNNN" suffix */
drh59eedf72011-10-11 17:54:54 +0000655 if( xtype==etEXP ){
drh557cc602005-08-13 12:59:14 +0000656 *(bufpt++) = aDigits[infop->charset];
657 if( exp<0 ){
658 *(bufpt++) = '-'; exp = -exp;
659 }else{
660 *(bufpt++) = '+';
661 }
662 if( exp>=100 ){
drhea678832008-12-10 19:26:22 +0000663 *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */
drh557cc602005-08-13 12:59:14 +0000664 exp %= 100;
665 }
drhea678832008-12-10 19:26:22 +0000666 *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */
667 *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */
drh557cc602005-08-13 12:59:14 +0000668 }
669 *bufpt = 0;
670
drha18c5682000-10-08 22:20:57 +0000671 /* The converted number is in buf[] and zero terminated. Output it.
672 ** Note that the number is in the usual order, not reversed as with
673 ** integer conversions. */
drh59eedf72011-10-11 17:54:54 +0000674 length = (int)(bufpt-zOut);
675 bufpt = zOut;
drha18c5682000-10-08 22:20:57 +0000676
677 /* Special case: Add leading zeros if the flag_zeropad flag is
678 ** set and we are not left justified */
679 if( flag_zeropad && !flag_leftjustify && length < width){
680 int i;
681 int nPad = width - length;
682 for(i=width; i>=nPad; i--){
683 bufpt[i] = bufpt[i-nPad];
684 }
685 i = prefix!=0;
686 while( nPad-- ) bufpt[i++] = '0';
687 length = width;
688 }
drh69ef7032010-03-04 17:11:31 +0000689#endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */
drha18c5682000-10-08 22:20:57 +0000690 break;
691 case etSIZE:
drhfc6ee9d2013-12-17 15:58:42 +0000692 if( !bArgList ){
693 *(va_arg(ap,int*)) = pAccum->nChar;
694 }
drha18c5682000-10-08 22:20:57 +0000695 length = width = 0;
696 break;
697 case etPERCENT:
698 buf[0] = '%';
699 bufpt = buf;
700 length = 1;
701 break;
drha18c5682000-10-08 22:20:57 +0000702 case etCHARX:
drha5c14162013-12-17 15:03:06 +0000703 if( bArgList ){
drhfc6ee9d2013-12-17 15:58:42 +0000704 bufpt = getTextArg(pArgList);
drha15a7c32018-02-19 21:58:16 +0000705 length = 1;
drh136102b2018-02-19 18:56:52 +0000706 if( bufpt ){
707 buf[0] = c = *(bufpt++);
drh136102b2018-02-19 18:56:52 +0000708 if( (c&0xc0)==0xc0 ){
709 while( length<4 && (bufpt[0]&0xc0)==0x80 ){
710 buf[length++] = *(bufpt++);
711 }
712 }
drha15a7c32018-02-19 21:58:16 +0000713 }else{
714 buf[0] = 0;
drh136102b2018-02-19 18:56:52 +0000715 }
drha5c14162013-12-17 15:03:06 +0000716 }else{
drh136102b2018-02-19 18:56:52 +0000717 unsigned int ch = va_arg(ap,unsigned int);
718 if( ch<0x00080 ){
719 buf[0] = ch & 0xff;
720 length = 1;
721 }else if( ch<0x00800 ){
722 buf[0] = 0xc0 + (u8)((ch>>6)&0x1f);
723 buf[1] = 0x80 + (u8)(ch & 0x3f);
724 length = 2;
725 }else if( ch<0x10000 ){
726 buf[0] = 0xe0 + (u8)((ch>>12)&0x0f);
727 buf[1] = 0x80 + (u8)((ch>>6) & 0x3f);
728 buf[2] = 0x80 + (u8)(ch & 0x3f);
729 length = 3;
730 }else{
731 buf[0] = 0xf0 + (u8)((ch>>18) & 0x07);
732 buf[1] = 0x80 + (u8)((ch>>12) & 0x3f);
733 buf[2] = 0x80 + (u8)((ch>>6) & 0x3f);
734 buf[3] = 0x80 + (u8)(ch & 0x3f);
735 length = 4;
736 }
drha5c14162013-12-17 15:03:06 +0000737 }
drhaf8f5132014-10-29 18:20:18 +0000738 if( precision>1 ){
739 width -= precision-1;
740 if( width>1 && !flag_leftjustify ){
drh0cdbe1a2018-05-09 13:46:26 +0000741 sqlite3_str_appendchar(pAccum, width-1, ' ');
drhaf8f5132014-10-29 18:20:18 +0000742 width = 0;
743 }
drh136102b2018-02-19 18:56:52 +0000744 while( precision-- > 1 ){
drh0cdbe1a2018-05-09 13:46:26 +0000745 sqlite3_str_append(pAccum, buf, length);
drh136102b2018-02-19 18:56:52 +0000746 }
drh9adf9ac2002-05-15 11:44:13 +0000747 }
drha18c5682000-10-08 22:20:57 +0000748 bufpt = buf;
drhcf7c8372018-02-19 20:23:20 +0000749 flag_altform2 = 1;
750 goto adjust_width_for_utf8;
drha18c5682000-10-08 22:20:57 +0000751 case etSTRING:
drhd93d8a82003-06-16 03:08:18 +0000752 case etDYNSTRING:
drha5c14162013-12-17 15:03:06 +0000753 if( bArgList ){
754 bufpt = getTextArg(pArgList);
drh2a8f6712015-09-02 21:00:48 +0000755 xtype = etSTRING;
drha5c14162013-12-17 15:03:06 +0000756 }else{
757 bufpt = va_arg(ap,char*);
758 }
drhd93d8a82003-06-16 03:08:18 +0000759 if( bufpt==0 ){
760 bufpt = "";
drh2a8f6712015-09-02 21:00:48 +0000761 }else if( xtype==etDYNSTRING ){
drhaf524a62018-09-13 17:07:12 +0000762 if( pAccum->nChar==0
763 && pAccum->mxAlloc
764 && width==0
765 && precision<0
766 && pAccum->accError==0
767 ){
drhcc398962018-02-20 15:23:37 +0000768 /* Special optimization for sqlite3_mprintf("%z..."):
769 ** Extend an existing memory allocation rather than creating
770 ** a new one. */
771 assert( (pAccum->printfFlags&SQLITE_PRINTF_MALLOCED)==0 );
772 pAccum->zText = bufpt;
773 pAccum->nAlloc = sqlite3DbMallocSize(pAccum->db, bufpt);
774 pAccum->nChar = 0x7fffffff & (int)strlen(bufpt);
775 pAccum->printfFlags |= SQLITE_PRINTF_MALLOCED;
776 length = 0;
777 break;
778 }
drhd93d8a82003-06-16 03:08:18 +0000779 zExtra = bufpt;
780 }
drhe5090942008-04-29 15:22:27 +0000781 if( precision>=0 ){
drh62856462018-02-19 17:03:23 +0000782 if( flag_altform2 ){
783 /* Set length to the number of bytes needed in order to display
784 ** precision characters */
785 unsigned char *z = (unsigned char*)bufpt;
786 while( precision-- > 0 && z[0] ){
787 SQLITE_SKIP_UTF8(z);
788 }
789 length = (int)(z - (unsigned char*)bufpt);
790 }else{
791 for(length=0; length<precision && bufpt[length]; length++){}
792 }
drhe5090942008-04-29 15:22:27 +0000793 }else{
drhc84ddf12017-08-19 20:38:18 +0000794 length = 0x7fffffff & (int)strlen(bufpt);
drhe5090942008-04-29 15:22:27 +0000795 }
drh57e3ba72018-02-19 18:03:10 +0000796 adjust_width_for_utf8:
drh62856462018-02-19 17:03:23 +0000797 if( flag_altform2 && width>0 ){
798 /* Adjust width to account for extra bytes in UTF-8 characters */
799 int ii = length - 1;
800 while( ii>=0 ) if( (bufpt[ii--] & 0xc0)==0x80 ) width++;
801 }
drha18c5682000-10-08 22:20:57 +0000802 break;
drh57e3ba72018-02-19 18:03:10 +0000803 case etSQLESCAPE: /* %q: Escape ' characters */
804 case etSQLESCAPE2: /* %Q: Escape ' and enclose in '...' */
805 case etSQLESCAPE3: { /* %w: Escape " characters */
drh8965b502009-11-25 16:53:37 +0000806 int i, j, k, n, isnull;
drh5eba8c02005-08-19 02:26:27 +0000807 int needQuote;
drhea678832008-12-10 19:26:22 +0000808 char ch;
danielk1977f3b863e2007-06-24 06:32:17 +0000809 char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */
drha5c14162013-12-17 15:03:06 +0000810 char *escarg;
811
812 if( bArgList ){
813 escarg = getTextArg(pArgList);
814 }else{
815 escarg = va_arg(ap,char*);
816 }
danielk1977f0113002006-01-24 12:09:17 +0000817 isnull = escarg==0;
818 if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)");
drhb6907e22020-05-25 15:41:03 +0000819 /* For %q, %Q, and %w, the precision is the number of bytes (or
drh57e3ba72018-02-19 18:03:10 +0000820 ** characters if the ! flags is present) to use from the input.
821 ** Because of the extra quoting characters inserted, the number
822 ** of output characters may be larger than the precision.
823 */
drh8965b502009-11-25 16:53:37 +0000824 k = precision;
dan60d4a302010-03-04 17:58:45 +0000825 for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){
danielk1977f3b863e2007-06-24 06:32:17 +0000826 if( ch==q ) n++;
drh57e3ba72018-02-19 18:03:10 +0000827 if( flag_altform2 && (ch&0xc0)==0xc0 ){
828 while( (escarg[i+1]&0xc0)==0x80 ){ i++; }
829 }
drha18c5682000-10-08 22:20:57 +0000830 }
drh5eba8c02005-08-19 02:26:27 +0000831 needQuote = !isnull && xtype==etSQLESCAPE2;
drh2a8f6712015-09-02 21:00:48 +0000832 n += i + 3;
drh5eba8c02005-08-19 02:26:27 +0000833 if( n>etBUFSIZE ){
drh29642252019-02-01 20:29:04 +0000834 bufpt = zExtra = printfTempBuf(pAccum, n);
835 if( bufpt==0 ) return;
drh5eba8c02005-08-19 02:26:27 +0000836 }else{
837 bufpt = buf;
838 }
839 j = 0;
danielk1977f3b863e2007-06-24 06:32:17 +0000840 if( needQuote ) bufpt[j++] = q;
drh8965b502009-11-25 16:53:37 +0000841 k = i;
842 for(i=0; i<k; i++){
843 bufpt[j++] = ch = escarg[i];
danielk1977f3b863e2007-06-24 06:32:17 +0000844 if( ch==q ) bufpt[j++] = ch;
drh5eba8c02005-08-19 02:26:27 +0000845 }
danielk1977f3b863e2007-06-24 06:32:17 +0000846 if( needQuote ) bufpt[j++] = q;
drh5eba8c02005-08-19 02:26:27 +0000847 bufpt[j] = 0;
848 length = j;
drh57e3ba72018-02-19 18:03:10 +0000849 goto adjust_width_for_utf8;
drh5eba8c02005-08-19 02:26:27 +0000850 }
drh5f968432004-02-21 19:02:30 +0000851 case etTOKEN: {
drh8236f682017-01-04 00:26:28 +0000852 Token *pToken;
853 if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
854 pToken = va_arg(ap, Token*);
drha5c14162013-12-17 15:03:06 +0000855 assert( bArgList==0 );
drha9ab4812013-12-11 11:00:44 +0000856 if( pToken && pToken->n ){
drh0cdbe1a2018-05-09 13:46:26 +0000857 sqlite3_str_append(pAccum, (const char*)pToken->z, pToken->n);
drhf62641e2021-12-24 20:22:13 +0000858 sqlite3RecordErrorByteOffset(pAccum->db, pToken->z);
drhad6d9462004-09-19 02:15:24 +0000859 }
drh5f968432004-02-21 19:02:30 +0000860 length = width = 0;
861 break;
862 }
drha9799932021-03-19 13:00:28 +0000863 case etSRCITEM: {
drh76012942021-02-21 21:04:54 +0000864 SrcItem *pItem;
drh8236f682017-01-04 00:26:28 +0000865 if( (pAccum->printfFlags & SQLITE_PRINTF_INTERNAL)==0 ) return;
drha9799932021-03-19 13:00:28 +0000866 pItem = va_arg(ap, SrcItem*);
drha5c14162013-12-17 15:03:06 +0000867 assert( bArgList==0 );
drh2f2091b2021-03-20 15:46:01 +0000868 if( pItem->zAlias && !flag_altform2 ){
drh82102332021-03-20 15:11:29 +0000869 sqlite3_str_appendall(pAccum, pItem->zAlias);
870 }else if( pItem->zName ){
871 if( pItem->zDatabase ){
872 sqlite3_str_appendall(pAccum, pItem->zDatabase);
873 sqlite3_str_append(pAccum, ".", 1);
874 }
drha9799932021-03-19 13:00:28 +0000875 sqlite3_str_appendall(pAccum, pItem->zName);
drh2f2091b2021-03-20 15:46:01 +0000876 }else if( pItem->zAlias ){
877 sqlite3_str_appendall(pAccum, pItem->zAlias);
drh5191ae02021-03-23 21:02:24 +0000878 }else if( ALWAYS(pItem->pSelect) ){
drh6610e6a2021-03-19 19:44:56 +0000879 sqlite3_str_appendf(pAccum, "SUBQUERY %u", pItem->pSelect->selId);
drha9799932021-03-19 13:00:28 +0000880 }
drh5f968432004-02-21 19:02:30 +0000881 length = width = 0;
882 break;
883 }
drh874ba042009-04-08 16:10:04 +0000884 default: {
885 assert( xtype==etINVALID );
886 return;
887 }
drha18c5682000-10-08 22:20:57 +0000888 }/* End switch over the format type */
889 /*
890 ** The text of the conversion is pointed to by "bufpt" and is
891 ** "length" characters long. The field width is "width". Do
drh62856462018-02-19 17:03:23 +0000892 ** the output. Both length and width are in bytes, not characters,
893 ** at this point. If the "!" flag was present on string conversions
894 ** indicating that width and precision should be expressed in characters,
895 ** then the values have been translated prior to reaching this point.
drha18c5682000-10-08 22:20:57 +0000896 */
drha70a0732014-03-17 14:24:27 +0000897 width -= length;
drh8236f682017-01-04 00:26:28 +0000898 if( width>0 ){
drh0cdbe1a2018-05-09 13:46:26 +0000899 if( !flag_leftjustify ) sqlite3_str_appendchar(pAccum, width, ' ');
900 sqlite3_str_append(pAccum, bufpt, length);
901 if( flag_leftjustify ) sqlite3_str_appendchar(pAccum, width, ' ');
drh8236f682017-01-04 00:26:28 +0000902 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000903 sqlite3_str_append(pAccum, bufpt, length);
drh8236f682017-01-04 00:26:28 +0000904 }
drha70a0732014-03-17 14:24:27 +0000905
drhaf8f5132014-10-29 18:20:18 +0000906 if( zExtra ){
drh96ceaf82015-11-14 22:04:22 +0000907 sqlite3DbFree(pAccum->db, zExtra);
drhaf8f5132014-10-29 18:20:18 +0000908 zExtra = 0;
909 }
drha18c5682000-10-08 22:20:57 +0000910 }/* End for loop over the format string */
drha18c5682000-10-08 22:20:57 +0000911} /* End of function */
912
drhf62641e2021-12-24 20:22:13 +0000913
914/*
915** The z string points to the first character of a token that is
916** associated with an error. If db does not already have an error
917** byte offset recorded, try to compute the error byte offset for
918** z and set the error byte offset in db.
919*/
920void sqlite3RecordErrorByteOffset(sqlite3 *db, const char *z){
921 const Parse *pParse;
922 const char *zText;
923 const char *zEnd;
924 assert( z!=0 );
925 if( NEVER(db==0) ) return;
926 if( db->errByteOffset!=(-2) ) return;
927 pParse = db->pParse;
928 if( NEVER(pParse==0) ) return;
929 zText =pParse->zTail;
930 if( NEVER(zText==0) ) return;
931 zEnd = &zText[strlen(zText)];
932 if( SQLITE_WITHIN(z,zText,zEnd) ){
933 db->errByteOffset = (int)(z-zText);
934 }
935}
936
drhade86482007-11-28 22:36:40 +0000937/*
drha70a0732014-03-17 14:24:27 +0000938** Enlarge the memory allocation on a StrAccum object so that it is
939** able to accept at least N more bytes of text.
940**
941** Return the number of bytes of text that StrAccum is able to accept
942** after the attempted enlargement. The value returned might be zero.
943*/
drhef95d552021-12-10 21:01:24 +0000944int sqlite3StrAccumEnlarge(StrAccum *p, int N){
drha70a0732014-03-17 14:24:27 +0000945 char *zNew;
drha30d22a2015-04-07 13:28:41 +0000946 assert( p->nChar+(i64)N >= p->nAlloc ); /* Only called if really needed */
drha70a0732014-03-17 14:24:27 +0000947 if( p->accError ){
drh0cdbe1a2018-05-09 13:46:26 +0000948 testcase(p->accError==SQLITE_TOOBIG);
949 testcase(p->accError==SQLITE_NOMEM);
drha70a0732014-03-17 14:24:27 +0000950 return 0;
951 }
drhc0490572015-05-02 11:45:53 +0000952 if( p->mxAlloc==0 ){
drhf06db3e2021-10-01 00:25:06 +0000953 sqlite3StrAccumSetError(p, SQLITE_TOOBIG);
drh255a81f2019-02-22 15:42:10 +0000954 return p->nAlloc - p->nChar - 1;
drha70a0732014-03-17 14:24:27 +0000955 }else{
drh5f4a6862016-01-30 12:50:25 +0000956 char *zOld = isMalloced(p) ? p->zText : 0;
drha70a0732014-03-17 14:24:27 +0000957 i64 szNew = p->nChar;
drhbb059762021-03-02 21:07:41 +0000958 szNew += (sqlite3_int64)N + 1;
drh7b4d7802014-11-03 14:46:29 +0000959 if( szNew+p->nChar<=p->mxAlloc ){
960 /* Force exponential buffer size growth as long as it does not overflow,
961 ** to avoid having to call this routine too often */
962 szNew += p->nChar;
963 }
drha70a0732014-03-17 14:24:27 +0000964 if( szNew > p->mxAlloc ){
drh0cdbe1a2018-05-09 13:46:26 +0000965 sqlite3_str_reset(p);
drhf06db3e2021-10-01 00:25:06 +0000966 sqlite3StrAccumSetError(p, SQLITE_TOOBIG);
drha70a0732014-03-17 14:24:27 +0000967 return 0;
968 }else{
969 p->nAlloc = (int)szNew;
970 }
drhc0490572015-05-02 11:45:53 +0000971 if( p->db ){
drha70a0732014-03-17 14:24:27 +0000972 zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc);
973 }else{
drhd924e7b2020-05-17 00:26:44 +0000974 zNew = sqlite3Realloc(zOld, p->nAlloc);
drha70a0732014-03-17 14:24:27 +0000975 }
976 if( zNew ){
drh7ef4d1c2014-05-31 15:39:53 +0000977 assert( p->zText!=0 || p->nChar==0 );
drh5f4a6862016-01-30 12:50:25 +0000978 if( !isMalloced(p) && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar);
drha70a0732014-03-17 14:24:27 +0000979 p->zText = zNew;
drh7f5a7ec2014-11-03 13:24:12 +0000980 p->nAlloc = sqlite3DbMallocSize(p->db, zNew);
drh5f4a6862016-01-30 12:50:25 +0000981 p->printfFlags |= SQLITE_PRINTF_MALLOCED;
drha70a0732014-03-17 14:24:27 +0000982 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000983 sqlite3_str_reset(p);
drhf06db3e2021-10-01 00:25:06 +0000984 sqlite3StrAccumSetError(p, SQLITE_NOMEM);
drha70a0732014-03-17 14:24:27 +0000985 return 0;
986 }
987 }
988 return N;
989}
990
991/*
drhaf8f5132014-10-29 18:20:18 +0000992** Append N copies of character c to the given string buffer.
drha70a0732014-03-17 14:24:27 +0000993*/
drh0cdbe1a2018-05-09 13:46:26 +0000994void sqlite3_str_appendchar(sqlite3_str *p, int N, char c){
drha30d22a2015-04-07 13:28:41 +0000995 testcase( p->nChar + (i64)N > 0x7fffffff );
996 if( p->nChar+(i64)N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ){
997 return;
998 }
drhaf8f5132014-10-29 18:20:18 +0000999 while( (N--)>0 ) p->zText[p->nChar++] = c;
drha70a0732014-03-17 14:24:27 +00001000}
1001
1002/*
1003** The StrAccum "p" is not large enough to accept N new bytes of z[].
1004** So enlarge if first, then do the append.
1005**
drh0cdbe1a2018-05-09 13:46:26 +00001006** This is a helper routine to sqlite3_str_append() that does special-case
drha70a0732014-03-17 14:24:27 +00001007** work (enlarging the buffer) using tail recursion, so that the
drh0cdbe1a2018-05-09 13:46:26 +00001008** sqlite3_str_append() routine can use fast calling semantics.
drha70a0732014-03-17 14:24:27 +00001009*/
drh172087f2014-08-22 15:40:20 +00001010static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){
drha70a0732014-03-17 14:24:27 +00001011 N = sqlite3StrAccumEnlarge(p, N);
1012 if( N>0 ){
1013 memcpy(&p->zText[p->nChar], z, N);
1014 p->nChar += N;
1015 }
1016}
1017
1018/*
1019** Append N bytes of text from z to the StrAccum object. Increase the
1020** size of the memory allocation for StrAccum if necessary.
drha18c5682000-10-08 22:20:57 +00001021*/
drh0cdbe1a2018-05-09 13:46:26 +00001022void sqlite3_str_append(sqlite3_str *p, const char *z, int N){
drh34573382015-04-15 05:38:35 +00001023 assert( z!=0 || N==0 );
drha6353a32013-12-09 19:03:26 +00001024 assert( p->zText!=0 || p->nChar==0 || p->accError );
1025 assert( N>=0 );
drh255a81f2019-02-22 15:42:10 +00001026 assert( p->accError==0 || p->nAlloc==0 || p->mxAlloc==0 );
drhade86482007-11-28 22:36:40 +00001027 if( p->nChar+N >= p->nAlloc ){
drha70a0732014-03-17 14:24:27 +00001028 enlargeAndAppend(p,z,N);
dan895decf2016-12-30 14:15:56 +00001029 }else if( N ){
drh172087f2014-08-22 15:40:20 +00001030 assert( p->zText );
1031 p->nChar += N;
1032 memcpy(&p->zText[p->nChar-N], z, N);
drh5f968432004-02-21 19:02:30 +00001033 }
drh483750b2003-01-29 18:46:51 +00001034}
1035
1036/*
drha6353a32013-12-09 19:03:26 +00001037** Append the complete text of zero-terminated string z[] to the p string.
1038*/
drh0cdbe1a2018-05-09 13:46:26 +00001039void sqlite3_str_appendall(sqlite3_str *p, const char *z){
1040 sqlite3_str_append(p, z, sqlite3Strlen30(z));
drha6353a32013-12-09 19:03:26 +00001041}
1042
1043
1044/*
drhade86482007-11-28 22:36:40 +00001045** Finish off a string by making sure it is zero-terminated.
1046** Return a pointer to the resulting string. Return a NULL
1047** pointer if any kind of error was encountered.
drh5f968432004-02-21 19:02:30 +00001048*/
drh043e5862016-11-25 15:11:26 +00001049static SQLITE_NOINLINE char *strAccumFinishRealloc(StrAccum *p){
drh3f18e6d2017-08-12 02:01:55 +00001050 char *zText;
drh043e5862016-11-25 15:11:26 +00001051 assert( p->mxAlloc>0 && !isMalloced(p) );
drh3f18e6d2017-08-12 02:01:55 +00001052 zText = sqlite3DbMallocRaw(p->db, p->nChar+1 );
1053 if( zText ){
1054 memcpy(zText, p->zText, p->nChar+1);
drh043e5862016-11-25 15:11:26 +00001055 p->printfFlags |= SQLITE_PRINTF_MALLOCED;
1056 }else{
drhf06db3e2021-10-01 00:25:06 +00001057 sqlite3StrAccumSetError(p, SQLITE_NOMEM);
drh043e5862016-11-25 15:11:26 +00001058 }
drh3f18e6d2017-08-12 02:01:55 +00001059 p->zText = zText;
1060 return zText;
drh043e5862016-11-25 15:11:26 +00001061}
drhade86482007-11-28 22:36:40 +00001062char *sqlite3StrAccumFinish(StrAccum *p){
1063 if( p->zText ){
1064 p->zText[p->nChar] = 0;
drh5f4a6862016-01-30 12:50:25 +00001065 if( p->mxAlloc>0 && !isMalloced(p) ){
drh043e5862016-11-25 15:11:26 +00001066 return strAccumFinishRealloc(p);
drhade86482007-11-28 22:36:40 +00001067 }
1068 }
1069 return p->zText;
1070}
1071
drhf80bba92018-05-16 15:35:03 +00001072/*
drh5bf47152021-10-03 00:12:43 +00001073** Use the content of the StrAccum passed as the second argument
1074** as the result of an SQL function.
1075*/
1076void sqlite3ResultStrAccum(sqlite3_context *pCtx, StrAccum *p){
1077 if( p->accError ){
1078 sqlite3_result_error_code(pCtx, p->accError);
1079 sqlite3_str_reset(p);
1080 }else if( isMalloced(p) ){
1081 sqlite3_result_text(pCtx, p->zText, p->nChar, SQLITE_DYNAMIC);
1082 }else{
1083 sqlite3_result_text(pCtx, "", 0, SQLITE_STATIC);
1084 sqlite3_str_reset(p);
1085 }
1086}
1087
1088/*
drhf80bba92018-05-16 15:35:03 +00001089** This singleton is an sqlite3_str object that is returned if
1090** sqlite3_malloc() fails to provide space for a real one. This
1091** sqlite3_str object accepts no new text and always returns
1092** an SQLITE_NOMEM error.
1093*/
1094static sqlite3_str sqlite3OomStr = {
drh3e62ddb2018-05-30 00:59:09 +00001095 0, 0, 0, 0, 0, SQLITE_NOMEM, 0
drhf80bba92018-05-16 15:35:03 +00001096};
1097
drh0cdbe1a2018-05-09 13:46:26 +00001098/* Finalize a string created using sqlite3_str_new().
1099*/
1100char *sqlite3_str_finish(sqlite3_str *p){
1101 char *z;
drhf80bba92018-05-16 15:35:03 +00001102 if( p!=0 && p!=&sqlite3OomStr ){
drh0cdbe1a2018-05-09 13:46:26 +00001103 z = sqlite3StrAccumFinish(p);
drh446135d2018-05-09 14:29:40 +00001104 sqlite3_free(p);
drh0cdbe1a2018-05-09 13:46:26 +00001105 }else{
1106 z = 0;
1107 }
1108 return z;
1109}
1110
1111/* Return any error code associated with p */
1112int sqlite3_str_errcode(sqlite3_str *p){
1113 return p ? p->accError : SQLITE_NOMEM;
1114}
1115
1116/* Return the current length of p in bytes */
1117int sqlite3_str_length(sqlite3_str *p){
1118 return p ? p->nChar : 0;
1119}
1120
1121/* Return the current value for p */
1122char *sqlite3_str_value(sqlite3_str *p){
drh446135d2018-05-09 14:29:40 +00001123 if( p==0 || p->nChar==0 ) return 0;
1124 p->zText[p->nChar] = 0;
1125 return p->zText;
drh0cdbe1a2018-05-09 13:46:26 +00001126}
1127
drhade86482007-11-28 22:36:40 +00001128/*
1129** Reset an StrAccum string. Reclaim all malloced memory.
1130*/
drh0cdbe1a2018-05-09 13:46:26 +00001131void sqlite3_str_reset(StrAccum *p){
drh5f4a6862016-01-30 12:50:25 +00001132 if( isMalloced(p) ){
drhc0490572015-05-02 11:45:53 +00001133 sqlite3DbFree(p->db, p->zText);
drh5f4a6862016-01-30 12:50:25 +00001134 p->printfFlags &= ~SQLITE_PRINTF_MALLOCED;
drhade86482007-11-28 22:36:40 +00001135 }
drh446135d2018-05-09 14:29:40 +00001136 p->nAlloc = 0;
1137 p->nChar = 0;
drhf089aa42008-07-08 19:34:06 +00001138 p->zText = 0;
drhade86482007-11-28 22:36:40 +00001139}
1140
1141/*
drhc0490572015-05-02 11:45:53 +00001142** Initialize a string accumulator.
1143**
1144** p: The accumulator to be initialized.
1145** db: Pointer to a database connection. May be NULL. Lookaside
1146** memory is used if not NULL. db->mallocFailed is set appropriately
1147** when not NULL.
1148** zBase: An initial buffer. May be NULL in which case the initial buffer
1149** is malloced.
1150** n: Size of zBase in bytes. If total space requirements never exceed
1151** n then no memory allocations ever occur.
1152** mx: Maximum number of bytes to accumulate. If mx==0 then no memory
1153** allocations will ever occur.
drhade86482007-11-28 22:36:40 +00001154*/
drhc0490572015-05-02 11:45:53 +00001155void sqlite3StrAccumInit(StrAccum *p, sqlite3 *db, char *zBase, int n, int mx){
drh3f18e6d2017-08-12 02:01:55 +00001156 p->zText = zBase;
drhc0490572015-05-02 11:45:53 +00001157 p->db = db;
drhade86482007-11-28 22:36:40 +00001158 p->nAlloc = n;
drhbb4957f2008-03-20 14:03:29 +00001159 p->mxAlloc = mx;
drh3f18e6d2017-08-12 02:01:55 +00001160 p->nChar = 0;
drhb49bc862013-08-21 21:12:10 +00001161 p->accError = 0;
drh5f4a6862016-01-30 12:50:25 +00001162 p->printfFlags = 0;
drh5f968432004-02-21 19:02:30 +00001163}
1164
drh0cdbe1a2018-05-09 13:46:26 +00001165/* Allocate and initialize a new dynamic string object */
1166sqlite3_str *sqlite3_str_new(sqlite3 *db){
drh446135d2018-05-09 14:29:40 +00001167 sqlite3_str *p = sqlite3_malloc64(sizeof(*p));
drh0cdbe1a2018-05-09 13:46:26 +00001168 if( p ){
drh446135d2018-05-09 14:29:40 +00001169 sqlite3StrAccumInit(p, 0, 0, 0,
1170 db ? db->aLimit[SQLITE_LIMIT_LENGTH] : SQLITE_MAX_LENGTH);
drhf80bba92018-05-16 15:35:03 +00001171 }else{
1172 p = &sqlite3OomStr;
drh0cdbe1a2018-05-09 13:46:26 +00001173 }
1174 return p;
1175}
1176
drh5f968432004-02-21 19:02:30 +00001177/*
1178** Print into memory obtained from sqliteMalloc(). Use the internal
1179** %-conversion extensions.
1180*/
drh17435752007-08-16 04:30:38 +00001181char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){
1182 char *z;
drh79158e12005-09-06 21:40:45 +00001183 char zBase[SQLITE_PRINT_BUF_SIZE];
drhade86482007-11-28 22:36:40 +00001184 StrAccum acc;
drhbc6160b2009-04-08 15:45:31 +00001185 assert( db!=0 );
drhc0490572015-05-02 11:45:53 +00001186 sqlite3StrAccumInit(&acc, db, zBase, sizeof(zBase),
drhbc6160b2009-04-08 15:45:31 +00001187 db->aLimit[SQLITE_LIMIT_LENGTH]);
drh5f4a6862016-01-30 12:50:25 +00001188 acc.printfFlags = SQLITE_PRINTF_INTERNAL;
drh0cdbe1a2018-05-09 13:46:26 +00001189 sqlite3_str_vappendf(&acc, zFormat, ap);
drhade86482007-11-28 22:36:40 +00001190 z = sqlite3StrAccumFinish(&acc);
drh0cdbe1a2018-05-09 13:46:26 +00001191 if( acc.accError==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +00001192 sqlite3OomFault(db);
drh17435752007-08-16 04:30:38 +00001193 }
1194 return z;
drh5f968432004-02-21 19:02:30 +00001195}
1196
1197/*
1198** Print into memory obtained from sqliteMalloc(). Use the internal
1199** %-conversion extensions.
1200*/
drh17435752007-08-16 04:30:38 +00001201char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){
drh5f968432004-02-21 19:02:30 +00001202 va_list ap;
1203 char *z;
drh5f968432004-02-21 19:02:30 +00001204 va_start(ap, zFormat);
drhade86482007-11-28 22:36:40 +00001205 z = sqlite3VMPrintf(db, zFormat, ap);
drh5f968432004-02-21 19:02:30 +00001206 va_end(ap);
1207 return z;
1208}
1209
1210/*
drh28dd4792006-06-26 21:35:44 +00001211** Print into memory obtained from sqlite3_malloc(). Omit the internal
1212** %-conversion extensions.
1213*/
1214char *sqlite3_vmprintf(const char *zFormat, va_list ap){
drhade86482007-11-28 22:36:40 +00001215 char *z;
drh28dd4792006-06-26 21:35:44 +00001216 char zBase[SQLITE_PRINT_BUF_SIZE];
drhade86482007-11-28 22:36:40 +00001217 StrAccum acc;
drh9ca95732014-10-24 00:35:58 +00001218
1219#ifdef SQLITE_ENABLE_API_ARMOR
1220 if( zFormat==0 ){
1221 (void)SQLITE_MISUSE_BKPT;
1222 return 0;
1223 }
1224#endif
drhff1590e2008-07-14 12:52:53 +00001225#ifndef SQLITE_OMIT_AUTOINIT
1226 if( sqlite3_initialize() ) return 0;
1227#endif
drhc0490572015-05-02 11:45:53 +00001228 sqlite3StrAccumInit(&acc, 0, zBase, sizeof(zBase), SQLITE_MAX_LENGTH);
drh0cdbe1a2018-05-09 13:46:26 +00001229 sqlite3_str_vappendf(&acc, zFormat, ap);
drhade86482007-11-28 22:36:40 +00001230 z = sqlite3StrAccumFinish(&acc);
1231 return z;
drh28dd4792006-06-26 21:35:44 +00001232}
1233
1234/*
1235** Print into memory obtained from sqlite3_malloc()(). Omit the internal
1236** %-conversion extensions.
drh483750b2003-01-29 18:46:51 +00001237*/
danielk19776f8a5032004-05-10 10:34:51 +00001238char *sqlite3_mprintf(const char *zFormat, ...){
drha18c5682000-10-08 22:20:57 +00001239 va_list ap;
drh5f968432004-02-21 19:02:30 +00001240 char *z;
drhff1590e2008-07-14 12:52:53 +00001241#ifndef SQLITE_OMIT_AUTOINIT
1242 if( sqlite3_initialize() ) return 0;
1243#endif
drh28dd4792006-06-26 21:35:44 +00001244 va_start(ap, zFormat);
drhb3738b62007-03-31 15:02:49 +00001245 z = sqlite3_vmprintf(zFormat, ap);
drha18c5682000-10-08 22:20:57 +00001246 va_end(ap);
drh5f968432004-02-21 19:02:30 +00001247 return z;
drha18c5682000-10-08 22:20:57 +00001248}
1249
drh93a5c6b2003-12-23 02:17:35 +00001250/*
danielk19776f8a5032004-05-10 10:34:51 +00001251** sqlite3_snprintf() works like snprintf() except that it ignores the
drh93a5c6b2003-12-23 02:17:35 +00001252** current locale settings. This is important for SQLite because we
1253** are not able to use a "," as the decimal point in place of "." as
1254** specified by some locales.
drhdb26d4c2011-01-05 12:20:09 +00001255**
1256** Oops: The first two arguments of sqlite3_snprintf() are backwards
1257** from the snprintf() standard. Unfortunately, it is too late to change
1258** this without breaking compatibility, so we just have to live with the
1259** mistake.
1260**
1261** sqlite3_vsnprintf() is the varargs version.
drh93a5c6b2003-12-23 02:17:35 +00001262*/
drhdb26d4c2011-01-05 12:20:09 +00001263char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){
1264 StrAccum acc;
1265 if( n<=0 ) return zBuf;
drh9ca95732014-10-24 00:35:58 +00001266#ifdef SQLITE_ENABLE_API_ARMOR
1267 if( zBuf==0 || zFormat==0 ) {
1268 (void)SQLITE_MISUSE_BKPT;
drh96c707a2015-02-13 16:36:14 +00001269 if( zBuf ) zBuf[0] = 0;
drh9ca95732014-10-24 00:35:58 +00001270 return zBuf;
1271 }
1272#endif
drhc0490572015-05-02 11:45:53 +00001273 sqlite3StrAccumInit(&acc, 0, zBuf, n, 0);
drh0cdbe1a2018-05-09 13:46:26 +00001274 sqlite3_str_vappendf(&acc, zFormat, ap);
drhe9bb5662016-11-25 15:47:53 +00001275 zBuf[acc.nChar] = 0;
1276 return zBuf;
drhdb26d4c2011-01-05 12:20:09 +00001277}
danielk19776f8a5032004-05-10 10:34:51 +00001278char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){
drh5f968432004-02-21 19:02:30 +00001279 char *z;
drh93a5c6b2003-12-23 02:17:35 +00001280 va_list ap;
drh93a5c6b2003-12-23 02:17:35 +00001281 va_start(ap,zFormat);
drhdb26d4c2011-01-05 12:20:09 +00001282 z = sqlite3_vsnprintf(n, zBuf, zFormat, ap);
drh93a5c6b2003-12-23 02:17:35 +00001283 va_end(ap);
drh5f968432004-02-21 19:02:30 +00001284 return z;
drh93a5c6b2003-12-23 02:17:35 +00001285}
1286
drh3f280702010-02-18 18:45:09 +00001287/*
drh7c0c4602010-03-03 22:25:18 +00001288** This is the routine that actually formats the sqlite3_log() message.
1289** We house it in a separate routine from sqlite3_log() to avoid using
1290** stack space on small-stack systems when logging is disabled.
1291**
1292** sqlite3_log() must render into a static buffer. It cannot dynamically
1293** allocate memory because it might be called while the memory allocator
1294** mutex is held.
drha8dbd522015-07-14 22:43:37 +00001295**
drh0cdbe1a2018-05-09 13:46:26 +00001296** sqlite3_str_vappendf() might ask for *temporary* memory allocations for
drha8dbd522015-07-14 22:43:37 +00001297** certain format characters (%q) or for very large precisions or widths.
1298** Care must be taken that any sqlite3_log() calls that occur while the
1299** memory mutex is held do not use these mechanisms.
drh7c0c4602010-03-03 22:25:18 +00001300*/
1301static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){
drha64fa912010-03-04 00:53:32 +00001302 StrAccum acc; /* String accumulator */
1303 char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */
drh7c0c4602010-03-03 22:25:18 +00001304
drhc0490572015-05-02 11:45:53 +00001305 sqlite3StrAccumInit(&acc, 0, zMsg, sizeof(zMsg), 0);
drh0cdbe1a2018-05-09 13:46:26 +00001306 sqlite3_str_vappendf(&acc, zFormat, ap);
drh7c0c4602010-03-03 22:25:18 +00001307 sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode,
1308 sqlite3StrAccumFinish(&acc));
1309}
1310
1311/*
drh3f280702010-02-18 18:45:09 +00001312** Format and write a message to the log if logging is enabled.
1313*/
drha7564662010-02-22 19:32:31 +00001314void sqlite3_log(int iErrCode, const char *zFormat, ...){
drh3f280702010-02-18 18:45:09 +00001315 va_list ap; /* Vararg list */
drh7c0c4602010-03-03 22:25:18 +00001316 if( sqlite3GlobalConfig.xLog ){
drh3f280702010-02-18 18:45:09 +00001317 va_start(ap, zFormat);
drh7c0c4602010-03-03 22:25:18 +00001318 renderLogMsg(iErrCode, zFormat, ap);
drh3f280702010-02-18 18:45:09 +00001319 va_end(ap);
drh3f280702010-02-18 18:45:09 +00001320 }
1321}
1322
mistachkin02b0e262015-04-16 03:37:19 +00001323#if defined(SQLITE_DEBUG) || defined(SQLITE_HAVE_OS_TRACE)
drhe54ca3f2004-06-07 01:52:14 +00001324/*
1325** A version of printf() that understands %lld. Used for debugging.
1326** The printf() built into some versions of windows does not understand %lld
1327** and segfaults if you give it a long long int.
1328*/
1329void sqlite3DebugPrintf(const char *zFormat, ...){
1330 va_list ap;
drhade86482007-11-28 22:36:40 +00001331 StrAccum acc;
mistachkina8e41ec2020-05-15 01:18:07 +00001332 char zBuf[SQLITE_PRINT_BUF_SIZE*10];
drhc0490572015-05-02 11:45:53 +00001333 sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
drhade86482007-11-28 22:36:40 +00001334 va_start(ap,zFormat);
drh0cdbe1a2018-05-09 13:46:26 +00001335 sqlite3_str_vappendf(&acc, zFormat, ap);
drhe54ca3f2004-06-07 01:52:14 +00001336 va_end(ap);
drhbed8e7e2007-12-08 17:55:35 +00001337 sqlite3StrAccumFinish(&acc);
mistachkin4a9ff912017-11-09 17:29:04 +00001338#ifdef SQLITE_OS_TRACE_PROC
1339 {
1340 extern void SQLITE_OS_TRACE_PROC(const char *zBuf, int nBuf);
1341 SQLITE_OS_TRACE_PROC(zBuf, sizeof(zBuf));
1342 }
1343#else
drh485f0032007-01-26 19:23:33 +00001344 fprintf(stdout,"%s", zBuf);
drh2ac3ee92004-06-07 16:27:46 +00001345 fflush(stdout);
mistachkin4a9ff912017-11-09 17:29:04 +00001346#endif
drhe54ca3f2004-06-07 01:52:14 +00001347}
1348#endif
drhc7bc4fd2009-11-25 18:03:42 +00001349
drh4fa4a542014-09-30 12:33:33 +00001350
drhc7bc4fd2009-11-25 18:03:42 +00001351/*
drh0cdbe1a2018-05-09 13:46:26 +00001352** variable-argument wrapper around sqlite3_str_vappendf(). The bFlags argument
drhd37bea52015-09-02 15:37:50 +00001353** can contain the bit SQLITE_PRINTF_INTERNAL enable internal formats.
drhc7bc4fd2009-11-25 18:03:42 +00001354*/
drh0cdbe1a2018-05-09 13:46:26 +00001355void sqlite3_str_appendf(StrAccum *p, const char *zFormat, ...){
drhc7bc4fd2009-11-25 18:03:42 +00001356 va_list ap;
1357 va_start(ap,zFormat);
drh0cdbe1a2018-05-09 13:46:26 +00001358 sqlite3_str_vappendf(p, zFormat, ap);
drhc7bc4fd2009-11-25 18:03:42 +00001359 va_end(ap);
1360}