dlls/user32/clipboard.c

   1 /*
   2  * WIN32 clipboard implementation
   3  *
   4  * Copyright 1994 Martin Ayotte
   5  *           1996 Alex Korobka
   6  *           1999 Noel Borthwick
   7  *           2003 Ulrich Czekalla for CodeWeavers
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  22  *
  23  * NOTES:
  24  *    This file contains the implementation for the WIN32 Clipboard API
  25  * and Wine's internal clipboard cache.
  26  * The actual contents of the clipboard are held in the clipboard cache.
  27  * The internal implementation talks to a "clipboard driver" to fill or
  28  * expose the cache to the native device. (Currently only the X11 and
  29  * TTY clipboard  driver are available)
  30  */
  31
  32 #include "config.h"
  33 #include "wine/port.h"
  34
  35 #include <stdarg.h>
  36 #include <stdlib.h>
  37 #include <sys/types.h>
  38 #include <fcntl.h>
  39 #ifdef HAVE_UNISTD_H
  40 # include <unistd.h>
  41 #endif
  42 #include <string.h>
  43
  44 #include "windef.h"
  45 #include "winbase.h"
  46 #include "wingdi.h"
  47 #include "winuser.h"
  48 #include "winerror.h"
  49 #include "wine/winbase16.h"
  50 #include "user_private.h"
  51 #include "win.h"
  52
  53 #include "wine/debug.h"
  54 #include "wine/unicode.h"
  55 #include "wine/server.h"
  56
  57 WINE_DEFAULT_DEBUG_CHANNEL(clipboard);
  58
  59 #define  CF_REGFORMATBASE  0xC000
  60
  61 typedef struct
  62 {
  63     HWND hWndOpen;
  64     HWND hWndOwner;
  65     HWND hWndViewer;
  66     UINT seqno;
  67     UINT flags;
  68 } CLIPBOARDINFO, *LPCLIPBOARDINFO;
  69
  70 /*
  71  * Indicates if data has changed since open.
  72  */
  73 static BOOL bCBHasChanged = FALSE;
  74
  75
  76 /**************************************************************************
  77  *                      CLIPBOARD_SetClipboardOwner
  78  *
  79  * Set the global wineserver clipboard owner. The current process will
  80  * be the owner and <hWnd> will get the render notifications.
  81  */
  82 static BOOL CLIPBOARD_SetClipboardOwner(HWND hWnd)
  83 {
  84     BOOL bRet;
  85
  86     TRACE(" hWnd(%p)\n", hWnd);
  87
  88     SERVER_START_REQ( set_clipboard_info )
  89     {
  90         req->flags = SET_CB_OWNER;
  91         req->owner = wine_server_user_handle( hWnd );
  92         bRet = !wine_server_call_err( req );
  93     }
  94     SERVER_END_REQ;
  95
  96     return bRet;
  97 }
  98
  99
 100 /**************************************************************************
 101  *                      CLIPBOARD_GetClipboardInfo
 102  */
 103 static BOOL CLIPBOARD_GetClipboardInfo(LPCLIPBOARDINFO cbInfo)
 104 {
 105     BOOL bRet;
 106
 107     SERVER_START_REQ( set_clipboard_info )
 108     {
 109         req->flags = 0;
 110
 111         if (((bRet = !wine_server_call_err( req ))))
 112         {
 113             cbInfo->hWndOpen = wine_server_ptr_handle( reply->old_clipboard );
 114             cbInfo->hWndOwner = wine_server_ptr_handle( reply->old_owner );
 115             cbInfo->hWndViewer = wine_server_ptr_handle( reply->old_viewer );
 116             cbInfo->seqno = reply->seqno;
 117             cbInfo->flags = reply->flags;
 118         }
 119     }
 120     SERVER_END_REQ;
 121
 122     return bRet;
 123 }
 124
 125
 126 /**************************************************************************
 127  *      CLIPBOARD_ReleaseOwner
 128  */
 129 BOOL CLIPBOARD_ReleaseOwner(void)
 130 {
 131     BOOL bRet = FALSE;
 132
 133     SERVER_START_REQ( set_clipboard_info )
 134     {
 135         req->flags = SET_CB_RELOWNER | SET_CB_SEQNO;
 136
 137         if (wine_server_call_err( req ))
 138         {
 139             ERR("Failed to set clipboard.\n");
 140         }
 141         else
 142         {
 143             bRet = TRUE;
 144         }
 145     }
 146     SERVER_END_REQ;
 147
 148     return bRet;
 149 }
 150
 151
 152 /**************************************************************************
 153  *              CLIPBOARD_OpenClipboard
 154  */
 155 static BOOL CLIPBOARD_OpenClipboard(HWND hWnd)
 156 {
 157     BOOL bRet;
 158
 159     SERVER_START_REQ( set_clipboard_info )
 160     {
 161         req->flags = SET_CB_OPEN;
 162         req->clipboard = wine_server_user_handle( hWnd );
 163         bRet = !wine_server_call( req );
 164     }
 165     SERVER_END_REQ;
 166
 167     return bRet;
 168 }
 169
 170
 171 /**************************************************************************
 172  *              CLIPBOARD_CloseClipboard
 173  */
 174 static BOOL CLIPBOARD_CloseClipboard(void)
 175 {
 176     BOOL bRet;
 177
 178     TRACE(" Changed=%d\n", bCBHasChanged);
 179
 180     SERVER_START_REQ( set_clipboard_info )
 181     {
 182         req->flags = SET_CB_CLOSE;
 183         if (bCBHasChanged) req->flags |= SET_CB_SEQNO;
 184         bRet = !wine_server_call_err( req );
 185     }
 186     SERVER_END_REQ;
 187
 188     return bRet;
 189 }
 190
 191
 192 /**************************************************************************
 193  *                WIN32 Clipboard implementation
 194  **************************************************************************/
 195
 196 /**************************************************************************
 197  *              RegisterClipboardFormatW (USER32.@)
 198  */
 199 UINT WINAPI RegisterClipboardFormatW(LPCWSTR FormatName)
 200 {
 201     return USER_Driver->pRegisterClipboardFormat(FormatName);
 202 }
 203
 204
 205 /**************************************************************************
 206  *              RegisterClipboardFormatA (USER32.@)
 207  */
 208 UINT WINAPI RegisterClipboardFormatA(LPCSTR formatName)
 209 {
 210     int len;
 211     LPWSTR wFormat;
 212     UINT ret;
 213
 214     len = MultiByteToWideChar(CP_ACP, 0, formatName, -1, NULL, 0);
 215     wFormat = HeapAlloc(GetProcessHeap(), 0, len*sizeof(WCHAR));
 216     MultiByteToWideChar(CP_ACP, 0, formatName, -1, wFormat, len);
 217
 218     ret = RegisterClipboardFormatW(wFormat);
 219     HeapFree(GetProcessHeap(), 0, wFormat);
 220     return ret;
 221 }
 222
 223
 224 /**************************************************************************
 225  *              GetClipboardFormatNameW (USER32.@)
 226  */
 227 INT WINAPI GetClipboardFormatNameW(UINT wFormat, LPWSTR retStr, INT maxlen)
 228 {
 229     return USER_Driver->pGetClipboardFormatName(wFormat, retStr, maxlen);
 230 }
 231
 232
 233 /**************************************************************************
 234  *              GetClipboardFormatNameA (USER32.@)
 235  */
 236 INT WINAPI GetClipboardFormatNameA(UINT wFormat, LPSTR retStr, INT maxlen)
 237 {
 238     INT ret;
 239     LPWSTR p = HeapAlloc( GetProcessHeap(), 0, maxlen*sizeof(WCHAR) );
 240     if(p == NULL) return 0; /* FIXME: is this the correct failure value? */
 241
 242     ret = GetClipboardFormatNameW( wFormat, p, maxlen );
 243
 244     if (ret && maxlen > 0 && !WideCharToMultiByte( CP_ACP, 0, p, -1, retStr, maxlen, 0, 0))
 245         retStr[maxlen-1] = 0;
 246     HeapFree( GetProcessHeap(), 0, p );
 247     return ret;
 248 }
 249
 250
 251 /**************************************************************************
 252  *              OpenClipboard (USER32.@)
 253  *
 254  * Note: Netscape uses NULL hWnd to open the clipboard.
 255  */
 256 BOOL WINAPI OpenClipboard( HWND hWnd )
 257 {
 258     BOOL bRet;
 259
 260     TRACE("(%p)...\n", hWnd);
 261
 262     bRet = CLIPBOARD_OpenClipboard(hWnd);
 263
 264     TRACE(" returning %i\n", bRet);
 265
 266     return bRet;
 267 }
 268
 269
 270 /**************************************************************************
 271  *              CloseClipboard (USER32.@)
 272  */
 273 BOOL WINAPI CloseClipboard(void)
 274 {
 275     BOOL bRet = FALSE;
 276
 277     TRACE("(%d)\n", bCBHasChanged);
 278
 279     if (CLIPBOARD_CloseClipboard())
 280     {
 281         if (bCBHasChanged)
 282         {
 283             HWND hWndViewer = GetClipboardViewer();
 284
 285             USER_Driver->pEndClipboardUpdate();
 286
 287             if (hWndViewer)
 288                 SendMessageW(hWndViewer, WM_DRAWCLIPBOARD, 0, 0);
 289
 290             bCBHasChanged = FALSE;
 291         }
 292
 293         bRet = TRUE;
 294     }
 295
 296     return bRet;
 297 }
 298
 299
 300 /**************************************************************************
 301  *              EmptyClipboard (USER32.@)
 302  * Empties and acquires ownership of the clipboard
 303  */
 304 BOOL WINAPI EmptyClipboard(void)
 305 {
 306     CLIPBOARDINFO cbinfo;
 307
 308     TRACE("()\n");
 309
 310     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 311         ~cbinfo.flags & CB_OPEN)
 312     {
 313         WARN("Clipboard not opened by calling task!\n");
 314         SetLastError(ERROR_CLIPBOARD_NOT_OPEN);
 315         return FALSE;
 316     }
 317
 318     /* Destroy private objects */
 319     if (cbinfo.hWndOwner)
 320         SendMessageW(cbinfo.hWndOwner, WM_DESTROYCLIPBOARD, 0, 0);
 321
 322     /* Tell the driver to acquire the selection. The current owner
 323      * will be signaled to delete it's own cache. */
 324
 325     /* Assign ownership of the clipboard to the current client. We do
 326      * this before acquiring the selection so that when we do acquire the
 327      * selection and the selection loser gets notified, it can check if
 328      * it has lost the Wine clipboard ownership. If it did then it knows
 329      * that a WM_DESTORYCLIPBOARD has already been sent. Otherwise it
 330      * lost the selection to a X app and it should send the
 331      * WM_DESTROYCLIPBOARD itself. */
 332     CLIPBOARD_SetClipboardOwner(cbinfo.hWndOpen);
 333
 334     /* Acquire the selection. This will notify the previous owner
 335      * to clear it's cache. */
 336     USER_Driver->pAcquireClipboard(cbinfo.hWndOpen);
 337
 338     /* Empty the local cache */
 339     USER_Driver->pEmptyClipboard(FALSE);
 340
 341     bCBHasChanged = TRUE;
 342
 343     return TRUE;
 344 }
 345
 346
 347 /**************************************************************************
 348  *              GetClipboardOwner (USER32.@)
 349  *  FIXME: Can't return the owner if the clipboard is owned by an external X-app
 350  */
 351 HWND WINAPI GetClipboardOwner(void)
 352 {
 353     HWND hWndOwner = 0;
 354
 355     SERVER_START_REQ( set_clipboard_info )
 356     {
 357         req->flags = 0;
 358         if (!wine_server_call_err( req )) hWndOwner = wine_server_ptr_handle( reply->old_owner );
 359     }
 360     SERVER_END_REQ;
 361
 362     TRACE(" hWndOwner(%p)\n", hWndOwner);
 363
 364     return hWndOwner;
 365 }
 366
 367
 368 /**************************************************************************
 369  *              GetOpenClipboardWindow (USER32.@)
 370  */
 371 HWND WINAPI GetOpenClipboardWindow(void)
 372 {
 373     HWND hWndOpen = 0;
 374
 375     SERVER_START_REQ( set_clipboard_info )
 376     {
 377         req->flags = 0;
 378         if (!wine_server_call_err( req )) hWndOpen = wine_server_ptr_handle( reply->old_clipboard );
 379     }
 380     SERVER_END_REQ;
 381
 382     TRACE(" hWndClipWindow(%p)\n", hWndOpen);
 383
 384     return hWndOpen;
 385 }
 386
 387
 388 /**************************************************************************
 389  *              SetClipboardViewer (USER32.@)
 390  */
 391 HWND WINAPI SetClipboardViewer( HWND hWnd )
 392 {
 393     HWND hwndPrev = 0;
 394
 395     SERVER_START_REQ( set_clipboard_info )
 396     {
 397         req->flags = SET_CB_VIEWER;
 398         req->viewer = wine_server_user_handle( hWnd );
 399         if (!wine_server_call_err( req ))
 400             hwndPrev = wine_server_ptr_handle( reply->old_viewer );
 401     }
 402     SERVER_END_REQ;
 403
 404     TRACE("(%p): returning %p\n", hWnd, hwndPrev);
 405
 406     return hwndPrev;
 407 }
 408
 409
 410 /**************************************************************************
 411  *              GetClipboardViewer (USER32.@)
 412  */
 413 HWND WINAPI GetClipboardViewer(void)
 414 {
 415     HWND hWndViewer = 0;
 416
 417     SERVER_START_REQ( set_clipboard_info )
 418     {
 419         req->flags = 0;
 420         if (!wine_server_call_err( req )) hWndViewer = wine_server_ptr_handle( reply->old_viewer );
 421     }
 422     SERVER_END_REQ;
 423
 424     TRACE(" hWndViewer=%p\n", hWndViewer);
 425
 426     return hWndViewer;
 427 }
 428
 429
 430 /**************************************************************************
 431  *              ChangeClipboardChain (USER32.@)
 432  */
 433 BOOL WINAPI ChangeClipboardChain(HWND hWnd, HWND hWndNext)
 434 {
 435     BOOL bRet = TRUE;
 436     HWND hWndViewer = GetClipboardViewer();
 437
 438     if (hWndViewer)
 439     {
 440         if (WIN_GetFullHandle(hWnd) == hWndViewer)
 441             SetClipboardViewer(WIN_GetFullHandle(hWndNext));
 442         else
 443             bRet = !SendMessageW(hWndViewer, WM_CHANGECBCHAIN, (WPARAM)hWnd, (LPARAM)hWndNext);
 444     }
 445     else
 446         ERR("hWndViewer is lost\n");
 447
 448     return bRet;
 449 }
 450
 451
 452 /**************************************************************************
 453  *              SetClipboardData (USER.141)
 454  */
 455 HANDLE16 WINAPI SetClipboardData16(UINT16 wFormat, HANDLE16 hData)
 456 {
 457     CLIPBOARDINFO cbinfo;
 458     HANDLE16 hResult = 0;
 459
 460     TRACE("(%04X, %04x) !\n", wFormat, hData);
 461
 462     /* If it's not owned, data can only be set if the format doesn't exists
 463        and its rendering is not delayed */
 464     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 465         (!(cbinfo.flags & CB_OWNER) && !hData))
 466     {
 467         WARN("Clipboard not owned by calling task. Operation failed.\n");
 468         return 0;
 469     }
 470
 471     if (USER_Driver->pSetClipboardData(wFormat, hData, 0, cbinfo.flags & CB_OWNER))
 472     {
 473         hResult = hData;
 474         bCBHasChanged = TRUE;
 475     }
 476
 477     return hResult;
 478 }
 479
 480
 481 /**************************************************************************
 482  *              SetClipboardData (USER32.@)
 483  */
 484 HANDLE WINAPI SetClipboardData(UINT wFormat, HANDLE hData)
 485 {
 486     CLIPBOARDINFO cbinfo;
 487     HANDLE hResult = 0;
 488
 489     TRACE("(%04X, %p) !\n", wFormat, hData);
 490
 491     /* If it's not owned, data can only be set if the format isn't
 492        available and its rendering is not delayed */
 493     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 494        (!(cbinfo.flags & CB_OWNER) && !hData))
 495     {
 496         WARN("Clipboard not owned by calling task. Operation failed.\n");
 497         return 0;
 498     }
 499
 500     if (USER_Driver->pSetClipboardData(wFormat, 0, hData, cbinfo.flags & CB_OWNER))
 501     {
 502         hResult = hData;
 503         bCBHasChanged = TRUE;
 504     }
 505
 506     return hResult;
 507 }
 508
 509
 510 /**************************************************************************
 511  *              CountClipboardFormats (USER32.@)
 512  */
 513 INT WINAPI CountClipboardFormats(void)
 514 {
 515     INT count = USER_Driver->pCountClipboardFormats();
 516     TRACE("returning %d\n", count);
 517     return count;
 518 }
 519
 520
 521 /**************************************************************************
 522  *              EnumClipboardFormats (USER32.@)
 523  */
 524 UINT WINAPI EnumClipboardFormats(UINT wFormat)
 525 {
 526     CLIPBOARDINFO cbinfo;
 527
 528     TRACE("(%04X)\n", wFormat);
 529
 530     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 531         (~cbinfo.flags & CB_OPEN))
 532     {
 533         WARN("Clipboard not opened by calling task.\n");
 534         SetLastError(ERROR_CLIPBOARD_NOT_OPEN);
 535         return 0;
 536     }
 537     return USER_Driver->pEnumClipboardFormats(wFormat);
 538 }
 539
 540
 541 /**************************************************************************
 542  *              IsClipboardFormatAvailable (USER32.@)
 543  */
 544 BOOL WINAPI IsClipboardFormatAvailable(UINT wFormat)
 545 {
 546     BOOL bret = USER_Driver->pIsClipboardFormatAvailable(wFormat);
 547     TRACE("%04x, returning %d\n", wFormat, bret);
 548     return bret;
 549 }
 550
 551
 552 /**************************************************************************
 553  *              GetClipboardData (USER.142)
 554  */
 555 HANDLE16 WINAPI GetClipboardData16(UINT16 wFormat)
 556 {
 557     HANDLE16 hData = 0;
 558     CLIPBOARDINFO cbinfo;
 559
 560     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 561         (~cbinfo.flags & CB_OPEN))
 562     {
 563         WARN("Clipboard not opened by calling task.\n");
 564         SetLastError(ERROR_CLIPBOARD_NOT_OPEN);
 565         return 0;
 566     }
 567
 568     if (!USER_Driver->pGetClipboardData(wFormat, &hData, NULL)) hData = 0;
 569
 570     return hData;
 571 }
 572
 573
 574 /**************************************************************************
 575  *              GetClipboardData (USER32.@)
 576  */
 577 HANDLE WINAPI GetClipboardData(UINT wFormat)
 578 {
 579     HANDLE hData = 0;
 580     CLIPBOARDINFO cbinfo;
 581
 582     TRACE("%04x\n", wFormat);
 583
 584     if (!CLIPBOARD_GetClipboardInfo(&cbinfo) ||
 585         (~cbinfo.flags & CB_OPEN))
 586     {
 587         WARN("Clipboard not opened by calling task.\n");
 588         SetLastError(ERROR_CLIPBOARD_NOT_OPEN);
 589         return 0;
 590     }
 591
 592     if (!USER_Driver->pGetClipboardData(wFormat, NULL, &hData)) hData = 0;
 593
 594     TRACE("returning %p\n", hData);
 595     return hData;
 596 }
 597
 598
 599 /**************************************************************************
 600  *              GetPriorityClipboardFormat (USER32.@)
 601  */
 602 INT WINAPI GetPriorityClipboardFormat(UINT *list, INT nCount)
 603 {
 604     int i;
 605
 606     TRACE("()\n");
 607
 608     if(CountClipboardFormats() == 0)
 609         return 0;
 610
 611     for (i = 0; i < nCount; i++)
 612         if (IsClipboardFormatAvailable(list[i]))
 613             return list[i];
 614
 615     return -1;
 616 }
 617
 618
 619 /**************************************************************************
 620  *              GetClipboardSequenceNumber (USER32.@)
 621  * Supported on Win2k/Win98
 622  * MSDN: Windows clipboard code keeps a serial number for the clipboard
 623  * for each window station.  The number is incremented whenever the
 624  * contents change or are emptied.
 625  * If you do not have WINSTA_ACCESSCLIPBOARD then the function returns 0
 626  */
 627 DWORD WINAPI GetClipboardSequenceNumber(VOID)
 628 {
 629     DWORD seqno = 0;
 630
 631     SERVER_START_REQ( set_clipboard_info )
 632     {
 633         req->flags = 0;
 634         if (!wine_server_call_err( req )) seqno = reply->seqno;
 635     }
 636     SERVER_END_REQ;
 637
 638     TRACE("returning %x\n", seqno);
 639     return seqno;
 640 }