414
+ − 1 /* Generic selection processing for XEmacs
+ − 2 Copyright (C) 1999 Free Software Foundation, Inc.
+ − 3 Copyright (C) 1999 Andy Piper.
+ − 4
+ − 5 This file is part of XEmacs.
+ − 6
+ − 7 XEmacs is free software; you can redistribute it and/or modify it
+ − 8 under the terms of the GNU General Public License as published by the
+ − 9 Free Software Foundation; either version 2, or (at your option) any
+ − 10 later version.
+ − 11
+ − 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
+ − 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ − 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ − 15 for more details.
+ − 16
+ − 17 You should have received a copy of the GNU General Public License
+ − 18 along with XEmacs; see the file COPYING. If not, write to
+ − 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ − 20 Boston, MA 02111-1307, USA. */
+ − 21
+ − 22 /* Synched up with: Not synched with FSF. */
+ − 23
+ − 24 #include <config.h>
+ − 25 #include "lisp.h"
+ − 26
+ − 27 #include "buffer.h"
872
+ − 28 #include "device-impl.h"
442
+ − 29 #include "extents.h"
414
+ − 30 #include "console.h"
+ − 31 #include "objects.h"
+ − 32
+ − 33 #include "frame.h"
+ − 34 #include "opaque.h"
+ − 35 #include "select.h"
+ − 36
442
+ − 37 /* X Atoms */
414
+ − 38 Lisp_Object QPRIMARY, QSECONDARY, QSTRING, QINTEGER, QCLIPBOARD, QTIMESTAMP,
+ − 39 QTEXT, QDELETE, QMULTIPLE, QINCR, QEMACS_TMP, QTARGETS, QATOM, QNULL,
+ − 40 QATOM_PAIR, QCOMPOUND_TEXT;
+ − 41
442
+ − 42 /* Windows clipboard formats */
+ − 43 Lisp_Object QCF_TEXT, QCF_BITMAP, QCF_METAFILEPICT, QCF_SYLK, QCF_DIF,
+ − 44 QCF_TIFF, QCF_OEMTEXT, QCF_DIB, QCF_DIBV5, QCF_PALETTE, QCF_PENDATA,
+ − 45 QCF_RIFF, QCF_WAVE, QCF_UNICODETEXT, QCF_ENHMETAFILE, QCF_HDROP, QCF_LOCALE,
+ − 46 QCF_OWNERDISPLAY, QCF_DSPTEXT, QCF_DSPBITMAP, QCF_DSPMETAFILEPICT,
+ − 47 QCF_DSPENHMETAFILE;
+ − 48
+ − 49 /* Selection strategy symbols */
+ − 50 Lisp_Object Qreplace_all, Qreplace_existing;
+ − 51
414
+ − 52 /* "Selection owner couldn't convert selection" */
+ − 53 Lisp_Object Qselection_conversion_error;
+ − 54
442
+ − 55 /* A couple of Lisp functions */
+ − 56 Lisp_Object Qselect_convert_in, Qselect_convert_out, Qselect_coerce;
+ − 57
+ − 58 /* These are alists whose CARs are selection-types (whose names are the same
+ − 59 as the names of X Atoms or Windows clipboard formats) and whose CDRs are
+ − 60 the names of Lisp functions to call to convert the given Emacs selection
+ − 61 value to a string representing the given selection type. This is for
+ − 62 elisp-level extension of the emacs selection handling.
414
+ − 63 */
442
+ − 64 Lisp_Object Vselection_converter_out_alist;
+ − 65 Lisp_Object Vselection_converter_in_alist;
+ − 66 Lisp_Object Vselection_coercion_alist;
+ − 67 Lisp_Object Vselection_appender_alist;
+ − 68 Lisp_Object Vselection_buffer_killed_alist;
+ − 69 Lisp_Object Vselection_coercible_types;
414
+ − 70
+ − 71 Lisp_Object Vlost_selection_hooks;
+ − 72
+ − 73 /* This is an association list whose elements are of the form
+ − 74 ( selection-name selection-value selection-timestamp )
+ − 75 selection-name is a lisp symbol, whose name is the name of an X Atom.
442
+ − 76 selection-value is a list of cons pairs that emacs owns for that selection.
+ − 77 Each pair consists of (type . value), where type is nil or a
+ − 78 selection data type, and value is any type of Lisp object.
414
+ − 79 selection-timestamp is the time at which emacs began owning this selection,
+ − 80 as a cons of two 16-bit numbers (making a 32 bit time).
+ − 81 If there is an entry in this alist, then it can be assumed that emacs owns
+ − 82 that selection.
+ − 83 The only (eq) parts of this list that are visible from elisp are the
+ − 84 selection-values.
+ − 85 */
+ − 86 Lisp_Object Vselection_alist;
+ − 87
442
+ − 88 /* Given a selection-name and desired type, this looks up our local copy of
+ − 89 the selection value and converts it to the type. */
414
+ − 90 static Lisp_Object
+ − 91 get_local_selection (Lisp_Object selection_symbol, Lisp_Object target_type)
+ − 92 {
+ − 93 Lisp_Object local_value = assq_no_quit (selection_symbol, Vselection_alist);
+ − 94
442
+ − 95 if (!NILP (local_value))
+ − 96 {
+ − 97 Lisp_Object value_list = XCAR (XCDR (local_value));
+ − 98 Lisp_Object value;
414
+ − 99
442
+ − 100 /* First try to find an entry of the appropriate type */
+ − 101 value = assq_no_quit (target_type, value_list);
+ − 102
+ − 103 if (!NILP (value))
+ − 104 return XCDR (value);
414
+ − 105 }
+ − 106
442
+ − 107 return Qnil;
414
+ − 108 }
+ − 109
442
+ − 110 /* #### Should perhaps handle 'MULTIPLE. The code below is now completely
+ − 111 broken due to a re-organization of get_local_selection, but I've left
+ − 112 it here should anyone show an interest - ajh */
+ − 113 #if 0
+ − 114 else if (CONSP (target_type) &&
+ − 115 XCAR (target_type) == QMULTIPLE)
+ − 116 {
+ − 117 Lisp_Object pairs = XCDR (target_type);
+ − 118 int len = XVECTOR_LENGTH (pairs);
+ − 119 int i;
+ − 120 /* If the target is MULTIPLE, then target_type looks like
+ − 121 (MULTIPLE . [[SELECTION1 TARGET1] [SELECTION2 TARGET2] ... ])
+ − 122 We modify the second element of each pair in the vector and
+ − 123 return it as [[SELECTION1 <value1>] [SELECTION2 <value2>] ... ]
+ − 124 */
+ − 125 for (i = 0; i < len; i++)
+ − 126 {
+ − 127 Lisp_Object pair = XVECTOR_DATA (pairs) [i];
+ − 128 XVECTOR_DATA (pair) [1] =
+ − 129 x_get_local_selection (XVECTOR_DATA (pair) [0],
+ − 130 XVECTOR_DATA (pair) [1]);
+ − 131 }
+ − 132 return pairs;
+ − 133 }
+ − 134 #endif
+ − 135
+ − 136 DEFUN ("own-selection-internal", Fown_selection_internal, 2, 5, 0, /*
444
+ − 137 Give the selection SELECTION-NAME the value SELECTION-VALUE.
+ − 138 SELECTION-NAME is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD.
+ − 139 SELECTION-VALUE is typically a string, or a cons of two markers, but may be
442
+ − 140 anything that the functions on selection-converter-out-alist know about.
444
+ − 141 Optional arg HOW-TO-ADD specifies how the selection will be combined
843
+ − 142 with any existing selection(s) - see `own-selection' for more
+ − 143 information.
444
+ − 144 Optional arg DATA-TYPE is a window-system-specific type.
+ − 145 Optional arg DEVICE specifies the device on which to assert the selection.
+ − 146 It defaults to the selected device.
414
+ − 147 */
442
+ − 148 (selection_name, selection_value, how_to_add, data_type, device))
414
+ − 149 {
442
+ − 150 Lisp_Object selection_time, selection_data, prev_value = Qnil,
+ − 151 value_list = Qnil;
+ − 152 Lisp_Object prev_real_value = Qnil;
440
+ − 153 struct gcpro gcpro1;
458
+ − 154 int owned_p = 0;
414
+ − 155
+ − 156 CHECK_SYMBOL (selection_name);
563
+ − 157 if (NILP (selection_value))
+ − 158 invalid_argument ("`selection-value' may not be nil", Qunbound);
414
+ − 159
+ − 160 if (NILP (device))
+ − 161 device = Fselected_device (Qnil);
+ − 162
442
+ − 163 if (!EQ (how_to_add, Qappend) && !EQ (how_to_add, Qt)
+ − 164 && !EQ (how_to_add, Qreplace_existing)
+ − 165 && !EQ (how_to_add, Qreplace_all) && !NILP (how_to_add))
563
+ − 166 invalid_constant ("`how-to-add' must be nil, append, replace_all, "
+ − 167 "replace_existing or t", how_to_add);
442
+ − 168
+ − 169 #ifdef MULE
+ − 170 if (NILP (data_type))
+ − 171 data_type = QCOMPOUND_TEXT;
+ − 172 #else
+ − 173 if (NILP (data_type))
+ − 174 data_type = QSTRING;
+ − 175 #endif
+ − 176
+ − 177 /* Examine the how-to-add argument */
+ − 178 if (EQ (how_to_add, Qreplace_all) || NILP (how_to_add))
+ − 179 {
+ − 180 Lisp_Object local_selection_data = assq_no_quit (selection_name,
+ − 181 Vselection_alist);
+ − 182
+ − 183 if (!NILP (local_selection_data))
+ − 184 {
458
+ − 185 owned_p = 1;
442
+ − 186 /* Don't use Fdelq() as that may QUIT;. */
+ − 187 if (EQ (local_selection_data, Fcar (Vselection_alist)))
+ − 188 Vselection_alist = Fcdr (Vselection_alist);
+ − 189 else
+ − 190 {
+ − 191 Lisp_Object rest;
+ − 192 for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
+ − 193 if (EQ (local_selection_data, Fcar (XCDR (rest))))
+ − 194 {
+ − 195 XCDR (rest) = Fcdr (XCDR (rest));
+ − 196 break;
+ − 197 }
+ − 198 }
+ − 199 }
+ − 200 }
+ − 201 else
+ − 202 {
+ − 203 /* Look for a previous value */
+ − 204 prev_value = assq_no_quit (selection_name, Vselection_alist);
+ − 205
+ − 206 if (!NILP (prev_value))
458
+ − 207 {
+ − 208 owned_p = 1;
+ − 209 value_list = XCAR (XCDR (prev_value));
+ − 210 }
440
+ − 211
442
+ − 212 if (!NILP (value_list))
+ − 213 prev_real_value = assq_no_quit (data_type, value_list);
+ − 214 }
+ − 215
+ − 216 /* Append values if necessary */
+ − 217 if (!NILP (value_list) && (EQ (how_to_add, Qappend) || EQ (how_to_add, Qt)))
414
+ − 218 {
442
+ − 219 /* Did we have anything of this type previously? */
+ − 220 if (!NILP (prev_real_value))
+ − 221 {
+ − 222 if ((NILP (data_type) && STRINGP (selection_value)
+ − 223 && STRINGP (XCDR (prev_real_value)))
+ − 224 || !NILP (data_type))
+ − 225 {
+ − 226 Lisp_Object function = assq_no_quit (data_type,
+ − 227 Vselection_appender_alist);
+ − 228
+ − 229 if (NILP (function))
563
+ − 230 signal_error (Qinvalid_argument,
+ − 231 "Cannot append selections of supplied types (no function)",
+ − 232 data_type);
442
+ − 233
+ − 234 function = XCDR (function);
+ − 235
+ − 236 selection_value = call4 (function,
+ − 237 selection_name,
+ − 238 data_type,
+ − 239 XCDR (prev_real_value),
+ − 240 selection_value);
+ − 241
+ − 242 if (NILP (selection_value))
563
+ − 243 signal_error (Qinvalid_argument,
+ − 244 "Cannot append selections of supplied types (function returned nil)",
+ − 245 data_type);
442
+ − 246 }
+ − 247 else
563
+ − 248 signal_error_2 (Qinvalid_argument, "Cannot append selections of supplied types (data type nil and both values not strings)",
+ − 249 XCDR (prev_real_value),
+ − 250 selection_value);
442
+ − 251 }
+ − 252
+ − 253 selection_data = Fcons (data_type, selection_value);
+ − 254 value_list = Fcons (selection_data, value_list);
+ − 255 }
+ − 256
+ − 257 if (!NILP (prev_real_value))
+ − 258 {
+ − 259 Lisp_Object rest; /* We know it isn't the CAR, so it's easy. */
+ − 260
+ − 261 /* Delete the old type entry from the list */
+ − 262 for (rest = value_list; !NILP (rest); rest = Fcdr (rest))
+ − 263 if (EQ (prev_real_value, Fcar (XCDR (rest))))
414
+ − 264 {
+ − 265 XCDR (rest) = Fcdr (XCDR (rest));
+ − 266 break;
+ − 267 }
+ − 268 }
442
+ − 269 else
+ − 270 {
+ − 271 value_list = Fcons (Fcons (data_type, selection_value),
+ − 272 value_list);
+ − 273 }
414
+ − 274
442
+ − 275 /* Complete the local cache update; note that we destructively
+ − 276 modify the current list entry if there is one */
+ − 277 if (NILP (prev_value))
+ − 278 {
+ − 279 selection_data = list3 (selection_name, value_list, Qnil);
+ − 280 Vselection_alist = Fcons (selection_data, Vselection_alist);
+ − 281 }
+ − 282 else
+ − 283 {
+ − 284 selection_data = prev_value;
+ − 285 Fsetcar (XCDR (selection_data), value_list);
+ − 286 }
+ − 287
+ − 288 GCPRO1 (selection_data);
+ − 289
+ − 290 /* have to do device specific stuff last so that methods can access the
414
+ − 291 selection_alist */
+ − 292 if (HAS_DEVMETH_P (XDEVICE (device), own_selection))
+ − 293 selection_time = DEVMETH (XDEVICE (device), own_selection,
442
+ − 294 (selection_name, selection_value,
458
+ − 295 how_to_add, data_type, owned_p));
414
+ − 296 else
+ − 297 selection_time = Qnil;
+ − 298
+ − 299 Fsetcar (XCDR (XCDR (selection_data)), selection_time);
+ − 300
440
+ − 301 UNGCPRO;
+ − 302
414
+ − 303 return selection_value;
+ − 304 }
+ − 305
442
+ − 306 DEFUN ("register-selection-data-type", Fregister_selection_data_type, 1,2,0, /*
+ − 307 Register a new selection data type DATA-TYPE, optionally on the specified
+ − 308 DEVICE. Returns the device-specific data type identifier, or nil if the
+ − 309 device does not support this feature or the registration fails. */
+ − 310 (data_type, device))
+ − 311 {
+ − 312 /* Check arguments */
+ − 313 CHECK_STRING (data_type);
+ − 314
+ − 315 if (NILP (device))
+ − 316 device = Fselected_device (Qnil);
+ − 317
+ − 318 if (HAS_DEVMETH_P (XDEVICE (device), register_selection_data_type))
+ − 319 return DEVMETH (XDEVICE (device), register_selection_data_type,
+ − 320 (data_type));
+ − 321 else
+ − 322 return Qnil;
+ − 323 }
+ − 324
+ − 325 DEFUN ("selection-data-type-name", Fselection_data_type_name, 1, 2, 0, /*
+ − 326 Retrieve the name of the specified selection data type DATA-TYPE, optionally
+ − 327 on the specified DEVICE. Returns either a string or a symbol on success, and
+ − 328 nil if the device does not support this feature or the type is not known. */
+ − 329 (data_type, device))
+ − 330 {
+ − 331 if (NILP (device))
+ − 332 device = Fselected_device (Qnil);
+ − 333
+ − 334 if (HAS_DEVMETH_P (XDEVICE (device), selection_data_type_name))
+ − 335 return DEVMETH (XDEVICE (device), selection_data_type_name, (data_type));
+ − 336 else
+ − 337 return Qnil;
+ − 338 }
+ − 339
+ − 340 DEFUN ("available-selection-types", Favailable_selection_types, 1, 2, 0, /*
+ − 341 Retrieve a list of currently available types of selection associated with
+ − 342 the given SELECTION-NAME, optionally on the specified DEVICE. This list
+ − 343 does not take into account any possible conversions that might take place,
+ − 344 so it should be taken as a minimal estimate of what is available.
+ − 345 */
+ − 346 (selection_name, device))
+ − 347 {
+ − 348 Lisp_Object types = Qnil, rest;
+ − 349 struct gcpro gcpro1;
+ − 350
+ − 351 CHECK_SYMBOL (selection_name);
+ − 352
+ − 353 if (NILP (device))
+ − 354 device = Fselected_device (Qnil);
+ − 355
+ − 356 GCPRO1 (types);
+ − 357
+ − 358 /* First check the device */
+ − 359 if (HAS_DEVMETH_P (XDEVICE (device), available_selection_types))
+ − 360 types = DEVMETH (XDEVICE (device), available_selection_types,
+ − 361 (selection_name));
+ − 362
+ − 363 /* Now look in the list */
+ − 364 rest = assq_no_quit (selection_name, Vselection_alist);
+ − 365
+ − 366 if (NILP (rest))
+ − 367 {
+ − 368 UNGCPRO;
+ − 369
+ − 370 return types;
+ − 371 }
+ − 372
+ − 373 /* Examine the types and cons them onto the front of the list */
+ − 374 for (rest = XCAR (XCDR (rest)); !NILP (rest); rest = XCDR (rest))
+ − 375 {
+ − 376 Lisp_Object value = XCDR (XCAR (rest));
+ − 377 Lisp_Object type = XCAR (XCAR (rest));
+ − 378
+ − 379 types = Fcons (type, types);
+ − 380
+ − 381 if ((STRINGP (value) || EXTENTP (value))
+ − 382 && (NILP (type) || EQ (type, QSTRING)
+ − 383 || EQ (type, QTEXT) || EQ (type, QCOMPOUND_TEXT)))
+ − 384 types = Fcons (QTEXT, Fcons (QCOMPOUND_TEXT, Fcons (QSTRING, types)));
+ − 385 else if (INTP (value) && NILP (type))
+ − 386 types = Fcons (QINTEGER, types);
+ − 387 else if (SYMBOLP (value) && NILP (type))
+ − 388 types = Fcons (QATOM, types);
+ − 389 }
+ − 390
+ − 391 UNGCPRO;
+ − 392
+ − 393 return types;
+ − 394 }
+ − 395
414
+ − 396 /* remove a selection from our local copy
+ − 397 */
+ − 398 void
+ − 399 handle_selection_clear (Lisp_Object selection_symbol)
+ − 400 {
442
+ − 401 Lisp_Object local_selection_data = assq_no_quit (selection_symbol,
+ − 402 Vselection_alist);
414
+ − 403
+ − 404 /* Well, we already believe that we don't own it, so that's just fine. */
+ − 405 if (NILP (local_selection_data)) return;
+ − 406
+ − 407 /* Otherwise, we're really honest and truly being told to drop it.
+ − 408 Don't use Fdelq() as that may QUIT;.
+ − 409 */
+ − 410 if (EQ (local_selection_data, Fcar (Vselection_alist)))
+ − 411 Vselection_alist = Fcdr (Vselection_alist);
+ − 412 else
+ − 413 {
+ − 414 Lisp_Object rest;
+ − 415 for (rest = Vselection_alist; !NILP (rest); rest = Fcdr (rest))
+ − 416 if (EQ (local_selection_data, Fcar (XCDR (rest))))
+ − 417 {
+ − 418 XCDR (rest) = Fcdr (XCDR (rest));
+ − 419 break;
+ − 420 }
+ − 421 }
+ − 422
+ − 423 /* Let random lisp code notice that the selection has been stolen.
+ − 424 */
+ − 425 {
+ − 426 Lisp_Object rest;
+ − 427 Lisp_Object val = Vlost_selection_hooks;
+ − 428 if (!UNBOUNDP (val) && !NILP (val))
+ − 429 {
+ − 430 if (CONSP (val) && !EQ (XCAR (val), Qlambda))
+ − 431 for (rest = val; !NILP (rest); rest = Fcdr (rest))
+ − 432 call1 (Fcar (rest), selection_symbol);
+ − 433 else
+ − 434 call1 (val, selection_symbol);
+ − 435 }
+ − 436 }
+ − 437 }
+ − 438
+ − 439 DEFUN ("disown-selection-internal", Fdisown_selection_internal, 1, 3, 0, /*
+ − 440 If we own the named selection, then disown it (make there be no selection).
+ − 441 */
+ − 442 (selection_name, selection_time, device))
+ − 443 {
+ − 444 if (NILP (assq_no_quit (selection_name, Vselection_alist)))
+ − 445 return Qnil; /* Don't disown the selection when we're not the owner. */
+ − 446
+ − 447 if (NILP (device))
+ − 448 device = Fselected_device (Qnil);
+ − 449
+ − 450 MAYBE_DEVMETH (XDEVICE (device), disown_selection,
+ − 451 (selection_name, selection_time));
442
+ − 452
414
+ − 453 handle_selection_clear (selection_name);
+ − 454
+ − 455 return Qt;
+ − 456 }
+ − 457
+ − 458 DEFUN ("selection-owner-p", Fselection_owner_p, 0, 1, 0, /*
444
+ − 459 Return t if the current emacs process owns SELECTION.
+ − 460 SELECTION should be the name of the selection in question, typically one of
414
+ − 461 the symbols PRIMARY, SECONDARY, or CLIPBOARD. (For convenience, the symbol
+ − 462 nil is the same as PRIMARY, and t is the same as SECONDARY.)
+ − 463 */
+ − 464 (selection))
+ − 465 {
+ − 466 CHECK_SYMBOL (selection);
+ − 467 if (EQ (selection, Qnil)) selection = QPRIMARY;
+ − 468 else if (EQ (selection, Qt)) selection = QSECONDARY;
+ − 469
+ − 470 return NILP (Fassq (selection, Vselection_alist)) ? Qnil : Qt;
+ − 471 }
+ − 472
442
+ − 473 DEFUN ("selection-exists-p", Fselection_exists_p, 0, 3, 0, /*
444
+ − 474 Whether there is currently an owner for SELECTION.
+ − 475 SELECTION should be the name of the selection in question, typically one of
414
+ − 476 the symbols PRIMARY, SECONDARY, or CLIPBOARD. (For convenience, the symbol
+ − 477 nil is the same as PRIMARY, and t is the same as SECONDARY.)
444
+ − 478 Optionally, the window-system DATA-TYPE and the DEVICE may be specified.
414
+ − 479 */
442
+ − 480 (selection, data_type, device))
414
+ − 481 {
+ − 482 CHECK_SYMBOL (selection);
442
+ − 483 if (NILP (data_type)
+ − 484 && !NILP (Fselection_owner_p (selection)))
414
+ − 485 return Qt;
+ − 486
+ − 487 if (NILP (device))
+ − 488 device = Fselected_device (Qnil);
+ − 489
+ − 490 return HAS_DEVMETH_P (XDEVICE (device), selection_exists_p) ?
442
+ − 491 DEVMETH (XDEVICE (device), selection_exists_p, (selection, data_type))
414
+ − 492 : Qnil;
+ − 493 }
+ − 494
442
+ − 495 /* Get the timestamp of the given selection */
+ − 496 DEFUN ("get-selection-timestamp", Fget_selection_timestamp, 1, 1, 0, /*
+ − 497 Return the timestamp associated with the specified SELECTION, if it exists.
+ − 498 Note that the timestamp is a device-specific object, and may not actually be
+ − 499 visible from Lisp.
+ − 500 */
+ − 501 (selection))
+ − 502 {
+ − 503 Lisp_Object local_value = assq_no_quit (selection, Vselection_alist);
+ − 504
+ − 505 if (!NILP (local_value))
+ − 506 return XCAR (XCDR (XCDR (local_value)));
+ − 507
+ − 508 return Qnil;
+ − 509 }
+ − 510
414
+ − 511 /* Request the selection value from the owner. If we are the owner,
843
+ − 512 simply return our selection value. If we are not the owner, this
+ − 513 will block until all of the data has arrived.
414
+ − 514 */
+ − 515 DEFUN ("get-selection-internal", Fget_selection_internal, 2, 3, 0, /*
+ − 516 Return text selected from some window-system window.
444
+ − 517 SELECTION is a symbol, typically PRIMARY, SECONDARY, or CLIPBOARD.
+ − 518 TARGET-TYPE is the type of data desired, typically STRING or COMPOUND_TEXT.
414
+ − 519 Under Mule, if the resultant data comes back as 8-bit data in type
+ − 520 TEXT or COMPOUND_TEXT, it will be decoded as Compound Text.
+ − 521 */
444
+ − 522 (selection, target_type, device))
414
+ − 523 {
+ − 524 /* This function can GC */
+ − 525 Lisp_Object val = Qnil;
+ − 526 struct gcpro gcpro1, gcpro2;
442
+ − 527 GCPRO2 (target_type, val);
444
+ − 528 CHECK_SYMBOL (selection);
414
+ − 529
+ − 530 if (NILP (device))
+ − 531 device = Fselected_device (Qnil);
+ − 532
442
+ − 533 #ifdef MULE
+ − 534 if (NILP (target_type))
+ − 535 target_type = QCOMPOUND_TEXT;
+ − 536 #else
+ − 537 if (NILP (target_type))
+ − 538 target_type = QSTRING;
+ − 539 #endif
+ − 540
414
+ − 541 #if 0 /* #### MULTIPLE doesn't work yet and probably never will */
+ − 542 if (CONSP (target_type) &&
+ − 543 XCAR (target_type) == QMULTIPLE)
+ − 544 {
+ − 545 CHECK_VECTOR (XCDR (target_type));
+ − 546 /* So we don't destructively modify this... */
+ − 547 target_type = copy_multiple_data (target_type);
+ − 548 }
+ − 549 #endif
442
+ − 550
+ − 551 /* Used to check that target_type was a symbol. This is no longer
+ − 552 necessarily the case, because the type might be registered with
+ − 553 the device (in which case target_type would be a device-specific
+ − 554 identifier - probably an integer) - ajh */
414
+ − 555
444
+ − 556 val = get_local_selection (selection, target_type);
414
+ − 557
442
+ − 558 if (!NILP (val))
414
+ − 559 {
442
+ − 560 /* If we get something from the local cache, we may need to convert
+ − 561 it slightly - to do this, we call select-coerce */
843
+ − 562 val = call3 (Qselect_coerce, selection, target_type, val);
442
+ − 563 }
+ − 564 else if (HAS_DEVMETH_P (XDEVICE (device), get_foreign_selection))
+ − 565 {
+ − 566 /* Nothing in the local cache; try the window system */
414
+ − 567 val = DEVMETH (XDEVICE (device), get_foreign_selection,
444
+ − 568 (selection, target_type));
414
+ − 569 }
442
+ − 570
+ − 571 if (NILP (val))
414
+ − 572 {
442
+ − 573 /* Still nothing. Try coercion. */
+ − 574
+ − 575 /* Try looking in selection-coercible-types to see if any of
+ − 576 them are present for this selection. We try them *in order*;
+ − 577 the first for which a conversion succeeds gets returned. */
+ − 578 EXTERNAL_LIST_LOOP_2 (element, Vselection_coercible_types)
414
+ − 579 {
444
+ − 580 val = get_local_selection (selection, element);
442
+ − 581
+ − 582 if (NILP (val))
+ − 583 continue;
+ − 584
444
+ − 585 val = call3 (Qselect_coerce, selection, target_type, val);
442
+ − 586
+ − 587 if (!NILP (val))
+ − 588 break;
414
+ − 589 }
+ − 590 }
442
+ − 591
+ − 592 /* Used to call clean_local_selection here... but that really belonged
+ − 593 in Lisp (so the equivalent is now built-in to the INTEGER conversion
+ − 594 function select-convert-from-integer) - ajh */
+ − 595
414
+ − 596 UNGCPRO;
+ − 597 return val;
+ − 598 }
+ − 599
442
+ − 600 /* These are convenient interfaces to the lisp code in select.el;
+ − 601 this way we can rename them easily rather than having to hunt everywhere.
+ − 602 Also, this gives us access to get_local_selection so that convert_out
+ − 603 can retrieve the internal selection value automatically if passed a
+ − 604 value of Qnil. */
+ − 605 Lisp_Object
+ − 606 select_convert_in (Lisp_Object selection,
+ − 607 Lisp_Object type,
+ − 608 Lisp_Object value)
+ − 609 {
+ − 610 return call3 (Qselect_convert_in, selection, type, value);
+ − 611 }
+ − 612
+ − 613 Lisp_Object
+ − 614 select_coerce (Lisp_Object selection,
+ − 615 Lisp_Object type,
+ − 616 Lisp_Object value)
+ − 617 {
+ − 618 return call3 (Qselect_coerce, selection, type, value);
+ − 619 }
+ − 620
+ − 621 Lisp_Object
+ − 622 select_convert_out (Lisp_Object selection,
+ − 623 Lisp_Object type,
+ − 624 Lisp_Object value)
+ − 625 {
+ − 626 if (NILP (value))
+ − 627 value = get_local_selection (selection, type);
+ − 628
+ − 629 if (NILP (value))
+ − 630 {
+ − 631 /* Try looking in selection-coercible-types to see if any of
+ − 632 them are present for this selection. We try them *in order*;
+ − 633 the first for which a conversion succeeds gets returned. */
+ − 634 EXTERNAL_LIST_LOOP_2 (element, Vselection_coercible_types)
+ − 635 {
+ − 636 Lisp_Object ret;
+ − 637
+ − 638 value = get_local_selection (selection, element);
+ − 639
+ − 640 if (NILP (value))
+ − 641 continue;
+ − 642
+ − 643 ret = call3 (Qselect_convert_out, selection, type, value);
+ − 644
+ − 645 if (!NILP (ret))
+ − 646 return ret;
+ − 647 }
+ − 648
+ − 649 return Qnil;
+ − 650 }
+ − 651
+ − 652 return call3 (Qselect_convert_out, selection, type, value);
+ − 653 }
+ − 654
+ − 655
+ − 656 /* Gets called from kill-buffer; this lets us dispose of buffer-dependent
+ − 657 selections (or alternatively make them independent of the buffer) when
+ − 658 it gets vaped. */
+ − 659 void
+ − 660 select_notify_buffer_kill (Lisp_Object buffer)
+ − 661 {
+ − 662 Lisp_Object rest;
+ − 663 struct gcpro gcpro1, gcpro2, gcpro3;
+ − 664
+ − 665 /* For each element of Vselection_alist */
+ − 666 for (rest = Vselection_alist;
+ − 667 !NILP (rest);)
+ − 668 {
+ − 669 Lisp_Object selection, values, prev = Qnil;
+ − 670
+ − 671 selection = XCAR (rest);
+ − 672
+ − 673 for (values = XCAR (XCDR (selection));
+ − 674 !NILP (values);
+ − 675 values = XCDR (values))
+ − 676 {
+ − 677 Lisp_Object value, handler_fn;
+ − 678
+ − 679 /* Extract the (type . value) pair. */
+ − 680 value = XCAR (values);
+ − 681
+ − 682 /* Find the handler function (if any). */
+ − 683 handler_fn = Fcdr (Fassq (XCAR (value),
+ − 684 Vselection_buffer_killed_alist));
+ − 685
+ − 686 if (!NILP (handler_fn))
+ − 687 {
+ − 688 Lisp_Object newval;
+ − 689
+ − 690 /* Protect ourselves, just in case some tomfool calls
+ − 691 own-selection from with the buffer-killed handler, then
+ − 692 causes a GC. Just as a note, *don't do this*. */
+ − 693 GCPRO3 (rest, values, value);
+ − 694
+ − 695 newval = call4 (handler_fn, XCAR (selection), XCAR (value),
+ − 696 XCDR (value), buffer);
+ − 697
+ − 698 UNGCPRO;
+ − 699
+ − 700 /* Set or delete the value (by destructively modifying
+ − 701 the list). */
+ − 702 if (!NILP (newval))
+ − 703 {
+ − 704 Fsetcdr (value, newval);
+ − 705
+ − 706 prev = values;
+ − 707 }
+ − 708 else
+ − 709 {
+ − 710 if (NILP (prev))
+ − 711 Fsetcar (XCDR (selection), XCDR (values));
+ − 712 else
+ − 713 Fsetcdr (prev, XCDR (values));
+ − 714 }
+ − 715 }
+ − 716 else
+ − 717 prev = values;
+ − 718 }
+ − 719
+ − 720 /* If we have no values for this selection */
+ − 721 if (NILP (XCAR (XCDR (selection))))
+ − 722 {
+ − 723 /* Move on to the next element *first* */
+ − 724 rest = XCDR (rest);
+ − 725
+ − 726 /* Protect it and disown this selection */
+ − 727 GCPRO1 (rest);
+ − 728
+ − 729 Fdisown_selection_internal (XCAR (selection), Qnil, Qnil);
+ − 730
+ − 731 UNGCPRO;
+ − 732 }
+ − 733 else
+ − 734 rest = XCDR (rest);
+ − 735 }
+ − 736 }
+ − 737
+ − 738
414
+ − 739 void
+ − 740 syms_of_select (void)
+ − 741 {
+ − 742 DEFSUBR (Fown_selection_internal);
+ − 743 DEFSUBR (Fget_selection_internal);
442
+ − 744 DEFSUBR (Fget_selection_timestamp);
414
+ − 745 DEFSUBR (Fselection_exists_p);
+ − 746 DEFSUBR (Fdisown_selection_internal);
+ − 747 DEFSUBR (Fselection_owner_p);
442
+ − 748 DEFSUBR (Favailable_selection_types);
+ − 749 DEFSUBR (Fregister_selection_data_type);
+ − 750 DEFSUBR (Fselection_data_type_name);
414
+ − 751
442
+ − 752 /* Lisp Functions */
563
+ − 753 DEFSYMBOL (Qselect_convert_in);
+ − 754 DEFSYMBOL (Qselect_convert_out);
+ − 755 DEFSYMBOL (Qselect_coerce);
442
+ − 756
+ − 757 /* X Atoms */
563
+ − 758 DEFSYMBOL (QPRIMARY);
+ − 759 DEFSYMBOL (QSECONDARY);
+ − 760 DEFSYMBOL (QSTRING);
+ − 761 DEFSYMBOL (QINTEGER);
+ − 762 DEFSYMBOL (QCLIPBOARD);
+ − 763 DEFSYMBOL (QTIMESTAMP);
+ − 764 DEFSYMBOL (QTEXT);
+ − 765 DEFSYMBOL (QDELETE);
+ − 766 DEFSYMBOL (QMULTIPLE);
+ − 767 DEFSYMBOL (QINCR);
414
+ − 768 defsymbol (&QEMACS_TMP, "_EMACS_TMP_");
563
+ − 769 DEFSYMBOL (QTARGETS);
+ − 770 DEFSYMBOL (QATOM);
414
+ − 771 defsymbol (&QATOM_PAIR, "ATOM_PAIR");
+ − 772 defsymbol (&QCOMPOUND_TEXT, "COMPOUND_TEXT");
563
+ − 773 DEFSYMBOL (QNULL);
414
+ − 774
442
+ − 775 /* Windows formats - these all start with CF_ */
+ − 776 defsymbol (&QCF_TEXT, "CF_TEXT");
+ − 777 defsymbol (&QCF_BITMAP, "CF_BITMAP");
+ − 778 defsymbol (&QCF_METAFILEPICT, "CF_METAFILEPICT");
+ − 779 defsymbol (&QCF_SYLK, "CF_SYLK");
+ − 780 defsymbol (&QCF_DIF, "CF_DIF");
+ − 781 defsymbol (&QCF_TIFF, "CF_TIFF");
+ − 782 defsymbol (&QCF_OEMTEXT, "CF_OEMTEXT");
+ − 783 defsymbol (&QCF_DIB, "CF_DIB");
+ − 784 defsymbol (&QCF_DIBV5, "CF_DIBV5");
+ − 785 defsymbol (&QCF_PALETTE, "CF_PALETTE");
+ − 786 defsymbol (&QCF_PENDATA, "CF_PENDATA");
+ − 787 defsymbol (&QCF_RIFF, "CF_RIFF");
+ − 788 defsymbol (&QCF_WAVE, "CF_WAVE");
+ − 789 defsymbol (&QCF_UNICODETEXT, "CF_UNICODETEXT");
+ − 790 defsymbol (&QCF_ENHMETAFILE, "CF_ENHMETAFILE");
+ − 791 defsymbol (&QCF_HDROP, "CF_HDROP");
+ − 792 defsymbol (&QCF_LOCALE, "CF_LOCALE");
+ − 793 defsymbol (&QCF_OWNERDISPLAY, "CF_OWNERDISPLAY");
+ − 794 defsymbol (&QCF_DSPTEXT, "CF_DSPTEXT");
+ − 795 defsymbol (&QCF_DSPBITMAP, "CF_DSPBITMAP");
+ − 796 defsymbol (&QCF_DSPMETAFILEPICT, "CF_DSPMETAFILEPICT");
+ − 797 defsymbol (&QCF_DSPENHMETAFILE, "CF_DSPENHMETAFILE");
+ − 798
+ − 799 /* Selection strategies */
563
+ − 800 DEFSYMBOL (Qreplace_all);
+ − 801 DEFSYMBOL (Qreplace_existing);
442
+ − 802
563
+ − 803 DEFERROR_STANDARD (Qselection_conversion_error, Qconversion_error);
414
+ − 804 }
+ − 805
+ − 806 void
+ − 807 vars_of_select (void)
+ − 808 {
+ − 809 Vselection_alist = Qnil;
+ − 810 staticpro (&Vselection_alist);
+ − 811
442
+ − 812 DEFVAR_LISP ("selection-converter-alist", &Vselection_converter_out_alist /*
+ − 813 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 814 functions. This is an alias for `selection-converter-out-alist', and should
+ − 815 be considered obsolete. Use the new name instead. */ );
+ − 816
+ − 817 DEFVAR_LISP ("selection-converter-out-alist",
+ − 818 &Vselection_converter_out_alist /*
414
+ − 819 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 820 functions. These functions will be called with three args: the name
+ − 821 of the selection (typically PRIMARY, SECONDARY, or CLIPBOARD); a
+ − 822 desired type to which the selection should be converted; and the local
442
+ − 823 selection value (whatever had been passed to `own-selection').
+ − 824
+ − 825 The return type of these functions depends upon the device in question;
+ − 826 for mswindows, a string should be returned containing data in the requested
+ − 827 format, or nil to indicate that the conversion could not be done. Additionally,
+ − 828 it is permissible to return a cons of the form (DATA-TYPE . STRING) suggesting
+ − 829 a new data type to use instead.
+ − 830
+ − 831 For X, the return value should be one of:
414
+ − 832
+ − 833 -- nil (the conversion could not be done)
+ − 834 -- a cons of a symbol and any of the following values; the symbol
+ − 835 explicitly specifies the type that will be sent.
+ − 836 -- a string (If the type is not specified, then if Mule support exists,
+ − 837 the string will be converted to Compound Text and sent in
+ − 838 the 'COMPOUND_TEXT format; otherwise (no Mule support),
+ − 839 the string will be left as-is and sent in the 'STRING
+ − 840 format. If the type is specified, the string will be
+ − 841 left as-is (or converted to binary format under Mule).
+ − 842 In all cases, 8-bit data it sent.)
+ − 843 -- a character (With Mule support, will be converted to Compound Text
+ − 844 whether or not a type is specified. If a type is not
+ − 845 specified, a type of 'STRING or 'COMPOUND_TEXT will be
+ − 846 sent, as for strings.)
+ − 847 -- the symbol 'NULL (Indicates that there is no meaningful return value.
+ − 848 Empty 32-bit data with a type of 'NULL will be sent.)
+ − 849 -- a symbol (Will be converted into an atom. If the type is not specified,
+ − 850 a type of 'ATOM will be sent.)
+ − 851 -- an integer (Will be converted into a 16-bit or 32-bit integer depending
+ − 852 on the value. If the type is not specified, a type of
+ − 853 'INTEGER will be sent.)
+ − 854 -- a cons (HIGH . LOW) of integers (Will be converted into a 32-bit integer.
+ − 855 If the type is not specified, a type of
+ − 856 'INTEGER will be sent.)
+ − 857 -- a vector of symbols (Will be converted into a list of atoms. If the type
+ − 858 is not specified, a type of 'ATOM will be sent.)
+ − 859 -- a vector of integers (Will be converted into a list of 16-bit integers.
+ − 860 If the type is not specified, a type of 'INTEGER
+ − 861 will be sent.)
+ − 862 -- a vector of integers and/or conses (HIGH . LOW) of integers
+ − 863 (Will be converted into a list of 16-bit integers.
+ − 864 If the type is not specified, a type of 'INTEGER
442
+ − 865 will be sent.)
+ − 866 */ );
+ − 867 Vselection_converter_out_alist = Qnil;
+ − 868
+ − 869 DEFVAR_LISP ("selection-converter-in-alist",
+ − 870 &Vselection_converter_in_alist /*
+ − 871 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 872 functions. These functions will be called with three args: the name
+ − 873 of the selection (typically PRIMARY, SECONDARY or CLIPBOARD); the
+ − 874 type from which the selection should be converted; and the selection
+ − 875 value. These functions should return a suitable representation of the
+ − 876 value, or nil to indicate that the conversion was not possible.
+ − 877
+ − 878 See also `selection-converter-out-alist'. */ );
+ − 879 Vselection_converter_in_alist = Qnil;
+ − 880
+ − 881 DEFVAR_LISP ("selection-coercion-alist",
+ − 882 &Vselection_coercion_alist /*
+ − 883 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 884 functions. These functions will be called with three args; the name
+ − 885 of the selection (typically PRIMARY, SECONDARY or CLIPBOARD); the type
+ − 886 from which the selection should be converted, and the selection value.
+ − 887 The value passed will be *exactly the same value* that was given to
+ − 888 `own-selection'; it should be converted into something suitable for
+ − 889 return to a program calling `get-selection' with the appropriate
+ − 890 parameters.
+ − 891
+ − 892 See also `selection-converter-in-alist' and
+ − 893 `selection-converter-out-alist'. */);
+ − 894 Vselection_coercion_alist = Qnil;
+ − 895
+ − 896 DEFVAR_LISP ("selection-appender-alist",
+ − 897 &Vselection_appender_alist /*
+ − 898 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 899 functions. These functions will be called with four args; the name
+ − 900 of the selection (typically PRIMARY, SECONDARY or CLIPBOARD); the type
+ − 901 of the selection; and two selection values. The functions are expected to
+ − 902 return a value representing the catenation of the two values, or nil to
+ − 903 indicate that this was not possible. */ );
+ − 904 Vselection_appender_alist = Qnil;
+ − 905
+ − 906 DEFVAR_LISP ("selection-buffer-killed-alist",
+ − 907 &Vselection_buffer_killed_alist /*
+ − 908 An alist associating selection-types (such as STRING and TIMESTAMP) with
+ − 909 functions. These functions will be called whenever a buffer is killed,
+ − 910 with four args: the name of the selection (typically PRIMARY, SECONDARY
+ − 911 or CLIPBOARD); the type of the selection; the value of the selection; and
+ − 912 the buffer that has just been killed. These functions should return a new
+ − 913 selection value, or nil to indicate that the selection value should be
+ − 914 deleted. */ );
+ − 915 Vselection_buffer_killed_alist = Qnil;
+ − 916
+ − 917 DEFVAR_LISP ("selection-coercible-types",
+ − 918 &Vselection_coercible_types /*
+ − 919 A list of selection types that are coercible---that is, types that may be
+ − 920 automatically converted to another type. Selection values with types in this
+ − 921 list may be subject to conversion attempts to other types. */ );
+ − 922 Vselection_coercible_types = Qnil;
414
+ − 923
+ − 924 DEFVAR_LISP ("lost-selection-hooks", &Vlost_selection_hooks /*
+ − 925 A function or functions to be called after we have been notified
+ − 926 that we have lost the selection. The function(s) will be called with one
+ − 927 argument, a symbol naming the selection (typically PRIMARY, SECONDARY, or
+ − 928 CLIPBOARD).
+ − 929 */ );
+ − 930 Vlost_selection_hooks = Qunbound;
+ − 931 }
