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; /* 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 while( (c=(*++fmt))!='%' && c!=0 ){}; 228 sqlite3StrAccumAppend(pAccum, bufpt, (int)(fmt - bufpt)); 229 if( c==0 ) break; 230 } 231 if( (c=(*++fmt))==0 ){ 232 sqlite3StrAccumAppend(pAccum, "%", 1); 233 break; 234 } 235 /* Find out what flags are present */ 236 flag_leftjustify = flag_plussign = flag_blanksign = 237 flag_alternateform = flag_altform2 = flag_zeropad = 0; 238 done = 0; 239 do{ 240 switch( c ){ 241 case '-': flag_leftjustify = 1; break; 242 case '+': flag_plussign = 1; break; 243 case ' ': flag_blanksign = 1; break; 244 case '#': flag_alternateform = 1; break; 245 case '!': flag_altform2 = 1; break; 246 case '0': flag_zeropad = 1; break; 247 default: done = 1; break; 248 } 249 }while( !done && (c=(*++fmt))!=0 ); 250 /* Get the field width */ 251 width = 0; 252 if( c=='*' ){ 253 if( bArgList ){ 254 width = (int)getIntArg(pArgList); 255 }else{ 256 width = va_arg(ap,int); 257 } 258 if( width<0 ){ 259 flag_leftjustify = 1; 260 width = -width; 261 } 262 c = *++fmt; 263 }else{ 264 while( c>='0' && c<='9' ){ 265 width = width*10 + c - '0'; 266 c = *++fmt; 267 } 268 } 269 /* Get the precision */ 270 if( c=='.' ){ 271 precision = 0; 272 c = *++fmt; 273 if( c=='*' ){ 274 if( bArgList ){ 275 precision = (int)getIntArg(pArgList); 276 }else{ 277 precision = va_arg(ap,int); 278 } 279 if( precision<0 ) precision = -precision; 280 c = *++fmt; 281 }else{ 282 while( c>='0' && c<='9' ){ 283 precision = precision*10 + c - '0'; 284 c = *++fmt; 285 } 286 } 287 }else{ 288 precision = -1; 289 } 290 /* Get the conversion type modifier */ 291 if( c=='l' ){ 292 flag_long = 1; 293 c = *++fmt; 294 if( c=='l' ){ 295 flag_longlong = 1; 296 c = *++fmt; 297 }else{ 298 flag_longlong = 0; 299 } 300 }else{ 301 flag_long = flag_longlong = 0; 302 } 303 /* Fetch the info entry for the field */ 304 infop = &fmtinfo[0]; 305 xtype = etINVALID; 306 for(idx=0; idx<ArraySize(fmtinfo); idx++){ 307 if( c==fmtinfo[idx].fmttype ){ 308 infop = &fmtinfo[idx]; 309 if( useIntern || (infop->flags & FLAG_INTERN)==0 ){ 310 xtype = infop->type; 311 }else{ 312 return; 313 } 314 break; 315 } 316 } 317 zExtra = 0; 318 319 /* 320 ** At this point, variables are initialized as follows: 321 ** 322 ** flag_alternateform TRUE if a '#' is present. 323 ** flag_altform2 TRUE if a '!' is present. 324 ** flag_plussign TRUE if a '+' is present. 325 ** flag_leftjustify TRUE if a '-' is present or if the 326 ** field width was negative. 327 ** flag_zeropad TRUE if the width began with 0. 328 ** flag_long TRUE if the letter 'l' (ell) prefixed 329 ** the conversion character. 330 ** flag_longlong TRUE if the letter 'll' (ell ell) prefixed 331 ** the conversion character. 332 ** flag_blanksign TRUE if a ' ' is present. 333 ** width The specified field width. This is 334 ** always non-negative. Zero is the default. 335 ** precision The specified precision. The default 336 ** is -1. 337 ** xtype The class of the conversion. 338 ** infop Pointer to the appropriate info struct. 339 */ 340 switch( xtype ){ 341 case etPOINTER: 342 flag_longlong = sizeof(char*)==sizeof(i64); 343 flag_long = sizeof(char*)==sizeof(long int); 344 /* Fall through into the next case */ 345 case etORDINAL: 346 case etRADIX: 347 if( infop->flags & FLAG_SIGNED ){ 348 i64 v; 349 if( bArgList ){ 350 v = getIntArg(pArgList); 351 }else if( flag_longlong ){ 352 v = va_arg(ap,i64); 353 }else if( flag_long ){ 354 v = va_arg(ap,long int); 355 }else{ 356 v = va_arg(ap,int); 357 } 358 if( v<0 ){ 359 if( v==SMALLEST_INT64 ){ 360 longvalue = ((u64)1)<<63; 361 }else{ 362 longvalue = -v; 363 } 364 prefix = '-'; 365 }else{ 366 longvalue = v; 367 if( flag_plussign ) prefix = '+'; 368 else if( flag_blanksign ) prefix = ' '; 369 else prefix = 0; 370 } 371 }else{ 372 if( bArgList ){ 373 longvalue = (u64)getIntArg(pArgList); 374 }else if( flag_longlong ){ 375 longvalue = va_arg(ap,u64); 376 }else if( flag_long ){ 377 longvalue = va_arg(ap,unsigned long int); 378 }else{ 379 longvalue = va_arg(ap,unsigned int); 380 } 381 prefix = 0; 382 } 383 if( longvalue==0 ) flag_alternateform = 0; 384 if( flag_zeropad && precision<width-(prefix!=0) ){ 385 precision = width-(prefix!=0); 386 } 387 if( precision<etBUFSIZE-10 ){ 388 nOut = etBUFSIZE; 389 zOut = buf; 390 }else{ 391 nOut = precision + 10; 392 zOut = zExtra = sqlite3Malloc( nOut ); 393 if( zOut==0 ){ 394 setStrAccumError(pAccum, STRACCUM_NOMEM); 395 return; 396 } 397 } 398 bufpt = &zOut[nOut-1]; 399 if( xtype==etORDINAL ){ 400 static const char zOrd[] = "thstndrd"; 401 int x = (int)(longvalue % 10); 402 if( x>=4 || (longvalue/10)%10==1 ){ 403 x = 0; 404 } 405 *(--bufpt) = zOrd[x*2+1]; 406 *(--bufpt) = zOrd[x*2]; 407 } 408 { 409 const char *cset = &aDigits[infop->charset]; 410 u8 base = infop->base; 411 do{ /* Convert to ascii */ 412 *(--bufpt) = cset[longvalue%base]; 413 longvalue = longvalue/base; 414 }while( longvalue>0 ); 415 } 416 length = (int)(&zOut[nOut-1]-bufpt); 417 for(idx=precision-length; idx>0; idx--){ 418 *(--bufpt) = '0'; /* Zero pad */ 419 } 420 if( prefix ) *(--bufpt) = prefix; /* Add sign */ 421 if( flag_alternateform && infop->prefix ){ /* Add "0" or "0x" */ 422 const char *pre; 423 char x; 424 pre = &aPrefix[infop->prefix]; 425 for(; (x=(*pre))!=0; pre++) *(--bufpt) = x; 426 } 427 length = (int)(&zOut[nOut-1]-bufpt); 428 break; 429 case etFLOAT: 430 case etEXP: 431 case etGENERIC: 432 if( bArgList ){ 433 realvalue = getDoubleArg(pArgList); 434 }else{ 435 realvalue = va_arg(ap,double); 436 } 437 #ifdef SQLITE_OMIT_FLOATING_POINT 438 length = 0; 439 #else 440 if( precision<0 ) precision = 6; /* Set default precision */ 441 if( realvalue<0.0 ){ 442 realvalue = -realvalue; 443 prefix = '-'; 444 }else{ 445 if( flag_plussign ) prefix = '+'; 446 else if( flag_blanksign ) prefix = ' '; 447 else prefix = 0; 448 } 449 if( xtype==etGENERIC && precision>0 ) precision--; 450 for(idx=precision, rounder=0.5; idx>0; idx--, rounder*=0.1){} 451 if( xtype==etFLOAT ) realvalue += rounder; 452 /* Normalize realvalue to within 10.0 > realvalue >= 1.0 */ 453 exp = 0; 454 if( sqlite3IsNaN((double)realvalue) ){ 455 bufpt = "NaN"; 456 length = 3; 457 break; 458 } 459 if( realvalue>0.0 ){ 460 LONGDOUBLE_TYPE scale = 1.0; 461 while( realvalue>=1e100*scale && exp<=350 ){ scale *= 1e100;exp+=100;} 462 while( realvalue>=1e64*scale && exp<=350 ){ scale *= 1e64; exp+=64; } 463 while( realvalue>=1e8*scale && exp<=350 ){ scale *= 1e8; exp+=8; } 464 while( realvalue>=10.0*scale && exp<=350 ){ scale *= 10.0; exp++; } 465 realvalue /= scale; 466 while( realvalue<1e-8 ){ realvalue *= 1e8; exp-=8; } 467 while( realvalue<1.0 ){ realvalue *= 10.0; exp--; } 468 if( exp>350 ){ 469 if( prefix=='-' ){ 470 bufpt = "-Inf"; 471 }else if( prefix=='+' ){ 472 bufpt = "+Inf"; 473 }else{ 474 bufpt = "Inf"; 475 } 476 length = sqlite3Strlen30(bufpt); 477 break; 478 } 479 } 480 bufpt = buf; 481 /* 482 ** If the field type is etGENERIC, then convert to either etEXP 483 ** or etFLOAT, as appropriate. 484 */ 485 if( xtype!=etFLOAT ){ 486 realvalue += rounder; 487 if( realvalue>=10.0 ){ realvalue *= 0.1; exp++; } 488 } 489 if( xtype==etGENERIC ){ 490 flag_rtz = !flag_alternateform; 491 if( exp<-4 || exp>precision ){ 492 xtype = etEXP; 493 }else{ 494 precision = precision - exp; 495 xtype = etFLOAT; 496 } 497 }else{ 498 flag_rtz = flag_altform2; 499 } 500 if( xtype==etEXP ){ 501 e2 = 0; 502 }else{ 503 e2 = exp; 504 } 505 if( MAX(e2,0)+precision+width > etBUFSIZE - 15 ){ 506 bufpt = zExtra = sqlite3Malloc( MAX(e2,0)+precision+width+15 ); 507 if( bufpt==0 ){ 508 setStrAccumError(pAccum, STRACCUM_NOMEM); 509 return; 510 } 511 } 512 zOut = bufpt; 513 nsd = 16 + flag_altform2*10; 514 flag_dp = (precision>0 ?1:0) | flag_alternateform | flag_altform2; 515 /* The sign in front of the number */ 516 if( prefix ){ 517 *(bufpt++) = prefix; 518 } 519 /* Digits prior to the decimal point */ 520 if( e2<0 ){ 521 *(bufpt++) = '0'; 522 }else{ 523 for(; e2>=0; e2--){ 524 *(bufpt++) = et_getdigit(&realvalue,&nsd); 525 } 526 } 527 /* The decimal point */ 528 if( flag_dp ){ 529 *(bufpt++) = '.'; 530 } 531 /* "0" digits after the decimal point but before the first 532 ** significant digit of the number */ 533 for(e2++; e2<0; precision--, e2++){ 534 assert( precision>0 ); 535 *(bufpt++) = '0'; 536 } 537 /* Significant digits after the decimal point */ 538 while( (precision--)>0 ){ 539 *(bufpt++) = et_getdigit(&realvalue,&nsd); 540 } 541 /* Remove trailing zeros and the "." if no digits follow the "." */ 542 if( flag_rtz && flag_dp ){ 543 while( bufpt[-1]=='0' ) *(--bufpt) = 0; 544 assert( bufpt>zOut ); 545 if( bufpt[-1]=='.' ){ 546 if( flag_altform2 ){ 547 *(bufpt++) = '0'; 548 }else{ 549 *(--bufpt) = 0; 550 } 551 } 552 } 553 /* Add the "eNNN" suffix */ 554 if( xtype==etEXP ){ 555 *(bufpt++) = aDigits[infop->charset]; 556 if( exp<0 ){ 557 *(bufpt++) = '-'; exp = -exp; 558 }else{ 559 *(bufpt++) = '+'; 560 } 561 if( exp>=100 ){ 562 *(bufpt++) = (char)((exp/100)+'0'); /* 100's digit */ 563 exp %= 100; 564 } 565 *(bufpt++) = (char)(exp/10+'0'); /* 10's digit */ 566 *(bufpt++) = (char)(exp%10+'0'); /* 1's digit */ 567 } 568 *bufpt = 0; 569 570 /* The converted number is in buf[] and zero terminated. Output it. 571 ** Note that the number is in the usual order, not reversed as with 572 ** integer conversions. */ 573 length = (int)(bufpt-zOut); 574 bufpt = zOut; 575 576 /* Special case: Add leading zeros if the flag_zeropad flag is 577 ** set and we are not left justified */ 578 if( flag_zeropad && !flag_leftjustify && length < width){ 579 int i; 580 int nPad = width - length; 581 for(i=width; i>=nPad; i--){ 582 bufpt[i] = bufpt[i-nPad]; 583 } 584 i = prefix!=0; 585 while( nPad-- ) bufpt[i++] = '0'; 586 length = width; 587 } 588 #endif /* !defined(SQLITE_OMIT_FLOATING_POINT) */ 589 break; 590 case etSIZE: 591 if( !bArgList ){ 592 *(va_arg(ap,int*)) = pAccum->nChar; 593 } 594 length = width = 0; 595 break; 596 case etPERCENT: 597 buf[0] = '%'; 598 bufpt = buf; 599 length = 1; 600 break; 601 case etCHARX: 602 if( bArgList ){ 603 bufpt = getTextArg(pArgList); 604 c = bufpt ? bufpt[0] : 0; 605 }else{ 606 c = va_arg(ap,int); 607 } 608 buf[0] = (char)c; 609 if( precision>=0 ){ 610 for(idx=1; idx<precision; idx++) buf[idx] = (char)c; 611 length = precision; 612 }else{ 613 length =1; 614 } 615 bufpt = buf; 616 break; 617 case etSTRING: 618 case etDYNSTRING: 619 if( bArgList ){ 620 bufpt = getTextArg(pArgList); 621 }else{ 622 bufpt = va_arg(ap,char*); 623 } 624 if( bufpt==0 ){ 625 bufpt = ""; 626 }else if( xtype==etDYNSTRING && !bArgList ){ 627 zExtra = bufpt; 628 } 629 if( precision>=0 ){ 630 for(length=0; length<precision && bufpt[length]; length++){} 631 }else{ 632 length = sqlite3Strlen30(bufpt); 633 } 634 break; 635 case etSQLESCAPE: 636 case etSQLESCAPE2: 637 case etSQLESCAPE3: { 638 int i, j, k, n, isnull; 639 int needQuote; 640 char ch; 641 char q = ((xtype==etSQLESCAPE3)?'"':'\''); /* Quote character */ 642 char *escarg; 643 644 if( bArgList ){ 645 escarg = getTextArg(pArgList); 646 }else{ 647 escarg = va_arg(ap,char*); 648 } 649 isnull = escarg==0; 650 if( isnull ) escarg = (xtype==etSQLESCAPE2 ? "NULL" : "(NULL)"); 651 k = precision; 652 for(i=n=0; k!=0 && (ch=escarg[i])!=0; i++, k--){ 653 if( ch==q ) n++; 654 } 655 needQuote = !isnull && xtype==etSQLESCAPE2; 656 n += i + 1 + needQuote*2; 657 if( n>etBUFSIZE ){ 658 bufpt = zExtra = sqlite3Malloc( n ); 659 if( bufpt==0 ){ 660 setStrAccumError(pAccum, STRACCUM_NOMEM); 661 return; 662 } 663 }else{ 664 bufpt = buf; 665 } 666 j = 0; 667 if( needQuote ) bufpt[j++] = q; 668 k = i; 669 for(i=0; i<k; i++){ 670 bufpt[j++] = ch = escarg[i]; 671 if( ch==q ) bufpt[j++] = ch; 672 } 673 if( needQuote ) bufpt[j++] = q; 674 bufpt[j] = 0; 675 length = j; 676 /* The precision in %q and %Q means how many input characters to 677 ** consume, not the length of the output... 678 ** if( precision>=0 && precision<length ) length = precision; */ 679 break; 680 } 681 case etTOKEN: { 682 Token *pToken = va_arg(ap, Token*); 683 assert( bArgList==0 ); 684 if( pToken && pToken->n ){ 685 sqlite3StrAccumAppend(pAccum, (const char*)pToken->z, pToken->n); 686 } 687 length = width = 0; 688 break; 689 } 690 case etSRCLIST: { 691 SrcList *pSrc = va_arg(ap, SrcList*); 692 int k = va_arg(ap, int); 693 struct SrcList_item *pItem = &pSrc->a[k]; 694 assert( bArgList==0 ); 695 assert( k>=0 && k<pSrc->nSrc ); 696 if( pItem->zDatabase ){ 697 sqlite3StrAccumAppendAll(pAccum, pItem->zDatabase); 698 sqlite3StrAccumAppend(pAccum, ".", 1); 699 } 700 sqlite3StrAccumAppendAll(pAccum, pItem->zName); 701 length = width = 0; 702 break; 703 } 704 default: { 705 assert( xtype==etINVALID ); 706 return; 707 } 708 }/* End switch over the format type */ 709 /* 710 ** The text of the conversion is pointed to by "bufpt" and is 711 ** "length" characters long. The field width is "width". Do 712 ** the output. 713 */ 714 width -= length; 715 if( width>0 && !flag_leftjustify ) sqlite3AppendSpace(pAccum, width); 716 sqlite3StrAccumAppend(pAccum, bufpt, length); 717 if( width>0 && flag_leftjustify ) sqlite3AppendSpace(pAccum, width); 718 719 if( zExtra ) sqlite3_free(zExtra); 720 }/* End for loop over the format string */ 721 } /* End of function */ 722 723 /* 724 ** Enlarge the memory allocation on a StrAccum object so that it is 725 ** able to accept at least N more bytes of text. 726 ** 727 ** Return the number of bytes of text that StrAccum is able to accept 728 ** after the attempted enlargement. The value returned might be zero. 729 */ 730 static int sqlite3StrAccumEnlarge(StrAccum *p, int N){ 731 char *zNew; 732 assert( p->nChar+N >= p->nAlloc ); /* Only called if really needed */ 733 if( p->accError ){ 734 testcase(p->accError==STRACCUM_TOOBIG); 735 testcase(p->accError==STRACCUM_NOMEM); 736 return 0; 737 } 738 if( !p->useMalloc ){ 739 N = p->nAlloc - p->nChar - 1; 740 setStrAccumError(p, STRACCUM_TOOBIG); 741 return N; 742 }else{ 743 char *zOld = (p->zText==p->zBase ? 0 : p->zText); 744 i64 szNew = p->nChar; 745 szNew += N + 1; 746 if( szNew > p->mxAlloc ){ 747 sqlite3StrAccumReset(p); 748 setStrAccumError(p, STRACCUM_TOOBIG); 749 return 0; 750 }else{ 751 p->nAlloc = (int)szNew; 752 } 753 if( p->useMalloc==1 ){ 754 zNew = sqlite3DbRealloc(p->db, zOld, p->nAlloc); 755 }else{ 756 zNew = sqlite3_realloc(zOld, p->nAlloc); 757 } 758 if( zNew ){ 759 assert( p->zText!=0 || p->nChar==0 ); 760 if( zOld==0 && p->nChar>0 ) memcpy(zNew, p->zText, p->nChar); 761 p->zText = zNew; 762 }else{ 763 sqlite3StrAccumReset(p); 764 setStrAccumError(p, STRACCUM_NOMEM); 765 return 0; 766 } 767 } 768 return N; 769 } 770 771 /* 772 ** Append N space characters to the given string buffer. 773 */ 774 void sqlite3AppendSpace(StrAccum *p, int N){ 775 if( p->nChar+N >= p->nAlloc && (N = sqlite3StrAccumEnlarge(p, N))<=0 ) return; 776 while( (N--)>0 ) p->zText[p->nChar++] = ' '; 777 } 778 779 /* 780 ** The StrAccum "p" is not large enough to accept N new bytes of z[]. 781 ** So enlarge if first, then do the append. 782 ** 783 ** This is a helper routine to sqlite3StrAccumAppend() that does special-case 784 ** work (enlarging the buffer) using tail recursion, so that the 785 ** sqlite3StrAccumAppend() routine can use fast calling semantics. 786 */ 787 static void SQLITE_NOINLINE enlargeAndAppend(StrAccum *p, const char *z, int N){ 788 N = sqlite3StrAccumEnlarge(p, N); 789 if( N>0 ){ 790 memcpy(&p->zText[p->nChar], z, N); 791 p->nChar += N; 792 } 793 } 794 795 /* 796 ** Append N bytes of text from z to the StrAccum object. Increase the 797 ** size of the memory allocation for StrAccum if necessary. 798 */ 799 void sqlite3StrAccumAppend(StrAccum *p, const char *z, int N){ 800 assert( z!=0 ); 801 assert( p->zText!=0 || p->nChar==0 || p->accError ); 802 assert( N>=0 ); 803 assert( p->accError==0 || p->nAlloc==0 ); 804 if( p->nChar+N >= p->nAlloc ){ 805 enlargeAndAppend(p,z,N); 806 }else{ 807 assert( p->zText ); 808 p->nChar += N; 809 memcpy(&p->zText[p->nChar-N], z, N); 810 } 811 } 812 813 /* 814 ** Append the complete text of zero-terminated string z[] to the p string. 815 */ 816 void sqlite3StrAccumAppendAll(StrAccum *p, const char *z){ 817 sqlite3StrAccumAppend(p, z, sqlite3Strlen30(z)); 818 } 819 820 821 /* 822 ** Finish off a string by making sure it is zero-terminated. 823 ** Return a pointer to the resulting string. Return a NULL 824 ** pointer if any kind of error was encountered. 825 */ 826 char *sqlite3StrAccumFinish(StrAccum *p){ 827 if( p->zText ){ 828 p->zText[p->nChar] = 0; 829 if( p->useMalloc && p->zText==p->zBase ){ 830 if( p->useMalloc==1 ){ 831 p->zText = sqlite3DbMallocRaw(p->db, p->nChar+1 ); 832 }else{ 833 p->zText = sqlite3_malloc(p->nChar+1); 834 } 835 if( p->zText ){ 836 memcpy(p->zText, p->zBase, p->nChar+1); 837 }else{ 838 setStrAccumError(p, STRACCUM_NOMEM); 839 } 840 } 841 } 842 return p->zText; 843 } 844 845 /* 846 ** Reset an StrAccum string. Reclaim all malloced memory. 847 */ 848 void sqlite3StrAccumReset(StrAccum *p){ 849 if( p->zText!=p->zBase ){ 850 if( p->useMalloc==1 ){ 851 sqlite3DbFree(p->db, p->zText); 852 }else{ 853 sqlite3_free(p->zText); 854 } 855 } 856 p->zText = 0; 857 } 858 859 /* 860 ** Initialize a string accumulator 861 */ 862 void sqlite3StrAccumInit(StrAccum *p, char *zBase, int n, int mx){ 863 p->zText = p->zBase = zBase; 864 p->db = 0; 865 p->nChar = 0; 866 p->nAlloc = n; 867 p->mxAlloc = mx; 868 p->useMalloc = 1; 869 p->accError = 0; 870 } 871 872 /* 873 ** Print into memory obtained from sqliteMalloc(). Use the internal 874 ** %-conversion extensions. 875 */ 876 char *sqlite3VMPrintf(sqlite3 *db, const char *zFormat, va_list ap){ 877 char *z; 878 char zBase[SQLITE_PRINT_BUF_SIZE]; 879 StrAccum acc; 880 assert( db!=0 ); 881 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), 882 db->aLimit[SQLITE_LIMIT_LENGTH]); 883 acc.db = db; 884 sqlite3VXPrintf(&acc, SQLITE_PRINTF_INTERNAL, zFormat, ap); 885 z = sqlite3StrAccumFinish(&acc); 886 if( acc.accError==STRACCUM_NOMEM ){ 887 db->mallocFailed = 1; 888 } 889 return z; 890 } 891 892 /* 893 ** Print into memory obtained from sqliteMalloc(). Use the internal 894 ** %-conversion extensions. 895 */ 896 char *sqlite3MPrintf(sqlite3 *db, const char *zFormat, ...){ 897 va_list ap; 898 char *z; 899 va_start(ap, zFormat); 900 z = sqlite3VMPrintf(db, zFormat, ap); 901 va_end(ap); 902 return z; 903 } 904 905 /* 906 ** Like sqlite3MPrintf(), but call sqlite3DbFree() on zStr after formatting 907 ** the string and before returning. This routine is intended to be used 908 ** to modify an existing string. For example: 909 ** 910 ** x = sqlite3MPrintf(db, x, "prefix %s suffix", x); 911 ** 912 */ 913 char *sqlite3MAppendf(sqlite3 *db, char *zStr, const char *zFormat, ...){ 914 va_list ap; 915 char *z; 916 va_start(ap, zFormat); 917 z = sqlite3VMPrintf(db, zFormat, ap); 918 va_end(ap); 919 sqlite3DbFree(db, zStr); 920 return z; 921 } 922 923 /* 924 ** Print into memory obtained from sqlite3_malloc(). Omit the internal 925 ** %-conversion extensions. 926 */ 927 char *sqlite3_vmprintf(const char *zFormat, va_list ap){ 928 char *z; 929 char zBase[SQLITE_PRINT_BUF_SIZE]; 930 StrAccum acc; 931 #ifndef SQLITE_OMIT_AUTOINIT 932 if( sqlite3_initialize() ) return 0; 933 #endif 934 sqlite3StrAccumInit(&acc, zBase, sizeof(zBase), SQLITE_MAX_LENGTH); 935 acc.useMalloc = 2; 936 sqlite3VXPrintf(&acc, 0, zFormat, ap); 937 z = sqlite3StrAccumFinish(&acc); 938 return z; 939 } 940 941 /* 942 ** Print into memory obtained from sqlite3_malloc()(). Omit the internal 943 ** %-conversion extensions. 944 */ 945 char *sqlite3_mprintf(const char *zFormat, ...){ 946 va_list ap; 947 char *z; 948 #ifndef SQLITE_OMIT_AUTOINIT 949 if( sqlite3_initialize() ) return 0; 950 #endif 951 va_start(ap, zFormat); 952 z = sqlite3_vmprintf(zFormat, ap); 953 va_end(ap); 954 return z; 955 } 956 957 /* 958 ** sqlite3_snprintf() works like snprintf() except that it ignores the 959 ** current locale settings. This is important for SQLite because we 960 ** are not able to use a "," as the decimal point in place of "." as 961 ** specified by some locales. 962 ** 963 ** Oops: The first two arguments of sqlite3_snprintf() are backwards 964 ** from the snprintf() standard. Unfortunately, it is too late to change 965 ** this without breaking compatibility, so we just have to live with the 966 ** mistake. 967 ** 968 ** sqlite3_vsnprintf() is the varargs version. 969 */ 970 char *sqlite3_vsnprintf(int n, char *zBuf, const char *zFormat, va_list ap){ 971 StrAccum acc; 972 if( n<=0 ) return zBuf; 973 sqlite3StrAccumInit(&acc, zBuf, n, 0); 974 acc.useMalloc = 0; 975 sqlite3VXPrintf(&acc, 0, zFormat, ap); 976 return sqlite3StrAccumFinish(&acc); 977 } 978 char *sqlite3_snprintf(int n, char *zBuf, const char *zFormat, ...){ 979 char *z; 980 va_list ap; 981 va_start(ap,zFormat); 982 z = sqlite3_vsnprintf(n, zBuf, zFormat, ap); 983 va_end(ap); 984 return z; 985 } 986 987 /* 988 ** This is the routine that actually formats the sqlite3_log() message. 989 ** We house it in a separate routine from sqlite3_log() to avoid using 990 ** stack space on small-stack systems when logging is disabled. 991 ** 992 ** sqlite3_log() must render into a static buffer. It cannot dynamically 993 ** allocate memory because it might be called while the memory allocator 994 ** mutex is held. 995 */ 996 static void renderLogMsg(int iErrCode, const char *zFormat, va_list ap){ 997 StrAccum acc; /* String accumulator */ 998 char zMsg[SQLITE_PRINT_BUF_SIZE*3]; /* Complete log message */ 999 1000 sqlite3StrAccumInit(&acc, zMsg, sizeof(zMsg), 0); 1001 acc.useMalloc = 0; 1002 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1003 sqlite3GlobalConfig.xLog(sqlite3GlobalConfig.pLogArg, iErrCode, 1004 sqlite3StrAccumFinish(&acc)); 1005 } 1006 1007 /* 1008 ** Format and write a message to the log if logging is enabled. 1009 */ 1010 void sqlite3_log(int iErrCode, const char *zFormat, ...){ 1011 va_list ap; /* Vararg list */ 1012 if( sqlite3GlobalConfig.xLog ){ 1013 va_start(ap, zFormat); 1014 renderLogMsg(iErrCode, zFormat, ap); 1015 va_end(ap); 1016 } 1017 } 1018 1019 #if defined(SQLITE_DEBUG) 1020 /* 1021 ** A version of printf() that understands %lld. Used for debugging. 1022 ** The printf() built into some versions of windows does not understand %lld 1023 ** and segfaults if you give it a long long int. 1024 */ 1025 void sqlite3DebugPrintf(const char *zFormat, ...){ 1026 va_list ap; 1027 StrAccum acc; 1028 char zBuf[500]; 1029 sqlite3StrAccumInit(&acc, zBuf, sizeof(zBuf), 0); 1030 acc.useMalloc = 0; 1031 va_start(ap,zFormat); 1032 sqlite3VXPrintf(&acc, 0, zFormat, ap); 1033 va_end(ap); 1034 sqlite3StrAccumFinish(&acc); 1035 fprintf(stdout,"%s", zBuf); 1036 fflush(stdout); 1037 } 1038 #endif 1039 1040 /* 1041 ** variable-argument wrapper around sqlite3VXPrintf(). 1042 */ 1043 void sqlite3XPrintf(StrAccum *p, u32 bFlags, const char *zFormat, ...){ 1044 va_list ap; 1045 va_start(ap,zFormat); 1046 sqlite3VXPrintf(p, bFlags, zFormat, ap); 1047 va_end(ap); 1048 } 1049