Don't switch to engine-defined variant on game loading
[xboard.git] / gamelist.c
1 /*
2  * gamelist.c -- Functions to manage a gamelist
3  *
4  * Copyright 1995, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
5  *
6  * Enhancements Copyright 2005 Alessandro Scotti
7  *
8  * ------------------------------------------------------------------------
9  *
10  * GNU XBoard is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or (at
13  * your option) any later version.
14  *
15  * GNU XBoard is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see http://www.gnu.org/licenses/.
22  *
23  *------------------------------------------------------------------------
24  ** See the file ChangeLog for a revision history.  */
25
26 #include "config.h"
27
28 #include <stdio.h>
29 #include <errno.h>
30 #if STDC_HEADERS
31 # include <stdlib.h>
32 # include <string.h>
33 #else /* not STDC_HEADERS */
34 # if HAVE_STRING_H
35 #  include <string.h>
36 # else /* not HAVE_STRING_H */
37 #  include <strings.h>
38 # endif /* not HAVE_STRING_H */
39 #endif /* not STDC_HEADERS */
40
41 #include "common.h"
42 #include "frontend.h"
43 #include "backend.h"
44 #include "parser.h"
45 #include "moves.h"
46 #include "gettext.h"
47
48 #ifdef ENABLE_NLS
49 # define  _(s) gettext (s)
50 # define N_(s) gettext_noop (s)
51 #else
52 # define  _(s) (s)
53 # define N_(s)  s
54 #endif
55
56
57 /* Variables
58  */
59 List gameList;
60 extern Board initialPosition;
61 extern int quickFlag;
62 extern int movePtr;
63
64 /* Local function prototypes
65  */
66 static void GameListDeleteGame P((ListGame *));
67 static ListGame *GameListCreate P((void));
68 static void GameListFree P((List *));
69 static int GameListNewGame P((ListGame **));
70
71 /* [AS] Wildcard pattern matching */
72 Boolean
73 HasPattern (const char * text, const char * pattern)
74 {
75     while( *pattern != '\0' ) {
76         if( *pattern == '*' ) {
77             while( *pattern == '*' ) {
78                 pattern++;
79             }
80
81             if( *pattern == '\0' ) {
82                 return TRUE;
83             }
84
85             while( *text != '\0' ) {
86                 if( HasPattern( text, pattern ) ) {
87                     return TRUE;
88                 }
89                 text++;
90             }
91         }
92         else if( (*pattern == *text) || ((*pattern == '?') && (*text != '\0')) ) {
93             pattern++;
94             text++;
95             continue;
96         }
97
98         return FALSE;
99     }
100
101     return TRUE;
102 }
103
104 Boolean
105 SearchPattern (const char * text, const char * pattern)
106 {
107     Boolean result = TRUE;
108
109     if( pattern != NULL && *pattern != '\0' ) {
110         if( *pattern == '*' ) {
111             result = HasPattern( text, pattern );
112         }
113         else {
114             result = FALSE;
115
116             while( *text != '\0' ) {
117                 if( HasPattern( text, pattern ) ) {
118                     result = TRUE;
119                     break;
120                 }
121                 text++;
122             }
123         }
124     }
125
126     return result;
127 }
128
129 /* Delete a ListGame; implies removint it from a list.
130  */
131 static void
132 GameListDeleteGame (ListGame *listGame)
133 {
134     if (listGame) {
135         if (listGame->gameInfo.event) free(listGame->gameInfo.event);
136         if (listGame->gameInfo.site) free(listGame->gameInfo.site);
137         if (listGame->gameInfo.date) free(listGame->gameInfo.date);
138         if (listGame->gameInfo.round) free(listGame->gameInfo.round);
139         if (listGame->gameInfo.white) free(listGame->gameInfo.white);
140         if (listGame->gameInfo.black) free(listGame->gameInfo.black);
141         if (listGame->gameInfo.fen) free(listGame->gameInfo.fen);
142         if (listGame->gameInfo.resultDetails) free(listGame->gameInfo.resultDetails);
143         if (listGame->gameInfo.timeControl) free(listGame->gameInfo.timeControl);
144         if (listGame->gameInfo.extraTags) free(listGame->gameInfo.extraTags);
145         if (listGame->gameInfo.outOfBook) free(listGame->gameInfo.outOfBook);
146         ListNodeFree((ListNode *) listGame);
147     }
148 }
149
150
151 /* Free the previous list of games.
152  */
153 static void
154 GameListFree (List *gameList)
155 {
156   while (!ListEmpty(gameList))
157     {
158         GameListDeleteGame((ListGame *) gameList->head);
159     }
160 }
161
162
163
164 /* Initialize a new GameInfo structure.
165  */
166 void
167 GameListInitGameInfo (GameInfo *gameInfo)
168 {
169     gameInfo->event = NULL;
170     gameInfo->site = NULL;
171     gameInfo->date = NULL;
172     gameInfo->round = NULL;
173     gameInfo->white = NULL;
174     gameInfo->black = NULL;
175     gameInfo->result = GameUnfinished;
176     gameInfo->fen = NULL;
177     gameInfo->resultDetails = NULL;
178     gameInfo->timeControl = NULL;
179     gameInfo->extraTags = NULL;
180     gameInfo->whiteRating = -1; /* unknown */
181     gameInfo->blackRating = -1; /* unknown */
182     gameInfo->variant = VariantNormal;
183     gameInfo->variantName = NULL;
184     gameInfo->outOfBook = NULL;
185     gameInfo->resultDetails = NULL;
186 }
187
188
189 /* Create empty ListGame; returns ListGame or NULL, if out of memory.
190  *
191  * Note, that the ListGame is *not* added to any list
192  */
193 static ListGame *
194 GameListCreate ()
195 {
196     ListGame *listGame;
197
198     if ((listGame = (ListGame *) ListNodeCreate(sizeof(*listGame)))) {
199         GameListInitGameInfo(&listGame->gameInfo);
200     }
201     return(listGame);
202 }
203
204
205 /* Creates a new game for the gamelist.
206  */
207 static int
208 GameListNewGame (ListGame **listGamePtr)
209 {
210     if (!(*listGamePtr = (ListGame *) GameListCreate())) {
211         GameListFree(&gameList);
212         return(ENOMEM);
213     }
214     ListAddTail(&gameList, (ListNode *) *listGamePtr);
215     return(0);
216 }
217
218
219 /* Build the list of games in the open file f.
220  * Returns 0 for success or error number.
221  */
222 int
223 GameListBuild (FILE *f)
224 {
225     ChessMove cm, lastStart;
226     int gameNumber;
227     ListGame *currentListGame = NULL;
228     int error, scratch=100, plyNr=0, fromX, fromY, toX, toY;
229     int offset;
230     char lastComment[MSG_SIZ], buf[MSG_SIZ];
231     TimeMark t, t2;
232
233     GetTimeMark(&t);
234     GameListFree(&gameList);
235     yynewfile(f);
236     gameNumber = 0;
237     movePtr = 0;
238
239     lastStart = (ChessMove) 0;
240     yyskipmoves = FALSE;
241     do {
242         yyboardindex = scratch;
243         offset = yyoffset();
244         quickFlag = plyNr + 1;
245         cm = (ChessMove) Myylex();
246         switch (cm) {
247           case GNUChessGame:
248             if ((error = GameListNewGame(&currentListGame))) {
249                 rewind(f);
250                 yyskipmoves = FALSE;
251                 return(error);
252             }
253             currentListGame->number = ++gameNumber;
254             currentListGame->offset = offset;
255             if(1) { CopyBoard(boards[scratch], initialPosition); plyNr = 0; currentListGame->moves = PackGame(boards[scratch]); }
256             if (currentListGame->gameInfo.event != NULL) {
257                 free(currentListGame->gameInfo.event);
258             }
259             currentListGame->gameInfo.event = StrSave(yy_text);
260             lastStart = cm;
261             break;
262           case XBoardGame:
263             lastStart = cm;
264             break;
265           case MoveNumberOne:
266             switch (lastStart) {
267               case GNUChessGame:
268                 break;          /*  ignore  */
269               case PGNTag:
270                 lastStart = cm;
271                 break;          /*  Already started */
272               case (ChessMove) 0:
273               case MoveNumberOne:
274               case XBoardGame:
275                 if ((error = GameListNewGame(&currentListGame))) {
276                     rewind(f);
277                     yyskipmoves = FALSE;
278                     return(error);
279                 }
280                 currentListGame->number = ++gameNumber;
281                 currentListGame->offset = offset;
282                 if(1) { CopyBoard(boards[scratch], initialPosition); plyNr = 0; currentListGame->moves = PackGame(boards[scratch]); }
283                 lastStart = cm;
284                 break;
285               default:
286                 break;          /*  impossible  */
287             }
288             break;
289           case PGNTag:
290             lastStart = cm;
291             if ((error = GameListNewGame(&currentListGame))) {
292                 rewind(f);
293                 yyskipmoves = FALSE;
294                 return(error);
295             }
296             currentListGame->number = ++gameNumber;
297             currentListGame->offset = offset;
298             ParsePGNTag(yy_text, &currentListGame->gameInfo);
299             do {
300                 yyboardindex = 1;
301                 offset = yyoffset();
302                 cm = (ChessMove) Myylex();
303                 if (cm == PGNTag) {
304                     ParsePGNTag(yy_text, &currentListGame->gameInfo);
305                 }
306             } while (cm == PGNTag || cm == Comment);
307             if(1) {
308                 int btm=0;
309                 if(currentListGame->gameInfo.fen) ParseFEN(boards[scratch], &btm, currentListGame->gameInfo.fen, FALSE);
310                 else CopyBoard(boards[scratch], initialPosition);
311                 plyNr = (btm != 0);
312                 currentListGame->moves = PackGame(boards[scratch]);
313             }
314             if(cm != NormalMove) break;
315           case IllegalMove:
316                 if(appData.testLegality) break;
317           case NormalMove:
318             /* Allow the first game to start with an unnumbered move */
319             yyskipmoves = FALSE;
320             if (lastStart == (ChessMove) 0) {
321               if ((error = GameListNewGame(&currentListGame))) {
322                 rewind(f);
323                 yyskipmoves = FALSE;
324                 return(error);
325               }
326               currentListGame->number = ++gameNumber;
327               currentListGame->offset = offset;
328               if(1) { CopyBoard(boards[scratch], initialPosition); plyNr = 0; currentListGame->moves = PackGame(boards[scratch]); }
329               lastStart = MoveNumberOne;
330             }
331           case WhiteCapturesEnPassant:
332           case BlackCapturesEnPassant:
333           case WhitePromotion:
334           case BlackPromotion:
335           case WhiteNonPromotion:
336           case BlackNonPromotion:
337           case WhiteKingSideCastle:
338           case WhiteQueenSideCastle:
339           case BlackKingSideCastle:
340           case BlackQueenSideCastle:
341           case WhiteKingSideCastleWild:
342           case WhiteQueenSideCastleWild:
343           case BlackKingSideCastleWild:
344           case BlackQueenSideCastleWild:
345           case WhiteHSideCastleFR:
346           case WhiteASideCastleFR:
347           case BlackHSideCastleFR:
348           case BlackASideCastleFR:
349                 fromX = currentMoveString[0] - AAA;
350                 fromY = currentMoveString[1] - ONE;
351                 toX = currentMoveString[2] - AAA;
352                 toY = currentMoveString[3] - ONE;
353                 plyNr++;
354                 ApplyMove(fromX, fromY, toX, toY, currentMoveString[4], boards[scratch]);
355                 if(currentListGame && currentListGame->moves) PackMove(fromX, fromY, toX, toY, boards[scratch][toY][toX]);
356             break;
357         case WhiteWins: // [HGM] rescom: save last comment as result details
358         case BlackWins:
359         case GameIsDrawn:
360         case GameUnfinished:
361             if(!currentListGame) break;
362             if (currentListGame->gameInfo.resultDetails != NULL) {
363                 free(currentListGame->gameInfo.resultDetails);
364             }
365             if(yy_text[0] == '{') {
366                 char *p;
367                 safeStrCpy(lastComment, yy_text+1, sizeof(lastComment)/sizeof(lastComment[0]));
368                 if((p = strchr(lastComment, '}'))) *p = 0;
369                 currentListGame->gameInfo.resultDetails = StrSave(lastComment);
370             }
371             break;
372           default:
373             break;
374         }
375         if(gameNumber % 1000 == 0) {
376             snprintf(buf, MSG_SIZ, _("Reading game file (%d)"), gameNumber);
377             DisplayTitle(buf); DoEvents();
378         }
379     }
380     while (cm != (ChessMove) 0);
381
382  if(currentListGame) {
383     if(!currentListGame->moves) DisplayError("Game cache overflowed\nPosition-searching might not work properly", 0);
384
385     if (appData.debugMode) {
386         for (currentListGame = (ListGame *) gameList.head;
387              currentListGame->node.succ;
388              currentListGame = (ListGame *) currentListGame->node.succ) {
389
390             fprintf(debugFP, "Parsed game number %d, offset %ld:\n",
391                     currentListGame->number, currentListGame->offset);
392             PrintPGNTags(debugFP, &currentListGame->gameInfo);
393         }
394     }
395   }
396     if(appData.debugMode) { GetTimeMark(&t2);printf("GameListBuild %ld msec\n", SubtractTimeMarks(&t2,&t)); }
397     quickFlag = 0;
398     PackGame(boards[scratch]); // for appending end-of-game marker.
399     DisplayTitle("WinBoard");
400     rewind(f);
401     yyskipmoves = FALSE;
402     return 0;
403 }
404
405
406 /* Clear an existing GameInfo structure.
407  */
408 void
409 ClearGameInfo (GameInfo *gameInfo)
410 {
411     if (gameInfo->event != NULL) {
412         free(gameInfo->event);
413     }
414     if (gameInfo->site != NULL) {
415         free(gameInfo->site);
416     }
417     if (gameInfo->date != NULL) {
418         free(gameInfo->date);
419     }
420     if (gameInfo->round != NULL) {
421         free(gameInfo->round);
422     }
423     if (gameInfo->white != NULL) {
424         free(gameInfo->white);
425     }
426     if (gameInfo->black != NULL) {
427         free(gameInfo->black);
428     }
429     if (gameInfo->resultDetails != NULL) {
430         free(gameInfo->resultDetails);
431     }
432     if (gameInfo->fen != NULL) {
433         free(gameInfo->fen);
434     }
435     if (gameInfo->timeControl != NULL) {
436         free(gameInfo->timeControl);
437     }
438     if (gameInfo->extraTags != NULL) {
439         free(gameInfo->extraTags);
440     }
441     if (gameInfo->variantName != NULL) {
442         free(gameInfo->variantName);
443     }
444     if (gameInfo->outOfBook != NULL) {
445         free(gameInfo->outOfBook);
446     }
447     GameListInitGameInfo(gameInfo);
448 }
449
450 /* [AS] Replaced by "dynamic" tag selection below */
451 char *
452 GameListLineOld (int number, GameInfo *gameInfo)
453 {
454     char *event = (gameInfo->event && strcmp(gameInfo->event, "?") != 0) ?
455                      gameInfo->event : gameInfo->site ? gameInfo->site : "?";
456     char *white = gameInfo->white ? gameInfo->white : "?";
457     char *black = gameInfo->black ? gameInfo->black : "?";
458     char *date = gameInfo->date ? gameInfo->date : "?";
459     int len = 10 + strlen(event) + 2 + strlen(white) + 1 +
460       strlen(black) + 11 + strlen(date) + 1;
461     char *ret = (char *) malloc(len);
462     sprintf(ret, "%d. %s, %s-%s, %s, %s",
463             number, event, white, black, PGNResult(gameInfo->result), date);
464     return ret;
465 }
466
467 #define MAX_FIELD_LEN   80  /* To avoid overflowing the buffer */
468
469 char *
470 GameListLine (int number, GameInfo * gameInfo)
471 {
472     char buffer[2*MSG_SIZ];
473     char * buf = buffer;
474     char * glt = appData.gameListTags;
475
476     buf += sprintf( buffer, "%d.", number );
477
478     while( *glt != '\0' ) {
479         *buf++ = ' ';
480
481         switch( *glt ) {
482         case GLT_EVENT:
483             strncpy( buf, gameInfo->event ? gameInfo->event : "?", MAX_FIELD_LEN );
484             break;
485         case GLT_SITE:
486             strncpy( buf, gameInfo->site ? gameInfo->site : "?", MAX_FIELD_LEN );
487             break;
488         case GLT_DATE:
489             strncpy( buf, gameInfo->date ? gameInfo->date : "?", MAX_FIELD_LEN );
490             break;
491         case GLT_ROUND:
492             strncpy( buf, gameInfo->round ? gameInfo->round : "?", MAX_FIELD_LEN );
493             break;
494         case GLT_PLAYERS:
495             strncpy( buf, gameInfo->white ? gameInfo->white : "?", MAX_FIELD_LEN );
496             buf[ MAX_FIELD_LEN-1 ] = '\0';
497             buf += strlen( buf );
498             *buf++ = '-';
499             strncpy( buf, gameInfo->black ? gameInfo->black : "?", MAX_FIELD_LEN );
500             break;
501         case GLT_RESULT:
502             safeStrCpy( buf, PGNResult(gameInfo->result), 2*MSG_SIZ );
503             break;
504         case GLT_WHITE_ELO:
505             if( gameInfo->whiteRating > 0 )
506               sprintf( buf,  "%d", gameInfo->whiteRating );
507             else
508               safeStrCpy( buf, "?" , 2*MSG_SIZ);
509             break;
510         case GLT_BLACK_ELO:
511             if( gameInfo->blackRating > 0 )
512                 sprintf( buf, "%d", gameInfo->blackRating );
513             else
514               safeStrCpy( buf, "?" , 2*MSG_SIZ);
515             break;
516         case GLT_TIME_CONTROL:
517             strncpy( buf, gameInfo->timeControl ? gameInfo->timeControl : "?", MAX_FIELD_LEN );
518             break;
519         case GLT_VARIANT:
520             strncpy( buf, gameInfo->variantName ? gameInfo->variantName : VariantName(gameInfo->variant), MAX_FIELD_LEN );
521 //            strncpy( buf, VariantName(gameInfo->variant), MAX_FIELD_LEN );
522             break;
523         case GLT_OUT_OF_BOOK:
524             strncpy( buf, gameInfo->outOfBook ? gameInfo->outOfBook : "?", MAX_FIELD_LEN );
525             break;
526         case GLT_RESULT_COMMENT:
527             strncpy( buf, gameInfo->resultDetails ? gameInfo->resultDetails : "res?", MAX_FIELD_LEN );
528             break;
529         default:
530             break;
531         }
532
533         buf[MAX_FIELD_LEN-1] = '\0';
534
535         buf += strlen( buf );
536
537         glt++;
538
539         if( *glt != '\0' ) {
540             *buf++ = ',';
541         }
542     }
543
544     *buf = '\0';
545
546     return strdup( buffer );
547 }
548
549 char *
550 GameListLineFull (int number, GameInfo * gameInfo)
551 {
552     char * event = gameInfo->event ? gameInfo->event : "?";
553     char * site = gameInfo->site ? gameInfo->site : "?";
554     char * white = gameInfo->white ? gameInfo->white : "?";
555     char * black = gameInfo->black ? gameInfo->black : "?";
556     char * round = gameInfo->round ? gameInfo->round : "?";
557     char * date = gameInfo->date ? gameInfo->date : "?";
558     char * oob = gameInfo->outOfBook ? gameInfo->outOfBook : "";
559     char * reason = gameInfo->resultDetails ? gameInfo->resultDetails : "";
560
561     int len = 64 + strlen(event) + strlen(site) + strlen(white) + strlen(black) + strlen(date) + strlen(oob) + strlen(reason);
562
563     char *ret = (char *) malloc(len);
564
565     sprintf(ret, "%d, \"%s\", \"%s\", \"%s\", \"%s\", \"%s\", \"%s\", \"%s\", \"%s\", \"%s\"",
566         number, event, site, round, white, black, PGNResult(gameInfo->result), reason, date, oob );
567
568     return ret;
569 }
570 // --------------------------------------- Game-List options dialog --------------------------------------
571
572 // back-end
573 typedef struct {
574     char id;
575     char * name;
576 } GLT_Item;
577
578 // back-end: translation table tag id-char <-> full tag name
579 static GLT_Item GLT_ItemInfo[] = {
580     { GLT_EVENT,      "Event" },
581     { GLT_SITE,       "Site" },
582     { GLT_DATE,       "Date" },
583     { GLT_ROUND,      "Round" },
584     { GLT_PLAYERS,    "Players" },
585     { GLT_RESULT,     "Result" },
586     { GLT_WHITE_ELO,  "White Rating" },
587     { GLT_BLACK_ELO,  "Black Rating" },
588     { GLT_TIME_CONTROL,"Time Control" },
589     { GLT_VARIANT,    "Variant" },
590     { GLT_OUT_OF_BOOK,PGN_OUT_OF_BOOK },
591     { GLT_RESULT_COMMENT, "Result Comment" }, // [HGM] rescom
592     { 0, 0 }
593 };
594
595 char lpUserGLT[LPUSERGLT_SIZE];
596
597 // back-end: convert the tag id-char to a full tag name
598 char *
599 GLT_FindItem (char id)
600 {
601     char * result = 0;
602
603     GLT_Item * list = GLT_ItemInfo;
604
605     while( list->id != 0 ) {
606         if( list->id == id ) {
607             result = list->name;
608             break;
609         }
610
611         list++;
612     }
613
614     return result;
615 }
616
617 // back-end: build the list of tag names
618 void
619 GLT_TagsToList (char *tags)
620 {
621     char * pc = tags;
622
623     GLT_ClearList();
624
625     while( *pc ) {
626         GLT_AddToList( GLT_FindItem(*pc) );
627         pc++;
628     }
629
630     GLT_AddToList( "     --- Hidden tags ---     " );
631
632     pc = GLT_ALL_TAGS;
633
634     while( *pc ) {
635         if( strchr( tags, *pc ) == 0 ) {
636             GLT_AddToList( GLT_FindItem(*pc) );
637         }
638         pc++;
639     }
640
641     GLT_DeSelectList();
642 }
643
644 // back-end: retrieve item from dialog and translate to id-char
645 char
646 GLT_ListItemToTag (int index)
647 {
648     char result = '\0';
649     char name[MSG_SIZ];
650
651     GLT_Item * list = GLT_ItemInfo;
652
653     if( GLT_GetFromList(index, name) ) {
654         while( list->id != 0 ) {
655             if( strcmp( list->name, name ) == 0 ) {
656                 result = list->id;
657                 break;
658             }
659
660             list++;
661         }
662     }
663
664     return result;
665 }
666
667 // back-end: add items id-chars one-by-one to temp tags string
668 void
669 GLT_ParseList ()
670 {
671     char * pc = lpUserGLT;
672     int idx = 0;
673     char id;
674
675     do {
676         id = GLT_ListItemToTag( idx );
677         *pc++ = id;
678         idx++;
679     } while( id != '\0' );
680 }