1 /* 2 ** The "printf" code that follows dates from the 1980's. It is in 3 ** the public domain. The original comments are included here for 4 ** completeness. They are very out-of-date but might be useful as 5 ** an historical reference. Most of the "enhancements" have been backed 6 ** out so that the functionality is now the same as standard printf(). 7 ** 8 ************************************************************************** 9 ** 10 ** This file contains code for a set of "printf"-like routines. These 11 ** routines format strings much like the printf() from the standard C 12 ** library, though the implementation here has enhancements to support 13 ** SQLlite. 14 */ 15 #include "sqliteInt.h" 16 17 /* 18 ** Conversion types fall into various categories as defined by the 19 ** following enumeration. 20 */ 21 #define etRADIX 1 /* Integer types. %d, %x, %o, and so forth */ 22 #define etFLOAT 2 /* Floating point. %f */ 23 #define etEXP 3 /* Exponentional notation. %e and %E */ 24 #define etGENERIC 4 /* Floating or exponential, depending on exponent. %g */ 25 #define etSIZE 5 /* Return number of characters processed so far. %n */ 26 #define etSTRING 6 /* Strings. %s */ 27 #define etDYNSTRING 7 /* Dynamically allocated strings. %z */ 28 #define etPERCENT 8 /* Percent symbol. %% */ 29 #define etCHARX 9 /* Characters. %c */ 30 /* The rest are extensions, not normally found in printf() */ 31 #define etSQLESCAPE 10 /* Strings with '\'' doubled. %q */ 32 #define etSQLESCAPE2 11 /* Strings with '\'' doubled and enclosed in '', 33 NULL pointers replaced by SQL NULL. %Q */ 34 #define etTOKEN 12 /* a pointer to a Token structure */ 35 #define etSRCLIST 13 /* a pointer to a SrcList */ 36 #define etPOINTER 14 /* The %p conversion */ 37 #define etSQLESCAPE3 15 /* %w -> Strings with '\"' doubled */ 38 #define etORDINAL 16 /* %r -> 1st, 2nd, 3rd, 4th, etc. English only */ 39 40 #define etINVALID 0 /* Any unrecognized conversion type */ 41 42 43 /* 44 ** An "etByte" is an 8-bit unsigned value. 45 */ 46 typedef unsigned char etByte; 47 48 /* 49 ** Each builtin conversion character (ex: the 'd' in "%d") is described 50 ** by an instance of the following structure 51 */ 52 typedef struct et_info { /* Information about each format field */ 53 char fmttype; /* The format field code letter */ 54 etByte base; /* The base for radix conversion */ 55 etByte flags; /* One or more of FLAG_ constants below */ 56 etByte type; /* Conversion paradigm */ 57 etByte charset; /* Offset into aDigits[] of the digits string */ 58 etByte prefix; /* Offset into aPrefix[] of the prefix string */ 59 } et_info; 60 61 /* 62 ** Allowed values for et_info.flags 63 */ 64 #define FLAG_SIGNED 1 /* True if the value to convert is signed */ 65 #define FLAG_INTERN 2 /* True if for internal use only */ 66 #define FLAG_STRING 4 /* Allow infinity precision */ 67 68 69 /* 70 ** The following table is searched linearly, so it is good to put the 71 ** most frequently used conversion types first. 72 */ 73 static const char aDigits[] = "0123456789ABCDEF0123456789abcdef"; 74 static const char aPrefix[] = "-x0\000X0"; 75 static const et_info fmtinfo[] = { 76 { 'd', 10, 1, etRADIX, 0, 0 }, 77 { 's', 0, 4, etSTRING, 0, 0 }, 78 { 'g', 0, 1, etGENERIC, 30, 0 }, 79 { 'z', 0, 4, etDYNSTRING, 0, 0 }, 80 { 'q', 0, 4, etSQLESCAPE, 0, 0 }, 81 { 'Q', 0, 4, etSQLESCAPE2, 0, 0 }, 82 { 'w', 0, 4, etSQLESCAPE3, 0, 0 }, 83 { 'c', 0, 0, etCHARX, 0, 0 }, 84 { 'o', 8, 0, etRADIX, 0, 2 }, 85 { 'u', 10, 0, etRADIX, 0, 0 }, 86 { 'x', 16, 0, etRADIX, 16, 1 }, 87 { 'X', 16, 0, etRADIX, 0, 4 }, 88 #ifndef SQLITE_OMIT_FLOATING_POINT 89 { 'f', 0, 1, etFLOAT, 0, 0 }, 90 { 'e', 0, 1, etEXP, 30, 0 }, 91 { 'E', 0, 1, etEXP, 14, 0 }, 92 { 'G', 0, 1, etGENERIC, 14, 0 }, 93 #endif 94 { 'i', 10, 1, etRADIX, 0, 0 }, 95 { 'n', 0, 0, etSIZE, 0, 0 }, 96 { '%', 0, 0, etPERCENT, 0, 0 }, 97 { 'p', 16, 0, etPOINTER, 0, 1 }, 98 99 /* All the rest have the FLAG_INTERN bit set and are thus for internal 100 ** use only */ 101 { 'T', 0, 2, etTOKEN, 0, 0 }, 102 { 'S', 0, 2, etSRCLIST, 0, 0 }, 103 { 'r', 10, 3, etORDINAL, 0, 0 }, 104 }; 105 106 /* 107 ** If SQLITE_OMIT_FLOATING_POINT is defined, then none of the floating point 108 ** conversions will work. 109 */ 110 #ifndef SQLITE_OMIT_FLOATING_POINT 111 /* 112 ** "*val" is a double such that 0.1 <= *val < 10.0 113 ** Return the ascii code for the leading digit of *val, then 114 ** multiply "*val" by 10.0 to renormalize. 115 ** 116 ** Example: 117 ** input: *val = 3.14159 118 ** output: *val = 1.4159 function return = '3' 119 ** 120 ** The counter *cnt is incremented each time. After counter exceeds 121 ** 16 (the number of significant digits in a 64-bit float) '0' is 122 ** always returned. 123 */ 124 static char et_getdigit(LONGDOUBLE_TYPE *val, int *cnt){ 125 int digit; 126 LONGDOUBLE_TYPE d; 127 if( (*cnt)<=0 ) return '0'; 128 (*cnt)--; 129 digit = (int)*val; 130 d = digit; 131 digit += '0'; 132 *val = (*val - d)*10.0; 133 return (char)digit; 134 } 135 #endif /* SQLITE_OMIT_FLOATING_POINT */ 136 137 /* 138 ** Set the StrAccum object to an error mode. 139 */ 140 static void setStrAccumError(StrAccum *p, u8 eError){ 141 p->accError = eError; 142 p->nAlloc = 0; 143 } 144 145 /* 146 ** Extra argument values from a PrintfArguments object 147 */ 148 static sqlite3_int64 getIntArg(PrintfArguments *p){ 149 if( p->nArg<=p->nUsed ) return 0; 150 return sqlite3_value_int64(p->apArg[p->nUsed++]); 151 } 152 static double getDoubleArg(PrintfArguments *p){ 153 if( p->nArg<=p->nUsed ) return 0.0; 154 return sqlite3_value_double(p->apArg[p->nUsed++]); 155 } 156 static char *getTextArg(PrintfArguments *p){ 157 if( p->nArg<=p->nUsed ) return 0; 158 return (char*)sqlite3_value_text(p->apArg[p->nUsed++]); 159 } 160 161 162 /* 163 ** On machines with a small stack size, you can redefine the 164 ** SQLITE_PRINT_BUF_SIZE to be something smaller, if desired. 165 */ 166 #ifndef SQLITE_PRINT_BUF_SIZE 167 # define SQLITE_PRINT_BUF_SIZE 70 168 #endif 169 #define etBUFSIZE SQLITE_PRINT_BUF_SIZE /* Size of the output buffer */ 170 171 /* 172 ** Render a string given by "fmt" into the StrAccum object. 173 */ 174 void sqlite3VXPrintf( 175 StrAccum *pAccum, /* Accumulate results here */ 176 u32 bFlags, /* SQLITE_PRINTF_* flags */ 177 const char *fmt, /* Format string */ 178 va_list ap /* arguments */ 179 ){ 180 int c; /* Next character in the format string */ 181 char *bufpt; /* Pointer to the conversion buffer */ 182 int precision; /* Precision of the current field */ 183 int length; /* Length of the field */ 184 int idx; /* A general purpose loop counter */ 185 int width; /* Width of the current field */ 186 etByte flag_leftjustify; /* True if "-" flag is present */ 187 etByte flag_plussign; /* True if "+" flag is present */ 188 etByte flag_blanksign; /* True if " " flag is present */ 189 etByte flag_alternateform; /* True if "#" flag is present */ 190 etByte flag_altform2; /* True if "!" flag is present */ 191 etByte flag_zeropad; /* True if field width constant starts with zero */ 192 etByte flag_long; /* True if "l" flag is present */ 193 etByte flag_longlong; /* True if the "ll" flag is present */ 194 etByte done; /* Loop termination flag */ 195 etByte xtype = 0; /* Conversion paradigm */ 196 u8 bArgList; /* True for SQLITE_PRINTF_SQLFUNC */ 197 u8 useIntern; /* Ok to use internal conversions (ex: %T) */ 198 char prefix; /* Prefix character. "+" or "-" or " " or '\0'. */ 199 sqlite_uint64 longvalue; /* Value for integer types */ 200 LONGDOUBLE_TYPE realvalue; /* Value for real types */ 201 const et_info *infop; /* Pointer to the appropriate info structure */ 202 char *zOut; /* Rendering buffer */ 203 int nOut; /* Size of the rendering buffer */ 204 char *zExtra = 0; /* Malloced memory used by some conversion */ 205 #ifndef SQLITE_OMIT_FLOATING_POINT 206 int exp, e2; /* exponent of real numbers */ 207 int nsd; /* Number of significant digits returned */ 208 double rounder; /* Used for rounding floating point values */ 209 etByte flag_dp; /* True if decimal point should be shown */ 210 etByte flag_rtz; /* True if trailing zeros should be removed */ 211 #endif 212 PrintfArguments *pArgList = 0; /* Arguments for SQLITE_PRINTF_SQLFUNC */ 213 char buf[etBUFSIZE]; /* Conversion buffer */ 214 215 bufpt = 0; 216 if( bFlags ){ 217 if( (bArgList = (bFlags & SQLITE_PRINTF_SQLFUNC))!=0 ){ 218 pArgList = va_arg(ap, PrintfArguments*); 219 } 220 useIntern = bFlags & SQLITE_PRINTF_INTERNAL; 221 }else{ 222 bArgList = useIntern = 0; 223 } 224 for(; (c=(*fmt))!=0; ++fmt){ 225 if( c!='%' ){ 226 bufpt = (char *)fmt; 227 #if HAVE_STRCHRNUL 228 fmt = strchrnul(fmt, '%'); 229 #else 230 do{ fmt++; }while( *fmt && *fmt != '%' ); 231 #endif 232 sqlite3StrAccumAppend(pAccum, bufpt, (int)(fmt - bufpt)); 233 if( *fmt==0 ) break; 234 } 235 if( (c=(*++fmt))==0 ){ 236 sqlite3StrAccumAppend(pAccum, "%", 1); 237 break; 238 } 239 /* Find out what flags are present */ 240 flag_leftjustify = flag_plussign = flag_blanksign = 241 flag_alternateform = flag_altform2 = flag_zeropad = 0; 242 done = 0; 243 do{ 244 switch( c ){ 245 case '-': flag_leftjustify = 1; break; 246 case '+': flag_plussign = 1; break; 247 case ' ': flag_blanksign = 1; break; 248 case '#': flag_alternateform = 1; break; 249 case '!': flag_altform2 = 1; break; 250 case '0': flag_zeropad = 1; break; 251 default: done = 1; break; 252 } 253 }while( !done && (c=(*++fmt))!=0 ); 254 /* Get the field width */ 255 width = 0; 256 if( c=='*' ){ 257 if( bArgList ){ 258 width = (int)getIntArg(pArgList); 259 }else{ 260 width = va_arg(ap,int); 261 } 262 if( width<0 ){ 263 flag_leftjustify = 1; 264 width = -width; 265 } 266 c = *++fmt; 267 }else{ 268 while( c>='0' && c<='9' ){ 269 width = width*10 + c - '0'; 270 c = *++fmt; 271 } 272 } 273 /* Get the precision */ 274 if( c=='.' ){ 275 precision = 0; 276 c = *++fmt; 277 if( c=='*' ){ 278 if( bArgList ){ 279 precision = (int)getIntArg(pArgList); 280 }else{ 281 precision = va_arg(ap,int); 282 } 283 if( precision<0 ) precision = -precision; 284 c = *++fmt; 285 }else{ 286 while( c>='0' && c<='9' ){ 287 precision = precision*10 + c - '0'; 288 c = *++fmt; 289 } 290 } 291 }else{ 292 precision = -1; 293 } 294 /* Get the conversion type modifier */ 295 if( c=='l' ){ 296 flag_long = 1; 297 c = *++fmt; 298 if( c=='l' ){ 299 flag_longlong = 1; 300 c = *++fmt; 301 }else{ 302 flag_longlong = 0; 303 } 304 }else{ 305 flag_long = flag_longlong = 0; 306 } 307 /* Fetch the info entry for the field */ 308 infop = &fmtinfo[0]; 309 xtype = etINVALID; 310 for(idx=0; idx<ArraySize(fmtinfo); idx++){ 311 if( c==fmtinfo[idx].fmttype ){ 312 infop = &fmtinfo[idx]; 313 if( useIntern || (infop->flags & FLAG_INTERN)==0 ){ 314 xtype = infop->type; 315 }else{ 316 return; 317 } 318 break; 319 } 320 } 321 322 /* 323 ** At this point, variables are initialized as follows: 324 ** 325 ** flag_alternateform TRUE if a '#' is present. 326 ** flag_altform2 TRUE if a '!' is present. 327 ** flag_plussign TRUE if a '+' is present. 328 ** flag_leftjustify TRUE if a '-' is present or if the 329 ** field width was negative. 330 ** flag_zeropad TRUE if the width began with 0. 331 ** flag_long TRUE if the letter 'l' (ell) prefixed 332 ** the conversion character. 333 ** flag_longlong TRUE if the letter 'll' (ell ell) prefixed 334 ** the conversion character. 335 ** flag_blanksign TRUE if a ' ' is present. 336 ** width The specified field width. This is 337 ** always non-negative. Zero is the default. 338 ** precision The specified precision. The default 339 ** is -1. 340 ** xtype The class of the conversion. 341 ** infop Pointer to the appropriate info struct. 342 */ 343 switch( xtype ){ 344 case etPOINTER: 345 flag_longlong = sizeof(char*)==sizeof(i64); 346 flag_long = sizeof(char*)==sizeof(long int); 347 /* Fall through into the next case */ 348 case etORDINAL: 349 case etRADIX: 350 if( infop->flags & FLAG_SIGNED ){ 351 i64 v; 352 if( bArgList ){ 353 v = getIntArg(pArgList); 354 }else if( flag_longlong ){ 355 v = va_arg(ap,i64); 356 }else if( flag_long ){ 357 v = va_arg(ap,long int); 358 }else{ 359 v = va_arg(ap,int); 360 } 361 if( v<0 ){ 362 if( v==SMALLEST_INT64 ){ 363 longvalue = ((u64)1)<<63; 364 }else{ 365 longvalue = -v; 366 } 367 prefix = '-'; 368 }else{ 369 longvalue = v; 370 if( flag_plussign ) prefix = '+'; 371 else if( flag_blanksign ) prefix = ' '; 372 else prefix = 0; 373 } 374 }else{ 375 if( bArgList ){ 376 longvalue = (u64)getIntArg(pArgList); 377 }else if( flag_longlong ){ 378 longvalue = va_arg(ap,u64); 379 }else if( flag_long ){ 380 longvalue = va_arg(ap,unsigned long int); 381 }else{ 382 longvalue = va_arg(ap,unsigned int); 383 } 384 prefix = 0; 385 } 386 if( longvalue==0 ) flag_alternateform = 0; 387 if( flag_zeropad && precision<width-(prefix!=0) ){ 388 precision = width-(prefix!=0); 389 } 390 if( precision<etBUFSIZE-10 ){ 391 nOut = etBUFSIZE; 392 zOut = buf; 393 }else{ 394 nOut = precision + 10; 395 zOut = zExtra = sqlite3Malloc( nOut ); 396 if( zOut==0 ){ 397 setStrAccumError(pAccum, STRACCUM_NOMEM); 398 return; 399 } 400 } 401 bufpt = &zOut[nOut-1]; 402 if( xtype==etORDINAL ){ 403 static const char zOrd[] = "thstndrd"; 404 int x = (int)(longvalue % 10); 405 if( x>=4 || (longvalue/10)%10==1 ){ 406 x = 0; 407 } 408 *(--bufpt) = zOrd[x*2+1]; 409 *(--bufpt) = zOrd[x*2]; 410 } 411 { 412 const char *cset = &aDigits[infop->charset]; 413 u8 base = infop->base; 414 do{ /* Convert to ascii */ 415 *(--bufpt) = cset[longvalue%base]; 416 longvalue = longvalue/base; 417 }while( longvalue>0 ); 418 } 419 length = (int)(&zOut[nOut-1]-bufpt); 420 for(idx=precision-length; idx>0; idx--){ 421 *(--bufpt) = '0'; /* Zero pad */ 422 } 423 if( prefix ) *(--bufpt) = prefix; /* Add sign */ 424 if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */ 425 const char *pre; 426 char x; 427 pre = &aPrefix[infop->prefix]; 428 for(; (x=(*pre))!=0; pre++) *(--bufpt) = x; 429 } 430 length = (int)(&zOut[nOut-1]-bufpt); 431 break; 432 case etFLOAT: 433 case etEXP: 434 case etGENERIC: 435 if( bArgList ){ 436 realvalue = getDoubleArg(pArgList); 437 }else{ 438 realvalue = va_arg(ap,double); 439 } 440 #ifdef SQLITE_OMIT_FLOATING_POINT 441 length = 0; 442 #else 443 if( precision<0 ) precision = 6; /* Set default precision */ 444 if( realvalue<0.0 ){ 445 realvalue = -realvalue; 446 prefix = '-'; 447 }else{ 448 if( flag_plussign ) prefix = '+'; 449 else if( flag_blanksign ) prefix = ' '; 450 else prefix = 0; 451 } 452 if( xtype==etGENERIC && precision>0 ) precision--; 453 for(idx=precision, rounder=0.5; idx>0; idx--, rounder*=0.1){} 454 if( xtype==etFLOAT ) realvalue += rounder; 455 /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */ 456 exp = 0; 457 if( sqlite3IsNaN((double)realvalue) ){ 458 bufpt = "NaN"; 459 length = 3; 460 break; 461 } 462 if( realvalue>0.0 ){ 463 LONGDOUBLE_TYPE scale = 1.0; 464 while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;} 465 while( realvalue>=1e64*scale && exp<=350 ){ scale *= 1e64; exp+=64; } 466 while( realvalue>=1e8*scale && exp<=350 ){ scale *= 1e8; exp+=8; } 467 while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; } 468 realvalue /= scale; 469 while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; } 470 while( realvalue<1.0 ){ realvalue *= 10.0; exp--; } 471 if( exp>350 ){ 472 if( prefix=='-' ){ 473 bufpt = "-Inf"; 474 }else if( prefix=='+' ){ 475 bufpt = "+Inf"; 476 }else{ 477 bufpt = "Inf"; 478 } 479 length = sqlite3Strlen30(bufpt); 480 break; 481 } 482 } 483 bufpt = buf; 484 /* 485 ** If the field type is etGENERIC, then convert to either etEXP 486 ** or etFLOAT, as appropriate. 487 */ 488 if( xtype!=etFLOAT ){ 489 realvalue += rounder; 490 if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; } 491 } 492 if( xtype==etGENERIC ){ 493 flag_rtz = !flag_alternateform; 494 if( exp<-4 || exp>precision ){ 495 xtype = etEXP; 496 }else{ 497 precision = precision - exp; 498 xtype = etFLOAT; 499 } 500 }else{ 501 flag_rtz = flag_altform2; 502 } 503 if( xtype==etEXP ){ 504 e2 = 0; 505 }else{ 506 e2 = exp; 507 } 508 if( MAX(e2,0)+precision+width > etBUFSIZE - 15 ){ 509 bufpt = zExtra = sqlite3Malloc( MAX(e2,0)+precision+width+15 ); 510 if( bufpt==0 ){ 511 setStrAccumError(pAccum, STRACCUM_NOMEM); 512 return; 513 } 514 } 515 zOut = bufpt; 516 nsd = 16 + flag_altform2*10; 517 flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2; 518 /* The sign in front of the number */ 519 if( prefix ){ 520 *(bufpt++) = prefix; 521 } 522 /* Digits prior to the decimal point */ 523 if( e2<0 ){ 524 *(bufpt++) = '0'; 525 }else{ 526 for(; e2>=0; e2--){ 527 *(bufpt++) = et_getdigit(&realvalue,&nsd); 528 } 529 } 530 /* The decimal point */ 531 if( flag_dp ){ 532 *(bufpt++) = '.'; 533 } 534 /* "0" digits after the decimal point but before the first 535 ** significant digit of the number */ 536 for(e2++; e2<0; precision--, e2++){ 537 assert( precision>0 ); 538 *(bufpt++) = '0'; 539 } 540 /* Significant digits after the decimal point */ 541 while( (precision--)>0 ){ 542 *(bufpt++) = et_getdigit(&realvalue,&nsd); 543 } 544 /* Remove trailing zeros and the "." if no digits follow the "." */ 545 if( flag_rtz && flag_dp ){ 546 while( bufpt[-1]=='0' ) *(--bufpt) = 0; 547 assert( bufpt>zOut ); 548 if( bufpt[-1]=='.' ){ 549 if( flag_altform2 ){ 550 *(bufpt++) = '0'; 551 }else{ 552 *(--bufpt) = 0; 553 } 554 } 555 } 556 /* Add the "eNNN" suffix */ 557 if( xtype==etEXP ){ 558 *(bufpt++) = aDigits[infop->charset]; 559 if( exp<0 ){ 560 *(bufpt++) = '-'; exp = -exp; 561 }else{ 562 *(bufpt++) = '+'; 563 } 564 if( exp>=100 ){ 565 *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */ 566 exp %= 100; 567 } 568 *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */ 569 *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */ 570 } 571 *bufpt = 0; 572 573 /* The converted number is in buf[] and zero terminated. Output it. 574 ** Note that the number is in the usual order, not reversed as with 575 ** integer conversions. */ 576 length = (int)(bufpt-zOut); 577 bufpt = zOut; 578 579 /* Special case: Add leading zeros if the flag_zeropad flag is 580 ** set and we are not left justified */ 581 if( flag_zeropad && !flag_leftjustify && length < width){ 582 int i; 583 int nPad = width - length; 584 for(i=width; i>=nPad; i--){ 585 bufpt[i] = bufpt[i-nPad]; 586 } 587 i = prefix!=0; 588 while( nPad-- ) bufpt[i++] = '0'; 589 length = width; 590 } 591 #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */ 592 break; 593 case etSIZE: 594 if( !bArgList ){ 595 *(va_arg(ap,int*)) = pAccum->nChar; 596 } 597 length = width = 0; 598 break; 599 case etPERCENT: 600 buf[0] = '%'; 601 bufpt = buf; 602 length = 1; 603 break; 604 case etCHARX: 605 if( bArgList ){ 606 bufpt = getTextArg(pArgList); 607 c = bufpt ? bufpt[0] : 0; 608 }else{ 609 c = va_arg(ap,int); 610 } 611 if( precision>1 ){ 612 width -= precision-1; 613 if( width>1 && !flag_leftjustify ){ 614 sqlite3AppendChar(pAccum, width-1, ' '); 615 width = 0; 616 } 617 sqlite3AppendChar(pAccum, precision-1, c); 618 } 619 length = 1; 620 buf[0] = c; 621 bufpt = buf; 622 break; 623 case etSTRING: 624 case etDYNSTRING: 625 if( bArgList ){ 626 bufpt = getTextArg(pArgList); 627 }else{ 628 bufpt = va_arg(ap,char*); 629 } 630 if( bufpt==0 ){ 631 bufpt = ""; 632 }else if( xtype==etDYNSTRING && !bArgList ){ 633 zExtra = bufpt; 634 } 635 if( precision>=0 ){ 636 for(length=0; length<precision && bufpt[length]; length++){} 637 }else{ 638 length = sqlite3Strlen30(bufpt); 639 } 640 break; 641 case etSQLESCAPE: 642 case etSQLESCAPE2: 643 case etSQLESCAPE3: { 644 int i, j, k, n, isnull; 645 int needQuote; 646 char ch; 647 char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */ 648 char *escarg; 649 650 if( bArgList ){ 651 escarg = getTextArg(pArgList); 652 }else{ 653 escarg = va_arg(ap,char*); 654 } 655 isnull = escarg==0; 656 if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)"); 657 k = precision; 658 for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){ 659 if( ch==q ) n++; 660 } 661 needQuote = !isnull && xtype==etSQLESCAPE2; 662 n += i + 1 + needQuote*2; 663 if( n>etBUFSIZE ){ 664 bufpt = zExtra = sqlite3Malloc( n ); 665 if( bufpt==0 ){ 666 setStrAccumError(pAccum, STRACCUM_NOMEM); 667 return; 668 } 669 }else{ 670 bufpt = buf; 671 } 672 j = 0; 673 if( needQuote ) bufpt[j++] = q; 674 k = i; 675 for(i=0; i<k; i++){ 676 bufpt[j++] = ch = escarg[i]; 677 if( ch==q ) bufpt[j++] = ch; 678 } 679 if( needQuote ) bufpt[j++] = q; 680 bufpt[j] = 0; 681 length = j; 682 /* The precision in %q and %Q means how many input characters to 683 ** consume, not the length of the output... 684 ** if( precision>=0 && precision<length ) length = precision; */ 685 break; 686 } 687 case etTOKEN: { 688 Token *pToken = va_arg(ap, Token*); 689 assert( bArgList==0 ); 690 if( pToken && pToken->n ){ 691 sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n); 692 } 693 length = width = 0; 694 break; 695 } 696 case etSRCLIST: { 697 SrcList *pSrc = va_arg(ap, SrcList*); 698 int k = va_arg(ap, int); 699 struct SrcList_item *pItem = &pSrc->a[k]; 700 assert( bArgList==0 ); 701 assert( k>=0 && k<pSrc->nSrc ); 702 if( pItem->zDatabase ){ 703 sqlite3StrAccumAppendAll(pAccum, pItem->zDatabase); 704 sqlite3StrAccumAppend(pAccum, ".", 1); 705 } 706 sqlite3StrAccumAppendAll(pAccum, pItem->zName); 707 length = width = 0; 708 break; 709 } 710 default: { 711 assert( xtype==etINVALID ); 712 return; 713 } 714 }/* End switch over the format type */ 715 /* 716 ** The text of the conversion is pointed to by "bufpt" and is 717 ** "length" characters long. The field width is "width". Do 718 ** the output. 719 */ 720 width -= length; 721 if( width>0 && !flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' '); 722 sqlite3StrAccumAppend(pAccum, bufpt, length); 723 if( width>0 && flag_leftjustify ) sqlite3AppendChar(pAccum, width, ' '); 724 725 if( zExtra ){ 726 sqlite3_free(zExtra); 727 zExtra = 0; 728 } 729 }/* End for loop over the format string */ 730 } /* End of function */ 731 732 /* 733 ** Enlarge the memory allocation on a StrAccum object so that it is 734 ** able to accept at least N more bytes of text. 735 ** 736 ** Return the number of bytes of text that StrAccum is able to accept 737 ** after the attempted enlargement. The value returned might be zero. 738 */ 739 static int sqlite3StrAccumEnlarge(StrAccum *p, int N){ 740 char *zNew; 741 assert( p->nChar+N >= p->nAlloc ); /* Only called if really needed */ 742 if( p->accError ){ 743 testcase(p->accError==STRACCUM_TOOBIG); 744 testcase(p->accError==STRACCUM_NOMEM); 745 return 0; 746 } 747 if( !p->useMalloc ){ 748 N = p->nAlloc - p->nChar - 1; 749 setStrAccumError(p, STRACCUM_TOOBIG); 750 return N; 751 }else{ 752 char *zOld = (p->zText==p->zBase ? 0 : p->zText); 753 i64 szNew = p->nChar; 754 szNew += N + 1; 755 if( szNew+p->nChar<=p->mxAlloc ){ 756 /* Force exponential buffer size growth as long as it does not overflow, 757 ** to avoid having to call this routine too often */ 758 szNew += p->nChar; 759 } 760 if( szNew > p->mxAlloc ){ 761 sqlite3StrAccumReset(p); 762 setStrAccumError(p, STRACCUM_TOOBIG); 763 return 0; 764 }else{ 765 p->nAlloc = (int)szNew; 766 } 767 if( p->useMalloc==1 ){ 768 zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc); 769 }else{ 770 zNew = sqlite3_realloc(zOld, p->nAlloc); 771 } 772 if( zNew ){ 773 assert( p->zText!=0 || p->nChar==0 ); 774 if( zOld==0 && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar); 775 p->zText = zNew; 776 p->nAlloc = sqlite3DbMallocSize(p->db, zNew); 777 }else{ 778 sqlite3StrAccumReset(p); 779 setStrAccumError(p, STRACCUM_NOMEM); 780 return 0; 781 } 782 } 783 return N; 784 } 785 786 /* 787 ** Append N copies of character c to the given string buffer. 788 */ 789 void sqlite3AppendChar(StrAccum *p, int N, char c){ 790 if( p->nChar+N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ) return; 791 while( (N--)>0 ) p->zText[p->nChar++] = c; 792 } 793 794 /* 795 ** The StrAccum "p" is not large enough to accept N new bytes of z[]. 796 ** So enlarge if first, then do the append. 797 ** 798 ** This is a helper routine to sqlite3StrAccumAppend() that does special-case 799 ** work (enlarging the buffer) using tail recursion, so that the 800 ** sqlite3StrAccumAppend() routine can use fast calling semantics. 801 */ 802 static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){ 803 N = sqlite3StrAccumEnlarge(p, N); 804 if( N>0 ){ 805 memcpy(&p->zText[p->nChar], z, N); 806 p->nChar += N; 807 } 808 } 809 810 /* 811 ** Append N bytes of text from z to the StrAccum object. Increase the 812 ** size of the memory allocation for StrAccum if necessary. 813 */ 814 void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){ 815 assert( z!=0 ); 816 assert( p->zText!=0 || p->nChar==0 || p->accError ); 817 assert( N>=0 ); 818 assert( p->accError==0 || p->nAlloc==0 ); 819 if( p->nChar+N >= p->nAlloc ){ 820 enlargeAndAppend(p,z,N); 821 }else{ 822 assert( p->zText ); 823 p->nChar += N; 824 memcpy(&p->zText[p->nChar-N], z, N); 825 } 826 } 827 828 /* 829 ** Append the complete text of zero-terminated string z[] to the p string. 830 */ 831 void sqlite3StrAccumAppendAll(StrAccum *p, const char *z){ 832 sqlite3StrAccumAppend(p, z, sqlite3Strlen30(z)); 833 } 834 835 836 /* 837 ** Finish off a string by making sure it is zero-terminated. 838 ** Return a pointer to the resulting string. Return a NULL 839 ** pointer if any kind of error was encountered. 840 */ 841 char *sqlite3StrAccumFinish(StrAccum *p){ 842 if( p->zText ){ 843 p->zText[p->nChar] = 0; 844 if( p->useMalloc && p->zText==p->zBase ){ 845 if( p->useMalloc==1 ){ 846 p->zText = sqlite3DbMallocRaw(p->db, p->nChar+1 ); 847 }else{ 848 p->zText = sqlite3_malloc(p->nChar+1); 849 } 850 if( p->zText ){ 851 memcpy(p->zText, p->zBase, p->nChar+1); 852 }else{ 853 setStrAccumError(p, STRACCUM_NOMEM); 854 } 855 } 856 } 857 return p->zText; 858 } 859 860 /* 861 ** Reset an StrAccum string. Reclaim all malloced memory. 862 */ 863 void sqlite3StrAccumReset(StrAccum *p){ 864 if( p->zText!=p->zBase ){ 865 if( p->useMalloc==1 ){ 866 sqlite3DbFree(p->db, p->zText); 867 }else{ 868 sqlite3_free(p->zText); 869 } 870 } 871 p->zText = 0; 872 } 873 874 /* 875 ** Initialize a string accumulator 876 */ 877 void sqlite3StrAccumInit(StrAccum *p, char *zBase, int n, int mx){ 878 p->zText = p->zBase = zBase; 879 p->db = 0; 880 p->nChar = 0; 881 p->nAlloc = n; 882 p->mxAlloc = mx; 883 p->useMalloc = 1; 884 p->accError = 0; 885 } 886 887 /* 888 ** Print into memory obtained from sqliteMalloc(). Use the internal 889 ** %-conversion extensions. 890 */ 891 char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){ 892 char *z; 893 char zBase[SQLITE_PRINT_BUF_SIZE]; 894 StrAccum acc; 895 assert( db!=0 ); 896 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), 897 db->aLimit[SQLITE_LIMIT_LENGTH]); 898 acc.db = db; 899 sqlite3VXPrintf(&acc, SQLITE_PRINTF_INTERNAL, zFormat, ap); 900 z = sqlite3StrAccumFinish(&acc); 901 if( acc.accError==STRACCUM_NOMEM ){ 902 db->mallocFailed = 1; 903 } 904 return z; 905 } 906 907 /* 908 ** Print into memory obtained from sqliteMalloc(). Use the internal 909 ** %-conversion extensions. 910 */ 911 char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){ 912 va_list ap; 913 char *z; 914 va_start(ap, zFormat); 915 z = sqlite3VMPrintf(db, zFormat, ap); 916 va_end(ap); 917 return z; 918 } 919 920 /* 921 ** Like sqlite3MPrintf(), but call sqlite3DbFree() on zStr after formatting 922 ** the string and before returning. This routine is intended to be used 923 ** to modify an existing string. For example: 924 ** 925 ** x = sqlite3MPrintf(db, x, "prefix %s suffix", x); 926 ** 927 */ 928 char *sqlite3MAppendf(sqlite3 *db, char *zStr, const char *zFormat, ...){ 929 va_list ap; 930 char *z; 931 va_start(ap, zFormat); 932 z = sqlite3VMPrintf(db, zFormat, ap); 933 va_end(ap); 934 sqlite3DbFree(db, zStr); 935 return z; 936 } 937 938 /* 939 ** Print into memory obtained from sqlite3_malloc(). Omit the internal 940 ** %-conversion extensions. 941 */ 942 char *sqlite3_vmprintf(const char *zFormat, va_list ap){ 943 char *z; 944 char zBase[SQLITE_PRINT_BUF_SIZE]; 945 StrAccum acc; 946 947 #ifdef SQLITE_ENABLE_API_ARMOR 948 if( zFormat==0 ){ 949 (void)SQLITE_MISUSE_BKPT; 950 return 0; 951 } 952 #endif 953 #ifndef SQLITE_OMIT_AUTOINIT 954 if( sqlite3_initialize() ) return 0; 955 #endif 956 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), SQLITE_MAX_LENGTH); 957 acc.useMalloc = 2; 958 sqlite3VXPrintf(&acc, 0, zFormat, ap); 959 z = sqlite3StrAccumFinish(&acc); 960 return z; 961 } 962 963 /* 964 ** Print into memory obtained from sqlite3_malloc()(). Omit the internal 965 ** %-conversion extensions. 966 */ 967 char *sqlite3_mprintf(const char *zFormat, ...){ 968 va_list ap; 969 char *z; 970 #ifndef SQLITE_OMIT_AUTOINIT 971 if( sqlite3_initialize() ) return 0; 972 #endif 973 va_start(ap, zFormat); 974 z = sqlite3_vmprintf(zFormat, ap); 975 va_end(ap); 976 return z; 977 } 978 979 /* 980 ** sqlite3_snprintf() works like snprintf() except that it ignores the 981 ** current locale settings. This is important for SQLite because we 982 ** are not able to use a "," as the decimal point in place of "." as 983 ** specified by some locales. 984 ** 985 ** Oops: The first two arguments of sqlite3_snprintf() are backwards 986 ** from the snprintf() standard. Unfortunately, it is too late to change 987 ** this without breaking compatibility, so we just have to live with the 988 ** mistake. 989 ** 990 ** sqlite3_vsnprintf() is the varargs version. 991 */ 992 char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){ 993 StrAccum acc; 994 if( n<=0 ) return zBuf; 995 #ifdef SQLITE_ENABLE_API_ARMOR 996 if( zBuf==0 || zFormat==0 ) { 997 (void)SQLITE_MISUSE_BKPT; 998 if( zBuf ) zBuf[0] = 0; 999 return zBuf; 1000 } 1001 #endif 1002 sqlite3StrAccumInit(&acc, zBuf, n, 0); 1003 acc.useMalloc = 0; 1004 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1005 return sqlite3StrAccumFinish(&acc); 1006 } 1007 char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){ 1008 char *z; 1009 va_list ap; 1010 va_start(ap,zFormat); 1011 z = sqlite3_vsnprintf(n, zBuf, zFormat, ap); 1012 va_end(ap); 1013 return z; 1014 } 1015 1016 /* 1017 ** This is the routine that actually formats the sqlite3_log() message. 1018 ** We house it in a separate routine from sqlite3_log() to avoid using 1019 ** stack space on small-stack systems when logging is disabled. 1020 ** 1021 ** sqlite3_log() must render into a static buffer. It cannot dynamically 1022 ** allocate memory because it might be called while the memory allocator 1023 ** mutex is held. 1024 */ 1025 static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){ 1026 StrAccum acc; /* String accumulator */ 1027 char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */ 1028 1029 sqlite3StrAccumInit(&acc, zMsg, sizeof(zMsg), 0); 1030 acc.useMalloc = 0; 1031 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1032 sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode, 1033 sqlite3StrAccumFinish(&acc)); 1034 } 1035 1036 /* 1037 ** Format and write a message to the log if logging is enabled. 1038 */ 1039 void sqlite3_log(int iErrCode, const char *zFormat, ...){ 1040 va_list ap; /* Vararg list */ 1041 if( sqlite3GlobalConfig.xLog ){ 1042 va_start(ap, zFormat); 1043 renderLogMsg(iErrCode, zFormat, ap); 1044 va_end(ap); 1045 } 1046 } 1047 1048 #if defined(SQLITE_DEBUG) 1049 /* 1050 ** A version of printf() that understands %lld. Used for debugging. 1051 ** The printf() built into some versions of windows does not understand %lld 1052 ** and segfaults if you give it a long long int. 1053 */ 1054 void sqlite3DebugPrintf(const char *zFormat, ...){ 1055 va_list ap; 1056 StrAccum acc; 1057 char zBuf[500]; 1058 sqlite3StrAccumInit(&acc, zBuf, sizeof(zBuf), 0); 1059 acc.useMalloc = 0; 1060 va_start(ap,zFormat); 1061 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1062 va_end(ap); 1063 sqlite3StrAccumFinish(&acc); 1064 fprintf(stdout,"%s", zBuf); 1065 fflush(stdout); 1066 } 1067 #endif 1068 1069 #ifdef SQLITE_DEBUG 1070 /************************************************************************* 1071 ** Routines for implementing the "TreeView" display of hierarchical 1072 ** data structures for debugging. 1073 ** 1074 ** The main entry points (coded elsewhere) are: 1075 ** sqlite3TreeViewExpr(0, pExpr, 0); 1076 ** sqlite3TreeViewExprList(0, pList, 0, 0); 1077 ** sqlite3TreeViewSelect(0, pSelect, 0); 1078 ** Insert calls to those routines while debugging in order to display 1079 ** a diagram of Expr, ExprList, and Select objects. 1080 ** 1081 */ 1082 /* Add a new subitem to the tree. The moreToFollow flag indicates that this 1083 ** is not the last item in the tree. */ 1084 TreeView *sqlite3TreeViewPush(TreeView *p, u8 moreToFollow){ 1085 if( p==0 ){ 1086 p = sqlite3_malloc( sizeof(*p) ); 1087 if( p==0 ) return 0; 1088 memset(p, 0, sizeof(*p)); 1089 }else{ 1090 p->iLevel++; 1091 } 1092 assert( moreToFollow==0 || moreToFollow==1 ); 1093 if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow; 1094 return p; 1095 } 1096 /* Finished with one layer of the tree */ 1097 void sqlite3TreeViewPop(TreeView *p){ 1098 if( p==0 ) return; 1099 p->iLevel--; 1100 if( p->iLevel<0 ) sqlite3_free(p); 1101 } 1102 /* Generate a single line of output for the tree, with a prefix that contains 1103 ** all the appropriate tree lines */ 1104 void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){ 1105 va_list ap; 1106 int i; 1107 StrAccum acc; 1108 char zBuf[500]; 1109 sqlite3StrAccumInit(&acc, zBuf, sizeof(zBuf), 0); 1110 acc.useMalloc = 0; 1111 if( p ){ 1112 for(i=0; i<p->iLevel && i<sizeof(p->bLine)-1; i++){ 1113 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "| " : " ", 4); 1114 } 1115 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "|-- " : "'-- ", 4); 1116 } 1117 va_start(ap, zFormat); 1118 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1119 va_end(ap); 1120 if( zBuf[acc.nChar-1]!='\n' ) sqlite3StrAccumAppend(&acc, "\n", 1); 1121 sqlite3StrAccumFinish(&acc); 1122 fprintf(stdout,"%s", zBuf); 1123 fflush(stdout); 1124 } 1125 /* Shorthand for starting a new tree item that consists of a single label */ 1126 void sqlite3TreeViewItem(TreeView *p, const char *zLabel, u8 moreToFollow){ 1127 p = sqlite3TreeViewPush(p, moreToFollow); 1128 sqlite3TreeViewLine(p, "%s", zLabel); 1129 } 1130 #endif /* SQLITE_DEBUG */ 1131 1132 /* 1133 ** variable-argument wrapper around sqlite3VXPrintf(). 1134 */ 1135 void sqlite3XPrintf(StrAccum *p, u32 bFlags, const char *zFormat, ...){ 1136 va_list ap; 1137 va_start(ap,zFormat); 1138 sqlite3VXPrintf(p, bFlags, zFormat, ap); 1139 va_end(ap); 1140 } 1141