winboard/wgamelist.c

   1 /*\r
   2  * wgamelist.c -- Game list window for WinBoard\r
   3  *\r
   4  * Copyright 1995, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.\r
   5  *\r
   6  * Enhancements Copyright 2005 Alessandro Scotti\r
   7  *\r
   8  * ------------------------------------------------------------------------\r
   9  *\r
  10  * GNU XBoard is free software: you can redistribute it and/or modify\r
  11  * it under the terms of the GNU General Public License as published by\r
  12  * the Free Software Foundation, either version 3 of the License, or (at\r
  13  * your option) any later version.\r
  14  *\r
  15  * GNU XBoard is distributed in the hope that it will be useful, but\r
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of\r
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
  18  * General Public License for more details.\r
  19  *\r
  20  * You should have received a copy of the GNU General Public License\r
  21  * along with this program. If not, see http://www.gnu.org/licenses/.  *\r
  22  *\r
  23  *------------------------------------------------------------------------\r
  24  ** See the file ChangeLog for a revision history.  */\r
  25 \r
  26 #include "config.h"\r
  27 \r
  28 #include <windows.h> /* required for all Windows applications */\r
  29 #include <stdio.h>\r
  30 #include <stdlib.h>\r
  31 #include <malloc.h>\r
  32 #include <fcntl.h>\r
  33 #include <math.h>\r
  34 #include <commdlg.h>\r
  35 #include <dlgs.h>\r
  36 \r
  37 #include "common.h"\r
  38 #include "frontend.h"\r
  39 #include "backend.h"\r
  40 #include "winboard.h"\r
  41 \r
  42 #include "wsnap.h"\r
  43 \r
  44 #define _(s) T_(s)\r
  45 \r
  46 /* Module globals */\r
  47 static BOOLEAN gameListUp = FALSE;\r
  48 static FILE* gameFile;\r
  49 static char* gameFileName = NULL;\r
  50 \r
  51 /* [AS] Setup the game list according to the specified filter */\r
  52 int GameListToListBox( HWND hDlg, BOOL boReset, char * pszFilter, struct GameListStats * stats, BOOL byPos, BOOL narrow )\r
  53 {\r
  54     ListGame * lg = (ListGame *) gameList.head;\r
  55     int nItem;\r
  56     char buf[MSG_SIZ];\r
  57     BOOL hasFilter = FALSE;\r
  58     int count = 0;\r
  59     struct GameListStats dummy;\r
  60 \r
  61     if(!hDlg) hDlg = gameListDialog; // [HGM] to allow calling from Game List Options dialog\r
  62     if(!hDlg) return 0;\r
  63 \r
  64     /* Initialize stats (use a dummy variable if caller not interested in them) */\r
  65     if( stats == NULL ) {\r
  66         stats = &dummy;\r
  67     }\r
  68 \r
  69     stats->white_wins = 0;\r
  70     stats->black_wins = 0;\r
  71     stats->drawn = 0;\r
  72     stats->unfinished = 0;\r
  73 \r
  74     if( boReset ) {\r
  75         SendDlgItemMessage(hDlg, OPT_GameListText, LB_RESETCONTENT, 0, 0);\r
  76     }\r
  77 \r
  78     if( pszFilter != NULL ) {\r
  79         if( strlen( pszFilter ) > 0 ) {\r
  80             hasFilter = TRUE;\r
  81         }\r
  82     }\r
  83 \r
  84     if(byPos) InitSearch();\r
  85 \r
  86     for (nItem = 0; nItem < ((ListGame *) gameList.tailPred)->number; nItem++){\r
  87         char * st = NULL;\r
  88         BOOL skip = FALSE;\r
  89         int pos = -1;\r
  90 \r
  91         if(nItem % 2000 == 0) {\r
  92           snprintf(buf, MSG_SIZ, _("Scanning through games (%d)"), nItem);\r
  93           SetWindowText(hwndMain, buf); DoEvents();\r
  94         }\r
  95 \r
  96       if(!narrow || lg->position >= 0) {\r
  97         if( hasFilter ) {\r
  98             st = GameListLine(lg->number, &lg->gameInfo);\r
  99             if( !SearchPattern( st, pszFilter) ) skip = TRUE;\r
 100         }\r
 101 \r
 102         if( !skip && byPos) {\r
 103             if( (pos = GameContainsPosition(gameFile, lg)) < 0) skip = TRUE;\r
 104         }\r
 105 \r
 106         if( ! skip ) {\r
 107             if(!st) st = GameListLine(lg->number, &lg->gameInfo);\r
 108             SendDlgItemMessage(hDlg, OPT_GameListText, LB_ADDSTRING, 0, (LPARAM) st);\r
 109             count++;\r
 110 \r
 111             /* Update stats */\r
 112             if( lg->gameInfo.result == WhiteWins )\r
 113                 stats->white_wins++;\r
 114             else if( lg->gameInfo.result == BlackWins )\r
 115                 stats->black_wins++;\r
 116             else if( lg->gameInfo.result == GameIsDrawn )\r
 117                 stats->drawn++;\r
 118             else\r
 119                 stats->unfinished++;\r
 120             if(!byPos) pos = 0;\r
 121         }\r
 122       }\r
 123 \r
 124         lg->position = pos;\r
 125 \r
 126         if(st) free(st);\r
 127         lg = (ListGame *) lg->node.succ;\r
 128     }\r
 129 \r
 130     SendDlgItemMessage(hDlg, OPT_GameListText, LB_SETCURSEL, 0, 0);\r
 131     SetWindowText(hwndMain, "WinBoard");\r
 132 \r
 133     return count;\r
 134 }\r
 135 \r
 136 /* [AS] Show number of visible (filtered) games and total on window caption */\r
 137 static int GameListUpdateTitle( HWND hDlg, char * pszTitle, int item_count, int item_total, struct GameListStats * stats )\r
 138 {\r
 139     char buf[256];\r
 140 \r
 141     snprintf( buf, sizeof(buf)/sizeof(buf[0]),_("%s - %d/%d games"), pszTitle, item_count, item_total );\r
 142 \r
 143     if( stats != 0 ) {\r
 144         sprintf( buf+strlen(buf), " (%d-%d-%d)", stats->white_wins, stats->black_wins, stats->drawn );\r
 145     }\r
 146 \r
 147     SetWindowText( hDlg, buf );\r
 148 \r
 149     return 0;\r
 150 }\r
 151 \r
 152 #define MAX_FILTER_LENGTH   128\r
 153 \r
 154 LRESULT CALLBACK\r
 155 GameListDialog(HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)\r
 156 {\r
 157   static char szDlgTitle[64];\r
 158   static HANDLE hwndText;\r
 159   int nItem;\r
 160   RECT rect;\r
 161   static int sizeX, sizeY;\r
 162   int newSizeX, newSizeY;\r
 163   MINMAXINFO *mmi;\r
 164   static BOOL filterHasFocus = FALSE;\r
 165   int count;\r
 166   struct GameListStats stats;\r
 167   static SnapData sd;\r
 168 \r
 169   switch (message) {\r
 170   case WM_INITDIALOG:\r
 171     Translate(hDlg, DLG_GameList);\r
 172     GetWindowText( hDlg, szDlgTitle, sizeof(szDlgTitle) );\r
 173     szDlgTitle[ sizeof(szDlgTitle)-1 ] = '\0';\r
 174 \r
 175     if (gameListDialog) {\r
 176       SendDlgItemMessage(hDlg, OPT_GameListText, LB_RESETCONTENT, 0, 0);\r
 177     }\r
 178 \r
 179     /* Initialize the dialog items */\r
 180     hwndText = GetDlgItem(hDlg, OPT_TagsText);\r
 181 \r
 182     /* Set font */\r
 183     SendDlgItemMessage( hDlg, OPT_GameListText, WM_SETFONT, (WPARAM)font[boardSize][GAMELIST_FONT]->hf, MAKELPARAM(TRUE, 0 ));\r
 184 \r
 185     count = GameListToListBox( hDlg, gameListDialog ? TRUE : FALSE, NULL, &stats, FALSE, FALSE );\r
 186 \r
 187     SendDlgItemMessage( hDlg, IDC_GameListFilter, WM_SETTEXT, 0, (LPARAM) "" );\r
 188     SendDlgItemMessage( hDlg, IDC_GameListFilter, EM_SETLIMITTEXT, MAX_FILTER_LENGTH, 0 );\r
 189 \r
 190     filterHasFocus = FALSE;\r
 191 \r
 192     /* Size and position the dialog */\r
 193     if (!gameListDialog) {\r
 194       gameListDialog = hDlg;\r
 195       GetClientRect(hDlg, &rect);\r
 196       sizeX = rect.right;\r
 197       sizeY = rect.bottom;\r
 198       if (wpGameList.x != CW_USEDEFAULT && wpGameList.y != CW_USEDEFAULT &&\r
 199           wpGameList.width != CW_USEDEFAULT && wpGameList.height != CW_USEDEFAULT) {\r
 200         WINDOWPLACEMENT wp;\r
 201         EnsureOnScreen(&wpGameList.x, &wpGameList.y, 0, 0);\r
 202         wp.length = sizeof(WINDOWPLACEMENT);\r
 203         wp.flags = 0;\r
 204         wp.showCmd = SW_SHOW;\r
 205         wp.ptMaxPosition.x = wp.ptMaxPosition.y = 0;\r
 206         wp.rcNormalPosition.left = wpGameList.x;\r
 207         wp.rcNormalPosition.right = wpGameList.x + wpGameList.width;\r
 208         wp.rcNormalPosition.top = wpGameList.y;\r
 209         wp.rcNormalPosition.bottom = wpGameList.y + wpGameList.height;\r
 210         SetWindowPlacement(hDlg, &wp);\r
 211 \r
 212         GetClientRect(hDlg, &rect);\r
 213         newSizeX = rect.right;\r
 214         newSizeY = rect.bottom;\r
 215         ResizeEditPlusButtons(hDlg, hwndText, sizeX, sizeY,\r
 216                               newSizeX, newSizeY);\r
 217         sizeX = newSizeX;\r
 218         sizeY = newSizeY;\r
 219       } else\r
 220         GetActualPlacement( gameListDialog, &wpGameList );\r
 221 \r
 222     }\r
 223       GameListUpdateTitle( hDlg, _("Game List"), count, ((ListGame *) gameList.tailPred)->number, &stats ); // [HGM] always update title\r
 224     GameListHighlight(lastLoadGameNumber);\r
 225     return FALSE;\r
 226 \r
 227   case WM_SIZE:\r
 228     newSizeX = LOWORD(lParam);\r
 229     newSizeY = HIWORD(lParam);\r
 230     ResizeEditPlusButtons(hDlg, GetDlgItem(hDlg, OPT_GameListText),\r
 231       sizeX, sizeY, newSizeX, newSizeY);\r
 232     sizeX = newSizeX;\r
 233     sizeY = newSizeY;\r
 234     break;\r
 235 \r
 236   case WM_ENTERSIZEMOVE:\r
 237     return OnEnterSizeMove( &sd, hDlg, wParam, lParam );\r
 238 \r
 239   case WM_SIZING:\r
 240     return OnSizing( &sd, hDlg, wParam, lParam );\r
 241 \r
 242   case WM_MOVING:\r
 243     return OnMoving( &sd, hDlg, wParam, lParam );\r
 244 \r
 245   case WM_EXITSIZEMOVE:\r
 246     return OnExitSizeMove( &sd, hDlg, wParam, lParam );\r
 247 \r
 248   case WM_GETMINMAXINFO:\r
 249     /* Prevent resizing window too small */\r
 250     mmi = (MINMAXINFO *) lParam;\r
 251     mmi->ptMinTrackSize.x = 100;\r
 252     mmi->ptMinTrackSize.y = 100;\r
 253     break;\r
 254 \r
 255   case WM_COMMAND:\r
 256       /*\r
 257         [AS]\r
 258         If <Enter> is pressed while editing the filter, it's better to apply\r
 259         the filter rather than selecting the current game.\r
 260       */\r
 261       if( LOWORD(wParam) == IDC_GameListFilter ) {\r
 262           switch( HIWORD(wParam) ) {\r
 263           case EN_SETFOCUS:\r
 264               filterHasFocus = TRUE;\r
 265               break;\r
 266           case EN_KILLFOCUS:\r
 267               filterHasFocus = FALSE;\r
 268               break;\r
 269           }\r
 270       }\r
 271 \r
 272       if( filterHasFocus && (LOWORD(wParam) == IDOK) ) {\r
 273           wParam = IDC_GameListDoFilter;\r
 274       }\r
 275       /* [AS] End command replacement */\r
 276 \r
 277     switch (LOWORD(wParam)) {\r
 278     case OPT_GameListLoad:\r
 279       LoadOptionsPopup(hDlg);\r
 280       return TRUE;\r
 281     case IDOK:\r
 282       nItem = SendDlgItemMessage(hDlg, OPT_GameListText, LB_GETCURSEL, 0, 0);\r
 283       if (nItem < 0) {\r
 284         /* is this possible? */\r
 285         DisplayError(_("No game selected"), 0);\r
 286         return TRUE;\r
 287       }\r
 288       break; /* load the game*/\r
 289 \r
 290     case OPT_GameListNext:\r
 291       nItem = SendDlgItemMessage(hDlg, OPT_GameListText, LB_GETCURSEL, 0, 0);\r
 292       nItem++;\r
 293       if (nItem >= ((ListGame *) gameList.tailPred)->number) {\r
 294         /* [AS] Removed error message */\r
 295         /* DisplayError(_("Can't go forward any further"), 0); */\r
 296         return TRUE;\r
 297       }\r
 298       SendDlgItemMessage(hDlg, OPT_GameListText, LB_SETCURSEL, nItem, 0);\r
 299       break; /* load the game*/\r
 300 \r
 301     case OPT_GameListPrev:\r
 302 #if 0\r
 303       nItem = SendDlgItemMessage(hDlg, OPT_GameListText, LB_GETCURSEL, 0, 0);\r
 304       nItem--;\r
 305       if (nItem < 0) {\r
 306         /* [AS] Removed error message, added return */\r
 307         /* DisplayError(_("Can't back up any further"), 0); */\r
 308         return TRUE;\r
 309       }\r
 310       SendDlgItemMessage(hDlg, OPT_GameListText, LB_SETCURSEL, nItem, 0);\r
 311       break; /* load the game*/\r
 312 #endif\r
 313     /* [AS] */\r
 314     case OPT_GameListFind:\r
 315     case IDC_GameListDoFilter:\r
 316         {\r
 317             char filter[MAX_FILTER_LENGTH+1];\r
 318 \r
 319             if( GetDlgItemText( hDlg, IDC_GameListFilter, filter, sizeof(filter) ) >= 0 ) {\r
 320                 filter[ sizeof(filter)-1 ] = '\0';\r
 321                 count = GameListToListBox( hDlg, TRUE, filter, &stats, LOWORD(wParam)!=IDC_GameListDoFilter, LOWORD(wParam)==OPT_GameListNarrow );\r
 322                 GameListUpdateTitle( hDlg, _("Game List"), count, ((ListGame *) gameList.tailPred)->number, &stats );\r
 323             }\r
 324         }\r
 325         return FALSE;\r
 326         break;\r
 327 \r
 328     case IDCANCEL:\r
 329     case OPT_GameListClose:\r
 330       GameListPopDown();\r
 331       return TRUE;\r
 332 \r
 333     case OPT_GameListText:\r
 334       switch (HIWORD(wParam)) {\r
 335       case LBN_DBLCLK:\r
 336         nItem = SendMessage((HWND) lParam, LB_GETCURSEL, 0, 0);\r
 337         break; /* load the game*/\r
 338 \r
 339       default:\r
 340         return FALSE;\r
 341       }\r
 342       break;\r
 343 \r
 344     default:\r
 345       return FALSE;\r
 346     }\r
 347 \r
 348     /* Load the game */\r
 349     {\r
 350         /* [AS] Get index from the item itself, because filtering makes original order unuseable. */\r
 351         int index = SendDlgItemMessage(hDlg, OPT_GameListText, LB_GETCURSEL, 0, 0);\r
 352         char * text;\r
 353         LRESULT res;\r
 354 \r
 355         if( index < 0 ) {\r
 356             return TRUE;\r
 357         }\r
 358 \r
 359         res = SendDlgItemMessage( hDlg, OPT_GameListText, LB_GETTEXTLEN, index, 0 );\r
 360 \r
 361         if( res == LB_ERR ) {\r
 362             return TRUE;\r
 363         }\r
 364 \r
 365         text = (char *) malloc( res+1 );\r
 366 \r
 367         res = SendDlgItemMessage( hDlg, OPT_GameListText, LB_GETTEXT, index, (LPARAM)text );\r
 368 \r
 369         index = atoi( text );\r
 370 \r
 371         nItem = index - 1;\r
 372 \r
 373         free( text );\r
 374         /* [AS] End: nItem has been "patched" now! */\r
 375 \r
 376         if (cmailMsgLoaded) {\r
 377             CmailLoadGame(gameFile, nItem + 1, gameFileName, TRUE);\r
 378         }\r
 379         else {\r
 380             LoadGame(gameFile, nItem + 1, gameFileName, TRUE);\r
 381             SetFocus(hwndMain); // [HGM] automatic focus switch\r
 382         }\r
 383     }\r
 384 \r
 385     return TRUE;\r
 386 \r
 387   default:\r
 388     break;\r
 389   }\r
 390   return FALSE;\r
 391 }\r
 392 \r
 393 \r
 394 VOID GameListPopUp(FILE *fp, char *filename)\r
 395 {\r
 396   FARPROC lpProc;\r
 397 \r
 398   gameFile = fp;\r
 399   if (gameFileName != filename) {\r
 400     if (gameFileName) free(gameFileName);\r
 401     gameFileName = StrSave(filename);\r
 402   }\r
 403   CheckMenuItem(GetMenu(hwndMain), IDM_ShowGameList, MF_CHECKED);\r
 404   EnableMenuItem(GetMenu(hwndMain), IDM_SaveSelected, MF_ENABLED);\r
 405   if (gameListDialog) {\r
 406     SendMessage(gameListDialog, WM_INITDIALOG, 0, 0);\r
 407     if (!gameListUp) ShowWindow(gameListDialog, SW_SHOW);\r
 408     else SetFocus(gameListDialog);\r
 409   } else {\r
 410     lpProc = MakeProcInstance((FARPROC)GameListDialog, hInst);\r
 411     CreateDialog(hInst, MAKEINTRESOURCE(DLG_GameList),\r
 412       hwndMain, (DLGPROC)lpProc);\r
 413     FreeProcInstance(lpProc);\r
 414   }\r
 415   gameListUp = TRUE;\r
 416 }\r
 417 \r
 418 FILE *GameFile()\r
 419 {\r
 420   return gameFile;\r
 421 }\r
 422 \r
 423 VOID GameListPopDown(void)\r
 424 {\r
 425   CheckMenuItem(GetMenu(hwndMain), IDM_ShowGameList, MF_UNCHECKED);\r
 426   EnableMenuItem(GetMenu(hwndMain), IDM_SaveSelected, MF_GRAYED);\r
 427   if (gameListDialog) ShowWindow(gameListDialog, SW_HIDE);\r
 428   gameListUp = FALSE;\r
 429 }\r
 430 \r
 431 \r
 432 VOID GameListHighlight(int index)\r
 433 {\r
 434   char buf[MSG_SIZ];\r
 435   int i, j, k, n, res = 0;\r
 436   if (gameListDialog == NULL) return;\r
 437   for(i=64; ; i+=i) {\r
 438         res = SendDlgItemMessage( gameListDialog, OPT_GameListText, LB_GETTEXT, i, (LPARAM)buf );\r
 439         if(res == LB_ERR || index < atoi( buf )) break;\r
 440   }\r
 441   j = i/2;\r
 442   while(i-j > 1) {\r
 443         n = (i + j) >> 1;\r
 444         res = SendDlgItemMessage( gameListDialog, OPT_GameListText, LB_GETTEXT, n, (LPARAM)buf );\r
 445         if(res == LB_ERR || index < (k = atoi( buf ))) i = n; else {\r
 446             j = n;\r
 447             if(index == k) break;\r
 448         }\r
 449   }\r
 450   SendDlgItemMessage(gameListDialog, OPT_GameListText, LB_SETCURSEL, j, 0);\r
 451 }\r
 452 \r
 453 \r
 454 VOID GameListDestroy()\r
 455 {\r
 456   GameListPopDown();\r
 457   if (gameFileName) {\r
 458     free(gameFileName);\r
 459     gameFileName = NULL;\r
 460   }\r
 461 }\r
 462 \r
 463 VOID ShowGameListProc()\r
 464 {\r
 465   if (gameListUp) {\r
 466     if(gameListDialog) SetFocus(gameListDialog);\r
 467 //    GameListPopDown();\r
 468   } else {\r
 469     if (gameFileName) {\r
 470       GameListPopUp(gameFile, gameFileName);\r
 471     } else {\r
 472       DisplayError(_("No game list"), 0);\r
 473     }\r
 474   }\r
 475 }\r
 476 \r
 477 HGLOBAL ExportGameListAsText()\r
 478 {\r
 479     HGLOBAL result = NULL;\r
 480     LPVOID lpMem = NULL;\r
 481     ListGame * lg = (ListGame *) gameList.head;\r
 482     int nItem;\r
 483     DWORD dwLen = 0;\r
 484 \r
 485     if( ! gameFileName || ((ListGame *) gameList.tailPred)->number <= 0 ) {\r
 486         DisplayError(_(_("Game list not loaded or empty")), 0);\r
 487         return NULL;\r
 488     }\r
 489 \r
 490     /* Get list size */\r
 491     for (nItem = 0; nItem < ((ListGame *) gameList.tailPred)->number; nItem++){\r
 492         char * st = GameListLineFull(lg->number, &lg->gameInfo);\r
 493 \r
 494         dwLen += strlen(st) + 2; /* Add extra characters for "\r\n" */\r
 495 \r
 496         free(st);\r
 497         lg = (ListGame *) lg->node.succ;\r
 498     }\r
 499 \r
 500     /* Allocate memory for the list */\r
 501     result = GlobalAlloc(GHND, dwLen+1 );\r
 502 \r
 503     if( result != NULL ) {\r
 504         lpMem = GlobalLock(result);\r
 505     }\r
 506 \r
 507     /* Copy the list into the global memory block */\r
 508     if( lpMem != NULL ) {\r
 509         char * dst = (char *) lpMem;\r
 510         size_t len;\r
 511 \r
 512         lg = (ListGame *) gameList.head;\r
 513 \r
 514         for (nItem = 0; nItem < ((ListGame *) gameList.tailPred)->number; nItem++){\r
 515             char * st = GameListLineFull(lg->number, &lg->gameInfo);\r
 516 \r
 517             len = sprintf( dst, "%s\r\n", st );\r
 518             dst += len;\r
 519 \r
 520             free(st);\r
 521             lg = (ListGame *) lg->node.succ;\r
 522         }\r
 523 \r
 524         GlobalUnlock( result );\r
 525     }\r
 526 \r
 527     return result;\r
 528 }\r