d202ad6d146643dca063f3bee95e60c81809b9f2
[xboard.git] / ngamelist.c
1 /*
2  * ngamelist.c -- Game list window, Xt-independent front-end code for XBoard
3  *
4  * Copyright 1995, 2009, 2010, 2011, 2012, 2013, 2014 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
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <errno.h>
28 #include <sys/types.h>
29
30 #if STDC_HEADERS
31 # include <stdlib.h>
32 # include <string.h>
33 #else /* not STDC_HEADERS */
34 extern char *getenv();
35 # if HAVE_STRING_H
36 #  include <string.h>
37 # else /* not HAVE_STRING_H */
38 #  include <strings.h>
39 # endif /* not HAVE_STRING_H */
40 #endif /* not STDC_HEADERS */
41
42 #if HAVE_UNISTD_H
43 # include <unistd.h>
44 #endif
45
46 #include "common.h"
47 #include "frontend.h"
48 #include "backend.h"
49 #include "dialogs.h"
50 #include "menus.h"
51 #include "gettext.h"
52
53 #ifdef ENABLE_NLS
54 # define  _(s) gettext (s)
55 # define N_(s) gettext_noop (s)
56 #else
57 # define  _(s) (s)
58 # define N_(s)  s
59 #endif
60
61
62 static char filterString[MSG_SIZ];
63 static int listLength, wins, losses, draws, page;
64 int narrowFlag;
65
66
67 typedef struct {
68     short int x, y;
69     short int w, h;
70     FILE *fp;
71     char *filename;
72     char **strings;
73 } GameListClosure;
74 static GameListClosure *glc = NULL;
75
76 static char *filterPtr;
77 static char *list[1003];
78 static int listEnd;
79
80 static int GameListPrepare P((int byPos, int narrow));
81 static void GameListReplace P((int page));
82 static void GL_Button P((int n));
83
84 static Option gamesOptions[] = {
85 { 200,  LR|TB,     400, NULL, (void*) list,       NULL, NULL, ListBox, "", &appData.gameListFont },
86 {   0,  0,         100, NULL, (void*) &filterPtr, "", NULL, TextBox, "" },
87 {   4,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("find position") },
88 {   2,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("narrow") }, // buttons referred to by ID in value (=first) field!
89 {   3,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("thresholds") },
90 {   9,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("tags") },
91 {   5,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("next") },
92 {   6,  SAME_ROW,    0, NULL, (void*) &GL_Button, NULL, NULL, Button, N_("close") },
93 {   0,  SAME_ROW | NO_OK, 0, NULL, NULL, "", NULL, EndMark , "" }
94 };
95
96 static void
97 GL_Button (int n)
98 {
99     int index;
100     n = gamesOptions[n].value; // use marker in option rather than n itself, for more easy adding/deletng of buttons
101     if (n == 6) { // close
102         PopDown(GameListDlg);
103         return;
104     }
105     if (n == 3) { // thresholds
106         LoadOptionsPopUp(GameListDlg);
107         return;
108     }
109     if (n == 9) { // tags
110         GameListOptionsPopUp(GameListDlg);
111         return;
112     }
113     index = SelectedListBoxItem(&gamesOptions[0]);
114     if (n == 7) { // load
115         if (index < 0) {
116             DisplayError(_("No game selected"), 0);
117             return;
118         }
119     } else if (n == 5) { // next
120         index++;
121         if (index >= listLength || !list[index]) {
122             DisplayError(_("Can't go forward any further"), 0);
123             return;
124         }
125         HighlightWithScroll(&gamesOptions[0], index, listEnd);
126     } else if (n == 8) { // prev
127         index--;
128         if (index < 0) {
129             DisplayError(_("Can't back up any further"), 0);
130             return;
131         }
132         HighlightWithScroll(&gamesOptions[0], index, listEnd);
133     } else if (n == 2 || // narrow
134                n == 4) { // find position
135         char *text;
136         GetWidgetText(&gamesOptions[1], &text);
137         safeStrCpy(filterString, text, sizeof(filterString)/sizeof(filterString[0]));
138         GameListPrepare(True, n == 2); GameListReplace(0);
139         return;
140     }
141
142     index = atoi(list[index])-1; // [HGM] filter: read true index from sequence nr of line
143     if (cmailMsgLoaded) {
144         CmailLoadGame(glc->fp, index + 1, glc->filename, True);
145     } else {
146         LoadGame(glc->fp, index + 1, glc->filename, True);
147     }
148 }
149
150 static int
151 GameListCreate (char *name)
152 {
153     int new;
154     if(new = GenericPopUp(gamesOptions, name, GameListDlg, BoardWindow, NONMODAL, appData.topLevel))
155         AddHandler(&gamesOptions[1], GameListDlg, 4),
156         AddHandler(&gamesOptions[0], GameListDlg, 5);
157     FocusOnWidget(&gamesOptions[0], GameListDlg);
158     return new;
159 }
160
161 static int
162 GameListPrepare (int byPos, int narrow)
163 {   // [HGM] filter: put in separate routine, to make callable from call-back
164     int nstrings;
165     ListGame *lg;
166     char **st, *line;
167     TimeMark t, t2;
168
169     GetTimeMark(&t);
170     if(st = glc->strings) while(*st) free(*st++);
171     nstrings = ((ListGame *) gameList.tailPred)->number;
172     glc->strings = (char **) malloc((nstrings + 1) * sizeof(char *));
173     st = glc->strings;
174     lg = (ListGame *) gameList.head;
175     listLength = wins = losses = draws = 0;
176     if(byPos) InitSearch();
177     while (nstrings--) {
178         int pos = -1;
179         if(!narrow || lg->position >= 0) { // only consider already selected positions when narrowing
180           line = GameListLine(lg->number, &lg->gameInfo);
181           if((filterString[0] == NULLCHAR || SearchPattern( line, filterString )) && (!byPos || (pos=GameContainsPosition(glc->fp, lg)) >= 0) ) {
182             *st++ = line; // [HGM] filter: make adding line conditional.
183             listLength++;
184             if( lg->gameInfo.result == WhiteWins ) wins++; else
185             if( lg->gameInfo.result == BlackWins ) losses++; else
186             if( lg->gameInfo.result == GameIsDrawn ) draws++;
187             if(!byPos) pos = 0; // indicate selected
188           }
189         }
190         if(lg->number % 2000 == 0) {
191             char buf[MSG_SIZ];
192             snprintf(buf, MSG_SIZ, _("Scanning through games (%d)"), lg->number);
193             DisplayTitle(buf); DoEvents();
194         }
195         lg->position = pos;
196         lg = (ListGame *) lg->node.succ;
197     }
198     if(appData.debugMode) { GetTimeMark(&t2);printf("GameListPrepare %ld msec\n", SubtractTimeMarks(&t2,&t)); }
199     DisplayTitle("XBoard");
200     *st = NULL;
201     return listLength;
202 }
203
204 static void
205 GameListReplace (int page)
206 {
207   // filter: put in separate routine, to make callable from call-back
208   char buf[MSG_SIZ], **st=list;
209   int i;
210
211   if(page) *st++ = _("previous page"); else if(listLength > 1000) *st++ = "";
212   for(i=0; i<1000; i++) if( !(*st++ = glc->strings[page+i]) ) { st--; break; }
213   listEnd = st - list;
214   if(page + 1000 <= listLength) *st++ = _("next page");
215   *st = NULL;
216
217   LoadListBox(&gamesOptions[0], _("no games matched your request"), -1, -1);
218   HighlightWithScroll(&gamesOptions[0], listEnd > 1000, listEnd);
219   snprintf(buf, MSG_SIZ, _("%s - %d/%d games (%d-%d-%d)"), glc->filename, listLength, ((ListGame *) gameList.tailPred)->number, wins, losses, draws);
220   SetDialogTitle(GameListDlg, buf);
221 }
222
223 void
224 GameListUpdate ()
225 {
226     GameListPrepare(False, False);
227     GameListReplace(0);
228 }
229
230 void
231 GameListPopUp (FILE *fp, char *filename)
232 {
233     if (glc == NULL) {
234         glc = (GameListClosure *) calloc(1, sizeof(GameListClosure));
235         glc->x = glc->y = -1;
236         glc->filename = NULL;
237     }
238
239     GameListPrepare(False, False); // [HGM] filter: code put in separate routine
240
241     glc->fp = fp;
242
243     if (glc->filename != NULL) free(glc->filename);
244     glc->filename = StrSave(filename);
245
246     if (!GameListCreate(filename))
247         SetIconName(GameListDlg, filename);
248
249     page = 0;
250     GameListReplace(0); // [HGM] filter: code put in separate routine, and also called to set title
251     MarkMenu("View.GameList", GameListDlg);
252     EnableNamedMenuItem("File.SaveSelected", TRUE);
253 }
254
255 FILE *
256 GameFile ()
257 {
258   return glc ? glc->fp : NULL;
259 }
260
261 void
262 GameListDestroy ()
263 {
264     if (glc == NULL) return;
265     EnableNamedMenuItem("File.SaveSelected", FALSE);
266     PopDown(GameListDlg);
267     if (glc->strings != NULL) {
268         char **st;
269         st = glc->strings;
270         while (*st) {
271             free(*st++);
272         }
273         free(glc->strings);
274     }
275     free(glc);
276     glc = NULL;
277 }
278
279 void
280 ShowGameListProc ()
281 {
282     if (glc == NULL) {
283         DisplayError(_("There is no game list"), 0);
284         return;
285     }
286     if (shellUp[GameListDlg]) {
287         PopDown(GameListDlg);
288         return;
289     }
290     GenericPopUp(NULL, NULL, GameListDlg, BoardWindow, NONMODAL, appData.topLevel); // first two args ignored when shell exists!
291     MarkMenu("View.GameList", GameListDlg);
292     GameListHighlight(lastLoadGameNumber);
293 }
294
295 int
296 GameListClicks (int direction)
297 {
298     int index;
299
300     if (glc == NULL || listLength == 0) return 1;
301     if(direction == 100) { FocusOnWidget(&gamesOptions[0], GameListDlg); return 1; }
302     index = SelectedListBoxItem(&gamesOptions[0]);
303
304     if (index < 0) return 1;
305     if(page && (index == 0 && direction < 1 || direction == -4)) {
306         page -= 1000;
307         if(page < 0) page = 0; // safety
308         GameListReplace(page);
309         return 1;
310     }
311     if(index == 1001 && direction >= 0 || listEnd == 1001 && direction == 4) {
312         page += 1000;
313         GameListReplace(page);
314         return 1;
315     }
316
317     if(direction != 0) {
318         int doLoad = abs(direction) == 3;
319         if(doLoad) direction /= 3;
320         index += direction;
321         if(direction < -1) index = 0;
322         if(direction >  1) index = listEnd-1;
323         if(index < 0 || index >= listEnd) return 1;
324         HighlightWithScroll(&gamesOptions[0], index, listEnd);
325         if(!doLoad) return 1;
326     }
327     index = atoi(list[index])-1; // [HGM] filter: read true index from sequence nr of line
328     if (cmailMsgLoaded) {
329         CmailLoadGame(glc->fp, index + 1, glc->filename, True);
330     } else {
331         LoadGame(glc->fp, index + 1, glc->filename, True);
332     }
333     return 0;
334 }
335
336 void
337 SetFilter ()
338 {
339         char *name;
340         GetWidgetText(&gamesOptions[1], &name);
341         safeStrCpy(filterString, name, sizeof(filterString)/sizeof(filterString[0]));
342         GameListPrepare(False, False); GameListReplace(0);
343         UnCaret(); // filter text-edit
344         FocusOnWidget(&gamesOptions[0], GameListDlg); // listbox
345 }
346
347 void
348 GameListHighlight (int index)
349 {
350     int i=0; char **st;
351     if (!shellUp[GameListDlg]) return;
352     st = list;
353     while(*st && atoi(*st)<index) st++,i++;
354     HighlightWithScroll(&gamesOptions[0], i, listEnd);
355 }
356
357 int
358 SaveGameListAsText (FILE *f)
359 {
360     ListGame * lg = (ListGame *) gameList.head;
361     int nItem;
362
363     if( !glc || ((ListGame *) gameList.tailPred)->number <= 0 ) {
364       DisplayError(_("Game list not loaded or empty"), 0);
365         return False;
366     }
367
368     /* Copy the list into the global memory block */
369     if( f != NULL ) {
370
371         lg = (ListGame *) gameList.head;
372
373         for (nItem = 0; nItem < ((ListGame *) gameList.tailPred)->number; nItem++){
374             char * st = GameListLineFull(lg->number, &lg->gameInfo);
375             char *line = GameListLine(lg->number, &lg->gameInfo);
376             if(filterString[0] == NULLCHAR || SearchPattern( line, filterString ) )
377                     fprintf( f, "%s\n", st );
378             free(st); free(line);
379             lg = (ListGame *) lg->node.succ;
380         }
381
382         fclose(f);
383         return True;
384     }
385     return False;
386 }