Reserve piece command in protocol specs
[xboard.git] / pgntags.c
1 /*
2  * pgntags.c -- Functions to manage PGN tags
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  *
25  * This file could well be a part of backend.c, but I prefer it this
26  * way.
27  */
28
29 #include "config.h"
30
31 #include <stdio.h>
32 #include <errno.h>
33 #include <ctype.h>
34 #if STDC_HEADERS
35 # include <stdlib.h>
36 # include <string.h>
37 #else /* not STDC_HEADERS */
38 # if HAVE_STRING_H
39 #  include <string.h>
40 # else /* not HAVE_STRING_H */
41 #  include <strings.h>
42 # endif /* not HAVE_STRING_H */
43 #endif /* not STDC_HEADERS */
44
45 #include "common.h"
46 #include "frontend.h"
47 #include "backend.h"
48 #include "parser.h"
49
50
51 /* Parse PGN tags; returns 0 for success or error number
52  */
53 int
54 ParsePGNTag (char *tag, GameInfo *gameInfo)
55 {
56     char *name, *value, *p, *oldTags;
57     int len;
58     int success;
59
60     name = tag;
61     while (!isalpha(*name) && !isdigit(*name)) {
62         name++;
63     }
64     p = name;
65     while (*p != ' ' && *p != '\t' && *p != '\n') {
66         p++;
67     }
68     *p = NULLCHAR;
69     value = strchr(p + 1, '"') + 1;
70     p = strrchr(value, '"');
71     *p = NULLCHAR;
72
73     if (StrCaseCmp(name, "Event") == 0) {
74         success = StrSavePtr(value, &gameInfo->event) != NULL;
75     } else if (StrCaseCmp(name, "Site") == 0) {
76         success = StrSavePtr(value, &gameInfo->site) != NULL;
77     } else if (StrCaseCmp(name, "Date") == 0) {
78         success = StrSavePtr(value, &gameInfo->date) != NULL;
79     } else if (StrCaseCmp(name, "Round") == 0) {
80         success = StrSavePtr(value, &gameInfo->round) != NULL;
81     } else if (StrCaseCmp(name, "White") == 0) {
82         success = StrSavePtr(value, &gameInfo->white) != NULL;
83     } else if (StrCaseCmp(name, "Black") == 0) {
84         success = StrSavePtr(value, &gameInfo->black) != NULL;
85     }
86     /* Fold together the various ways of denoting White/Black rating */
87     else if ((StrCaseCmp(name, "WhiteElo")==0) ||
88              (StrCaseCmp(name, "WhiteUSCF")==0) ) {
89       success = TRUE;
90       gameInfo->whiteRating = atoi( value );
91     } else if ((StrCaseCmp(name, "BlackElo")==0) ||
92                (StrCaseCmp(name, "BlackUSCF")==0)) {
93       success = TRUE;
94       gameInfo->blackRating = atoi( value );
95     }
96     else if (StrCaseCmp(name, "Result") == 0) {
97         if (strcmp(value, "1-0") == 0)
98             gameInfo->result = WhiteWins;
99         else if (strcmp(value, "0-1") == 0)
100             gameInfo->result = BlackWins;
101         else if (strcmp(value, "1/2-1/2") == 0)
102             gameInfo->result = GameIsDrawn;
103         else
104             gameInfo->result = GameUnfinished;
105         success = TRUE;
106     } else if (StrCaseCmp(name, "TimeControl") == 0) {
107 //      int tc, mps, inc = -1;
108 //      if(sscanf(value, "%d/%d", &mps, &tc) == 2 || )
109         success = StrSavePtr(value, &gameInfo->timeControl) != NULL;
110     } else if (StrCaseCmp(name, "FEN") == 0) {
111         success = StrSavePtr(value, &gameInfo->fen) != NULL;
112     } else if (StrCaseCmp(name, "SetUp") == 0) {
113         /* ignore on input; presence of FEN governs */
114         success = TRUE;
115     } else if (StrCaseCmp(name, "Variant") == 0) {
116         /* xboard-defined extension */
117         gameInfo->variant = StringToVariant(value);
118         success = TRUE;
119     } else if (StrCaseCmp(name, PGN_OUT_OF_BOOK) == 0) {
120         /* [AS] Out of book annotation */
121         success = StrSavePtr(value, &gameInfo->outOfBook) != NULL;
122     } else {
123         if (gameInfo->extraTags == NULL) {
124             oldTags = "";
125         } else {
126             oldTags = gameInfo->extraTags;
127         }
128         /* Buffer size includes 7 bytes of space for [ ""]\n\0 */
129         len = strlen(oldTags) + strlen(value) + strlen(name) + 7;
130         if ((p = (char *) malloc(len))  !=  NULL) {
131             sprintf(p, "%s[%s \"%s\"]\n", oldTags, name, value);
132             if (gameInfo->extraTags != NULL) free(gameInfo->extraTags);
133             gameInfo->extraTags = p;
134             success = TRUE;
135         } else {
136             success = FALSE;
137         }
138     }
139     return(success ? 0 : ENOMEM);
140 }
141
142
143 /* Print game info */
144 void
145 PrintPGNTags (FILE *fp, GameInfo *gameInfo)
146 {
147     fprintf(fp, "[Event \"%s\"]\n", gameInfo->event ? gameInfo->event : "?");
148     fprintf(fp, "[Site \"%s\"]\n", gameInfo->site ? gameInfo->site : "?");
149     fprintf(fp, "[Date \"%s\"]\n", gameInfo->date ? gameInfo->date : "?");
150     fprintf(fp, "[Round \"%s\"]\n", gameInfo->round ? gameInfo->round : "-");
151     fprintf(fp, "[White \"%s\"]\n", gameInfo->white ? gameInfo->white : "?");
152     fprintf(fp, "[Black \"%s\"]\n", gameInfo->black ? gameInfo->black : "?");
153     fprintf(fp, "[Result \"%s\"]\n", PGNResult(gameInfo->result));
154     if (gameInfo->whiteRating >= 0)
155         fprintf(fp, "[WhiteElo \"%d\"]\n", gameInfo->whiteRating);
156     if (gameInfo->blackRating >= 0)
157         fprintf(fp, "[BlackElo \"%d\"]\n", gameInfo->blackRating);
158     if (gameInfo->timeControl)
159         fprintf(fp, "[TimeControl \"%s\"]\n", gameInfo->timeControl);
160     if (gameInfo->variant != VariantNormal)
161         fprintf(fp, "[Variant \"%s\"]\n", VariantName(gameInfo->variant));
162     if (gameInfo->extraTags)
163         fputs(gameInfo->extraTags, fp);
164 }
165
166
167 /* Return a non-static buffer with a games info.
168  */
169 char *
170 PGNTags (GameInfo *gameInfo)
171 {
172     size_t len;
173     char *buf;
174     char *p;
175
176     // First calculate the needed buffer size.
177     // Then we don't have to check the buffer size later.
178     len = 12 + 11 + 11 + 12 + 12 + 12 + 25 + 1; // The first 7 tags
179     if (gameInfo->event) len += strlen(gameInfo->event);
180     if (gameInfo->site)  len += strlen(gameInfo->site);
181     if (gameInfo->date)  len += strlen(gameInfo->date);
182     if (gameInfo->round) len += strlen(gameInfo->round);
183     if (gameInfo->white) len += strlen(gameInfo->white);
184     if (gameInfo->black) len += strlen(gameInfo->black);
185     if (gameInfo->whiteRating >= 0) len += 40;
186     if (gameInfo->blackRating >= 0) len += 40;
187     if (gameInfo->timeControl) len += strlen(gameInfo->timeControl) + 20;
188     if (gameInfo->variant != VariantNormal) len += 50;
189     if (gameInfo->extraTags) len += strlen(gameInfo->extraTags);
190
191     buf = malloc(len);
192     if (!buf)
193         return 0;
194
195     p = buf;
196     p += sprintf(p, "[Event \"%s\"]\n", gameInfo->event ? gameInfo->event : "?");
197     p += sprintf(p, "[Site \"%s\"]\n", gameInfo->site ? gameInfo->site : "?");
198     p += sprintf(p, "[Date \"%s\"]\n", gameInfo->date ? gameInfo->date : "?");
199     p += sprintf(p, "[Round \"%s\"]\n", gameInfo->round ? gameInfo->round : "-");
200     p += sprintf(p, "[White \"%s\"]\n", gameInfo->white ? gameInfo->white : "?");
201     p += sprintf(p, "[Black \"%s\"]\n", gameInfo->black ? gameInfo->black : "?");
202     p += sprintf(p, "[Result \"%s\"]\n", PGNResult(gameInfo->result));
203     if (gameInfo->whiteRating >= 0)
204         p += sprintf(p, "[WhiteElo \"%d\"]\n", gameInfo->whiteRating);
205     if (gameInfo->blackRating >= 0)
206         p += sprintf(p, "[BlackElo \"%d\"]\n", gameInfo->blackRating);
207     if (gameInfo->timeControl)
208         p += sprintf(p, "[TimeControl \"%s\"]\n", gameInfo->timeControl);
209     if (gameInfo->variant != VariantNormal)
210         p += sprintf(p, "[Variant \"%s\"]\n", VariantName(gameInfo->variant));
211     if (gameInfo->extraTags)
212         strcpy(p, gameInfo->extraTags);
213     return buf;
214 }
215
216
217 /* Returns pointer to a static string with a result.
218  */
219 char *
220 PGNResult (ChessMove result)
221 {
222     switch (result) {
223       case GameUnfinished:
224       default:
225         return "*";
226       case WhiteWins:
227         return "1-0";
228       case BlackWins:
229         return "0-1";
230       case GameIsDrawn:
231         return "1/2-1/2";
232     }
233 }
234
235 /* Returns 0 for success, nonzero for error */
236 int
237 ReplaceTags (char *tags, GameInfo *gameInfo)
238 {
239     ChessMove moveType;
240     int err;
241
242     ClearGameInfo(gameInfo);
243     yynewstr(tags);
244     for (;;) {
245         yyboardindex = 0;
246         moveType = (ChessMove) Myylex();
247         if (moveType == (ChessMove) 0) {
248             break;
249         } else if (moveType == PGNTag) {
250             err = ParsePGNTag(yy_text, gameInfo);
251             if (err != 0) return err;
252         }
253     }
254     /* just one problem...if there is a result in the new tags,
255      * DisplayMove() won't ever show it because ClearGameInfo() set
256      * gameInfo->resultDetails to NULL. So we must plug something in if there
257      * is a result.
258      */
259     if (gameInfo->result != GameUnfinished) {
260       if (gameInfo->resultDetails) free(gameInfo->resultDetails);
261       gameInfo->resultDetails = strdup("");
262     }
263     return 0;
264 }