1 ;;; select.el --- lisp portion of standard selection support
5 ;; Copyright (c) 1993, 1994 Free Software Foundation, Inc.
6 ;; Based partially on earlier release by Lucid.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 ;; This is for temporary compatibility with pre-release Emacs 19.
30 (defalias 'x-selection 'x-get-selection)
31 (defun x-get-selection (&optional type data-type)
32 "Return the value of an X Windows selection.
33 The argument TYPE (default `PRIMARY') says which selection,
34 and the argument DATA-TYPE (default `STRING') says
35 how to convert the data.
37 TYPE may be `SECONDARY' or `CLIPBOARD', in addition to `PRIMARY'.
38 DATA-TYPE is usually `STRING', but can also be one of the symbols
39 in `selection-converter-alist', which see."
40 (x-get-selection-internal (or type 'PRIMARY) (or data-type 'STRING)))
42 (defun x-get-clipboard ()
43 "Return text pasted to the clipboard."
44 (x-get-selection-internal 'CLIPBOARD 'STRING))
46 (defun x-set-selection (type data)
47 "Make an X Windows selection of type TYPE and value DATA.
48 The argument TYPE (default `PRIMARY') says which selection,
49 and DATA specifies the contents. DATA may be a string,
50 a symbol, an integer (or a cons of two integers or list of two integers).
52 The selection may also be a cons of two markers pointing to the same buffer,
53 or an overlay. In these cases, the selection is considered to be the text
54 between the markers *at whatever time the selection is examined*.
55 Thus, editing done in the buffer after you specify the selection
56 can alter the effective value of the selection.
58 The data may also be a vector of valid non-vector selection values.
60 Interactively, the text of the region is used as the selection value
61 if the prefix arg is set."
62 (interactive (if (not current-prefix-arg)
63 (list 'PRIMARY (read-string "Set text for pasting: "))
64 (list 'PRIMARY (buffer-substring (region-beginning) (region-end)))))
65 ;; This is for temporary compatibility with pre-release Emacs 19.
67 (setq type (intern type)))
68 (or (x-valid-simple-selection-p data)
71 (i (1- (length data))))
73 (or (x-valid-simple-selection-p (aref data i))
77 (signal 'error (list "invalid selection" data)))
78 (or type (setq type 'PRIMARY))
80 (x-own-selection-internal type data)
81 (x-disown-selection-internal type))
84 (defun x-valid-simple-selection-p (data)
90 (or (integerp (cdr data))
91 (and (consp (cdr data))
92 (integerp (car (cdr data))))))
97 (marker-buffer (car data))
98 (marker-buffer (cdr data))
99 (eq (marker-buffer (car data))
100 (marker-buffer (cdr data)))
101 (buffer-name (marker-buffer (car data)))
102 (buffer-name (marker-buffer (cdr data))))))
104 ;;; Cut Buffer support
106 (defun x-get-cut-buffer (&optional which-one)
107 "Returns the value of one of the 8 X server cut-buffers.
108 Optional arg WHICH-ONE should be a number from 0 to 7, defaulting to 0.
109 Cut buffers are considered obsolete; you should use selections instead."
110 (x-get-cut-buffer-internal
112 (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3
113 CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7]
117 (defun x-set-cut-buffer (string &optional push)
118 "Store STRING into the X server's primary cut buffer.
119 If PUSH is non-nil, also rotate the cut buffers:
120 this means the previous value of the primary cut buffer moves the second
121 cut buffer, and the second to the third, and so on (there are 8 buffers.)
122 Cut buffers are considered obsolete; you should use selections instead."
123 ;; Check the data type of STRING.
124 (substring string 0 0)
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)
135 (cond ((stringp value)
139 (or (buffer-name (overlay-buffer value))
140 (error "selection is in a killed buffer"))
141 (set-buffer (overlay-buffer value))
142 (buffer-substring (overlay-start value)
143 (overlay-end value))))
145 (markerp (car value))
146 (markerp (cdr value)))
147 (or (eq (marker-buffer (car value)) (marker-buffer (cdr value)))
149 (list "markers must be in the same buffer"
150 (car value) (cdr value))))
152 (set-buffer (or (marker-buffer (car value))
153 (error "selection is in a killed buffer")))
154 (buffer-substring (car value) (cdr value))))
157 (defun xselect-convert-to-length (selection type value)
159 (cond ((stringp value)
162 (abs (- (overlay-end value) (overlay-start value))))
164 (markerp (car value))
165 (markerp (cdr value)))
166 (or (eq (marker-buffer (car value))
167 (marker-buffer (cdr value)))
169 (list "markers must be in the same buffer"
170 (car value) (cdr value))))
171 (abs (- (car value) (cdr value)))))))
172 (if value ; force it to be in 32-bit format.
173 (cons (ash value -16) (logand value 65535))
176 (defun xselect-convert-to-targets (selection type value)
177 ;; return a vector of atoms, but remove duplicates first.
178 (let* ((all (cons 'TIMESTAMP (mapcar 'car selection-converter-alist)))
181 (cond ((memq (car rest) (cdr rest))
182 (setcdr rest (delq (car rest) (cdr rest))))
183 ((eq (car (cdr rest)) '_EMACS_INTERNAL) ; shh, it's a secret
184 (setcdr rest (cdr (cdr rest))))
186 (setq rest (cdr rest)))))
187 (apply 'vector all)))
189 (defun xselect-convert-to-delete (selection type value)
190 (x-disown-selection-internal selection)
191 ;; A return value of nil means that we do not know how to do this conversion,
192 ;; and replies with an "error". A return value of NULL means that we have
193 ;; done the conversion (and any side-effects) but have no value to return.
196 (defun xselect-convert-to-filename (selection type value)
197 (cond ((overlayp value)
198 (buffer-file-name (or (overlay-buffer value)
199 (error "selection is in a killed buffer"))))
201 (markerp (car value))
202 (markerp (cdr value)))
203 (buffer-file-name (or (marker-buffer (car value))
204 (error "selection is in a killed buffer"))))
207 (defun xselect-convert-to-charpos (selection type value)
209 (cond ((cond ((overlayp value)
210 (setq a (overlay-start value)
211 b (overlay-end value)))
213 (markerp (car value))
214 (markerp (cdr value)))
217 (setq a (1- a) b (1- b)) ; zero-based
218 (if (< b a) (setq tmp a a b b tmp))
220 (vector (cons (ash a -16) (logand a 65535))
221 (cons (ash b -16) (logand b 65535))))))))
223 (defun xselect-convert-to-lineno (selection type value)
225 (cond ((cond ((and (consp value)
226 (markerp (car value))
227 (markerp (cdr value)))
228 (setq a (marker-position (car value))
229 b (marker-position (cdr value))
230 buf (marker-buffer (car value))))
232 (setq buf (overlay-buffer value)
233 a (overlay-start value)
234 b (overlay-end value)))
238 (setq a (count-lines 1 a)
239 b (count-lines 1 b)))
240 (if (< b a) (setq tmp a a b b tmp))
242 (vector (cons (ash a -16) (logand a 65535))
243 (cons (ash b -16) (logand b 65535))))))))
245 (defun xselect-convert-to-colno (selection type value)
247 (cond ((cond ((and (consp value)
248 (markerp (car value))
249 (markerp (cdr value)))
252 buf (marker-buffer a)))
254 (setq buf (overlay-buffer value)
255 a (overlay-start value)
256 b (overlay-end value)))
261 (setq a (current-column))
263 (setq b (current-column)))
264 (if (< b a) (setq tmp a a b b tmp))
266 (vector (cons (ash a -16) (logand a 65535))
267 (cons (ash b -16) (logand b 65535))))))))
269 (defun xselect-convert-to-os (selection type size)
270 (symbol-name system-type))
272 (defun xselect-convert-to-host (selection type size)
275 (defun xselect-convert-to-user (selection type size)
278 (defun xselect-convert-to-class (selection type size)
279 "Convert selection to class.
280 This function returns the string \"Emacs\"."
283 ;; We do not try to determine the name Emacs was invoked with,
284 ;; because it is not clean for a program's behavior to depend on that.
285 (defun xselect-convert-to-name (selection type size)
286 "Convert selection to name.
287 This function returns the string \"emacs\"."
290 (defun xselect-convert-to-integer (selection type value)
291 (and (integerp value)
292 (cons (ash value -16) (logand value 65535))))
294 (defun xselect-convert-to-atom (selection type value)
295 (and (symbolp value) value))
297 (defun xselect-convert-to-identity (selection type value) ; used internally
300 (setq selection-converter-alist
301 '((TEXT . xselect-convert-to-string)
302 (COMPOUND_TEXT . xselect-convert-to-string)
303 (STRING . xselect-convert-to-string)
304 (TARGETS . xselect-convert-to-targets)
305 (LENGTH . xselect-convert-to-length)
306 (DELETE . xselect-convert-to-delete)
307 (FILE_NAME . xselect-convert-to-filename)
308 (CHARACTER_POSITION . xselect-convert-to-charpos)
309 (LINE_NUMBER . xselect-convert-to-lineno)
310 (COLUMN_NUMBER . xselect-convert-to-colno)
311 (OWNER_OS . xselect-convert-to-os)
312 (HOST_NAME . xselect-convert-to-host)
313 (USER . xselect-convert-to-user)
314 (CLASS . xselect-convert-to-class)
315 (NAME . xselect-convert-to-name)
316 (ATOM . xselect-convert-to-atom)
317 (INTEGER . xselect-convert-to-integer)
318 (_EMACS_INTERNAL . xselect-convert-to-identity)
323 ;;; select.el ends here