| 1 | /* X Selection processing for Emacs. |
| 2 | Copyright (C) 1993-1997, 2000-2013 Free Software Foundation, Inc. |
| 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 3 of the License, or |
| 9 | (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */ |
| 18 | |
| 19 | |
| 20 | /* Rewritten by jwz */ |
| 21 | |
| 22 | #include <config.h> |
| 23 | #include <limits.h> |
| 24 | #include <stdio.h> /* termhooks.h needs this */ |
| 25 | |
| 26 | #ifdef HAVE_SYS_TYPES_H |
| 27 | #include <sys/types.h> |
| 28 | #endif |
| 29 | |
| 30 | #include <unistd.h> |
| 31 | |
| 32 | #include "lisp.h" |
| 33 | #include "xterm.h" /* for all of the X includes */ |
| 34 | #include "dispextern.h" /* frame.h seems to want this */ |
| 35 | #include "frame.h" /* Need this to get the X window of selected_frame */ |
| 36 | #include "blockinput.h" |
| 37 | #include "character.h" |
| 38 | #include "buffer.h" |
| 39 | #include "process.h" |
| 40 | #include "termhooks.h" |
| 41 | #include "keyboard.h" |
| 42 | |
| 43 | #include <X11/Xproto.h> |
| 44 | |
| 45 | struct prop_location; |
| 46 | struct selection_data; |
| 47 | |
| 48 | static void x_decline_selection_request (struct input_event *); |
| 49 | static int x_convert_selection (struct input_event *, Lisp_Object, Lisp_Object, |
| 50 | Atom, int, struct x_display_info *); |
| 51 | static int waiting_for_other_props_on_window (Display *, Window); |
| 52 | static struct prop_location *expect_property_change (Display *, Window, |
| 53 | Atom, int); |
| 54 | static void unexpect_property_change (struct prop_location *); |
| 55 | static void wait_for_property_change (struct prop_location *); |
| 56 | static Lisp_Object x_get_window_property_as_lisp_data (Display *, |
| 57 | Window, Atom, |
| 58 | Lisp_Object, Atom); |
| 59 | static Lisp_Object selection_data_to_lisp_data (Display *, |
| 60 | const unsigned char *, |
| 61 | ptrdiff_t, Atom, int); |
| 62 | static void lisp_data_to_selection_data (Display *, Lisp_Object, |
| 63 | unsigned char **, Atom *, |
| 64 | ptrdiff_t *, int *, int *); |
| 65 | |
| 66 | /* Printing traces to stderr. */ |
| 67 | |
| 68 | #ifdef TRACE_SELECTION |
| 69 | #define TRACE0(fmt) \ |
| 70 | fprintf (stderr, "%"pMd": " fmt "\n", (printmax_t) getpid ()) |
| 71 | #define TRACE1(fmt, a0) \ |
| 72 | fprintf (stderr, "%"pMd": " fmt "\n", (printmax_t) getpid (), a0) |
| 73 | #define TRACE2(fmt, a0, a1) \ |
| 74 | fprintf (stderr, "%"pMd": " fmt "\n", (printmax_t) getpid (), a0, a1) |
| 75 | #define TRACE3(fmt, a0, a1, a2) \ |
| 76 | fprintf (stderr, "%"pMd": " fmt "\n", (printmax_t) getpid (), a0, a1, a2) |
| 77 | #else |
| 78 | #define TRACE0(fmt) (void) 0 |
| 79 | #define TRACE1(fmt, a0) (void) 0 |
| 80 | #define TRACE2(fmt, a0, a1) (void) 0 |
| 81 | #endif |
| 82 | |
| 83 | |
| 84 | static Lisp_Object QSECONDARY, QSTRING, QINTEGER, QCLIPBOARD, QTIMESTAMP, |
| 85 | QTEXT, QDELETE, QMULTIPLE, QINCR, QEMACS_TMP, QTARGETS, QATOM, QNULL, |
| 86 | QATOM_PAIR, QCLIPBOARD_MANAGER, QSAVE_TARGETS; |
| 87 | |
| 88 | static Lisp_Object QCOMPOUND_TEXT; /* This is a type of selection. */ |
| 89 | static Lisp_Object QUTF8_STRING; /* This is a type of selection. */ |
| 90 | |
| 91 | static Lisp_Object Qcompound_text_with_extensions; |
| 92 | |
| 93 | static Lisp_Object Qforeign_selection; |
| 94 | static Lisp_Object Qx_lost_selection_functions, Qx_sent_selection_functions; |
| 95 | |
| 96 | /* Bytes needed to represent 'long' data. This is as per libX11; it |
| 97 | is not necessarily sizeof (long). */ |
| 98 | #define X_LONG_SIZE 4 |
| 99 | |
| 100 | /* Extreme 'short' and 'long' values suitable for libX11. */ |
| 101 | #define X_SHRT_MAX 0x7fff |
| 102 | #define X_SHRT_MIN (-1 - X_SHRT_MAX) |
| 103 | #define X_LONG_MAX 0x7fffffff |
| 104 | #define X_LONG_MIN (-1 - X_LONG_MAX) |
| 105 | #define X_ULONG_MAX 0xffffffffUL |
| 106 | |
| 107 | /* If this is a smaller number than the max-request-size of the display, |
| 108 | emacs will use INCR selection transfer when the selection is larger |
| 109 | than this. The max-request-size is usually around 64k, so if you want |
| 110 | emacs to use incremental selection transfers when the selection is |
| 111 | smaller than that, set this. I added this mostly for debugging the |
| 112 | incremental transfer stuff, but it might improve server performance. |
| 113 | |
| 114 | This value cannot exceed INT_MAX / max (X_LONG_SIZE, sizeof (long)) |
| 115 | because it is multiplied by X_LONG_SIZE and by sizeof (long) in |
| 116 | subscript calculations. Similarly for PTRDIFF_MAX - 1 or SIZE_MAX |
| 117 | - 1 in place of INT_MAX. */ |
| 118 | #define MAX_SELECTION_QUANTUM \ |
| 119 | ((int) min (0xFFFFFF, (min (INT_MAX, min (PTRDIFF_MAX, SIZE_MAX) - 1) \ |
| 120 | / max (X_LONG_SIZE, sizeof (long))))) |
| 121 | |
| 122 | static int |
| 123 | selection_quantum (Display *display) |
| 124 | { |
| 125 | long mrs = XMaxRequestSize (display); |
| 126 | return (mrs < MAX_SELECTION_QUANTUM / X_LONG_SIZE + 25 |
| 127 | ? (mrs - 25) * X_LONG_SIZE |
| 128 | : MAX_SELECTION_QUANTUM); |
| 129 | } |
| 130 | |
| 131 | #define LOCAL_SELECTION(selection_symbol,dpyinfo) \ |
| 132 | assq_no_quit (selection_symbol, dpyinfo->terminal->Vselection_alist) |
| 133 | |
| 134 | \f |
| 135 | /* Define a queue to save up SELECTION_REQUEST_EVENT events for later |
| 136 | handling. */ |
| 137 | |
| 138 | struct selection_event_queue |
| 139 | { |
| 140 | struct input_event event; |
| 141 | struct selection_event_queue *next; |
| 142 | }; |
| 143 | |
| 144 | static struct selection_event_queue *selection_queue; |
| 145 | |
| 146 | /* Nonzero means queue up SELECTION_REQUEST_EVENT events. */ |
| 147 | |
| 148 | static int x_queue_selection_requests; |
| 149 | |
| 150 | /* Queue up an SELECTION_REQUEST_EVENT *EVENT, to be processed later. */ |
| 151 | |
| 152 | static void |
| 153 | x_queue_event (struct input_event *event) |
| 154 | { |
| 155 | struct selection_event_queue *queue_tmp; |
| 156 | |
| 157 | /* Don't queue repeated requests. |
| 158 | This only happens for large requests which uses the incremental protocol. */ |
| 159 | for (queue_tmp = selection_queue; queue_tmp; queue_tmp = queue_tmp->next) |
| 160 | { |
| 161 | if (!memcmp (&queue_tmp->event, event, sizeof (*event))) |
| 162 | { |
| 163 | TRACE1 ("DECLINE DUP SELECTION EVENT %p", queue_tmp); |
| 164 | x_decline_selection_request (event); |
| 165 | return; |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | queue_tmp = xmalloc (sizeof *queue_tmp); |
| 170 | TRACE1 ("QUEUE SELECTION EVENT %p", queue_tmp); |
| 171 | queue_tmp->event = *event; |
| 172 | queue_tmp->next = selection_queue; |
| 173 | selection_queue = queue_tmp; |
| 174 | } |
| 175 | |
| 176 | /* Start queuing SELECTION_REQUEST_EVENT events. */ |
| 177 | |
| 178 | static void |
| 179 | x_start_queuing_selection_requests (void) |
| 180 | { |
| 181 | if (x_queue_selection_requests) |
| 182 | emacs_abort (); |
| 183 | |
| 184 | x_queue_selection_requests++; |
| 185 | TRACE1 ("x_start_queuing_selection_requests %d", x_queue_selection_requests); |
| 186 | } |
| 187 | |
| 188 | /* Stop queuing SELECTION_REQUEST_EVENT events. */ |
| 189 | |
| 190 | static void |
| 191 | x_stop_queuing_selection_requests (void) |
| 192 | { |
| 193 | TRACE1 ("x_stop_queuing_selection_requests %d", x_queue_selection_requests); |
| 194 | --x_queue_selection_requests; |
| 195 | |
| 196 | /* Take all the queued events and put them back |
| 197 | so that they get processed afresh. */ |
| 198 | |
| 199 | while (selection_queue != NULL) |
| 200 | { |
| 201 | struct selection_event_queue *queue_tmp = selection_queue; |
| 202 | TRACE1 ("RESTORE SELECTION EVENT %p", queue_tmp); |
| 203 | kbd_buffer_unget_event (&queue_tmp->event); |
| 204 | selection_queue = queue_tmp->next; |
| 205 | xfree (queue_tmp); |
| 206 | } |
| 207 | } |
| 208 | \f |
| 209 | |
| 210 | /* This converts a Lisp symbol to a server Atom, avoiding a server |
| 211 | roundtrip whenever possible. */ |
| 212 | |
| 213 | static Atom |
| 214 | symbol_to_x_atom (struct x_display_info *dpyinfo, Lisp_Object sym) |
| 215 | { |
| 216 | Atom val; |
| 217 | if (NILP (sym)) return 0; |
| 218 | if (EQ (sym, QPRIMARY)) return XA_PRIMARY; |
| 219 | if (EQ (sym, QSECONDARY)) return XA_SECONDARY; |
| 220 | if (EQ (sym, QSTRING)) return XA_STRING; |
| 221 | if (EQ (sym, QINTEGER)) return XA_INTEGER; |
| 222 | if (EQ (sym, QATOM)) return XA_ATOM; |
| 223 | if (EQ (sym, QCLIPBOARD)) return dpyinfo->Xatom_CLIPBOARD; |
| 224 | if (EQ (sym, QTIMESTAMP)) return dpyinfo->Xatom_TIMESTAMP; |
| 225 | if (EQ (sym, QTEXT)) return dpyinfo->Xatom_TEXT; |
| 226 | if (EQ (sym, QCOMPOUND_TEXT)) return dpyinfo->Xatom_COMPOUND_TEXT; |
| 227 | if (EQ (sym, QUTF8_STRING)) return dpyinfo->Xatom_UTF8_STRING; |
| 228 | if (EQ (sym, QDELETE)) return dpyinfo->Xatom_DELETE; |
| 229 | if (EQ (sym, QMULTIPLE)) return dpyinfo->Xatom_MULTIPLE; |
| 230 | if (EQ (sym, QINCR)) return dpyinfo->Xatom_INCR; |
| 231 | if (EQ (sym, QEMACS_TMP)) return dpyinfo->Xatom_EMACS_TMP; |
| 232 | if (EQ (sym, QTARGETS)) return dpyinfo->Xatom_TARGETS; |
| 233 | if (EQ (sym, QNULL)) return dpyinfo->Xatom_NULL; |
| 234 | if (!SYMBOLP (sym)) emacs_abort (); |
| 235 | |
| 236 | TRACE1 (" XInternAtom %s", SSDATA (SYMBOL_NAME (sym))); |
| 237 | block_input (); |
| 238 | val = XInternAtom (dpyinfo->display, SSDATA (SYMBOL_NAME (sym)), False); |
| 239 | unblock_input (); |
| 240 | return val; |
| 241 | } |
| 242 | |
| 243 | |
| 244 | /* This converts a server Atom to a Lisp symbol, avoiding server roundtrips |
| 245 | and calls to intern whenever possible. */ |
| 246 | |
| 247 | static Lisp_Object |
| 248 | x_atom_to_symbol (Display *dpy, Atom atom) |
| 249 | { |
| 250 | struct x_display_info *dpyinfo; |
| 251 | char *str; |
| 252 | Lisp_Object val; |
| 253 | |
| 254 | if (! atom) |
| 255 | return Qnil; |
| 256 | |
| 257 | switch (atom) |
| 258 | { |
| 259 | case XA_PRIMARY: |
| 260 | return QPRIMARY; |
| 261 | case XA_SECONDARY: |
| 262 | return QSECONDARY; |
| 263 | case XA_STRING: |
| 264 | return QSTRING; |
| 265 | case XA_INTEGER: |
| 266 | return QINTEGER; |
| 267 | case XA_ATOM: |
| 268 | return QATOM; |
| 269 | } |
| 270 | |
| 271 | dpyinfo = x_display_info_for_display (dpy); |
| 272 | if (dpyinfo == NULL) |
| 273 | return Qnil; |
| 274 | if (atom == dpyinfo->Xatom_CLIPBOARD) |
| 275 | return QCLIPBOARD; |
| 276 | if (atom == dpyinfo->Xatom_TIMESTAMP) |
| 277 | return QTIMESTAMP; |
| 278 | if (atom == dpyinfo->Xatom_TEXT) |
| 279 | return QTEXT; |
| 280 | if (atom == dpyinfo->Xatom_COMPOUND_TEXT) |
| 281 | return QCOMPOUND_TEXT; |
| 282 | if (atom == dpyinfo->Xatom_UTF8_STRING) |
| 283 | return QUTF8_STRING; |
| 284 | if (atom == dpyinfo->Xatom_DELETE) |
| 285 | return QDELETE; |
| 286 | if (atom == dpyinfo->Xatom_MULTIPLE) |
| 287 | return QMULTIPLE; |
| 288 | if (atom == dpyinfo->Xatom_INCR) |
| 289 | return QINCR; |
| 290 | if (atom == dpyinfo->Xatom_EMACS_TMP) |
| 291 | return QEMACS_TMP; |
| 292 | if (atom == dpyinfo->Xatom_TARGETS) |
| 293 | return QTARGETS; |
| 294 | if (atom == dpyinfo->Xatom_NULL) |
| 295 | return QNULL; |
| 296 | |
| 297 | block_input (); |
| 298 | str = XGetAtomName (dpy, atom); |
| 299 | unblock_input (); |
| 300 | TRACE1 ("XGetAtomName --> %s", str); |
| 301 | if (! str) return Qnil; |
| 302 | val = intern (str); |
| 303 | block_input (); |
| 304 | /* This was allocated by Xlib, so use XFree. */ |
| 305 | XFree (str); |
| 306 | unblock_input (); |
| 307 | return val; |
| 308 | } |
| 309 | \f |
| 310 | /* Do protocol to assert ourself as a selection owner. |
| 311 | FRAME shall be the owner; it must be a valid X frame. |
| 312 | Update the Vselection_alist so that we can reply to later requests for |
| 313 | our selection. */ |
| 314 | |
| 315 | static void |
| 316 | x_own_selection (Lisp_Object selection_name, Lisp_Object selection_value, |
| 317 | Lisp_Object frame) |
| 318 | { |
| 319 | struct frame *f = XFRAME (frame); |
| 320 | Window selecting_window = FRAME_X_WINDOW (f); |
| 321 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 322 | Display *display = dpyinfo->display; |
| 323 | Time timestamp = last_event_timestamp; |
| 324 | Atom selection_atom = symbol_to_x_atom (dpyinfo, selection_name); |
| 325 | |
| 326 | block_input (); |
| 327 | x_catch_errors (display); |
| 328 | XSetSelectionOwner (display, selection_atom, selecting_window, timestamp); |
| 329 | x_check_errors (display, "Can't set selection: %s"); |
| 330 | x_uncatch_errors (); |
| 331 | unblock_input (); |
| 332 | |
| 333 | /* Now update the local cache */ |
| 334 | { |
| 335 | Lisp_Object selection_data; |
| 336 | Lisp_Object prev_value; |
| 337 | |
| 338 | selection_data = list4 (selection_name, selection_value, |
| 339 | INTEGER_TO_CONS (timestamp), frame); |
| 340 | prev_value = LOCAL_SELECTION (selection_name, dpyinfo); |
| 341 | |
| 342 | tset_selection_alist |
| 343 | (dpyinfo->terminal, |
| 344 | Fcons (selection_data, dpyinfo->terminal->Vselection_alist)); |
| 345 | |
| 346 | /* If we already owned the selection, remove the old selection |
| 347 | data. Don't use Fdelq as that may QUIT. */ |
| 348 | if (!NILP (prev_value)) |
| 349 | { |
| 350 | /* We know it's not the CAR, so it's easy. */ |
| 351 | Lisp_Object rest = dpyinfo->terminal->Vselection_alist; |
| 352 | for (; CONSP (rest); rest = XCDR (rest)) |
| 353 | if (EQ (prev_value, Fcar (XCDR (rest)))) |
| 354 | { |
| 355 | XSETCDR (rest, XCDR (XCDR (rest))); |
| 356 | break; |
| 357 | } |
| 358 | } |
| 359 | } |
| 360 | } |
| 361 | \f |
| 362 | /* Given a selection-name and desired type, look up our local copy of |
| 363 | the selection value and convert it to the type. |
| 364 | Return nil, a string, a vector, a symbol, an integer, or a cons |
| 365 | that CONS_TO_INTEGER could plausibly handle. |
| 366 | This function is used both for remote requests (LOCAL_REQUEST is zero) |
| 367 | and for local x-get-selection-internal (LOCAL_REQUEST is nonzero). |
| 368 | |
| 369 | This calls random Lisp code, and may signal or gc. */ |
| 370 | |
| 371 | static Lisp_Object |
| 372 | x_get_local_selection (Lisp_Object selection_symbol, Lisp_Object target_type, |
| 373 | int local_request, struct x_display_info *dpyinfo) |
| 374 | { |
| 375 | Lisp_Object local_value; |
| 376 | Lisp_Object handler_fn, value, check; |
| 377 | |
| 378 | local_value = LOCAL_SELECTION (selection_symbol, dpyinfo); |
| 379 | |
| 380 | if (NILP (local_value)) return Qnil; |
| 381 | |
| 382 | /* TIMESTAMP is a special case. */ |
| 383 | if (EQ (target_type, QTIMESTAMP)) |
| 384 | { |
| 385 | handler_fn = Qnil; |
| 386 | value = XCAR (XCDR (XCDR (local_value))); |
| 387 | } |
| 388 | else |
| 389 | { |
| 390 | /* Don't allow a quit within the converter. |
| 391 | When the user types C-g, he would be surprised |
| 392 | if by luck it came during a converter. */ |
| 393 | ptrdiff_t count = SPECPDL_INDEX (); |
| 394 | specbind (Qinhibit_quit, Qt); |
| 395 | |
| 396 | CHECK_SYMBOL (target_type); |
| 397 | handler_fn = Fcdr (Fassq (target_type, Vselection_converter_alist)); |
| 398 | /* gcpro is not needed here since nothing but HANDLER_FN |
| 399 | is live, and that ought to be a symbol. */ |
| 400 | |
| 401 | if (!NILP (handler_fn)) |
| 402 | value = call3 (handler_fn, |
| 403 | selection_symbol, (local_request ? Qnil : target_type), |
| 404 | XCAR (XCDR (local_value))); |
| 405 | else |
| 406 | value = Qnil; |
| 407 | unbind_to (count, Qnil); |
| 408 | } |
| 409 | |
| 410 | /* Make sure this value is of a type that we could transmit |
| 411 | to another X client. */ |
| 412 | |
| 413 | check = value; |
| 414 | if (CONSP (value) |
| 415 | && SYMBOLP (XCAR (value))) |
| 416 | check = XCDR (value); |
| 417 | |
| 418 | if (STRINGP (check) |
| 419 | || VECTORP (check) |
| 420 | || SYMBOLP (check) |
| 421 | || INTEGERP (check) |
| 422 | || NILP (value)) |
| 423 | return value; |
| 424 | /* Check for a value that CONS_TO_INTEGER could handle. */ |
| 425 | else if (CONSP (check) |
| 426 | && INTEGERP (XCAR (check)) |
| 427 | && (INTEGERP (XCDR (check)) |
| 428 | || |
| 429 | (CONSP (XCDR (check)) |
| 430 | && INTEGERP (XCAR (XCDR (check))) |
| 431 | && NILP (XCDR (XCDR (check)))))) |
| 432 | return value; |
| 433 | |
| 434 | signal_error ("Invalid data returned by selection-conversion function", |
| 435 | list2 (handler_fn, value)); |
| 436 | } |
| 437 | \f |
| 438 | /* Subroutines of x_reply_selection_request. */ |
| 439 | |
| 440 | /* Send a SelectionNotify event to the requestor with property=None, |
| 441 | meaning we were unable to do what they wanted. */ |
| 442 | |
| 443 | static void |
| 444 | x_decline_selection_request (struct input_event *event) |
| 445 | { |
| 446 | XEvent reply_base; |
| 447 | XSelectionEvent *reply = &(reply_base.xselection); |
| 448 | |
| 449 | reply->type = SelectionNotify; |
| 450 | reply->display = SELECTION_EVENT_DISPLAY (event); |
| 451 | reply->requestor = SELECTION_EVENT_REQUESTOR (event); |
| 452 | reply->selection = SELECTION_EVENT_SELECTION (event); |
| 453 | reply->time = SELECTION_EVENT_TIME (event); |
| 454 | reply->target = SELECTION_EVENT_TARGET (event); |
| 455 | reply->property = None; |
| 456 | |
| 457 | /* The reason for the error may be that the receiver has |
| 458 | died in the meantime. Handle that case. */ |
| 459 | block_input (); |
| 460 | x_catch_errors (reply->display); |
| 461 | XSendEvent (reply->display, reply->requestor, False, 0L, &reply_base); |
| 462 | XFlush (reply->display); |
| 463 | x_uncatch_errors (); |
| 464 | unblock_input (); |
| 465 | } |
| 466 | |
| 467 | /* This is the selection request currently being processed. |
| 468 | It is set to zero when the request is fully processed. */ |
| 469 | static struct input_event *x_selection_current_request; |
| 470 | |
| 471 | /* Display info in x_selection_request. */ |
| 472 | |
| 473 | static struct x_display_info *selection_request_dpyinfo; |
| 474 | |
| 475 | /* Raw selection data, for sending to a requestor window. */ |
| 476 | |
| 477 | struct selection_data |
| 478 | { |
| 479 | unsigned char *data; |
| 480 | ptrdiff_t size; |
| 481 | int format; |
| 482 | Atom type; |
| 483 | int nofree; |
| 484 | Atom property; |
| 485 | /* This can be set to non-NULL during x_reply_selection_request, if |
| 486 | the selection is waiting for an INCR transfer to complete. Don't |
| 487 | free these; that's done by unexpect_property_change. */ |
| 488 | struct prop_location *wait_object; |
| 489 | struct selection_data *next; |
| 490 | }; |
| 491 | |
| 492 | /* Linked list of the above (in support of MULTIPLE targets). */ |
| 493 | |
| 494 | static struct selection_data *converted_selections; |
| 495 | |
| 496 | /* "Data" to send a requestor for a failed MULTIPLE subtarget. */ |
| 497 | static Atom conversion_fail_tag; |
| 498 | |
| 499 | /* Used as an unwind-protect clause so that, if a selection-converter signals |
| 500 | an error, we tell the requestor that we were unable to do what they wanted |
| 501 | before we throw to top-level or go into the debugger or whatever. */ |
| 502 | |
| 503 | static void |
| 504 | x_selection_request_lisp_error (void) |
| 505 | { |
| 506 | struct selection_data *cs, *next; |
| 507 | |
| 508 | for (cs = converted_selections; cs; cs = next) |
| 509 | { |
| 510 | next = cs->next; |
| 511 | if (cs->nofree == 0 && cs->data) |
| 512 | xfree (cs->data); |
| 513 | xfree (cs); |
| 514 | } |
| 515 | converted_selections = NULL; |
| 516 | |
| 517 | if (x_selection_current_request != 0 |
| 518 | && selection_request_dpyinfo->display) |
| 519 | x_decline_selection_request (x_selection_current_request); |
| 520 | } |
| 521 | |
| 522 | static void |
| 523 | x_catch_errors_unwind (void) |
| 524 | { |
| 525 | block_input (); |
| 526 | x_uncatch_errors (); |
| 527 | unblock_input (); |
| 528 | } |
| 529 | \f |
| 530 | |
| 531 | /* This stuff is so that INCR selections are reentrant (that is, so we can |
| 532 | be servicing multiple INCR selection requests simultaneously.) I haven't |
| 533 | actually tested that yet. */ |
| 534 | |
| 535 | /* Keep a list of the property changes that are awaited. */ |
| 536 | |
| 537 | struct prop_location |
| 538 | { |
| 539 | int identifier; |
| 540 | Display *display; |
| 541 | Window window; |
| 542 | Atom property; |
| 543 | int desired_state; |
| 544 | int arrived; |
| 545 | struct prop_location *next; |
| 546 | }; |
| 547 | |
| 548 | static int prop_location_identifier; |
| 549 | |
| 550 | static Lisp_Object property_change_reply; |
| 551 | |
| 552 | static struct prop_location *property_change_reply_object; |
| 553 | |
| 554 | static struct prop_location *property_change_wait_list; |
| 555 | |
| 556 | \f |
| 557 | /* Send the reply to a selection request event EVENT. */ |
| 558 | |
| 559 | #ifdef TRACE_SELECTION |
| 560 | static int x_reply_selection_request_cnt; |
| 561 | #endif /* TRACE_SELECTION */ |
| 562 | |
| 563 | static void |
| 564 | x_reply_selection_request (struct input_event *event, |
| 565 | struct x_display_info *dpyinfo) |
| 566 | { |
| 567 | XEvent reply_base; |
| 568 | XSelectionEvent *reply = &(reply_base.xselection); |
| 569 | Display *display = SELECTION_EVENT_DISPLAY (event); |
| 570 | Window window = SELECTION_EVENT_REQUESTOR (event); |
| 571 | ptrdiff_t bytes_remaining; |
| 572 | int max_bytes = selection_quantum (display); |
| 573 | ptrdiff_t count = SPECPDL_INDEX (); |
| 574 | struct selection_data *cs; |
| 575 | |
| 576 | reply->type = SelectionNotify; |
| 577 | reply->display = display; |
| 578 | reply->requestor = window; |
| 579 | reply->selection = SELECTION_EVENT_SELECTION (event); |
| 580 | reply->time = SELECTION_EVENT_TIME (event); |
| 581 | reply->target = SELECTION_EVENT_TARGET (event); |
| 582 | reply->property = SELECTION_EVENT_PROPERTY (event); |
| 583 | if (reply->property == None) |
| 584 | reply->property = reply->target; |
| 585 | |
| 586 | block_input (); |
| 587 | /* The protected block contains wait_for_property_change, which can |
| 588 | run random lisp code (process handlers) or signal. Therefore, we |
| 589 | put the x_uncatch_errors call in an unwind. */ |
| 590 | record_unwind_protect_void (x_catch_errors_unwind); |
| 591 | x_catch_errors (display); |
| 592 | |
| 593 | /* Loop over converted selections, storing them in the requested |
| 594 | properties. If data is large, only store the first N bytes |
| 595 | (section 2.7.2 of ICCCM). Note that we store the data for a |
| 596 | MULTIPLE request in the opposite order; the ICCM says only that |
| 597 | the conversion itself must be done in the same order. */ |
| 598 | for (cs = converted_selections; cs; cs = cs->next) |
| 599 | { |
| 600 | if (cs->property == None) |
| 601 | continue; |
| 602 | |
| 603 | bytes_remaining = cs->size; |
| 604 | bytes_remaining *= cs->format >> 3; |
| 605 | if (bytes_remaining <= max_bytes) |
| 606 | { |
| 607 | /* Send all the data at once, with minimal handshaking. */ |
| 608 | TRACE1 ("Sending all %"pD"d bytes", bytes_remaining); |
| 609 | XChangeProperty (display, window, cs->property, |
| 610 | cs->type, cs->format, PropModeReplace, |
| 611 | cs->data, cs->size); |
| 612 | } |
| 613 | else |
| 614 | { |
| 615 | /* Send an INCR tag to initiate incremental transfer. */ |
| 616 | long value[1]; |
| 617 | |
| 618 | TRACE2 ("Start sending %"pD"d bytes incrementally (%s)", |
| 619 | bytes_remaining, XGetAtomName (display, cs->property)); |
| 620 | cs->wait_object |
| 621 | = expect_property_change (display, window, cs->property, |
| 622 | PropertyDelete); |
| 623 | |
| 624 | /* XChangeProperty expects an array of long even if long is |
| 625 | more than 32 bits. */ |
| 626 | value[0] = min (bytes_remaining, X_LONG_MAX); |
| 627 | XChangeProperty (display, window, cs->property, |
| 628 | dpyinfo->Xatom_INCR, 32, PropModeReplace, |
| 629 | (unsigned char *) value, 1); |
| 630 | XSelectInput (display, window, PropertyChangeMask); |
| 631 | } |
| 632 | } |
| 633 | |
| 634 | /* Now issue the SelectionNotify event. */ |
| 635 | XSendEvent (display, window, False, 0L, &reply_base); |
| 636 | XFlush (display); |
| 637 | |
| 638 | #ifdef TRACE_SELECTION |
| 639 | { |
| 640 | char *sel = XGetAtomName (display, reply->selection); |
| 641 | char *tgt = XGetAtomName (display, reply->target); |
| 642 | TRACE3 ("Sent SelectionNotify: %s, target %s (%d)", |
| 643 | sel, tgt, ++x_reply_selection_request_cnt); |
| 644 | if (sel) XFree (sel); |
| 645 | if (tgt) XFree (tgt); |
| 646 | } |
| 647 | #endif /* TRACE_SELECTION */ |
| 648 | |
| 649 | /* Finish sending the rest of each of the INCR values. This should |
| 650 | be improved; there's a chance of deadlock if more than one |
| 651 | subtarget in a MULTIPLE selection requires an INCR transfer, and |
| 652 | the requestor and Emacs loop waiting on different transfers. */ |
| 653 | for (cs = converted_selections; cs; cs = cs->next) |
| 654 | if (cs->wait_object) |
| 655 | { |
| 656 | int format_bytes = cs->format / 8; |
| 657 | bool had_errors_p = x_had_errors_p (display); |
| 658 | unblock_input (); |
| 659 | |
| 660 | bytes_remaining = cs->size; |
| 661 | bytes_remaining *= format_bytes; |
| 662 | |
| 663 | /* Wait for the requestor to ack by deleting the property. |
| 664 | This can run Lisp code (process handlers) or signal. */ |
| 665 | if (! had_errors_p) |
| 666 | { |
| 667 | TRACE1 ("Waiting for ACK (deletion of %s)", |
| 668 | XGetAtomName (display, cs->property)); |
| 669 | wait_for_property_change (cs->wait_object); |
| 670 | } |
| 671 | else |
| 672 | unexpect_property_change (cs->wait_object); |
| 673 | |
| 674 | while (bytes_remaining) |
| 675 | { |
| 676 | int i = ((bytes_remaining < max_bytes) |
| 677 | ? bytes_remaining |
| 678 | : max_bytes) / format_bytes; |
| 679 | block_input (); |
| 680 | |
| 681 | cs->wait_object |
| 682 | = expect_property_change (display, window, cs->property, |
| 683 | PropertyDelete); |
| 684 | |
| 685 | TRACE1 ("Sending increment of %d elements", i); |
| 686 | TRACE1 ("Set %s to increment data", |
| 687 | XGetAtomName (display, cs->property)); |
| 688 | |
| 689 | /* Append the next chunk of data to the property. */ |
| 690 | XChangeProperty (display, window, cs->property, |
| 691 | cs->type, cs->format, PropModeAppend, |
| 692 | cs->data, i); |
| 693 | bytes_remaining -= i * format_bytes; |
| 694 | cs->data += i * ((cs->format == 32) ? sizeof (long) |
| 695 | : format_bytes); |
| 696 | XFlush (display); |
| 697 | had_errors_p = x_had_errors_p (display); |
| 698 | unblock_input (); |
| 699 | |
| 700 | if (had_errors_p) break; |
| 701 | |
| 702 | /* Wait for the requestor to ack this chunk by deleting |
| 703 | the property. This can run Lisp code or signal. */ |
| 704 | TRACE1 ("Waiting for increment ACK (deletion of %s)", |
| 705 | XGetAtomName (display, cs->property)); |
| 706 | wait_for_property_change (cs->wait_object); |
| 707 | } |
| 708 | |
| 709 | /* Now write a zero-length chunk to the property to tell the |
| 710 | requestor that we're done. */ |
| 711 | block_input (); |
| 712 | if (! waiting_for_other_props_on_window (display, window)) |
| 713 | XSelectInput (display, window, 0L); |
| 714 | |
| 715 | TRACE1 ("Set %s to a 0-length chunk to indicate EOF", |
| 716 | XGetAtomName (display, cs->property)); |
| 717 | XChangeProperty (display, window, cs->property, |
| 718 | cs->type, cs->format, PropModeReplace, |
| 719 | cs->data, 0); |
| 720 | TRACE0 ("Done sending incrementally"); |
| 721 | } |
| 722 | |
| 723 | /* rms, 2003-01-03: I think I have fixed this bug. */ |
| 724 | /* The window we're communicating with may have been deleted |
| 725 | in the meantime (that's a real situation from a bug report). |
| 726 | In this case, there may be events in the event queue still |
| 727 | referring to the deleted window, and we'll get a BadWindow error |
| 728 | in XTread_socket when processing the events. I don't have |
| 729 | an idea how to fix that. gerd, 2001-01-98. */ |
| 730 | /* 2004-09-10: XSync and UNBLOCK so that possible protocol errors are |
| 731 | delivered before uncatch errors. */ |
| 732 | XSync (display, False); |
| 733 | unblock_input (); |
| 734 | |
| 735 | /* GTK queues events in addition to the queue in Xlib. So we |
| 736 | UNBLOCK to enter the event loop and get possible errors delivered, |
| 737 | and then BLOCK again because x_uncatch_errors requires it. */ |
| 738 | block_input (); |
| 739 | /* This calls x_uncatch_errors. */ |
| 740 | unbind_to (count, Qnil); |
| 741 | unblock_input (); |
| 742 | } |
| 743 | \f |
| 744 | /* Handle a SelectionRequest event EVENT. |
| 745 | This is called from keyboard.c when such an event is found in the queue. */ |
| 746 | |
| 747 | static void |
| 748 | x_handle_selection_request (struct input_event *event) |
| 749 | { |
| 750 | struct gcpro gcpro1, gcpro2; |
| 751 | Time local_selection_time; |
| 752 | |
| 753 | Display *display = SELECTION_EVENT_DISPLAY (event); |
| 754 | struct x_display_info *dpyinfo = x_display_info_for_display (display); |
| 755 | Atom selection = SELECTION_EVENT_SELECTION (event); |
| 756 | Lisp_Object selection_symbol = x_atom_to_symbol (display, selection); |
| 757 | Atom target = SELECTION_EVENT_TARGET (event); |
| 758 | Lisp_Object target_symbol = x_atom_to_symbol (display, target); |
| 759 | Atom property = SELECTION_EVENT_PROPERTY (event); |
| 760 | Lisp_Object local_selection_data; |
| 761 | int success = 0; |
| 762 | ptrdiff_t count = SPECPDL_INDEX (); |
| 763 | GCPRO2 (local_selection_data, target_symbol); |
| 764 | |
| 765 | if (!dpyinfo) goto DONE; |
| 766 | |
| 767 | local_selection_data = LOCAL_SELECTION (selection_symbol, dpyinfo); |
| 768 | |
| 769 | /* Decline if we don't own any selections. */ |
| 770 | if (NILP (local_selection_data)) goto DONE; |
| 771 | |
| 772 | /* Decline requests issued prior to our acquiring the selection. */ |
| 773 | CONS_TO_INTEGER (XCAR (XCDR (XCDR (local_selection_data))), |
| 774 | Time, local_selection_time); |
| 775 | if (SELECTION_EVENT_TIME (event) != CurrentTime |
| 776 | && local_selection_time > SELECTION_EVENT_TIME (event)) |
| 777 | goto DONE; |
| 778 | |
| 779 | x_selection_current_request = event; |
| 780 | selection_request_dpyinfo = dpyinfo; |
| 781 | record_unwind_protect_void (x_selection_request_lisp_error); |
| 782 | |
| 783 | /* We might be able to handle nested x_handle_selection_requests, |
| 784 | but this is difficult to test, and seems unimportant. */ |
| 785 | x_start_queuing_selection_requests (); |
| 786 | record_unwind_protect_void (x_stop_queuing_selection_requests); |
| 787 | |
| 788 | TRACE2 ("x_handle_selection_request: selection=%s, target=%s", |
| 789 | SDATA (SYMBOL_NAME (selection_symbol)), |
| 790 | SDATA (SYMBOL_NAME (target_symbol))); |
| 791 | |
| 792 | if (EQ (target_symbol, QMULTIPLE)) |
| 793 | { |
| 794 | /* For MULTIPLE targets, the event property names a list of atom |
| 795 | pairs; the first atom names a target and the second names a |
| 796 | non-None property. */ |
| 797 | Window requestor = SELECTION_EVENT_REQUESTOR (event); |
| 798 | Lisp_Object multprop; |
| 799 | ptrdiff_t j, nselections; |
| 800 | |
| 801 | if (property == None) goto DONE; |
| 802 | multprop |
| 803 | = x_get_window_property_as_lisp_data (display, requestor, property, |
| 804 | QMULTIPLE, selection); |
| 805 | |
| 806 | if (!VECTORP (multprop) || ASIZE (multprop) % 2) |
| 807 | goto DONE; |
| 808 | |
| 809 | nselections = ASIZE (multprop) / 2; |
| 810 | /* Perform conversions. This can signal. */ |
| 811 | for (j = 0; j < nselections; j++) |
| 812 | { |
| 813 | Lisp_Object subtarget = AREF (multprop, 2*j); |
| 814 | Atom subproperty = symbol_to_x_atom (dpyinfo, |
| 815 | AREF (multprop, 2*j+1)); |
| 816 | |
| 817 | if (subproperty != None) |
| 818 | x_convert_selection (event, selection_symbol, subtarget, |
| 819 | subproperty, 1, dpyinfo); |
| 820 | } |
| 821 | success = 1; |
| 822 | } |
| 823 | else |
| 824 | { |
| 825 | if (property == None) |
| 826 | property = SELECTION_EVENT_TARGET (event); |
| 827 | success = x_convert_selection (event, selection_symbol, |
| 828 | target_symbol, property, |
| 829 | 0, dpyinfo); |
| 830 | } |
| 831 | |
| 832 | DONE: |
| 833 | |
| 834 | if (success) |
| 835 | x_reply_selection_request (event, dpyinfo); |
| 836 | else |
| 837 | x_decline_selection_request (event); |
| 838 | x_selection_current_request = 0; |
| 839 | |
| 840 | /* Run the `x-sent-selection-functions' abnormal hook. */ |
| 841 | if (!NILP (Vx_sent_selection_functions) |
| 842 | && !EQ (Vx_sent_selection_functions, Qunbound)) |
| 843 | { |
| 844 | Lisp_Object args[4]; |
| 845 | args[0] = Qx_sent_selection_functions; |
| 846 | args[1] = selection_symbol; |
| 847 | args[2] = target_symbol; |
| 848 | args[3] = success ? Qt : Qnil; |
| 849 | Frun_hook_with_args (4, args); |
| 850 | } |
| 851 | |
| 852 | unbind_to (count, Qnil); |
| 853 | UNGCPRO; |
| 854 | } |
| 855 | |
| 856 | /* Perform the requested selection conversion, and write the data to |
| 857 | the converted_selections linked list, where it can be accessed by |
| 858 | x_reply_selection_request. If FOR_MULTIPLE is non-zero, write out |
| 859 | the data even if conversion fails, using conversion_fail_tag. |
| 860 | |
| 861 | Return 0 if the selection failed to convert, 1 otherwise. */ |
| 862 | |
| 863 | static int |
| 864 | x_convert_selection (struct input_event *event, Lisp_Object selection_symbol, |
| 865 | Lisp_Object target_symbol, Atom property, |
| 866 | int for_multiple, struct x_display_info *dpyinfo) |
| 867 | { |
| 868 | struct gcpro gcpro1; |
| 869 | Lisp_Object lisp_selection; |
| 870 | struct selection_data *cs; |
| 871 | GCPRO1 (lisp_selection); |
| 872 | |
| 873 | lisp_selection |
| 874 | = x_get_local_selection (selection_symbol, target_symbol, |
| 875 | 0, dpyinfo); |
| 876 | |
| 877 | /* A nil return value means we can't perform the conversion. */ |
| 878 | if (NILP (lisp_selection) |
| 879 | || (CONSP (lisp_selection) && NILP (XCDR (lisp_selection)))) |
| 880 | { |
| 881 | if (for_multiple) |
| 882 | { |
| 883 | cs = xmalloc (sizeof *cs); |
| 884 | cs->data = (unsigned char *) &conversion_fail_tag; |
| 885 | cs->size = 1; |
| 886 | cs->format = 32; |
| 887 | cs->type = XA_ATOM; |
| 888 | cs->nofree = 1; |
| 889 | cs->property = property; |
| 890 | cs->wait_object = NULL; |
| 891 | cs->next = converted_selections; |
| 892 | converted_selections = cs; |
| 893 | } |
| 894 | |
| 895 | UNGCPRO; |
| 896 | return 0; |
| 897 | } |
| 898 | |
| 899 | /* Otherwise, record the converted selection to binary. */ |
| 900 | cs = xmalloc (sizeof *cs); |
| 901 | cs->data = NULL; |
| 902 | cs->nofree = 1; |
| 903 | cs->property = property; |
| 904 | cs->wait_object = NULL; |
| 905 | cs->next = converted_selections; |
| 906 | converted_selections = cs; |
| 907 | lisp_data_to_selection_data (SELECTION_EVENT_DISPLAY (event), |
| 908 | lisp_selection, |
| 909 | &(cs->data), &(cs->type), |
| 910 | &(cs->size), &(cs->format), |
| 911 | &(cs->nofree)); |
| 912 | UNGCPRO; |
| 913 | return 1; |
| 914 | } |
| 915 | \f |
| 916 | /* Handle a SelectionClear event EVENT, which indicates that some |
| 917 | client cleared out our previously asserted selection. |
| 918 | This is called from keyboard.c when such an event is found in the queue. */ |
| 919 | |
| 920 | static void |
| 921 | x_handle_selection_clear (struct input_event *event) |
| 922 | { |
| 923 | Display *display = SELECTION_EVENT_DISPLAY (event); |
| 924 | Atom selection = SELECTION_EVENT_SELECTION (event); |
| 925 | Time changed_owner_time = SELECTION_EVENT_TIME (event); |
| 926 | |
| 927 | Lisp_Object selection_symbol, local_selection_data; |
| 928 | Time local_selection_time; |
| 929 | struct x_display_info *dpyinfo = x_display_info_for_display (display); |
| 930 | Lisp_Object Vselection_alist; |
| 931 | |
| 932 | TRACE0 ("x_handle_selection_clear"); |
| 933 | |
| 934 | if (!dpyinfo) return; |
| 935 | |
| 936 | selection_symbol = x_atom_to_symbol (display, selection); |
| 937 | local_selection_data = LOCAL_SELECTION (selection_symbol, dpyinfo); |
| 938 | |
| 939 | /* Well, we already believe that we don't own it, so that's just fine. */ |
| 940 | if (NILP (local_selection_data)) return; |
| 941 | |
| 942 | CONS_TO_INTEGER (XCAR (XCDR (XCDR (local_selection_data))), |
| 943 | Time, local_selection_time); |
| 944 | |
| 945 | /* We have reasserted the selection since this SelectionClear was |
| 946 | generated, so we can disregard it. */ |
| 947 | if (changed_owner_time != CurrentTime |
| 948 | && local_selection_time > changed_owner_time) |
| 949 | return; |
| 950 | |
| 951 | /* Otherwise, really clear. Don't use Fdelq as that may QUIT;. */ |
| 952 | Vselection_alist = dpyinfo->terminal->Vselection_alist; |
| 953 | if (EQ (local_selection_data, CAR (Vselection_alist))) |
| 954 | Vselection_alist = XCDR (Vselection_alist); |
| 955 | else |
| 956 | { |
| 957 | Lisp_Object rest; |
| 958 | for (rest = Vselection_alist; CONSP (rest); rest = XCDR (rest)) |
| 959 | if (EQ (local_selection_data, CAR (XCDR (rest)))) |
| 960 | { |
| 961 | XSETCDR (rest, XCDR (XCDR (rest))); |
| 962 | break; |
| 963 | } |
| 964 | } |
| 965 | tset_selection_alist (dpyinfo->terminal, Vselection_alist); |
| 966 | |
| 967 | /* Run the `x-lost-selection-functions' abnormal hook. */ |
| 968 | { |
| 969 | Lisp_Object args[2]; |
| 970 | args[0] = Qx_lost_selection_functions; |
| 971 | args[1] = selection_symbol; |
| 972 | Frun_hook_with_args (2, args); |
| 973 | } |
| 974 | |
| 975 | prepare_menu_bars (); |
| 976 | redisplay_preserve_echo_area (20); |
| 977 | } |
| 978 | |
| 979 | void |
| 980 | x_handle_selection_event (struct input_event *event) |
| 981 | { |
| 982 | TRACE0 ("x_handle_selection_event"); |
| 983 | if (event->kind != SELECTION_REQUEST_EVENT) |
| 984 | x_handle_selection_clear (event); |
| 985 | else if (x_queue_selection_requests) |
| 986 | x_queue_event (event); |
| 987 | else |
| 988 | x_handle_selection_request (event); |
| 989 | } |
| 990 | |
| 991 | |
| 992 | /* Clear all selections that were made from frame F. |
| 993 | We do this when about to delete a frame. */ |
| 994 | |
| 995 | void |
| 996 | x_clear_frame_selections (struct frame *f) |
| 997 | { |
| 998 | Lisp_Object frame; |
| 999 | Lisp_Object rest; |
| 1000 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 1001 | struct terminal *t = dpyinfo->terminal; |
| 1002 | |
| 1003 | XSETFRAME (frame, f); |
| 1004 | |
| 1005 | /* Delete elements from the beginning of Vselection_alist. */ |
| 1006 | while (CONSP (t->Vselection_alist) |
| 1007 | && EQ (frame, XCAR (XCDR (XCDR (XCDR (XCAR (t->Vselection_alist))))))) |
| 1008 | { |
| 1009 | /* Run the `x-lost-selection-functions' abnormal hook. */ |
| 1010 | Lisp_Object args[2]; |
| 1011 | args[0] = Qx_lost_selection_functions; |
| 1012 | args[1] = Fcar (Fcar (t->Vselection_alist)); |
| 1013 | Frun_hook_with_args (2, args); |
| 1014 | |
| 1015 | tset_selection_alist (t, XCDR (t->Vselection_alist)); |
| 1016 | } |
| 1017 | |
| 1018 | /* Delete elements after the beginning of Vselection_alist. */ |
| 1019 | for (rest = t->Vselection_alist; CONSP (rest); rest = XCDR (rest)) |
| 1020 | if (CONSP (XCDR (rest)) |
| 1021 | && EQ (frame, XCAR (XCDR (XCDR (XCDR (XCAR (XCDR (rest)))))))) |
| 1022 | { |
| 1023 | Lisp_Object args[2]; |
| 1024 | args[0] = Qx_lost_selection_functions; |
| 1025 | args[1] = XCAR (XCAR (XCDR (rest))); |
| 1026 | Frun_hook_with_args (2, args); |
| 1027 | XSETCDR (rest, XCDR (XCDR (rest))); |
| 1028 | break; |
| 1029 | } |
| 1030 | } |
| 1031 | \f |
| 1032 | /* Nonzero if any properties for DISPLAY and WINDOW |
| 1033 | are on the list of what we are waiting for. */ |
| 1034 | |
| 1035 | static int |
| 1036 | waiting_for_other_props_on_window (Display *display, Window window) |
| 1037 | { |
| 1038 | struct prop_location *rest = property_change_wait_list; |
| 1039 | while (rest) |
| 1040 | if (rest->display == display && rest->window == window) |
| 1041 | return 1; |
| 1042 | else |
| 1043 | rest = rest->next; |
| 1044 | return 0; |
| 1045 | } |
| 1046 | |
| 1047 | /* Add an entry to the list of property changes we are waiting for. |
| 1048 | DISPLAY, WINDOW, PROPERTY, STATE describe what we will wait for. |
| 1049 | The return value is a number that uniquely identifies |
| 1050 | this awaited property change. */ |
| 1051 | |
| 1052 | static struct prop_location * |
| 1053 | expect_property_change (Display *display, Window window, |
| 1054 | Atom property, int state) |
| 1055 | { |
| 1056 | struct prop_location *pl = xmalloc (sizeof *pl); |
| 1057 | pl->identifier = ++prop_location_identifier; |
| 1058 | pl->display = display; |
| 1059 | pl->window = window; |
| 1060 | pl->property = property; |
| 1061 | pl->desired_state = state; |
| 1062 | pl->next = property_change_wait_list; |
| 1063 | pl->arrived = 0; |
| 1064 | property_change_wait_list = pl; |
| 1065 | return pl; |
| 1066 | } |
| 1067 | |
| 1068 | /* Delete an entry from the list of property changes we are waiting for. |
| 1069 | IDENTIFIER is the number that uniquely identifies the entry. */ |
| 1070 | |
| 1071 | static void |
| 1072 | unexpect_property_change (struct prop_location *location) |
| 1073 | { |
| 1074 | struct prop_location *prev = 0, *rest = property_change_wait_list; |
| 1075 | while (rest) |
| 1076 | { |
| 1077 | if (rest == location) |
| 1078 | { |
| 1079 | if (prev) |
| 1080 | prev->next = rest->next; |
| 1081 | else |
| 1082 | property_change_wait_list = rest->next; |
| 1083 | xfree (rest); |
| 1084 | return; |
| 1085 | } |
| 1086 | prev = rest; |
| 1087 | rest = rest->next; |
| 1088 | } |
| 1089 | } |
| 1090 | |
| 1091 | /* Remove the property change expectation element for IDENTIFIER. */ |
| 1092 | |
| 1093 | static void |
| 1094 | wait_for_property_change_unwind (void *loc) |
| 1095 | { |
| 1096 | struct prop_location *location = loc; |
| 1097 | |
| 1098 | unexpect_property_change (location); |
| 1099 | if (location == property_change_reply_object) |
| 1100 | property_change_reply_object = 0; |
| 1101 | } |
| 1102 | |
| 1103 | /* Actually wait for a property change. |
| 1104 | IDENTIFIER should be the value that expect_property_change returned. */ |
| 1105 | |
| 1106 | static void |
| 1107 | wait_for_property_change (struct prop_location *location) |
| 1108 | { |
| 1109 | ptrdiff_t count = SPECPDL_INDEX (); |
| 1110 | |
| 1111 | if (property_change_reply_object) |
| 1112 | emacs_abort (); |
| 1113 | |
| 1114 | /* Make sure to do unexpect_property_change if we quit or err. */ |
| 1115 | record_unwind_protect_ptr (wait_for_property_change_unwind, location); |
| 1116 | |
| 1117 | XSETCAR (property_change_reply, Qnil); |
| 1118 | property_change_reply_object = location; |
| 1119 | |
| 1120 | /* If the event we are waiting for arrives beyond here, it will set |
| 1121 | property_change_reply, because property_change_reply_object says so. */ |
| 1122 | if (! location->arrived) |
| 1123 | { |
| 1124 | EMACS_INT timeout = max (0, x_selection_timeout); |
| 1125 | EMACS_INT secs = timeout / 1000; |
| 1126 | int nsecs = (timeout % 1000) * 1000000; |
| 1127 | TRACE2 (" Waiting %"pI"d secs, %d nsecs", secs, nsecs); |
| 1128 | wait_reading_process_output (secs, nsecs, 0, 0, |
| 1129 | property_change_reply, NULL, 0); |
| 1130 | |
| 1131 | if (NILP (XCAR (property_change_reply))) |
| 1132 | { |
| 1133 | TRACE0 (" Timed out"); |
| 1134 | error ("Timed out waiting for property-notify event"); |
| 1135 | } |
| 1136 | } |
| 1137 | |
| 1138 | unbind_to (count, Qnil); |
| 1139 | } |
| 1140 | |
| 1141 | /* Called from XTread_socket in response to a PropertyNotify event. */ |
| 1142 | |
| 1143 | void |
| 1144 | x_handle_property_notify (const XPropertyEvent *event) |
| 1145 | { |
| 1146 | struct prop_location *rest; |
| 1147 | |
| 1148 | for (rest = property_change_wait_list; rest; rest = rest->next) |
| 1149 | { |
| 1150 | if (!rest->arrived |
| 1151 | && rest->property == event->atom |
| 1152 | && rest->window == event->window |
| 1153 | && rest->display == event->display |
| 1154 | && rest->desired_state == event->state) |
| 1155 | { |
| 1156 | TRACE2 ("Expected %s of property %s", |
| 1157 | (event->state == PropertyDelete ? "deletion" : "change"), |
| 1158 | XGetAtomName (event->display, event->atom)); |
| 1159 | |
| 1160 | rest->arrived = 1; |
| 1161 | |
| 1162 | /* If this is the one wait_for_property_change is waiting for, |
| 1163 | tell it to wake up. */ |
| 1164 | if (rest == property_change_reply_object) |
| 1165 | XSETCAR (property_change_reply, Qt); |
| 1166 | |
| 1167 | return; |
| 1168 | } |
| 1169 | } |
| 1170 | } |
| 1171 | |
| 1172 | |
| 1173 | \f |
| 1174 | /* Variables for communication with x_handle_selection_notify. */ |
| 1175 | static Atom reading_which_selection; |
| 1176 | static Lisp_Object reading_selection_reply; |
| 1177 | static Window reading_selection_window; |
| 1178 | |
| 1179 | /* Do protocol to read selection-data from the server. |
| 1180 | Converts this to Lisp data and returns it. |
| 1181 | FRAME is the frame whose X window shall request the selection. */ |
| 1182 | |
| 1183 | static Lisp_Object |
| 1184 | x_get_foreign_selection (Lisp_Object selection_symbol, Lisp_Object target_type, |
| 1185 | Lisp_Object time_stamp, Lisp_Object frame) |
| 1186 | { |
| 1187 | struct frame *f = XFRAME (frame); |
| 1188 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 1189 | Display *display = dpyinfo->display; |
| 1190 | Window requestor_window = FRAME_X_WINDOW (f); |
| 1191 | Time requestor_time = last_event_timestamp; |
| 1192 | Atom target_property = dpyinfo->Xatom_EMACS_TMP; |
| 1193 | Atom selection_atom = symbol_to_x_atom (dpyinfo, selection_symbol); |
| 1194 | Atom type_atom = (CONSP (target_type) |
| 1195 | ? symbol_to_x_atom (dpyinfo, XCAR (target_type)) |
| 1196 | : symbol_to_x_atom (dpyinfo, target_type)); |
| 1197 | EMACS_INT timeout, secs; |
| 1198 | int nsecs; |
| 1199 | |
| 1200 | if (!FRAME_LIVE_P (f)) |
| 1201 | return Qnil; |
| 1202 | |
| 1203 | if (! NILP (time_stamp)) |
| 1204 | CONS_TO_INTEGER (time_stamp, Time, requestor_time); |
| 1205 | |
| 1206 | block_input (); |
| 1207 | TRACE2 ("Get selection %s, type %s", |
| 1208 | XGetAtomName (display, type_atom), |
| 1209 | XGetAtomName (display, target_property)); |
| 1210 | |
| 1211 | x_catch_errors (display); |
| 1212 | XConvertSelection (display, selection_atom, type_atom, target_property, |
| 1213 | requestor_window, requestor_time); |
| 1214 | x_check_errors (display, "Can't convert selection: %s"); |
| 1215 | x_uncatch_errors (); |
| 1216 | |
| 1217 | /* Prepare to block until the reply has been read. */ |
| 1218 | reading_selection_window = requestor_window; |
| 1219 | reading_which_selection = selection_atom; |
| 1220 | XSETCAR (reading_selection_reply, Qnil); |
| 1221 | |
| 1222 | /* It should not be necessary to stop handling selection requests |
| 1223 | during this time. In fact, the SAVE_TARGETS mechanism requires |
| 1224 | us to handle a clipboard manager's requests before it returns |
| 1225 | SelectionNotify. */ |
| 1226 | #if 0 |
| 1227 | x_start_queuing_selection_requests (); |
| 1228 | record_unwind_protect_void (x_stop_queuing_selection_requests); |
| 1229 | #endif |
| 1230 | |
| 1231 | unblock_input (); |
| 1232 | |
| 1233 | /* This allows quits. Also, don't wait forever. */ |
| 1234 | timeout = max (0, x_selection_timeout); |
| 1235 | secs = timeout / 1000; |
| 1236 | nsecs = (timeout % 1000) * 1000000; |
| 1237 | TRACE1 (" Start waiting %"pI"d secs for SelectionNotify", secs); |
| 1238 | wait_reading_process_output (secs, nsecs, 0, 0, |
| 1239 | reading_selection_reply, NULL, 0); |
| 1240 | TRACE1 (" Got event = %d", !NILP (XCAR (reading_selection_reply))); |
| 1241 | |
| 1242 | if (NILP (XCAR (reading_selection_reply))) |
| 1243 | error ("Timed out waiting for reply from selection owner"); |
| 1244 | if (EQ (XCAR (reading_selection_reply), Qlambda)) |
| 1245 | return Qnil; |
| 1246 | |
| 1247 | /* Otherwise, the selection is waiting for us on the requested property. */ |
| 1248 | return |
| 1249 | x_get_window_property_as_lisp_data (display, requestor_window, |
| 1250 | target_property, target_type, |
| 1251 | selection_atom); |
| 1252 | } |
| 1253 | \f |
| 1254 | /* Subroutines of x_get_window_property_as_lisp_data */ |
| 1255 | |
| 1256 | /* Use xfree, not XFree, to free the data obtained with this function. */ |
| 1257 | |
| 1258 | static void |
| 1259 | x_get_window_property (Display *display, Window window, Atom property, |
| 1260 | unsigned char **data_ret, ptrdiff_t *bytes_ret, |
| 1261 | Atom *actual_type_ret, int *actual_format_ret, |
| 1262 | unsigned long *actual_size_ret, int delete_p) |
| 1263 | { |
| 1264 | ptrdiff_t total_size; |
| 1265 | unsigned long bytes_remaining; |
| 1266 | ptrdiff_t offset = 0; |
| 1267 | unsigned char *data = 0; |
| 1268 | unsigned char *tmp_data = 0; |
| 1269 | int result; |
| 1270 | int buffer_size = selection_quantum (display); |
| 1271 | |
| 1272 | /* Wide enough to avoid overflow in expressions using it. */ |
| 1273 | ptrdiff_t x_long_size = X_LONG_SIZE; |
| 1274 | |
| 1275 | /* Maximum value for TOTAL_SIZE. It cannot exceed PTRDIFF_MAX - 1 |
| 1276 | and SIZE_MAX - 1, for an extra byte at the end. And it cannot |
| 1277 | exceed LONG_MAX * X_LONG_SIZE, for XGetWindowProperty. */ |
| 1278 | ptrdiff_t total_size_max = |
| 1279 | ((min (PTRDIFF_MAX, SIZE_MAX) - 1) / x_long_size < LONG_MAX |
| 1280 | ? min (PTRDIFF_MAX, SIZE_MAX) - 1 |
| 1281 | : LONG_MAX * x_long_size); |
| 1282 | |
| 1283 | block_input (); |
| 1284 | |
| 1285 | /* First probe the thing to find out how big it is. */ |
| 1286 | result = XGetWindowProperty (display, window, property, |
| 1287 | 0L, 0L, False, AnyPropertyType, |
| 1288 | actual_type_ret, actual_format_ret, |
| 1289 | actual_size_ret, |
| 1290 | &bytes_remaining, &tmp_data); |
| 1291 | if (result != Success) |
| 1292 | goto done; |
| 1293 | |
| 1294 | /* This was allocated by Xlib, so use XFree. */ |
| 1295 | XFree (tmp_data); |
| 1296 | |
| 1297 | if (*actual_type_ret == None || *actual_format_ret == 0) |
| 1298 | goto done; |
| 1299 | |
| 1300 | if (total_size_max < bytes_remaining) |
| 1301 | goto size_overflow; |
| 1302 | total_size = bytes_remaining; |
| 1303 | data = malloc (total_size + 1); |
| 1304 | if (! data) |
| 1305 | goto memory_exhausted; |
| 1306 | |
| 1307 | /* Now read, until we've gotten it all. */ |
| 1308 | while (bytes_remaining) |
| 1309 | { |
| 1310 | ptrdiff_t bytes_gotten; |
| 1311 | int bytes_per_item; |
| 1312 | result |
| 1313 | = XGetWindowProperty (display, window, property, |
| 1314 | offset / X_LONG_SIZE, |
| 1315 | buffer_size / X_LONG_SIZE, |
| 1316 | False, |
| 1317 | AnyPropertyType, |
| 1318 | actual_type_ret, actual_format_ret, |
| 1319 | actual_size_ret, &bytes_remaining, &tmp_data); |
| 1320 | |
| 1321 | /* If this doesn't return Success at this point, it means that |
| 1322 | some clod deleted the selection while we were in the midst of |
| 1323 | reading it. Deal with that, I guess.... */ |
| 1324 | if (result != Success) |
| 1325 | break; |
| 1326 | |
| 1327 | bytes_per_item = *actual_format_ret >> 3; |
| 1328 | eassert (*actual_size_ret <= buffer_size / bytes_per_item); |
| 1329 | |
| 1330 | /* The man page for XGetWindowProperty says: |
| 1331 | "If the returned format is 32, the returned data is represented |
| 1332 | as a long array and should be cast to that type to obtain the |
| 1333 | elements." |
| 1334 | This applies even if long is more than 32 bits, the X library |
| 1335 | converts from 32 bit elements received from the X server to long |
| 1336 | and passes the long array to us. Thus, for that case memcpy can not |
| 1337 | be used. We convert to a 32 bit type here, because so much code |
| 1338 | assume on that. |
| 1339 | |
| 1340 | The bytes and offsets passed to XGetWindowProperty refers to the |
| 1341 | property and those are indeed in 32 bit quantities if format is 32. */ |
| 1342 | |
| 1343 | bytes_gotten = *actual_size_ret; |
| 1344 | bytes_gotten *= bytes_per_item; |
| 1345 | |
| 1346 | TRACE2 ("Read %"pD"d bytes from property %s", |
| 1347 | bytes_gotten, XGetAtomName (display, property)); |
| 1348 | |
| 1349 | if (total_size - offset < bytes_gotten) |
| 1350 | { |
| 1351 | unsigned char *data1; |
| 1352 | ptrdiff_t remaining_lim = total_size_max - offset - bytes_gotten; |
| 1353 | if (remaining_lim < 0 || remaining_lim < bytes_remaining) |
| 1354 | goto size_overflow; |
| 1355 | total_size = offset + bytes_gotten + bytes_remaining; |
| 1356 | data1 = realloc (data, total_size + 1); |
| 1357 | if (! data1) |
| 1358 | goto memory_exhausted; |
| 1359 | data = data1; |
| 1360 | } |
| 1361 | |
| 1362 | if (BITS_PER_LONG > 32 && *actual_format_ret == 32) |
| 1363 | { |
| 1364 | unsigned long i; |
| 1365 | int *idata = (int *) (data + offset); |
| 1366 | long *ldata = (long *) tmp_data; |
| 1367 | |
| 1368 | for (i = 0; i < *actual_size_ret; ++i) |
| 1369 | idata[i] = ldata[i]; |
| 1370 | } |
| 1371 | else |
| 1372 | memcpy (data + offset, tmp_data, bytes_gotten); |
| 1373 | |
| 1374 | offset += bytes_gotten; |
| 1375 | |
| 1376 | /* This was allocated by Xlib, so use XFree. */ |
| 1377 | XFree (tmp_data); |
| 1378 | } |
| 1379 | |
| 1380 | XFlush (display); |
| 1381 | data[offset] = '\0'; |
| 1382 | |
| 1383 | done: |
| 1384 | unblock_input (); |
| 1385 | *data_ret = data; |
| 1386 | *bytes_ret = offset; |
| 1387 | return; |
| 1388 | |
| 1389 | size_overflow: |
| 1390 | free (data); |
| 1391 | unblock_input (); |
| 1392 | memory_full (SIZE_MAX); |
| 1393 | |
| 1394 | memory_exhausted: |
| 1395 | free (data); |
| 1396 | unblock_input (); |
| 1397 | memory_full (total_size + 1); |
| 1398 | } |
| 1399 | \f |
| 1400 | /* Use xfree, not XFree, to free the data obtained with this function. */ |
| 1401 | |
| 1402 | static void |
| 1403 | receive_incremental_selection (Display *display, Window window, Atom property, |
| 1404 | Lisp_Object target_type, |
| 1405 | unsigned int min_size_bytes, |
| 1406 | unsigned char **data_ret, |
| 1407 | ptrdiff_t *size_bytes_ret, |
| 1408 | Atom *type_ret, int *format_ret, |
| 1409 | unsigned long *size_ret) |
| 1410 | { |
| 1411 | ptrdiff_t offset = 0; |
| 1412 | struct prop_location *wait_object; |
| 1413 | if (min (PTRDIFF_MAX, SIZE_MAX) < min_size_bytes) |
| 1414 | memory_full (SIZE_MAX); |
| 1415 | *data_ret = xmalloc (min_size_bytes); |
| 1416 | *size_bytes_ret = min_size_bytes; |
| 1417 | |
| 1418 | TRACE1 ("Read %u bytes incrementally", min_size_bytes); |
| 1419 | |
| 1420 | /* At this point, we have read an INCR property. |
| 1421 | Delete the property to ack it. |
| 1422 | (But first, prepare to receive the next event in this handshake.) |
| 1423 | |
| 1424 | Now, we must loop, waiting for the sending window to put a value on |
| 1425 | that property, then reading the property, then deleting it to ack. |
| 1426 | We are done when the sender places a property of length 0. |
| 1427 | */ |
| 1428 | block_input (); |
| 1429 | XSelectInput (display, window, STANDARD_EVENT_SET | PropertyChangeMask); |
| 1430 | TRACE1 (" Delete property %s", |
| 1431 | SDATA (SYMBOL_NAME (x_atom_to_symbol (display, property)))); |
| 1432 | XDeleteProperty (display, window, property); |
| 1433 | TRACE1 (" Expect new value of property %s", |
| 1434 | SDATA (SYMBOL_NAME (x_atom_to_symbol (display, property)))); |
| 1435 | wait_object = expect_property_change (display, window, property, |
| 1436 | PropertyNewValue); |
| 1437 | XFlush (display); |
| 1438 | unblock_input (); |
| 1439 | |
| 1440 | while (1) |
| 1441 | { |
| 1442 | unsigned char *tmp_data; |
| 1443 | ptrdiff_t tmp_size_bytes; |
| 1444 | |
| 1445 | TRACE0 (" Wait for property change"); |
| 1446 | wait_for_property_change (wait_object); |
| 1447 | |
| 1448 | /* expect it again immediately, because x_get_window_property may |
| 1449 | .. no it won't, I don't get it. |
| 1450 | .. Ok, I get it now, the Xt code that implements INCR is broken. */ |
| 1451 | TRACE0 (" Get property value"); |
| 1452 | x_get_window_property (display, window, property, |
| 1453 | &tmp_data, &tmp_size_bytes, |
| 1454 | type_ret, format_ret, size_ret, 1); |
| 1455 | |
| 1456 | TRACE1 (" Read increment of %"pD"d bytes", tmp_size_bytes); |
| 1457 | |
| 1458 | if (tmp_size_bytes == 0) /* we're done */ |
| 1459 | { |
| 1460 | TRACE0 ("Done reading incrementally"); |
| 1461 | |
| 1462 | if (! waiting_for_other_props_on_window (display, window)) |
| 1463 | XSelectInput (display, window, STANDARD_EVENT_SET); |
| 1464 | /* Use xfree, not XFree, because x_get_window_property |
| 1465 | calls xmalloc itself. */ |
| 1466 | xfree (tmp_data); |
| 1467 | break; |
| 1468 | } |
| 1469 | |
| 1470 | block_input (); |
| 1471 | TRACE1 (" ACK by deleting property %s", |
| 1472 | XGetAtomName (display, property)); |
| 1473 | XDeleteProperty (display, window, property); |
| 1474 | wait_object = expect_property_change (display, window, property, |
| 1475 | PropertyNewValue); |
| 1476 | XFlush (display); |
| 1477 | unblock_input (); |
| 1478 | |
| 1479 | if (*size_bytes_ret - offset < tmp_size_bytes) |
| 1480 | *data_ret = xpalloc (*data_ret, size_bytes_ret, |
| 1481 | tmp_size_bytes - (*size_bytes_ret - offset), |
| 1482 | -1, 1); |
| 1483 | |
| 1484 | memcpy ((*data_ret) + offset, tmp_data, tmp_size_bytes); |
| 1485 | offset += tmp_size_bytes; |
| 1486 | |
| 1487 | /* Use xfree, not XFree, because x_get_window_property |
| 1488 | calls xmalloc itself. */ |
| 1489 | xfree (tmp_data); |
| 1490 | } |
| 1491 | } |
| 1492 | |
| 1493 | \f |
| 1494 | /* Fetch a value from property PROPERTY of X window WINDOW on display |
| 1495 | DISPLAY. TARGET_TYPE and SELECTION_ATOM are used in error message |
| 1496 | if this fails. */ |
| 1497 | |
| 1498 | static Lisp_Object |
| 1499 | x_get_window_property_as_lisp_data (Display *display, Window window, |
| 1500 | Atom property, |
| 1501 | Lisp_Object target_type, |
| 1502 | Atom selection_atom) |
| 1503 | { |
| 1504 | Atom actual_type; |
| 1505 | int actual_format; |
| 1506 | unsigned long actual_size; |
| 1507 | unsigned char *data = 0; |
| 1508 | ptrdiff_t bytes = 0; |
| 1509 | Lisp_Object val; |
| 1510 | struct x_display_info *dpyinfo = x_display_info_for_display (display); |
| 1511 | |
| 1512 | TRACE0 ("Reading selection data"); |
| 1513 | |
| 1514 | x_get_window_property (display, window, property, &data, &bytes, |
| 1515 | &actual_type, &actual_format, &actual_size, 1); |
| 1516 | if (! data) |
| 1517 | { |
| 1518 | int there_is_a_selection_owner; |
| 1519 | block_input (); |
| 1520 | there_is_a_selection_owner |
| 1521 | = XGetSelectionOwner (display, selection_atom); |
| 1522 | unblock_input (); |
| 1523 | if (there_is_a_selection_owner) |
| 1524 | signal_error ("Selection owner couldn't convert", |
| 1525 | actual_type |
| 1526 | ? list2 (target_type, |
| 1527 | x_atom_to_symbol (display, actual_type)) |
| 1528 | : target_type); |
| 1529 | else |
| 1530 | signal_error ("No selection", |
| 1531 | x_atom_to_symbol (display, selection_atom)); |
| 1532 | } |
| 1533 | |
| 1534 | if (actual_type == dpyinfo->Xatom_INCR) |
| 1535 | { |
| 1536 | /* That wasn't really the data, just the beginning. */ |
| 1537 | |
| 1538 | unsigned int min_size_bytes = * ((unsigned int *) data); |
| 1539 | block_input (); |
| 1540 | /* Use xfree, not XFree, because x_get_window_property |
| 1541 | calls xmalloc itself. */ |
| 1542 | xfree (data); |
| 1543 | unblock_input (); |
| 1544 | receive_incremental_selection (display, window, property, target_type, |
| 1545 | min_size_bytes, &data, &bytes, |
| 1546 | &actual_type, &actual_format, |
| 1547 | &actual_size); |
| 1548 | } |
| 1549 | |
| 1550 | block_input (); |
| 1551 | TRACE1 (" Delete property %s", XGetAtomName (display, property)); |
| 1552 | XDeleteProperty (display, window, property); |
| 1553 | XFlush (display); |
| 1554 | unblock_input (); |
| 1555 | |
| 1556 | /* It's been read. Now convert it to a lisp object in some semi-rational |
| 1557 | manner. */ |
| 1558 | val = selection_data_to_lisp_data (display, data, bytes, |
| 1559 | actual_type, actual_format); |
| 1560 | |
| 1561 | /* Use xfree, not XFree, because x_get_window_property |
| 1562 | calls xmalloc itself. */ |
| 1563 | xfree (data); |
| 1564 | return val; |
| 1565 | } |
| 1566 | \f |
| 1567 | /* These functions convert from the selection data read from the server into |
| 1568 | something that we can use from Lisp, and vice versa. |
| 1569 | |
| 1570 | Type: Format: Size: Lisp Type: |
| 1571 | ----- ------- ----- ----------- |
| 1572 | * 8 * String |
| 1573 | ATOM 32 1 Symbol |
| 1574 | ATOM 32 > 1 Vector of Symbols |
| 1575 | * 16 1 Integer |
| 1576 | * 16 > 1 Vector of Integers |
| 1577 | * 32 1 if <=16 bits: Integer |
| 1578 | if > 16 bits: Cons of top16, bot16 |
| 1579 | * 32 > 1 Vector of the above |
| 1580 | |
| 1581 | When converting a Lisp number to C, it is assumed to be of format 16 if |
| 1582 | it is an integer, and of format 32 if it is a cons of two integers. |
| 1583 | |
| 1584 | When converting a vector of numbers from Lisp to C, it is assumed to be |
| 1585 | of format 16 if every element in the vector is an integer, and is assumed |
| 1586 | to be of format 32 if any element is a cons of two integers. |
| 1587 | |
| 1588 | When converting an object to C, it may be of the form (SYMBOL . <data>) |
| 1589 | where SYMBOL is what we should claim that the type is. Format and |
| 1590 | representation are as above. |
| 1591 | |
| 1592 | Important: When format is 32, data should contain an array of int, |
| 1593 | not an array of long as the X library returns. This makes a difference |
| 1594 | when sizeof(long) != sizeof(int). */ |
| 1595 | |
| 1596 | |
| 1597 | |
| 1598 | static Lisp_Object |
| 1599 | selection_data_to_lisp_data (Display *display, const unsigned char *data, |
| 1600 | ptrdiff_t size, Atom type, int format) |
| 1601 | { |
| 1602 | struct x_display_info *dpyinfo = x_display_info_for_display (display); |
| 1603 | |
| 1604 | if (type == dpyinfo->Xatom_NULL) |
| 1605 | return QNULL; |
| 1606 | |
| 1607 | /* Convert any 8-bit data to a string, for compactness. */ |
| 1608 | else if (format == 8) |
| 1609 | { |
| 1610 | Lisp_Object str, lispy_type; |
| 1611 | |
| 1612 | str = make_unibyte_string ((char *) data, size); |
| 1613 | /* Indicate that this string is from foreign selection by a text |
| 1614 | property `foreign-selection' so that the caller of |
| 1615 | x-get-selection-internal (usually x-get-selection) can know |
| 1616 | that the string must be decode. */ |
| 1617 | if (type == dpyinfo->Xatom_COMPOUND_TEXT) |
| 1618 | lispy_type = QCOMPOUND_TEXT; |
| 1619 | else if (type == dpyinfo->Xatom_UTF8_STRING) |
| 1620 | lispy_type = QUTF8_STRING; |
| 1621 | else |
| 1622 | lispy_type = QSTRING; |
| 1623 | Fput_text_property (make_number (0), make_number (size), |
| 1624 | Qforeign_selection, lispy_type, str); |
| 1625 | return str; |
| 1626 | } |
| 1627 | /* Convert a single atom to a Lisp_Symbol. Convert a set of atoms to |
| 1628 | a vector of symbols. */ |
| 1629 | else if (type == XA_ATOM |
| 1630 | /* Treat ATOM_PAIR type similar to list of atoms. */ |
| 1631 | || type == dpyinfo->Xatom_ATOM_PAIR) |
| 1632 | { |
| 1633 | ptrdiff_t i; |
| 1634 | /* On a 64 bit machine sizeof(Atom) == sizeof(long) == 8. |
| 1635 | But the callers of these function has made sure the data for |
| 1636 | format == 32 is an array of int. Thus, use int instead |
| 1637 | of Atom. */ |
| 1638 | int *idata = (int *) data; |
| 1639 | |
| 1640 | if (size == sizeof (int)) |
| 1641 | return x_atom_to_symbol (display, (Atom) idata[0]); |
| 1642 | else |
| 1643 | { |
| 1644 | Lisp_Object v = make_uninit_vector (size / sizeof (int)); |
| 1645 | |
| 1646 | for (i = 0; i < size / sizeof (int); i++) |
| 1647 | ASET (v, i, x_atom_to_symbol (display, (Atom) idata[i])); |
| 1648 | return v; |
| 1649 | } |
| 1650 | } |
| 1651 | |
| 1652 | /* Convert a single 16-bit number or a small 32-bit number to a Lisp_Int. |
| 1653 | If the number is 32 bits and won't fit in a Lisp_Int, |
| 1654 | convert it to a cons of integers, 16 bits in each half. |
| 1655 | */ |
| 1656 | else if (format == 32 && size == sizeof (int)) |
| 1657 | return INTEGER_TO_CONS (((int *) data) [0]); |
| 1658 | else if (format == 16 && size == sizeof (short)) |
| 1659 | return make_number (((short *) data) [0]); |
| 1660 | |
| 1661 | /* Convert any other kind of data to a vector of numbers, represented |
| 1662 | as above (as an integer, or a cons of two 16 bit integers.) |
| 1663 | */ |
| 1664 | else if (format == 16) |
| 1665 | { |
| 1666 | ptrdiff_t i; |
| 1667 | Lisp_Object v = make_uninit_vector (size / 2); |
| 1668 | |
| 1669 | for (i = 0; i < size / 2; i++) |
| 1670 | { |
| 1671 | short j = ((short *) data) [i]; |
| 1672 | ASET (v, i, make_number (j)); |
| 1673 | } |
| 1674 | return v; |
| 1675 | } |
| 1676 | else |
| 1677 | { |
| 1678 | ptrdiff_t i; |
| 1679 | Lisp_Object v = make_uninit_vector (size / X_LONG_SIZE); |
| 1680 | |
| 1681 | for (i = 0; i < size / X_LONG_SIZE; i++) |
| 1682 | { |
| 1683 | int j = ((int *) data) [i]; |
| 1684 | ASET (v, i, INTEGER_TO_CONS (j)); |
| 1685 | } |
| 1686 | return v; |
| 1687 | } |
| 1688 | } |
| 1689 | |
| 1690 | /* Convert OBJ to an X long value, and return it as unsigned long. |
| 1691 | OBJ should be an integer or a cons representing an integer. |
| 1692 | Treat values in the range X_LONG_MAX + 1 .. X_ULONG_MAX as X |
| 1693 | unsigned long values: in theory these values are supposed to be |
| 1694 | signed but in practice unsigned 32-bit data are communicated via X |
| 1695 | selections and we need to support that. */ |
| 1696 | static unsigned long |
| 1697 | cons_to_x_long (Lisp_Object obj) |
| 1698 | { |
| 1699 | if (X_ULONG_MAX <= INTMAX_MAX |
| 1700 | || XINT (INTEGERP (obj) ? obj : XCAR (obj)) < 0) |
| 1701 | return cons_to_signed (obj, X_LONG_MIN, min (X_ULONG_MAX, INTMAX_MAX)); |
| 1702 | else |
| 1703 | return cons_to_unsigned (obj, X_ULONG_MAX); |
| 1704 | } |
| 1705 | |
| 1706 | /* Use xfree, not XFree, to free the data obtained with this function. */ |
| 1707 | |
| 1708 | static void |
| 1709 | lisp_data_to_selection_data (Display *display, Lisp_Object obj, |
| 1710 | unsigned char **data_ret, Atom *type_ret, |
| 1711 | ptrdiff_t *size_ret, |
| 1712 | int *format_ret, int *nofree_ret) |
| 1713 | { |
| 1714 | Lisp_Object type = Qnil; |
| 1715 | struct x_display_info *dpyinfo = x_display_info_for_display (display); |
| 1716 | |
| 1717 | *nofree_ret = 0; |
| 1718 | |
| 1719 | if (CONSP (obj) && SYMBOLP (XCAR (obj))) |
| 1720 | { |
| 1721 | type = XCAR (obj); |
| 1722 | obj = XCDR (obj); |
| 1723 | if (CONSP (obj) && NILP (XCDR (obj))) |
| 1724 | obj = XCAR (obj); |
| 1725 | } |
| 1726 | |
| 1727 | if (EQ (obj, QNULL) || (EQ (type, QNULL))) |
| 1728 | { /* This is not the same as declining */ |
| 1729 | *format_ret = 32; |
| 1730 | *size_ret = 0; |
| 1731 | *data_ret = 0; |
| 1732 | type = QNULL; |
| 1733 | } |
| 1734 | else if (STRINGP (obj)) |
| 1735 | { |
| 1736 | if (SCHARS (obj) < SBYTES (obj)) |
| 1737 | /* OBJ is a multibyte string containing a non-ASCII char. */ |
| 1738 | signal_error ("Non-ASCII string must be encoded in advance", obj); |
| 1739 | if (NILP (type)) |
| 1740 | type = QSTRING; |
| 1741 | *format_ret = 8; |
| 1742 | *size_ret = SBYTES (obj); |
| 1743 | *data_ret = SDATA (obj); |
| 1744 | *nofree_ret = 1; |
| 1745 | } |
| 1746 | else if (SYMBOLP (obj)) |
| 1747 | { |
| 1748 | void *data = xmalloc (sizeof (Atom) + 1); |
| 1749 | Atom *x_atom_ptr = data; |
| 1750 | *data_ret = data; |
| 1751 | *format_ret = 32; |
| 1752 | *size_ret = 1; |
| 1753 | (*data_ret) [sizeof (Atom)] = 0; |
| 1754 | *x_atom_ptr = symbol_to_x_atom (dpyinfo, obj); |
| 1755 | if (NILP (type)) type = QATOM; |
| 1756 | } |
| 1757 | else if (RANGED_INTEGERP (X_SHRT_MIN, obj, X_SHRT_MAX)) |
| 1758 | { |
| 1759 | void *data = xmalloc (sizeof (short) + 1); |
| 1760 | short *short_ptr = data; |
| 1761 | *data_ret = data; |
| 1762 | *format_ret = 16; |
| 1763 | *size_ret = 1; |
| 1764 | (*data_ret) [sizeof (short)] = 0; |
| 1765 | *short_ptr = XINT (obj); |
| 1766 | if (NILP (type)) type = QINTEGER; |
| 1767 | } |
| 1768 | else if (INTEGERP (obj) |
| 1769 | || (CONSP (obj) && INTEGERP (XCAR (obj)) |
| 1770 | && (INTEGERP (XCDR (obj)) |
| 1771 | || (CONSP (XCDR (obj)) |
| 1772 | && INTEGERP (XCAR (XCDR (obj))))))) |
| 1773 | { |
| 1774 | void *data = xmalloc (sizeof (unsigned long) + 1); |
| 1775 | unsigned long *x_long_ptr = data; |
| 1776 | *data_ret = data; |
| 1777 | *format_ret = 32; |
| 1778 | *size_ret = 1; |
| 1779 | (*data_ret) [sizeof (unsigned long)] = 0; |
| 1780 | *x_long_ptr = cons_to_x_long (obj); |
| 1781 | if (NILP (type)) type = QINTEGER; |
| 1782 | } |
| 1783 | else if (VECTORP (obj)) |
| 1784 | { |
| 1785 | /* Lisp_Vectors may represent a set of ATOMs; |
| 1786 | a set of 16 or 32 bit INTEGERs; |
| 1787 | or a set of ATOM_PAIRs (represented as [[A1 A2] [A3 A4] ...] |
| 1788 | */ |
| 1789 | ptrdiff_t i; |
| 1790 | ptrdiff_t size = ASIZE (obj); |
| 1791 | |
| 1792 | if (SYMBOLP (AREF (obj, 0))) |
| 1793 | /* This vector is an ATOM set */ |
| 1794 | { |
| 1795 | void *data; |
| 1796 | Atom *x_atoms; |
| 1797 | if (NILP (type)) type = QATOM; |
| 1798 | for (i = 0; i < size; i++) |
| 1799 | if (!SYMBOLP (AREF (obj, i))) |
| 1800 | signal_error ("All elements of selection vector must have same type", obj); |
| 1801 | |
| 1802 | *data_ret = data = xnmalloc (size, sizeof *x_atoms); |
| 1803 | x_atoms = data; |
| 1804 | *format_ret = 32; |
| 1805 | *size_ret = size; |
| 1806 | for (i = 0; i < size; i++) |
| 1807 | x_atoms[i] = symbol_to_x_atom (dpyinfo, AREF (obj, i)); |
| 1808 | } |
| 1809 | else |
| 1810 | /* This vector is an INTEGER set, or something like it */ |
| 1811 | { |
| 1812 | int format = 16; |
| 1813 | int data_size = sizeof (short); |
| 1814 | void *data; |
| 1815 | unsigned long *x_atoms; |
| 1816 | short *shorts; |
| 1817 | if (NILP (type)) type = QINTEGER; |
| 1818 | for (i = 0; i < size; i++) |
| 1819 | { |
| 1820 | if (! RANGED_INTEGERP (X_SHRT_MIN, AREF (obj, i), |
| 1821 | X_SHRT_MAX)) |
| 1822 | { |
| 1823 | /* Use sizeof (long) even if it is more than 32 bits. |
| 1824 | See comment in x_get_window_property and |
| 1825 | x_fill_property_data. */ |
| 1826 | data_size = sizeof (long); |
| 1827 | format = 32; |
| 1828 | break; |
| 1829 | } |
| 1830 | } |
| 1831 | *data_ret = data = xnmalloc (size, data_size); |
| 1832 | x_atoms = data; |
| 1833 | shorts = data; |
| 1834 | *format_ret = format; |
| 1835 | *size_ret = size; |
| 1836 | for (i = 0; i < size; i++) |
| 1837 | { |
| 1838 | if (format == 32) |
| 1839 | x_atoms[i] = cons_to_x_long (AREF (obj, i)); |
| 1840 | else |
| 1841 | shorts[i] = XINT (AREF (obj, i)); |
| 1842 | } |
| 1843 | } |
| 1844 | } |
| 1845 | else |
| 1846 | signal_error (/* Qselection_error */ "Unrecognized selection data", obj); |
| 1847 | |
| 1848 | *type_ret = symbol_to_x_atom (dpyinfo, type); |
| 1849 | } |
| 1850 | |
| 1851 | static Lisp_Object |
| 1852 | clean_local_selection_data (Lisp_Object obj) |
| 1853 | { |
| 1854 | if (CONSP (obj) |
| 1855 | && INTEGERP (XCAR (obj)) |
| 1856 | && CONSP (XCDR (obj)) |
| 1857 | && INTEGERP (XCAR (XCDR (obj))) |
| 1858 | && NILP (XCDR (XCDR (obj)))) |
| 1859 | obj = Fcons (XCAR (obj), XCDR (obj)); |
| 1860 | |
| 1861 | if (CONSP (obj) |
| 1862 | && INTEGERP (XCAR (obj)) |
| 1863 | && INTEGERP (XCDR (obj))) |
| 1864 | { |
| 1865 | if (XINT (XCAR (obj)) == 0) |
| 1866 | return XCDR (obj); |
| 1867 | if (XINT (XCAR (obj)) == -1) |
| 1868 | return make_number (- XINT (XCDR (obj))); |
| 1869 | } |
| 1870 | if (VECTORP (obj)) |
| 1871 | { |
| 1872 | ptrdiff_t i; |
| 1873 | ptrdiff_t size = ASIZE (obj); |
| 1874 | Lisp_Object copy; |
| 1875 | if (size == 1) |
| 1876 | return clean_local_selection_data (AREF (obj, 0)); |
| 1877 | copy = make_uninit_vector (size); |
| 1878 | for (i = 0; i < size; i++) |
| 1879 | ASET (copy, i, clean_local_selection_data (AREF (obj, i))); |
| 1880 | return copy; |
| 1881 | } |
| 1882 | return obj; |
| 1883 | } |
| 1884 | \f |
| 1885 | /* Called from XTread_socket to handle SelectionNotify events. |
| 1886 | If it's the selection we are waiting for, stop waiting |
| 1887 | by setting the car of reading_selection_reply to non-nil. |
| 1888 | We store t there if the reply is successful, lambda if not. */ |
| 1889 | |
| 1890 | void |
| 1891 | x_handle_selection_notify (const XSelectionEvent *event) |
| 1892 | { |
| 1893 | if (event->requestor != reading_selection_window) |
| 1894 | return; |
| 1895 | if (event->selection != reading_which_selection) |
| 1896 | return; |
| 1897 | |
| 1898 | TRACE0 ("Received SelectionNotify"); |
| 1899 | XSETCAR (reading_selection_reply, |
| 1900 | (event->property != 0 ? Qt : Qlambda)); |
| 1901 | } |
| 1902 | |
| 1903 | \f |
| 1904 | /* From a Lisp_Object, return a suitable frame for selection |
| 1905 | operations. OBJECT may be a frame, a terminal object, or nil |
| 1906 | (which stands for the selected frame--or, if that is not an X |
| 1907 | frame, the first X display on the list). If no suitable frame can |
| 1908 | be found, return NULL. */ |
| 1909 | |
| 1910 | static struct frame * |
| 1911 | frame_for_x_selection (Lisp_Object object) |
| 1912 | { |
| 1913 | Lisp_Object tail, frame; |
| 1914 | struct frame *f; |
| 1915 | |
| 1916 | if (NILP (object)) |
| 1917 | { |
| 1918 | f = XFRAME (selected_frame); |
| 1919 | if (FRAME_X_P (f) && FRAME_LIVE_P (f)) |
| 1920 | return f; |
| 1921 | |
| 1922 | FOR_EACH_FRAME (tail, frame) |
| 1923 | { |
| 1924 | f = XFRAME (frame); |
| 1925 | if (FRAME_X_P (f) && FRAME_LIVE_P (f)) |
| 1926 | return f; |
| 1927 | } |
| 1928 | } |
| 1929 | else if (TERMINALP (object)) |
| 1930 | { |
| 1931 | struct terminal *t = get_terminal (object, 1); |
| 1932 | |
| 1933 | if (t->type == output_x_window) |
| 1934 | FOR_EACH_FRAME (tail, frame) |
| 1935 | { |
| 1936 | f = XFRAME (frame); |
| 1937 | if (FRAME_LIVE_P (f) && f->terminal == t) |
| 1938 | return f; |
| 1939 | } |
| 1940 | } |
| 1941 | else if (FRAMEP (object)) |
| 1942 | { |
| 1943 | f = XFRAME (object); |
| 1944 | if (FRAME_X_P (f) && FRAME_LIVE_P (f)) |
| 1945 | return f; |
| 1946 | } |
| 1947 | |
| 1948 | return NULL; |
| 1949 | } |
| 1950 | |
| 1951 | |
| 1952 | DEFUN ("x-own-selection-internal", Fx_own_selection_internal, |
| 1953 | Sx_own_selection_internal, 2, 3, 0, |
| 1954 | doc: /* Assert an X selection of type SELECTION and value VALUE. |
| 1955 | SELECTION is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'. |
| 1956 | \(Those are literal upper-case symbol names, since that's what X expects.) |
| 1957 | VALUE is typically a string, or a cons of two markers, but may be |
| 1958 | anything that the functions on `selection-converter-alist' know about. |
| 1959 | |
| 1960 | FRAME should be a frame that should own the selection. If omitted or |
| 1961 | nil, it defaults to the selected frame. |
| 1962 | |
| 1963 | On Nextstep, FRAME is unused. */) |
| 1964 | (Lisp_Object selection, Lisp_Object value, Lisp_Object frame) |
| 1965 | { |
| 1966 | if (NILP (frame)) frame = selected_frame; |
| 1967 | if (!FRAME_LIVE_P (XFRAME (frame)) || !FRAME_X_P (XFRAME (frame))) |
| 1968 | error ("X selection unavailable for this frame"); |
| 1969 | |
| 1970 | CHECK_SYMBOL (selection); |
| 1971 | if (NILP (value)) error ("VALUE may not be nil"); |
| 1972 | x_own_selection (selection, value, frame); |
| 1973 | return value; |
| 1974 | } |
| 1975 | |
| 1976 | |
| 1977 | /* Request the selection value from the owner. If we are the owner, |
| 1978 | simply return our selection value. If we are not the owner, this |
| 1979 | will block until all of the data has arrived. */ |
| 1980 | |
| 1981 | DEFUN ("x-get-selection-internal", Fx_get_selection_internal, |
| 1982 | Sx_get_selection_internal, 2, 4, 0, |
| 1983 | doc: /* Return text selected from some X window. |
| 1984 | SELECTION-SYMBOL is typically `PRIMARY', `SECONDARY', or `CLIPBOARD'. |
| 1985 | \(Those are literal upper-case symbol names, since that's what X expects.) |
| 1986 | TARGET-TYPE is the type of data desired, typically `STRING'. |
| 1987 | |
| 1988 | TIME-STAMP is the time to use in the XConvertSelection call for foreign |
| 1989 | selections. If omitted, defaults to the time for the last event. |
| 1990 | |
| 1991 | TERMINAL should be a terminal object or a frame specifying the X |
| 1992 | server to query. If omitted or nil, that stands for the selected |
| 1993 | frame's display, or the first available X display. |
| 1994 | |
| 1995 | On Nextstep, TIME-STAMP and TERMINAL are unused. */) |
| 1996 | (Lisp_Object selection_symbol, Lisp_Object target_type, |
| 1997 | Lisp_Object time_stamp, Lisp_Object terminal) |
| 1998 | { |
| 1999 | Lisp_Object val = Qnil; |
| 2000 | struct gcpro gcpro1, gcpro2; |
| 2001 | struct frame *f = frame_for_x_selection (terminal); |
| 2002 | GCPRO2 (target_type, val); /* we store newly consed data into these */ |
| 2003 | |
| 2004 | CHECK_SYMBOL (selection_symbol); |
| 2005 | CHECK_SYMBOL (target_type); |
| 2006 | if (EQ (target_type, QMULTIPLE)) |
| 2007 | error ("Retrieving MULTIPLE selections is currently unimplemented"); |
| 2008 | if (!f) |
| 2009 | error ("X selection unavailable for this frame"); |
| 2010 | |
| 2011 | val = x_get_local_selection (selection_symbol, target_type, 1, |
| 2012 | FRAME_DISPLAY_INFO (f)); |
| 2013 | |
| 2014 | if (NILP (val) && FRAME_LIVE_P (f)) |
| 2015 | { |
| 2016 | Lisp_Object frame; |
| 2017 | XSETFRAME (frame, f); |
| 2018 | RETURN_UNGCPRO (x_get_foreign_selection (selection_symbol, target_type, |
| 2019 | time_stamp, frame)); |
| 2020 | } |
| 2021 | |
| 2022 | if (CONSP (val) && SYMBOLP (XCAR (val))) |
| 2023 | { |
| 2024 | val = XCDR (val); |
| 2025 | if (CONSP (val) && NILP (XCDR (val))) |
| 2026 | val = XCAR (val); |
| 2027 | } |
| 2028 | RETURN_UNGCPRO (clean_local_selection_data (val)); |
| 2029 | } |
| 2030 | |
| 2031 | DEFUN ("x-disown-selection-internal", Fx_disown_selection_internal, |
| 2032 | Sx_disown_selection_internal, 1, 3, 0, |
| 2033 | doc: /* If we own the selection SELECTION, disown it. |
| 2034 | Disowning it means there is no such selection. |
| 2035 | |
| 2036 | Sets the last-change time for the selection to TIME-OBJECT (by default |
| 2037 | the time of the last event). |
| 2038 | |
| 2039 | TERMINAL should be a terminal object or a frame specifying the X |
| 2040 | server to query. If omitted or nil, that stands for the selected |
| 2041 | frame's display, or the first available X display. |
| 2042 | |
| 2043 | On Nextstep, the TIME-OBJECT and TERMINAL arguments are unused. |
| 2044 | On MS-DOS, all this does is return non-nil if we own the selection. */) |
| 2045 | (Lisp_Object selection, Lisp_Object time_object, Lisp_Object terminal) |
| 2046 | { |
| 2047 | Time timestamp; |
| 2048 | Atom selection_atom; |
| 2049 | union { |
| 2050 | struct selection_input_event sie; |
| 2051 | struct input_event ie; |
| 2052 | } event; |
| 2053 | struct frame *f = frame_for_x_selection (terminal); |
| 2054 | struct x_display_info *dpyinfo; |
| 2055 | |
| 2056 | if (!f) |
| 2057 | return Qnil; |
| 2058 | |
| 2059 | dpyinfo = FRAME_DISPLAY_INFO (f); |
| 2060 | CHECK_SYMBOL (selection); |
| 2061 | |
| 2062 | /* Don't disown the selection when we're not the owner. */ |
| 2063 | if (NILP (LOCAL_SELECTION (selection, dpyinfo))) |
| 2064 | return Qnil; |
| 2065 | |
| 2066 | selection_atom = symbol_to_x_atom (dpyinfo, selection); |
| 2067 | |
| 2068 | block_input (); |
| 2069 | if (NILP (time_object)) |
| 2070 | timestamp = last_event_timestamp; |
| 2071 | else |
| 2072 | CONS_TO_INTEGER (time_object, Time, timestamp); |
| 2073 | XSetSelectionOwner (dpyinfo->display, selection_atom, None, timestamp); |
| 2074 | unblock_input (); |
| 2075 | |
| 2076 | /* It doesn't seem to be guaranteed that a SelectionClear event will be |
| 2077 | generated for a window which owns the selection when that window sets |
| 2078 | the selection owner to None. The NCD server does, the MIT Sun4 server |
| 2079 | doesn't. So we synthesize one; this means we might get two, but |
| 2080 | that's ok, because the second one won't have any effect. */ |
| 2081 | SELECTION_EVENT_DISPLAY (&event.sie) = dpyinfo->display; |
| 2082 | SELECTION_EVENT_SELECTION (&event.sie) = selection_atom; |
| 2083 | SELECTION_EVENT_TIME (&event.sie) = timestamp; |
| 2084 | x_handle_selection_clear (&event.ie); |
| 2085 | |
| 2086 | return Qt; |
| 2087 | } |
| 2088 | |
| 2089 | DEFUN ("x-selection-owner-p", Fx_selection_owner_p, Sx_selection_owner_p, |
| 2090 | 0, 2, 0, |
| 2091 | doc: /* Whether the current Emacs process owns the given X Selection. |
| 2092 | The arg should be the name of the selection in question, typically one of |
| 2093 | the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'. |
| 2094 | \(Those are literal upper-case symbol names, since that's what X expects.) |
| 2095 | For convenience, the symbol nil is the same as `PRIMARY', |
| 2096 | and t is the same as `SECONDARY'. |
| 2097 | |
| 2098 | TERMINAL should be a terminal object or a frame specifying the X |
| 2099 | server to query. If omitted or nil, that stands for the selected |
| 2100 | frame's display, or the first available X display. |
| 2101 | |
| 2102 | On Nextstep, TERMINAL is unused. */) |
| 2103 | (Lisp_Object selection, Lisp_Object terminal) |
| 2104 | { |
| 2105 | struct frame *f = frame_for_x_selection (terminal); |
| 2106 | |
| 2107 | CHECK_SYMBOL (selection); |
| 2108 | if (EQ (selection, Qnil)) selection = QPRIMARY; |
| 2109 | if (EQ (selection, Qt)) selection = QSECONDARY; |
| 2110 | |
| 2111 | if (f && !NILP (LOCAL_SELECTION (selection, FRAME_DISPLAY_INFO (f)))) |
| 2112 | return Qt; |
| 2113 | else |
| 2114 | return Qnil; |
| 2115 | } |
| 2116 | |
| 2117 | DEFUN ("x-selection-exists-p", Fx_selection_exists_p, Sx_selection_exists_p, |
| 2118 | 0, 2, 0, |
| 2119 | doc: /* Whether there is an owner for the given X selection. |
| 2120 | SELECTION should be the name of the selection in question, typically |
| 2121 | one of the symbols `PRIMARY', `SECONDARY', `CLIPBOARD', or |
| 2122 | `CLIPBOARD_MANAGER' (X expects these literal upper-case names.) The |
| 2123 | symbol nil is the same as `PRIMARY', and t is the same as `SECONDARY'. |
| 2124 | |
| 2125 | TERMINAL should be a terminal object or a frame specifying the X |
| 2126 | server to query. If omitted or nil, that stands for the selected |
| 2127 | frame's display, or the first available X display. |
| 2128 | |
| 2129 | On Nextstep, TERMINAL is unused. */) |
| 2130 | (Lisp_Object selection, Lisp_Object terminal) |
| 2131 | { |
| 2132 | Window owner; |
| 2133 | Atom atom; |
| 2134 | struct frame *f = frame_for_x_selection (terminal); |
| 2135 | struct x_display_info *dpyinfo; |
| 2136 | |
| 2137 | CHECK_SYMBOL (selection); |
| 2138 | if (EQ (selection, Qnil)) selection = QPRIMARY; |
| 2139 | if (EQ (selection, Qt)) selection = QSECONDARY; |
| 2140 | |
| 2141 | if (!f) |
| 2142 | return Qnil; |
| 2143 | |
| 2144 | dpyinfo = FRAME_DISPLAY_INFO (f); |
| 2145 | |
| 2146 | if (!NILP (LOCAL_SELECTION (selection, dpyinfo))) |
| 2147 | return Qt; |
| 2148 | |
| 2149 | atom = symbol_to_x_atom (dpyinfo, selection); |
| 2150 | if (atom == 0) return Qnil; |
| 2151 | block_input (); |
| 2152 | owner = XGetSelectionOwner (dpyinfo->display, atom); |
| 2153 | unblock_input (); |
| 2154 | return (owner ? Qt : Qnil); |
| 2155 | } |
| 2156 | |
| 2157 | \f |
| 2158 | /* Send clipboard manager a SAVE_TARGETS request with a UTF8_STRING |
| 2159 | property (http://www.freedesktop.org/wiki/ClipboardManager). */ |
| 2160 | |
| 2161 | static Lisp_Object |
| 2162 | x_clipboard_manager_save (Lisp_Object frame) |
| 2163 | { |
| 2164 | struct frame *f = XFRAME (frame); |
| 2165 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 2166 | Atom data = dpyinfo->Xatom_UTF8_STRING; |
| 2167 | |
| 2168 | XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), |
| 2169 | dpyinfo->Xatom_EMACS_TMP, |
| 2170 | dpyinfo->Xatom_ATOM, 32, PropModeReplace, |
| 2171 | (unsigned char *) &data, 1); |
| 2172 | x_get_foreign_selection (QCLIPBOARD_MANAGER, QSAVE_TARGETS, |
| 2173 | Qnil, frame); |
| 2174 | return Qt; |
| 2175 | } |
| 2176 | |
| 2177 | /* Error handler for x_clipboard_manager_save_frame. */ |
| 2178 | |
| 2179 | static Lisp_Object |
| 2180 | x_clipboard_manager_error_1 (Lisp_Object err) |
| 2181 | { |
| 2182 | Lisp_Object args[2]; |
| 2183 | args[0] = build_string ("X clipboard manager error: %s\n\ |
| 2184 | If the problem persists, set `x-select-enable-clipboard-manager' to nil."); |
| 2185 | args[1] = CAR (CDR (err)); |
| 2186 | Fmessage (2, args); |
| 2187 | return Qnil; |
| 2188 | } |
| 2189 | |
| 2190 | /* Error handler for x_clipboard_manager_save_all. */ |
| 2191 | |
| 2192 | static Lisp_Object |
| 2193 | x_clipboard_manager_error_2 (Lisp_Object err) |
| 2194 | { |
| 2195 | fprintf (stderr, "Error saving to X clipboard manager.\n\ |
| 2196 | If the problem persists, set `x-select-enable-clipboard-manager' \ |
| 2197 | to nil.\n"); |
| 2198 | return Qnil; |
| 2199 | } |
| 2200 | |
| 2201 | /* Called from delete_frame: save any clipboard owned by FRAME to the |
| 2202 | clipboard manager. Do nothing if FRAME does not own the clipboard, |
| 2203 | or if no clipboard manager is present. */ |
| 2204 | |
| 2205 | void |
| 2206 | x_clipboard_manager_save_frame (Lisp_Object frame) |
| 2207 | { |
| 2208 | struct frame *f; |
| 2209 | |
| 2210 | if (!NILP (Vx_select_enable_clipboard_manager) |
| 2211 | && FRAMEP (frame) |
| 2212 | && (f = XFRAME (frame), FRAME_X_P (f)) |
| 2213 | && FRAME_LIVE_P (f)) |
| 2214 | { |
| 2215 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 2216 | Lisp_Object local_selection |
| 2217 | = LOCAL_SELECTION (QCLIPBOARD, dpyinfo); |
| 2218 | |
| 2219 | if (!NILP (local_selection) |
| 2220 | && EQ (frame, XCAR (XCDR (XCDR (XCDR (local_selection))))) |
| 2221 | && XGetSelectionOwner (dpyinfo->display, |
| 2222 | dpyinfo->Xatom_CLIPBOARD_MANAGER)) |
| 2223 | internal_condition_case_1 (x_clipboard_manager_save, frame, Qt, |
| 2224 | x_clipboard_manager_error_1); |
| 2225 | } |
| 2226 | } |
| 2227 | |
| 2228 | /* Called from Fkill_emacs: save any clipboard owned by FRAME to the |
| 2229 | clipboard manager. Do nothing if FRAME does not own the clipboard, |
| 2230 | or if no clipboard manager is present. */ |
| 2231 | |
| 2232 | void |
| 2233 | x_clipboard_manager_save_all (void) |
| 2234 | { |
| 2235 | /* Loop through all X displays, saving owned clipboards. */ |
| 2236 | struct x_display_info *dpyinfo; |
| 2237 | Lisp_Object local_selection, local_frame; |
| 2238 | |
| 2239 | if (NILP (Vx_select_enable_clipboard_manager)) |
| 2240 | return; |
| 2241 | |
| 2242 | for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next) |
| 2243 | { |
| 2244 | local_selection = LOCAL_SELECTION (QCLIPBOARD, dpyinfo); |
| 2245 | if (NILP (local_selection) |
| 2246 | || !XGetSelectionOwner (dpyinfo->display, |
| 2247 | dpyinfo->Xatom_CLIPBOARD_MANAGER)) |
| 2248 | continue; |
| 2249 | |
| 2250 | local_frame = XCAR (XCDR (XCDR (XCDR (local_selection)))); |
| 2251 | if (FRAME_LIVE_P (XFRAME (local_frame))) |
| 2252 | { |
| 2253 | Lisp_Object args[1]; |
| 2254 | args[0] = build_string ("Saving clipboard to X clipboard manager..."); |
| 2255 | Fmessage (1, args); |
| 2256 | |
| 2257 | internal_condition_case_1 (x_clipboard_manager_save, local_frame, |
| 2258 | Qt, x_clipboard_manager_error_2); |
| 2259 | } |
| 2260 | } |
| 2261 | } |
| 2262 | |
| 2263 | \f |
| 2264 | /*********************************************************************** |
| 2265 | Drag and drop support |
| 2266 | ***********************************************************************/ |
| 2267 | /* Check that lisp values are of correct type for x_fill_property_data. |
| 2268 | That is, number, string or a cons with two numbers (low and high 16 |
| 2269 | bit parts of a 32 bit number). Return the number of items in DATA, |
| 2270 | or -1 if there is an error. */ |
| 2271 | |
| 2272 | int |
| 2273 | x_check_property_data (Lisp_Object data) |
| 2274 | { |
| 2275 | Lisp_Object iter; |
| 2276 | int size = 0; |
| 2277 | |
| 2278 | for (iter = data; CONSP (iter); iter = XCDR (iter)) |
| 2279 | { |
| 2280 | Lisp_Object o = XCAR (iter); |
| 2281 | |
| 2282 | if (! NUMBERP (o) && ! STRINGP (o) && ! CONSP (o)) |
| 2283 | return -1; |
| 2284 | else if (CONSP (o) && |
| 2285 | (! NUMBERP (XCAR (o)) || ! NUMBERP (XCDR (o)))) |
| 2286 | return -1; |
| 2287 | if (size == INT_MAX) |
| 2288 | return -1; |
| 2289 | size++; |
| 2290 | } |
| 2291 | |
| 2292 | return size; |
| 2293 | } |
| 2294 | |
| 2295 | /* Convert lisp values to a C array. Values may be a number, a string |
| 2296 | which is taken as an X atom name and converted to the atom value, or |
| 2297 | a cons containing the two 16 bit parts of a 32 bit number. |
| 2298 | |
| 2299 | DPY is the display use to look up X atoms. |
| 2300 | DATA is a Lisp list of values to be converted. |
| 2301 | RET is the C array that contains the converted values. It is assumed |
| 2302 | it is big enough to hold all values. |
| 2303 | FORMAT is 8, 16 or 32 and denotes char/short/long for each C value to |
| 2304 | be stored in RET. Note that long is used for 32 even if long is more |
| 2305 | than 32 bits (see man pages for XChangeProperty, XGetWindowProperty and |
| 2306 | XClientMessageEvent). */ |
| 2307 | |
| 2308 | void |
| 2309 | x_fill_property_data (Display *dpy, Lisp_Object data, void *ret, int format) |
| 2310 | { |
| 2311 | long val; |
| 2312 | long *d32 = (long *) ret; |
| 2313 | short *d16 = (short *) ret; |
| 2314 | char *d08 = (char *) ret; |
| 2315 | Lisp_Object iter; |
| 2316 | |
| 2317 | for (iter = data; CONSP (iter); iter = XCDR (iter)) |
| 2318 | { |
| 2319 | Lisp_Object o = XCAR (iter); |
| 2320 | |
| 2321 | if (INTEGERP (o) || FLOATP (o) || CONSP (o)) |
| 2322 | val = cons_to_signed (o, LONG_MIN, LONG_MAX); |
| 2323 | else if (STRINGP (o)) |
| 2324 | { |
| 2325 | block_input (); |
| 2326 | val = (long) XInternAtom (dpy, SSDATA (o), False); |
| 2327 | unblock_input (); |
| 2328 | } |
| 2329 | else |
| 2330 | error ("Wrong type, must be string, number or cons"); |
| 2331 | |
| 2332 | if (format == 8) |
| 2333 | { |
| 2334 | if (CHAR_MIN <= val && val <= CHAR_MAX) |
| 2335 | *d08++ = val; |
| 2336 | else |
| 2337 | error ("Out of 'char' range"); |
| 2338 | } |
| 2339 | else if (format == 16) |
| 2340 | { |
| 2341 | if (SHRT_MIN <= val && val <= SHRT_MAX) |
| 2342 | *d16++ = val; |
| 2343 | else |
| 2344 | error ("Out of 'short' range"); |
| 2345 | } |
| 2346 | else |
| 2347 | *d32++ = val; |
| 2348 | } |
| 2349 | } |
| 2350 | |
| 2351 | /* Convert an array of C values to a Lisp list. |
| 2352 | F is the frame to be used to look up X atoms if the TYPE is XA_ATOM. |
| 2353 | DATA is a C array of values to be converted. |
| 2354 | TYPE is the type of the data. Only XA_ATOM is special, it converts |
| 2355 | each number in DATA to its corresponding X atom as a symbol. |
| 2356 | FORMAT is 8, 16 or 32 and gives the size in bits for each C value to |
| 2357 | be stored in RET. |
| 2358 | SIZE is the number of elements in DATA. |
| 2359 | |
| 2360 | Important: When format is 32, data should contain an array of int, |
| 2361 | not an array of long as the X library returns. This makes a difference |
| 2362 | when sizeof(long) != sizeof(int). |
| 2363 | |
| 2364 | Also see comment for selection_data_to_lisp_data above. */ |
| 2365 | |
| 2366 | Lisp_Object |
| 2367 | x_property_data_to_lisp (struct frame *f, const unsigned char *data, |
| 2368 | Atom type, int format, long unsigned int size) |
| 2369 | { |
| 2370 | ptrdiff_t format_bytes = format >> 3; |
| 2371 | if (PTRDIFF_MAX / format_bytes < size) |
| 2372 | memory_full (SIZE_MAX); |
| 2373 | return selection_data_to_lisp_data (FRAME_X_DISPLAY (f), |
| 2374 | data, size * format_bytes, type, format); |
| 2375 | } |
| 2376 | |
| 2377 | /* Get the mouse position in frame relative coordinates. */ |
| 2378 | |
| 2379 | static void |
| 2380 | mouse_position_for_drop (struct frame *f, int *x, int *y) |
| 2381 | { |
| 2382 | Window root, dummy_window; |
| 2383 | int dummy; |
| 2384 | |
| 2385 | block_input (); |
| 2386 | |
| 2387 | XQueryPointer (FRAME_X_DISPLAY (f), |
| 2388 | DefaultRootWindow (FRAME_X_DISPLAY (f)), |
| 2389 | |
| 2390 | /* The root window which contains the pointer. */ |
| 2391 | &root, |
| 2392 | |
| 2393 | /* Window pointer is on, not used */ |
| 2394 | &dummy_window, |
| 2395 | |
| 2396 | /* The position on that root window. */ |
| 2397 | x, y, |
| 2398 | |
| 2399 | /* x/y in dummy_window coordinates, not used. */ |
| 2400 | &dummy, &dummy, |
| 2401 | |
| 2402 | /* Modifier keys and pointer buttons, about which |
| 2403 | we don't care. */ |
| 2404 | (unsigned int *) &dummy); |
| 2405 | |
| 2406 | |
| 2407 | /* Absolute to relative. */ |
| 2408 | *x -= f->left_pos + FRAME_OUTER_TO_INNER_DIFF_X (f); |
| 2409 | *y -= f->top_pos + FRAME_OUTER_TO_INNER_DIFF_Y (f); |
| 2410 | |
| 2411 | unblock_input (); |
| 2412 | } |
| 2413 | |
| 2414 | DEFUN ("x-get-atom-name", Fx_get_atom_name, |
| 2415 | Sx_get_atom_name, 1, 2, 0, |
| 2416 | doc: /* Return the X atom name for VALUE as a string. |
| 2417 | VALUE may be a number or a cons where the car is the upper 16 bits and |
| 2418 | the cdr is the lower 16 bits of a 32 bit value. |
| 2419 | Use the display for FRAME or the current frame if FRAME is not given or nil. |
| 2420 | |
| 2421 | If the value is 0 or the atom is not known, return the empty string. */) |
| 2422 | (Lisp_Object value, Lisp_Object frame) |
| 2423 | { |
| 2424 | struct frame *f = decode_window_system_frame (frame); |
| 2425 | char *name = 0; |
| 2426 | char empty[] = ""; |
| 2427 | Lisp_Object ret = Qnil; |
| 2428 | Display *dpy = FRAME_X_DISPLAY (f); |
| 2429 | Atom atom; |
| 2430 | bool had_errors_p; |
| 2431 | |
| 2432 | CONS_TO_INTEGER (value, Atom, atom); |
| 2433 | |
| 2434 | block_input (); |
| 2435 | x_catch_errors (dpy); |
| 2436 | name = atom ? XGetAtomName (dpy, atom) : empty; |
| 2437 | had_errors_p = x_had_errors_p (dpy); |
| 2438 | x_uncatch_errors (); |
| 2439 | |
| 2440 | if (!had_errors_p) |
| 2441 | ret = build_string (name); |
| 2442 | |
| 2443 | if (atom && name) XFree (name); |
| 2444 | if (NILP (ret)) ret = empty_unibyte_string; |
| 2445 | |
| 2446 | unblock_input (); |
| 2447 | |
| 2448 | return ret; |
| 2449 | } |
| 2450 | |
| 2451 | DEFUN ("x-register-dnd-atom", Fx_register_dnd_atom, |
| 2452 | Sx_register_dnd_atom, 1, 2, 0, |
| 2453 | doc: /* Request that dnd events are made for ClientMessages with ATOM. |
| 2454 | ATOM can be a symbol or a string. The ATOM is interned on the display that |
| 2455 | FRAME is on. If FRAME is nil, the selected frame is used. */) |
| 2456 | (Lisp_Object atom, Lisp_Object frame) |
| 2457 | { |
| 2458 | Atom x_atom; |
| 2459 | struct frame *f = decode_window_system_frame (frame); |
| 2460 | ptrdiff_t i; |
| 2461 | struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f); |
| 2462 | |
| 2463 | |
| 2464 | if (SYMBOLP (atom)) |
| 2465 | x_atom = symbol_to_x_atom (dpyinfo, atom); |
| 2466 | else if (STRINGP (atom)) |
| 2467 | { |
| 2468 | block_input (); |
| 2469 | x_atom = XInternAtom (FRAME_X_DISPLAY (f), SSDATA (atom), False); |
| 2470 | unblock_input (); |
| 2471 | } |
| 2472 | else |
| 2473 | error ("ATOM must be a symbol or a string"); |
| 2474 | |
| 2475 | for (i = 0; i < dpyinfo->x_dnd_atoms_length; ++i) |
| 2476 | if (dpyinfo->x_dnd_atoms[i] == x_atom) |
| 2477 | return Qnil; |
| 2478 | |
| 2479 | if (dpyinfo->x_dnd_atoms_length == dpyinfo->x_dnd_atoms_size) |
| 2480 | dpyinfo->x_dnd_atoms = |
| 2481 | xpalloc (dpyinfo->x_dnd_atoms, &dpyinfo->x_dnd_atoms_size, |
| 2482 | 1, -1, sizeof *dpyinfo->x_dnd_atoms); |
| 2483 | |
| 2484 | dpyinfo->x_dnd_atoms[dpyinfo->x_dnd_atoms_length++] = x_atom; |
| 2485 | return Qnil; |
| 2486 | } |
| 2487 | |
| 2488 | /* Convert an XClientMessageEvent to a Lisp event of type DRAG_N_DROP_EVENT. */ |
| 2489 | |
| 2490 | int |
| 2491 | x_handle_dnd_message (struct frame *f, const XClientMessageEvent *event, |
| 2492 | struct x_display_info *dpyinfo, struct input_event *bufp) |
| 2493 | { |
| 2494 | Lisp_Object vec; |
| 2495 | Lisp_Object frame; |
| 2496 | /* format 32 => size 5, format 16 => size 10, format 8 => size 20 */ |
| 2497 | unsigned long size = 160/event->format; |
| 2498 | int x, y; |
| 2499 | unsigned char *data = (unsigned char *) event->data.b; |
| 2500 | int idata[5]; |
| 2501 | ptrdiff_t i; |
| 2502 | |
| 2503 | for (i = 0; i < dpyinfo->x_dnd_atoms_length; ++i) |
| 2504 | if (dpyinfo->x_dnd_atoms[i] == event->message_type) break; |
| 2505 | |
| 2506 | if (i == dpyinfo->x_dnd_atoms_length) return 0; |
| 2507 | |
| 2508 | XSETFRAME (frame, f); |
| 2509 | |
| 2510 | /* On a 64 bit machine, the event->data.l array members are 64 bits (long), |
| 2511 | but the x_property_data_to_lisp (or rather selection_data_to_lisp_data) |
| 2512 | function expects them to be of size int (i.e. 32). So to be able to |
| 2513 | use that function, put the data in the form it expects if format is 32. */ |
| 2514 | |
| 2515 | if (BITS_PER_LONG > 32 && event->format == 32) |
| 2516 | { |
| 2517 | for (i = 0; i < 5; ++i) /* There are only 5 longs in a ClientMessage. */ |
| 2518 | idata[i] = event->data.l[i]; |
| 2519 | data = (unsigned char *) idata; |
| 2520 | } |
| 2521 | |
| 2522 | vec = Fmake_vector (make_number (4), Qnil); |
| 2523 | ASET (vec, 0, SYMBOL_NAME (x_atom_to_symbol (FRAME_X_DISPLAY (f), |
| 2524 | event->message_type))); |
| 2525 | ASET (vec, 1, frame); |
| 2526 | ASET (vec, 2, make_number (event->format)); |
| 2527 | ASET (vec, 3, x_property_data_to_lisp (f, |
| 2528 | data, |
| 2529 | event->message_type, |
| 2530 | event->format, |
| 2531 | size)); |
| 2532 | |
| 2533 | mouse_position_for_drop (f, &x, &y); |
| 2534 | bufp->kind = DRAG_N_DROP_EVENT; |
| 2535 | bufp->frame_or_window = frame; |
| 2536 | bufp->timestamp = CurrentTime; |
| 2537 | bufp->x = make_number (x); |
| 2538 | bufp->y = make_number (y); |
| 2539 | bufp->arg = vec; |
| 2540 | bufp->modifiers = 0; |
| 2541 | |
| 2542 | return 1; |
| 2543 | } |
| 2544 | |
| 2545 | DEFUN ("x-send-client-message", Fx_send_client_message, |
| 2546 | Sx_send_client_message, 6, 6, 0, |
| 2547 | doc: /* Send a client message of MESSAGE-TYPE to window DEST on DISPLAY. |
| 2548 | |
| 2549 | For DISPLAY, specify either a frame or a display name (a string). |
| 2550 | If DISPLAY is nil, that stands for the selected frame's display. |
| 2551 | DEST may be a number, in which case it is a Window id. The value 0 may |
| 2552 | be used to send to the root window of the DISPLAY. |
| 2553 | If DEST is a cons, it is converted to a 32 bit number |
| 2554 | with the high 16 bits from the car and the lower 16 bit from the cdr. That |
| 2555 | number is then used as a window id. |
| 2556 | If DEST is a frame the event is sent to the outer window of that frame. |
| 2557 | A value of nil means the currently selected frame. |
| 2558 | If DEST is the string "PointerWindow" the event is sent to the window that |
| 2559 | contains the pointer. If DEST is the string "InputFocus" the event is |
| 2560 | sent to the window that has the input focus. |
| 2561 | FROM is the frame sending the event. Use nil for currently selected frame. |
| 2562 | MESSAGE-TYPE is the name of an Atom as a string. |
| 2563 | FORMAT must be one of 8, 16 or 32 and determines the size of the values in |
| 2564 | bits. VALUES is a list of numbers, cons and/or strings containing the values |
| 2565 | to send. If a value is a string, it is converted to an Atom and the value of |
| 2566 | the Atom is sent. If a value is a cons, it is converted to a 32 bit number |
| 2567 | with the high 16 bits from the car and the lower 16 bit from the cdr. |
| 2568 | If more values than fits into the event is given, the excessive values |
| 2569 | are ignored. */) |
| 2570 | (Lisp_Object display, Lisp_Object dest, Lisp_Object from, |
| 2571 | Lisp_Object message_type, Lisp_Object format, Lisp_Object values) |
| 2572 | { |
| 2573 | struct x_display_info *dpyinfo = check_x_display_info (display); |
| 2574 | |
| 2575 | CHECK_STRING (message_type); |
| 2576 | x_send_client_event (display, dest, from, |
| 2577 | XInternAtom (dpyinfo->display, |
| 2578 | SSDATA (message_type), |
| 2579 | False), |
| 2580 | format, values); |
| 2581 | |
| 2582 | return Qnil; |
| 2583 | } |
| 2584 | |
| 2585 | void |
| 2586 | x_send_client_event (Lisp_Object display, Lisp_Object dest, Lisp_Object from, |
| 2587 | Atom message_type, Lisp_Object format, Lisp_Object values) |
| 2588 | { |
| 2589 | struct x_display_info *dpyinfo = check_x_display_info (display); |
| 2590 | Window wdest; |
| 2591 | XEvent event; |
| 2592 | struct frame *f = decode_window_system_frame (from); |
| 2593 | int to_root; |
| 2594 | |
| 2595 | CHECK_NUMBER (format); |
| 2596 | CHECK_CONS (values); |
| 2597 | |
| 2598 | if (x_check_property_data (values) == -1) |
| 2599 | error ("Bad data in VALUES, must be number, cons or string"); |
| 2600 | |
| 2601 | if (XINT (format) != 8 && XINT (format) != 16 && XINT (format) != 32) |
| 2602 | error ("FORMAT must be one of 8, 16 or 32"); |
| 2603 | |
| 2604 | event.xclient.type = ClientMessage; |
| 2605 | event.xclient.format = XINT (format); |
| 2606 | |
| 2607 | if (FRAMEP (dest) || NILP (dest)) |
| 2608 | { |
| 2609 | struct frame *fdest = decode_window_system_frame (dest); |
| 2610 | wdest = FRAME_OUTER_WINDOW (fdest); |
| 2611 | } |
| 2612 | else if (STRINGP (dest)) |
| 2613 | { |
| 2614 | if (strcmp (SSDATA (dest), "PointerWindow") == 0) |
| 2615 | wdest = PointerWindow; |
| 2616 | else if (strcmp (SSDATA (dest), "InputFocus") == 0) |
| 2617 | wdest = InputFocus; |
| 2618 | else |
| 2619 | error ("DEST as a string must be one of PointerWindow or InputFocus"); |
| 2620 | } |
| 2621 | else if (INTEGERP (dest) || FLOATP (dest) || CONSP (dest)) |
| 2622 | CONS_TO_INTEGER (dest, Window, wdest); |
| 2623 | else |
| 2624 | error ("DEST must be a frame, nil, string, number or cons"); |
| 2625 | |
| 2626 | if (wdest == 0) wdest = dpyinfo->root_window; |
| 2627 | to_root = wdest == dpyinfo->root_window; |
| 2628 | |
| 2629 | block_input (); |
| 2630 | |
| 2631 | event.xclient.send_event = True; |
| 2632 | event.xclient.serial = 0; |
| 2633 | event.xclient.message_type = message_type; |
| 2634 | event.xclient.display = dpyinfo->display; |
| 2635 | |
| 2636 | /* Some clients (metacity for example) expects sending window to be here |
| 2637 | when sending to the root window. */ |
| 2638 | event.xclient.window = to_root ? FRAME_OUTER_WINDOW (f) : wdest; |
| 2639 | |
| 2640 | memset (event.xclient.data.l, 0, sizeof (event.xclient.data.l)); |
| 2641 | x_fill_property_data (dpyinfo->display, values, event.xclient.data.b, |
| 2642 | event.xclient.format); |
| 2643 | |
| 2644 | /* If event mask is 0 the event is sent to the client that created |
| 2645 | the destination window. But if we are sending to the root window, |
| 2646 | there is no such client. Then we set the event mask to 0xffffff. The |
| 2647 | event then goes to clients selecting for events on the root window. */ |
| 2648 | x_catch_errors (dpyinfo->display); |
| 2649 | { |
| 2650 | int propagate = to_root ? False : True; |
| 2651 | long mask = to_root ? 0xffffff : 0; |
| 2652 | |
| 2653 | XSendEvent (dpyinfo->display, wdest, propagate, mask, &event); |
| 2654 | XFlush (dpyinfo->display); |
| 2655 | } |
| 2656 | x_uncatch_errors (); |
| 2657 | unblock_input (); |
| 2658 | } |
| 2659 | |
| 2660 | \f |
| 2661 | void |
| 2662 | syms_of_xselect (void) |
| 2663 | { |
| 2664 | defsubr (&Sx_get_selection_internal); |
| 2665 | defsubr (&Sx_own_selection_internal); |
| 2666 | defsubr (&Sx_disown_selection_internal); |
| 2667 | defsubr (&Sx_selection_owner_p); |
| 2668 | defsubr (&Sx_selection_exists_p); |
| 2669 | |
| 2670 | defsubr (&Sx_get_atom_name); |
| 2671 | defsubr (&Sx_send_client_message); |
| 2672 | defsubr (&Sx_register_dnd_atom); |
| 2673 | |
| 2674 | reading_selection_reply = Fcons (Qnil, Qnil); |
| 2675 | staticpro (&reading_selection_reply); |
| 2676 | reading_selection_window = 0; |
| 2677 | reading_which_selection = 0; |
| 2678 | |
| 2679 | property_change_wait_list = 0; |
| 2680 | prop_location_identifier = 0; |
| 2681 | property_change_reply = Fcons (Qnil, Qnil); |
| 2682 | staticpro (&property_change_reply); |
| 2683 | |
| 2684 | converted_selections = NULL; |
| 2685 | conversion_fail_tag = None; |
| 2686 | |
| 2687 | DEFVAR_LISP ("selection-converter-alist", Vselection_converter_alist, |
| 2688 | doc: /* An alist associating X Windows selection-types with functions. |
| 2689 | These functions are called to convert the selection, with three args: |
| 2690 | the name of the selection (typically `PRIMARY', `SECONDARY', or `CLIPBOARD'); |
| 2691 | a desired type to which the selection should be converted; |
| 2692 | and the local selection value (whatever was given to `x-own-selection'). |
| 2693 | |
| 2694 | The function should return the value to send to the X server |
| 2695 | \(typically a string). A return value of nil |
| 2696 | means that the conversion could not be done. |
| 2697 | A return value which is the symbol `NULL' |
| 2698 | means that a side-effect was executed, |
| 2699 | and there is no meaningful selection value. */); |
| 2700 | Vselection_converter_alist = Qnil; |
| 2701 | |
| 2702 | DEFVAR_LISP ("x-lost-selection-functions", Vx_lost_selection_functions, |
| 2703 | doc: /* A list of functions to be called when Emacs loses an X selection. |
| 2704 | \(This happens when some other X client makes its own selection |
| 2705 | or when a Lisp program explicitly clears the selection.) |
| 2706 | The functions are called with one argument, the selection type |
| 2707 | \(a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'). */); |
| 2708 | Vx_lost_selection_functions = Qnil; |
| 2709 | |
| 2710 | DEFVAR_LISP ("x-sent-selection-functions", Vx_sent_selection_functions, |
| 2711 | doc: /* A list of functions to be called when Emacs answers a selection request. |
| 2712 | The functions are called with three arguments: |
| 2713 | - the selection name (typically `PRIMARY', `SECONDARY', or `CLIPBOARD'); |
| 2714 | - the selection-type which Emacs was asked to convert the |
| 2715 | selection into before sending (for example, `STRING' or `LENGTH'); |
| 2716 | - a flag indicating success or failure for responding to the request. |
| 2717 | We might have failed (and declined the request) for any number of reasons, |
| 2718 | including being asked for a selection that we no longer own, or being asked |
| 2719 | to convert into a type that we don't know about or that is inappropriate. |
| 2720 | This hook doesn't let you change the behavior of Emacs's selection replies, |
| 2721 | it merely informs you that they have happened. */); |
| 2722 | Vx_sent_selection_functions = Qnil; |
| 2723 | |
| 2724 | DEFVAR_LISP ("x-select-enable-clipboard-manager", |
| 2725 | Vx_select_enable_clipboard_manager, |
| 2726 | doc: /* Whether to enable X clipboard manager support. |
| 2727 | If non-nil, then whenever Emacs is killed or an Emacs frame is deleted |
| 2728 | while owning the X clipboard, the clipboard contents are saved to the |
| 2729 | clipboard manager if one is present. */); |
| 2730 | Vx_select_enable_clipboard_manager = Qt; |
| 2731 | |
| 2732 | DEFVAR_INT ("x-selection-timeout", x_selection_timeout, |
| 2733 | doc: /* Number of milliseconds to wait for a selection reply. |
| 2734 | If the selection owner doesn't reply in this time, we give up. |
| 2735 | A value of 0 means wait as long as necessary. This is initialized from the |
| 2736 | \"*selectionTimeout\" resource. */); |
| 2737 | x_selection_timeout = 0; |
| 2738 | |
| 2739 | /* QPRIMARY is defined in keyboard.c. */ |
| 2740 | DEFSYM (QSECONDARY, "SECONDARY"); |
| 2741 | DEFSYM (QSTRING, "STRING"); |
| 2742 | DEFSYM (QINTEGER, "INTEGER"); |
| 2743 | DEFSYM (QCLIPBOARD, "CLIPBOARD"); |
| 2744 | DEFSYM (QTIMESTAMP, "TIMESTAMP"); |
| 2745 | DEFSYM (QTEXT, "TEXT"); |
| 2746 | DEFSYM (QCOMPOUND_TEXT, "COMPOUND_TEXT"); |
| 2747 | DEFSYM (QUTF8_STRING, "UTF8_STRING"); |
| 2748 | DEFSYM (QDELETE, "DELETE"); |
| 2749 | DEFSYM (QMULTIPLE, "MULTIPLE"); |
| 2750 | DEFSYM (QINCR, "INCR"); |
| 2751 | DEFSYM (QEMACS_TMP, "_EMACS_TMP_"); |
| 2752 | DEFSYM (QTARGETS, "TARGETS"); |
| 2753 | DEFSYM (QATOM, "ATOM"); |
| 2754 | DEFSYM (QATOM_PAIR, "ATOM_PAIR"); |
| 2755 | DEFSYM (QCLIPBOARD_MANAGER, "CLIPBOARD_MANAGER"); |
| 2756 | DEFSYM (QSAVE_TARGETS, "SAVE_TARGETS"); |
| 2757 | DEFSYM (QNULL, "NULL"); |
| 2758 | DEFSYM (Qcompound_text_with_extensions, "compound-text-with-extensions"); |
| 2759 | DEFSYM (Qforeign_selection, "foreign-selection"); |
| 2760 | DEFSYM (Qx_lost_selection_functions, "x-lost-selection-functions"); |
| 2761 | DEFSYM (Qx_sent_selection_functions, "x-sent-selection-functions"); |
| 2762 | } |