2 * X11 clipboard windows driver
4 * Copyright 1994 Martin Ayotte
9 * This file contains the X specific implementation for the windows
12 * Wine's internal clipboard is exposed to external apps via the X
13 * selection mechanism.
14 * Currently the driver asserts ownership via two selection atoms:
15 * 1. PRIMARY(XA_PRIMARY)
18 * In our implementation, the CLIPBOARD selection takes precedence over PRIMARY.
19 * i.e. if a CLIPBOARD selection is available, it is used instead of PRIMARY.
20 * When Wine taks ownership of the clipboard, it takes ownership of BOTH selections.
21 * While giving up selection ownership, if the CLIPBOARD selection is lost,
22 * it will lose both PRIMARY and CLIPBOARD and empty the clipboard.
23 * However if only PRIMARY is lost, it will continue to hold the CLIPBOARD selection
24 * (leaving the clipboard cache content unaffected).
26 * Every format exposed via a windows clipboard format is also exposed through
27 * a corresponding X selection target. A selection target atom is synthesized
28 * whenever a new Windows clipboard format is registered via RegisterClipboardFormat,
29 * or when a built in format is used for the first time.
30 * Windows native format are exposed by prefixing the format name with "<WCF>"
31 * This allows us to uniquely identify windows native formats exposed by other
34 * In order to allow external applications to query WINE for supported formats,
35 * we respond to the "TARGETS" selection target. (See EVENT_SelectionRequest
36 * for implementation) We use the same mechanism to query external clients for
37 * availability of a particular format, by cacheing the list of available targets
38 * by using the clipboard cache's "delayed render" mechanism. If a selection client
39 * does not support the "TARGETS" selection target, we actually attempt to retrieve
40 * the format requested as a fallback mechanism.
42 * Certain Windows native formats are automatically converted to X native formats
43 * and vice versa. If a native format is available in the selection, it takes
44 * precedence, in order to avoid unnecessary conversions.
56 #include "clipboard.h"
60 #include "debugtools.h"
62 DEFAULT_DEBUG_CHANNEL(clipboard
);
66 #define S_NOSELECTION 0
70 /* X selection context info */
72 static char _CLIPBOARD
[] = "CLIPBOARD"; /* CLIPBOARD atom name */
73 static char FMT_PREFIX
[] = "<WCF>"; /* Prefix for windows specific formats */
74 static int selectionAcquired
= 0; /* Contains the current selection masks */
75 static Window selectionWindow
= None
; /* The top level X window which owns the selection */
76 static Window selectionPrevWindow
= None
; /* The last X window that owned the selection */
77 static Window PrimarySelectionOwner
= None
; /* The window which owns the primary selection */
78 static Window ClipboardSelectionOwner
= None
; /* The window which owns the clipboard selection */
79 static unsigned long cSelectionTargets
= 0; /* Number of target formats reported by TARGETS selection */
80 static Atom selectionCacheSrc
= XA_PRIMARY
; /* The selection source from which the clipboard cache was filled */
81 static HANDLE selectionClearEvent
= 0;/* Synchronization object used to block until server is started */
83 typedef struct tagPROPERTY
85 struct tagPROPERTY
*next
;
90 static PROPERTY
*prop_head
;
93 /**************************************************************************
94 * X11DRV_CLIPBOARD_MapPropertyToFormat
96 * Map an X selection property type atom name to a windows clipboard format ID
98 UINT
X11DRV_CLIPBOARD_MapPropertyToFormat(char *itemFmtName
)
101 * If the property name starts with FMT_PREFIX strip this off and
102 * get the ID for a custom Windows registered format with this name.
103 * We can also understand STRING, PIXMAP and BITMAP.
105 if ( NULL
== itemFmtName
)
107 else if ( 0 == strncmp(itemFmtName
, FMT_PREFIX
, strlen(FMT_PREFIX
)) )
108 return RegisterClipboardFormatA(itemFmtName
+ strlen(FMT_PREFIX
));
109 else if ( 0 == strcmp(itemFmtName
, "STRING") )
110 return CF_UNICODETEXT
;
111 else if ( 0 == strcmp(itemFmtName
, "PIXMAP")
112 || 0 == strcmp(itemFmtName
, "BITMAP") )
115 * Return CF_DIB as first preference, if WINE is the selection owner
116 * and if CF_DIB exists in the cache.
117 * If wine dowsn't own the selection we always return CF_DIB
119 if ( !X11DRV_IsSelectionOwner() )
121 else if ( CLIPBOARD_IsPresent(CF_DIB
) )
127 WARN("\tNo mapping to Windows clipboard format for property %s\n", itemFmtName
);
131 /**************************************************************************
132 * X11DRV_CLIPBOARD_MapFormatToProperty
134 * Map a windows clipboard format ID to an X selection property atom
136 Atom
X11DRV_CLIPBOARD_MapFormatToProperty(UINT wFormat
)
142 /* We support only CF_UNICODETEXT, other formats are synthesized */
155 * Request a PIXMAP, only if WINE is NOT the selection owner,
156 * AND the requested format is not in the cache.
158 if ( !X11DRV_IsSelectionOwner() && !CLIPBOARD_IsPresent(wFormat
) )
163 /* Fall thru to the default case in order to use the native format */
169 * If an X atom is registered for this format, return that
170 * Otherwise register a new atom.
173 char *fmtName
= CLIPBOARD_GetFormatName(wFormat
);
174 strcpy(str
, FMT_PREFIX
);
178 strncat(str
, fmtName
, sizeof(str
) - strlen(FMT_PREFIX
));
179 prop
= TSXInternAtom(display
, str
, False
);
186 TRACE("\tNo mapping to X property for Windows clipboard format %d(%s)\n",
187 wFormat
, CLIPBOARD_GetFormatName(wFormat
));
192 /**************************************************************************
193 * X11DRV_CLIPBOARD_IsNativeProperty
195 * Checks if a property is a native Wine property type
197 BOOL
X11DRV_CLIPBOARD_IsNativeProperty(Atom prop
)
199 char *itemFmtName
= TSXGetAtomName(display
, prop
);
202 if ( 0 == strncmp(itemFmtName
, FMT_PREFIX
, strlen(FMT_PREFIX
)) )
205 TSXFree(itemFmtName
);
210 /**************************************************************************
211 * X11DRV_CLIPBOARD_LaunchServer
212 * Launches the clipboard server. This is called from X11DRV_CLIPBOARD_ResetOwner
213 * when the selection can no longer be recyled to another top level window.
214 * In order to make the selection persist after Wine shuts down a server
215 * process is launched which services subsequent selection requests.
217 BOOL
X11DRV_CLIPBOARD_LaunchServer()
221 /* If persistant selection has been disabled in the .winerc Clipboard section,
222 * don't launch the server
224 if ( !PROFILE_GetWineIniInt("Clipboard", "PersistentSelection", 1) )
227 /* Start up persistant WINE X clipboard server process which will
228 * take ownership of the X selection and continue to service selection
229 * requests from other apps.
231 selectionWindow
= selectionPrevWindow
;
234 /* NOTE: This code only executes in the context of the child process
235 * Do note make any Wine specific calls here.
239 char selMask
[8], dbgClassMask
[8], clearSelection
[8];
242 /* Don't inherit wine's X sockets to the wineclipsrv, otherwise
243 * windows stay around when you have to kill a hanging wine...
245 for (i
= 3; i
< 256; ++i
)
246 fcntl(i
, F_SETFD
, 1);
248 sprintf(selMask
, "%d", selectionAcquired
);
250 /* Build the debug class mask to pass to the server, by inheriting
251 * the settings for the clipboard debug channel.
253 dbgClasses
|= FIXME_ON(clipboard
) ? 1 : 0;
254 dbgClasses
|= ERR_ON(clipboard
) ? 2 : 0;
255 dbgClasses
|= WARN_ON(clipboard
) ? 4 : 0;
256 dbgClasses
|= TRACE_ON(clipboard
) ? 8 : 0;
257 sprintf(dbgClassMask
, "%d", dbgClasses
);
259 /* Get the clear selection preference */
260 sprintf(clearSelection
, "%d",
261 PROFILE_GetWineIniInt("Clipboard", "ClearAllSelections", 0));
263 /* Exec the clipboard server passing it the selection and debug class masks */
264 execl( BINDIR
"/wineclipsrv", "wineclipsrv",
265 selMask
, dbgClassMask
, clearSelection
, NULL
);
266 execlp( "wineclipsrv", "wineclipsrv", selMask
, dbgClassMask
, clearSelection
, NULL
);
267 execl( "./windows/x11drv/wineclipsrv", "wineclipsrv",
268 selMask
, dbgClassMask
, clearSelection
, NULL
);
271 perror("Could not start Wine clipboard server");
272 exit( 1 ); /* Exit the child process */
275 /* Wait until the clipboard server acquires the selection.
276 * We must release the windows lock to enable Wine to process
277 * selection messages in response to the servers requests.
280 iWndsLocks
= WIN_SuspendWndsLock();
282 /* We must wait until the server finishes acquiring the selection,
283 * before proceeding, otherwise the window which owns the selection
284 * will be destroyed prematurely!
285 * Create a non-signalled, auto-reset event which will be set by
286 * X11DRV_CLIPBOARD_ReleaseSelection, and wait until this gets
287 * signalled before proceeding.
290 if ( !(selectionClearEvent
= CreateEventA(NULL
, FALSE
, FALSE
, NULL
)) )
291 ERR("Could not create wait object. Clipboard server won't start!\n");
294 /* Wait until we lose the selection, timing out after a minute */
296 TRACE("Waiting for clipboard server to acquire selection\n");
298 if ( WaitForSingleObject( selectionClearEvent
, 60000 ) != WAIT_OBJECT_0
)
299 TRACE("Server could not acquire selection, or a timeout occurred!\n");
301 TRACE("Server successfully acquired selection\n");
303 /* Release the event */
304 CloseHandle(selectionClearEvent
);
305 selectionClearEvent
= 0;
308 WIN_RestoreWndsLock(iWndsLocks
);
314 /**************************************************************************
315 * X11DRV_CLIPBOARD_CacheDataFormats
317 * Caches the list of data formats available from the current selection.
318 * This queries the selection owner for the TARGETS property and saves all
319 * reported property types.
321 int X11DRV_CLIPBOARD_CacheDataFormats( Atom SelectionName
)
324 HWND hWndClipWindow
= GetOpenClipboardWindow();
328 Atom atype
=AnyPropertyType
;
330 unsigned long remain
;
331 Atom
* targetList
=NULL
;
333 Window ownerSelection
= 0;
337 * Empty the clipboard cache
339 CLIPBOARD_EmptyCache(TRUE
);
341 cSelectionTargets
= 0;
342 selectionCacheSrc
= SelectionName
;
344 hWnd
= (hWndClipWindow
) ? hWndClipWindow
: GetActiveWindow();
346 ownerSelection
= TSXGetSelectionOwner(display
, SelectionName
);
347 if ( !hWnd
|| (ownerSelection
== None
) )
348 return cSelectionTargets
;
351 * Query the selection owner for the TARGETS property
353 wnd
= WIN_FindWndPtr(hWnd
);
354 w
= X11DRV_WND_FindXWindow(wnd
);
355 WIN_ReleaseWndPtr(wnd
);
358 aTargets
= TSXInternAtom(display
, "TARGETS", False
);
360 TRACE("Requesting TARGETS selection for '%s' (owner=%08x)...\n",
361 TSXGetAtomName(display
, selectionCacheSrc
), (unsigned)ownerSelection
);
363 XConvertSelection(display
, selectionCacheSrc
, aTargets
,
364 TSXInternAtom(display
, "SELECTION_DATA", False
),
368 * Wait until SelectionNotify is received
372 if( XCheckTypedWindowEvent(display
, w
, SelectionNotify
, &xe
) )
373 if( xe
.xselection
.selection
== selectionCacheSrc
)
378 /* Verify that the selection returned a valid TARGETS property */
379 if ( (xe
.xselection
.target
!= aTargets
)
380 || (xe
.xselection
.property
== None
) )
382 TRACE("\tExit, could not retrieve TARGETS\n");
383 return cSelectionTargets
;
386 /* Read the TARGETS property contents */
387 if(TSXGetWindowProperty(display
, xe
.xselection
.requestor
, xe
.xselection
.property
,
388 0, 0x3FFF, True
, AnyPropertyType
/*XA_ATOM*/, &atype
, &aformat
,
389 &cSelectionTargets
, &remain
, (unsigned char**)&targetList
) != Success
)
390 TRACE("\tCouldn't read TARGETS property\n");
393 TRACE("\tType %s,Format %d,nItems %ld, Remain %ld\n",
394 TSXGetAtomName(display
,atype
),aformat
,cSelectionTargets
, remain
);
396 * The TARGETS property should have returned us a list of atoms
397 * corresponding to each selection target format supported.
399 if( (atype
== XA_ATOM
|| atype
== aTargets
) && aformat
== 32 )
402 LPWINE_CLIPFORMAT lpFormat
;
404 /* Cache these formats in the clipboard cache */
406 for (i
= 0; i
< cSelectionTargets
; i
++)
408 char *itemFmtName
= TSXGetAtomName(display
, targetList
[i
]);
409 UINT wFormat
= X11DRV_CLIPBOARD_MapPropertyToFormat(itemFmtName
);
412 * If the clipboard format maps to a Windows format, simply store
413 * the atom identifier and record its availablity status
414 * in the clipboard cache.
418 lpFormat
= CLIPBOARD_LookupFormat( wFormat
);
420 /* Don't replace if the property already cached is a native format,
421 * or if a PIXMAP is being replaced by a BITMAP.
423 if (lpFormat
->wDataPresent
&&
424 ( X11DRV_CLIPBOARD_IsNativeProperty(lpFormat
->drvData
)
425 || (lpFormat
->drvData
== XA_PIXMAP
&& targetList
[i
] == XA_BITMAP
) )
428 TRACE("\tAtom# %d: '%s' --> FormatID(%d) %s (Skipped)\n",
429 i
, itemFmtName
, wFormat
, lpFormat
->Name
);
433 lpFormat
->wDataPresent
= 1;
434 lpFormat
->drvData
= targetList
[i
];
435 TRACE("\tAtom# %d: '%s' --> FormatID(%d) %s\n",
436 i
, itemFmtName
, wFormat
, lpFormat
->Name
);
440 TSXFree(itemFmtName
);
444 /* Free the list of targets */
448 return cSelectionTargets
;
451 /**************************************************************************
452 * X11DRV_CLIPBOARD_ReadSelection
453 * Reads the contents of the X selection property into the WINE clipboard cache
454 * converting the selection into a format compatible with the windows clipboard
456 * This method is invoked only to read the contents of a the selection owned
457 * by an external application. i.e. when we do not own the X selection.
459 static BOOL
X11DRV_CLIPBOARD_ReadSelection(UINT wFormat
, Window w
, Atom prop
, Atom reqType
)
461 Atom atype
=AnyPropertyType
;
463 unsigned long nitems
,remain
,itemSize
;
465 unsigned char* val
=NULL
;
466 LPWINE_CLIPFORMAT lpFormat
;
468 HWND hWndClipWindow
= GetOpenClipboardWindow();
474 TRACE("Reading X selection...\n");
476 TRACE("\tretrieving property %s from window %ld into %s\n",
477 TSXGetAtomName(display
,reqType
), (long)w
, TSXGetAtomName(display
,prop
) );
480 * First request a zero length in order to figure out the request size.
482 if(TSXGetWindowProperty(display
,w
,prop
,0,0,False
, AnyPropertyType
/*reqType*/,
483 &atype
, &aformat
, &nitems
, &itemSize
, &val
) != Success
)
485 WARN("\tcouldn't get property size\n");
489 /* Free zero length return data if any */
496 TRACE("\tretrieving %ld bytes...\n", itemSize
* aformat
/8);
497 lRequestLength
= (itemSize
* aformat
/8)/4 + 1;
500 * Retrieve the actual property in the required X format.
502 if(TSXGetWindowProperty(display
,w
,prop
,0,lRequestLength
,False
,AnyPropertyType
/*reqType*/,
503 &atype
, &aformat
, &nitems
, &remain
, &val
) != Success
)
505 WARN("\tcouldn't read property\n");
509 TRACE("\tType %s,Format %d,nitems %ld,remain %ld,value %s\n",
510 atype
? TSXGetAtomName(display
,atype
) : NULL
, aformat
,nitems
,remain
,val
);
514 WARN("\tCouldn't read entire property- selection may be too large! Remain=%ld\n", remain
);
519 * Translate the X property into the appropriate Windows clipboard
520 * format, if possible.
522 if ( (reqType
== XA_STRING
)
523 && (atype
== XA_STRING
) && (aformat
== 8) )
524 /* convert Unix text to CF_UNICODETEXT */
529 TRACE("\tselection is '%s'\n",val
);
531 for(i
=0; i
<= nitems
; i
++)
532 if( val
[i
] == '\n' ) inlcount
++;
534 if( (lpstr
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, nitems
+ inlcount
+ 1)) )
536 static UINT text_cp
= (UINT
)-1;
540 for(i
=0,inlcount
=0; i
<= nitems
; i
++)
542 if( val
[i
] == '\n' ) lpstr
[inlcount
++]='\r';
543 lpstr
[inlcount
++]=val
[i
];
546 if(text_cp
== (UINT
)-1)
547 text_cp
= PROFILE_GetWineIniInt("x11drv", "TextCP", CP_ACP
);
549 count
= MultiByteToWideChar(text_cp
, 0, lpstr
, -1, NULL
, 0);
550 hUnicodeText
= GlobalAlloc(GMEM_MOVEABLE
| GMEM_DDESHARE
, count
* sizeof(WCHAR
));
553 WCHAR
*textW
= GlobalLock(hUnicodeText
);
554 MultiByteToWideChar(text_cp
, 0, lpstr
, -1, textW
, count
);
555 GlobalUnlock(hUnicodeText
);
556 SetClipboardData(CF_UNICODETEXT
, hUnicodeText
);
559 HeapFree(GetProcessHeap(), 0, lpstr
);
562 else if ( reqType
== XA_PIXMAP
|| reqType
== XA_BITMAP
) /* treat PIXMAP as CF_DIB or CF_BITMAP */
564 /* Get the first pixmap handle passed to us */
565 Pixmap
*pPixmap
= (Pixmap
*)val
;
566 HANDLE hTargetImage
= 0; /* Handle to store the converted bitmap or DIB */
568 if (aformat
!= 32 || nitems
< 1 || atype
!= XA_PIXMAP
569 || (wFormat
!= CF_BITMAP
&& wFormat
!= CF_DIB
))
571 WARN("\tUnimplemented format conversion request\n");
575 if ( wFormat
== CF_BITMAP
)
577 /* For CF_BITMAP requests we must return an HBITMAP */
578 hTargetImage
= X11DRV_BITMAP_CreateBitmapFromPixmap(*pPixmap
, TRUE
);
580 else if (wFormat
== CF_DIB
)
582 HWND hwnd
= GetOpenClipboardWindow();
583 HDC hdc
= GetDC(hwnd
);
585 /* For CF_DIB requests we must return an HGLOBAL storing a packed DIB */
586 hTargetImage
= X11DRV_DIB_CreateDIBFromPixmap(*pPixmap
, hdc
, TRUE
);
588 ReleaseDC(hdc
, hwnd
);
593 WARN("PIXMAP conversion failed!\n" );
597 /* Delete previous clipboard data */
598 lpFormat
= CLIPBOARD_LookupFormat(wFormat
);
599 if (lpFormat
->wDataPresent
&& (lpFormat
->hData16
|| lpFormat
->hData32
))
600 CLIPBOARD_DeleteRecord(lpFormat
, !(hWndClipWindow
));
602 /* Update the clipboard record */
603 lpFormat
->wDataPresent
= 1;
604 lpFormat
->hData32
= hTargetImage
;
605 lpFormat
->hData16
= 0;
610 /* For native properties simply copy the X data without conversion */
611 else if (X11DRV_CLIPBOARD_IsNativeProperty(reqType
)) /* <WCF>* */
613 HANDLE hClipData
= 0;
615 int cBytes
= nitems
* aformat
/8;
619 /* Turn on the DDESHARE flag to enable shared 32 bit memory */
620 hClipData
= GlobalAlloc(GMEM_MOVEABLE
| GMEM_DDESHARE
, cBytes
);
621 if( (lpClipData
= GlobalLock(hClipData
)) )
623 memcpy(lpClipData
, val
, cBytes
);
624 GlobalUnlock(hClipData
);
632 /* delete previous clipboard record if any */
633 lpFormat
= CLIPBOARD_LookupFormat(wFormat
);
634 if (lpFormat
->wDataPresent
|| lpFormat
->hData16
|| lpFormat
->hData32
)
635 CLIPBOARD_DeleteRecord(lpFormat
, !(hWndClipWindow
));
637 /* Update the clipboard record */
638 lpFormat
->wDataPresent
= 1;
639 lpFormat
->hData32
= hClipData
;
640 lpFormat
->hData16
= 0;
647 WARN("\tUnimplemented format conversion request\n");
652 /* Delete the property on the window now that we are done
653 * This will send a PropertyNotify event to the selection owner. */
654 TSXDeleteProperty(display
,w
,prop
);
656 /* Free the retrieved property data */
663 /**************************************************************************
664 * X11DRV_CLIPBOARD_ReleaseSelection
666 * Release an XA_PRIMARY or XA_CLIPBOARD selection that we own, in response
667 * to a SelectionClear event.
668 * This can occur in response to another client grabbing the X selection.
669 * If the XA_CLIPBOARD selection is lost, we relinquish XA_PRIMARY as well.
671 void X11DRV_CLIPBOARD_ReleaseSelection(Atom selType
, Window w
, HWND hwnd
)
673 Atom xaClipboard
= TSXInternAtom(display
, "CLIPBOARD", False
);
674 int clearAllSelections
= PROFILE_GetWineIniInt("Clipboard", "ClearAllSelections", 0);
676 /* w is the window that lost the selection
677 * selectionPrevWindow is nonzero if CheckSelection() was called.
680 TRACE("\tevent->window = %08x (sw = %08x, spw=%08x)\n",
681 (unsigned)w
, (unsigned)selectionWindow
, (unsigned)selectionPrevWindow
);
683 if( selectionAcquired
)
685 if( w
== selectionWindow
|| selectionPrevWindow
== None
)
687 /* If we're losing the CLIPBOARD selection, or if the preferences in .winerc
688 * dictate that *all* selections should be cleared on loss of a selection,
689 * we must give up all the selections we own.
691 if ( clearAllSelections
|| (selType
== xaClipboard
) )
693 /* completely give up the selection */
694 TRACE("Lost CLIPBOARD (+PRIMARY) selection\n");
696 /* We are completely giving up the selection.
697 * Make sure we can open the windows clipboard first. */
699 if ( !OpenClipboard(hwnd
) )
702 * We can't empty the clipboard if we cant open it so abandon.
703 * Wine will think that it still owns the selection but this is
704 * safer than losing the selection without properly emptying
705 * the clipboard. Perhaps we should forcibly re-assert ownership
706 * of the CLIPBOARD selection in this case...
708 ERR("\tClipboard is busy. Could not give up selection!\n");
712 /* We really lost CLIPBOARD but want to voluntarily lose PRIMARY */
713 if ( (selType
== xaClipboard
)
714 && (selectionAcquired
& S_PRIMARY
) )
716 XSetSelectionOwner(display
, XA_PRIMARY
, None
, CurrentTime
);
719 /* We really lost PRIMARY but want to voluntarily lose CLIPBOARD */
720 if ( (selType
== XA_PRIMARY
)
721 && (selectionAcquired
& S_CLIPBOARD
) )
723 XSetSelectionOwner(display
, xaClipboard
, None
, CurrentTime
);
726 selectionWindow
= None
;
727 PrimarySelectionOwner
= ClipboardSelectionOwner
= 0;
729 /* Empty the windows clipboard.
730 * We should pretend that we still own the selection BEFORE calling
731 * EmptyClipboard() since otherwise this has the side effect of
732 * triggering X11DRV_CLIPBOARD_Acquire() and causing the X selection
733 * to be re-acquired by us!
735 selectionAcquired
= (S_PRIMARY
| S_CLIPBOARD
);
739 /* Give up ownership of the windows clipboard */
740 CLIPBOARD_ReleaseOwner();
742 /* Reset the selection flags now that we are done */
743 selectionAcquired
= S_NOSELECTION
;
745 else if ( selType
== XA_PRIMARY
) /* Give up only PRIMARY selection */
747 TRACE("Lost PRIMARY selection\n");
748 PrimarySelectionOwner
= 0;
749 selectionAcquired
&= ~S_PRIMARY
; /* clear S_PRIMARY mask */
752 cSelectionTargets
= 0;
754 /* but we'll keep existing data for internal use */
755 else if( w
== selectionPrevWindow
)
757 Atom xaClipboard
= TSXInternAtom(display
, _CLIPBOARD
, False
);
759 w
= TSXGetSelectionOwner(display
, XA_PRIMARY
);
761 TSXSetSelectionOwner(display
, XA_PRIMARY
, selectionWindow
, CurrentTime
);
763 w
= TSXGetSelectionOwner(display
, xaClipboard
);
765 TSXSetSelectionOwner(display
, xaClipboard
, selectionWindow
, CurrentTime
);
769 /* Signal to a selectionClearEvent listener if the selection is completely lost */
770 if (selectionClearEvent
&& !selectionAcquired
)
772 TRACE("Lost all selections, signalling to selectionClearEvent listener\n");
773 SetEvent(selectionClearEvent
);
776 selectionPrevWindow
= None
;
779 /**************************************************************************
780 * ReleaseClipboard (X11DRV.@)
781 * Voluntarily release all currently owned X selections
783 void X11DRV_ReleaseClipboard(void)
785 if( selectionAcquired
)
788 Window savePrevWindow
= selectionWindow
;
789 Atom xaClipboard
= TSXInternAtom(display
, _CLIPBOARD
, False
);
790 BOOL bHasPrimarySelection
= selectionAcquired
& S_PRIMARY
;
792 selectionAcquired
= S_NOSELECTION
;
793 selectionPrevWindow
= selectionWindow
;
794 selectionWindow
= None
;
796 TRACE("\tgiving up selection (spw = %08x)\n",
797 (unsigned)selectionPrevWindow
);
801 TRACE("Releasing CLIPBOARD selection\n");
802 XSetSelectionOwner(display
, xaClipboard
, None
, CurrentTime
);
803 if( selectionPrevWindow
)
804 while( !XCheckTypedWindowEvent( display
, selectionPrevWindow
,
805 SelectionClear
, &xe
) );
807 if ( bHasPrimarySelection
)
809 TRACE("Releasing XA_PRIMARY selection\n");
810 selectionPrevWindow
= savePrevWindow
; /* May be cleared in X11DRV_CLIPBOARD_ReleaseSelection */
811 XSetSelectionOwner(display
, XA_PRIMARY
, None
, CurrentTime
);
813 if( selectionPrevWindow
)
814 while( !XCheckTypedWindowEvent( display
, selectionPrevWindow
,
815 SelectionClear
, &xe
) );
820 /* Get rid of any Pixmap resources we may still have */
823 PROPERTY
*prop
= prop_head
;
824 prop_head
= prop
->next
;
825 XFreePixmap( display
, prop
->pixmap
);
826 HeapFree( GetProcessHeap(), 0, prop
);
830 /**************************************************************************
831 * AcquireClipboard (X11DRV.@)
833 void X11DRV_AcquireClipboard(void)
836 HWND hWndClipWindow
= GetOpenClipboardWindow();
839 * Acquire X selection if we don't already own it.
840 * Note that we only acquire the selection if it hasn't been already
841 * acquired by us, and ignore the fact that another X window may be
842 * asserting ownership. The reason for this is we need *any* top level
843 * X window to hold selection ownership. The actual clipboard data requests
844 * are made via GetClipboardData from EVENT_SelectionRequest and this
845 * ensures that the real HWND owner services the request.
846 * If the owning X window gets destroyed the selection ownership is
847 * re-cycled to another top level X window in X11DRV_CLIPBOARD_ResetOwner.
851 if ( !(selectionAcquired
== (S_PRIMARY
| S_CLIPBOARD
)) )
853 Atom xaClipboard
= TSXInternAtom(display
, _CLIPBOARD
, False
);
854 WND
*tmpWnd
= WIN_FindWndPtr( hWndClipWindow
? hWndClipWindow
: AnyPopup() );
855 owner
= X11DRV_WND_FindXWindow(tmpWnd
);
856 WIN_ReleaseWndPtr(tmpWnd
);
858 /* Grab PRIMARY selection if not owned */
859 if ( !(selectionAcquired
& S_PRIMARY
) )
860 TSXSetSelectionOwner(display
, XA_PRIMARY
, owner
, CurrentTime
);
862 /* Grab CLIPBOARD selection if not owned */
863 if ( !(selectionAcquired
& S_CLIPBOARD
) )
864 TSXSetSelectionOwner(display
, xaClipboard
, owner
, CurrentTime
);
866 if( TSXGetSelectionOwner(display
,XA_PRIMARY
) == owner
)
867 selectionAcquired
|= S_PRIMARY
;
869 if( TSXGetSelectionOwner(display
,xaClipboard
) == owner
)
870 selectionAcquired
|= S_CLIPBOARD
;
872 if (selectionAcquired
)
874 selectionWindow
= owner
;
875 TRACE("Grabbed X selection, owner=(%08x)\n", (unsigned) owner
);
880 /**************************************************************************
881 * IsClipboardFormatAvailable (X11DRV.@)
883 * Checks if the specified format is available in the current selection
884 * Only invoked when WINE is not the selection owner
886 BOOL
X11DRV_IsClipboardFormatAvailable(UINT wFormat
)
888 Atom xaClipboard
= TSXInternAtom(display
, _CLIPBOARD
, False
);
889 Window ownerPrimary
= TSXGetSelectionOwner(display
,XA_PRIMARY
);
890 Window ownerClipboard
= TSXGetSelectionOwner(display
,xaClipboard
);
892 TRACE("enter for %d\n", wFormat
);
895 * If the selection has not been previously cached, or the selection has changed,
896 * try and cache the list of available selection targets from the current selection.
898 if ( !cSelectionTargets
|| (PrimarySelectionOwner
!= ownerPrimary
)
899 || (ClipboardSelectionOwner
!= ownerClipboard
) )
902 * First try cacheing the CLIPBOARD selection.
903 * If unavailable try PRIMARY.
905 if ( X11DRV_CLIPBOARD_CacheDataFormats(xaClipboard
) == 0 )
907 X11DRV_CLIPBOARD_CacheDataFormats(XA_PRIMARY
);
910 ClipboardSelectionOwner
= ownerClipboard
;
911 PrimarySelectionOwner
= ownerPrimary
;
914 /* Exit if there is no selection */
915 if ( !ownerClipboard
&& !ownerPrimary
)
917 TRACE("There is no selection owner\n");
921 /* Check if the format is available in the clipboard cache */
922 if ( CLIPBOARD_IsPresent(wFormat
) )
926 * Many X client apps (such as XTerminal) don't support being queried
927 * for the "TARGETS" target atom. To handle such clients we must actually
928 * try to convert the selection to the requested type.
930 if ( !cSelectionTargets
)
931 return X11DRV_GetClipboardData( wFormat
);
933 TRACE("There is no selection\n");
937 /**************************************************************************
938 * RegisterClipboardFormat (X11DRV.@)
940 * Registers a custom X clipboard format
941 * Returns: TRUE - success, FALSE - failure
943 BOOL
X11DRV_RegisterClipboardFormat( LPCSTR FormatName
)
949 * If an X atom is registered for this format, return that
950 * Otherwise register a new atom.
954 /* Add a WINE specific prefix to the format */
955 strcpy(str
, FMT_PREFIX
);
956 strncat(str
, FormatName
, sizeof(str
) - strlen(FMT_PREFIX
));
957 prop
= TSXInternAtom(display
, str
, False
);
960 return (prop
) ? TRUE
: FALSE
;
963 /**************************************************************************
964 * IsSelectionOwner (X11DRV.@)
966 * Returns: TRUE - We(WINE) own the selection, FALSE - Selection not owned by us
968 BOOL
X11DRV_IsSelectionOwner(void)
970 return selectionAcquired
;
973 /**************************************************************************
974 * SetClipboardData (X11DRV.@)
976 * We don't need to do anything special here since the clipboard code
977 * maintains the cache.
980 void X11DRV_SetClipboardData(UINT wFormat
)
982 /* Make sure we have acquired the X selection */
983 X11DRV_AcquireClipboard();
986 /**************************************************************************
987 * GetClipboardData (X11DRV.@)
989 * This method is invoked only when we DO NOT own the X selection
991 * NOTE: Clipboard driver get requests only for CF_UNICODETEXT data.
992 * We always get the data from the selection client each time,
993 * since we have no way of determining if the data in our cache is stale.
995 BOOL
X11DRV_GetClipboardData(UINT wFormat
)
997 BOOL bRet
= selectionAcquired
;
998 HWND hWndClipWindow
= GetOpenClipboardWindow();
999 HWND hWnd
= (hWndClipWindow
) ? hWndClipWindow
: GetActiveWindow();
1001 LPWINE_CLIPFORMAT lpFormat
;
1003 TRACE("%d\n", wFormat
);
1005 if( !selectionAcquired
&& (wnd
= WIN_FindWndPtr(hWnd
)) )
1009 Window w
= X11DRV_WND_FindXWindow(wnd
);
1010 WIN_ReleaseWndPtr(wnd
);
1013 /* Map the format ID requested to an X selection property.
1014 * If the format is in the cache, use the atom associated
1018 lpFormat
= CLIPBOARD_LookupFormat( wFormat
);
1019 if (lpFormat
&& lpFormat
->wDataPresent
&& lpFormat
->drvData
)
1020 propRequest
= (Atom
)lpFormat
->drvData
;
1022 propRequest
= X11DRV_CLIPBOARD_MapFormatToProperty(wFormat
);
1026 TRACE("Requesting %s selection from %s...\n",
1027 TSXGetAtomName(display
, propRequest
),
1028 TSXGetAtomName(display
, selectionCacheSrc
) );
1030 XConvertSelection(display
, selectionCacheSrc
, propRequest
,
1031 TSXInternAtom(display
, "SELECTION_DATA", False
),
1034 /* wait until SelectionNotify is received */
1038 if( XCheckTypedWindowEvent(display
, w
, SelectionNotify
, &xe
) )
1039 if( xe
.xselection
.selection
== selectionCacheSrc
)
1042 wine_tsx11_unlock();
1045 * Read the contents of the X selection property into WINE's
1046 * clipboard cache converting the selection to be compatible if possible.
1048 bRet
= X11DRV_CLIPBOARD_ReadSelection( wFormat
,
1049 xe
.xselection
.requestor
,
1050 xe
.xselection
.property
,
1051 xe
.xselection
.target
);
1056 TRACE("\tpresent %s = %i\n", CLIPBOARD_GetFormatName(wFormat
), bRet
);
1059 TRACE("Returning %d\n", bRet
);
1064 /**************************************************************************
1065 * ResetSelectionOwner (X11DRV.@)
1067 * Called from DestroyWindow() to prevent X selection from being lost when
1068 * a top level window is destroyed, by switching ownership to another top
1070 * Any top level window can own the selection. See X11DRV_CLIPBOARD_Acquire
1071 * for a more detailed description of this.
1073 void X11DRV_ResetSelectionOwner(WND
*pWnd
, BOOL bFooBar
)
1075 HWND hWndClipOwner
= 0;
1076 Window XWnd
= X11DRV_WND_GetXWindow(pWnd
);
1078 BOOL bLostSelection
= FALSE
;
1080 /* There is nothing to do if we don't own the selection,
1081 * or if the X window which currently owns the selecion is different
1082 * from the one passed in.
1084 if ( !selectionAcquired
|| XWnd
!= selectionWindow
1085 || selectionWindow
== None
)
1088 if ( (bFooBar
&& XWnd
) || (!bFooBar
&& !XWnd
) )
1091 hWndClipOwner
= GetClipboardOwner();
1092 xaClipboard
= TSXInternAtom(display
, _CLIPBOARD
, False
);
1094 TRACE("clipboard owner = %04x, selection window = %08x\n",
1095 hWndClipOwner
, (unsigned)selectionWindow
);
1097 /* now try to salvage current selection from being destroyed by X */
1099 TRACE("\tchecking %08x\n", (unsigned) XWnd
);
1101 selectionPrevWindow
= selectionWindow
;
1102 selectionWindow
= None
;
1105 selectionWindow
= X11DRV_WND_GetXWindow(pWnd
->next
);
1106 else if( pWnd
->parent
)
1107 if( pWnd
->parent
->child
!= pWnd
)
1108 selectionWindow
= X11DRV_WND_GetXWindow(pWnd
->parent
->child
);
1110 if( selectionWindow
!= None
)
1112 /* We must pretend that we don't own the selection while making the switch
1113 * since a SelectionClear event will be sent to the last owner.
1114 * If there is no owner X11DRV_CLIPBOARD_ReleaseSelection will do nothing.
1116 int saveSelectionState
= selectionAcquired
;
1117 selectionAcquired
= False
;
1119 TRACE("\tswitching selection from %08x to %08x\n",
1120 (unsigned)selectionPrevWindow
, (unsigned)selectionWindow
);
1122 /* Assume ownership for the PRIMARY and CLIPBOARD selection */
1123 if ( saveSelectionState
& S_PRIMARY
)
1124 TSXSetSelectionOwner(display
, XA_PRIMARY
, selectionWindow
, CurrentTime
);
1126 TSXSetSelectionOwner(display
, xaClipboard
, selectionWindow
, CurrentTime
);
1128 /* Restore the selection masks */
1129 selectionAcquired
= saveSelectionState
;
1131 /* Lose the selection if something went wrong */
1132 if ( ( (saveSelectionState
& S_PRIMARY
) &&
1133 (TSXGetSelectionOwner(display
, XA_PRIMARY
) != selectionWindow
) )
1134 || (TSXGetSelectionOwner(display
, xaClipboard
) != selectionWindow
) )
1136 bLostSelection
= TRUE
;
1141 /* Update selection state */
1142 if (saveSelectionState
& S_PRIMARY
)
1143 PrimarySelectionOwner
= selectionWindow
;
1145 ClipboardSelectionOwner
= selectionWindow
;
1150 bLostSelection
= TRUE
;
1157 /* Launch the clipboard server if the selection can no longer be recyled
1158 * to another top level window. */
1160 if ( !X11DRV_CLIPBOARD_LaunchServer() )
1162 /* Empty the windows clipboard if the server was not launched.
1163 * We should pretend that we still own the selection BEFORE calling
1164 * EmptyClipboard() since otherwise this has the side effect of
1165 * triggering X11DRV_CLIPBOARD_Acquire() and causing the X selection
1166 * to be re-acquired by us!
1169 TRACE("\tLost the selection! Emptying the clipboard...\n");
1172 selectionAcquired
= (S_PRIMARY
| S_CLIPBOARD
);
1177 /* Give up ownership of the windows clipboard */
1178 CLIPBOARD_ReleaseOwner();
1181 selectionAcquired
= S_NOSELECTION
;
1182 ClipboardSelectionOwner
= PrimarySelectionOwner
= 0;
1183 selectionWindow
= 0;
1187 /**************************************************************************
1188 * X11DRV_CLIPBOARD_RegisterPixmapResource
1189 * Registers a Pixmap resource which is to be associated with a property Atom.
1190 * When the property is destroyed we also destroy the Pixmap through the
1191 * PropertyNotify event.
1193 BOOL
X11DRV_CLIPBOARD_RegisterPixmapResource( Atom property
, Pixmap pixmap
)
1195 PROPERTY
*prop
= HeapAlloc( GetProcessHeap(), 0, sizeof(*prop
) );
1196 if (!prop
) return FALSE
;
1197 prop
->atom
= property
;
1198 prop
->pixmap
= pixmap
;
1199 prop
->next
= prop_head
;
1204 /**************************************************************************
1205 * X11DRV_CLIPBOARD_FreeResources
1207 * Called from EVENT_PropertyNotify() to give us a chance to destroy
1208 * any resources associated with this property.
1210 void X11DRV_CLIPBOARD_FreeResources( Atom property
)
1212 /* Do a simple linear search to see if we have a Pixmap resource
1213 * associated with this property and release it.
1215 PROPERTY
**prop
= &prop_head
;
1219 if ((*prop
)->atom
== property
)
1221 PROPERTY
*next
= (*prop
)->next
;
1222 XFreePixmap( display
, (*prop
)->pixmap
);
1223 HeapFree( GetProcessHeap(), 0, *prop
);
1226 else prop
= &(*prop
)->next
;