select.el 24.6 KB
Newer Older
1
;;; select.el --- lisp portion of standard selection support  -*- lexical-binding:t -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993-1994, 2001-2019 Free Software Foundation, Inc.
4

5
;; Maintainer: emacs-devel@gnu.org
Eric S. Raymond's avatar
Eric S. Raymond committed
6 7 8 9
;; Keywords: internal

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Eric S. Raymond's avatar
Eric S. Raymond committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Eric S. Raymond's avatar
Eric S. Raymond committed
14 15 16 17 18 19 20

;; 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
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Eric S. Raymond's avatar
Eric S. Raymond committed
22

23 24
;;; Commentary:

25 26
;; Based partially on earlier release by Lucid.

27 28 29 30 31 32 33 34 35 36 37
;; The functionality here is divided in two parts:
;; - Low-level: gui-get-selection, gui-set-selection, gui-selection-owner-p,
;;   gui-selection-exists-p are the backend-dependent functions meant to access
;;   various kinds of selections (CLIPBOARD, PRIMARY, SECONDARY).
;; - Higher-level: gui-select-text and gui-selection-value go together to
;;   access the general notion of "GUI selection" for interoperation with other
;;   applications.  This can use either the clipboard or the primary selection,
;;   or both or none according to select-enable-clipboard/primary.  These are
;;   the default values of interprogram-cut/paste-function.
;;   Additionally, there's gui-get-primary-selection which is used to get the
;;   PRIMARY selection, specifically for mouse-yank-primary.
38

Eric S. Raymond's avatar
Eric S. Raymond committed
39 40
;;; Code:

41
(defcustom selection-coding-system nil
42
  "Coding system for communicating with other programs.
Kenichi Handa's avatar
Kenichi Handa committed
43

44 45 46 47 48 49 50
For MS-Windows and MS-DOS:
When sending or receiving text via selection and clipboard, the text
is encoded or decoded by this coding system.  The default value is
the current system default encoding on 9x/Me, `utf-16le-dos'
\(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.

For X Windows:
Kenichi Handa's avatar
Kenichi Handa committed
51
When sending text via selection and clipboard, if the target
52 53 54 55
data-type matches this coding system according to the table
below, it is used for encoding the text.  Otherwise (including
the case that this variable is nil), a proper coding system is
selected as below:
Kenichi Handa's avatar
Kenichi Handa committed
56 57 58 59 60 61

data-type	coding system
---------	-------------
UTF8_STRING	utf-8
COMPOUND_TEXT	compound-text-with-extensions
STRING		iso-latin-1
62
C_STRING	raw-text-unix
Kenichi Handa's avatar
Kenichi Handa committed
63 64 65 66 67 68 69 70

When receiving text, if this coding system is non-nil, it is used
for decoding regardless of the data-type.  If this is nil, a
proper coding system is used according to the data-type as above.

See also the documentation of the variable `x-select-request-type' how
to control which data-type to request for receiving text.

71 72 73 74 75 76 77 78
The default value is nil."
  :type 'coding-system
  :group 'mule
  ;; Default was compound-text-with-extensions in 22.x (pre-unicode).
  :version "23.1"
  :set (lambda (symbol value)
         (set-selection-coding-system value)
         (set symbol value)))
Kenichi Handa's avatar
Kenichi Handa committed
79 80

(defvar next-selection-coding-system nil
81
  "Coding system for the next communication with other programs.
Kenichi Handa's avatar
Kenichi Handa committed
82
Usually, `selection-coding-system' is used for communicating with
83 84 85
other programs (X Windows clients or MS Windows programs).  But, if this
variable is set, it is used for the next communication only.
After the communication, this variable is set to nil.")
Kenichi Handa's avatar
Kenichi Handa committed
86

87 88 89
;; Only declared obsolete in 23.3.
(define-obsolete-function-alias 'x-selection 'x-get-selection "at least 19.34")

90 91
(define-obsolete-variable-alias 'x-select-enable-clipboard
  'select-enable-clipboard "25.1")
92
(defcustom select-enable-clipboard t
Stefan Monnier's avatar
Stefan Monnier committed
93 94 95 96 97 98 99 100
  "Non-nil means cutting and pasting uses the clipboard.
This can be in addition to, but in preference to, the primary selection,
if applicable (i.e. under X11)."
  :type 'boolean
  :group 'killing
  ;; The GNU/Linux version changed in 24.1, the MS-Windows version did not.
  :version "24.1")

101 102
(define-obsolete-variable-alias 'x-select-enable-primary
  'select-enable-primary "25.1")
103
(defcustom select-enable-primary nil
104
  "Non-nil means cutting and pasting uses the primary selection.
105 106 107 108
The existence of a primary selection depends on the underlying GUI you use.
E.g. it doesn't exist under MS-Windows."
  :type 'boolean
  :group 'killing
109
  :version "25.1")
Stefan Monnier's avatar
Stefan Monnier committed
110

111 112 113 114 115
;; We keep track of the last text selected here, so we can check the
;; current selection against it, and avoid passing back our own text
;; from gui-selection-value.  We track both
;; separately in case another X application only sets one of them
;; we aren't fooled by the PRIMARY or CLIPBOARD selection staying the same.
116

117 118 119 120
(defvar gui--last-selected-text-clipboard nil
  "The value of the CLIPBOARD selection last seen.")
(defvar gui--last-selected-text-primary nil
  "The value of the PRIMARY selection last seen.")
Stefan Monnier's avatar
Stefan Monnier committed
121 122 123

(defun gui-select-text (text)
  "Select TEXT, a string, according to the window system.
124 125 126 127 128 129 130 131 132 133 134 135 136 137
if `select-enable-clipboard' is non-nil, copy TEXT to the system's clipboard.
If `select-enable-primary' is non-nil, put TEXT in the primary selection.

MS-Windows does not have a \"primary\" selection."
  (when select-enable-primary
    (gui-set-selection 'PRIMARY text)
    (setq gui--last-selected-text-primary text))
  (when select-enable-clipboard
    ;; When cutting, the selection is cleared and PRIMARY
    ;; set to the empty string.  Prevent that, PRIMARY
    ;; should not be reset by cut (Bug#16382).
    (setq saved-region-selection text)
    (gui-set-selection 'CLIPBOARD text)
    (setq gui--last-selected-text-clipboard text)))
Stefan Monnier's avatar
Stefan Monnier committed
138 139
(define-obsolete-function-alias 'x-select-text 'gui-select-text "25.1")

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
(defcustom x-select-request-type nil
  "Data type request for X selection.
The value is one of the following data types, a list of them, or nil:
  `COMPOUND_TEXT', `UTF8_STRING', `STRING', `TEXT'

If the value is one of the above symbols, try only the specified type.

If the value is a list of them, try each of them in the specified
order until succeed.

The value nil is the same as the list (UTF8_STRING COMPOUND_TEXT STRING)."
  :type '(choice (const :tag "Default" nil)
		 (const COMPOUND_TEXT)
		 (const UTF8_STRING)
		 (const STRING)
		 (const TEXT)
		 (set :tag "List of values"
		      (const COMPOUND_TEXT)
		      (const UTF8_STRING)
		      (const STRING)
		      (const TEXT)))
  :group 'killing)

;; Get a selection value of type TYPE by calling gui-get-selection with
;; an appropriate DATA-TYPE argument decided by `x-select-request-type'.
;; The return value is already decoded.  If gui-get-selection causes an
;; error, this function return nil.

(defun gui--selection-value-internal (type)
  (let ((request-type (if (eq window-system 'x)
                          (or x-select-request-type
                              '(UTF8_STRING COMPOUND_TEXT STRING))
                        'STRING))
	text)
    (with-demoted-errors "gui-get-selection: %S"
      (if (consp request-type)
          (while (and request-type (not text))
            (setq text (gui-get-selection type (car request-type)))
            (setq request-type (cdr request-type)))
        (setq text (gui-get-selection type request-type))))
    (if text
	(remove-text-properties 0 (length text) '(foreign-selection nil) text))
    text))
183 184

(defun gui-selection-value ()
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
  (let ((clip-text
         (when select-enable-clipboard
           (let ((text (gui--selection-value-internal 'CLIPBOARD)))
             (if (string= text "") (setq text nil))

             ;; Check the CLIPBOARD selection for 'newness', is it different
             ;; from what we remembered them to be last time we did a
             ;; cut/paste operation.
             (prog1
                 (unless (equal text gui--last-selected-text-clipboard)
                   text)
               (setq gui--last-selected-text-clipboard text)))))
        (primary-text
         (when select-enable-primary
           (let ((text (gui--selection-value-internal 'PRIMARY)))
             (if (string= text "") (setq text nil))
             ;; Check the PRIMARY selection for 'newness', is it different
             ;; from what we remembered them to be last time we did a
             ;; cut/paste operation.
             (prog1
                 (unless (equal text gui--last-selected-text-primary)
                   text)
               (setq gui--last-selected-text-primary text))))))

    ;; As we have done one selection, clear this now.
    (setq next-selection-coding-system nil)

    ;; At this point we have recorded the current values for the
    ;; selection from clipboard (if we are supposed to) and primary.
    ;; So return the first one that has changed
    ;; (which is the first non-null one).
    ;;
    ;; NOTE: There will be cases where more than one of these has
    ;; changed and the new values differ.  This indicates that
    ;; something like the following has happened since the last time
    ;; we looked at the selections: Application X set all the
    ;; selections, then Application Y set only one of them.
    ;; In this case since we don't have
    ;; timestamps there is no way to know what the 'correct' value to
    ;; return is.  The nice thing to do would be to tell the user we
    ;; saw multiple possible selections and ask the user which was the
    ;; one they wanted.
    (or clip-text primary-text)
    ))
229

230
(define-obsolete-function-alias 'x-selection-value 'gui-selection-value "25.1")
Eric S. Raymond's avatar
Eric S. Raymond committed
231 232 233

(defun x-get-clipboard ()
  "Return text pasted to the clipboard."
234
  (declare (obsolete gui-get-selection "25.1"))
235
  (gui-backend-get-selection 'CLIPBOARD 'STRING))
236 237 238

(defun gui-get-primary-selection ()
  "Return the PRIMARY selection, or the best emulation thereof."
239
  (or (gui--selection-value-internal 'PRIMARY)
240 241 242 243 244 245 246 247 248 249
      (and (fboundp 'w32-get-selection-value)
           (eq (framep (selected-frame)) 'w32)
           ;; MS-Windows emulates PRIMARY in x-get-selection, but only
           ;; within the Emacs session, so consult the clipboard if
           ;; primary is not found.
           (w32-get-selection-value))
      (error "No selection is available")))
(define-obsolete-function-alias 'x-get-selection-value
  'gui-get-primary-selection "25.1")

250 251
;;; Lower-level, backend dependent selection handling.

252
(cl-defgeneric gui-backend-get-selection (_selection-symbol _target-type)
253 254 255
  "Return selected text.
SELECTION-SYMBOL is typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.
\(Those are literal upper-case symbol names, since that's what X expects.)
256 257
TARGET-TYPE is the type of data desired, typically `STRING'."
  nil)
258

259
(cl-defgeneric gui-backend-set-selection (_selection _value)
260 261
  "Method to assert a selection of type SELECTION and value VALUE.
SELECTION is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.
262 263 264
If VALUE is nil and we own the selection SELECTION, disown it instead.
Disowning it means there is no such selection.
\(Those are literal upper-case symbol names, since that's what X expects.)
265
VALUE is typically a string, or a cons of two markers, but may be
266 267
anything that the functions on `selection-converter-alist' know about."
  nil)
268

269
(cl-defgeneric gui-backend-selection-owner-p (_selection)
270 271 272
  "Whether the current Emacs process owns the given X Selection.
The arg should be the name of the selection in question, typically one of
the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
273 274
\(Those are literal upper-case symbol names, since that's what X expects.)"
  nil)
275

276
(cl-defgeneric gui-backend-selection-exists-p (_selection)
277 278 279
  "Whether there is an owner for the given X Selection.
The arg should be the name of the selection in question, typically one of
the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
280 281
\(Those are literal upper-case symbol names, since that's what X expects.)"
  nil)
282 283 284 285 286 287 288 289 290 291 292 293 294

(defun gui-get-selection (&optional type data-type)
  "Return the value of an X Windows selection.
The argument TYPE (default `PRIMARY') says which selection,
and the argument DATA-TYPE (default `STRING') says
how to convert the data.

TYPE may be any symbol \(but nil stands for `PRIMARY').  However,
only a few symbols are commonly used.  They conventionally have
all upper-case names.  The most often used ones, in addition to
`PRIMARY', are `SECONDARY' and `CLIPBOARD'.

DATA-TYPE is usually `STRING', but can also be one of the symbols
295 296 297 298
in `selection-converter-alist', which see.  Window systems other
than X usually support only a small subset of these symbols, in
addition to `STRING'; MS-Windows supports `TARGETS', which reports
the formats available in the clipboard if TYPE is `CLIPBOARD'."
299 300
  (let ((data (gui-backend-get-selection (or type 'PRIMARY)
                                         (or data-type 'STRING))))
301 302 303 304 305 306 307 308 309 310 311
    (when (and (stringp data)
	       (setq data-type (get-text-property 0 'foreign-selection data)))
      (let ((coding (or next-selection-coding-system
                        selection-coding-system
                        (pcase data-type
                          ('UTF8_STRING 'utf-8)
                          ('COMPOUND_TEXT 'compound-text-with-extensions)
                          ('C_STRING nil)
                          ('STRING 'iso-8859-1)
                          (_ (error "Unknown selection data type: %S"
                                    type))))))
312 313 314 315 316 317
        (setq data (if coding (decode-coding-string data coding)
                     ;; This is for C_STRING case.
                     ;; We want to convert each non-ASCII byte to the
                     ;; corresponding eight-bit character, which has
                     ;; a codepoint >= #x3FFF00.
                     (string-to-multibyte data))))
318 319 320 321
      (setq next-selection-coding-system nil)
      (put-text-property 0 (length data) 'foreign-selection data-type data))
    data))
(define-obsolete-function-alias 'x-get-selection 'gui-get-selection "25.1")
322 323

(defun gui-set-selection (type data)
324
  "Make an X selection of type TYPE and value DATA.
Eli Zaretskii's avatar
Eli Zaretskii committed
325 326 327 328 329 330 331 332 333 334 335 336 337
The argument TYPE (nil means `PRIMARY') says which selection, and
DATA specifies the contents.  TYPE must be a symbol.  \(It can also
be a string, which stands for the symbol with that name, but this
is considered obsolete.)  DATA may be a string, a symbol, an
integer (or a cons of two integers or list of two integers).

The selection may also be a cons of two markers pointing to the same buffer,
or an overlay.  In these cases, the selection is considered to be the text
between the markers *at whatever time the selection is examined*.
Thus, editing done in the buffer after you specify the selection
can alter the effective value of the selection.

The data may also be a vector of valid non-vector selection values.
338

339 340 341 342
The return value is DATA.

Interactively, this command sets the primary selection.  Without
prefix argument, it reads the selection in the minibuffer.  With
Eli Zaretskii's avatar
Eli Zaretskii committed
343 344 345 346
prefix argument, it uses the text of the region as the selection value.

Note that on MS-Windows, primary and secondary selections set by Emacs
are not available to other programs."
Eric S. Raymond's avatar
Eric S. Raymond committed
347
  (interactive (if (not current-prefix-arg)
348
		   (list 'PRIMARY (read-string "Set text for pasting: "))
349
		 (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
350
  (if (stringp type) (setq type (intern type)))
351
  (or (gui--valid-simple-selection-p data)
Eric S. Raymond's avatar
Eric S. Raymond committed
352
      (and (vectorp data)
353 354
	   (let ((valid t))
	     (dotimes (i (length data))
355
	       (or (gui--valid-simple-selection-p (aref data i))
356
		   (setq valid nil)))
Eric S. Raymond's avatar
Eric S. Raymond committed
357 358 359
	     valid))
      (signal 'error (list "invalid selection" data)))
  (or type (setq type 'PRIMARY))
360
  (gui-backend-set-selection type data)
Eric S. Raymond's avatar
Eric S. Raymond committed
361
  data)
362
(define-obsolete-function-alias 'x-set-selection 'gui-set-selection "25.1")
Eric S. Raymond's avatar
Eric S. Raymond committed
363

364
(defun gui--valid-simple-selection-p (data)
365 366
  (or (bufferp data)
      (and (consp data)
Eric S. Raymond's avatar
Eric S. Raymond committed
367 368 369
	   (markerp (car data))
	   (markerp (cdr data))
	   (marker-buffer (car data))
370
	   (buffer-live-p (marker-buffer (car data)))
371 372 373 374 375
	   (eq (marker-buffer (car data))
	       (marker-buffer (cdr data))))
      (stringp data)
      (and (overlayp data)
	   (overlay-buffer data)
376
	   (buffer-live-p (overlay-buffer data)))
377 378
      (symbolp data)
      (integerp data)))
Eric S. Raymond's avatar
Eric S. Raymond committed
379

Stefan Monnier's avatar
Stefan Monnier committed
380 381 382
;; Functions to convert the selection into various other selection types.
;; Every selection type that Emacs handles is implemented this way, except
;; for TIMESTAMP, which is a special case.
Eric S. Raymond's avatar
Eric S. Raymond committed
383

384 385 386 387
(defun xselect--selection-bounds (value)
  "Return bounds of X selection value VALUE.
The return value is a list (BEG END BUF) if VALUE is a cons of
two markers or an overlay.  Otherwise, it is nil."
388 389 390 391 392
  (cond ((bufferp value)
	 (with-current-buffer value
	   (when (mark t)
	     (list (mark t) (point) value))))
	((and (consp value)
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
	      (markerp (car value))
	      (markerp (cdr value)))
	 (when (and (marker-buffer (car value))
		    (buffer-name (marker-buffer (car value)))
		    (eq (marker-buffer (car value))
			(marker-buffer (cdr value))))
	   (list (marker-position (car value))
		 (marker-position (cdr value))
		 (marker-buffer (car value)))))
	((overlayp value)
	 (when (overlay-buffer value)
	   (list (overlay-start value)
		 (overlay-end value)
		 (overlay-buffer value))))))

(defun xselect--int-to-cons (n)
  (cons (ash n -16) (logand n 65535)))

411 412 413 414 415 416 417 418
(defun xselect--encode-string (type str &optional can-modify)
  (when str
    ;; If TYPE is nil, this is a local request; return STR as-is.
    (if (null type)
	str
      ;; Otherwise, encode STR.
      (let ((coding (or next-selection-coding-system
			selection-coding-system)))
419
	(if coding
Kenichi Handa's avatar
Kenichi Handa committed
420
	    (setq coding (coding-system-base coding)))
421
	(let ((inhibit-read-only t))
422
	  ;; Suppress producing escape sequences for compositions.
423 424
	  ;; But avoid modifying the string if it's a buffer name etc.
	  (unless can-modify (setq str (substring str 0)))
425
	  (remove-text-properties 0 (length str) '(composition nil) str)
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
	  ;; For X selections, TEXT is a polymorphic target; choose
	  ;; the actual type from `UTF8_STRING', `COMPOUND_TEXT',
	  ;; `STRING', and `C_STRING'.  On Nextstep, always use UTF-8
	  ;; (see ns_string_to_pasteboard_internal in nsselect.m).
	  (when (eq type 'TEXT)
	    (cond
	     ((featurep 'ns)
	      (setq type 'UTF8_STRING))
	     ((not (multibyte-string-p str))
	      (setq type 'C_STRING))
	     (t
	      (let (non-latin-1 non-unicode eight-bit)
		(mapc #'(lambda (x)
			  (if (>= x #x100)
			      (if (< x #x110000)
				  (setq non-latin-1 t)
				(if (< x #x3FFF80)
				    (setq non-unicode t)
				  (setq eight-bit t)))))
		      str)
446 447 448 449 450 451 452 453 454 455 456
		(setq type (if (or non-unicode
				   (and
				    non-latin-1
				    ;; If a coding is specified for
				    ;; selection, and that is
				    ;; compatible with COMPOUND_TEXT,
				    ;; use it.
				    coding
				    (eq (coding-system-get coding :mime-charset)
					'x-ctext)))
			       'COMPOUND_TEXT
457 458 459
			     (if non-latin-1 'UTF8_STRING
			       (if eight-bit 'C_STRING
				 'STRING))))))))
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
	  (cond
	   ((eq type 'UTF8_STRING)
	    (if (or (not coding)
		    (not (eq (coding-system-type coding) 'utf-8)))
		(setq coding 'utf-8))
	    (setq str (encode-coding-string str coding)))

	   ((eq type 'STRING)
	    (if (or (not coding)
		    (not (eq (coding-system-type coding) 'charset)))
		(setq coding 'iso-8859-1))
	    (setq str (encode-coding-string str coding)))

	   ((eq type 'COMPOUND_TEXT)
	    (if (or (not coding)
		    (not (eq (coding-system-type coding) 'iso-2022)))
		(setq coding 'compound-text-with-extensions))
	    (setq str (encode-coding-string str coding)))

	   ((eq type 'C_STRING)
480 481 482 483 484 485 486 487
            ;; According to ICCCM Protocol v2.0 (para 2.7.1), C_STRING
            ;; is a zero-terminated sequence of raw bytes that
            ;; shouldn't be interpreted as text in any encoding.
            ;; Therefore, if STR is unibyte (the normal case), we use
            ;; it as-is; otherwise we assume some of the characters
            ;; are eight-bit and ensure they are converted to their
            ;; single-byte representation.
            (or (null (multibyte-string-p str))
488
                (setq str (encode-coding-string str 'raw-text-unix))))
489 490

	   (t
491
	    (error "Unknown selection type: %S" type)))))
492

493 494 495
      ;; Most programs are unable to handle NUL bytes in strings.
      (setq str (replace-regexp-in-string "\0" "\\0" str t t))

496 497 498
      (setq next-selection-coding-system nil)
      (cons type str))))

499 500 501 502 503 504 505 506
(defun xselect-convert-to-string (_selection type value)
  (let ((str (cond ((stringp value) value)
		   ((setq value (xselect--selection-bounds value))
		    (with-current-buffer (nth 2 value)
		      (buffer-substring (nth 0 value)
					(nth 1 value)))))))
    (xselect--encode-string type str t)))

507
(defun xselect-convert-to-length (_selection _type value)
508 509 510 511 512 513
  (let ((len (cond ((stringp value)
		    (length value))
		   ((setq value (xselect--selection-bounds value))
		    (abs (- (nth 0 value) (nth 1 value)))))))
    (if len
	(xselect--int-to-cons len))))
Eric S. Raymond's avatar
Eric S. Raymond committed
514

515
(defun xselect-convert-to-targets (_selection _type _value)
Eric S. Raymond's avatar
Eric S. Raymond committed
516
  ;; return a vector of atoms, but remove duplicates first.
Chong Yidong's avatar
Chong Yidong committed
517 518 519
  (let* ((all (cons 'TIMESTAMP
		    (cons 'MULTIPLE
			  (mapcar 'car selection-converter-alist))))
Eric S. Raymond's avatar
Eric S. Raymond committed
520 521 522 523 524 525 526 527 528 529
	 (rest all))
    (while rest
      (cond ((memq (car rest) (cdr rest))
	     (setcdr rest (delq (car rest) (cdr rest))))
	    ((eq (car (cdr rest)) '_EMACS_INTERNAL)  ; shh, it's a secret
	     (setcdr rest (cdr (cdr rest))))
	    (t
	     (setq rest (cdr rest)))))
    (apply 'vector all)))

530
(defun xselect-convert-to-delete (selection _type _value)
531
  (gui-backend-set-selection selection nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
532 533 534 535 536
  ;; A return value of nil means that we do not know how to do this conversion,
  ;; and replies with an "error".  A return value of NULL means that we have
  ;; done the conversion (and any side-effects) but have no value to return.
  'NULL)

537
(defun xselect-convert-to-filename (_selection _type value)
538
  (when (setq value (xselect--selection-bounds value))
539
    (xselect--encode-string 'TEXT (buffer-file-name (nth 2 value)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
540

541
(defun xselect-convert-to-charpos (_selection _type value)
542 543 544 545 546
  (when (setq value (xselect--selection-bounds value))
    (let ((beg (1- (nth 0 value))) ; zero-based
	  (end (1- (nth 1 value))))
      (cons 'SPAN (vector (xselect--int-to-cons (min beg end))
			  (xselect--int-to-cons (max beg end)))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
547

548
(defun xselect-convert-to-lineno (_selection _type value)
549 550 551 552 553 554
  (when (setq value (xselect--selection-bounds value))
    (with-current-buffer (nth 2 value)
      (let ((beg (line-number-at-pos (nth 0 value)))
	    (end (line-number-at-pos (nth 1 value))))
	(cons 'SPAN (vector (xselect--int-to-cons (min beg end))
			    (xselect--int-to-cons (max beg end))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
555

556
(defun xselect-convert-to-colno (_selection _type value)
557 558 559 560 561 562
  (when (setq value (xselect--selection-bounds value))
    (with-current-buffer (nth 2 value)
      (let ((beg (progn (goto-char (nth 0 value)) (current-column)))
	    (end (progn (goto-char (nth 1 value)) (current-column))))
	(cons 'SPAN (vector (xselect--int-to-cons (min beg end))
			    (xselect--int-to-cons (max beg end))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
563

564
(defun xselect-convert-to-os (_selection _type _size)
565
  (xselect--encode-string 'TEXT (symbol-name system-type)))
Eric S. Raymond's avatar
Eric S. Raymond committed
566

567
(defun xselect-convert-to-host (_selection _type _size)
568
  (xselect--encode-string 'TEXT (system-name)))
Eric S. Raymond's avatar
Eric S. Raymond committed
569

570
(defun xselect-convert-to-user (_selection _type _size)
571
  (xselect--encode-string 'TEXT (user-full-name)))
Eric S. Raymond's avatar
Eric S. Raymond committed
572

573
(defun xselect-convert-to-class (_selection _type _size)
574 575
  "Convert selection to class.
This function returns the string \"Emacs\"."
576
  "Emacs")
Eric S. Raymond's avatar
Eric S. Raymond committed
577 578 579

;; We do not try to determine the name Emacs was invoked with,
;; because it is not clean for a program's behavior to depend on that.
580
(defun xselect-convert-to-name (_selection _type _size)
581 582
  "Convert selection to name.
This function returns the string \"emacs\"."
Eric S. Raymond's avatar
Eric S. Raymond committed
583 584
  "emacs")

585
(defun xselect-convert-to-integer (_selection _type value)
Eric S. Raymond's avatar
Eric S. Raymond committed
586
  (and (integerp value)
587
       (xselect--int-to-cons value)))
Eric S. Raymond's avatar
Eric S. Raymond committed
588

589
(defun xselect-convert-to-atom (_selection _type value)
Eric S. Raymond's avatar
Eric S. Raymond committed
590 591
  (and (symbolp value) value))

592
(defun xselect-convert-to-identity (_selection _type value) ; used internally
Eric S. Raymond's avatar
Eric S. Raymond committed
593 594
  (vector value))

Chong Yidong's avatar
Chong Yidong committed
595 596 597 598 599 600
;; Null target that tells clipboard managers we support SAVE_TARGETS
;; (see freedesktop.org Clipboard Manager spec).
(defun xselect-convert-to-save-targets (selection _type _value)
  (when (eq selection 'CLIPBOARD)
    'NULL))

Eric S. Raymond's avatar
Eric S. Raymond committed
601 602
(setq selection-converter-alist
      '((TEXT . xselect-convert-to-string)
603
	(COMPOUND_TEXT . xselect-convert-to-string)
Eric S. Raymond's avatar
Eric S. Raymond committed
604
	(STRING . xselect-convert-to-string)
605
	(UTF8_STRING . xselect-convert-to-string)
Eric S. Raymond's avatar
Eric S. Raymond committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619
	(TARGETS . xselect-convert-to-targets)
	(LENGTH . xselect-convert-to-length)
	(DELETE . xselect-convert-to-delete)
	(FILE_NAME . xselect-convert-to-filename)
	(CHARACTER_POSITION . xselect-convert-to-charpos)
	(LINE_NUMBER . xselect-convert-to-lineno)
	(COLUMN_NUMBER . xselect-convert-to-colno)
	(OWNER_OS . xselect-convert-to-os)
	(HOST_NAME . xselect-convert-to-host)
	(USER . xselect-convert-to-user)
	(CLASS . xselect-convert-to-class)
	(NAME . xselect-convert-to-name)
	(ATOM . xselect-convert-to-atom)
	(INTEGER . xselect-convert-to-integer)
Chong Yidong's avatar
Chong Yidong committed
620
	(SAVE_TARGETS . xselect-convert-to-save-targets)
621
	(_EMACS_INTERNAL . xselect-convert-to-identity)))
Eric S. Raymond's avatar
Eric S. Raymond committed
622 623 624

(provide 'select)

625
;;; select.el ends here