]> code.delx.au - gnu-emacs/blob - src/xselect.c
(selection_data_to_lisp_data):
[gnu-emacs] / src / xselect.c
1 /* X Selection processing for Emacs.
2 Copyright (C) 1993, 1994, 1995, 1996 Free Software Foundation.
3
4 This file is part of GNU Emacs.
5
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21
22 /* Rewritten by jwz */
23
24 #include <config.h>
25 #include "lisp.h"
26 #include "xterm.h" /* for all of the X includes */
27 #include "dispextern.h" /* frame.h seems to want this */
28 #include "frame.h" /* Need this to get the X window of selected_frame */
29 #include "blockinput.h"
30 #include "charset.h"
31 #include "coding.h"
32
33 #define CUT_BUFFER_SUPPORT
34
35 Lisp_Object QPRIMARY, QSECONDARY, QSTRING, QINTEGER, QCLIPBOARD, QTIMESTAMP,
36 QTEXT, QDELETE, QMULTIPLE, QINCR, QEMACS_TMP, QTARGETS, QATOM, QNULL,
37 QATOM_PAIR;
38
39 Lisp_Object QCOMPOUND_TEXT; /* This is a type of selection. */
40
41 #ifdef CUT_BUFFER_SUPPORT
42 Lisp_Object QCUT_BUFFER0, QCUT_BUFFER1, QCUT_BUFFER2, QCUT_BUFFER3,
43 QCUT_BUFFER4, QCUT_BUFFER5, QCUT_BUFFER6, QCUT_BUFFER7;
44 #endif
45
46 static Lisp_Object Vx_lost_selection_hooks;
47 static Lisp_Object Vx_sent_selection_hooks;
48
49 /* If this is a smaller number than the max-request-size of the display,
50 emacs will use INCR selection transfer when the selection is larger
51 than this. The max-request-size is usually around 64k, so if you want
52 emacs to use incremental selection transfers when the selection is
53 smaller than that, set this. I added this mostly for debugging the
54 incremental transfer stuff, but it might improve server performance. */
55 #define MAX_SELECTION_QUANTUM 0xFFFFFF
56
57 #ifdef HAVE_X11R4
58 #define SELECTION_QUANTUM(dpy) ((XMaxRequestSize(dpy) << 2) - 100)
59 #else
60 #define SELECTION_QUANTUM(dpy) (((dpy)->max_request_size << 2) - 100)
61 #endif
62
63 /* The timestamp of the last input event Emacs received from the X server. */
64 /* Defined in keyboard.c. */
65 extern unsigned long last_event_timestamp;
66
67 /* This is an association list whose elements are of the form
68 ( SELECTION-NAME SELECTION-VALUE SELECTION-TIMESTAMP FRAME)
69 SELECTION-NAME is a lisp symbol, whose name is the name of an X Atom.
70 SELECTION-VALUE is the value that emacs owns for that selection.
71 It may be any kind of Lisp object.
72 SELECTION-TIMESTAMP is the time at which emacs began owning this selection,
73 as a cons of two 16-bit numbers (making a 32 bit time.)
74 FRAME is the frame for which we made the selection.
75 If there is an entry in this alist, then it can be assumed that Emacs owns
76 that selection.
77 The only (eq) parts of this list that are visible from Lisp are the
78 selection-values. */
79 static Lisp_Object Vselection_alist;
80
81 /* This is an alist whose CARs are selection-types (whose names are the same
82 as the names of X Atoms) and whose CDRs are the names of Lisp functions to
83 call to convert the given Emacs selection value to a string representing
84 the given selection type. This is for Lisp-level extension of the emacs
85 selection handling. */
86 static Lisp_Object Vselection_converter_alist;
87
88 /* If the selection owner takes too long to reply to a selection request,
89 we give up on it. This is in milliseconds (0 = no timeout.) */
90 static int x_selection_timeout;
91 \f
92 /* Utility functions */
93
94 static void lisp_data_to_selection_data ();
95 static Lisp_Object selection_data_to_lisp_data ();
96 static Lisp_Object x_get_window_property_as_lisp_data ();
97
98 /* This converts a Lisp symbol to a server Atom, avoiding a server
99 roundtrip whenever possible. */
100
101 static Atom
102 symbol_to_x_atom (dpyinfo, display, sym)
103 struct x_display_info *dpyinfo;
104 Display *display;
105 Lisp_Object sym;
106 {
107 Atom val;
108 if (NILP (sym)) return 0;
109 if (EQ (sym, QPRIMARY)) return XA_PRIMARY;
110 if (EQ (sym, QSECONDARY)) return XA_SECONDARY;
111 if (EQ (sym, QSTRING)) return XA_STRING;
112 if (EQ (sym, QINTEGER)) return XA_INTEGER;
113 if (EQ (sym, QATOM)) return XA_ATOM;
114 if (EQ (sym, QCLIPBOARD)) return dpyinfo->Xatom_CLIPBOARD;
115 if (EQ (sym, QTIMESTAMP)) return dpyinfo->Xatom_TIMESTAMP;
116 if (EQ (sym, QTEXT)) return dpyinfo->Xatom_TEXT;
117 if (EQ (sym, QCOMPOUND_TEXT)) return dpyinfo->Xatom_COMPOUND_TEXT;
118 if (EQ (sym, QDELETE)) return dpyinfo->Xatom_DELETE;
119 if (EQ (sym, QMULTIPLE)) return dpyinfo->Xatom_MULTIPLE;
120 if (EQ (sym, QINCR)) return dpyinfo->Xatom_INCR;
121 if (EQ (sym, QEMACS_TMP)) return dpyinfo->Xatom_EMACS_TMP;
122 if (EQ (sym, QTARGETS)) return dpyinfo->Xatom_TARGETS;
123 if (EQ (sym, QNULL)) return dpyinfo->Xatom_NULL;
124 #ifdef CUT_BUFFER_SUPPORT
125 if (EQ (sym, QCUT_BUFFER0)) return XA_CUT_BUFFER0;
126 if (EQ (sym, QCUT_BUFFER1)) return XA_CUT_BUFFER1;
127 if (EQ (sym, QCUT_BUFFER2)) return XA_CUT_BUFFER2;
128 if (EQ (sym, QCUT_BUFFER3)) return XA_CUT_BUFFER3;
129 if (EQ (sym, QCUT_BUFFER4)) return XA_CUT_BUFFER4;
130 if (EQ (sym, QCUT_BUFFER5)) return XA_CUT_BUFFER5;
131 if (EQ (sym, QCUT_BUFFER6)) return XA_CUT_BUFFER6;
132 if (EQ (sym, QCUT_BUFFER7)) return XA_CUT_BUFFER7;
133 #endif
134 if (!SYMBOLP (sym)) abort ();
135
136 #if 0
137 fprintf (stderr, " XInternAtom %s\n", (char *) XSYMBOL (sym)->name->data);
138 #endif
139 BLOCK_INPUT;
140 val = XInternAtom (display, (char *) XSYMBOL (sym)->name->data, False);
141 UNBLOCK_INPUT;
142 return val;
143 }
144
145
146 /* This converts a server Atom to a Lisp symbol, avoiding server roundtrips
147 and calls to intern whenever possible. */
148
149 static Lisp_Object
150 x_atom_to_symbol (dpyinfo, display, atom)
151 struct x_display_info *dpyinfo;
152 Display *display;
153 Atom atom;
154 {
155 char *str;
156 Lisp_Object val;
157 if (! atom) return Qnil;
158 switch (atom)
159 {
160 case XA_PRIMARY:
161 return QPRIMARY;
162 case XA_SECONDARY:
163 return QSECONDARY;
164 case XA_STRING:
165 return QSTRING;
166 case XA_INTEGER:
167 return QINTEGER;
168 case XA_ATOM:
169 return QATOM;
170 #ifdef CUT_BUFFER_SUPPORT
171 case XA_CUT_BUFFER0:
172 return QCUT_BUFFER0;
173 case XA_CUT_BUFFER1:
174 return QCUT_BUFFER1;
175 case XA_CUT_BUFFER2:
176 return QCUT_BUFFER2;
177 case XA_CUT_BUFFER3:
178 return QCUT_BUFFER3;
179 case XA_CUT_BUFFER4:
180 return QCUT_BUFFER4;
181 case XA_CUT_BUFFER5:
182 return QCUT_BUFFER5;
183 case XA_CUT_BUFFER6:
184 return QCUT_BUFFER6;
185 case XA_CUT_BUFFER7:
186 return QCUT_BUFFER7;
187 #endif
188 }
189
190 if (atom == dpyinfo->Xatom_CLIPBOARD)
191 return QCLIPBOARD;
192 if (atom == dpyinfo->Xatom_TIMESTAMP)
193 return QTIMESTAMP;
194 if (atom == dpyinfo->Xatom_TEXT)
195 return QTEXT;
196 if (atom == dpyinfo->Xatom_COMPOUND_TEXT)
197 return QCOMPOUND_TEXT;
198 if (atom == dpyinfo->Xatom_DELETE)
199 return QDELETE;
200 if (atom == dpyinfo->Xatom_MULTIPLE)
201 return QMULTIPLE;
202 if (atom == dpyinfo->Xatom_INCR)
203 return QINCR;
204 if (atom == dpyinfo->Xatom_EMACS_TMP)
205 return QEMACS_TMP;
206 if (atom == dpyinfo->Xatom_TARGETS)
207 return QTARGETS;
208 if (atom == dpyinfo->Xatom_NULL)
209 return QNULL;
210
211 BLOCK_INPUT;
212 str = XGetAtomName (display, atom);
213 UNBLOCK_INPUT;
214 #if 0
215 fprintf (stderr, " XGetAtomName --> %s\n", str);
216 #endif
217 if (! str) return Qnil;
218 val = intern (str);
219 BLOCK_INPUT;
220 /* This was allocated by Xlib, so use XFree. */
221 XFree (str);
222 UNBLOCK_INPUT;
223 return val;
224 }
225 \f
226 /* Do protocol to assert ourself as a selection owner.
227 Update the Vselection_alist so that we can reply to later requests for
228 our selection. */
229
230 static void
231 x_own_selection (selection_name, selection_value)
232 Lisp_Object selection_name, selection_value;
233 {
234 Window selecting_window = FRAME_X_WINDOW (selected_frame);
235 Display *display = FRAME_X_DISPLAY (selected_frame);
236 Time time = last_event_timestamp;
237 Atom selection_atom;
238 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (selected_frame);
239 int count;
240
241 CHECK_SYMBOL (selection_name, 0);
242 selection_atom = symbol_to_x_atom (dpyinfo, display, selection_name);
243
244 BLOCK_INPUT;
245 count = x_catch_errors (display);
246 XSetSelectionOwner (display, selection_atom, selecting_window, time);
247 x_check_errors (display, "Can't set selection: %s");
248 x_uncatch_errors (display, count);
249 UNBLOCK_INPUT;
250
251 /* Now update the local cache */
252 {
253 Lisp_Object selection_time;
254 Lisp_Object selection_data;
255 Lisp_Object prev_value;
256
257 selection_time = long_to_cons ((unsigned long) time);
258 selection_data = Fcons (selection_name,
259 Fcons (selection_value,
260 Fcons (selection_time,
261 Fcons (Fselected_frame (), Qnil))));
262 prev_value = assq_no_quit (selection_name, Vselection_alist);
263
264 Vselection_alist = Fcons (selection_data, Vselection_alist);
265
266 /* If we already owned the selection, remove the old selection data.
267 Perhaps we should destructively modify it instead.
268 Don't use Fdelq as that may QUIT. */
269 if (!NILP (prev_value))
270 {
271 Lisp_Object rest; /* we know it's not the CAR, so it's easy. */
272 for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
273 if (EQ (prev_value, Fcar (XCONS (rest)->cdr)))
274 {
275 XCONS (rest)->cdr = Fcdr (XCONS (rest)->cdr);
276 break;
277 }
278 }
279 }
280 }
281 \f
282 /* Given a selection-name and desired type, look up our local copy of
283 the selection value and convert it to the type.
284 The value is nil or a string.
285 This function is used both for remote requests
286 and for local x-get-selection-internal.
287
288 This calls random Lisp code, and may signal or gc. */
289
290 static Lisp_Object
291 x_get_local_selection (selection_symbol, target_type)
292 Lisp_Object selection_symbol, target_type;
293 {
294 Lisp_Object local_value;
295 Lisp_Object handler_fn, value, type, check;
296 int count;
297
298 local_value = assq_no_quit (selection_symbol, Vselection_alist);
299
300 if (NILP (local_value)) return Qnil;
301
302 /* TIMESTAMP and MULTIPLE are special cases 'cause that's easiest. */
303 if (EQ (target_type, QTIMESTAMP))
304 {
305 handler_fn = Qnil;
306 value = XCONS (XCONS (XCONS (local_value)->cdr)->cdr)->car;
307 }
308 #if 0
309 else if (EQ (target_type, QDELETE))
310 {
311 handler_fn = Qnil;
312 Fx_disown_selection_internal
313 (selection_symbol,
314 XCONS (XCONS (XCONS (local_value)->cdr)->cdr)->car);
315 value = QNULL;
316 }
317 #endif
318
319 #if 0 /* #### MULTIPLE doesn't work yet */
320 else if (CONSP (target_type)
321 && XCONS (target_type)->car == QMULTIPLE)
322 {
323 Lisp_Object pairs;
324 int size;
325 int i;
326 pairs = XCONS (target_type)->cdr;
327 size = XVECTOR (pairs)->size;
328 /* If the target is MULTIPLE, then target_type looks like
329 (MULTIPLE . [[SELECTION1 TARGET1] [SELECTION2 TARGET2] ... ])
330 We modify the second element of each pair in the vector and
331 return it as [[SELECTION1 <value1>] [SELECTION2 <value2>] ... ]
332 */
333 for (i = 0; i < size; i++)
334 {
335 Lisp_Object pair;
336 pair = XVECTOR (pairs)->contents [i];
337 XVECTOR (pair)->contents [1]
338 = x_get_local_selection (XVECTOR (pair)->contents [0],
339 XVECTOR (pair)->contents [1]);
340 }
341 return pairs;
342 }
343 #endif
344 else
345 {
346 /* Don't allow a quit within the converter.
347 When the user types C-g, he would be surprised
348 if by luck it came during a converter. */
349 count = specpdl_ptr - specpdl;
350 specbind (Qinhibit_quit, Qt);
351
352 CHECK_SYMBOL (target_type, 0);
353 handler_fn = Fcdr (Fassq (target_type, Vselection_converter_alist));
354 if (!NILP (handler_fn))
355 value = call3 (handler_fn,
356 selection_symbol, target_type,
357 XCONS (XCONS (local_value)->cdr)->car);
358 else
359 value = Qnil;
360 unbind_to (count, Qnil);
361 }
362
363 /* Make sure this value is of a type that we could transmit
364 to another X client. */
365
366 check = value;
367 if (CONSP (value)
368 && SYMBOLP (XCONS (value)->car))
369 type = XCONS (value)->car,
370 check = XCONS (value)->cdr;
371
372 if (STRINGP (check)
373 || VECTORP (check)
374 || SYMBOLP (check)
375 || INTEGERP (check)
376 || NILP (value))
377 return value;
378 /* Check for a value that cons_to_long could handle. */
379 else if (CONSP (check)
380 && INTEGERP (XCONS (check)->car)
381 && (INTEGERP (XCONS (check)->cdr)
382 ||
383 (CONSP (XCONS (check)->cdr)
384 && INTEGERP (XCONS (XCONS (check)->cdr)->car)
385 && NILP (XCONS (XCONS (check)->cdr)->cdr))))
386 return value;
387 else
388 return
389 Fsignal (Qerror,
390 Fcons (build_string ("invalid data returned by selection-conversion function"),
391 Fcons (handler_fn, Fcons (value, Qnil))));
392 }
393 \f
394 /* Subroutines of x_reply_selection_request. */
395
396 /* Send a SelectionNotify event to the requestor with property=None,
397 meaning we were unable to do what they wanted. */
398
399 static void
400 x_decline_selection_request (event)
401 struct input_event *event;
402 {
403 XSelectionEvent reply;
404 reply.type = SelectionNotify;
405 reply.display = SELECTION_EVENT_DISPLAY (event);
406 reply.requestor = SELECTION_EVENT_REQUESTOR (event);
407 reply.selection = SELECTION_EVENT_SELECTION (event);
408 reply.time = SELECTION_EVENT_TIME (event);
409 reply.target = SELECTION_EVENT_TARGET (event);
410 reply.property = None;
411
412 BLOCK_INPUT;
413 XSendEvent (reply.display, reply.requestor, False, 0L,
414 (XEvent *) &reply);
415 XFlush (reply.display);
416 UNBLOCK_INPUT;
417 }
418
419 /* This is the selection request currently being processed.
420 It is set to zero when the request is fully processed. */
421 static struct input_event *x_selection_current_request;
422
423 /* Used as an unwind-protect clause so that, if a selection-converter signals
424 an error, we tell the requester that we were unable to do what they wanted
425 before we throw to top-level or go into the debugger or whatever. */
426
427 static Lisp_Object
428 x_selection_request_lisp_error (ignore)
429 Lisp_Object ignore;
430 {
431 if (x_selection_current_request != 0)
432 x_decline_selection_request (x_selection_current_request);
433 return Qnil;
434 }
435 \f
436
437 /* This stuff is so that INCR selections are reentrant (that is, so we can
438 be servicing multiple INCR selection requests simultaneously.) I haven't
439 actually tested that yet. */
440
441 /* Keep a list of the property changes that are awaited. */
442
443 struct prop_location
444 {
445 int identifier;
446 Display *display;
447 Window window;
448 Atom property;
449 int desired_state;
450 int arrived;
451 struct prop_location *next;
452 };
453
454 static struct prop_location *expect_property_change ();
455 static void wait_for_property_change ();
456 static void unexpect_property_change ();
457 static int waiting_for_other_props_on_window ();
458
459 static int prop_location_identifier;
460
461 static Lisp_Object property_change_reply;
462
463 static struct prop_location *property_change_reply_object;
464
465 static struct prop_location *property_change_wait_list;
466
467 static Lisp_Object
468 queue_selection_requests_unwind (frame)
469 Lisp_Object frame;
470 {
471 FRAME_PTR f = XFRAME (frame);
472
473 if (! NILP (frame))
474 x_stop_queuing_selection_requests (FRAME_X_DISPLAY (f));
475 return Qnil;
476 }
477
478 /* Return some frame whose display info is DPYINFO.
479 Return nil if there is none. */
480
481 static Lisp_Object
482 some_frame_on_display (dpyinfo)
483 struct x_display_info *dpyinfo;
484 {
485 Lisp_Object list, frame;
486
487 FOR_EACH_FRAME (list, frame)
488 {
489 if (FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
490 return frame;
491 }
492
493 return Qnil;
494 }
495 \f
496 /* Send the reply to a selection request event EVENT.
497 TYPE is the type of selection data requested.
498 DATA and SIZE describe the data to send, already converted.
499 FORMAT is the unit-size (in bits) of the data to be transmitted. */
500
501 static void
502 x_reply_selection_request (event, format, data, size, type)
503 struct input_event *event;
504 int format, size;
505 unsigned char *data;
506 Atom type;
507 {
508 XSelectionEvent reply;
509 Display *display = SELECTION_EVENT_DISPLAY (event);
510 Window window = SELECTION_EVENT_REQUESTOR (event);
511 int bytes_remaining;
512 int format_bytes = format/8;
513 int max_bytes = SELECTION_QUANTUM (display);
514 struct x_display_info *dpyinfo = x_display_info_for_display (display);
515 int count;
516
517 if (max_bytes > MAX_SELECTION_QUANTUM)
518 max_bytes = MAX_SELECTION_QUANTUM;
519
520 reply.type = SelectionNotify;
521 reply.display = display;
522 reply.requestor = window;
523 reply.selection = SELECTION_EVENT_SELECTION (event);
524 reply.time = SELECTION_EVENT_TIME (event);
525 reply.target = SELECTION_EVENT_TARGET (event);
526 reply.property = SELECTION_EVENT_PROPERTY (event);
527 if (reply.property == None)
528 reply.property = reply.target;
529
530 /* #### XChangeProperty can generate BadAlloc, and we must handle it! */
531 BLOCK_INPUT;
532 count = x_catch_errors (display);
533
534 /* Store the data on the requested property.
535 If the selection is large, only store the first N bytes of it.
536 */
537 bytes_remaining = size * format_bytes;
538 if (bytes_remaining <= max_bytes)
539 {
540 /* Send all the data at once, with minimal handshaking. */
541 #if 0
542 fprintf (stderr,"\nStoring all %d\n", bytes_remaining);
543 #endif
544 XChangeProperty (display, window, reply.property, type, format,
545 PropModeReplace, data, size);
546 /* At this point, the selection was successfully stored; ack it. */
547 XSendEvent (display, window, False, 0L, (XEvent *) &reply);
548 }
549 else
550 {
551 /* Send an INCR selection. */
552 struct prop_location *wait_object;
553 int had_errors;
554 Lisp_Object frame;
555
556 frame = some_frame_on_display (dpyinfo);
557
558 /* If the display no longer has frames, we can't expect
559 to get many more selection requests from it, so don't
560 bother trying to queue them. */
561 if (!NILP (frame))
562 {
563 x_start_queuing_selection_requests (display);
564
565 record_unwind_protect (queue_selection_requests_unwind,
566 frame);
567 }
568
569 if (x_window_to_frame (dpyinfo, window)) /* #### debug */
570 error ("Attempt to transfer an INCR to ourself!");
571 #if 0
572 fprintf (stderr, "\nINCR %d\n", bytes_remaining);
573 #endif
574 wait_object = expect_property_change (display, window, reply.property,
575 PropertyDelete);
576
577 XChangeProperty (display, window, reply.property, dpyinfo->Xatom_INCR,
578 32, PropModeReplace,
579 (unsigned char *) &bytes_remaining, 1);
580 XSelectInput (display, window, PropertyChangeMask);
581 /* Tell 'em the INCR data is there... */
582 XSendEvent (display, window, False, 0L, (XEvent *) &reply);
583 XFlush (display);
584
585 had_errors = x_had_errors_p (display);
586 UNBLOCK_INPUT;
587
588 /* First, wait for the requester to ack by deleting the property.
589 This can run random lisp code (process handlers) or signal. */
590 if (! had_errors)
591 wait_for_property_change (wait_object);
592
593 while (bytes_remaining)
594 {
595 int i = ((bytes_remaining < max_bytes)
596 ? bytes_remaining
597 : max_bytes);
598
599 BLOCK_INPUT;
600
601 wait_object
602 = expect_property_change (display, window, reply.property,
603 PropertyDelete);
604 #if 0
605 fprintf (stderr," INCR adding %d\n", i);
606 #endif
607 /* Append the next chunk of data to the property. */
608 XChangeProperty (display, window, reply.property, type, format,
609 PropModeAppend, data, i / format_bytes);
610 bytes_remaining -= i;
611 data += i;
612 XFlush (display);
613 had_errors = x_had_errors_p (display);
614 UNBLOCK_INPUT;
615
616 if (had_errors)
617 break;
618
619 /* Now wait for the requester to ack this chunk by deleting the
620 property. This can run random lisp code or signal.
621 */
622 wait_for_property_change (wait_object);
623 }
624 /* Now write a zero-length chunk to the property to tell the requester
625 that we're done. */
626 #if 0
627 fprintf (stderr," INCR done\n");
628 #endif
629 BLOCK_INPUT;
630 if (! waiting_for_other_props_on_window (display, window))
631 XSelectInput (display, window, 0L);
632
633 XChangeProperty (display, window, reply.property, type, format,
634 PropModeReplace, data, 0);
635 }
636
637 XFlush (display);
638 x_uncatch_errors (display, count);
639 UNBLOCK_INPUT;
640 }
641 \f
642 /* Handle a SelectionRequest event EVENT.
643 This is called from keyboard.c when such an event is found in the queue. */
644
645 void
646 x_handle_selection_request (event)
647 struct input_event *event;
648 {
649 struct gcpro gcpro1, gcpro2, gcpro3;
650 Lisp_Object local_selection_data;
651 Lisp_Object selection_symbol;
652 Lisp_Object target_symbol;
653 Lisp_Object converted_selection;
654 Time local_selection_time;
655 Lisp_Object successful_p;
656 int count;
657 struct x_display_info *dpyinfo
658 = x_display_info_for_display (SELECTION_EVENT_DISPLAY (event));
659
660 local_selection_data = Qnil;
661 target_symbol = Qnil;
662 converted_selection = Qnil;
663 successful_p = Qnil;
664
665 GCPRO3 (local_selection_data, converted_selection, target_symbol);
666
667 selection_symbol = x_atom_to_symbol (dpyinfo,
668 SELECTION_EVENT_DISPLAY (event),
669 SELECTION_EVENT_SELECTION (event));
670
671 local_selection_data = assq_no_quit (selection_symbol, Vselection_alist);
672
673 if (NILP (local_selection_data))
674 {
675 /* Someone asked for the selection, but we don't have it any more.
676 */
677 x_decline_selection_request (event);
678 goto DONE;
679 }
680
681 local_selection_time = (Time)
682 cons_to_long (XCONS (XCONS (XCONS (local_selection_data)->cdr)->cdr)->car);
683
684 if (SELECTION_EVENT_TIME (event) != CurrentTime
685 && local_selection_time > SELECTION_EVENT_TIME (event))
686 {
687 /* Someone asked for the selection, and we have one, but not the one
688 they're looking for.
689 */
690 x_decline_selection_request (event);
691 goto DONE;
692 }
693
694 count = specpdl_ptr - specpdl;
695 x_selection_current_request = event;
696 record_unwind_protect (x_selection_request_lisp_error, Qnil);
697
698 target_symbol = x_atom_to_symbol (dpyinfo, SELECTION_EVENT_DISPLAY (event),
699 SELECTION_EVENT_TARGET (event));
700
701 #if 0 /* #### MULTIPLE doesn't work yet */
702 if (EQ (target_symbol, QMULTIPLE))
703 target_symbol = fetch_multiple_target (event);
704 #endif
705
706 /* Convert lisp objects back into binary data */
707
708 converted_selection
709 = x_get_local_selection (selection_symbol, target_symbol);
710
711 if (! NILP (converted_selection))
712 {
713 unsigned char *data;
714 unsigned int size;
715 int format;
716 Atom type;
717 int nofree;
718
719 lisp_data_to_selection_data (SELECTION_EVENT_DISPLAY (event),
720 converted_selection,
721 &data, &type, &size, &format, &nofree);
722
723 x_reply_selection_request (event, format, data, size, type);
724 successful_p = Qt;
725
726 /* Indicate we have successfully processed this event. */
727 x_selection_current_request = 0;
728
729 /* Use free, not XFree, because lisp_data_to_selection_data
730 calls xmalloc itself. */
731 if (!nofree)
732 free (data);
733 }
734 unbind_to (count, Qnil);
735
736 DONE:
737
738 UNGCPRO;
739
740 /* Let random lisp code notice that the selection has been asked for. */
741 {
742 Lisp_Object rest;
743 rest = Vx_sent_selection_hooks;
744 if (!EQ (rest, Qunbound))
745 for (; CONSP (rest); rest = Fcdr (rest))
746 call3 (Fcar (rest), selection_symbol, target_symbol, successful_p);
747 }
748 }
749 \f
750 /* Handle a SelectionClear event EVENT, which indicates that some other
751 client cleared out our previously asserted selection.
752 This is called from keyboard.c when such an event is found in the queue. */
753
754 void
755 x_handle_selection_clear (event)
756 struct input_event *event;
757 {
758 Display *display = SELECTION_EVENT_DISPLAY (event);
759 Atom selection = SELECTION_EVENT_SELECTION (event);
760 Time changed_owner_time = SELECTION_EVENT_TIME (event);
761
762 Lisp_Object selection_symbol, local_selection_data;
763 Time local_selection_time;
764 struct x_display_info *dpyinfo = x_display_info_for_display (display);
765
766 selection_symbol = x_atom_to_symbol (dpyinfo, display, selection);
767
768 local_selection_data = assq_no_quit (selection_symbol, Vselection_alist);
769
770 /* Well, we already believe that we don't own it, so that's just fine. */
771 if (NILP (local_selection_data)) return;
772
773 local_selection_time = (Time)
774 cons_to_long (XCONS (XCONS (XCONS (local_selection_data)->cdr)->cdr)->car);
775
776 /* This SelectionClear is for a selection that we no longer own, so we can
777 disregard it. (That is, we have reasserted the selection since this
778 request was generated.) */
779
780 if (changed_owner_time != CurrentTime
781 && local_selection_time > changed_owner_time)
782 return;
783
784 /* Otherwise, we're really honest and truly being told to drop it.
785 Don't use Fdelq as that may QUIT;. */
786
787 if (EQ (local_selection_data, Fcar (Vselection_alist)))
788 Vselection_alist = Fcdr (Vselection_alist);
789 else
790 {
791 Lisp_Object rest;
792 for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
793 if (EQ (local_selection_data, Fcar (XCONS (rest)->cdr)))
794 {
795 XCONS (rest)->cdr = Fcdr (XCONS (rest)->cdr);
796 break;
797 }
798 }
799
800 /* Let random lisp code notice that the selection has been stolen. */
801
802 {
803 Lisp_Object rest;
804 rest = Vx_lost_selection_hooks;
805 if (!EQ (rest, Qunbound))
806 {
807 for (; CONSP (rest); rest = Fcdr (rest))
808 call1 (Fcar (rest), selection_symbol);
809 prepare_menu_bars ();
810 redisplay_preserve_echo_area ();
811 }
812 }
813 }
814
815 /* Clear all selections that were made from frame F.
816 We do this when about to delete a frame. */
817
818 void
819 x_clear_frame_selections (f)
820 FRAME_PTR f;
821 {
822 Lisp_Object frame;
823 Lisp_Object rest;
824
825 XSETFRAME (frame, f);
826
827 /* Otherwise, we're really honest and truly being told to drop it.
828 Don't use Fdelq as that may QUIT;. */
829
830 /* Delete elements from the beginning of Vselection_alist. */
831 while (!NILP (Vselection_alist)
832 && EQ (frame, Fcar (Fcdr (Fcdr (Fcdr (Fcar (Vselection_alist)))))))
833 {
834 /* Let random Lisp code notice that the selection has been stolen. */
835 Lisp_Object hooks, selection_symbol;
836
837 hooks = Vx_lost_selection_hooks;
838 selection_symbol = Fcar (Fcar (Vselection_alist));
839
840 if (!EQ (hooks, Qunbound))
841 {
842 for (; CONSP (hooks); hooks = Fcdr (hooks))
843 call1 (Fcar (hooks), selection_symbol);
844 #if 0 /* This can crash when deleting a frame
845 from x_connection_closed. Anyway, it seems unnecessary;
846 something else should cause a redisplay. */
847 redisplay_preserve_echo_area ();
848 #endif
849 }
850
851 Vselection_alist = Fcdr (Vselection_alist);
852 }
853
854 /* Delete elements after the beginning of Vselection_alist. */
855 for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
856 if (EQ (frame, Fcar (Fcdr (Fcdr (Fcdr (Fcar (XCONS (rest)->cdr)))))))
857 {
858 /* Let random Lisp code notice that the selection has been stolen. */
859 Lisp_Object hooks, selection_symbol;
860
861 hooks = Vx_lost_selection_hooks;
862 selection_symbol = Fcar (Fcar (XCONS (rest)->cdr));
863
864 if (!EQ (hooks, Qunbound))
865 {
866 for (; CONSP (hooks); hooks = Fcdr (hooks))
867 call1 (Fcar (hooks), selection_symbol);
868 #if 0 /* See above */
869 redisplay_preserve_echo_area ();
870 #endif
871 }
872 XCONS (rest)->cdr = Fcdr (XCONS (rest)->cdr);
873 break;
874 }
875 }
876 \f
877 /* Nonzero if any properties for DISPLAY and WINDOW
878 are on the list of what we are waiting for. */
879
880 static int
881 waiting_for_other_props_on_window (display, window)
882 Display *display;
883 Window window;
884 {
885 struct prop_location *rest = property_change_wait_list;
886 while (rest)
887 if (rest->display == display && rest->window == window)
888 return 1;
889 else
890 rest = rest->next;
891 return 0;
892 }
893
894 /* Add an entry to the list of property changes we are waiting for.
895 DISPLAY, WINDOW, PROPERTY, STATE describe what we will wait for.
896 The return value is a number that uniquely identifies
897 this awaited property change. */
898
899 static struct prop_location *
900 expect_property_change (display, window, property, state)
901 Display *display;
902 Window window;
903 Atom property;
904 int state;
905 {
906 struct prop_location *pl
907 = (struct prop_location *) xmalloc (sizeof (struct prop_location));
908 pl->identifier = ++prop_location_identifier;
909 pl->display = display;
910 pl->window = window;
911 pl->property = property;
912 pl->desired_state = state;
913 pl->next = property_change_wait_list;
914 pl->arrived = 0;
915 property_change_wait_list = pl;
916 return pl;
917 }
918
919 /* Delete an entry from the list of property changes we are waiting for.
920 IDENTIFIER is the number that uniquely identifies the entry. */
921
922 static void
923 unexpect_property_change (location)
924 struct prop_location *location;
925 {
926 struct prop_location *prev = 0, *rest = property_change_wait_list;
927 while (rest)
928 {
929 if (rest == location)
930 {
931 if (prev)
932 prev->next = rest->next;
933 else
934 property_change_wait_list = rest->next;
935 free (rest);
936 return;
937 }
938 prev = rest;
939 rest = rest->next;
940 }
941 }
942
943 /* Remove the property change expectation element for IDENTIFIER. */
944
945 static Lisp_Object
946 wait_for_property_change_unwind (identifierval)
947 Lisp_Object identifierval;
948 {
949 unexpect_property_change ((struct prop_location *)
950 (XFASTINT (XCONS (identifierval)->car) << 16
951 | XFASTINT (XCONS (identifierval)->cdr)));
952 return Qnil;
953 }
954
955 /* Actually wait for a property change.
956 IDENTIFIER should be the value that expect_property_change returned. */
957
958 static void
959 wait_for_property_change (location)
960 struct prop_location *location;
961 {
962 int secs, usecs;
963 int count = specpdl_ptr - specpdl;
964 Lisp_Object tem;
965
966 tem = Fcons (Qnil, Qnil);
967 XSETFASTINT (XCONS (tem)->car, (EMACS_UINT)location >> 16);
968 XSETFASTINT (XCONS (tem)->cdr, (EMACS_UINT)location & 0xffff);
969
970 /* Make sure to do unexpect_property_change if we quit or err. */
971 record_unwind_protect (wait_for_property_change_unwind, tem);
972
973 XCONS (property_change_reply)->car = Qnil;
974
975 property_change_reply_object = location;
976 /* If the event we are waiting for arrives beyond here, it will set
977 property_change_reply, because property_change_reply_object says so. */
978 if (! location->arrived)
979 {
980 secs = x_selection_timeout / 1000;
981 usecs = (x_selection_timeout % 1000) * 1000;
982 wait_reading_process_input (secs, usecs, property_change_reply, 0);
983
984 if (NILP (XCONS (property_change_reply)->car))
985 error ("Timed out waiting for property-notify event");
986 }
987
988 unbind_to (count, Qnil);
989 }
990
991 /* Called from XTread_socket in response to a PropertyNotify event. */
992
993 void
994 x_handle_property_notify (event)
995 XPropertyEvent *event;
996 {
997 struct prop_location *prev = 0, *rest = property_change_wait_list;
998 while (rest)
999 {
1000 if (rest->property == event->atom
1001 && rest->window == event->window
1002 && rest->display == event->display
1003 && rest->desired_state == event->state)
1004 {
1005 #if 0
1006 fprintf (stderr, "Saw expected prop-%s on %s\n",
1007 (event->state == PropertyDelete ? "delete" : "change"),
1008 (char *) XSYMBOL (x_atom_to_symbol (dpyinfo, event->display,
1009 event->atom))
1010 ->name->data);
1011 #endif
1012
1013 rest->arrived = 1;
1014
1015 /* If this is the one wait_for_property_change is waiting for,
1016 tell it to wake up. */
1017 if (rest == property_change_reply_object)
1018 XCONS (property_change_reply)->car = Qt;
1019
1020 if (prev)
1021 prev->next = rest->next;
1022 else
1023 property_change_wait_list = rest->next;
1024 free (rest);
1025 return;
1026 }
1027 prev = rest;
1028 rest = rest->next;
1029 }
1030 #if 0
1031 fprintf (stderr, "Saw UNexpected prop-%s on %s\n",
1032 (event->state == PropertyDelete ? "delete" : "change"),
1033 (char *) XSYMBOL (x_atom_to_symbol (dpyinfo,
1034 event->display, event->atom))
1035 ->name->data);
1036 #endif
1037 }
1038
1039
1040 \f
1041 #if 0 /* #### MULTIPLE doesn't work yet */
1042
1043 static Lisp_Object
1044 fetch_multiple_target (event)
1045 XSelectionRequestEvent *event;
1046 {
1047 Display *display = event->display;
1048 Window window = event->requestor;
1049 Atom target = event->target;
1050 Atom selection_atom = event->selection;
1051 int result;
1052
1053 return
1054 Fcons (QMULTIPLE,
1055 x_get_window_property_as_lisp_data (display, window, target,
1056 QMULTIPLE, selection_atom));
1057 }
1058
1059 static Lisp_Object
1060 copy_multiple_data (obj)
1061 Lisp_Object obj;
1062 {
1063 Lisp_Object vec;
1064 int i;
1065 int size;
1066 if (CONSP (obj))
1067 return Fcons (XCONS (obj)->car, copy_multiple_data (XCONS (obj)->cdr));
1068
1069 CHECK_VECTOR (obj, 0);
1070 vec = Fmake_vector (size = XVECTOR (obj)->size, Qnil);
1071 for (i = 0; i < size; i++)
1072 {
1073 Lisp_Object vec2 = XVECTOR (obj)->contents [i];
1074 CHECK_VECTOR (vec2, 0);
1075 if (XVECTOR (vec2)->size != 2)
1076 /* ??? Confusing error message */
1077 Fsignal (Qerror, Fcons (build_string ("vectors must be of length 2"),
1078 Fcons (vec2, Qnil)));
1079 XVECTOR (vec)->contents [i] = Fmake_vector (2, Qnil);
1080 XVECTOR (XVECTOR (vec)->contents [i])->contents [0]
1081 = XVECTOR (vec2)->contents [0];
1082 XVECTOR (XVECTOR (vec)->contents [i])->contents [1]
1083 = XVECTOR (vec2)->contents [1];
1084 }
1085 return vec;
1086 }
1087
1088 #endif
1089
1090 \f
1091 /* Variables for communication with x_handle_selection_notify. */
1092 static Atom reading_which_selection;
1093 static Lisp_Object reading_selection_reply;
1094 static Window reading_selection_window;
1095
1096 /* Do protocol to read selection-data from the server.
1097 Converts this to Lisp data and returns it. */
1098
1099 static Lisp_Object
1100 x_get_foreign_selection (selection_symbol, target_type)
1101 Lisp_Object selection_symbol, target_type;
1102 {
1103 Window requestor_window = FRAME_X_WINDOW (selected_frame);
1104 Display *display = FRAME_X_DISPLAY (selected_frame);
1105 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (selected_frame);
1106 Time requestor_time = last_event_timestamp;
1107 Atom target_property = dpyinfo->Xatom_EMACS_TMP;
1108 Atom selection_atom = symbol_to_x_atom (dpyinfo, display, selection_symbol);
1109 Atom type_atom;
1110 int secs, usecs;
1111 int count;
1112 Lisp_Object frame;
1113
1114 if (CONSP (target_type))
1115 type_atom = symbol_to_x_atom (dpyinfo, display, XCONS (target_type)->car);
1116 else
1117 type_atom = symbol_to_x_atom (dpyinfo, display, target_type);
1118
1119 BLOCK_INPUT;
1120 count = x_catch_errors (display);
1121 XConvertSelection (display, selection_atom, type_atom, target_property,
1122 requestor_window, requestor_time);
1123 XFlush (display);
1124
1125 /* Prepare to block until the reply has been read. */
1126 reading_selection_window = requestor_window;
1127 reading_which_selection = selection_atom;
1128 XCONS (reading_selection_reply)->car = Qnil;
1129
1130 frame = some_frame_on_display (dpyinfo);
1131
1132 /* If the display no longer has frames, we can't expect
1133 to get many more selection requests from it, so don't
1134 bother trying to queue them. */
1135 if (!NILP (frame))
1136 {
1137 x_start_queuing_selection_requests (display);
1138
1139 record_unwind_protect (queue_selection_requests_unwind,
1140 frame);
1141 }
1142 UNBLOCK_INPUT;
1143
1144 /* This allows quits. Also, don't wait forever. */
1145 secs = x_selection_timeout / 1000;
1146 usecs = (x_selection_timeout % 1000) * 1000;
1147 wait_reading_process_input (secs, usecs, reading_selection_reply, 0);
1148
1149 BLOCK_INPUT;
1150 x_check_errors (display, "Cannot get selection: %s");
1151 x_uncatch_errors (display, count);
1152 UNBLOCK_INPUT;
1153
1154 if (NILP (XCONS (reading_selection_reply)->car))
1155 error ("Timed out waiting for reply from selection owner");
1156 if (EQ (XCONS (reading_selection_reply)->car, Qlambda))
1157 error ("No `%s' selection", XSYMBOL (selection_symbol)->name->data);
1158
1159 /* Otherwise, the selection is waiting for us on the requested property. */
1160 return
1161 x_get_window_property_as_lisp_data (display, requestor_window,
1162 target_property, target_type,
1163 selection_atom);
1164 }
1165 \f
1166 /* Subroutines of x_get_window_property_as_lisp_data */
1167
1168 /* Use free, not XFree, to free the data obtained with this function. */
1169
1170 static void
1171 x_get_window_property (display, window, property, data_ret, bytes_ret,
1172 actual_type_ret, actual_format_ret, actual_size_ret,
1173 delete_p)
1174 Display *display;
1175 Window window;
1176 Atom property;
1177 unsigned char **data_ret;
1178 int *bytes_ret;
1179 Atom *actual_type_ret;
1180 int *actual_format_ret;
1181 unsigned long *actual_size_ret;
1182 int delete_p;
1183 {
1184 int total_size;
1185 unsigned long bytes_remaining;
1186 int offset = 0;
1187 unsigned char *tmp_data = 0;
1188 int result;
1189 int buffer_size = SELECTION_QUANTUM (display);
1190 if (buffer_size > MAX_SELECTION_QUANTUM) buffer_size = MAX_SELECTION_QUANTUM;
1191
1192 BLOCK_INPUT;
1193 /* First probe the thing to find out how big it is. */
1194 result = XGetWindowProperty (display, window, property,
1195 0L, 0L, False, AnyPropertyType,
1196 actual_type_ret, actual_format_ret,
1197 actual_size_ret,
1198 &bytes_remaining, &tmp_data);
1199 if (result != Success)
1200 {
1201 UNBLOCK_INPUT;
1202 *data_ret = 0;
1203 *bytes_ret = 0;
1204 return;
1205 }
1206 /* This was allocated by Xlib, so use XFree. */
1207 XFree ((char *) tmp_data);
1208
1209 if (*actual_type_ret == None || *actual_format_ret == 0)
1210 {
1211 UNBLOCK_INPUT;
1212 return;
1213 }
1214
1215 total_size = bytes_remaining + 1;
1216 *data_ret = (unsigned char *) xmalloc (total_size);
1217
1218 /* Now read, until we've gotten it all. */
1219 while (bytes_remaining)
1220 {
1221 #if 0
1222 int last = bytes_remaining;
1223 #endif
1224 result
1225 = XGetWindowProperty (display, window, property,
1226 (long)offset/4, (long)buffer_size/4,
1227 False,
1228 AnyPropertyType,
1229 actual_type_ret, actual_format_ret,
1230 actual_size_ret, &bytes_remaining, &tmp_data);
1231 #if 0
1232 fprintf (stderr, "<< read %d\n", last-bytes_remaining);
1233 #endif
1234 /* If this doesn't return Success at this point, it means that
1235 some clod deleted the selection while we were in the midst of
1236 reading it. Deal with that, I guess....
1237 */
1238 if (result != Success) break;
1239 *actual_size_ret *= *actual_format_ret / 8;
1240 bcopy (tmp_data, (*data_ret) + offset, *actual_size_ret);
1241 offset += *actual_size_ret;
1242 /* This was allocated by Xlib, so use XFree. */
1243 XFree ((char *) tmp_data);
1244 }
1245
1246 XFlush (display);
1247 UNBLOCK_INPUT;
1248 *bytes_ret = offset;
1249 }
1250 \f
1251 /* Use free, not XFree, to free the data obtained with this function. */
1252
1253 static void
1254 receive_incremental_selection (display, window, property, target_type,
1255 min_size_bytes, data_ret, size_bytes_ret,
1256 type_ret, format_ret, size_ret)
1257 Display *display;
1258 Window window;
1259 Atom property;
1260 Lisp_Object target_type; /* for error messages only */
1261 unsigned int min_size_bytes;
1262 unsigned char **data_ret;
1263 int *size_bytes_ret;
1264 Atom *type_ret;
1265 unsigned long *size_ret;
1266 int *format_ret;
1267 {
1268 int offset = 0;
1269 struct prop_location *wait_object;
1270 *size_bytes_ret = min_size_bytes;
1271 *data_ret = (unsigned char *) xmalloc (*size_bytes_ret);
1272 #if 0
1273 fprintf (stderr, "\nread INCR %d\n", min_size_bytes);
1274 #endif
1275
1276 /* At this point, we have read an INCR property.
1277 Delete the property to ack it.
1278 (But first, prepare to receive the next event in this handshake.)
1279
1280 Now, we must loop, waiting for the sending window to put a value on
1281 that property, then reading the property, then deleting it to ack.
1282 We are done when the sender places a property of length 0.
1283 */
1284 BLOCK_INPUT;
1285 XSelectInput (display, window, STANDARD_EVENT_SET | PropertyChangeMask);
1286 XDeleteProperty (display, window, property);
1287 wait_object = expect_property_change (display, window, property,
1288 PropertyNewValue);
1289 XFlush (display);
1290 UNBLOCK_INPUT;
1291
1292 while (1)
1293 {
1294 unsigned char *tmp_data;
1295 int tmp_size_bytes;
1296 wait_for_property_change (wait_object);
1297 /* expect it again immediately, because x_get_window_property may
1298 .. no it won't, I don't get it.
1299 .. Ok, I get it now, the Xt code that implements INCR is broken.
1300 */
1301 x_get_window_property (display, window, property,
1302 &tmp_data, &tmp_size_bytes,
1303 type_ret, format_ret, size_ret, 1);
1304
1305 if (tmp_size_bytes == 0) /* we're done */
1306 {
1307 #if 0
1308 fprintf (stderr, " read INCR done\n");
1309 #endif
1310 if (! waiting_for_other_props_on_window (display, window))
1311 XSelectInput (display, window, STANDARD_EVENT_SET);
1312 unexpect_property_change (wait_object);
1313 /* Use free, not XFree, because x_get_window_property
1314 calls xmalloc itself. */
1315 if (tmp_data) free (tmp_data);
1316 break;
1317 }
1318
1319 BLOCK_INPUT;
1320 XDeleteProperty (display, window, property);
1321 wait_object = expect_property_change (display, window, property,
1322 PropertyNewValue);
1323 XFlush (display);
1324 UNBLOCK_INPUT;
1325
1326 #if 0
1327 fprintf (stderr, " read INCR %d\n", tmp_size_bytes);
1328 #endif
1329 if (*size_bytes_ret < offset + tmp_size_bytes)
1330 {
1331 #if 0
1332 fprintf (stderr, " read INCR realloc %d -> %d\n",
1333 *size_bytes_ret, offset + tmp_size_bytes);
1334 #endif
1335 *size_bytes_ret = offset + tmp_size_bytes;
1336 *data_ret = (unsigned char *) xrealloc (*data_ret, *size_bytes_ret);
1337 }
1338 bcopy (tmp_data, (*data_ret) + offset, tmp_size_bytes);
1339 offset += tmp_size_bytes;
1340 /* Use free, not XFree, because x_get_window_property
1341 calls xmalloc itself. */
1342 free (tmp_data);
1343 }
1344 }
1345 \f
1346 /* Once a requested selection is "ready" (we got a SelectionNotify event),
1347 fetch value from property PROPERTY of X window WINDOW on display DISPLAY.
1348 TARGET_TYPE and SELECTION_ATOM are used in error message if this fails. */
1349
1350 static Lisp_Object
1351 x_get_window_property_as_lisp_data (display, window, property, target_type,
1352 selection_atom)
1353 Display *display;
1354 Window window;
1355 Atom property;
1356 Lisp_Object target_type; /* for error messages only */
1357 Atom selection_atom; /* for error messages only */
1358 {
1359 Atom actual_type;
1360 int actual_format;
1361 unsigned long actual_size;
1362 unsigned char *data = 0;
1363 int bytes = 0;
1364 Lisp_Object val;
1365 struct x_display_info *dpyinfo = x_display_info_for_display (display);
1366
1367 x_get_window_property (display, window, property, &data, &bytes,
1368 &actual_type, &actual_format, &actual_size, 1);
1369 if (! data)
1370 {
1371 int there_is_a_selection_owner;
1372 BLOCK_INPUT;
1373 there_is_a_selection_owner
1374 = XGetSelectionOwner (display, selection_atom);
1375 UNBLOCK_INPUT;
1376 Fsignal (Qerror,
1377 there_is_a_selection_owner
1378 ? Fcons (build_string ("selection owner couldn't convert"),
1379 actual_type
1380 ? Fcons (target_type,
1381 Fcons (x_atom_to_symbol (dpyinfo, display,
1382 actual_type),
1383 Qnil))
1384 : Fcons (target_type, Qnil))
1385 : Fcons (build_string ("no selection"),
1386 Fcons (x_atom_to_symbol (dpyinfo, display,
1387 selection_atom),
1388 Qnil)));
1389 }
1390
1391 if (actual_type == dpyinfo->Xatom_INCR)
1392 {
1393 /* That wasn't really the data, just the beginning. */
1394
1395 unsigned int min_size_bytes = * ((unsigned int *) data);
1396 BLOCK_INPUT;
1397 /* Use free, not XFree, because x_get_window_property
1398 calls xmalloc itself. */
1399 free ((char *) data);
1400 UNBLOCK_INPUT;
1401 receive_incremental_selection (display, window, property, target_type,
1402 min_size_bytes, &data, &bytes,
1403 &actual_type, &actual_format,
1404 &actual_size);
1405 }
1406
1407 BLOCK_INPUT;
1408 XDeleteProperty (display, window, property);
1409 XFlush (display);
1410 UNBLOCK_INPUT;
1411
1412 /* It's been read. Now convert it to a lisp object in some semi-rational
1413 manner. */
1414 val = selection_data_to_lisp_data (display, data, bytes,
1415 actual_type, actual_format);
1416
1417 /* Use free, not XFree, because x_get_window_property
1418 calls xmalloc itself. */
1419 free ((char *) data);
1420 return val;
1421 }
1422 \f
1423 /* These functions convert from the selection data read from the server into
1424 something that we can use from Lisp, and vice versa.
1425
1426 Type: Format: Size: Lisp Type:
1427 ----- ------- ----- -----------
1428 * 8 * String
1429 ATOM 32 1 Symbol
1430 ATOM 32 > 1 Vector of Symbols
1431 * 16 1 Integer
1432 * 16 > 1 Vector of Integers
1433 * 32 1 if <=16 bits: Integer
1434 if > 16 bits: Cons of top16, bot16
1435 * 32 > 1 Vector of the above
1436
1437 When converting a Lisp number to C, it is assumed to be of format 16 if
1438 it is an integer, and of format 32 if it is a cons of two integers.
1439
1440 When converting a vector of numbers from Lisp to C, it is assumed to be
1441 of format 16 if every element in the vector is an integer, and is assumed
1442 to be of format 32 if any element is a cons of two integers.
1443
1444 When converting an object to C, it may be of the form (SYMBOL . <data>)
1445 where SYMBOL is what we should claim that the type is. Format and
1446 representation are as above. */
1447
1448
1449
1450 static Lisp_Object
1451 selection_data_to_lisp_data (display, data, size, type, format)
1452 Display *display;
1453 unsigned char *data;
1454 Atom type;
1455 int size, format;
1456 {
1457 struct x_display_info *dpyinfo = x_display_info_for_display (display);
1458
1459 if (type == dpyinfo->Xatom_NULL)
1460 return QNULL;
1461
1462 /* Convert any 8-bit data to a string, for compactness. */
1463 else if (format == 8)
1464 {
1465 Lisp_Object str;
1466 int require_encoding = 0;
1467
1468 /* If TYPE is `TEXT' or `COMPOUND_TEXT', we should decode DATA
1469 to Emacs internal format because DATA may be encoded in
1470 compound text format. In addtion, if TYPE is `STRING' and
1471 DATA contains any 8-bit Latin-1 code, we should also decode
1472 it. */
1473 if (type == dpyinfo->Xatom_TEXT || type == dpyinfo->Xatom_COMPOUND_TEXT)
1474 require_encoding = 1;
1475 else if (type == XA_STRING)
1476 {
1477 int i;
1478 for (i = 0; i < size; i++)
1479 {
1480 if (data[i] >= 0x80)
1481 {
1482 require_encoding = 1;
1483 break;
1484 }
1485 }
1486 }
1487 if (!require_encoding)
1488 str = make_string ((char *) data, size);
1489 else
1490 {
1491 int bufsize, dummy;
1492 unsigned char *buf;
1493 struct coding_system coding;
1494 Lisp_Object sym = intern ("iso-latin-1");
1495
1496 setup_coding_system (Fcheck_coding_system (sym), &coding);
1497 coding.last_block = 1;
1498 bufsize = decoding_buffer_size (&coding, size);
1499 buf = (unsigned char *) xmalloc (bufsize);
1500 size = decode_coding (&coding, data, buf, size, bufsize, &dummy);
1501 str = make_string ((char *) buf, size);
1502 free (buf);
1503 }
1504 return str;
1505 }
1506 /* Convert a single atom to a Lisp_Symbol. Convert a set of atoms to
1507 a vector of symbols.
1508 */
1509 else if (type == XA_ATOM)
1510 {
1511 int i;
1512 if (size == sizeof (Atom))
1513 return x_atom_to_symbol (dpyinfo, display, *((Atom *) data));
1514 else
1515 {
1516 Lisp_Object v = Fmake_vector (make_number (size / sizeof (Atom)),
1517 make_number (0));
1518 for (i = 0; i < size / sizeof (Atom); i++)
1519 Faset (v, make_number (i),
1520 x_atom_to_symbol (dpyinfo, display, ((Atom *) data) [i]));
1521 return v;
1522 }
1523 }
1524
1525 /* Convert a single 16 or small 32 bit number to a Lisp_Int.
1526 If the number is > 16 bits, convert it to a cons of integers,
1527 16 bits in each half.
1528 */
1529 else if (format == 32 && size == sizeof (long))
1530 return long_to_cons (((unsigned long *) data) [0]);
1531 else if (format == 16 && size == sizeof (short))
1532 return make_number ((int) (((unsigned short *) data) [0]));
1533
1534 /* Convert any other kind of data to a vector of numbers, represented
1535 as above (as an integer, or a cons of two 16 bit integers.)
1536 */
1537 else if (format == 16)
1538 {
1539 int i;
1540 Lisp_Object v;
1541 v = Fmake_vector (make_number (size / 2), make_number (0));
1542 for (i = 0; i < size / 2; i++)
1543 {
1544 int j = (int) ((unsigned short *) data) [i];
1545 Faset (v, make_number (i), make_number (j));
1546 }
1547 return v;
1548 }
1549 else
1550 {
1551 int i;
1552 Lisp_Object v = Fmake_vector (make_number (size / 4), make_number (0));
1553 for (i = 0; i < size / 4; i++)
1554 {
1555 unsigned long j = ((unsigned long *) data) [i];
1556 Faset (v, make_number (i), long_to_cons (j));
1557 }
1558 return v;
1559 }
1560 }
1561
1562
1563 /* Use free, not XFree, to free the data obtained with this function. */
1564
1565 static void
1566 lisp_data_to_selection_data (display, obj,
1567 data_ret, type_ret, size_ret,
1568 format_ret, nofree_ret)
1569 Display *display;
1570 Lisp_Object obj;
1571 unsigned char **data_ret;
1572 Atom *type_ret;
1573 unsigned int *size_ret;
1574 int *format_ret;
1575 int *nofree_ret;
1576 {
1577 Lisp_Object type = Qnil;
1578 struct x_display_info *dpyinfo = x_display_info_for_display (display);
1579
1580 *nofree_ret = 0;
1581
1582 if (CONSP (obj) && SYMBOLP (XCONS (obj)->car))
1583 {
1584 type = XCONS (obj)->car;
1585 obj = XCONS (obj)->cdr;
1586 if (CONSP (obj) && NILP (XCONS (obj)->cdr))
1587 obj = XCONS (obj)->car;
1588 }
1589
1590 if (EQ (obj, QNULL) || (EQ (type, QNULL)))
1591 { /* This is not the same as declining */
1592 *format_ret = 32;
1593 *size_ret = 0;
1594 *data_ret = 0;
1595 type = QNULL;
1596 }
1597 else if (STRINGP (obj))
1598 {
1599 /* Since we are now handling multilingual text, we must consider
1600 sending back compound text. */
1601 int charsets[MAX_CHARSET + 1];
1602 int num;
1603
1604 *format_ret = 8;
1605 *size_ret = XSTRING (obj)->size;
1606 *data_ret = XSTRING (obj)->data;
1607 bzero (charsets, (MAX_CHARSET + 1) * sizeof (int));
1608 num = ((*size_ret <= 1) /* Check the possibility of short cut. */
1609 ? 0
1610 : find_charset_in_str (*data_ret, *size_ret, charsets, Qnil));
1611
1612 if (!num || (num == 1 && charsets[CHARSET_ASCII]))
1613 {
1614 /* No multibyte character in OBJ. We need not encode it. */
1615 *nofree_ret = 1;
1616 if (NILP (type)) type = QSTRING;
1617 }
1618 else
1619 {
1620 /* We must encode contents of OBJ to compound text format.
1621 The format is compatible with what the target `STRING'
1622 expects if OBJ contains only ASCII and Latin-1
1623 characters. */
1624 int bufsize, dummy;
1625 unsigned char *buf;
1626 struct coding_system coding;
1627 Lisp_Object sym = intern ("iso-latin-1");
1628
1629 setup_coding_system (Fcheck_coding_system (sym), &coding);
1630 coding.last_block = 1;
1631 bufsize = encoding_buffer_size (&coding, *size_ret);
1632 buf = (unsigned char *) xmalloc (bufsize);
1633 *size_ret = encode_coding (&coding, *data_ret, buf,
1634 *size_ret, bufsize, &dummy);
1635 *data_ret = buf;
1636 if (charsets[charset_latin_iso8859_1]
1637 && (num == 1 || (num == 2 && charsets[CHARSET_ASCII])))
1638 {
1639 /* Ok, we can return it as `STRING'. */
1640 if (NILP (type)) type = QSTRING;
1641 }
1642 else
1643 {
1644 /* We must return it as `COMPOUND_TEXT'. */
1645 if (NILP (type)) type = QCOMPOUND_TEXT;
1646 }
1647 }
1648 }
1649 else if (SYMBOLP (obj))
1650 {
1651 *format_ret = 32;
1652 *size_ret = 1;
1653 *data_ret = (unsigned char *) xmalloc (sizeof (Atom) + 1);
1654 (*data_ret) [sizeof (Atom)] = 0;
1655 (*(Atom **) data_ret) [0] = symbol_to_x_atom (dpyinfo, display, obj);
1656 if (NILP (type)) type = QATOM;
1657 }
1658 else if (INTEGERP (obj)
1659 && XINT (obj) < 0xFFFF
1660 && XINT (obj) > -0xFFFF)
1661 {
1662 *format_ret = 16;
1663 *size_ret = 1;
1664 *data_ret = (unsigned char *) xmalloc (sizeof (short) + 1);
1665 (*data_ret) [sizeof (short)] = 0;
1666 (*(short **) data_ret) [0] = (short) XINT (obj);
1667 if (NILP (type)) type = QINTEGER;
1668 }
1669 else if (INTEGERP (obj)
1670 || (CONSP (obj) && INTEGERP (XCONS (obj)->car)
1671 && (INTEGERP (XCONS (obj)->cdr)
1672 || (CONSP (XCONS (obj)->cdr)
1673 && INTEGERP (XCONS (XCONS (obj)->cdr)->car)))))
1674 {
1675 *format_ret = 32;
1676 *size_ret = 1;
1677 *data_ret = (unsigned char *) xmalloc (sizeof (long) + 1);
1678 (*data_ret) [sizeof (long)] = 0;
1679 (*(unsigned long **) data_ret) [0] = cons_to_long (obj);
1680 if (NILP (type)) type = QINTEGER;
1681 }
1682 else if (VECTORP (obj))
1683 {
1684 /* Lisp_Vectors may represent a set of ATOMs;
1685 a set of 16 or 32 bit INTEGERs;
1686 or a set of ATOM_PAIRs (represented as [[A1 A2] [A3 A4] ...]
1687 */
1688 int i;
1689
1690 if (SYMBOLP (XVECTOR (obj)->contents [0]))
1691 /* This vector is an ATOM set */
1692 {
1693 if (NILP (type)) type = QATOM;
1694 *size_ret = XVECTOR (obj)->size;
1695 *format_ret = 32;
1696 *data_ret = (unsigned char *) xmalloc ((*size_ret) * sizeof (Atom));
1697 for (i = 0; i < *size_ret; i++)
1698 if (SYMBOLP (XVECTOR (obj)->contents [i]))
1699 (*(Atom **) data_ret) [i]
1700 = symbol_to_x_atom (dpyinfo, display, XVECTOR (obj)->contents [i]);
1701 else
1702 Fsignal (Qerror, /* Qselection_error */
1703 Fcons (build_string
1704 ("all elements of selection vector must have same type"),
1705 Fcons (obj, Qnil)));
1706 }
1707 #if 0 /* #### MULTIPLE doesn't work yet */
1708 else if (VECTORP (XVECTOR (obj)->contents [0]))
1709 /* This vector is an ATOM_PAIR set */
1710 {
1711 if (NILP (type)) type = QATOM_PAIR;
1712 *size_ret = XVECTOR (obj)->size;
1713 *format_ret = 32;
1714 *data_ret = (unsigned char *)
1715 xmalloc ((*size_ret) * sizeof (Atom) * 2);
1716 for (i = 0; i < *size_ret; i++)
1717 if (VECTORP (XVECTOR (obj)->contents [i]))
1718 {
1719 Lisp_Object pair = XVECTOR (obj)->contents [i];
1720 if (XVECTOR (pair)->size != 2)
1721 Fsignal (Qerror,
1722 Fcons (build_string
1723 ("elements of the vector must be vectors of exactly two elements"),
1724 Fcons (pair, Qnil)));
1725
1726 (*(Atom **) data_ret) [i * 2]
1727 = symbol_to_x_atom (dpyinfo, display,
1728 XVECTOR (pair)->contents [0]);
1729 (*(Atom **) data_ret) [(i * 2) + 1]
1730 = symbol_to_x_atom (dpyinfo, display,
1731 XVECTOR (pair)->contents [1]);
1732 }
1733 else
1734 Fsignal (Qerror,
1735 Fcons (build_string
1736 ("all elements of the vector must be of the same type"),
1737 Fcons (obj, Qnil)));
1738
1739 }
1740 #endif
1741 else
1742 /* This vector is an INTEGER set, or something like it */
1743 {
1744 *size_ret = XVECTOR (obj)->size;
1745 if (NILP (type)) type = QINTEGER;
1746 *format_ret = 16;
1747 for (i = 0; i < *size_ret; i++)
1748 if (CONSP (XVECTOR (obj)->contents [i]))
1749 *format_ret = 32;
1750 else if (!INTEGERP (XVECTOR (obj)->contents [i]))
1751 Fsignal (Qerror, /* Qselection_error */
1752 Fcons (build_string
1753 ("elements of selection vector must be integers or conses of integers"),
1754 Fcons (obj, Qnil)));
1755
1756 *data_ret = (unsigned char *) xmalloc (*size_ret * (*format_ret/8));
1757 for (i = 0; i < *size_ret; i++)
1758 if (*format_ret == 32)
1759 (*((unsigned long **) data_ret)) [i]
1760 = cons_to_long (XVECTOR (obj)->contents [i]);
1761 else
1762 (*((unsigned short **) data_ret)) [i]
1763 = (unsigned short) cons_to_long (XVECTOR (obj)->contents [i]);
1764 }
1765 }
1766 else
1767 Fsignal (Qerror, /* Qselection_error */
1768 Fcons (build_string ("unrecognised selection data"),
1769 Fcons (obj, Qnil)));
1770
1771 *type_ret = symbol_to_x_atom (dpyinfo, display, type);
1772 }
1773
1774 static Lisp_Object
1775 clean_local_selection_data (obj)
1776 Lisp_Object obj;
1777 {
1778 if (CONSP (obj)
1779 && INTEGERP (XCONS (obj)->car)
1780 && CONSP (XCONS (obj)->cdr)
1781 && INTEGERP (XCONS (XCONS (obj)->cdr)->car)
1782 && NILP (XCONS (XCONS (obj)->cdr)->cdr))
1783 obj = Fcons (XCONS (obj)->car, XCONS (obj)->cdr);
1784
1785 if (CONSP (obj)
1786 && INTEGERP (XCONS (obj)->car)
1787 && INTEGERP (XCONS (obj)->cdr))
1788 {
1789 if (XINT (XCONS (obj)->car) == 0)
1790 return XCONS (obj)->cdr;
1791 if (XINT (XCONS (obj)->car) == -1)
1792 return make_number (- XINT (XCONS (obj)->cdr));
1793 }
1794 if (VECTORP (obj))
1795 {
1796 int i;
1797 int size = XVECTOR (obj)->size;
1798 Lisp_Object copy;
1799 if (size == 1)
1800 return clean_local_selection_data (XVECTOR (obj)->contents [0]);
1801 copy = Fmake_vector (make_number (size), Qnil);
1802 for (i = 0; i < size; i++)
1803 XVECTOR (copy)->contents [i]
1804 = clean_local_selection_data (XVECTOR (obj)->contents [i]);
1805 return copy;
1806 }
1807 return obj;
1808 }
1809 \f
1810 /* Called from XTread_socket to handle SelectionNotify events.
1811 If it's the selection we are waiting for, stop waiting
1812 by setting the car of reading_selection_reply to non-nil.
1813 We store t there if the reply is successful, lambda if not. */
1814
1815 void
1816 x_handle_selection_notify (event)
1817 XSelectionEvent *event;
1818 {
1819 if (event->requestor != reading_selection_window)
1820 return;
1821 if (event->selection != reading_which_selection)
1822 return;
1823
1824 XCONS (reading_selection_reply)->car
1825 = (event->property != 0 ? Qt : Qlambda);
1826 }
1827
1828 \f
1829 DEFUN ("x-own-selection-internal", Fx_own_selection_internal,
1830 Sx_own_selection_internal, 2, 2, 0,
1831 "Assert an X selection of the given TYPE with the given VALUE.\n\
1832 TYPE is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.\n\
1833 \(Those are literal upper-case symbol names, since that's what X expects.)\n\
1834 VALUE is typically a string, or a cons of two markers, but may be\n\
1835 anything that the functions on `selection-converter-alist' know about.")
1836 (selection_name, selection_value)
1837 Lisp_Object selection_name, selection_value;
1838 {
1839 check_x ();
1840 CHECK_SYMBOL (selection_name, 0);
1841 if (NILP (selection_value)) error ("selection-value may not be nil");
1842 x_own_selection (selection_name, selection_value);
1843 return selection_value;
1844 }
1845
1846
1847 /* Request the selection value from the owner. If we are the owner,
1848 simply return our selection value. If we are not the owner, this
1849 will block until all of the data has arrived. */
1850
1851 DEFUN ("x-get-selection-internal", Fx_get_selection_internal,
1852 Sx_get_selection_internal, 2, 2, 0,
1853 "Return text selected from some X window.\n\
1854 SELECTION is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.\n\
1855 \(Those are literal upper-case symbol names, since that's what X expects.)\n\
1856 TYPE is the type of data desired, typically `STRING'.")
1857 (selection_symbol, target_type)
1858 Lisp_Object selection_symbol, target_type;
1859 {
1860 Lisp_Object val = Qnil;
1861 struct gcpro gcpro1, gcpro2;
1862 GCPRO2 (target_type, val); /* we store newly consed data into these */
1863 check_x ();
1864 CHECK_SYMBOL (selection_symbol, 0);
1865
1866 #if 0 /* #### MULTIPLE doesn't work yet */
1867 if (CONSP (target_type)
1868 && XCONS (target_type)->car == QMULTIPLE)
1869 {
1870 CHECK_VECTOR (XCONS (target_type)->cdr, 0);
1871 /* So we don't destructively modify this... */
1872 target_type = copy_multiple_data (target_type);
1873 }
1874 else
1875 #endif
1876 CHECK_SYMBOL (target_type, 0);
1877
1878 val = x_get_local_selection (selection_symbol, target_type);
1879
1880 if (NILP (val))
1881 {
1882 val = x_get_foreign_selection (selection_symbol, target_type);
1883 goto DONE;
1884 }
1885
1886 if (CONSP (val)
1887 && SYMBOLP (XCONS (val)->car))
1888 {
1889 val = XCONS (val)->cdr;
1890 if (CONSP (val) && NILP (XCONS (val)->cdr))
1891 val = XCONS (val)->car;
1892 }
1893 val = clean_local_selection_data (val);
1894 DONE:
1895 UNGCPRO;
1896 return val;
1897 }
1898
1899 DEFUN ("x-disown-selection-internal", Fx_disown_selection_internal,
1900 Sx_disown_selection_internal, 1, 2, 0,
1901 "If we own the selection SELECTION, disown it.\n\
1902 Disowning it means there is no such selection.")
1903 (selection, time)
1904 Lisp_Object selection;
1905 Lisp_Object time;
1906 {
1907 Time timestamp;
1908 Atom selection_atom;
1909 XSelectionClearEvent event;
1910 Display *display;
1911 struct x_display_info *dpyinfo;
1912
1913 check_x ();
1914 display = FRAME_X_DISPLAY (selected_frame);
1915 dpyinfo = FRAME_X_DISPLAY_INFO (selected_frame);
1916 CHECK_SYMBOL (selection, 0);
1917 if (NILP (time))
1918 timestamp = last_event_timestamp;
1919 else
1920 timestamp = cons_to_long (time);
1921
1922 if (NILP (assq_no_quit (selection, Vselection_alist)))
1923 return Qnil; /* Don't disown the selection when we're not the owner. */
1924
1925 selection_atom = symbol_to_x_atom (dpyinfo, display, selection);
1926
1927 BLOCK_INPUT;
1928 XSetSelectionOwner (display, selection_atom, None, timestamp);
1929 UNBLOCK_INPUT;
1930
1931 /* It doesn't seem to be guaranteed that a SelectionClear event will be
1932 generated for a window which owns the selection when that window sets
1933 the selection owner to None. The NCD server does, the MIT Sun4 server
1934 doesn't. So we synthesize one; this means we might get two, but
1935 that's ok, because the second one won't have any effect. */
1936 SELECTION_EVENT_DISPLAY (&event) = display;
1937 SELECTION_EVENT_SELECTION (&event) = selection_atom;
1938 SELECTION_EVENT_TIME (&event) = timestamp;
1939 x_handle_selection_clear (&event);
1940
1941 return Qt;
1942 }
1943
1944 /* Get rid of all the selections in buffer BUFFER.
1945 This is used when we kill a buffer. */
1946
1947 void
1948 x_disown_buffer_selections (buffer)
1949 Lisp_Object buffer;
1950 {
1951 Lisp_Object tail;
1952 struct buffer *buf = XBUFFER (buffer);
1953
1954 for (tail = Vselection_alist; CONSP (tail); tail = XCONS (tail)->cdr)
1955 {
1956 Lisp_Object elt, value;
1957 elt = XCONS (tail)->car;
1958 value = XCONS (elt)->cdr;
1959 if (CONSP (value) && MARKERP (XCONS (value)->car)
1960 && XMARKER (XCONS (value)->car)->buffer == buf)
1961 Fx_disown_selection_internal (XCONS (elt)->car, Qnil);
1962 }
1963 }
1964
1965 DEFUN ("x-selection-owner-p", Fx_selection_owner_p, Sx_selection_owner_p,
1966 0, 1, 0,
1967 "Whether the current Emacs process owns the given X Selection.\n\
1968 The arg should be the name of the selection in question, typically one of\n\
1969 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.\n\
1970 \(Those are literal upper-case symbol names, since that's what X expects.)\n\
1971 For convenience, the symbol nil is the same as `PRIMARY',\n\
1972 and t is the same as `SECONDARY'.)")
1973 (selection)
1974 Lisp_Object selection;
1975 {
1976 check_x ();
1977 CHECK_SYMBOL (selection, 0);
1978 if (EQ (selection, Qnil)) selection = QPRIMARY;
1979 if (EQ (selection, Qt)) selection = QSECONDARY;
1980
1981 if (NILP (Fassq (selection, Vselection_alist)))
1982 return Qnil;
1983 return Qt;
1984 }
1985
1986 DEFUN ("x-selection-exists-p", Fx_selection_exists_p, Sx_selection_exists_p,
1987 0, 1, 0,
1988 "Whether there is an owner for the given X Selection.\n\
1989 The arg should be the name of the selection in question, typically one of\n\
1990 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.\n\
1991 \(Those are literal upper-case symbol names, since that's what X expects.)\n\
1992 For convenience, the symbol nil is the same as `PRIMARY',\n\
1993 and t is the same as `SECONDARY'.)")
1994 (selection)
1995 Lisp_Object selection;
1996 {
1997 Window owner;
1998 Atom atom;
1999 Display *dpy;
2000
2001 /* It should be safe to call this before we have an X frame. */
2002 if (! FRAME_X_P (selected_frame))
2003 return Qnil;
2004
2005 dpy = FRAME_X_DISPLAY (selected_frame);
2006 CHECK_SYMBOL (selection, 0);
2007 if (!NILP (Fx_selection_owner_p (selection)))
2008 return Qt;
2009 if (EQ (selection, Qnil)) selection = QPRIMARY;
2010 if (EQ (selection, Qt)) selection = QSECONDARY;
2011 atom = symbol_to_x_atom (FRAME_X_DISPLAY_INFO (selected_frame),
2012 dpy, selection);
2013 if (atom == 0)
2014 return Qnil;
2015 BLOCK_INPUT;
2016 owner = XGetSelectionOwner (dpy, atom);
2017 UNBLOCK_INPUT;
2018 return (owner ? Qt : Qnil);
2019 }
2020
2021 \f
2022 #ifdef CUT_BUFFER_SUPPORT
2023
2024 /* Ensure that all 8 cut buffers exist. ICCCM says we gotta... */
2025 static void
2026 initialize_cut_buffers (display, window)
2027 Display *display;
2028 Window window;
2029 {
2030 unsigned char *data = (unsigned char *) "";
2031 BLOCK_INPUT;
2032 #define FROB(atom) XChangeProperty (display, window, atom, XA_STRING, 8, \
2033 PropModeAppend, data, 0)
2034 FROB (XA_CUT_BUFFER0);
2035 FROB (XA_CUT_BUFFER1);
2036 FROB (XA_CUT_BUFFER2);
2037 FROB (XA_CUT_BUFFER3);
2038 FROB (XA_CUT_BUFFER4);
2039 FROB (XA_CUT_BUFFER5);
2040 FROB (XA_CUT_BUFFER6);
2041 FROB (XA_CUT_BUFFER7);
2042 #undef FROB
2043 UNBLOCK_INPUT;
2044 }
2045
2046
2047 #define CHECK_CUT_BUFFER(symbol,n) \
2048 { CHECK_SYMBOL ((symbol), (n)); \
2049 if (!EQ((symbol), QCUT_BUFFER0) && !EQ((symbol), QCUT_BUFFER1) \
2050 && !EQ((symbol), QCUT_BUFFER2) && !EQ((symbol), QCUT_BUFFER3) \
2051 && !EQ((symbol), QCUT_BUFFER4) && !EQ((symbol), QCUT_BUFFER5) \
2052 && !EQ((symbol), QCUT_BUFFER6) && !EQ((symbol), QCUT_BUFFER7)) \
2053 Fsignal (Qerror, \
2054 Fcons (build_string ("doesn't name a cut buffer"), \
2055 Fcons ((symbol), Qnil))); \
2056 }
2057
2058 DEFUN ("x-get-cut-buffer-internal", Fx_get_cut_buffer_internal,
2059 Sx_get_cut_buffer_internal, 1, 1, 0,
2060 "Returns the value of the named cut buffer (typically CUT_BUFFER0).")
2061 (buffer)
2062 Lisp_Object buffer;
2063 {
2064 Window window;
2065 Atom buffer_atom;
2066 unsigned char *data;
2067 int bytes;
2068 Atom type;
2069 int format;
2070 unsigned long size;
2071 Lisp_Object ret;
2072 Display *display;
2073 struct x_display_info *dpyinfo;
2074
2075 check_x ();
2076 display = FRAME_X_DISPLAY (selected_frame);
2077 dpyinfo = FRAME_X_DISPLAY_INFO (selected_frame);
2078 window = RootWindow (display, 0); /* Cut buffers are on screen 0 */
2079 CHECK_CUT_BUFFER (buffer, 0);
2080 buffer_atom = symbol_to_x_atom (dpyinfo, display, buffer);
2081
2082 x_get_window_property (display, window, buffer_atom, &data, &bytes,
2083 &type, &format, &size, 0);
2084 if (!data) return Qnil;
2085
2086 if (format != 8 || type != XA_STRING)
2087 Fsignal (Qerror,
2088 Fcons (build_string ("cut buffer doesn't contain 8-bit data"),
2089 Fcons (x_atom_to_symbol (dpyinfo, display, type),
2090 Fcons (make_number (format), Qnil))));
2091
2092 ret = (bytes ? make_string ((char *) data, bytes) : Qnil);
2093 /* Use free, not XFree, because x_get_window_property
2094 calls xmalloc itself. */
2095 free (data);
2096 return ret;
2097 }
2098
2099
2100 DEFUN ("x-store-cut-buffer-internal", Fx_store_cut_buffer_internal,
2101 Sx_store_cut_buffer_internal, 2, 2, 0,
2102 "Sets the value of the named cut buffer (typically CUT_BUFFER0).")
2103 (buffer, string)
2104 Lisp_Object buffer, string;
2105 {
2106 Window window;
2107 Atom buffer_atom;
2108 unsigned char *data;
2109 int bytes;
2110 int bytes_remaining;
2111 int max_bytes;
2112 Display *display;
2113
2114 check_x ();
2115 display = FRAME_X_DISPLAY (selected_frame);
2116 window = RootWindow (display, 0); /* Cut buffers are on screen 0 */
2117
2118 max_bytes = SELECTION_QUANTUM (display);
2119 if (max_bytes > MAX_SELECTION_QUANTUM)
2120 max_bytes = MAX_SELECTION_QUANTUM;
2121
2122 CHECK_CUT_BUFFER (buffer, 0);
2123 CHECK_STRING (string, 0);
2124 buffer_atom = symbol_to_x_atom (FRAME_X_DISPLAY_INFO (selected_frame),
2125 display, buffer);
2126 data = (unsigned char *) XSTRING (string)->data;
2127 bytes = XSTRING (string)->size;
2128 bytes_remaining = bytes;
2129
2130 if (! FRAME_X_DISPLAY_INFO (selected_frame)->cut_buffers_initialized)
2131 {
2132 initialize_cut_buffers (display, window);
2133 FRAME_X_DISPLAY_INFO (selected_frame)->cut_buffers_initialized = 1;
2134 }
2135
2136 BLOCK_INPUT;
2137
2138 /* Don't mess up with an empty value. */
2139 if (!bytes_remaining)
2140 XChangeProperty (display, window, buffer_atom, XA_STRING, 8,
2141 PropModeReplace, data, 0);
2142
2143 while (bytes_remaining)
2144 {
2145 int chunk = (bytes_remaining < max_bytes
2146 ? bytes_remaining : max_bytes);
2147 XChangeProperty (display, window, buffer_atom, XA_STRING, 8,
2148 (bytes_remaining == bytes
2149 ? PropModeReplace
2150 : PropModeAppend),
2151 data, chunk);
2152 data += chunk;
2153 bytes_remaining -= chunk;
2154 }
2155 UNBLOCK_INPUT;
2156 return string;
2157 }
2158
2159
2160 DEFUN ("x-rotate-cut-buffers-internal", Fx_rotate_cut_buffers_internal,
2161 Sx_rotate_cut_buffers_internal, 1, 1, 0,
2162 "Rotate the values of the cut buffers by the given number of steps;\n\
2163 positive means move values forward, negative means backward.")
2164 (n)
2165 Lisp_Object n;
2166 {
2167 Window window;
2168 Atom props[8];
2169 Display *display;
2170
2171 check_x ();
2172 display = FRAME_X_DISPLAY (selected_frame);
2173 window = RootWindow (display, 0); /* Cut buffers are on screen 0 */
2174 CHECK_NUMBER (n, 0);
2175 if (XINT (n) == 0)
2176 return n;
2177 if (! FRAME_X_DISPLAY_INFO (selected_frame)->cut_buffers_initialized)
2178 {
2179 initialize_cut_buffers (display, window);
2180 FRAME_X_DISPLAY_INFO (selected_frame)->cut_buffers_initialized = 1;
2181 }
2182
2183 props[0] = XA_CUT_BUFFER0;
2184 props[1] = XA_CUT_BUFFER1;
2185 props[2] = XA_CUT_BUFFER2;
2186 props[3] = XA_CUT_BUFFER3;
2187 props[4] = XA_CUT_BUFFER4;
2188 props[5] = XA_CUT_BUFFER5;
2189 props[6] = XA_CUT_BUFFER6;
2190 props[7] = XA_CUT_BUFFER7;
2191 BLOCK_INPUT;
2192 XRotateWindowProperties (display, window, props, 8, XINT (n));
2193 UNBLOCK_INPUT;
2194 return n;
2195 }
2196
2197 #endif
2198 \f
2199 void
2200 syms_of_xselect ()
2201 {
2202 defsubr (&Sx_get_selection_internal);
2203 defsubr (&Sx_own_selection_internal);
2204 defsubr (&Sx_disown_selection_internal);
2205 defsubr (&Sx_selection_owner_p);
2206 defsubr (&Sx_selection_exists_p);
2207
2208 #ifdef CUT_BUFFER_SUPPORT
2209 defsubr (&Sx_get_cut_buffer_internal);
2210 defsubr (&Sx_store_cut_buffer_internal);
2211 defsubr (&Sx_rotate_cut_buffers_internal);
2212 #endif
2213
2214 reading_selection_reply = Fcons (Qnil, Qnil);
2215 staticpro (&reading_selection_reply);
2216 reading_selection_window = 0;
2217 reading_which_selection = 0;
2218
2219 property_change_wait_list = 0;
2220 prop_location_identifier = 0;
2221 property_change_reply = Fcons (Qnil, Qnil);
2222 staticpro (&property_change_reply);
2223
2224 Vselection_alist = Qnil;
2225 staticpro (&Vselection_alist);
2226
2227 DEFVAR_LISP ("selection-converter-alist", &Vselection_converter_alist,
2228 "An alist associating X Windows selection-types with functions.\n\
2229 These functions are called to convert the selection, with three args:\n\
2230 the name of the selection (typically `PRIMARY', `SECONDARY', or `CLIPBOARD');\n\
2231 a desired type to which the selection should be converted;\n\
2232 and the local selection value (whatever was given to `x-own-selection').\n\
2233 \n\
2234 The function should return the value to send to the X server\n\
2235 \(typically a string). A return value of nil\n\
2236 means that the conversion could not be done.\n\
2237 A return value which is the symbol `NULL'\n\
2238 means that a side-effect was executed,\n\
2239 and there is no meaningful selection value.");
2240 Vselection_converter_alist = Qnil;
2241
2242 DEFVAR_LISP ("x-lost-selection-hooks", &Vx_lost_selection_hooks,
2243 "A list of functions to be called when Emacs loses an X selection.\n\
2244 \(This happens when some other X client makes its own selection\n\
2245 or when a Lisp program explicitly clears the selection.)\n\
2246 The functions are called with one argument, the selection type\n\
2247 \(a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD').");
2248 Vx_lost_selection_hooks = Qnil;
2249
2250 DEFVAR_LISP ("x-sent-selection-hooks", &Vx_sent_selection_hooks,
2251 "A list of functions to be called when Emacs answers a selection request.\n\
2252 The functions are called with four arguments:\n\
2253 - the selection name (typically `PRIMARY', `SECONDARY', or `CLIPBOARD');\n\
2254 - the selection-type which Emacs was asked to convert the\n\
2255 selection into before sending (for example, `STRING' or `LENGTH');\n\
2256 - a flag indicating success or failure for responding to the request.\n\
2257 We might have failed (and declined the request) for any number of reasons,\n\
2258 including being asked for a selection that we no longer own, or being asked\n\
2259 to convert into a type that we don't know about or that is inappropriate.\n\
2260 This hook doesn't let you change the behavior of Emacs's selection replies,\n\
2261 it merely informs you that they have happened.");
2262 Vx_sent_selection_hooks = Qnil;
2263
2264 DEFVAR_INT ("x-selection-timeout", &x_selection_timeout,
2265 "Number of milliseconds to wait for a selection reply.\n\
2266 If the selection owner doesn't reply in this time, we give up.\n\
2267 A value of 0 means wait as long as necessary. This is initialized from the\n\
2268 \"*selectionTimeout\" resource.");
2269 x_selection_timeout = 0;
2270
2271 QPRIMARY = intern ("PRIMARY"); staticpro (&QPRIMARY);
2272 QSECONDARY = intern ("SECONDARY"); staticpro (&QSECONDARY);
2273 QSTRING = intern ("STRING"); staticpro (&QSTRING);
2274 QINTEGER = intern ("INTEGER"); staticpro (&QINTEGER);
2275 QCLIPBOARD = intern ("CLIPBOARD"); staticpro (&QCLIPBOARD);
2276 QTIMESTAMP = intern ("TIMESTAMP"); staticpro (&QTIMESTAMP);
2277 QTEXT = intern ("TEXT"); staticpro (&QTEXT);
2278 QCOMPOUND_TEXT = intern ("COMPOUND_TEXT"); staticpro (&QCOMPOUND_TEXT);
2279 QTIMESTAMP = intern ("TIMESTAMP"); staticpro (&QTIMESTAMP);
2280 QDELETE = intern ("DELETE"); staticpro (&QDELETE);
2281 QMULTIPLE = intern ("MULTIPLE"); staticpro (&QMULTIPLE);
2282 QINCR = intern ("INCR"); staticpro (&QINCR);
2283 QEMACS_TMP = intern ("_EMACS_TMP_"); staticpro (&QEMACS_TMP);
2284 QTARGETS = intern ("TARGETS"); staticpro (&QTARGETS);
2285 QATOM = intern ("ATOM"); staticpro (&QATOM);
2286 QATOM_PAIR = intern ("ATOM_PAIR"); staticpro (&QATOM_PAIR);
2287 QNULL = intern ("NULL"); staticpro (&QNULL);
2288
2289 #ifdef CUT_BUFFER_SUPPORT
2290 QCUT_BUFFER0 = intern ("CUT_BUFFER0"); staticpro (&QCUT_BUFFER0);
2291 QCUT_BUFFER1 = intern ("CUT_BUFFER1"); staticpro (&QCUT_BUFFER1);
2292 QCUT_BUFFER2 = intern ("CUT_BUFFER2"); staticpro (&QCUT_BUFFER2);
2293 QCUT_BUFFER3 = intern ("CUT_BUFFER3"); staticpro (&QCUT_BUFFER3);
2294 QCUT_BUFFER4 = intern ("CUT_BUFFER4"); staticpro (&QCUT_BUFFER4);
2295 QCUT_BUFFER5 = intern ("CUT_BUFFER5"); staticpro (&QCUT_BUFFER5);
2296 QCUT_BUFFER6 = intern ("CUT_BUFFER6"); staticpro (&QCUT_BUFFER6);
2297 QCUT_BUFFER7 = intern ("CUT_BUFFER7"); staticpro (&QCUT_BUFFER7);
2298 #endif
2299
2300 }