2
* Copyright Ā© 2004 Red Hat, Inc.
3
* Copyright Ā© 2004 Nokia Corporation
5
* Permission to use, copy, modify, distribute, and sell this software and its
6
* documentation for any purpose is hereby granted without fee, provided that
7
* the above copyright notice appear in all copies and that both that
8
* copyright notice and this permission notice appear in supporting
9
* documentation, and that the name of Red Hat not be used in advertising or
10
* publicity pertaining to distribution of the software without specific,
11
* written prior permission. Red Hat makes no representations about the
12
* suitability of this software for any purpose. It is provided "as is"
13
* without express or implied warranty.
15
* RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
16
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL RED HAT
17
* BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
19
* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22
* Authors: Matthias Clasen, Red Hat, Inc.
23
* Anders Carlsson, Imendio AB
31
#include <X11/Xatom.h>
33
#include "clipboard-manager.h"
38
struct _ClipboardManager
44
ClipboardTerminateFunc terminate;
45
ClipboardWatchFunc watch;
48
ClipboardErrorTrapPushFunc error_trap_push;
49
ClipboardErrorTrapPopFunc error_trap_pop;
79
/* We need to use reference counting for the target data, since we may
80
* need to keep the data around after loosing the CLIPBOARD ownership
81
* to complete incremental transfers.
84
target_data_ref (TargetData *data)
91
target_data_unref (TargetData *data)
94
if (data->refcount == 0)
102
conversion_free (IncrConversion *rdata)
105
target_data_unref (rdata->data);
110
send_selection_notify (ClipboardManager *manager,
113
XSelectionEvent notify;
115
notify.type = SelectionNotify;
117
notify.send_event = True;
118
notify.display = manager->display;
119
notify.requestor = manager->requestor;
120
notify.selection = XA_CLIPBOARD_MANAGER;
121
notify.target = XA_SAVE_TARGETS;
122
notify.property = success ? manager->property : None;
123
notify.time = manager->time;
125
manager->error_trap_push ();
127
XSendEvent (manager->display, manager->requestor,
128
False, NoEventMask, (XEvent *)¬ify);
129
XSync (manager->display, False);
131
manager->error_trap_pop ();
135
finish_selection_request (ClipboardManager *manager,
139
XSelectionEvent notify;
141
notify.type = SelectionNotify;
143
notify.send_event = True;
144
notify.display = xev->xselectionrequest.display;
145
notify.requestor = xev->xselectionrequest.requestor;
146
notify.selection = xev->xselectionrequest.selection;
147
notify.target = xev->xselectionrequest.target;
148
notify.property = success ? xev->xselectionrequest.property : None;
149
notify.time = xev->xselectionrequest.time;
151
manager->error_trap_push ();
153
XSendEvent (xev->xselectionrequest.display,
154
xev->xselectionrequest.requestor,
155
False, NoEventMask, (XEvent *)¬ify);
156
XSync (manager->display, False);
158
manager->error_trap_pop ();
162
clipboard_bytes_per_item (int format)
167
return sizeof (char);
169
return sizeof (short);
171
return sizeof (long);
178
save_targets (ClipboardManager *manager,
186
multiple = (Atom *) malloc (2 * nitems * sizeof (Atom));
189
for (i = 0; i < nitems; i++)
191
if (save_targets[i] != XA_TARGETS &&
192
save_targets[i] != XA_MULTIPLE &&
193
save_targets[i] != XA_DELETE &&
194
save_targets[i] != XA_INSERT_PROPERTY &&
195
save_targets[i] != XA_INSERT_SELECTION &&
196
save_targets[i] != XA_PIXMAP)
199
tdata = (TargetData *) malloc (sizeof (TargetData));
202
tdata->target = save_targets[i];
206
manager->contents = list_prepend (manager->contents, tdata);
208
multiple[nout++] = save_targets[i];
209
multiple[nout++] = save_targets[i];
213
XFree (save_targets);
215
XChangeProperty (manager->display, manager->window,
216
XA_MULTIPLE, XA_ATOM_PAIR,
217
32, PropModeReplace, (char *)multiple, nout);
220
XConvertSelection (manager->display, XA_CLIPBOARD,
221
XA_MULTIPLE, XA_MULTIPLE,
222
manager->window, manager->time);
226
find_content_target (TargetData *tdata,
229
return tdata->target == target;
233
find_content_type (TargetData *tdata,
236
return tdata->type == type;
240
find_conversion_requestor (IncrConversion *rdata,
243
return (rdata->requestor == xev->xproperty.window &&
244
rdata->property == xev->xproperty.atom);
248
get_property (TargetData *tdata,
249
ClipboardManager *manager)
253
unsigned long length;
254
unsigned long remaining;
257
XGetWindowProperty (manager->display,
260
0, 0x1FFFFFFF, True, AnyPropertyType,
261
&type, &format, &length, &remaining,
266
manager->contents = list_remove (manager->contents, tdata);
269
else if (type == XA_INCR)
279
tdata->length = length * clipboard_bytes_per_item (format);
280
tdata->format = format;
285
receive_incrementally (ClipboardManager *manager,
292
unsigned long length, nitems, remaining;
295
if (xev->xproperty.window != manager->window)
298
list = list_find (manager->contents,
299
(ListFindFunc)find_content_target, (void *)xev->xproperty.atom);
304
tdata = (TargetData *)list->data;
306
if (tdata->type != XA_INCR)
309
XGetWindowProperty (xev->xproperty.display,
310
xev->xproperty.window,
312
0, 0x1FFFFFFF, True, AnyPropertyType,
313
&type, &format, &nitems, &remaining, &data);
315
length = nitems * clipboard_bytes_per_item (format);
320
tdata->format = format;
322
if (!list_find (manager->contents,
323
(ListFindFunc)find_content_type, (void *)XA_INCR))
325
/* all incremental transfers done */
326
send_selection_notify (manager, True);
327
manager->requestor = None;
337
tdata->length = length;
341
tdata->data = realloc (tdata->data, tdata->length + length + 1);
342
memcpy (tdata->data + tdata->length, data, length + 1);
343
tdata->length += length;
352
send_incrementally (ClipboardManager *manager,
356
IncrConversion *rdata;
357
unsigned long length, items;
360
list = list_find (manager->conversions,
361
(ListFindFunc)find_conversion_requestor, xev);
366
rdata = (IncrConversion *)list->data;
368
data = rdata->data->data + rdata->offset;
369
length = rdata->data->length - rdata->offset;
370
if (length > SELECTION_MAX_SIZE)
371
length = SELECTION_MAX_SIZE;
373
rdata->offset += length;
375
items = length / clipboard_bytes_per_item (rdata->data->format);
376
XChangeProperty (manager->display, rdata->requestor,
377
rdata->property, rdata->data->type,
378
rdata->data->format, PropModeAppend,
383
manager->conversions = list_remove (manager->conversions, rdata);
384
conversion_free (rdata);
391
convert_clipboard_manager (ClipboardManager *manager,
396
unsigned long nitems, remaining;
397
Atom *targets = NULL;
399
if (xev->xselectionrequest.target == XA_SAVE_TARGETS)
401
if (manager->requestor != None || manager->contents != NULL)
403
/* We're in the middle of a conversion request, or own
404
* the CLIPBOARD already
406
finish_selection_request (manager, xev, False);
410
manager->error_trap_push ();
412
manager->watch (xev->xselectionrequest.requestor, True, StructureNotifyMask, manager->cb_data);
413
XSelectInput (manager->display, xev->xselectionrequest.requestor,
414
StructureNotifyMask);
415
XSync (manager->display, False);
417
if (manager->error_trap_pop () != Success)
420
manager->error_trap_push ();
422
if (xev->xselectionrequest.property != None)
424
XGetWindowProperty (manager->display, xev->xselectionrequest.requestor,
425
xev->xselectionrequest.property,
426
0, 0x1FFFFFFF, False, XA_ATOM,
427
&type, &format, &nitems, &remaining,
428
(unsigned char **)&targets);
430
if (manager->error_trap_pop () != Success)
439
manager->requestor = xev->xselectionrequest.requestor;
440
manager->property = xev->xselectionrequest.property;
441
manager->time = xev->xselectionrequest.time;
444
XConvertSelection (manager->display, XA_CLIPBOARD,
445
XA_TARGETS, XA_TARGETS,
446
manager->window, manager->time);
448
save_targets (manager, targets, nitems);
451
else if (xev->xselectionrequest.target == XA_TIMESTAMP)
453
XChangeProperty (manager->display,
454
xev->xselectionrequest.requestor,
455
xev->xselectionrequest.property,
456
XA_INTEGER, 32, PropModeReplace,
457
(unsigned char *)&manager->timestamp, 1);
459
finish_selection_request (manager, xev, True);
461
else if (xev->xselectionrequest.target == XA_TARGETS)
466
targets[n_targets++] = XA_TARGETS;
467
targets[n_targets++] = XA_TIMESTAMP;
468
targets[n_targets++] = XA_SAVE_TARGETS;
470
XChangeProperty (manager->display,
471
xev->xselectionrequest.requestor,
472
xev->xselectionrequest.property,
473
XA_ATOM, 32, PropModeReplace,
474
(unsigned char *)targets, n_targets);
476
finish_selection_request (manager, xev, True);
480
finish_selection_request (manager, xev, False);
485
convert_clipboard_target (IncrConversion *rdata,
486
ClipboardManager *manager)
493
XWindowAttributes atts;
495
if (rdata->target == XA_TARGETS)
497
n_targets = list_length (manager->contents) + 2;
498
targets = (Atom *) malloc (n_targets * sizeof (Atom));
502
targets[n_targets++] = XA_TARGETS;
503
targets[n_targets++] = XA_MULTIPLE;
505
for (list = manager->contents; list; list = list->next)
507
tdata = (TargetData *)list->data;
508
targets[n_targets++] = tdata->target;
511
XChangeProperty (manager->display, rdata->requestor,
513
XA_ATOM, 32, PropModeReplace,
514
(unsigned char *)targets, n_targets);
519
/* Convert from stored CLIPBOARD data */
520
list = list_find (manager->contents,
521
(ListFindFunc)find_content_target, (void *)rdata->target);
523
/* We got a target that we don't support */
527
tdata = (TargetData *)list->data;
529
if (tdata->type == XA_INCR)
531
/* we haven't completely received this target yet
533
rdata->property = None;
537
rdata->data = target_data_ref (tdata);
538
items = tdata->length / clipboard_bytes_per_item (tdata->format);
539
if (tdata->length <= SELECTION_MAX_SIZE)
540
XChangeProperty (manager->display, rdata->requestor,
542
tdata->type, tdata->format, PropModeReplace,
546
/* start incremental transfer
550
manager->error_trap_push ();
552
XGetWindowAttributes (manager->display, rdata->requestor, &atts);
553
XSelectInput (manager->display, rdata->requestor,
554
atts.your_event_mask | PropertyChangeMask);
556
XChangeProperty (manager->display, rdata->requestor,
558
XA_INCR, 32, PropModeReplace,
559
(unsigned char *)&items, 1);
561
XSync (manager->display, False);
563
manager->error_trap_pop ();
569
collect_incremental (IncrConversion *rdata,
570
ClipboardManager *manager)
572
if (rdata->offset >= 0)
573
manager->conversions = list_prepend (manager->conversions, rdata);
578
target_data_unref (rdata->data);
586
convert_clipboard (ClipboardManager *manager,
589
List *list, *conversions;
590
IncrConversion *rdata;
593
unsigned long nitems, remaining;
599
if (xev->xselectionrequest.target == XA_MULTIPLE)
602
XGetWindowProperty (xev->xselectionrequest.display,
603
xev->xselectionrequest.requestor,
604
xev->xselectionrequest.property,
605
0, 0x1FFFFFFF, False, XA_ATOM_PAIR,
606
&type, &format, &nitems, &remaining,
607
(unsigned char **)&multiple);
611
if (type != XA_ATOM_PAIR)
614
for (i = 0; i < nitems; i += 2)
616
rdata = (IncrConversion *) malloc (sizeof (IncrConversion));
617
rdata->requestor = xev->xselectionrequest.requestor;
618
rdata->target = multiple[i];
619
rdata->property = multiple[i+1];
622
conversions = list_prepend (conversions, rdata);
629
rdata = (IncrConversion *) malloc (sizeof (IncrConversion));
630
rdata->requestor = xev->xselectionrequest.requestor;
631
rdata->target = xev->xselectionrequest.target;
632
rdata->property = xev->xselectionrequest.property;
635
conversions = list_prepend (conversions, rdata);
638
list_foreach (conversions, (Callback)convert_clipboard_target, manager);
640
if (conversions->next == NULL &&
641
((IncrConversion *)conversions->data)->property == None)
643
finish_selection_request (manager, xev, False);
650
for (list = conversions; list; list = list->next)
652
rdata = (IncrConversion *)list->data;
653
multiple[i++] = rdata->target;
654
multiple[i++] = rdata->property;
656
XChangeProperty (xev->xselectionrequest.display,
657
xev->xselectionrequest.requestor,
658
xev->xselectionrequest.property,
659
XA_ATOM_PAIR, 32, PropModeReplace,
660
(unsigned char *)multiple, nitems);
662
finish_selection_request (manager, xev, True);
665
list_foreach (conversions, (Callback)collect_incremental, manager);
666
list_free (conversions);
673
clipboard_manager_process_event (ClipboardManager *manager,
678
unsigned long nitems;
679
unsigned long remaining;
684
switch (xev->xany.type)
687
if (xev->xdestroywindow.window == manager->requestor)
689
list_foreach (manager->contents, (Callback)target_data_unref, NULL);
690
list_free (manager->contents);
691
manager->contents = NULL;
693
manager->watch (manager->requestor, False, 0, manager->cb_data);
694
manager->requestor = None;
699
if (xev->xproperty.state == PropertyNewValue)
700
return receive_incrementally (manager, xev);
702
return send_incrementally (manager, xev);
705
if (xev->xany.window != manager->window)
708
if (xev->xselectionclear.selection == XA_CLIPBOARD_MANAGER)
710
/* We lost the manager selection */
711
if (manager->contents)
713
list_foreach (manager->contents, (Callback)target_data_unref, NULL);
714
list_free (manager->contents);
715
manager->contents = NULL;
717
XSetSelectionOwner (manager->display,
719
None, manager->time);
721
manager->terminate (manager->cb_data);
725
if (xev->xselectionclear.selection == XA_CLIPBOARD)
727
/* We lost the clipboard selection */
728
list_foreach (manager->contents, (Callback)target_data_unref, NULL);
729
list_free (manager->contents);
730
manager->contents = NULL;
731
manager->watch (manager->requestor, False, 0, manager->cb_data);
732
manager->requestor = None;
738
case SelectionNotify:
739
if (xev->xany.window != manager->window)
742
if (xev->xselection.selection == XA_CLIPBOARD)
744
/* a CLIPBOARD conversion is done */
745
if (xev->xselection.property == XA_TARGETS)
747
XGetWindowProperty (xev->xselection.display,
748
xev->xselection.requestor,
749
xev->xselection.property,
750
0, 0x1FFFFFFF, True, XA_ATOM,
751
&type, &format, &nitems, &remaining,
752
(unsigned char **)&targets);
754
save_targets (manager, targets, nitems);
756
else if (xev->xselection.property == XA_MULTIPLE)
760
tmp = list_copy (manager->contents);
761
list_foreach (tmp, (Callback)get_property, manager);
764
manager->time = xev->xselection.time;
765
XSetSelectionOwner (manager->display, XA_CLIPBOARD,
766
manager->window, manager->time);
768
if (manager->property != None)
769
XChangeProperty (manager->display, manager->requestor,
771
XA_ATOM, 32, PropModeReplace,
772
(unsigned char *)&XA_NULL, 1);
774
if (!list_find (manager->contents,
775
(ListFindFunc)find_content_type, (void *)XA_INCR))
777
/* all transfers done */
778
send_selection_notify (manager, True);
779
manager->watch (manager->requestor, False, 0, manager->cb_data);
780
manager->requestor = None;
783
else if (xev->xselection.property == None)
785
send_selection_notify (manager, False);
786
manager->watch (manager->requestor, False, 0, manager->cb_data);
787
manager->requestor = None;
794
case SelectionRequest:
795
if (xev->xany.window != manager->window)
798
if (xev->xselectionrequest.selection == XA_CLIPBOARD_MANAGER)
800
convert_clipboard_manager (manager, xev);
803
else if (xev->xselectionrequest.selection == XA_CLIPBOARD)
805
convert_clipboard (manager, xev);
817
clipboard_manager_check_running (Display *display)
819
init_atoms (display);
821
if (XGetSelectionOwner (display, XA_CLIPBOARD_MANAGER))
828
clipboard_manager_new (Display *display,
829
ClipboardErrorTrapPushFunc error_trap_push_cb,
830
ClipboardErrorTrapPopFunc error_trap_pop_cb,
831
ClipboardTerminateFunc terminate,
832
ClipboardWatchFunc watch,
835
ClipboardManager *manager;
836
XClientMessageEvent xev;
838
init_atoms (display);
840
manager = malloc (sizeof *manager);
844
manager->display = display;
846
manager->error_trap_push = error_trap_push_cb;
847
manager->error_trap_pop = error_trap_pop_cb;
849
manager->terminate = terminate;
850
manager->watch = watch;
851
manager->cb_data = cb_data;
853
manager->contents = NULL;
854
manager->conversions = NULL;
856
manager->requestor = None;
858
manager->window = XCreateSimpleWindow (display,
859
DefaultRootWindow (display),
861
WhitePixel (display, DefaultScreen (display)),
862
WhitePixel (display, DefaultScreen (display)));
864
manager->watch (manager->window, True, PropertyChangeMask, manager->cb_data);
865
XSelectInput (display, manager->window, PropertyChangeMask);
866
manager->timestamp = get_server_time (display, manager->window);
868
XSetSelectionOwner (display, XA_CLIPBOARD_MANAGER,
869
manager->window, manager->timestamp);
871
/* Check to see if we managed to claim the selection. If not,
872
* we treat it as if we got it then immediately lost it
875
if (XGetSelectionOwner (display, XA_CLIPBOARD_MANAGER) == manager->window)
877
xev.type = ClientMessage;
878
xev.window = DefaultRootWindow (display);
879
xev.message_type = XA_MANAGER;
881
xev.data.l[0] = manager->timestamp;
882
xev.data.l[1] = XA_CLIPBOARD_MANAGER;
883
xev.data.l[2] = manager->window;
884
xev.data.l[3] = 0; /* manager specific data */
885
xev.data.l[4] = 0; /* manager specific data */
887
XSendEvent (display, DefaultRootWindow (display),
888
False, StructureNotifyMask, (XEvent *)&xev);
892
manager->watch (manager->window, False, 0, manager->cb_data);
893
manager->terminate (manager->cb_data);
902
clipboard_manager_destroy (ClipboardManager *manager)
906
manager->watch (manager->window, False, 0, manager->cb_data);
907
XDestroyWindow (manager->display, manager->window);
909
list_foreach (manager->conversions, (Callback)conversion_free, NULL);
910
list_free (manager->conversions);
912
list_foreach (manager->contents, (Callback)target_data_unref, NULL);
913
list_free (manager->contents);