git.oblomov.eu Git - wine/blob - dlls/msvcrt/printf.h

   1 /*
   2  * Copyright 2011 Piotr Caban for CodeWeavers
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifdef PRINTF_WIDE
  20 #define APICHAR MSVCRT_wchar_t
  21 #define CONVCHAR char
  22 #define FUNC_NAME(func) func ## _w
  23 #else
  24 #define APICHAR char
  25 #define CONVCHAR MSVCRT_wchar_t
  26 #define FUNC_NAME(func) func ## _a
  27 #endif
  28
  29 typedef struct FUNC_NAME(pf_flags_t)
  30 {
  31     APICHAR Sign, LeftAlign, Alternate, PadZero;
  32     int FieldLength, Precision;
  33     APICHAR IntegerLength, IntegerDouble;
  34     APICHAR WideString;
  35     APICHAR Format;
  36 } FUNC_NAME(pf_flags);
  37
  38 struct FUNC_NAME(_str_ctx) {
  39     MSVCRT_size_t len;
  40     APICHAR *buf;
  41 };
  42
  43 static int FUNC_NAME(puts_clbk_str)(void *ctx, int len, const APICHAR *str)
  44 {
  45     struct FUNC_NAME(_str_ctx) *out = ctx;
  46
  47     if(!out->buf)
  48         return len;
  49
  50     if(out->len < len) {
  51         memcpy(out->buf, str, out->len);
  52         out->buf += out->len;
  53         out->len = 0;
  54         return -1;
  55     }
  56
  57     memcpy(out->buf, str, len*sizeof(APICHAR));
  58     out->buf += len;
  59     return len;
  60 }
  61
  62 static inline const APICHAR* FUNC_NAME(pf_parse_int)(const APICHAR *fmt, int *val)
  63 {
  64     *val = 0;
  65
  66     while(isdigit(*fmt)) {
  67         *val *= 10;
  68         *val += *fmt++ - '0';
  69     }
  70
  71     return fmt;
  72 }
  73
  74 /* pf_fill: takes care of signs, alignment, zero and field padding */
  75 static inline int FUNC_NAME(pf_fill)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
  76         int len, FUNC_NAME(pf_flags) *flags, BOOL left)
  77 {
  78     int i, r = 0, written;
  79
  80     if(flags->Sign && !(flags->Format=='d' || flags->Format=='i'))
  81         flags->Sign = 0;
  82
  83     if(left && flags->Sign) {
  84         flags->FieldLength--;
  85         if(flags->PadZero)
  86             r = pf_puts(puts_ctx, 1, &flags->Sign);
  87     }
  88     written = r;
  89
  90     if((!left && flags->LeftAlign) || (left && !flags->LeftAlign)) {
  91         APICHAR ch;
  92
  93         if(left && flags->PadZero)
  94             ch = '0';
  95         else
  96             ch = ' ';
  97
  98         for(i=0; i<flags->FieldLength-len && r>=0; i++) {
  99             r = pf_puts(puts_ctx, 1, &ch);
 100             written += r;
 101         }
 102     }
 103
 104
 105     if(r>=0 && left && flags->Sign && !flags->PadZero) {
 106         r = pf_puts(puts_ctx, 1, &flags->Sign);
 107         written += r;
 108     }
 109
 110     return r>=0 ? written : r;
 111 }
 112
 113 static inline int FUNC_NAME(pf_output_wstr)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
 114         const MSVCRT_wchar_t *str, int len, MSVCRT__locale_t locale)
 115 {
 116 #ifdef PRINTF_WIDE
 117     return pf_puts(puts_ctx, len, str);
 118 #else
 119     LPSTR out;
 120     int len_a = WideCharToMultiByte(locale->locinfo->lc_codepage, 0, str, len, NULL, 0, NULL, NULL);
 121
 122     out = HeapAlloc(GetProcessHeap(), 0, len_a);
 123     if(!out)
 124         return -1;
 125
 126     WideCharToMultiByte(locale->locinfo->lc_codepage, 0, str, len, out, len_a, NULL, NULL);
 127     len = pf_puts(puts_ctx, len_a, out);
 128     HeapFree(GetProcessHeap(), 0, out);
 129     return len;
 130 #endif
 131 }
 132
 133 static inline int FUNC_NAME(pf_output_str)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
 134         const char *str, int len, MSVCRT__locale_t locale)
 135 {
 136 #ifdef PRINTF_WIDE
 137     LPWSTR out;
 138     int len_w = MultiByteToWideChar(locale->locinfo->lc_codepage, 0, str, len, NULL, 0);
 139
 140     out = HeapAlloc(GetProcessHeap(), 0, len_w*sizeof(WCHAR));
 141     if(!out)
 142         return -1;
 143
 144     MultiByteToWideChar(locale->locinfo->lc_codepage, 0, str, len, out, len_w);
 145     len = pf_puts(puts_ctx, len_w, out);
 146     HeapFree(GetProcessHeap(), 0, out);
 147     return len;
 148 #else
 149     return pf_puts(puts_ctx, len, str);
 150 #endif
 151 }
 152
 153 static inline int FUNC_NAME(pf_output_format_wstr)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
 154         const MSVCRT_wchar_t *str, int len, FUNC_NAME(pf_flags) *flags, MSVCRT__locale_t locale)
 155 {
 156     int r, ret;
 157
 158     if(len < 0)
 159         len = strlenW(str);
 160
 161     if(flags->Precision>=0 && flags->Precision<len)
 162         len = flags->Precision;
 163
 164     r = FUNC_NAME(pf_fill)(pf_puts, puts_ctx, len, flags, TRUE);
 165     ret = r;
 166     if(r >= 0) {
 167         r = FUNC_NAME(pf_output_wstr)(pf_puts, puts_ctx, str, len, locale);
 168         ret += r;
 169     }
 170     if(r >= 0) {
 171         r = FUNC_NAME(pf_fill)(pf_puts, puts_ctx, len, flags, FALSE);
 172         ret += r;
 173     }
 174
 175     return r>=0 ? ret : r;
 176 }
 177
 178 static inline int FUNC_NAME(pf_output_format_str)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
 179         const char *str, int len, FUNC_NAME(pf_flags) *flags, MSVCRT__locale_t locale)
 180 {
 181     int r, ret;
 182
 183     if(len < 0)
 184         len = strlen(str);
 185
 186     if(flags->Precision>=0 && flags->Precision<len)
 187         len = flags->Precision;
 188
 189     r = FUNC_NAME(pf_fill)(pf_puts, puts_ctx, len, flags, TRUE);
 190     ret = r;
 191     if(r >= 0) {
 192         r = FUNC_NAME(pf_output_str)(pf_puts, puts_ctx, str, len, locale);
 193         ret += r;
 194     }
 195     if(r >= 0) {
 196         r = FUNC_NAME(pf_fill)(pf_puts, puts_ctx, len, flags, FALSE);
 197         ret += r;
 198     }
 199
 200     return r>=0 ? ret : r;
 201 }
 202
 203 static inline int FUNC_NAME(pf_handle_string)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx,
 204         const void *str, int len, FUNC_NAME(pf_flags) *flags, MSVCRT__locale_t locale)
 205 {
 206 #ifdef PRINTF_WIDE
 207     static const MSVCRT_wchar_t nullW[] = {'(','n','u','l','l',')',0};
 208
 209     if(!str)
 210         return FUNC_NAME(pf_output_format_wstr)(pf_puts, puts_ctx, nullW, 6, flags, locale);
 211 #else
 212     if(!str)
 213         return FUNC_NAME(pf_output_format_str)(pf_puts, puts_ctx, "(null)", 6, flags, locale);
 214 #endif
 215
 216     if(flags->WideString || flags->IntegerLength=='l')
 217         return FUNC_NAME(pf_output_format_wstr)(pf_puts, puts_ctx, str, len, flags, locale);
 218     if(flags->IntegerLength == 'h')
 219         return FUNC_NAME(pf_output_format_str)(pf_puts, puts_ctx, str, len, flags, locale);
 220
 221     if((flags->Format=='S' || flags->Format=='C') == (sizeof(APICHAR)==sizeof(MSVCRT_wchar_t)))
 222         return FUNC_NAME(pf_output_format_str)(pf_puts, puts_ctx, str, len, flags, locale);
 223     else
 224         return FUNC_NAME(pf_output_format_wstr)(pf_puts, puts_ctx, str, len, flags, locale);
 225 }
 226
 227 static inline void FUNC_NAME(pf_rebuild_format_string)(char *p, FUNC_NAME(pf_flags) *flags)
 228 {
 229     *p++ = '%';
 230     if(flags->Sign)
 231         *p++ = flags->Sign;
 232     if(flags->LeftAlign)
 233         *p++ = flags->LeftAlign;
 234     if(flags->Alternate)
 235         *p++ = flags->Alternate;
 236     if(flags->PadZero)
 237         *p++ = flags->PadZero;
 238     if(flags->FieldLength) {
 239         sprintf(p, "%d", flags->FieldLength);
 240         p += strlen(p);
 241     }
 242     if(flags->Precision >= 0) {
 243         sprintf(p, ".%d", flags->Precision);
 244         p += strlen(p);
 245     }
 246     *p++ = flags->Format;
 247     *p++ = 0;
 248 }
 249
 250 /* pf_integer_conv:  prints x to buf, including alternate formats and
 251    additional precision digits, but not field characters or the sign */
 252 static inline void FUNC_NAME(pf_integer_conv)(char *buf, int buf_len,
 253         FUNC_NAME(pf_flags) *flags, LONGLONG x)
 254 {
 255     unsigned int base;
 256     const char *digits;
 257
 258     int i, j, k;
 259     char number[40], *tmp = number;
 260
 261     if(buf_len > sizeof number)
 262         tmp = HeapAlloc(GetProcessHeap(), 0, buf_len);
 263
 264     if(flags->Format == 'o')
 265         base = 8;
 266     else if(flags->Format=='x' || flags->Format=='X')
 267         base = 16;
 268     else
 269         base = 10;
 270
 271     if(flags->Format == 'X')
 272         digits = "0123456789ABCDEFX";
 273     else
 274         digits = "0123456789abcdefx";
 275
 276     if(x<0 && (flags->Format=='d' || flags->Format=='i')) {
 277         x = -x;
 278         flags->Sign = '-';
 279     }
 280
 281     i = 0;
 282     if(x==0 && flags->Precision)
 283         tmp[i++] = '0';
 284     else {
 285         while(x != 0) {
 286             j = (ULONGLONG)x%base;
 287             x = (ULONGLONG)x/base;
 288             tmp[i++] = digits[j];
 289         }
 290     }
 291     k = flags->Precision-i;
 292     while(k-- > 0)
 293         tmp[i++] = '0';
 294     if(flags->Alternate) {
 295         if(base == 16) {
 296             tmp[i++] = digits[16];
 297             tmp[i++] = '0';
 298         } else if(base==8 && tmp[i-1]!='0')
 299             tmp[i++] = '0';
 300     }
 301
 302     j = 0;
 303     while(i-- > 0)
 304         buf[j++] = tmp[i];
 305     buf[j] = '\0';
 306
 307     /* Adjust precision so pf_fill won't truncate the number later */
 308     flags->Precision = strlen(buf);
 309
 310     if(tmp != number)
 311         HeapFree(GetProcessHeap(), 0, tmp);
 312 }
 313
 314 static inline void FUNC_NAME(pf_fixup_exponent)(char *buf)
 315 {
 316     char* tmp = buf;
 317
 318     while(tmp[0] && toupper(tmp[0])!='E')
 319         tmp++;
 320
 321     if(tmp[0] && (tmp[1]=='+' || tmp[1]=='-') &&
 322             isdigit(tmp[2]) && isdigit(tmp[3])) {
 323         char final;
 324
 325         if (isdigit(tmp[4]))
 326             return; /* Exponent already 3 digits */
 327
 328         tmp += 2;
 329         final = tmp[2];
 330         tmp[2] = tmp[1];
 331         tmp[1] = tmp[0];
 332         tmp[0] = '0';
 333
 334         if(final == '\0') {
 335             tmp[3] = '\0';
 336             if(buf[0] == ' ')
 337                 memmove(buf, buf + 1, (tmp - buf) + 3);
 338         }
 339     }
 340 }
 341
 342 int FUNC_NAME(pf_printf)(FUNC_NAME(puts_clbk) pf_puts, void *puts_ctx, const APICHAR *fmt,
 343         MSVCRT__locale_t locale, BOOL positional_params, BOOL invoke_invalid_param_handler,
 344         args_clbk pf_args, void *args_ctx, __ms_va_list valist)
 345 {
 346     const APICHAR *q, *p = fmt;
 347     int written = 0, pos, i;
 348     FUNC_NAME(pf_flags) flags;
 349     char buf[32];
 350
 351     TRACE("Format is: %s\n", FUNC_NAME(debugstr)(fmt));
 352
 353     if(!locale)
 354         locale = get_locale();
 355
 356     while(*p) {
 357         /* output characters before '%' */
 358         for(q=p; *q && *q!='%'; q++);
 359         if(p != q) {
 360             i = pf_puts(puts_ctx, q-p, p);
 361             if(i < 0)
 362                 return i;
 363
 364             written += i;
 365             p = q;
 366             continue;
 367         }
 368
 369         /* *p == '%' here */
 370         p++;
 371
 372         /* output a single '%' character */
 373         if(*p == '%') {
 374             i = pf_puts(puts_ctx, 1, p++);
 375             if(i < 0)
 376                 return i;
 377
 378             written += i;
 379             continue;
 380         }
 381
 382         /* check parameter position */
 383         if(positional_params && (q = FUNC_NAME(pf_parse_int)(p, &pos)) && *q=='$')
 384             p = q+1;
 385         else
 386             pos = -1;
 387
 388         /* parse the flags */
 389         memset(&flags, 0, sizeof(flags));
 390         while(*p) {
 391             if(*p=='+' || *p==' ') {
 392                 if(flags.Sign != '+')
 393                     flags.Sign = *p;
 394             } else if(*p == '-')
 395                 flags.LeftAlign = *p;
 396             else if(*p == '0')
 397                 flags.PadZero = *p;
 398             else if(*p == '#')
 399                 flags.Alternate = *p;
 400             else
 401                 break;
 402
 403             p++;
 404         }
 405
 406         /* parse the widh */
 407         if(*p == '*') {
 408             p++;
 409             if(positional_params && (q = FUNC_NAME(pf_parse_int)(p, &i)) && *q=='$')
 410                 p = q+1;
 411             else
 412                 i = -1;
 413
 414             flags.FieldLength = pf_args(args_ctx, i, VT_INT, &valist).get_int;
 415             if(flags.FieldLength < 0) {
 416                 flags.LeftAlign = '-';
 417                 flags.FieldLength = -flags.FieldLength;
 418             }
 419         } else while(isdigit(*p)) {
 420             flags.FieldLength *= 10;
 421             flags.FieldLength += *p++ - '0';
 422         }
 423
 424         /* parse the precision */
 425         flags.Precision = -1;
 426         if(*p == '.') {
 427             flags.Precision = 0;
 428             p++;
 429             if(*p == '*') {
 430                 p++;
 431                 if(positional_params && (q = FUNC_NAME(pf_parse_int)(p, &i)) && *q=='$')
 432                     p = q+1;
 433                 else
 434                     i = -1;
 435
 436                 flags.Precision = pf_args(args_ctx, i, VT_INT, &valist).get_int;
 437             } else while(isdigit(*p)) {
 438                 flags.Precision *= 10;
 439                 flags.Precision += *p++ - '0';
 440             }
 441         }
 442
 443         /* parse argument size modifier */
 444         while(*p) {
 445             if(*p=='l' && *(p+1)=='l') {
 446                 flags.IntegerDouble++;
 447                 p += 2;
 448             } else if(*p=='h' || *p=='l' || *p=='L') {
 449                 flags.IntegerLength = *p;
 450                 p++;
 451             } else if(*p == 'I') {
 452                 if(*(p+1)=='6' && *(p+2)=='4') {
 453                     flags.IntegerDouble++;
 454                     p += 3;
 455                 } else if(*(p+1)=='3' && *(p+2)=='2')
 456                     p += 3;
 457                 else if(isdigit(*(p+1)) || !*(p+1))
 458                     break;
 459                 else
 460                     p++;
 461             } else if(*p == 'w')
 462                 flags.WideString = *p++;
 463             else if(*p == 'F')
 464                 p++; /* ignore */
 465             else
 466                 break;
 467         }
 468
 469         flags.Format = *p;
 470
 471         if(flags.Format == 's' || flags.Format == 'S') {
 472             i = FUNC_NAME(pf_handle_string)(pf_puts, puts_ctx,
 473                     pf_args(args_ctx, pos, VT_PTR, &valist).get_ptr,
 474                     -1,  &flags, locale);
 475         } else if(flags.Format == 'c' || flags.Format == 'C') {
 476             int ch = pf_args(args_ctx, pos, VT_INT, &valist).get_int;
 477
 478             if((ch&0xff) != ch)
 479                 FIXME("multibyte characters printing not supported\n");
 480
 481             i = FUNC_NAME(pf_handle_string)(pf_puts, puts_ctx, &ch, 1, &flags, locale);
 482         } else if(flags.Format == 'p') {
 483             void *ptr = pf_args(args_ctx, pos, VT_PTR, &valist).get_ptr;
 484
 485             flags.PadZero = 0;
 486             if(flags.Alternate)
 487                 sprintf(buf, "0X%0*lX", 2*(int)sizeof(ptr), (ULONG_PTR)ptr);
 488             else
 489                 sprintf(buf, "%0*lX", 2*(int)sizeof(ptr), (ULONG_PTR)ptr);
 490
 491             i = FUNC_NAME(pf_output_format_str)(pf_puts, puts_ctx, buf, -1, &flags, locale);
 492         } else if(flags.Format == 'n') {
 493             int *used = pf_args(args_ctx, pos, VT_PTR, &valist).get_ptr;
 494             *used = written;
 495             i = 0;
 496         } else if(flags.IntegerDouble && flags.Format && strchr("diouxX", flags.Format)) {
 497             char *tmp = buf;
 498             int max_len = (flags.FieldLength>flags.Precision ? flags.FieldLength : flags.Precision) + 10;
 499
 500             if(max_len > sizeof(buf))
 501                 tmp = HeapAlloc(GetProcessHeap(), 0, max_len);
 502             if(!tmp)
 503                 return -1;
 504
 505             FUNC_NAME(pf_integer_conv)(tmp, max_len, &flags,
 506                     pf_args(args_ctx, pos, VT_I8, &valist).get_longlong);
 507
 508             i = FUNC_NAME(pf_output_format_str)(pf_puts, puts_ctx, tmp, -1, &flags, locale);
 509             if(tmp != buf)
 510                 HeapFree(GetProcessHeap(), 0, tmp);
 511         } else if(flags.Format && strchr("acCdeEfgGinouxX", flags.Format)) {
 512             char fmt[20], *tmp = buf, *decimal_point;
 513             int max_len = (flags.FieldLength>flags.Precision ? flags.FieldLength : flags.Precision) + 10;
 514
 515             if(max_len > sizeof(buf))
 516                 tmp = HeapAlloc(GetProcessHeap(), 0, max_len);
 517             if(!tmp)
 518                 return -1;
 519
 520             FUNC_NAME(pf_rebuild_format_string)(fmt, &flags);
 521
 522             if(flags.Format && strchr("aeEfgG", flags.Format)) {
 523                 sprintf(tmp, fmt, pf_args(args_ctx, pos, VT_R8, &valist).get_double);
 524                 if(toupper(flags.Format)=='E' || toupper(flags.Format)=='G')
 525                     FUNC_NAME(pf_fixup_exponent)(tmp);
 526             }
 527             else
 528                 sprintf(tmp, fmt, pf_args(args_ctx, pos, VT_INT, &valist).get_int);
 529
 530             decimal_point = strchr(tmp, '.');
 531             if(decimal_point)
 532                 *decimal_point = *locale->locinfo->lconv->decimal_point;
 533
 534             i = FUNC_NAME(pf_output_str)(pf_puts, puts_ctx, tmp, strlen(tmp), locale);
 535             if(tmp != buf)
 536                 HeapFree(GetProcessHeap(), 0, tmp);
 537         } else {
 538             if(invoke_invalid_param_handler) {
 539                 MSVCRT__invalid_parameter(NULL, NULL, NULL, 0, 0);
 540                 *MSVCRT__errno() = MSVCRT_EINVAL;
 541                 return -1;
 542             }
 543
 544             continue;
 545         }
 546
 547         if(i < 0)
 548             return i;
 549         written += i;
 550         p++;
 551     }
 552
 553     return written;
 554 }
 555
 556 #ifndef PRINTF_WIDE
 557 enum types_clbk_flags {
 558     TYPE_CLBK_VA_LIST = 1,
 559     TYPE_CLBK_POSITIONAL = 2,
 560     TYPE_CLBK_ERROR_POS = 4,
 561     TYPE_CLBK_ERROR_TYPE = 8
 562 };
 563
 564 /* This functions stores types of arguments. It uses args[0] internally */
 565 static printf_arg arg_clbk_type(void *ctx, int pos, int type, __ms_va_list *valist)
 566 {
 567     static const printf_arg ret;
 568     printf_arg *args = ctx;
 569
 570     if(pos == -1) {
 571         args[0].get_int |= TYPE_CLBK_VA_LIST;
 572         return ret;
 573     } else
 574         args[0].get_int |= TYPE_CLBK_POSITIONAL;
 575
 576     if(pos<1 || pos>MSVCRT__ARGMAX)
 577         args[0].get_int |= TYPE_CLBK_ERROR_POS;
 578     else if(args[pos].get_int && args[pos].get_int!=type)
 579         args[0].get_int |= TYPE_CLBK_ERROR_TYPE;
 580     else
 581         args[pos].get_int = type;
 582
 583     return ret;
 584 }
 585 #endif
 586
 587 static int FUNC_NAME(create_positional_ctx)(void *args_ctx, const APICHAR *format, __ms_va_list valist)
 588 {
 589     struct FUNC_NAME(_str_ctx) puts_ctx = {INT_MAX, NULL};
 590     printf_arg *args = args_ctx;
 591     int i, j;
 592
 593     i = FUNC_NAME(pf_printf)(FUNC_NAME(puts_clbk_str), &puts_ctx, format, NULL, TRUE, FALSE,
 594             arg_clbk_type, args_ctx, NULL);
 595     if(i < 0)
 596         return i;
 597
 598     if(args[0].get_int==0 || args[0].get_int==TYPE_CLBK_VA_LIST)
 599         return 0;
 600     if(args[0].get_int != TYPE_CLBK_POSITIONAL)
 601         return -1;
 602
 603     for(i=MSVCRT__ARGMAX; i>0; i--)
 604         if(args[i].get_int)
 605             break;
 606
 607     for(j=1; j<=i; j++) {
 608         switch(args[j].get_int) {
 609         case VT_I8:
 610             args[j].get_longlong = va_arg(valist, LONGLONG);
 611             break;
 612         case VT_INT:
 613             args[j].get_int = va_arg(valist, int);
 614             break;
 615         case VT_R8:
 616             args[j].get_double = va_arg(valist, double);
 617             break;
 618         case VT_PTR:
 619             args[j].get_ptr = va_arg(valist, void*);
 620             break;
 621         default:
 622             return -1;
 623         }
 624     }
 625
 626     return j;
 627 }
 628
 629 #undef APICHAR
 630 #undef CONVCHAR
 631 #undef FUNC_NAME