xselect.c 84.9 KB
Newer Older
1
/* X Selection processing for Emacs.
2
   Copyright (C) 1993, 1994, 1995, 1996, 1997, 2000, 2001, 2003
3
   Free Software Foundation.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
21

Jim Blandy's avatar
Jim Blandy committed
22

Richard M. Stallman's avatar
Richard M. Stallman committed
23 24
/* Rewritten by jwz */

25
#include <config.h>
Jan Djärv's avatar
Jan Djärv committed
26
#include <stdio.h>      /* termhooks.h needs this */
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28
#include "lisp.h"
#include "xterm.h"	/* for all of the X includes */
29 30
#include "dispextern.h"	/* frame.h seems to want this */
#include "frame.h"	/* Need this to get the X window of selected_frame */
31
#include "blockinput.h"
Kenichi Handa's avatar
Kenichi Handa committed
32
#include "buffer.h"
Andreas Schwab's avatar
Andreas Schwab committed
33
#include "process.h"
34 35 36
#include "termhooks.h"

#include <X11/Xproto.h>
37

38 39 40 41 42 43
struct prop_location;

static Lisp_Object x_atom_to_symbol P_ ((Display *dpy, Atom atom));
static Atom symbol_to_x_atom P_ ((struct x_display_info *, Display *,
				  Lisp_Object));
static void x_own_selection P_ ((Lisp_Object, Lisp_Object));
Kenichi Handa's avatar
Kenichi Handa committed
44
static Lisp_Object x_get_local_selection P_ ((Lisp_Object, Lisp_Object, int));
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
static void x_decline_selection_request P_ ((struct input_event *));
static Lisp_Object x_selection_request_lisp_error P_ ((Lisp_Object));
static Lisp_Object queue_selection_requests_unwind P_ ((Lisp_Object));
static Lisp_Object some_frame_on_display P_ ((struct x_display_info *));
static void x_reply_selection_request P_ ((struct input_event *, int,
					   unsigned char *, int, Atom));
static int waiting_for_other_props_on_window P_ ((Display *, Window));
static struct prop_location *expect_property_change P_ ((Display *, Window,
							 Atom, int));
static void unexpect_property_change P_ ((struct prop_location *));
static Lisp_Object wait_for_property_change_unwind P_ ((Lisp_Object));
static void wait_for_property_change P_ ((struct prop_location *));
static Lisp_Object x_get_foreign_selection P_ ((Lisp_Object, Lisp_Object));
static void x_get_window_property P_ ((Display *, Window, Atom,
				       unsigned char **, int *,
				       Atom *, int *, unsigned long *, int));
static void receive_incremental_selection P_ ((Display *, Window, Atom,
					       Lisp_Object, unsigned,
					       unsigned char **, int *,
					       Atom *, int *, unsigned long *));
static Lisp_Object x_get_window_property_as_lisp_data P_ ((Display *,
							   Window, Atom,
							   Lisp_Object, Atom));
static Lisp_Object selection_data_to_lisp_data P_ ((Display *, unsigned char *,
						    int, Atom, int));
static void lisp_data_to_selection_data P_ ((Display *, Lisp_Object,
					     unsigned char **, Atom *,
					     unsigned *, int *, int *));
static Lisp_Object clean_local_selection_data P_ ((Lisp_Object));
static void initialize_cut_buffers P_ ((Display *, Window));


/* Printing traces to stderr.  */

#ifdef TRACE_SELECTION
#define TRACE0(fmt) \
  fprintf (stderr, "%d: " fmt "\n", getpid ())
#define TRACE1(fmt, a0) \
  fprintf (stderr, "%d: " fmt "\n", getpid (), a0)
#define TRACE2(fmt, a0, a1) \
  fprintf (stderr, "%d: " fmt "\n", getpid (), a0, a1)
#else
#define TRACE0(fmt)		(void) 0
#define TRACE1(fmt, a0)		(void) 0
#define TRACE2(fmt, a0, a1)	(void) 0
#endif


Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96 97 98
#define CUT_BUFFER_SUPPORT

Lisp_Object QPRIMARY, QSECONDARY, QSTRING, QINTEGER, QCLIPBOARD, QTIMESTAMP,
  QTEXT, QDELETE, QMULTIPLE, QINCR, QEMACS_TMP, QTARGETS, QATOM, QNULL,
  QATOM_PAIR;

Karl Heuer's avatar
Karl Heuer committed
99
Lisp_Object QCOMPOUND_TEXT;	/* This is a type of selection.  */
Kenichi Handa's avatar
Kenichi Handa committed
100
Lisp_Object QUTF8_STRING;	/* This is a type of selection.  */
Karl Heuer's avatar
Karl Heuer committed
101

102
Lisp_Object Qcompound_text_with_extensions;
103

Richard M. Stallman's avatar
Richard M. Stallman committed
104 105 106 107 108
#ifdef CUT_BUFFER_SUPPORT
Lisp_Object QCUT_BUFFER0, QCUT_BUFFER1, QCUT_BUFFER2, QCUT_BUFFER3,
  QCUT_BUFFER4, QCUT_BUFFER5, QCUT_BUFFER6, QCUT_BUFFER7;
#endif

109 110
static Lisp_Object Vx_lost_selection_hooks;
static Lisp_Object Vx_sent_selection_hooks;
111 112
/* Coding system for communicating with other X clients via cutbuffer,
   selection, and clipboard.  */
113
static Lisp_Object Vselection_coding_system;
Richard M. Stallman's avatar
Richard M. Stallman committed
114

115 116 117
/* Coding system for the next communicating with other X clients.  */
static Lisp_Object Vnext_selection_coding_system;

118 119
static Lisp_Object Qforeign_selection;

Richard M. Stallman's avatar
Richard M. Stallman committed
120 121 122
/* If this is a smaller number than the max-request-size of the display,
   emacs will use INCR selection transfer when the selection is larger
   than this.  The max-request-size is usually around 64k, so if you want
123
   emacs to use incremental selection transfers when the selection is
Richard M. Stallman's avatar
Richard M. Stallman committed
124
   smaller than that, set this.  I added this mostly for debugging the
125
   incremental transfer stuff, but it might improve server performance.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
126 127
#define MAX_SELECTION_QUANTUM 0xFFFFFF

128 129 130 131 132
#ifdef HAVE_X11R4
#define SELECTION_QUANTUM(dpy) ((XMaxRequestSize(dpy) << 2) - 100)
#else
#define SELECTION_QUANTUM(dpy) (((dpy)->max_request_size << 2) - 100)
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
133

134
/* The timestamp of the last input event Emacs received from the X server.  */
135 136
/* Defined in keyboard.c.  */
extern unsigned long last_event_timestamp;
Richard M. Stallman's avatar
Richard M. Stallman committed
137 138

/* This is an association list whose elements are of the form
139 140 141
     ( SELECTION-NAME SELECTION-VALUE SELECTION-TIMESTAMP FRAME)
   SELECTION-NAME is a lisp symbol, whose name is the name of an X Atom.
   SELECTION-VALUE is the value that emacs owns for that selection.
Richard M. Stallman's avatar
Richard M. Stallman committed
142
     It may be any kind of Lisp object.
143
   SELECTION-TIMESTAMP is the time at which emacs began owning this selection,
Richard M. Stallman's avatar
Richard M. Stallman committed
144
     as a cons of two 16-bit numbers (making a 32 bit time.)
145 146
   FRAME is the frame for which we made the selection.
   If there is an entry in this alist, then it can be assumed that Emacs owns
Richard M. Stallman's avatar
Richard M. Stallman committed
147 148
    that selection.
   The only (eq) parts of this list that are visible from Lisp are the
149 150
    selection-values.  */
static Lisp_Object Vselection_alist;
Richard M. Stallman's avatar
Richard M. Stallman committed
151 152 153

/* This is an alist whose CARs are selection-types (whose names are the same
   as the names of X Atoms) and whose CDRs are the names of Lisp functions to
154
   call to convert the given Emacs selection value to a string representing
Richard M. Stallman's avatar
Richard M. Stallman committed
155
   the given selection type.  This is for Lisp-level extension of the emacs
156 157
   selection handling.  */
static Lisp_Object Vselection_converter_alist;
Richard M. Stallman's avatar
Richard M. Stallman committed
158 159

/* If the selection owner takes too long to reply to a selection request,
160
   we give up on it.  This is in milliseconds (0 = no timeout.)  */
161
static EMACS_INT x_selection_timeout;
Richard M. Stallman's avatar
Richard M. Stallman committed
162 163 164 165 166 167 168

/* Utility functions */

static void lisp_data_to_selection_data ();
static Lisp_Object selection_data_to_lisp_data ();
static Lisp_Object x_get_window_property_as_lisp_data ();

169
/* This converts a Lisp symbol to a server Atom, avoiding a server
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171 172
   roundtrip whenever possible.  */

static Atom
173 174
symbol_to_x_atom (dpyinfo, display, sym)
     struct x_display_info *dpyinfo;
Richard M. Stallman's avatar
Richard M. Stallman committed
175 176 177 178 179 180 181 182 183 184
     Display *display;
     Lisp_Object sym;
{
  Atom val;
  if (NILP (sym))	    return 0;
  if (EQ (sym, QPRIMARY))   return XA_PRIMARY;
  if (EQ (sym, QSECONDARY)) return XA_SECONDARY;
  if (EQ (sym, QSTRING))    return XA_STRING;
  if (EQ (sym, QINTEGER))   return XA_INTEGER;
  if (EQ (sym, QATOM))	    return XA_ATOM;
185 186 187
  if (EQ (sym, QCLIPBOARD)) return dpyinfo->Xatom_CLIPBOARD;
  if (EQ (sym, QTIMESTAMP)) return dpyinfo->Xatom_TIMESTAMP;
  if (EQ (sym, QTEXT))	    return dpyinfo->Xatom_TEXT;
Karl Heuer's avatar
Karl Heuer committed
188
  if (EQ (sym, QCOMPOUND_TEXT)) return dpyinfo->Xatom_COMPOUND_TEXT;
Kenichi Handa's avatar
Kenichi Handa committed
189
  if (EQ (sym, QUTF8_STRING)) return dpyinfo->Xatom_UTF8_STRING;
190 191 192 193 194 195
  if (EQ (sym, QDELETE))    return dpyinfo->Xatom_DELETE;
  if (EQ (sym, QMULTIPLE))  return dpyinfo->Xatom_MULTIPLE;
  if (EQ (sym, QINCR))	    return dpyinfo->Xatom_INCR;
  if (EQ (sym, QEMACS_TMP)) return dpyinfo->Xatom_EMACS_TMP;
  if (EQ (sym, QTARGETS))   return dpyinfo->Xatom_TARGETS;
  if (EQ (sym, QNULL))	    return dpyinfo->Xatom_NULL;
Richard M. Stallman's avatar
Richard M. Stallman committed
196 197 198 199 200 201 202 203 204 205 206 207
#ifdef CUT_BUFFER_SUPPORT
  if (EQ (sym, QCUT_BUFFER0)) return XA_CUT_BUFFER0;
  if (EQ (sym, QCUT_BUFFER1)) return XA_CUT_BUFFER1;
  if (EQ (sym, QCUT_BUFFER2)) return XA_CUT_BUFFER2;
  if (EQ (sym, QCUT_BUFFER3)) return XA_CUT_BUFFER3;
  if (EQ (sym, QCUT_BUFFER4)) return XA_CUT_BUFFER4;
  if (EQ (sym, QCUT_BUFFER5)) return XA_CUT_BUFFER5;
  if (EQ (sym, QCUT_BUFFER6)) return XA_CUT_BUFFER6;
  if (EQ (sym, QCUT_BUFFER7)) return XA_CUT_BUFFER7;
#endif
  if (!SYMBOLP (sym)) abort ();

208
  TRACE1 (" XInternAtom %s", (char *) SDATA (SYMBOL_NAME (sym)));
Richard M. Stallman's avatar
Richard M. Stallman committed
209
  BLOCK_INPUT;
210
  val = XInternAtom (display, (char *) SDATA (SYMBOL_NAME (sym)), False);
Richard M. Stallman's avatar
Richard M. Stallman committed
211 212 213 214 215 216 217 218 219
  UNBLOCK_INPUT;
  return val;
}


/* This converts a server Atom to a Lisp symbol, avoiding server roundtrips
   and calls to intern whenever possible.  */

static Lisp_Object
220 221
x_atom_to_symbol (dpy, atom)
     Display *dpy;
Richard M. Stallman's avatar
Richard M. Stallman committed
222 223
     Atom atom;
{
224
  struct x_display_info *dpyinfo;
Richard M. Stallman's avatar
Richard M. Stallman committed
225 226
  char *str;
  Lisp_Object val;
227

228 229
  if (! atom)
    return Qnil;
230

231 232 233 234 235 236 237 238 239 240 241 242
  switch (atom)
    {
    case XA_PRIMARY:
      return QPRIMARY;
    case XA_SECONDARY:
      return QSECONDARY;
    case XA_STRING:
      return QSTRING;
    case XA_INTEGER:
      return QINTEGER;
    case XA_ATOM:
      return QATOM;
Richard M. Stallman's avatar
Richard M. Stallman committed
243
#ifdef CUT_BUFFER_SUPPORT
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
    case XA_CUT_BUFFER0:
      return QCUT_BUFFER0;
    case XA_CUT_BUFFER1:
      return QCUT_BUFFER1;
    case XA_CUT_BUFFER2:
      return QCUT_BUFFER2;
    case XA_CUT_BUFFER3:
      return QCUT_BUFFER3;
    case XA_CUT_BUFFER4:
      return QCUT_BUFFER4;
    case XA_CUT_BUFFER5:
      return QCUT_BUFFER5;
    case XA_CUT_BUFFER6:
      return QCUT_BUFFER6;
    case XA_CUT_BUFFER7:
      return QCUT_BUFFER7;
Richard M. Stallman's avatar
Richard M. Stallman committed
260
#endif
261 262
    }

263
  dpyinfo = x_display_info_for_display (dpy);
264
  if (atom == dpyinfo->Xatom_CLIPBOARD)
265
    return QCLIPBOARD;
266
  if (atom == dpyinfo->Xatom_TIMESTAMP)
267
    return QTIMESTAMP;
268
  if (atom == dpyinfo->Xatom_TEXT)
269
    return QTEXT;
Karl Heuer's avatar
Karl Heuer committed
270 271
  if (atom == dpyinfo->Xatom_COMPOUND_TEXT)
    return QCOMPOUND_TEXT;
Kenichi Handa's avatar
Kenichi Handa committed
272 273
  if (atom == dpyinfo->Xatom_UTF8_STRING)
    return QUTF8_STRING;
274
  if (atom == dpyinfo->Xatom_DELETE)
275
    return QDELETE;
276
  if (atom == dpyinfo->Xatom_MULTIPLE)
277
    return QMULTIPLE;
278
  if (atom == dpyinfo->Xatom_INCR)
279
    return QINCR;
280
  if (atom == dpyinfo->Xatom_EMACS_TMP)
281
    return QEMACS_TMP;
282
  if (atom == dpyinfo->Xatom_TARGETS)
283
    return QTARGETS;
284
  if (atom == dpyinfo->Xatom_NULL)
285
    return QNULL;
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287

  BLOCK_INPUT;
288
  str = XGetAtomName (dpy, atom);
Richard M. Stallman's avatar
Richard M. Stallman committed
289
  UNBLOCK_INPUT;
290
  TRACE1 ("XGetAtomName --> %s", str);
Richard M. Stallman's avatar
Richard M. Stallman committed
291 292 293
  if (! str) return Qnil;
  val = intern (str);
  BLOCK_INPUT;
294
  /* This was allocated by Xlib, so use XFree.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
295 296 297 298
  XFree (str);
  UNBLOCK_INPUT;
  return val;
}
299

Richard M. Stallman's avatar
Richard M. Stallman committed
300
/* Do protocol to assert ourself as a selection owner.
301
   Update the Vselection_alist so that we can reply to later requests for
Richard M. Stallman's avatar
Richard M. Stallman committed
302 303 304 305 306 307
   our selection.  */

static void
x_own_selection (selection_name, selection_value)
     Lisp_Object selection_name, selection_value;
{
308 309 310
  struct frame *sf = SELECTED_FRAME ();
  Window selecting_window = FRAME_X_WINDOW (sf);
  Display *display = FRAME_X_DISPLAY (sf);
311
  Time time = last_event_timestamp;
Richard M. Stallman's avatar
Richard M. Stallman committed
312
  Atom selection_atom;
313
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (sf);
314
  int count;
Richard M. Stallman's avatar
Richard M. Stallman committed
315

316
  CHECK_SYMBOL (selection_name);
317
  selection_atom = symbol_to_x_atom (dpyinfo, display, selection_name);
Richard M. Stallman's avatar
Richard M. Stallman committed
318 319

  BLOCK_INPUT;
320
  count = x_catch_errors (display);
Richard M. Stallman's avatar
Richard M. Stallman committed
321
  XSetSelectionOwner (display, selection_atom, selecting_window, time);
322
  x_check_errors (display, "Can't set selection: %s");
323
  x_uncatch_errors (display, count);
Richard M. Stallman's avatar
Richard M. Stallman committed
324 325 326 327 328 329 330 331 332 333 334
  UNBLOCK_INPUT;

  /* Now update the local cache */
  {
    Lisp_Object selection_time;
    Lisp_Object selection_data;
    Lisp_Object prev_value;

    selection_time = long_to_cons ((unsigned long) time);
    selection_data = Fcons (selection_name,
			    Fcons (selection_value,
335
				   Fcons (selection_time,
336
					  Fcons (selected_frame, Qnil))));
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340 341 342 343 344 345 346 347
    prev_value = assq_no_quit (selection_name, Vselection_alist);

    Vselection_alist = Fcons (selection_data, Vselection_alist);

    /* If we already owned the selection, remove the old selection data.
       Perhaps we should destructively modify it instead.
       Don't use Fdelq as that may QUIT.  */
    if (!NILP (prev_value))
      {
	Lisp_Object rest;	/* we know it's not the CAR, so it's easy.  */
	for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
348
	  if (EQ (prev_value, Fcar (XCDR (rest))))
Richard M. Stallman's avatar
Richard M. Stallman committed
349
	    {
350
	      XSETCDR (rest, Fcdr (XCDR (rest)));
Richard M. Stallman's avatar
Richard M. Stallman committed
351 352 353 354 355 356 357 358 359
	      break;
	    }
      }
  }
}

/* Given a selection-name and desired type, look up our local copy of
   the selection value and convert it to the type.
   The value is nil or a string.
Kenichi Handa's avatar
Kenichi Handa committed
360 361
   This function is used both for remote requests (LOCAL_REQUEST is zero)
   and for local x-get-selection-internal (LOCAL_REQUEST is nonzero).
Richard M. Stallman's avatar
Richard M. Stallman committed
362 363 364 365

   This calls random Lisp code, and may signal or gc.  */

static Lisp_Object
Kenichi Handa's avatar
Kenichi Handa committed
366
x_get_local_selection (selection_symbol, target_type, local_request)
Richard M. Stallman's avatar
Richard M. Stallman committed
367
     Lisp_Object selection_symbol, target_type;
Kenichi Handa's avatar
Kenichi Handa committed
368
     int local_request;
Richard M. Stallman's avatar
Richard M. Stallman committed
369 370 371 372 373 374 375 376 377 378 379 380 381
{
  Lisp_Object local_value;
  Lisp_Object handler_fn, value, type, check;
  int count;

  local_value = assq_no_quit (selection_symbol, Vselection_alist);

  if (NILP (local_value)) return Qnil;

  /* TIMESTAMP and MULTIPLE are special cases 'cause that's easiest.  */
  if (EQ (target_type, QTIMESTAMP))
    {
      handler_fn = Qnil;
382
      value = XCAR (XCDR (XCDR (local_value)));
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385 386 387 388 389
    }
#if 0
  else if (EQ (target_type, QDELETE))
    {
      handler_fn = Qnil;
      Fx_disown_selection_internal
	(selection_symbol,
390
	 XCAR (XCDR (XCDR (local_value))));
Richard M. Stallman's avatar
Richard M. Stallman committed
391 392 393 394 395 396
      value = QNULL;
    }
#endif

#if 0 /* #### MULTIPLE doesn't work yet */
  else if (CONSP (target_type)
397
	   && XCAR (target_type) == QMULTIPLE)
Richard M. Stallman's avatar
Richard M. Stallman committed
398
    {
399 400
      Lisp_Object pairs;
      int size;
Richard M. Stallman's avatar
Richard M. Stallman committed
401
      int i;
402
      pairs = XCDR (target_type);
403
      size = XVECTOR (pairs)->size;
Richard M. Stallman's avatar
Richard M. Stallman committed
404 405 406 407 408 409 410
      /* If the target is MULTIPLE, then target_type looks like
	  (MULTIPLE . [[SELECTION1 TARGET1] [SELECTION2 TARGET2] ... ])
	 We modify the second element of each pair in the vector and
	 return it as [[SELECTION1 <value1>] [SELECTION2 <value2>] ... ]
       */
      for (i = 0; i < size; i++)
	{
411 412
	  Lisp_Object pair;
	  pair = XVECTOR (pairs)->contents [i];
Richard M. Stallman's avatar
Richard M. Stallman committed
413 414
	  XVECTOR (pair)->contents [1]
	    = x_get_local_selection (XVECTOR (pair)->contents [0],
Kenichi Handa's avatar
Kenichi Handa committed
415 416
				     XVECTOR (pair)->contents [1],
				     local_request);
Richard M. Stallman's avatar
Richard M. Stallman committed
417 418 419 420 421 422 423 424 425
	}
      return pairs;
    }
#endif
  else
    {
      /* Don't allow a quit within the converter.
	 When the user types C-g, he would be surprised
	 if by luck it came during a converter.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
426
      count = SPECPDL_INDEX ();
Richard M. Stallman's avatar
Richard M. Stallman committed
427 428
      specbind (Qinhibit_quit, Qt);

429
      CHECK_SYMBOL (target_type);
Richard M. Stallman's avatar
Richard M. Stallman committed
430
      handler_fn = Fcdr (Fassq (target_type, Vselection_converter_alist));
431 432 433
      /* gcpro is not needed here since nothing but HANDLER_FN
	 is live, and that ought to be a symbol.  */

434 435
      if (!NILP (handler_fn))
	value = call3 (handler_fn,
Kenichi Handa's avatar
Kenichi Handa committed
436
		       selection_symbol, (local_request ? Qnil : target_type),
437
		       XCAR (XCDR (local_value)));
438 439
      else
	value = Qnil;
Richard M. Stallman's avatar
Richard M. Stallman committed
440 441 442 443 444
      unbind_to (count, Qnil);
    }

  /* Make sure this value is of a type that we could transmit
     to another X client.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
445

Richard M. Stallman's avatar
Richard M. Stallman committed
446 447
  check = value;
  if (CONSP (value)
448 449 450
      && SYMBOLP (XCAR (value)))
    type = XCAR (value),
    check = XCDR (value);
451

Richard M. Stallman's avatar
Richard M. Stallman committed
452 453 454
  if (STRINGP (check)
      || VECTORP (check)
      || SYMBOLP (check)
455
      || INTEGERP (check)
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457
      || NILP (value))
    return value;
Richard M. Stallman's avatar
Richard M. Stallman committed
458
  /* Check for a value that cons_to_long could handle.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
459
  else if (CONSP (check)
460 461
	   && INTEGERP (XCAR (check))
	   && (INTEGERP (XCDR (check))
Richard M. Stallman's avatar
Richard M. Stallman committed
462
	       ||
463 464 465
	       (CONSP (XCDR (check))
		&& INTEGERP (XCAR (XCDR (check)))
		&& NILP (XCDR (XCDR (check))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
466 467 468 469
    return value;
  else
    return
      Fsignal (Qerror,
Richard M. Stallman's avatar
Richard M. Stallman committed
470
	       Fcons (build_string ("invalid data returned by selection-conversion function"),
Richard M. Stallman's avatar
Richard M. Stallman committed
471 472 473 474 475
		      Fcons (handler_fn, Fcons (value, Qnil))));
}

/* Subroutines of x_reply_selection_request.  */

476
/* Send a SelectionNotify event to the requestor with property=None,
Richard M. Stallman's avatar
Richard M. Stallman committed
477 478 479 480 481 482 483
   meaning we were unable to do what they wanted.  */

static void
x_decline_selection_request (event)
     struct input_event *event;
{
  XSelectionEvent reply;
484
  int count;
485

Richard M. Stallman's avatar
Richard M. Stallman committed
486 487
  reply.type = SelectionNotify;
  reply.display = SELECTION_EVENT_DISPLAY (event);
488
  reply.requestor = SELECTION_EVENT_REQUESTOR (event);
Richard M. Stallman's avatar
Richard M. Stallman committed
489 490 491 492 493
  reply.selection = SELECTION_EVENT_SELECTION (event);
  reply.time = SELECTION_EVENT_TIME (event);
  reply.target = SELECTION_EVENT_TARGET (event);
  reply.property = None;

494 495
  /* The reason for the error may be that the receiver has
     died in the meantime.  Handle that case.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
496
  BLOCK_INPUT;
497 498
  count = x_catch_errors (reply.display);
  XSendEvent (reply.display, reply.requestor, False, 0L, (XEvent *) &reply);
499
  XFlush (reply.display);
500
  x_uncatch_errors (reply.display, count);
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502 503 504 505 506 507
  UNBLOCK_INPUT;
}

/* This is the selection request currently being processed.
   It is set to zero when the request is fully processed.  */
static struct input_event *x_selection_current_request;

508 509 510 511
/* Display info in x_selection_request.  */

static struct x_display_info *selection_request_dpyinfo;

Richard M. Stallman's avatar
Richard M. Stallman committed
512
/* Used as an unwind-protect clause so that, if a selection-converter signals
513
   an error, we tell the requester that we were unable to do what they wanted
Richard M. Stallman's avatar
Richard M. Stallman committed
514 515 516 517 518 519
   before we throw to top-level or go into the debugger or whatever.  */

static Lisp_Object
x_selection_request_lisp_error (ignore)
     Lisp_Object ignore;
{
520 521
  if (x_selection_current_request != 0
      && selection_request_dpyinfo->display)
Richard M. Stallman's avatar
Richard M. Stallman committed
522 523 524 525
    x_decline_selection_request (x_selection_current_request);
  return Qnil;
}

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555

/* This stuff is so that INCR selections are reentrant (that is, so we can
   be servicing multiple INCR selection requests simultaneously.)  I haven't
   actually tested that yet.  */

/* Keep a list of the property changes that are awaited.  */

struct prop_location
{
  int identifier;
  Display *display;
  Window window;
  Atom property;
  int desired_state;
  int arrived;
  struct prop_location *next;
};

static struct prop_location *expect_property_change ();
static void wait_for_property_change ();
static void unexpect_property_change ();
static int waiting_for_other_props_on_window ();

static int prop_location_identifier;

static Lisp_Object property_change_reply;

static struct prop_location *property_change_reply_object;

static struct prop_location *property_change_wait_list;
556 557 558 559 560 561 562 563 564

static Lisp_Object
queue_selection_requests_unwind (frame)
     Lisp_Object frame;
{
  FRAME_PTR f = XFRAME (frame);

  if (! NILP (frame))
    x_stop_queuing_selection_requests (FRAME_X_DISPLAY (f));
565
  return Qnil;
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
}

/* Return some frame whose display info is DPYINFO.
   Return nil if there is none.  */

static Lisp_Object
some_frame_on_display (dpyinfo)
     struct x_display_info *dpyinfo;
{
  Lisp_Object list, frame;

  FOR_EACH_FRAME (list, frame)
    {
      if (FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
	return frame;
    }

  return Qnil;
}
585

Richard M. Stallman's avatar
Richard M. Stallman committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599
/* Send the reply to a selection request event EVENT.
   TYPE is the type of selection data requested.
   DATA and SIZE describe the data to send, already converted.
   FORMAT is the unit-size (in bits) of the data to be transmitted.  */

static void
x_reply_selection_request (event, format, data, size, type)
     struct input_event *event;
     int format, size;
     unsigned char *data;
     Atom type;
{
  XSelectionEvent reply;
  Display *display = SELECTION_EVENT_DISPLAY (event);
600
  Window window = SELECTION_EVENT_REQUESTOR (event);
Richard M. Stallman's avatar
Richard M. Stallman committed
601 602 603
  int bytes_remaining;
  int format_bytes = format/8;
  int max_bytes = SELECTION_QUANTUM (display);
604
  struct x_display_info *dpyinfo = x_display_info_for_display (display);
605
  int count;
Richard M. Stallman's avatar
Richard M. Stallman committed
606 607 608 609 610 611

  if (max_bytes > MAX_SELECTION_QUANTUM)
    max_bytes = MAX_SELECTION_QUANTUM;

  reply.type = SelectionNotify;
  reply.display = display;
612
  reply.requestor = window;
Richard M. Stallman's avatar
Richard M. Stallman committed
613 614 615 616 617 618 619 620
  reply.selection = SELECTION_EVENT_SELECTION (event);
  reply.time = SELECTION_EVENT_TIME (event);
  reply.target = SELECTION_EVENT_TARGET (event);
  reply.property = SELECTION_EVENT_PROPERTY (event);
  if (reply.property == None)
    reply.property = reply.target;

  /* #### XChangeProperty can generate BadAlloc, and we must handle it! */
621
  BLOCK_INPUT;
622
  count = x_catch_errors (display);
Richard M. Stallman's avatar
Richard M. Stallman committed
623 624 625 626 627 628 629 630

  /* Store the data on the requested property.
     If the selection is large, only store the first N bytes of it.
   */
  bytes_remaining = size * format_bytes;
  if (bytes_remaining <= max_bytes)
    {
      /* Send all the data at once, with minimal handshaking.  */
631
      TRACE1 ("Sending all %d bytes", bytes_remaining);
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633 634
      XChangeProperty (display, window, reply.property, type, format,
		       PropModeReplace, data, size);
      /* At this point, the selection was successfully stored; ack it.  */
635
      XSendEvent (display, window, False, 0L, (XEvent *) &reply);
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637 638 639
    }
  else
    {
      /* Send an INCR selection.  */
640
      struct prop_location *wait_object;
641
      int had_errors;
642
      Lisp_Object frame;
Richard M. Stallman's avatar
Richard M. Stallman committed
643

644 645 646 647 648 649 650 651 652 653 654 655
      frame = some_frame_on_display (dpyinfo);

      /* If the display no longer has frames, we can't expect
	 to get many more selection requests from it, so don't
	 bother trying to queue them.  */
      if (!NILP (frame))
	{
	  x_start_queuing_selection_requests (display);

	  record_unwind_protect (queue_selection_requests_unwind,
				 frame);
	}
656

657
      if (x_window_to_frame (dpyinfo, window)) /* #### debug */
658
	error ("Attempt to transfer an INCR to ourself!");
659

660 661
      TRACE2 ("Start sending %d bytes incrementally (%s)",
	      bytes_remaining,  XGetAtomName (display, reply.property));
662 663
      wait_object = expect_property_change (display, window, reply.property,
					    PropertyDelete);
Richard M. Stallman's avatar
Richard M. Stallman committed
664

665 666
      TRACE1 ("Set %s to number of bytes to send",
	      XGetAtomName (display, reply.property));
667
      XChangeProperty (display, window, reply.property, dpyinfo->Xatom_INCR,
668 669
		       32, PropModeReplace,
		       (unsigned char *) &bytes_remaining, 1);
Richard M. Stallman's avatar
Richard M. Stallman committed
670
      XSelectInput (display, window, PropertyChangeMask);
671

Richard M. Stallman's avatar
Richard M. Stallman committed
672
      /* Tell 'em the INCR data is there...  */
673
      TRACE0 ("Send SelectionNotify event");
674
      XSendEvent (display, window, False, 0L, (XEvent *) &reply);
675
      XFlush (display);
676 677

      had_errors = x_had_errors_p (display);
678
      UNBLOCK_INPUT;
Richard M. Stallman's avatar
Richard M. Stallman committed
679

680
      /* First, wait for the requester to ack by deleting the property.
Richard M. Stallman's avatar
Richard M. Stallman committed
681
	 This can run random lisp code (process handlers) or signal.  */
682
      if (! had_errors)
683 684 685 686 687
	{
	  TRACE1 ("Waiting for ACK (deletion of %s)",
		  XGetAtomName (display, reply.property));
	  wait_for_property_change (wait_object);
	}
Richard M. Stallman's avatar
Richard M. Stallman committed
688

689
      TRACE0 ("Got ACK");
Richard M. Stallman's avatar
Richard M. Stallman committed
690 691 692 693 694
      while (bytes_remaining)
	{
	  int i = ((bytes_remaining < max_bytes)
		   ? bytes_remaining
		   : max_bytes);
695 696 697

	  BLOCK_INPUT;

698 699 700
	  wait_object
	    = expect_property_change (display, window, reply.property,
				      PropertyDelete);
701 702 703 704

	  TRACE1 ("Sending increment of %d bytes", i);
	  TRACE1 ("Set %s to increment data",
		  XGetAtomName (display, reply.property));
705

Richard M. Stallman's avatar
Richard M. Stallman committed
706 707 708 709 710
	  /* Append the next chunk of data to the property.  */
	  XChangeProperty (display, window, reply.property, type, format,
			   PropModeAppend, data, i / format_bytes);
	  bytes_remaining -= i;
	  data += i;
711
	  XFlush (display);
712
	  had_errors = x_had_errors_p (display);
713
	  UNBLOCK_INPUT;
Richard M. Stallman's avatar
Richard M. Stallman committed
714

715 716 717
	  if (had_errors)
	    break;

718
	  /* Now wait for the requester to ack this chunk by deleting the
719 720 721
	     property.	 This can run random lisp code or signal.  */
	  TRACE1 ("Waiting for increment ACK (deletion of %s)",
		  XGetAtomName (display, reply.property));
722
	  wait_for_property_change (wait_object);
Richard M. Stallman's avatar
Richard M. Stallman committed
723
	}
724

725 726
      /* Now write a zero-length chunk to the property to tell the
	 requester that we're done.  */
727
      BLOCK_INPUT;
Richard M. Stallman's avatar
Richard M. Stallman committed
728 729 730
      if (! waiting_for_other_props_on_window (display, window))
	XSelectInput (display, window, 0L);

731 732
      TRACE1 ("Set %s to a 0-length chunk to indicate EOF",
	      XGetAtomName (display, reply.property));
Richard M. Stallman's avatar
Richard M. Stallman committed
733 734
      XChangeProperty (display, window, reply.property, type, format,
		       PropModeReplace, data, 0);
735
      TRACE0 ("Done sending incrementally");
Richard M. Stallman's avatar
Richard M. Stallman committed
736
    }
737

Richard M. Stallman's avatar
Richard M. Stallman committed
738
  /* rms, 2003-01-03: I think I have fixed this bug.  */
739 740 741 742 743 744
  /* The window we're communicating with may have been deleted
     in the meantime (that's a real situation from a bug report).
     In this case, there may be events in the event queue still
     refering to the deleted window, and we'll get a BadWindow error
     in XTread_socket when processing the events.  I don't have
     an idea how to fix that.  gerd, 2001-01-98.   */
745
  XFlush (display);
746
  x_uncatch_errors (display, count);
747
  UNBLOCK_INPUT;
Richard M. Stallman's avatar
Richard M. Stallman committed
748 749 750 751 752 753 754 755 756 757
}

/* Handle a SelectionRequest event EVENT.
   This is called from keyboard.c when such an event is found in the queue.  */

void
x_handle_selection_request (event)
     struct input_event *event;
{
  struct gcpro gcpro1, gcpro2, gcpro3;
758
  Lisp_Object local_selection_data;
Richard M. Stallman's avatar
Richard M. Stallman committed
759
  Lisp_Object selection_symbol;
760 761
  Lisp_Object target_symbol;
  Lisp_Object converted_selection;
Richard M. Stallman's avatar
Richard M. Stallman committed
762
  Time local_selection_time;
763
  Lisp_Object successful_p;
Richard M. Stallman's avatar
Richard M. Stallman committed
764
  int count;
765 766
  struct x_display_info *dpyinfo
    = x_display_info_for_display (SELECTION_EVENT_DISPLAY (event));
Richard M. Stallman's avatar
Richard M. Stallman committed
767

768 769 770 771 772
  local_selection_data = Qnil;
  target_symbol = Qnil;
  converted_selection = Qnil;
  successful_p = Qnil;

Richard M. Stallman's avatar
Richard M. Stallman committed
773 774
  GCPRO3 (local_selection_data, converted_selection, target_symbol);

775
  selection_symbol = x_atom_to_symbol (SELECTION_EVENT_DISPLAY (event),
Richard M. Stallman's avatar
Richard M. Stallman committed
776 777 778 779 780 781 782 783 784 785 786 787 788
				       SELECTION_EVENT_SELECTION (event));

  local_selection_data = assq_no_quit (selection_symbol, Vselection_alist);

  if (NILP (local_selection_data))
    {
      /* Someone asked for the selection, but we don't have it any more.
       */
      x_decline_selection_request (event);
      goto DONE;
    }

  local_selection_time = (Time)
789
    cons_to_long (XCAR (XCDR (XCDR (local_selection_data))));
Richard M. Stallman's avatar
Richard M. Stallman committed
790 791

  if (SELECTION_EVENT_TIME (event) != CurrentTime
792
      && local_selection_time > SELECTION_EVENT_TIME (event))
Richard M. Stallman's avatar
Richard M. Stallman committed
793 794 795 796 797 798 799 800 801
    {
      /* Someone asked for the selection, and we have one, but not the one
	 they're looking for.
       */
      x_decline_selection_request (event);
      goto DONE;
    }

  x_selection_current_request = event;
802
  count = SPECPDL_INDEX ();
803
  selection_request_dpyinfo = dpyinfo;
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805
  record_unwind_protect (x_selection_request_lisp_error, Qnil);

806
  target_symbol = x_atom_to_symbol (SELECTION_EVENT_DISPLAY (event),
Richard M. Stallman's avatar
Richard M. Stallman committed
807 808 809 810 811 812
				    SELECTION_EVENT_TARGET (event));

#if 0 /* #### MULTIPLE doesn't work yet */
  if (EQ (target_symbol, QMULTIPLE))
    target_symbol = fetch_multiple_target (event);
#endif
813

Richard M. Stallman's avatar
Richard M. Stallman committed
814
  /* Convert lisp objects back into binary data */
815

Richard M. Stallman's avatar
Richard M. Stallman committed
816
  converted_selection
Kenichi Handa's avatar
Kenichi Handa committed
817
    = x_get_local_selection (selection_symbol, target_symbol, 0);
818

Richard M. Stallman's avatar
Richard M. Stallman committed
819 820 821 822 823 824
  if (! NILP (converted_selection))
    {
      unsigned char *data;
      unsigned int size;
      int format;
      Atom type;
825 826
      int nofree;

827 828
      lisp_data_to_selection_data (SELECTION_EVENT_DISPLAY (event),
				   converted_selection,
829
				   &data, &type, &size, &format, &nofree);
830

Richard M. Stallman's avatar
Richard M. Stallman committed
831 832 833 834
      x_reply_selection_request (event, format, data, size, type);
      successful_p = Qt;

      /* Indicate we have successfully processed this event.  */
835
      x_selection_current_request = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
836

837
      /* Use xfree, not XFree, because lisp_data_to_selection_data
838
	 calls xmalloc itself.  */
839
      if (!nofree)
840
	xfree (data);
Richard M. Stallman's avatar
Richard M. Stallman committed
841 842 843 844 845 846 847
    }
  unbind_to (count, Qnil);

 DONE:

  /* Let random lisp code notice that the selection has been asked for.  */
  {
848 849
    Lisp_Object rest;
    rest = Vx_sent_selection_hooks;
Richard M. Stallman's avatar
Richard M. Stallman committed
850 851 852 853
    if (!EQ (rest, Qunbound))
      for (; CONSP (rest); rest = Fcdr (rest))
	call3 (Fcar (rest), selection_symbol, target_symbol, successful_p);
  }
854 855

  UNGCPRO;
Richard M. Stallman's avatar
Richard M. Stallman committed
856 857
}

858
/* Handle a SelectionClear event EVENT, which indicates that some
Richard M. Stallman's avatar
Richard M. Stallman committed
859 860 861 862 863 864 865 866 867 868
   client cleared out our previously asserted selection.
   This is called from keyboard.c when such an event is found in the queue.  */

void
x_handle_selection_clear (event)
     struct input_event *event;
{
  Display *display = SELECTION_EVENT_DISPLAY (event);
  Atom selection = SELECTION_EVENT_SELECTION (event);
  Time changed_owner_time = SELECTION_EVENT_TIME (event);
869

Richard M. Stallman's avatar
Richard M. Stallman committed
870 871
  Lisp_Object selection_symbol, local_selection_data;
  Time local_selection_time;
872
  struct x_display_info *dpyinfo = x_display_info_for_display (display);
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
  struct x_display_info *t_dpyinfo;

  /* If the new selection owner is also Emacs,
     don't clear the new selection.  */
  BLOCK_INPUT;
  /* Check each display on the same terminal,
     to see if this Emacs job now owns the selection
     through that display.  */
  for (t_dpyinfo = x_display_list; t_dpyinfo; t_dpyinfo = t_dpyinfo->next)
    if (t_dpyinfo->kboard == dpyinfo->kboard)
      {
	Window owner_window
	  = XGetSelectionOwner (t_dpyinfo->display, selection);
	if (x_window_to_frame (t_dpyinfo, owner_window) != 0)
	  {
	    UNBLOCK_INPUT;
	    return;
	  }
      }
  UNBLOCK_INPUT;
Richard M. Stallman's avatar
Richard M. Stallman committed
893

894
  selection_symbol = x_atom_to_symbol (display, selection);
Richard M. Stallman's avatar
Richard M. Stallman committed
895 896 897 898 899 900 901

  local_selection_data = assq_no_quit (selection_symbol, Vselection_alist);

  /* Well, we already believe that we don't own it, so that's just fine.  */
  if (NILP (local_selection_data)) return;

  local_selection_time = (Time)
902
    cons_to_long (XCAR (XCDR (XCDR (local_selection_data))));
Richard M. Stallman's avatar
Richard M. Stallman committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920

  /* This SelectionClear is for a selection that we no longer own, so we can
     disregard it.  (That is, we have reasserted the selection since this
     request was generated.)  */

  if (changed_owner_time != CurrentTime
      && local_selection_time > changed_owner_time)
    return;

  /* Otherwise, we're really honest and truly being told to drop it.
     Don't use Fdelq as that may QUIT;.  */

  if (EQ (local_selection_data, Fcar (Vselection_alist)))
    Vselection_alist = Fcdr (Vselection_alist);
  else
    {
      Lisp_Object rest;
      for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
921
	if (EQ (local_selection_data, Fcar (XCDR (rest))))
Richard M. Stallman's avatar
Richard M. Stallman committed
922
	  {
923
	    XSETCDR (rest, Fcdr (XCDR (rest)));
Richard M. Stallman's avatar
Richard M. Stallman committed
924 925 926 927 928 929 930
	    break;
	  }
    }

  /* Let random lisp code notice that the selection has been stolen.  */

  {
931 932
    Lisp_Object rest;
    rest = Vx_lost_selection_hooks;
Richard M. Stallman's avatar
Richard M. Stallman committed
933
    if (!EQ (rest, Qunbound))
934 935 936
      {
	for (; CONSP (rest); rest = Fcdr (rest))
	  call1 (Fcar (rest), selection_symbol);
937
	prepare_menu_bars ();
938
	redisplay_preserve_echo_area (20);
939
      }
Richard M. Stallman's avatar
Richard M. Stallman committed
940 941 942
  }
}

943 944 945 946 947 948 949 950 951 952
/* Clear all selections that were made from frame F.
   We do this when about to delete a frame.  */

void
x_clear_frame_selections (f)
     FRAME_PTR f;
{
  Lisp_Object frame;
  Lisp_Object rest;

953
  XSETFRAME (frame, f);
954 955 956 957

  /* Otherwise, we're really honest and truly being told to drop it.
     Don't use Fdelq as that may QUIT;.  */

958 959 960 961 962 963 964 965 966 967 968 969 970 971
  /* Delete elements from the beginning of Vselection_alist.  */
  while (!NILP (Vselection_alist)
	 && EQ (frame, Fcar (Fcdr (Fcdr (Fcdr (Fcar (Vselection_alist)))))))
    {
      /* Let random Lisp code notice that the selection has been stolen.  */
      Lisp_Object hooks, selection_symbol;

      hooks = Vx_lost_selection_hooks;
      selection_symbol = Fcar (Fcar (Vselection_alist));

      if (!EQ (hooks, Qunbound))
	{
	  for (; CONSP (hooks); hooks = Fcdr (hooks))
	    call1 (Fcar (hooks), selection_symbol);
972 973 974
#if 0 /* This can crash when deleting a frame
	 from x_connection_closed.  Anyway, it seems unnecessary;
	 something else should cause a redisplay.  */
975
	  redisplay_preserve_echo_area (21);
976
#endif
977 978 979 980 981 982
	}

      Vselection_alist = Fcdr (Vselection_alist);
    }

  /* Delete elements after the beginning of Vselection_alist.  */
983
  for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
984
    if (EQ (frame, Fcar (Fcdr (Fcdr (Fcdr (Fcar (XCDR (rest))))))))
985 986 987 988 989
      {
	/* Let random Lisp code notice that the selection has been stolen.  */
	Lisp_Object hooks, selection_symbol;

	hooks = Vx_lost_selection_hooks;
990
	selection_symbol = Fcar (Fcar (XCDR (rest)));
991 992 993 994 995

	if (!EQ (hooks, Qunbound))
	  {
	    for (; CONSP (hooks); hooks = Fcdr (hooks))
	      call1 (Fcar (hooks), selection_symbol);
996
#if 0 /* See above */
997
	    redisplay_preserve_echo_area (22);
998
#endif
999
	  }
1000
	XSETCDR (rest, Fcdr (XCDR (rest)));
1001 1002 1003
	break;
      }
}
Richard M. Stallman's avatar
Richard M. Stallman committed
1004 1005