include/wx/private/wxprintf.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/private/wxprintf.h
   3 // Purpose:     wxWidgets wxPrintf() implementation
   4 // Author:      Ove Kaven
   5 // Modified by: Ron Lee, Francesco Montorsi
   6 // Created:     09/04/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWidgets copyright
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PRIVATE_WXPRINTF_H_
  13 #define _WX_PRIVATE_WXPRINTF_H_
  14
  15 // ---------------------------------------------------------------------------
  16 // headers and macros
  17 // ---------------------------------------------------------------------------
  18
  19 #include "wx/crt.h"
  20 #include "wx/log.h"
  21 #include "wx/utils.h"
  22
  23 #include <string.h>
  24
  25 #if defined(__MWERKS__) && __MSL__ >= 0x6000
  26 namespace std {}
  27 using namespace std ;
  28 #endif
  29
  30 // prefer snprintf over sprintf
  31 #if defined(__VISUALC__) || \
  32         (defined(__BORLANDC__) && __BORLANDC__ >= 0x540)
  33     #define system_sprintf(buff, max, flags, data)      \
  34         ::_snprintf(buff, max, flags, data)
  35 #elif defined(HAVE_SNPRINTF)
  36     #define system_sprintf(buff, max, flags, data)      \
  37         ::snprintf(buff, max, flags, data)
  38 #else       // NB: at least sprintf() should always be available
  39     // since 'max' is not used in this case, wxVsnprintf() should always
  40     // ensure that 'buff' is big enough for all common needs
  41     // (see wxMAX_SVNPRINTF_FLAGBUFFER_LEN and wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN)
  42     #define system_sprintf(buff, max, flags, data)      \
  43         ::sprintf(buff, flags, data)
  44
  45     #define SYSTEM_SPRINTF_IS_UNSAFE
  46 #endif
  47
  48 // ---------------------------------------------------------------------------
  49 // printf format string parsing
  50 // ---------------------------------------------------------------------------
  51
  52 // some limits of our implementation
  53 #define wxMAX_SVNPRINTF_ARGUMENTS         64
  54 #define wxMAX_SVNPRINTF_FLAGBUFFER_LEN    32
  55 #define wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN   512
  56
  57
  58 // the conversion specifiers accepted by wxCRT_VsnprintfW
  59 enum wxPrintfArgType
  60 {
  61     wxPAT_INVALID = -1,
  62
  63     wxPAT_INT,          // %d, %i, %o, %u, %x, %X
  64     wxPAT_LONGINT,      // %ld, etc
  65 #ifdef wxLongLong_t
  66     wxPAT_LONGLONGINT,  // %Ld, etc
  67 #endif
  68     wxPAT_SIZET,        // %Zd, etc
  69
  70     wxPAT_DOUBLE,       // %e, %E, %f, %g, %G
  71     wxPAT_LONGDOUBLE,   // %le, etc
  72
  73     wxPAT_POINTER,      // %p
  74
  75     wxPAT_CHAR,         // %hc  (in ANSI mode: %c, too)
  76     wxPAT_WCHAR,        // %lc  (in Unicode mode: %c, too)
  77
  78     wxPAT_PCHAR,        // %s   (related to a char *)
  79     wxPAT_PWCHAR,       // %s   (related to a wchar_t *)
  80
  81     wxPAT_NINT,         // %n
  82     wxPAT_NSHORTINT,    // %hn
  83     wxPAT_NLONGINT,     // %ln
  84
  85     wxPAT_STAR          // '*' used for width or precision
  86 };
  87
  88 // an argument passed to wxCRT_VsnprintfW
  89 union wxPrintfArg
  90 {
  91     int pad_int;                        //  %d, %i, %o, %u, %x, %X
  92     long int pad_longint;               // %ld, etc
  93 #ifdef wxLongLong_t
  94     wxLongLong_t pad_longlongint;       // %Ld, etc
  95 #endif
  96     size_t pad_sizet;                   // %Zd, etc
  97
  98     double pad_double;                  // %e, %E, %f, %g, %G
  99     long double pad_longdouble;         // %le, etc
 100
 101     void *pad_pointer;                  // %p
 102
 103     char pad_char;                      // %hc  (in ANSI mode: %c, too)
 104     wchar_t pad_wchar;                  // %lc  (in Unicode mode: %c, too)
 105
 106     void *pad_str;                      // %s
 107
 108     int *pad_nint;                      // %n
 109     short int *pad_nshortint;           // %hn
 110     long int *pad_nlongint;             // %ln
 111 };
 112
 113 // helper for converting string into either char* or wchar_t* depending
 114 // on the type of wxPrintfConvSpec<T> instantiation:
 115 template<typename CharType> struct wxPrintfStringHelper {};
 116
 117 template<> struct wxPrintfStringHelper<char>
 118 {
 119     typedef const wxWX2MBbuf ConvertedType;
 120     static ConvertedType Convert(const wxString& s) { return s.mb_str(); }
 121 };
 122
 123 template<> struct wxPrintfStringHelper<wchar_t>
 124 {
 125     typedef const wxWX2WCbuf ConvertedType;
 126     static ConvertedType Convert(const wxString& s) { return s.wc_str(); }
 127 };
 128
 129
 130 // Contains parsed data relative to a conversion specifier given to
 131 // wxCRT_VsnprintfW and parsed from the format string
 132 // NOTE: in C++ there is almost no difference between struct & classes thus
 133 //       there is no performance gain by using a struct here...
 134 template<typename CharType>
 135 class wxPrintfConvSpec
 136 {
 137 public:
 138
 139     // the position of the argument relative to this conversion specifier
 140     size_t m_pos;
 141
 142     // the type of this conversion specifier
 143     wxPrintfArgType m_type;
 144
 145     // the minimum and maximum width
 146     // when one of this var is set to -1 it means: use the following argument
 147     // in the stack as minimum/maximum width for this conversion specifier
 148     int m_nMinWidth, m_nMaxWidth;
 149
 150     // does the argument need to the be aligned to left ?
 151     bool m_bAlignLeft;
 152
 153     // pointer to the '%' of this conversion specifier in the format string
 154     // NOTE: this points somewhere in the string given to the Parse() function -
 155     //       it's task of the caller ensure that memory is still valid !
 156     const CharType *m_pArgPos;
 157
 158     // pointer to the last character of this conversion specifier in the
 159     // format string
 160     // NOTE: this points somewhere in the string given to the Parse() function -
 161     //       it's task of the caller ensure that memory is still valid !
 162     const CharType *m_pArgEnd;
 163
 164     // a little buffer where formatting flags like #+\.hlqLZ are stored by Parse()
 165     // for use in Process()
 166     char m_szFlags[wxMAX_SVNPRINTF_FLAGBUFFER_LEN];
 167
 168
 169 public:
 170
 171     // we don't declare this as a constructor otherwise it would be called
 172     // automatically and we don't want this: to be optimized, wxCRT_VsnprintfW
 173     // calls this function only on really-used instances of this class.
 174     void Init();
 175
 176     // Parses the first conversion specifier in the given string, which must
 177     // begin with a '%'. Returns false if the first '%' does not introduce a
 178     // (valid) conversion specifier and thus should be ignored.
 179     bool Parse(const CharType *format);
 180
 181     // Process this conversion specifier and puts the result in the given
 182     // buffer. Returns the number of characters written in 'buf' or -1 if
 183     // there's not enough space.
 184     int Process(CharType *buf, size_t lenMax, wxPrintfArg *p, size_t written);
 185
 186     // Loads the argument of this conversion specifier from given va_list.
 187     bool LoadArg(wxPrintfArg *p, va_list &argptr);
 188
 189 private:
 190     // An helper function of LoadArg() which is used to handle the '*' flag
 191     void ReplaceAsteriskWith(int w);
 192 };
 193
 194 template<typename CharType>
 195 void wxPrintfConvSpec<CharType>::Init()
 196 {
 197     m_nMinWidth = 0;
 198     m_nMaxWidth = 0xFFFF;
 199     m_pos = 0;
 200     m_bAlignLeft = false;
 201     m_pArgPos = m_pArgEnd = NULL;
 202     m_type = wxPAT_INVALID;
 203
 204     // this character will never be removed from m_szFlags array and
 205     // is important when calling sprintf() in wxPrintfConvSpec::Process() !
 206     m_szFlags[0] = '%';
 207 }
 208
 209 template<typename CharType>
 210 bool wxPrintfConvSpec<CharType>::Parse(const CharType *format)
 211 {
 212     bool done = false;
 213
 214     // temporary parse data
 215     size_t flagofs = 1;
 216     bool in_prec,       // true if we found the dot in some previous iteration
 217          prec_dot;      // true if the dot has been already added to m_szFlags
 218     int ilen = 0;
 219
 220     m_bAlignLeft = in_prec = prec_dot = false;
 221     m_pArgPos = m_pArgEnd = format;
 222     do
 223     {
 224 #define CHECK_PREC \
 225         if (in_prec && !prec_dot) \
 226         { \
 227             m_szFlags[flagofs++] = '.'; \
 228             prec_dot = true; \
 229         }
 230
 231         // what follows '%'?
 232         const CharType ch = *(++m_pArgEnd);
 233         switch ( ch )
 234         {
 235             case wxT('\0'):
 236                 return false;       // not really an argument
 237
 238             case wxT('%'):
 239                 return false;       // not really an argument
 240
 241             case wxT('#'):
 242             case wxT('0'):
 243             case wxT(' '):
 244             case wxT('+'):
 245             case wxT('\''):
 246                 CHECK_PREC
 247                 m_szFlags[flagofs++] = char(ch);
 248                 break;
 249
 250             case wxT('-'):
 251                 CHECK_PREC
 252                 m_bAlignLeft = true;
 253                 m_szFlags[flagofs++] = char(ch);
 254                 break;
 255
 256             case wxT('.'):
 257                 // don't use CHECK_PREC here to avoid warning about the value
 258                 // assigned to prec_dot inside it being never used (because
 259                 // overwritten just below) from Borland in release build
 260                 if (in_prec && !prec_dot)
 261                     m_szFlags[flagofs++] = '.';
 262                 in_prec = true;
 263                 prec_dot = false;
 264                 m_nMaxWidth = 0;
 265                 // dot will be auto-added to m_szFlags if non-negative
 266                 // number follows
 267                 break;
 268
 269             case wxT('h'):
 270                 ilen = -1;
 271                 CHECK_PREC
 272                 m_szFlags[flagofs++] = char(ch);
 273                 break;
 274
 275             case wxT('l'):
 276                 // NB: it's safe to use flagofs-1 as flagofs always start from 1
 277                 if (m_szFlags[flagofs-1] == 'l')       // 'll' modifier is the same as 'L' or 'q'
 278                     ilen = 2;
 279                 else
 280                 ilen = 1;
 281                 CHECK_PREC
 282                 m_szFlags[flagofs++] = char(ch);
 283                 break;
 284
 285             case wxT('q'):
 286             case wxT('L'):
 287                 ilen = 2;
 288                 CHECK_PREC
 289                 m_szFlags[flagofs++] = char(ch);
 290                 break;
 291 #ifdef __WXMSW__
 292             // under Windows we support the special '%I64' notation as longlong
 293             // integer conversion specifier for MSVC compatibility
 294             // (it behaves exactly as '%lli' or '%Li' or '%qi')
 295             case wxT('I'):
 296                 if (*(m_pArgEnd+1) != wxT('6') ||
 297                     *(m_pArgEnd+2) != wxT('4'))
 298                     return false;       // bad format
 299
 300                 m_pArgEnd++;
 301                 m_pArgEnd++;
 302
 303                 ilen = 2;
 304                 CHECK_PREC
 305                 m_szFlags[flagofs++] = char(ch);
 306                 m_szFlags[flagofs++] = '6';
 307                 m_szFlags[flagofs++] = '4';
 308                 break;
 309 #endif      // __WXMSW__
 310
 311             case wxT('Z'):
 312                 ilen = 3;
 313                 CHECK_PREC
 314                 m_szFlags[flagofs++] = char(ch);
 315                 break;
 316
 317             case wxT('*'):
 318                 if (in_prec)
 319                 {
 320                     CHECK_PREC
 321
 322                     // tell Process() to use the next argument
 323                     // in the stack as maxwidth...
 324                     m_nMaxWidth = -1;
 325                 }
 326                 else
 327                 {
 328                     // tell Process() to use the next argument
 329                     // in the stack as minwidth...
 330                     m_nMinWidth = -1;
 331                 }
 332
 333                 // save the * in our formatting buffer...
 334                 // will be replaced later by Process()
 335                 m_szFlags[flagofs++] = char(ch);
 336                 break;
 337
 338             case wxT('1'): case wxT('2'): case wxT('3'):
 339             case wxT('4'): case wxT('5'): case wxT('6'):
 340             case wxT('7'): case wxT('8'): case wxT('9'):
 341                 {
 342                     int len = 0;
 343                     CHECK_PREC
 344                     while ( (*m_pArgEnd >= CharType('0')) &&
 345                             (*m_pArgEnd <= CharType('9')) )
 346                     {
 347                         m_szFlags[flagofs++] = char(*m_pArgEnd);
 348                         len = len*10 + (*m_pArgEnd - wxT('0'));
 349                         m_pArgEnd++;
 350                     }
 351
 352                     if (in_prec)
 353                         m_nMaxWidth = len;
 354                     else
 355                         m_nMinWidth = len;
 356
 357                     m_pArgEnd--; // the main loop pre-increments n again
 358                 }
 359                 break;
 360
 361             case wxT('$'):      // a positional parameter (e.g. %2$s) ?
 362                 {
 363                     if (m_nMinWidth <= 0)
 364                         break;      // ignore this formatting flag as no
 365                                     // numbers are preceding it
 366
 367                     // remove from m_szFlags all digits previously added
 368                     do {
 369                         flagofs--;
 370                     } while (m_szFlags[flagofs] >= '1' &&
 371                              m_szFlags[flagofs] <= '9');
 372
 373                     // re-adjust the offset making it point to the
 374                     // next free char of m_szFlags
 375                     flagofs++;
 376
 377                     m_pos = m_nMinWidth;
 378                     m_nMinWidth = 0;
 379                 }
 380                 break;
 381
 382             case wxT('d'):
 383             case wxT('i'):
 384             case wxT('o'):
 385             case wxT('u'):
 386             case wxT('x'):
 387             case wxT('X'):
 388                 CHECK_PREC
 389                 m_szFlags[flagofs++] = char(ch);
 390                 m_szFlags[flagofs] = '\0';
 391                 if (ilen == 0)
 392                     m_type = wxPAT_INT;
 393                 else if (ilen == -1)
 394                     // NB: 'short int' value passed through '...'
 395                     //      is promoted to 'int', so we have to get
 396                     //      an int from stack even if we need a short
 397                     m_type = wxPAT_INT;
 398                 else if (ilen == 1)
 399                     m_type = wxPAT_LONGINT;
 400                 else if (ilen == 2)
 401 #ifdef wxLongLong_t
 402                     m_type = wxPAT_LONGLONGINT;
 403 #else // !wxLongLong_t
 404                     m_type = wxPAT_LONGINT;
 405 #endif // wxLongLong_t/!wxLongLong_t
 406                 else if (ilen == 3)
 407                     m_type = wxPAT_SIZET;
 408                 done = true;
 409                 break;
 410
 411             case wxT('e'):
 412             case wxT('E'):
 413             case wxT('f'):
 414             case wxT('g'):
 415             case wxT('G'):
 416                 CHECK_PREC
 417                 m_szFlags[flagofs++] = char(ch);
 418                 m_szFlags[flagofs] = '\0';
 419                 if (ilen == 2)
 420                     m_type = wxPAT_LONGDOUBLE;
 421                 else
 422                     m_type = wxPAT_DOUBLE;
 423                 done = true;
 424                 break;
 425
 426             case wxT('p'):
 427                 m_type = wxPAT_POINTER;
 428                 m_szFlags[flagofs++] = char(ch);
 429                 m_szFlags[flagofs] = '\0';
 430                 done = true;
 431                 break;
 432
 433             case wxT('c'):
 434                 if (ilen == -1)
 435                 {
 436                     // in Unicode mode %hc == ANSI character
 437                     // and in ANSI mode, %hc == %c == ANSI...
 438                     m_type = wxPAT_CHAR;
 439                 }
 440                 else if (ilen == 1)
 441                 {
 442                     // in ANSI mode %lc == Unicode character
 443                     // and in Unicode mode, %lc == %c == Unicode...
 444                     m_type = wxPAT_WCHAR;
 445                 }
 446                 else
 447                 {
 448 #if wxUSE_UNICODE
 449                     // in Unicode mode, %c == Unicode character
 450                     m_type = wxPAT_WCHAR;
 451 #else
 452                     // in ANSI mode, %c == ANSI character
 453                     m_type = wxPAT_CHAR;
 454 #endif
 455                 }
 456                 done = true;
 457                 break;
 458
 459             case wxT('s'):
 460                 if (ilen == -1)
 461                 {
 462                     // Unicode mode wx extension: we'll let %hs mean non-Unicode
 463                     // strings (when in ANSI mode, %s == %hs == ANSI string)
 464                     m_type = wxPAT_PCHAR;
 465                 }
 466                 else if (ilen == 1)
 467                 {
 468                     // in Unicode mode, %ls == %s == Unicode string
 469                     // in ANSI mode, %ls == Unicode string
 470                     m_type = wxPAT_PWCHAR;
 471                 }
 472                 else
 473                 {
 474 #if wxUSE_UNICODE
 475                     m_type = wxPAT_PWCHAR;
 476 #else
 477                     m_type = wxPAT_PCHAR;
 478 #endif
 479                 }
 480                 done = true;
 481                 break;
 482
 483             case wxT('n'):
 484                 if (ilen == 0)
 485                     m_type = wxPAT_NINT;
 486                 else if (ilen == -1)
 487                     m_type = wxPAT_NSHORTINT;
 488                 else if (ilen >= 1)
 489                     m_type = wxPAT_NLONGINT;
 490                 done = true;
 491                 break;
 492
 493             default:
 494                 // bad format, don't consider this an argument;
 495                 // leave it unchanged
 496                 return false;
 497         }
 498
 499         if (flagofs == wxMAX_SVNPRINTF_FLAGBUFFER_LEN)
 500         {
 501             wxLogDebug(wxT("Too many flags specified for a single conversion specifier!"));
 502             return false;
 503         }
 504     }
 505     while (!done);
 506
 507     return true;        // parsing was successful
 508 }
 509
 510 template<typename CharType>
 511 void wxPrintfConvSpec<CharType>::ReplaceAsteriskWith(int width)
 512 {
 513     char temp[wxMAX_SVNPRINTF_FLAGBUFFER_LEN];
 514
 515     // find the first * in our flag buffer
 516     char *pwidth = strchr(m_szFlags, '*');
 517     wxCHECK_RET(pwidth, _T("field width must be specified"));
 518
 519     // save what follows the * (the +1 is to skip the asterisk itself!)
 520     strcpy(temp, pwidth+1);
 521     if (width < 0)
 522     {
 523         pwidth[0] = wxT('-');
 524         pwidth++;
 525     }
 526
 527     // replace * with the actual integer given as width
 528 #ifndef SYSTEM_SPRINTF_IS_UNSAFE
 529     int maxlen = (m_szFlags + wxMAX_SVNPRINTF_FLAGBUFFER_LEN - pwidth) /
 530                         sizeof(*m_szFlags);
 531 #endif
 532     int offset = system_sprintf(pwidth, maxlen, "%d", abs(width));
 533
 534     // restore after the expanded * what was following it
 535     strcpy(pwidth+offset, temp);
 536 }
 537
 538 template<typename CharType>
 539 bool wxPrintfConvSpec<CharType>::LoadArg(wxPrintfArg *p, va_list &argptr)
 540 {
 541     // did the '*' width/precision specifier was used ?
 542     if (m_nMaxWidth == -1)
 543     {
 544         // take the maxwidth specifier from the stack
 545         m_nMaxWidth = va_arg(argptr, int);
 546         if (m_nMaxWidth < 0)
 547             m_nMaxWidth = 0;
 548         else
 549             ReplaceAsteriskWith(m_nMaxWidth);
 550     }
 551
 552     if (m_nMinWidth == -1)
 553     {
 554         // take the minwidth specifier from the stack
 555         m_nMinWidth = va_arg(argptr, int);
 556
 557         ReplaceAsteriskWith(m_nMinWidth);
 558         if (m_nMinWidth < 0)
 559         {
 560             m_bAlignLeft = !m_bAlignLeft;
 561             m_nMinWidth = -m_nMinWidth;
 562         }
 563     }
 564
 565     switch (m_type) {
 566         case wxPAT_INT:
 567             p->pad_int = va_arg(argptr, int);
 568             break;
 569         case wxPAT_LONGINT:
 570             p->pad_longint = va_arg(argptr, long int);
 571             break;
 572 #ifdef wxLongLong_t
 573         case wxPAT_LONGLONGINT:
 574             p->pad_longlongint = va_arg(argptr, wxLongLong_t);
 575             break;
 576 #endif // wxLongLong_t
 577         case wxPAT_SIZET:
 578             p->pad_sizet = va_arg(argptr, size_t);
 579             break;
 580         case wxPAT_DOUBLE:
 581             p->pad_double = va_arg(argptr, double);
 582             break;
 583         case wxPAT_LONGDOUBLE:
 584             p->pad_longdouble = va_arg(argptr, long double);
 585             break;
 586         case wxPAT_POINTER:
 587             p->pad_pointer = va_arg(argptr, void *);
 588             break;
 589
 590         case wxPAT_CHAR:
 591             p->pad_char = (char)va_arg(argptr, int);  // char is promoted to int when passed through '...'
 592             break;
 593         case wxPAT_WCHAR:
 594             p->pad_wchar = (wchar_t)va_arg(argptr, int);  // char is promoted to int when passed through '...'
 595             break;
 596
 597         case wxPAT_PCHAR:
 598         case wxPAT_PWCHAR:
 599             p->pad_str = va_arg(argptr, void *);
 600             break;
 601
 602         case wxPAT_NINT:
 603             p->pad_nint = va_arg(argptr, int *);
 604             break;
 605         case wxPAT_NSHORTINT:
 606             p->pad_nshortint = va_arg(argptr, short int *);
 607             break;
 608         case wxPAT_NLONGINT:
 609             p->pad_nlongint = va_arg(argptr, long int *);
 610             break;
 611
 612         case wxPAT_STAR:
 613             // this will be handled as part of the next argument
 614             return true;
 615
 616         case wxPAT_INVALID:
 617         default:
 618             return false;
 619     }
 620
 621     return true;    // loading was successful
 622 }
 623
 624 template<typename CharType>
 625 int wxPrintfConvSpec<CharType>::Process(CharType *buf, size_t lenMax, wxPrintfArg *p, size_t written)
 626 {
 627     // buffer to avoid dynamic memory allocation each time for small strings;
 628     // note that this buffer is used only to hold results of number formatting,
 629     // %s directly writes user's string in buf, without using szScratch
 630     char szScratch[wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN];
 631     size_t lenScratch = 0, lenCur = 0;
 632
 633 #define APPEND_CH(ch) \
 634                 { \
 635                     if ( lenCur == lenMax ) \
 636                         return -1; \
 637                     \
 638                     buf[lenCur++] = ch; \
 639                 }
 640
 641     switch ( m_type )
 642     {
 643         case wxPAT_INT:
 644             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_int);
 645             break;
 646
 647         case wxPAT_LONGINT:
 648             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_longint);
 649             break;
 650
 651 #ifdef wxLongLong_t
 652         case wxPAT_LONGLONGINT:
 653             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_longlongint);
 654             break;
 655 #endif // SIZEOF_LONG_LONG
 656
 657         case wxPAT_SIZET:
 658             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_sizet);
 659             break;
 660
 661         case wxPAT_LONGDOUBLE:
 662             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_longdouble);
 663             break;
 664
 665         case wxPAT_DOUBLE:
 666             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_double);
 667             break;
 668
 669         case wxPAT_POINTER:
 670             lenScratch = system_sprintf(szScratch, wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN, m_szFlags, p->pad_pointer);
 671             break;
 672
 673         case wxPAT_CHAR:
 674         case wxPAT_WCHAR:
 675             {
 676                 wxUniChar ch;
 677                 if (m_type == wxPAT_CHAR)
 678                     ch = p->pad_char;
 679                 else // m_type == wxPAT_WCHAR
 680                     ch = p->pad_wchar;
 681
 682                 CharType val = ch;
 683
 684                 size_t i;
 685
 686                 if (!m_bAlignLeft)
 687                     for (i = 1; i < (size_t)m_nMinWidth; i++)
 688                         APPEND_CH(_T(' '));
 689
 690                 APPEND_CH(val);
 691
 692                 if (m_bAlignLeft)
 693                     for (i = 1; i < (size_t)m_nMinWidth; i++)
 694                         APPEND_CH(_T(' '));
 695             }
 696             break;
 697
 698         case wxPAT_PCHAR:
 699         case wxPAT_PWCHAR:
 700             {
 701                 wxArgNormalizedString arg(p->pad_str);
 702                 wxString s = arg;
 703
 704                 if ( !arg.IsValid() && m_nMaxWidth >= 6 )
 705                     s = wxT("(null)");
 706
 707                 typename wxPrintfStringHelper<CharType>::ConvertedType strbuf(
 708                         wxPrintfStringHelper<CharType>::Convert(s));
 709
 710                 // at this point we are sure that m_nMaxWidth is positive or
 711                 // null (see top of wxPrintfConvSpec::LoadArg)
 712                 int len = wxMin((unsigned int)m_nMaxWidth, wxStrlen(strbuf));
 713
 714                 int i;
 715
 716                 if (!m_bAlignLeft)
 717                 {
 718                     for (i = len; i < m_nMinWidth; i++)
 719                         APPEND_CH(_T(' '));
 720                 }
 721
 722                 len = wxMin((unsigned int)len, lenMax-lenCur);
 723                 wxStrncpy(buf+lenCur, strbuf, len);
 724                 lenCur += len;
 725
 726                 if (m_bAlignLeft)
 727                 {
 728                     for (i = len; i < m_nMinWidth; i++)
 729                         APPEND_CH(_T(' '));
 730                 }
 731             }
 732             break;
 733
 734         case wxPAT_NINT:
 735             *p->pad_nint = written;
 736             break;
 737
 738         case wxPAT_NSHORTINT:
 739             *p->pad_nshortint = (short int)written;
 740             break;
 741
 742         case wxPAT_NLONGINT:
 743             *p->pad_nlongint = written;
 744             break;
 745
 746         case wxPAT_INVALID:
 747         default:
 748             return -1;
 749     }
 750
 751     // if we used system's sprintf() then we now need to append the s_szScratch
 752     // buffer to the given one...
 753     switch (m_type)
 754     {
 755         case wxPAT_INT:
 756         case wxPAT_LONGINT:
 757 #ifdef wxLongLong_t
 758         case wxPAT_LONGLONGINT:
 759 #endif
 760         case wxPAT_SIZET:
 761         case wxPAT_LONGDOUBLE:
 762         case wxPAT_DOUBLE:
 763         case wxPAT_POINTER:
 764             wxASSERT(lenScratch < wxMAX_SVNPRINTF_SCRATCHBUFFER_LEN);
 765             // NB: 1) we can compare lenMax (for CharType*, i.e. possibly
 766             //        wchar_t*) with lenScratch (char*) because this code is
 767             //        formatting integers and that will have the same length
 768             //        even in UTF-8 (the only case when char* length may be
 769             //        more than wchar_t* length of the same string)
 770             //     2) wxStrncpy converts the 2nd argument to 1st argument's
 771             //        type transparently if their types differ, so this code
 772             //        works for both instantiations
 773             if (lenMax < lenScratch)
 774             {
 775                 // fill output buffer and then return -1
 776                 wxStrncpy(buf, szScratch, lenMax);
 777                 return -1;
 778             }
 779             wxStrncpy(buf, szScratch, lenScratch);
 780             lenCur += lenScratch;
 781             break;
 782
 783         default:
 784             break;      // all other cases were completed previously
 785     }
 786
 787     return lenCur;
 788 }
 789
 790
 791 // helper that parses format string
 792 template<typename CharType>
 793 struct wxPrintfConvSpecParser
 794 {
 795     typedef wxPrintfConvSpec<CharType> ConvSpec;
 796
 797     wxPrintfConvSpecParser(const CharType *fmt)
 798     {
 799         nargs = 0;
 800         posarg_present =
 801         nonposarg_present = false;
 802
 803         memset(pspec, 0, sizeof(pspec));
 804
 805         // parse the format string
 806         for ( const CharType *toparse = fmt; *toparse != wxT('\0'); toparse++ )
 807         {
 808             // skip everything except format specifications
 809             if ( *toparse != '%' )
 810                 continue;
 811
 812             // also skip escaped percent signs
 813             if ( toparse[1] == '%' )
 814             {
 815                 toparse++;
 816                 continue;
 817             }
 818
 819             ConvSpec *spec = &specs[nargs];
 820             spec->Init();
 821
 822             // attempt to parse this format specification
 823             if ( !spec->Parse(toparse) )
 824                 continue;
 825
 826             // advance to the end of this specifier
 827             toparse = spec->m_pArgEnd;
 828
 829             // special handling for specifications including asterisks: we need
 830             // to reserve an extra slot (or two if asterisks were used for both
 831             // width and precision) in specs array in this case
 832             for ( const char *f = strchr(spec->m_szFlags, '*');
 833                   f;
 834                   f = strchr(f + 1, '*') )
 835             {
 836                 if ( nargs++ == wxMAX_SVNPRINTF_ARGUMENTS )
 837                     break;
 838
 839                 // TODO: we need to support specifiers of the form "%2$*1$s"
 840                 // (this is the same as "%*s") as if any positional arguments
 841                 // are used all asterisks must be positional as well but this
 842                 // requires a lot of changes in this code (basically we'd need
 843                 // to rewrite Parse() to return "*" and conversion itself as
 844                 // separate entries)
 845                 if ( posarg_present )
 846                 {
 847                     wxFAIL_MSG
 848                     (
 849                         wxString::Format
 850                         (
 851                             "Format string \"%s\" uses both positional "
 852                             "parameters and '*' but this is not currently "
 853                             "supported by this implementation, sorry.",
 854                             fmt
 855                         )
 856                     );
 857                 }
 858
 859                 specs[nargs] = *spec;
 860
 861                 // make an entry for '*' and point to it from pspec
 862                 spec->Init();
 863                 spec->m_type = wxPAT_STAR;
 864                 pspec[nargs - 1] = spec;
 865
 866                 spec = &specs[nargs];
 867             }
 868
 869             // check if this is a positional or normal argument
 870             if ( spec->m_pos > 0 )
 871             {
 872                 // the positional arguments start from number 1 so we need
 873                 // to adjust the index
 874                 spec->m_pos--;
 875                 posarg_present = true;
 876             }
 877             else // not a positional argument...
 878             {
 879                 spec->m_pos = nargs;
 880                 nonposarg_present = true;
 881             }
 882
 883             // this conversion specifier is tied to the pos-th argument...
 884             pspec[spec->m_pos] = spec;
 885
 886             if ( nargs++ == wxMAX_SVNPRINTF_ARGUMENTS )
 887                 break;
 888         }
 889
 890
 891         // warn if we lost any arguments (the program probably will crash
 892         // anyhow because of stack corruption...)
 893         if ( nargs == wxMAX_SVNPRINTF_ARGUMENTS )
 894         {
 895             wxFAIL_MSG
 896             (
 897                 wxString::Format
 898                 (
 899                     "wxVsnprintf() currently supports only %d arguments, "
 900                     "but format string \"%s\" defines more of them.\n"
 901                     "You need to change wxMAX_SVNPRINTF_ARGUMENTS and "
 902                     "recompile if more are really needed.",
 903                     fmt, wxMAX_SVNPRINTF_ARGUMENTS
 904                 )
 905             );
 906         }
 907     }
 908
 909     // total number of valid elements in specs
 910     unsigned nargs;
 911
 912     // all format specifications in this format string in order of their
 913     // appearance (which may be different from arguments order)
 914     ConvSpec specs[wxMAX_SVNPRINTF_ARGUMENTS];
 915
 916     // pointer to specs array element for the N-th argument
 917     ConvSpec *pspec[wxMAX_SVNPRINTF_ARGUMENTS];
 918
 919     // true if any positional/non-positional parameters are used
 920     bool posarg_present,
 921          nonposarg_present;
 922 };
 923
 924 #undef APPEND_CH
 925 #undef CHECK_PREC
 926
 927 #endif // _WX_PRIVATE_WXPRINTF_H_