1 ;;; select.el --- lisp portion of standard selection support
6 ;; Copyright (c) 1993, 1994 Free Software Foundation, Inc.
7 ;; Based partially on earlier release by Lucid.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 ;; This is for temporary compatibility with pre-release Emacs 19.
31 (defalias 'x-selection 'x-get-selection)
32 (defun x-get-selection (&optional type data-type)
33 "Return the value of an X Windows selection.
34 The argument TYPE (default `PRIMARY') says which selection,
35 and the argument DATA-TYPE (default `STRING') says
36 how to convert the data.
38 TYPE may be `SECONDARY' or `CLIPBOARD', in addition to `PRIMARY'.
39 DATA-TYPE is usually `STRING', but can also be one of the symbols
40 in `selection-converter-alist', which see."
41 (x-get-selection-internal (or type 'PRIMARY) (or data-type 'STRING)))
43 (defun x-get-clipboard ()
44 "Return text pasted to the clipboard."
45 (x-get-selection-internal 'CLIPBOARD 'STRING))
47 (defun x-set-selection (type data)
48 "Make an X Windows selection of type TYPE and value DATA.
49 The argument TYPE (default `PRIMARY') says which selection,
50 and DATA specifies the contents. DATA may be a string,
51 a symbol, an integer (or a cons of two integers or list of two integers).
53 The selection may also be a cons of two markers pointing to the same buffer,
54 or an overlay. In these cases, the selection is considered to be the text
55 between the markers *at whatever time the selection is examined*.
56 Thus, editing done in the buffer after you specify the selection
57 can alter the effective value of the selection.
59 The data may also be a vector of valid non-vector selection values.
61 Interactively, the text of the region is used as the selection value
62 if the prefix arg is set."
63 (interactive (if (not current-prefix-arg)
64 (list 'PRIMARY (read-string "Set text for pasting: "))
65 (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
66 ;; This is for temporary compatibility with pre-release Emacs 19.
68 (setq type (intern type)))
69 (or (x-valid-simple-selection-p data)
72 (i (1- (length data))))
74 (or (x-valid-simple-selection-p (aref data i))
78 (signal 'error (list "invalid selection" data)))
79 (or type (setq type 'PRIMARY))
81 (x-own-selection-internal type data)
82 (x-disown-selection-internal type))
85 (defun x-valid-simple-selection-p (data)
91 (or (integerp (cdr data))
92 (and (consp (cdr data))
93 (integerp (car (cdr data))))))
98 (marker-buffer (car data))
99 (marker-buffer (cdr data))
100 (eq (marker-buffer (car data))
101 (marker-buffer (cdr data)))
102 (buffer-name (marker-buffer (car data)))
103 (buffer-name (marker-buffer (cdr data))))))
105 ;;; Cut Buffer support
107 (defun x-get-cut-buffer (&optional which-one)
108 "Returns the value of one of the 8 X server cut-buffers.
109 Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
110 Cut buffers are considered obsolete; you should use selections instead."
111 (x-get-cut-buffer-internal
113 (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3
114 CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7]
118 (defun x-set-cut-buffer (string &optional push)
119 "Store STRING into the X server's primary cut buffer.
120 If PUSH is non-nil, also rotate the cut buffers:
121 this means the previous value of the primary cut buffer moves to the second
122 cut buffer, and the second to the third, and so on (there are 8 buffers.)
123 Cut buffers are considered obsolete; you should use selections instead."
124 (or (stringp string) (signal 'wrong-type-argument (list 'string string)))
126 (x-rotate-cut-buffers-internal 1))
127 (x-store-cut-buffer-internal 'CUT_BUFFER0 string))
130 ;;; Functions to convert the selection into various other selection types.
131 ;;; Every selection type that Emacs handles is implemented this way, except
132 ;;; for TIMESTAMP, which is a special case.
134 (defun xselect-convert-to-string (selection type value)
136 ;; Get the actual string from VALUE.
137 (cond ((stringp value)
142 (or (buffer-name (overlay-buffer value))
143 (error "selection is in a killed buffer"))
144 (set-buffer (overlay-buffer value))
145 (setq str (buffer-substring (overlay-start value)
146 (overlay-end value)))))
148 (markerp (car value))
149 (markerp (cdr value)))
150 (or (eq (marker-buffer (car value)) (marker-buffer (cdr value)))
152 (list "markers must be in the same buffer"
153 (car value) (cdr value))))
155 (set-buffer (or (marker-buffer (car value))
156 (error "selection is in a killed buffer")))
157 (setq str (buffer-substring (car value) (cdr value))))))
160 ;; If TYPE is nil, this is a local request, thus return STR as
161 ;; is. Otherwise, encode STR.
164 (setq coding (or next-selection-coding-system selection-coding-system))
166 (setq coding (coding-system-base coding))
167 (setq coding 'raw-text))
168 ;; Suppress producing escape sequences for compositions.
169 (remove-text-properties 0 (length str) '(composition nil) str)
172 (if (not (multibyte-string-p str))
173 ;; Don't have to encode unibyte string.
175 ;; If STR contains only ASCII, Latin-1, and raw bytes,
176 ;; encode STR by iso-latin-1, and return it as type
177 ;; `STRING'. Otherwise, encode STR by CODING. In that
178 ;; case, the returing type depends on CODING.
179 (let ((charsets (find-charset-string str)))
182 (delq 'latin-iso8859-1
183 (delq 'eight-bit-control
184 (delq 'eight-bit-graphic charsets)))))
186 (setq str (encode-coding-string str coding)
187 type (if (memq coding '(compound-text
188 compound-text-with-extensions))
192 str (encode-coding-string str 'iso-latin-1))))))
194 ((eq type 'COMPOUND_TEXT)
195 (setq str (encode-coding-string str coding)))
198 (if (memq coding '(compound-text
199 compound-text-with-extensions))
200 (setq str (string-make-unibyte str))
201 (setq str (encode-coding-string str coding))))
203 ((eq type 'UTF8_STRING)
204 (setq str (encode-coding-string str 'utf-8)))
207 (error "Unknow selection type: %S" type))
210 (setq next-selection-coding-system nil)
214 (defun xselect-convert-to-length (selection type value)
216 (cond ((stringp value)
219 (abs (- (overlay-end value) (overlay-start value))))
221 (markerp (car value))
222 (markerp (cdr value)))
223 (or (eq (marker-buffer (car value))
224 (marker-buffer (cdr value)))
226 (list "markers must be in the same buffer"
227 (car value) (cdr value))))
228 (abs (- (car value) (cdr value)))))))
229 (if value ; force it to be in 32-bit format.
230 (cons (ash value -16) (logand value 65535))
233 (defun xselect-convert-to-targets (selection type value)
234 ;; return a vector of atoms, but remove duplicates first.
235 (let* ((all (cons 'TIMESTAMP (mapcar 'car selection-converter-alist)))
238 (cond ((memq (car rest) (cdr rest))
239 (setcdr rest (delq (car rest) (cdr rest))))
240 ((eq (car (cdr rest)) '_EMACS_INTERNAL) ; shh, it's a secret
241 (setcdr rest (cdr (cdr rest))))
243 (setq rest (cdr rest)))))
244 (apply 'vector all)))
246 (defun xselect-convert-to-delete (selection type value)
247 (x-disown-selection-internal selection)
248 ;; A return value of nil means that we do not know how to do this conversion,
249 ;; and replies with an "error". A return value of NULL means that we have
250 ;; done the conversion (and any side-effects) but have no value to return.
253 (defun xselect-convert-to-filename (selection type value)
254 (cond ((overlayp value)
255 (buffer-file-name (or (overlay-buffer value)
256 (error "selection is in a killed buffer"))))
258 (markerp (car value))
259 (markerp (cdr value)))
260 (buffer-file-name (or (marker-buffer (car value))
261 (error "selection is in a killed buffer"))))
264 (defun xselect-convert-to-charpos (selection type value)
266 (cond ((cond ((overlayp value)
267 (setq a (overlay-start value)
268 b (overlay-end value)))
270 (markerp (car value))
271 (markerp (cdr value)))
274 (setq a (1- a) b (1- b)) ; zero-based
275 (if (< b a) (setq tmp a a b b tmp))
277 (vector (cons (ash a -16) (logand a 65535))
278 (cons (ash b -16) (logand b 65535))))))))
280 (defun xselect-convert-to-lineno (selection type value)
282 (cond ((cond ((and (consp value)
283 (markerp (car value))
284 (markerp (cdr value)))
285 (setq a (marker-position (car value))
286 b (marker-position (cdr value))
287 buf (marker-buffer (car value))))
289 (setq buf (overlay-buffer value)
290 a (overlay-start value)
291 b (overlay-end value)))
295 (setq a (count-lines 1 a)
296 b (count-lines 1 b)))
297 (if (< b a) (setq tmp a a b b tmp))
299 (vector (cons (ash a -16) (logand a 65535))
300 (cons (ash b -16) (logand b 65535))))))))
302 (defun xselect-convert-to-colno (selection type value)
304 (cond ((cond ((and (consp value)
305 (markerp (car value))
306 (markerp (cdr value)))
309 buf (marker-buffer a)))
311 (setq buf (overlay-buffer value)
312 a (overlay-start value)
313 b (overlay-end value)))
318 (setq a (current-column))
320 (setq b (current-column)))
321 (if (< b a) (setq tmp a a b b tmp))
323 (vector (cons (ash a -16) (logand a 65535))
324 (cons (ash b -16) (logand b 65535))))))))
326 (defun xselect-convert-to-os (selection type size)
327 (symbol-name system-type))
329 (defun xselect-convert-to-host (selection type size)
332 (defun xselect-convert-to-user (selection type size)
335 (defun xselect-convert-to-class (selection type size)
336 "Convert selection to class.
337 This function returns the string \"Emacs\"."
340 ;; We do not try to determine the name Emacs was invoked with,
341 ;; because it is not clean for a program's behavior to depend on that.
342 (defun xselect-convert-to-name (selection type size)
343 "Convert selection to name.
344 This function returns the string \"emacs\"."
347 (defun xselect-convert-to-integer (selection type value)
348 (and (integerp value)
349 (cons (ash value -16) (logand value 65535))))
351 (defun xselect-convert-to-atom (selection type value)
352 (and (symbolp value) value))
354 (defun xselect-convert-to-identity (selection type value) ; used internally
357 (setq selection-converter-alist
358 '((TEXT . xselect-convert-to-string)
359 (COMPOUND_TEXT . xselect-convert-to-string)
360 (STRING . xselect-convert-to-string)
361 (UTF8_STRING . xselect-convert-to-string)
362 (TARGETS . xselect-convert-to-targets)
363 (LENGTH . xselect-convert-to-length)
364 (DELETE . xselect-convert-to-delete)
365 (FILE_NAME . xselect-convert-to-filename)
366 (CHARACTER_POSITION . xselect-convert-to-charpos)
367 (LINE_NUMBER . xselect-convert-to-lineno)
368 (COLUMN_NUMBER . xselect-convert-to-colno)
369 (OWNER_OS . xselect-convert-to-os)
370 (HOST_NAME . xselect-convert-to-host)
371 (USER . xselect-convert-to-user)
372 (CLASS . xselect-convert-to-class)
373 (NAME . xselect-convert-to-name)
374 (ATOM . xselect-convert-to-atom)
375 (INTEGER . xselect-convert-to-integer)
376 (_EMACS_INTERNAL . xselect-convert-to-identity)
381 ;;; select.el ends here