winboard/wclipbrd.c

   1 /*\r
   2  * wclipbrd.c -- Clipboard routines for WinBoard\r
   3  *\r
   4  * Copyright 2000, 2009, 2010 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 <sys/stat.h>\r
  33 \r
  34 #include "common.h"\r
  35 #include "frontend.h"\r
  36 #include "backend.h"\r
  37 #include "winboard.h"\r
  38 #include "wclipbrd.h"\r
  39 \r
  40 #define _(s) T_(s)\r
  41 #define N_(s) s\r
  42 \r
  43 /* Imports from winboard.c */\r
  44 extern HWND hwndMain;\r
  45 Boolean ParseFEN(Board b, int *stm, char *FEN);\r
  46 \r
  47 /* File globals */\r
  48 static char *copyTemp;\r
  49 static char *pasteTemp;\r
  50 \r
  51 VOID \r
  52 CopyFENToClipboard()\r
  53 {\r
  54   char *fen = NULL;\r
  55 \r
  56   if(gameMode == EditPosition) EditPositionDone(TRUE); // [HGM] mak sure castling rights are set consistently\r
  57   fen = PositionToFEN(currentMove, NULL);\r
  58   if (!fen) {\r
  59     DisplayError(_("Unable to convert position to FEN."), 0);\r
  60     return;\r
  61   }\r
  62   if (!CopyTextToClipboard(fen))\r
  63       DisplayError(_("Unable to copy FEN to clipboard."), 0);\r
  64   free(fen);\r
  65 }\r
  66 \r
  67 /* [AS] */\r
  68 HGLOBAL ExportGameListAsText();\r
  69 \r
  70 VOID CopyGameListToClipboard()\r
  71 {\r
  72     HGLOBAL hMem = ExportGameListAsText();\r
  73     \r
  74     if( hMem != NULL ) {\r
  75         /* Assign memory block to clipboard */\r
  76         BOOL ok = OpenClipboard( hwndMain );\r
  77 \r
  78         if( ok ) {\r
  79             ok = EmptyClipboard();\r
  80 \r
  81             if( ok ) {\r
  82                 if( hMem != SetClipboardData( CF_TEXT, hMem ) ) {\r
  83                     ok = FALSE;\r
  84                 }\r
  85             }\r
  86 \r
  87             CloseClipboard();\r
  88 \r
  89             if( ! ok ) {\r
  90                 GlobalFree( hMem );\r
  91             }\r
  92         }\r
  93 \r
  94         if( ! ok ) {\r
  95             DisplayError( "Cannot copy list to clipboard.", 0 );\r
  96         }\r
  97     }\r
  98 }\r
  99 \r
 100 VOID\r
 101 CopyGameToClipboard()\r
 102 {\r
 103   /* A rather cheesy hack here. Write the game to a file, then read from the\r
 104    * file into the clipboard.\r
 105    */\r
 106   char *buf = NULL;\r
 107   FILE *f;\r
 108   unsigned long size;\r
 109   size_t len;\r
 110   struct stat st;\r
 111 \r
 112   if (!copyTemp) {\r
 113     copyTemp = tempnam(NULL, "wbcp");\r
 114   }\r
 115   if (!copyTemp) {\r
 116       DisplayError(_("Cannot create temporary file name."),0);\r
 117       return;\r
 118   }\r
 119   f = fopen(copyTemp, "w");\r
 120   if (!f) {\r
 121     DisplayError(_("Cannot open temporary file."), 0);\r
 122     return;\r
 123   }\r
 124   if (!SaveGame(f,0,"")) {                      /* call into backend */\r
 125     DisplayError(_("Cannot write to temporary file."), 0);\r
 126     goto copy_game_to_clipboard_cleanup;\r
 127   }\r
 128   f = fopen(copyTemp, "rb");\r
 129   if (!f) {\r
 130     DisplayError(_("Cannot reopen temporary file."), 0);\r
 131     goto copy_game_to_clipboard_cleanup;\r
 132   }\r
 133   if (fstat(fileno(f), &st) < 0) {\r
 134     DisplayError(_(_("Cannot determine size of file.")), 0);\r
 135     goto copy_game_to_clipboard_cleanup;\r
 136   }\r
 137   size = st.st_size;\r
 138   if (size == -1) {\r
 139     DisplayError(_(_("Cannot determine size of file.")), 0);\r
 140     goto copy_game_to_clipboard_cleanup;\r
 141   }\r
 142   rewind(f);\r
 143   buf = (char*)malloc(size+1);\r
 144   if (!buf) {\r
 145     DisplayError(_("Cannot allocate clipboard buffer."), 0);\r
 146     goto copy_game_to_clipboard_cleanup;\r
 147   }\r
 148   len = fread(buf, sizeof(char), size, f);\r
 149   if (len == -1) {\r
 150     DisplayError(_("Cannot read from temporary file."), 0);\r
 151     goto copy_game_to_clipboard_cleanup;\r
 152   }\r
 153   if ((unsigned long)size != (unsigned long)len) { /* sigh */ \r
 154       DisplayError(_("Error reading from temporary file."), 0);\r
 155       goto copy_game_to_clipboard_cleanup;\r
 156   }\r
 157   buf[size] = 0;\r
 158   if (!CopyTextToClipboard(buf)) {\r
 159       DisplayError(_("Cannot copy text to clipboard"), 0);\r
 160   }\r
 161 \r
 162 copy_game_to_clipboard_cleanup:\r
 163   if (buf) free(buf);\r
 164   if (f) fclose(f);\r
 165 }\r
 166 \r
 167 \r
 168 int \r
 169 CopyTextToClipboard(char *text)\r
 170 {\r
 171   /* some (most?) of the error checking may be overkill, \r
 172    * but hey, this is Windows \r
 173    */\r
 174   HGLOBAL hGlobalMem;\r
 175   LPVOID lpGlobalMem;\r
 176   BOOL locked;\r
 177   UINT lockCount;\r
 178   DWORD err;\r
 179 \r
 180   hGlobalMem = GlobalAlloc(GHND, (DWORD)lstrlen(text)+1);\r
 181   if (hGlobalMem == NULL) {\r
 182     DisplayError(_("Unable to allocate memory for clipboard."), 0);\r
 183     return FALSE;\r
 184   }\r
 185   lpGlobalMem = GlobalLock(hGlobalMem);\r
 186   if (lpGlobalMem == NULL) {\r
 187     DisplayError(_(_("Unable to lock clipboard memory.")), 0);\r
 188     GlobalFree(hGlobalMem);\r
 189     return FALSE;\r
 190   }\r
 191   safeStrCpy(lpGlobalMem, text, sizeof(lpGlobalMem)/sizeof(lpGlobalMem[0]) );\r
 192   if (appData.debugMode) {\r
 193     lockCount = GlobalFlags(hGlobalMem) & GMEM_LOCKCOUNT;\r
 194     fprintf(debugFP, "CopyTextToClipboard(): lock count %d\n", lockCount);\r
 195   }\r
 196   SetLastError(NO_ERROR);\r
 197   locked = GlobalUnlock(hGlobalMem);\r
 198   err = GetLastError();\r
 199   if (appData.debugMode) {\r
 200     lockCount = GlobalFlags(hGlobalMem) & GMEM_LOCKCOUNT;\r
 201     fprintf(debugFP, "CopyTextToClipboard(): lock count %d\n", lockCount);\r
 202   }\r
 203   if (!locked) {\r
 204     locked = !((err == NO_ERROR) || (err == ERROR_NOT_LOCKED));\r
 205     if (appData.debugMode) {\r
 206       fprintf(debugFP, \r
 207               "CopyTextToClipboard(): err %d locked %d\n", (int)err, locked);\r
 208     }\r
 209   }\r
 210   if (locked) {\r
 211     DisplayError(_("Cannot unlock clipboard memory."), 0);\r
 212     GlobalFree(hGlobalMem);\r
 213     return FALSE;\r
 214   }\r
 215   if (!OpenClipboard(hwndMain)) {\r
 216     DisplayError(_("Cannot open clipboard."), 0);\r
 217     GlobalFree(hGlobalMem);\r
 218     return FALSE;\r
 219   }\r
 220   if (!EmptyClipboard()) {\r
 221     DisplayError(_("Cannot empty clipboard."), 0);\r
 222     return FALSE;\r
 223   }\r
 224   if (hGlobalMem != SetClipboardData(CF_TEXT, hGlobalMem)) {\r
 225     DisplayError(_("Cannot copy text to clipboard."), 0);\r
 226     CloseClipboard();\r
 227     GlobalFree(hGlobalMem);\r
 228     return FALSE;\r
 229   }\r
 230   if (!CloseClipboard())\r
 231     DisplayError(_("Cannot close clipboard."), 0);\r
 232   \r
 233   return TRUE;\r
 234 }\r
 235 \r
 236 /* [AS] Reworked paste functions so they can work with strings too */\r
 237 \r
 238 VOID PasteFENFromString( char * fen )\r
 239 {\r
 240   if (appData.debugMode) {\r
 241     fprintf(debugFP, "PasteFenFromString(): fen '%s'\n", fen);\r
 242   }\r
 243   EditPositionPasteFEN(fen); /* call into backend */\r
 244   free(fen);\r
 245 }\r
 246 \r
 247 \r
 248 VOID\r
 249 PasteFENFromClipboard()\r
 250 {\r
 251   char *fen = NULL;\r
 252   if (!PasteTextFromClipboard(&fen)) {\r
 253       DisplayError(_("Unable to paste FEN from clipboard."), 0);\r
 254       return;\r
 255   }\r
 256   PasteFENFromString( fen );\r
 257 }\r
 258 \r
 259 VOID PasteGameFromString( char * buf )\r
 260 {\r
 261   FILE *f;\r
 262   size_t len;\r
 263   if (!pasteTemp) {\r
 264     pasteTemp = tempnam(NULL, "wbpt");\r
 265   }\r
 266   f = fopen(pasteTemp, "w");\r
 267   if (!f) {\r
 268     DisplayError(_("Unable to create temporary file."), 0);\r
 269     free(buf); /* [AS] */\r
 270     return;\r
 271   }\r
 272   len = fwrite(buf, sizeof(char), strlen(buf), f);\r
 273   fclose(f);\r
 274   if (len != strlen(buf)) {\r
 275     DisplayError(_("Error writing to temporary file."), 0);\r
 276     free(buf); /* [AS] */\r
 277     return;\r
 278   }\r
 279   LoadGameFromFile(pasteTemp, 0, "Clipboard", TRUE);\r
 280   free( buf ); /* [AS] */\r
 281 }\r
 282 \r
 283 \r
 284 VOID\r
 285 PasteGameFromClipboard()\r
 286 {\r
 287   /* Write the clipboard to a temp file, then let LoadGameFromFile()\r
 288    * do all the work.  */\r
 289   char *buf;\r
 290   if (!PasteTextFromClipboard(&buf)) {\r
 291     return;\r
 292   }\r
 293   PasteGameFromString( buf );\r
 294 }\r
 295 \r
 296 /* [AS] Try to detect whether the clipboard contains FEN or PGN data */\r
 297 VOID PasteGameOrFENFromClipboard()\r
 298 {\r
 299   char *buf;\r
 300 //  char *tmp;\r
 301   Board dummyBoard; int dummy; // [HGM] paste any\r
 302 \r
 303   if (!PasteTextFromClipboard(&buf)) {\r
 304     return;\r
 305   }\r
 306 \r
 307   // [HGM] paste any: make still smarter, to allow pasting of games without tags, recognize FEN in stead\r
 308   if(!ParseFEN(dummyBoard, &dummy, buf) ) {\r
 309       PasteGameFromString( buf );\r
 310   }\r
 311   else {\r
 312       PasteFENFromString( buf );\r
 313   }\r
 314 }\r
 315 \r
 316 int \r
 317 PasteTextFromClipboard(char **text)\r
 318 {\r
 319   /* some (most?) of the error checking may be overkill, \r
 320    * but hey, this is Windows \r
 321    */\r
 322   HANDLE hClipMem;\r
 323   LPVOID lpClipMem;\r
 324   BOOL locked = FALSE;\r
 325   DWORD err;\r
 326   UINT lockCount;\r
 327 \r
 328   if (!OpenClipboard(hwndMain)) {\r
 329     DisplayError(_("Unable to open clipboard."), 0);\r
 330     return FALSE;\r
 331   }\r
 332   hClipMem = GetClipboardData(CF_TEXT);\r
 333   if (hClipMem == NULL) {\r
 334     CloseClipboard();\r
 335     DisplayError(_("No text in clipboard."), 0);\r
 336     return FALSE;\r
 337   }\r
 338   lpClipMem = GlobalLock(hClipMem);\r
 339   if (lpClipMem == NULL) {\r
 340     CloseClipboard();\r
 341     DisplayError(_(_("Unable to lock clipboard memory.")), 0);\r
 342     return FALSE;\r
 343   }\r
 344   *text = (char *) malloc(GlobalSize(hClipMem)+1);\r
 345   if (!*text) {\r
 346     DisplayError(_("Unable to allocate memory for text string."), 0);\r
 347     CloseClipboard();\r
 348     return FALSE;\r
 349   }\r
 350   safeStrCpy(*text, lpClipMem, sizeof(*text)/sizeof(*text[0]) );\r
 351   if (appData.debugMode) {\r
 352     lockCount = GlobalFlags(hClipMem) & GMEM_LOCKCOUNT;\r
 353     fprintf(debugFP, "PasteTextFromClipboard(): lock count %d\n", lockCount);\r
 354   }\r
 355   SetLastError(NO_ERROR);\r
 356   /*suggested by Wilkin Ng*/\r
 357   lockCount = GlobalFlags(hClipMem) & GMEM_LOCKCOUNT;\r
 358   if (lockCount) {\r
 359     locked = GlobalUnlock(hClipMem);\r
 360   }\r
 361   err = GetLastError();\r
 362   if (appData.debugMode) {\r
 363     lockCount = GlobalFlags(hClipMem) & GMEM_LOCKCOUNT;\r
 364     fprintf(debugFP, "PasteTextFromClipboard(): lock count %d\n", lockCount);\r
 365   }\r
 366   if (!locked) {\r
 367     locked = !((err == NO_ERROR) || (err == ERROR_NOT_LOCKED));\r
 368     if (appData.debugMode) {\r
 369       fprintf(debugFP, \r
 370               "PasteTextFromClipboard(): err %d locked %d\n", (int)err, locked);\r
 371     }\r
 372   }\r
 373   if (locked) \r
 374     DisplayError(_("Unable to unlock clipboard memory."), 0);\r
 375   \r
 376   if (!CloseClipboard())\r
 377     DisplayError(_("Unable to close clipboard."), 0);\r
 378   \r
 379   return TRUE;\r
 380 }\r
 381 \r
 382 VOID\r
 383 DeleteClipboardTempFiles()\r
 384 {\r
 385   if (copyTemp) remove(copyTemp);\r
 386   if (pasteTemp) remove(pasteTemp);\r
 387 }\r