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

   1 /*
   2  * general implementation of scanf used by scanf, sscanf, fscanf,
   3  * _cscanf, wscanf, swscanf and fwscanf
   4  *
   5  * Copyright 1996,1998 Marcus Meissner
   6  * Copyright 1996 Jukka Iivonen
   7  * Copyright 1997,2000 Uwe Bonnes
   8  * Copyright 2000 Jon Griffiths
   9  * Copyright 2002 Daniel Gudbjartsson
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifdef WIDE_SCANF
  27 #define _L_(x) L##x
  28 #define _CHAR_ WCHAR
  29 #define _EOF_ MSVCRT_WEOF
  30 #define _ISSPACE_(c) MSVCRT_iswspace(c)
  31 #define _ISDIGIT_(c) MSVCRT_iswdigit(c)
  32 #define _CONVERT_(c) c /*** FIXME ***/
  33 #define _CHAR2DIGIT_(c, base) wchar2digit((c), (base))
  34 #else /* WIDE_SCANF */
  35 #define _L_(x) x
  36 #define _CHAR_ char
  37 #define _EOF_ MSVCRT_EOF
  38 #define _ISSPACE_(c) isspace(c)
  39 #define _ISDIGIT_(c) isdigit(c)
  40 #define _CONVERT_(c) c /*** FIXME ***/
  41 #define _CHAR2DIGIT_(c, base) char2digit((c), (base))
  42 #endif /* WIDE_SCANF */
  43
  44 #ifdef CONSOLE
  45 #define _GETC_(file) _getch()
  46 #define _UNGETC_(nch, file) _ungetch(nch)
  47 #define _FUNCTION_ _cscanf(const _CHAR_ *format, ...)
  48 #else
  49 #ifdef STRING
  50 #undef _EOF_
  51 #define _EOF_ 0
  52 #define _GETC_(file) *file++
  53 #define _UNGETC_(nch, file) file--
  54 #ifdef WIDE_SCANF
  55 #define _FUNCTION_ MSVCRT_swscanf(const WCHAR *file, const WCHAR *format, ...)
  56 #else /* WIDE_SCANF */
  57 #define _FUNCTION_ MSVCRT_sscanf(const char *file, const char *format, ...)
  58 #endif /* WIDE_SCANF */
  59 #else /* STRING */
  60 #ifdef WIDE_SCANF
  61 #define _GETC_(file) MSVCRT_fgetwc(file)
  62 #define _UNGETC_(nch, file) MSVCRT_ungetwc(nch, file)
  63 #define _FUNCTION_ MSVCRT_fwscanf(MSVCRT_FILE* file, const WCHAR *format, ...)
  64 #else /* WIDE_SCANF */
  65 #define _GETC_(file) MSVCRT_fgetc(file)
  66 #define _UNGETC_(nch, file) MSVCRT_ungetc(nch, file)
  67 #define _FUNCTION_ MSVCRT_fscanf(MSVCRT_FILE* file, const char *format, ...)
  68 #endif /* WIDE_SCANF */
  69 #endif /* STRING */
  70 #endif /* CONSOLE */
  71
  72 /*********************************************************************
  73  * Implemented based on
  74  * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vccore98/html/_crt_format_specification_fields_.2d_.scanf_and_wscanf_functions.asp
  75  * Extended by C. Scott Ananian <cananian@alumni.princeton.edu> to handle
  76  * more types of format spec.
  77  */
  78 int _FUNCTION_ {
  79     int rd = 0;
  80     int nch;
  81     va_list ap;
  82     if (!*format) return 0;
  83 #ifndef WIDE_SCANF
  84 #ifdef CONSOLE
  85     WARN("(\"%s\"): semi-stub\n", format);
  86 #else /* CONSOLE */
  87 #ifdef STRING
  88     WARN("%s (\"%s\"): semi-stub\n", file, format);
  89 #else /* STRING */
  90     WARN("%p (\"%s\"): semi-stub\n", file, format);
  91 #endif /* STRING */
  92 #endif /* CONSOLE */
  93 #endif /* WIDE_SCANF */
  94     nch = _GETC_(file);
  95     va_start(ap, format);
  96     while (*format) {
  97         /* a whitespace character in the format string causes scanf to read,
  98          * but not store, all consecutive white-space characters in the input
  99          * up to the next non-white-space character.  One white space character
 100          * in the input matches any number (including zero) and combination of
 101          * white-space characters in the input. */
 102         if (_ISSPACE_(*format)) {
 103             /* skip whitespace */
 104             while ((nch!=_EOF_) && _ISSPACE_(nch))
 105                 nch = _GETC_(file);
 106         }
 107         /* a format specification causes scanf to read and convert characters
 108          * in the input into values of a specified type.  The value is assigned
 109          * to an argument in the argument list.  Format specifications have
 110          * the form %[*][width][{h | l | I64 | L}]type */
 111         else if (*format == _L_('%')) {
 112             int st = 0; int suppress = 0; int width = 0;
 113             int base, number_signed;
 114             int h_prefix = 0;
 115             int l_prefix = 0;
 116             int L_prefix = 0;
 117             int w_prefix = 0;
 118             int prefix_finished = 0;
 119             /* int I64_prefix = 0; */
 120             format++;
 121             /* look for leading asterisk, which means 'suppress assignment of
 122              * this field'. */
 123             if (*format==_L_('*')) {
 124                 format++;
 125                 suppress=1;
 126             }
 127             /* look for width specification */
 128             while (_ISDIGIT_(*format)) {
 129                 width*=10;
 130                 width+=*format++ - _L_('0');
 131             }
 132             if (width==0) width=-1; /* no width spec seen */
 133             /* read prefix (if any) */
 134             while (!prefix_finished) {
 135                 switch(*format) {
 136                 case _L_('h'): h_prefix = 1; break;
 137                 case _L_('l'): l_prefix = 1; break;
 138                 case _L_('w'): w_prefix = 1; break;
 139                 case _L_('L'): L_prefix = 1; break;
 140                 case _L_('I'):
 141                     if (*(format + 1) == _L_('6') &&
 142                         *(format + 2) == _L_('4')) {
 143                         /* I64_prefix = 1; */
 144                         format += 2;
 145                         FIXME("I64 prefix currently not implemented in fscanf/fwscanf");
 146                     }
 147                     break;
 148                 default:
 149                     prefix_finished = 1;
 150                 }
 151                 if (!prefix_finished) format++;
 152             }
 153             /* read type */
 154             switch(*format) {
 155             case _L_('%'): { /* read a percent symbol */
 156                     while ((nch!=_EOF_) && _ISSPACE_(nch))
 157                         nch = _GETC_(file);
 158                     if (nch==_L_('%')) {
 159                         suppress = 1; /* whoops no field to be read */
 160                         st = 1; /* but we got what we expected */
 161                         nch = _GETC_(file);
 162                     }
 163                 }
 164                 break;
 165             case _L_('x'):
 166             case _L_('X'): /* hexadecimal integer. */
 167                 base = 16; number_signed = 0;
 168                 goto number;
 169             case _L_('o'): /* octal integer */
 170                 base = 8; number_signed = 0;
 171                 goto number;
 172             case _L_('u'): /* unsigned decimal integer */
 173                 base = 10; number_signed = 0;
 174                 goto number;
 175             case _L_('d'): /* signed decimal integer */
 176                 base = 10; number_signed = 1;
 177                 goto number;
 178             case _L_('i'): /* generic integer */
 179                 base = 0; number_signed = 1;
 180             number: {
 181                     /* read an integer */
 182                     long unsigned int cur = 0;
 183                     int negative = 0;
 184                     int seendigit=0;
 185                     /* skip initial whitespace */
 186                     while ((nch!=_EOF_) && _ISSPACE_(nch))
 187                         nch = _GETC_(file);
 188                     /* get sign */
 189                     if (number_signed && (nch == _L_('-') ||
 190                                           nch == _L_('+'))) {
 191                         negative = (nch==_L_('-'));
 192                         nch = _GETC_(file);
 193                         if (width>0) width--;
 194                     }
 195                     /* look for leading indication of base */
 196                     if (width!=0 && nch == _L_('0')) {
 197                         nch = _GETC_(file);
 198                         if (width>0) width--;
 199                         seendigit=1;
 200                         if (width!=0 && (nch==_L_('x') || nch==_L_('X'))) {
 201                             if (base==0)
 202                                 base=16;
 203                             if (base==16) {
 204                                 nch = _GETC_(file);
 205                                 if (width>0) width--;
 206                                 seendigit=0;
 207                             }
 208                         } else if (base==0)
 209                             base = 8;
 210                     }
 211                     /* throw away leading zeros */
 212                     while (width!=0 && nch==_L_('0')) {
 213                         nch = _GETC_(file);
 214                         if (width>0) width--;
 215                         seendigit=1;
 216                     }
 217                     if (width!=0 && _CHAR2DIGIT_(nch, base)!=-1) {
 218                         cur = _CHAR2DIGIT_(nch, base);
 219                         nch = _GETC_(file);
 220                         if (width>0) width--;
 221                         seendigit=1;
 222                     }
 223                     /* read until no more digits */
 224                     while (width!=0 && (nch!=_EOF_) && _CHAR2DIGIT_(nch, base)!=-1) {
 225                         cur = cur*base + _CHAR2DIGIT_(nch, base);
 226                         nch = _GETC_(file);
 227                         if (width>0) width--;
 228                         seendigit=1;
 229                     }
 230                     /* okay, done! */
 231                     if (!seendigit) break; /* not a valid number */
 232                     st = 1;
 233                     if (!suppress) {
 234 #define _SET_NUMBER_(type) *va_arg(ap, type*) = negative ? -cur : cur
 235                         if (number_signed) {
 236                             if (l_prefix) _SET_NUMBER_(long int);
 237                             else if (h_prefix) _SET_NUMBER_(short int);
 238                             else _SET_NUMBER_(int);
 239                         } else {
 240                             if (negative) {
 241                                 WARN("Dropping sign in reading a negative number into an unsigned value");
 242                                 negative = 0;
 243                             }
 244                             if (l_prefix) _SET_NUMBER_(unsigned long int);
 245                             else if (h_prefix)
 246                                 _SET_NUMBER_(unsigned short int);
 247                             else _SET_NUMBER_(unsigned int);
 248                         }
 249                     }
 250                 }
 251                 break;
 252             case _L_('e'):
 253             case _L_('E'):
 254             case _L_('f'):
 255             case _L_('g'):
 256             case _L_('G'): { /* read a float */
 257                     long double cur = 0;
 258                     int negative = 0;
 259                     /* skip initial whitespace */
 260                     while ((nch!=_EOF_) && _ISSPACE_(nch))
 261                         nch = _GETC_(file);
 262                     /* get sign. */
 263                     if (nch == _L_('-') || nch == _L_('+')) {
 264                         negative = (nch==_L_('-'));
 265                         if (width>0) width--;
 266                         if (width==0) break;
 267                         nch = _GETC_(file);
 268                     }
 269                     /* get first digit. */
 270                     if (!_ISDIGIT_(nch)) break;
 271                     cur = (nch - _L_('0')) * (negative ? -1 : 1);
 272                     nch = _GETC_(file);
 273                     if (width>0) width--;
 274                     /* read until no more digits */
 275                     while (width!=0 && (nch!=_EOF_) && _ISDIGIT_(nch)) {
 276                         cur = cur*10 + (nch - _L_('0'));
 277                         nch = _GETC_(file);
 278                         if (width>0) width--;
 279                     }
 280                     /* handle decimals */
 281                     if (width!=0 && nch == _L_('.')) {
 282                         float dec = 1;
 283                         nch = _GETC_(file);
 284                         if (width>0) width--;
 285                         while (width!=0 && (nch!=_EOF_) && _ISDIGIT_(nch)) {
 286                             dec /= 10;
 287                             cur += dec * (nch - _L_('0'));
 288                             nch = _GETC_(file);
 289                             if (width>0) width--;
 290                         }
 291                     }
 292                     /* handle exponent */
 293                     if (width!=0 && (nch == _L_('e') || nch == _L_('E'))) {
 294                         int exponent = 0, negexp = 0;
 295                         float expcnt;
 296                         nch = _GETC_(file);
 297                         if (width>0) width--;
 298                         /* possible sign on the exponent */
 299                         if (width!=0 && (nch==_L_('+') || nch==_L_('-'))) {
 300                             negexp = (nch==_L_('-'));
 301                             nch = _GETC_(file);
 302                             if (width>0) width--;
 303                         }
 304                         /* exponent digits */
 305                         while (width!=0 && (nch!=_EOF_) && _ISDIGIT_(nch)) {
 306                             exponent *= 10;
 307                             exponent += (nch - _L_('0'));
 308                             nch = _GETC_(file);
 309                             if (width>0) width--;
 310                         }
 311                         /* update 'cur' with this exponent. */
 312                         expcnt =  negexp ? .1 : 10;
 313                         while (exponent!=0) {
 314                             if (exponent&1)
 315                                 cur*=expcnt;
 316                             exponent/=2;
 317                             expcnt=expcnt*expcnt;
 318                         }
 319                     }
 320                     st = 1;
 321                     if (!suppress) {
 322                         if (L_prefix) _SET_NUMBER_(long double);
 323                         else if (l_prefix) _SET_NUMBER_(double);
 324                         else _SET_NUMBER_(float);
 325                     }
 326                 }
 327                 break;
 328                 /* According to
 329                  * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_crt_scanf_type_field_characters.asp
 330                  * 's' reads a character string in a call to fscanf
 331                  * and 'S' a wide character string and vice versa in a
 332                  * call to fwscanf. The 'h', 'w' and 'l' prefixes override
 333                  * this behaviour. 'h' forces reading char * but 'l' and 'w'
 334                  * force reading WCHAR. */
 335             case _L_('s'):
 336                     if (w_prefix || l_prefix) goto widecharstring;
 337                     else if (h_prefix) goto charstring;
 338 #ifdef WIDE_SCANF
 339                     else goto widecharstring;
 340 #else /* WIDE_SCANF */
 341                     else goto charstring;
 342 #endif /* WIDE_SCANF */
 343             case _L_('S'):
 344                     if (w_prefix || l_prefix) goto widecharstring;
 345                     else if (h_prefix) goto charstring;
 346 #ifdef WIDE_SCANF
 347                     else goto charstring;
 348 #else /* WIDE_SCANF */
 349                     else goto widecharstring;
 350 #endif /* WIDE_SCANF */
 351             charstring: { /* read a word into a char */
 352                     char*str = suppress ? NULL : va_arg(ap, char*);
 353                     char*sptr = str;
 354                     /* skip initial whitespace */
 355                     while ((nch!=_EOF_) && _ISSPACE_(nch))
 356                         nch = _GETC_(file);
 357                     /* read until whitespace */
 358                     while (width!=0 && (nch!=_EOF_) && !_ISSPACE_(nch)) {
 359 #ifdef WIDE_SCANF
 360                         if (!suppress) *sptr++ = _CONVERT_(nch);
 361 #else /* WIDE_SCANF */
 362                         if (!suppress) *sptr++ = nch;
 363 #endif /* WIDE_SCANF */
 364                         st++;
 365                         nch = _GETC_(file);
 366                         if (width>0) width--;
 367                     }
 368                     /* terminate */
 369                     if (!suppress) *sptr = 0;
 370                 }
 371                 break;
 372             widecharstring: { /* read a word into a WCHAR * */
 373                     WCHAR*str =
 374                         suppress ? NULL : va_arg(ap, WCHAR*);
 375                     WCHAR*sptr = str;
 376                     /* skip initial whitespace */
 377                     while ((nch!=_EOF_) && _ISSPACE_(nch))
 378                         nch = _GETC_(file);
 379                     /* read until whitespace */
 380                     while (width!=0 && (nch!=_EOF_) && !_ISSPACE_(nch)) {
 381 #ifdef WIDE_SCANF
 382                         if (!suppress) *sptr++ = nch;
 383 #else /* WIDE_SCANF */
 384                         if (!suppress) *sptr++ = _CONVERT_(nch);
 385 #endif /* WIDE_SCANF */
 386                         st++;
 387                         nch = _GETC_(file);
 388                         if (width>0) width--;
 389                     }
 390                     /* terminate */
 391                     if (!suppress) *sptr = 0;
 392                 }
 393                 break;
 394             /* 'c' and 'C work analogously to 's' and 'S' as described
 395              * above */
 396             case _L_('c'):
 397                     if (w_prefix || l_prefix) goto widecharacter;
 398                     else if (h_prefix) goto character;
 399 #ifdef WIDE_SCANF
 400                     else goto widecharacter;
 401 #else /* WIDE_SCANF */
 402                     else goto character;
 403 #endif /* WIDE_SCANF */
 404             case _L_('C'):
 405                     if (w_prefix || l_prefix) goto widecharacter;
 406                     else if (h_prefix) goto character;
 407 #ifdef WIDE_SCANF
 408                     else goto character;
 409 #else /* WIDE_SCANF */
 410                     else goto widecharacter;
 411 #endif /* WIDE_SCANF */
 412           character: { /* read single character into char */
 413                     if (!suppress) {
 414                         char*c = va_arg(ap, char*);
 415 #ifdef WIDE_SCANF
 416                         *c = _CONVERT_(nch);
 417 #else /* WIDE_SCANF */
 418                         *c = nch;
 419 #endif /* WIDE_SCANF */
 420                         st = 1;
 421                     }
 422                     nch = _GETC_(file);
 423                 }
 424                 break;
 425           widecharacter: {
 426                     if (!suppress) { /* read single character into WCHAR */
 427                         WCHAR*c = va_arg(ap, WCHAR*);
 428 #ifdef WIDE_SCANF
 429                         *c = nch;
 430 #else /* WIDE_SCANF */
 431                         *c = _CONVERT_(nch);
 432 #endif /* WIDE_SCANF */
 433                         st = 1;
 434                     }
 435                     nch = _GETC_(file);
 436                 }
 437                 break;
 438             case _L_('n'): {
 439                     if (!suppress) {
 440                         int*n = va_arg(ap, int*);
 441                         *n = rd;
 442                     }
 443                 }
 444                 break;
 445             case _L_('['): {
 446                     _CHAR_ *str = suppress ? NULL : va_arg(ap, _CHAR_*);
 447                     _CHAR_ *sptr = str;
 448                     RTL_BITMAP bitMask;
 449                     LPBYTE Mask;
 450                     int invert = 0; /* Set if we are NOT to find the chars */
 451
 452                     /* Init our bitmap */
 453 #ifdef WIDE_SCANF
 454                     Mask = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, 65536/8);
 455                     RtlInitializeBitMap(&bitMask, Mask, 65536);
 456 #else /* WIDE_SCANF */
 457                     Mask = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, 256/8);
 458                     RtlInitializeBitMap(&bitMask, Mask, 256);
 459 #endif /* WIDE_SCANF */
 460
 461                     /* Read the format */
 462                     format++;
 463                     if(*format == '^') {
 464                         invert = 1;
 465                         format++;
 466                     }
 467                     if(*format == ']') {
 468                         RtlSetBits(&bitMask, ']', 1);
 469                         format++;
 470                     }
 471                     while(*format && (*format != ']')) {
 472                         if((*format == '-') && (*(format + 1) != ']')) {
 473                             int n = 0;
 474                             for(;(n + *(format - 1)) < *(format + 1); n++)
 475                                 RtlSetBits(&bitMask, n + *(format - 1), 1);
 476                             format++;
 477                         }
 478                         RtlSetBits(&bitMask, *format, 1);
 479                         format++;
 480                     }
 481                     /* read until char is not suitable */
 482                     while ((width != 0) && (nch != _EOF_)) {
 483                         if(!invert) {
 484                             if(RtlAreBitsSet(&bitMask, nch, 1)) {
 485 #ifdef WIDE_SCANF
 486                                 if (!suppress) *sptr++ = _CONVERT_(nch);
 487 #else /* WIDE_SCANF */
 488                                 if (!suppress) *sptr++ = nch;
 489 #endif /* WIDE_SCANF */
 490                             } else
 491                                 break;
 492                         } else {
 493                             if(RtlAreBitsClear(&bitMask, nch, 1)) {
 494 #ifdef WIDE_SCANF
 495                                 if (!suppress) *sptr++ = _CONVERT_(nch);
 496 #else /* WIDE_SCANF */
 497                                 if (!suppress) *sptr++ = nch;
 498 #endif /* WIDE_SCANF */
 499                             } else
 500                                 break;
 501                         }
 502                         st++;
 503                         nch = _GETC_(file);
 504                         if (width>0) width--;
 505                     }
 506                     /* terminate */
 507                     if (!suppress) *sptr = 0;
 508                     HeapFree(GetProcessHeap(), 0, Mask);
 509                 }
 510                 break;
 511             default: FIXME("unhandled: %%%c\n", *format);
 512                 /* From spec: "if a percent sign is followed by a character
 513                  * that has no meaning as a format-control character, that
 514                  * character and the following characters are treated as
 515                  * an ordinary sequence of characters, that is, a sequence
 516                  * of characters that must match the input.  For example,
 517                  * to specify that a percent-sign character is to be input,
 518                  * use %%."
 519                  * LEAVING AS-IS because we catch bugs better that way. */
 520             }
 521             if (st && !suppress) rd++;
 522             else if (!st) break;
 523         }
 524         /* a non-white-space character causes scanf to read, but not store,
 525          * a matching non-white-space character. */
 526         else {
 527             /* check for character match */
 528             if (nch == *format) {
 529                 nch = _GETC_(file);
 530             } else break;
 531         }
 532         format++;
 533     }
 534     if (nch!=_EOF_) {
 535         _UNGETC_(nch, file);
 536     }
 537     va_end(ap);
 538     TRACE("returning %d\n", rd);
 539     return rd;
 540 }
 541
 542 #undef _L_
 543 #undef _CHAR_
 544 #undef _EOF_
 545 #undef _ISSPACE_
 546 #undef _ISDIGIT_
 547 #undef _CONVERT_
 548 #undef _CHAR2DIGIT_
 549 #undef _GETC_
 550 #undef _UNGETC_
 551 #undef _FUNCTION_