parser.c

   1 /*
   2  * parser.c --
   3  *
   4  * Copyright 2011, 2012, 2013 Free Software Foundation, Inc.
   5  * ------------------------------------------------------------------------
   6  *
   7  * GNU XBoard is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or (at
  10  * your option) any later version.
  11  *
  12  * GNU XBoard is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program. If not, see http://www.gnu.org/licenses/.  *
  19  *
  20  *------------------------------------------------------------------------
  21  ** See the file ChangeLog for a revision history.  */
  22
  23 #include "config.h"
  24 #include <stdio.h>
  25 #include <ctype.h>
  26 #include <string.h>
  27 #include "common.h"
  28 #include "backend.h"
  29 #include "frontend.h"
  30 #include "parser.h"
  31 #include "moves.h"
  32
  33
  34 extern Board    boards[MAX_MOVES];
  35 extern int      PosFlags(int nr);
  36 int             yyboardindex;
  37 int             yyskipmoves = FALSE;
  38 char            currentMoveString[4096]; // a bit ridiculous size?
  39 char *yy_text;
  40
  41 #define PARSEBUFSIZE 10000
  42
  43 static FILE *inputFile;
  44 static char *inPtr, *parsePtr, *parseStart;
  45 static char inputBuf[PARSEBUFSIZE];
  46 static char yytext[PARSEBUFSIZE];
  47 static char fromString = 0, lastChar = '\n';
  48
  49 #define NOTHING 0
  50 #define NUMERIC 1
  51 #define ALPHABETIC 2
  52 #define BADNUMBER (-2000000000)
  53
  54 int
  55 ReadLine ()
  56 {   // Read one line from the input file, and append to the buffer
  57     char c, *start = inPtr;
  58     if(fromString) return 0; // parsing string, so the end is a hard end
  59     if(!inputFile) return 0;
  60     while((c = fgetc(inputFile)) != EOF) {
  61         *inPtr++ = c;
  62         if(c == '\n') { *inPtr = NULLCHAR; return 1; }
  63         if(inPtr - inputBuf > PARSEBUFSIZE-2) inPtr--; //prevent crash on overflow
  64     }
  65     if(inPtr == start) return 0;
  66     *inPtr++ = '\n', *inPtr = NULLCHAR; // repair missing linefeed at EOF
  67     return 1;
  68 }
  69
  70 int
  71 Scan (char c, char **p)
  72 {   // line-spanning skip to mentioned character or EOF
  73     do {
  74         while(**p) if(*(*p)++ == c) return 0;
  75     } while(ReadLine());
  76     // no closing bracket; force match for entire rest of file.
  77     return 1;
  78 }
  79
  80 int
  81 SkipWhite (char **p)
  82 {   // skip spaces tabs and newlines; return 1 if anything was skipped
  83     char *start = *p;
  84     do{
  85         while(**p == ' ' || **p == '\t' || **p == '\n' || **p == '\r') (*p)++;
  86     } while(**p == NULLCHAR && ReadLine()); // continue as long as ReadLine reads something
  87     return *p != start;
  88 }
  89
  90 inline int
  91 Match (char *pattern, char **ptr)
  92 {
  93     char *p = pattern, *s = *ptr;
  94     while(*p && (*p == *s++ || s[-1] == '\r' && *p--)) p++;
  95     if(*p == 0) {
  96         *ptr = s;
  97         return 1;
  98     }
  99     return 0; // no match, no ptr update
 100 }
 101
 102 inline int
 103 Word (char *pattern, char **p)
 104 {
 105     if(Match(pattern, p)) return 1;
 106     if(*pattern >= 'a' && *pattern <= 'z' && *pattern - **p == 'a' - 'A') { // capitalized
 107         (*p)++;
 108         if(Match(pattern + 1, p)) return 1;
 109         (*p)--;
 110     }
 111     return 0;
 112 }
 113
 114 int
 115 Verb (char *pattern, char **p)
 116 {
 117     int res = Word(pattern, p);
 118     if(res && !Match("s", p)) Match("ed", p); // eat conjugation suffix, if any
 119     return res;
 120 }
 121
 122 int
 123 Number (char **p)
 124 {
 125     int val = 0;
 126     if(**p < '0' || **p > '9') return BADNUMBER;
 127     while(**p >= '0' && **p <= '9') {
 128         val = 10*val + *(*p)++ - '0';
 129     }
 130     return val;
 131 }
 132
 133 int
 134 RdTime (char c, char **p)
 135 {
 136     char *start = ++(*p), *sec; // increment *p, as it was pointing to the opening ( or {
 137     if(Number(p) == BADNUMBER) return 0;
 138     sec = *p;
 139     if(Match(":", p) && Number(p) != BADNUMBER && *p - sec == 3) { // well formed
 140         sec = *p;
 141         if(Match(".", p) && Number(p) != BADNUMBER && *(*p)++ == c) return 1; // well-formed fraction
 142         *p = sec;
 143         if(*(*p)++ == c) return 1; // matching bracket without fraction
 144     }
 145     *p = start; // failure
 146     return 0;
 147 }
 148
 149 char
 150 PromoSuffix (char **p)
 151 {
 152     char *start = *p;
 153     if(**p == 'e' && (Match("ep", p) || Match("e.p.", p))) { *p = start; return NULLCHAR; } // non-compliant e.p. suffix is no promoChar!
 154     if(**p == '+' && IS_SHOGI(gameInfo.variant)) { (*p)++; return '+'; }
 155     if(**p == '=' || (gameInfo.variant == VariantSChess) && **p == '/') (*p)++; // optional = (or / for Seirawan gating)
 156     if(**p == '(' && (*p)[2] == ')' && isalpha( (*p)[1] )) { (*p) += 3; return ToLower((*p)[-2]); }
 157     if(isalpha(**p) && **p != 'x') return ToLower(*(*p)++); // reserve 'x' for multi-leg captures?
 158     if(*p != start) return '='; // must be the optional =
 159     return NULLCHAR; // no suffix detected
 160 }
 161
 162 int
 163 NextUnit (char **p)
 164 {       // Main parser routine
 165         int coord[4], n, result, piece, i;
 166         char type[4], promoted, separator, slash, *oldp, *commentEnd, c;
 167         int wom = quickFlag ? quickFlag&1 : WhiteOnMove(yyboardindex);
 168
 169         // ********* try white first, because it is so common **************************
 170         if(**p == ' ' || **p == '\n' || **p == '\t') { parseStart = (*p)++; return Nothing; }
 171
 172
 173         if(**p == NULLCHAR) { // make sure there is something to parse
 174             if(fromString) return 0; // we are parsing string, so the end is really the end
 175             *p = inPtr = inputBuf;
 176             if(!ReadLine()) return 0; // EOF
 177         }
 178         parseStart = oldp = *p; // remember where we begin
 179
 180
 181         // ********* attempt to recognize a SAN move in the leading non-blank text *****
 182         piece = separator = promoted = slash = n = 0;
 183         for(i=0; i<4; i++) coord[i] = -1, type[i] = NOTHING;
 184         if(**p == '+') (*p)++, promoted++;
 185         if(**p >= 'a' && **p <= 'z' && (*p)[1]== '@') piece =*(*p)++ + 'A' - 'a'; else
 186         if(**p >= 'A' && **p <= 'Z') {
 187              piece = *(*p)++; // Note we could test for 2-byte non-ascii names here
 188              if(**p == '/') slash = *(*p)++;
 189         }
 190         while(n < 4) {
 191             if(**p >= 'a' && **p < 'x') coord[n] = *(*p)++ - 'a', type[n++] = ALPHABETIC;
 192             else if((i = Number(p)) != BADNUMBER) coord[n] = i, type[n++] = NUMERIC;
 193             else break;
 194             if(n == 2 && type[0] == type[1]) { // if two identical types, the opposite type in between must have been missing
 195                 type[2] = type[1]; coord[2] = coord[1];
 196                 type[1] = NOTHING; coord[1] = -1; n++;
 197             }
 198         }
 199         // we always get here, and might have read a +, a piece, and upto 4 potential coordinates
 200         if(n <= 2) { // could be from-square or disambiguator, when -:xX follow, or drop with @ directly after piece, but also to-square
 201              if(**p == '-' || **p == ':' || **p == 'x' || **p == 'X' || // these cannot be move suffix, so to-square must follow
 202                  (**p == '@' || **p == '*') && n == 0 && !promoted && piece) { // P@ must also be followed by to-square
 203                 separator = *(*p)++;
 204                 if(n == 1) coord[1] = coord[0]; // must be disambiguator, but we do not know which yet
 205                 n = 2;
 206                 while(n < 4) { // attempt to read to-square
 207                     if(**p >= 'a' && **p < 'x') coord[n] = *(*p)++ - 'a', type[n++] = ALPHABETIC;
 208                     else if((i = Number(p)) != BADNUMBER) coord[n] = i, type[n++] = NUMERIC;
 209                     else break;
 210                 }
 211             } else if((**p == '+' || **p == '=') && n == 1 && piece && type[0] == NUMERIC) { // can be traditional Xiangqi notation
 212                 separator = *(*p)++;
 213                 n = 2;
 214                 if((i = Number(p)) != BADNUMBER) coord[n] = i, type[n++] = NUMERIC;
 215             } else if(n == 2) { // only one square mentioned, must be to-square
 216                 while(n < 4) { coord[n] = coord[n-2], type[n] = type[n-2], coord[n-2] = -1, type[n-2] = NOTHING; n++; }
 217             }
 218         } else if(n == 3 && type[1] != NOTHING) { // must be hyphenless disambiguator + to-square
 219             for(i=3; i>0; i--) coord[i] = coord[i-1], type[i] = type[i-1]; // move to-square to where it belongs
 220             type[1] = NOTHING; // disambiguator goes in first two positions
 221             n = 4;
 222         }
 223         // we always get here; move must be completely read now, with to-square coord(s) at end
 224         if(n == 3) { // incomplete to-square. Could be Xiangqi traditional, or stuff like fxg
 225             if(piece && type[1] == NOTHING && type[0] == NUMERIC && type[2] == NUMERIC &&
 226                 (separator == '+' || separator == '=' || separator == '-')) {
 227                      // Xiangqi traditional
 228
 229                 return ImpossibleMove; // for now treat as invalid
 230             }
 231             // fxg stuff, but also things like 0-0, 0-1 and 1-0
 232             if(!piece && type[1] == NOTHING && type[0] == ALPHABETIC && type[2] == ALPHABETIC
 233                  && (coord[0] != 14 || coord[2] != 14) /* reserve oo for castling! */ ) {
 234                 piece = 'P'; n = 4; // kludge alert: fake full to-square
 235             }
 236         } else if(n == 1 && type[0] == NUMERIC && coord[0] > 1) { while(**p == '.') (*p)++; return Nothing; } // fast exit for move numbers
 237         if(n == 4 && type[2] != type[3] && // we have a valid to-square (kludge: type[3] can be NOTHING on fxg type move)
 238                      (piece || !promoted) && // promoted indicator only valid on named piece type
 239                      (type[2] == ALPHABETIC || IS_SHOGI(gameInfo.variant))) { // in Shogi also allow alphabetic rank
 240             DisambiguateClosure cl;
 241             int fromX, fromY, toX, toY;
 242
 243             if(slash && (!piece || type[1] == NOTHING)) goto badMove; // slash after piece only in ICS long format
 244             if (yyskipmoves) return (int) AmbiguousMove; /* not disambiguated */
 245
 246             if(type[2] == NUMERIC) { // alpha-rank
 247                 coord[2] = BOARD_RGHT - BOARD_LEFT - coord[2];
 248                 coord[3] = BOARD_HEIGHT - coord[3];
 249                 if(coord[0] >= 0) coord[0] = BOARD_RGHT - BOARD_LEFT - coord[0];
 250                 if(coord[1] >= 0) coord[1] = BOARD_HEIGHT - coord[1];
 251             }
 252             toX = cl.ftIn = (currentMoveString[2] = coord[2] + 'a') - AAA;
 253             toY = cl.rtIn = (currentMoveString[3] = coord[3] + '0') - ONE;
 254             if(type[3] == NOTHING) cl.rtIn = -1; // for fxg type moves ask for toY disambiguation
 255             else if(toY >= BOARD_HEIGHT || toY < 0)   return ImpossibleMove; // vert off-board to-square
 256             if(toX < BOARD_LEFT || toX >= BOARD_RGHT) return ImpossibleMove;
 257             if(piece) {
 258                 cl.pieceIn = CharToPiece(wom ? piece : ToLower(piece));
 259                 if(cl.pieceIn == EmptySquare) return ImpossibleMove; // non-existent piece
 260                 if(promoted) cl.pieceIn = (ChessSquare) (CHUPROMOTED cl.pieceIn);
 261             } else cl.pieceIn = EmptySquare;
 262             if(separator == '@' || separator == '*') { // drop move. We only get here without from-square or promoted piece
 263                 fromY = DROP_RANK; fromX = cl.pieceIn;
 264                 currentMoveString[0] = piece;
 265                 currentMoveString[1] = '@';
 266                 return LegalityTest(boards[yyboardindex], PosFlags(yyboardindex)&~F_MANDATORY_CAPTURE, fromY, fromX, toY, toX, NULLCHAR);
 267             }
 268             if(type[1] == NOTHING && type[0] != NOTHING) { // there is a disambiguator
 269                 if(type[0] != type[2]) coord[0] = -1, type[1] = type[0], type[0] = NOTHING; // it was a rank-disambiguator
 270             }
 271             if(  type[1] != type[2] && // means fromY is of opposite type as ToX, or NOTHING
 272                 (type[0] == NOTHING || type[0] == type[2]) ) { // well formed
 273
 274                 fromX = (currentMoveString[0] = coord[0] + 'a') - AAA;
 275                 fromY = (currentMoveString[1] = coord[1] + '0') - ONE;
 276                 currentMoveString[4] = cl.promoCharIn = PromoSuffix(p);
 277                 currentMoveString[5] = NULLCHAR;
 278                 if(!cl.promoCharIn && (**p == '-' || **p == 'x')) { // Lion-type multi-leg move
 279                     currentMoveString[5] = (killX = toX) + AAA; // what we thought was to-square is in fact kill-square
 280                     currentMoveString[6] = (killY = toY) + ONE; // append it as suffix behind long algebraic move
 281                     currentMoveString[4] = ';';
 282                     currentMoveString[7] = NULLCHAR;
 283                     // read new to-square (VERY non-robust! Assumes correct (non-alpha-rank) syntax, and messes up on errors)
 284                     toX = cl.ftIn = (currentMoveString[2] = *++*p) - AAA; ++*p;
 285                     toY = cl.rtIn = (currentMoveString[3] = Number(p) + '0') - ONE;
 286                 }
 287                 if(type[0] != NOTHING && type[1] != NOTHING && type[3] != NOTHING) { // fully specified.
 288                     // Note that Disambiguate does not work for illegal moves, but flags them as impossible
 289                     if(piece) { // check if correct piece indicated
 290                         ChessSquare realPiece = boards[yyboardindex][fromY][fromX];
 291                         if(PieceToChar(realPiece) == '~') realPiece = (ChessSquare) (DEMOTED realPiece);
 292                         if(!(appData.icsActive && PieceToChar(realPiece) == '+') && // trust ICS if it moves promoted pieces
 293                            piece && realPiece != cl.pieceIn) return ImpossibleMove;
 294                     }
 295                     result = LegalityTest(boards[yyboardindex], PosFlags(yyboardindex), fromY, fromX, toY, toX, cl.promoCharIn);
 296                     if (currentMoveString[4] == NULLCHAR) { // suppy missing mandatory promotion character
 297                       if(result == WhitePromotion  || result == BlackPromotion) {
 298                         switch(gameInfo.variant) {
 299                           case VariantCourier:
 300                           case VariantShatranj: currentMoveString[4] = PieceToChar(BlackFerz); break;
 301                           case VariantGreat:    currentMoveString[4] = PieceToChar(BlackMan); break;
 302                           case VariantShogi:    currentMoveString[4] = '+'; break;
 303                           default:              currentMoveString[4] = PieceToChar(BlackQueen);
 304                         }
 305                       } else if(result == WhiteNonPromotion  || result == BlackNonPromotion) {
 306                                                 currentMoveString[4] = '=';
 307                       }
 308                     } else if(appData.testLegality && gameInfo.variant != VariantSChess && // strip off unnecessary and false promo characters
 309                        !(result == WhitePromotion  || result == BlackPromotion ||
 310                          result == WhiteNonPromotion || result == BlackNonPromotion)) currentMoveString[4] = NULLCHAR;
 311                     return result;
 312                 } else if(cl.pieceIn == EmptySquare) cl.pieceIn = wom ? WhitePawn : BlackPawn;
 313                 cl.ffIn = type[0] == NOTHING ? -1 : coord[0] + 'a' - AAA;
 314                 cl.rfIn = type[1] == NOTHING ? -1 : coord[1] + '0' - ONE;
 315
 316                 Disambiguate(boards[yyboardindex], PosFlags(yyboardindex), &cl);
 317
 318                 if(cl.kind == ImpossibleMove && !piece && type[1] == NOTHING // fxg5 type
 319                         && toY == (wom ? 4 : 3)) { // could be improperly written e.p.
 320                     cl.rtIn += wom ? 1 : -1; // shift target square to e.p. square
 321                     Disambiguate(boards[yyboardindex], PosFlags(yyboardindex), &cl);
 322                     if((cl.kind != WhiteCapturesEnPassant && cl.kind != BlackCapturesEnPassant))
 323                         return ImpossibleMove; // nice try, but no cigar
 324                 }
 325
 326                 currentMoveString[0] = cl.ff + AAA;
 327                 currentMoveString[1] = cl.rf + ONE;
 328                 currentMoveString[3] = cl.rt + ONE;
 329                 if(killX < 0) // [HGM] lion: do not overwrite kill-square suffix
 330                 currentMoveString[4] = cl.promoChar;
 331
 332                 if((cl.kind == WhiteCapturesEnPassant || cl.kind == BlackCapturesEnPassant) && (Match("ep", p) || Match("e.p.", p)));
 333
 334                 return (int) cl.kind;
 335             }
 336         }
 337 badMove:// we failed to find algebraic move
 338         *p = oldp;
 339
 340
 341         // Next we do some common symbols where the first character commits us to things that cannot possibly be a move
 342
 343         // ********* PGN tags ******************************************
 344         if(**p == '[') {
 345             oldp = ++(*p);
 346             if(Match("--", p)) { // "[--" could be start of position diagram
 347                 if(!Scan(']', p) && (*p)[-3] == '-' && (*p)[-2] == '-') return PositionDiagram;
 348                 *p = oldp;
 349             }
 350             SkipWhite(p);
 351             if(isdigit(**p) || isalpha(**p)) {
 352                 do (*p)++; while(isdigit(**p) || isalpha(**p) || **p == '+' ||
 353                                 **p == '-' || **p == '=' || **p == '_' || **p == '#');
 354                 SkipWhite(p);
 355                 if(**p == '"') {
 356                     (*p)++;
 357                     while(**p != '\n' && (*(*p)++ != '"'|| (*p)[-2] == '\\')); // look for unescaped quote
 358                     if((*p)[-1] !='"') { *p = oldp; Scan(']', p); return Comment; } // string closing delimiter missing
 359                     SkipWhite(p); if(*(*p)++ == ']') return PGNTag;
 360                 }
 361             }
 362             Scan(']', p); return Comment;
 363         }
 364
 365         // ********* SAN Castings *************************************
 366         if(**p == 'O' || **p == 'o' || **p == '0' && !Match("00:", p)) { // exclude 00 in time stamps
 367             int castlingType = 0;
 368             if(Match("O-O-O", p) || Match("o-o-o", p) || Match("0-0-0", p) ||
 369                Match("OOO", p) || Match("ooo", p) || Match("000", p)) castlingType = 2;
 370             else if(Match("O-O", p) || Match("o-o", p) || Match("0-0", p) ||
 371                     Match("OO", p) || Match("oo", p) || Match("00", p)) castlingType = 1;
 372             if(castlingType) { //code from old parser, collapsed for both castling types, and streamlined a bit
 373                 int rf, ff, rt, ft; ChessSquare king;
 374                 char promo=NULLCHAR;
 375
 376                 if(gameInfo.variant == VariantSChess) promo = PromoSuffix(p);
 377
 378                 if (yyskipmoves) return (int) AmbiguousMove; /* not disambiguated */
 379
 380                 if (wom) {
 381                     rf = 0;
 382                     rt = 0;
 383                     king = WhiteKing;
 384                 } else {
 385                     rf = BOARD_HEIGHT-1;
 386                     rt = BOARD_HEIGHT-1;
 387                     king = BlackKing;
 388                 }
 389                 ff = (BOARD_WIDTH-1)>>1; // this would be d-file
 390                 if (boards[yyboardindex][rf][ff] == king) {
 391                     /* ICS wild castling */
 392                     ft = castlingType == 1 ? BOARD_LEFT+1 : (gameInfo.variant == VariantJanus ? BOARD_RGHT-2 : BOARD_RGHT-3);
 393                 } else {
 394                     ff = BOARD_WIDTH>>1; // e-file
 395                     ft = castlingType == 1 ? BOARD_RGHT-2 : BOARD_LEFT+2;
 396                 }
 397                 if(PosFlags(0) & F_FRC_TYPE_CASTLING) {
 398                     if (wom) {
 399                         ff = initialRights[2];
 400                         ft = initialRights[castlingType-1];
 401                     } else {
 402                         ff = initialRights[5];
 403                         ft = initialRights[castlingType+2];
 404                     }
 405                     if (appData.debugMode) fprintf(debugFP, "Parser FRC (type=%d) %d %d\n", castlingType, ff, ft);
 406                     if(ff == NoRights || ft == NoRights) return ImpossibleMove;
 407                 }
 408                 sprintf(currentMoveString, "%c%c%c%c%c",ff+AAA,rf+ONE,ft+AAA,rt+ONE,promo);
 409                 if (appData.debugMode) fprintf(debugFP, "(%d-type) castling %d %d\n", castlingType, ff, ft);
 410
 411                 return (int) LegalityTest(boards[yyboardindex],
 412                               PosFlags(yyboardindex)&~F_MANDATORY_CAPTURE, // [HGM] losers: e.p.!
 413                               rf, ff, rt, ft, promo);
 414             }
 415         }
 416
 417
 418         // ********* variations (nesting) ******************************
 419         if(**p =='(') {
 420             if(RdTime(')', p)) return ElapsedTime;
 421             return Open;
 422         }
 423         if(**p ==')') { (*p)++; return Close; }
 424         if(**p == ';') { while(**p != '\n') (*p)++; return Comment; }
 425
 426
 427         // ********* Comments and result messages **********************
 428         *p = oldp; commentEnd = NULL; result = 0;
 429         if(**p == '{') {
 430             if(RdTime('}', p)) return ElapsedTime;
 431             if(lastChar == '\n' && Match("--------------\n", p)) {
 432                 char *q;
 433                 i = Scan ('}', p); q = *p - 16;
 434                 if(Match("\n--------------}\n", &q)) return PositionDiagram;
 435             } else i = Scan('}', p);
 436             commentEnd = *p; if(i) return Comment; // return comment that runs to EOF immediately
 437         }
 438         if(commentEnd) SkipWhite(p);
 439         if(Match("*", p)) result = GameUnfinished;
 440         else if(**p == '0') {
 441             if( Match("0-1", p) || Match("0/1", p) || Match("0:1", p) ||
 442                 Match("0 - 1", p) || Match("0 / 1", p) || Match("0 : 1", p)) result = BlackWins;
 443         } else if(**p == '1') {
 444             if( Match("1-0", p) || Match("1/0", p) || Match("1:0", p) ||
 445                 Match("1 - 0", p) || Match("1 / 0", p) || Match("1 : 0", p)) result = WhiteWins;
 446             else if(Match("1/2 - 1/2", p) || Match("1/2:1/2", p) || Match("1/2 : 1/2", p) || Match("1 / 2 - 1 / 2", p) ||
 447                     Match("1 / 2 : 1 / 2", p) || Match("1/2", p) || Match("1 / 2", p)) result = GameIsDrawn;
 448         }
 449         if(result) {
 450             if(Match(" (", p) && !Scan(')', p) || Match(" {", p) && !Scan('}', p)) { // there is a comment after the PGN result!
 451                 if(commentEnd) { *p = commentEnd; return Comment; } // so comment before it is normal comment; return that first
 452             }
 453             return result; // this returns a possible preceeding comment as result details
 454         }
 455         if(commentEnd) { *p = commentEnd; return Comment; } // there was no PGN result following, so return as normal comment
 456
 457
 458         // ********* Move numbers (after castlings or PGN results!) ***********
 459         if((i = Number(p)) != BADNUMBER) { // a single number was read as part of our attempt to read a move
 460             char *numEnd = *p;
 461             if(**p == '.') (*p)++; SkipWhite(p);
 462             if(**p == '+' || isalpha(**p) || gameInfo.variant == VariantShogi && *p != numEnd && isdigit(**p)) {
 463                 *p = numEnd;
 464                 return i == 1 ? MoveNumberOne : Nothing;
 465             }
 466             *p = numEnd; return Nothing;
 467         }
 468
 469
 470         // ********* non-compliant game-result indicators *********************
 471         if(Match("+-+", p) || Word("stalemate", p)) return GameIsDrawn;
 472         if(Match("++", p) || Verb("resign", p) || (Word("check", p) || 1) && Word("mate", p) )
 473             return (wom ? BlackWins : WhiteWins);
 474         c = ToUpper(**p);
 475         if(Word("w", p) && (Match("hite", p) || 1) || Word("b", p) && (Match("lack", p) || 1) ) {
 476             if(**p != ' ') return Nothing;
 477             ++*p;
 478             if(Verb("disconnect", p)) return GameUnfinished;
 479             if(Verb("resign", p) || Verb("forfeit", p) || Word("mated", p) || Word("lost", p) || Word("loses", p))
 480                 return (c == 'W' ? BlackWins : WhiteWins);
 481             if(Word("mates", p) || Word("wins", p) || Word("won", p))
 482                 return (c != 'W' ? BlackWins : WhiteWins);
 483             return Nothing;
 484         }
 485         if(Word("draw", p)) {
 486             if(**p == 'n') (*p)++;
 487             if(**p != ' ') return GameIsDrawn;
 488             oldp = ++*p;
 489             if(Word("agreed", p)) return GameIsDrawn;
 490             if(Match("by ", p) && (Word("repetition", p) || Word("agreement", p)) ) return GameIsDrawn;
 491             *p = oldp;
 492             if(*(*p)++ == '(') {
 493                 while(**p != '\n') if(*(*p)++ == ')') break;
 494                 if((*p)[-1] == ')')  return GameIsDrawn;
 495             }
 496             *p = oldp - 1; return GameIsDrawn;
 497         }
 498
 499
 500         // ********* Numeric annotation glyph **********************************
 501         if(**p == '$') { (*p)++; if(Number(p) != BADNUMBER) return NAG; return Nothing; }
 502
 503
 504         // ********** by now we are getting down to the silly stuff ************
 505         if(Word("gnu", p) || Match("GNU", p)) {
 506             if(**p == ' ') (*p)++;
 507             if(Word("chess", p) || Match("CHESS", p)) {
 508                 char *q;
 509                 if((q = strstr(*p, "game")) || (q = strstr(*p, "GAME")) || (q = strstr(*p, "Game"))) {
 510                     (*p) = q + 4; return GNUChessGame;
 511                 }
 512             }
 513             return Nothing;
 514         }
 515         if(lastChar == '\n' && (Match("# ", p) || Match("; ", p) || Match("% ", p))) {
 516             while(**p != '\n' && **p != ' ') (*p)++;
 517             if(**p == ' ' && (Match(" game file", p) || Match(" position file", p))) {
 518                 while(**p != '\n') (*p)++; // skip to EOLN
 519                 return XBoardGame;
 520             }
 521             *p = oldp; // we might need to re-match the skipped stuff
 522         }
 523
 524         if(Match("@@@@", p) || Match("--", p) || Match("Z0", p) || Match("pass", p) || Match("null", p)) {
 525             strncpy(currentMoveString, "@@@@", 5);
 526             return yyboardindex & F_WHITE_ON_MOVE ? WhiteDrop : BlackDrop;
 527         }
 528
 529         // ********* Efficient skipping of (mostly) alphabetic chatter **********
 530         while(isdigit(**p) || isalpha(**p) || **p == '-') (*p)++;
 531         if(*p != oldp) {
 532             if(**p == '\'') {
 533                 while(isdigit(**p) || isalpha(**p) || **p == '-' || **p == '\'') (*p)++;
 534                 return Nothing; // random word
 535             }
 536             if(lastChar == '\n' && Match(": ", p)) { // mail header, skip indented lines
 537                 do {
 538                     while(**p != '\n') (*p)++;
 539                     if(!ReadLine()) return Nothing; // append next line if not EOF
 540                 } while(Match("\n ", p) || Match("\n\t", p));
 541             }
 542             return Nothing;
 543         }
 544
 545         // ********* Prevent 00 in unprotected time stamps to be mistaken for castling *******
 546         if(Match(":00", p)) return Nothing;
 547
 548         // ********* Could not match to anything. Return offending character ****
 549         (*p)++;
 550         return Nothing;
 551 }
 552
 553 /*
 554     Return offset of next pattern in the current file.
 555 */
 556 int
 557 yyoffset ()
 558 {
 559     return ftell(inputFile) - (inPtr - parsePtr); // subtract what is read but not yet parsed
 560 }
 561
 562 void
 563 yynewfile (FILE *f)
 564 {   // prepare parse buffer for reading file
 565     inputFile = f;
 566     inPtr = parsePtr = inputBuf;
 567     fromString = 0;
 568     lastChar = '\n';
 569     *inPtr = NULLCHAR; // make sure we will start by reading a line
 570 }
 571
 572 void
 573 yynewstr P((char *s))
 574 {
 575     parsePtr = s;
 576     inputFile = NULL;
 577     fromString = 1;
 578 }
 579
 580 int
 581 yylex ()
 582 {   // this replaces the flex-generated parser
 583     int result = NextUnit(&parsePtr);
 584     char *p = parseStart, *q = yytext;
 585     while(p < parsePtr) *q++ = *p++; // copy the matched text to yytext[]
 586     *q = NULLCHAR;
 587     lastChar = q[-1];
 588     return result;
 589 }
 590
 591 int
 592 Myylex ()
 593 {   // [HGM] wrapper for yylex, which treats nesting of parentheses
 594     int symbol, nestingLevel = 0, i=0;
 595     char *p;
 596     static char buf[256*MSG_SIZ];
 597     buf[0] = NULLCHAR;
 598     do { // eat away anything not at level 0
 599         symbol = yylex();
 600         if(symbol == Open) nestingLevel++;
 601         if(nestingLevel) { // save all parsed text between (and including) the ()
 602             for(p=yytext; *p && i<256*MSG_SIZ-2;) buf[i++] = *p++;
 603             buf[i] = NULLCHAR;
 604         }
 605         if(symbol == 0) break; // ran into EOF
 606         if(symbol == Close) symbol = Comment, nestingLevel--;
 607     } while(nestingLevel || symbol == Nothing);
 608     yy_text = buf[0] ? buf : (char*)yytext;
 609     return symbol;
 610 }
 611
 612 ChessMove
 613 yylexstr (int boardIndex, char *s, char *buf, int buflen)
 614 {
 615     ChessMove ret;
 616     char *savPP = parsePtr;
 617     fromString = 1;
 618     yyboardindex = boardIndex;
 619     parsePtr = s;
 620     ret = (ChessMove) Myylex();
 621     strncpy(buf, yy_text, buflen-1);
 622     buf[buflen-1] = NULLCHAR;
 623     parsePtr = savPP;
 624     fromString = 0;
 625     return ret;
 626 }