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 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 ;; Check the data type of STRING.
125 (substring string
0 0)
127 (x-rotate-cut-buffers-internal 1))
128 (x-store-cut-buffer-internal 'CUT_BUFFER0 string
))
131 ;;; Functions to convert the selection into various other selection types.
132 ;;; Every selection type that Emacs handles is implemented this way, except
133 ;;; for TIMESTAMP, which is a special case.
135 (defun xselect-convert-to-string (selection type value
)
136 (cond ((stringp value
)
140 (or (buffer-name (overlay-buffer value
))
141 (error "selection is in a killed buffer"))
142 (set-buffer (overlay-buffer value
))
143 (buffer-substring (overlay-start value
)
144 (overlay-end value
))))
146 (markerp (car value
))
147 (markerp (cdr value
)))
148 (or (eq (marker-buffer (car value
)) (marker-buffer (cdr value
)))
150 (list "markers must be in the same buffer"
151 (car value
) (cdr value
))))
153 (set-buffer (or (marker-buffer (car value
))
154 (error "selection is in a killed buffer")))
155 (buffer-substring (car value
) (cdr value
))))
158 (defun xselect-convert-to-length (selection type value
)
160 (cond ((stringp value
)
163 (abs (- (overlay-end value
) (overlay-start value
))))
165 (markerp (car value
))
166 (markerp (cdr value
)))
167 (or (eq (marker-buffer (car value
))
168 (marker-buffer (cdr value
)))
170 (list "markers must be in the same buffer"
171 (car value
) (cdr value
))))
172 (abs (- (car value
) (cdr value
)))))))
173 (if value
; force it to be in 32-bit format.
174 (cons (ash value -
16) (logand value
65535))
177 (defun xselect-convert-to-targets (selection type value
)
178 ;; return a vector of atoms, but remove duplicates first.
179 (let* ((all (cons 'TIMESTAMP
(mapcar 'car selection-converter-alist
)))
182 (cond ((memq (car rest
) (cdr rest
))
183 (setcdr rest
(delq (car rest
) (cdr rest
))))
184 ((eq (car (cdr rest
)) '_EMACS_INTERNAL
) ; shh, it's a secret
185 (setcdr rest
(cdr (cdr rest
))))
187 (setq rest
(cdr rest
)))))
188 (apply 'vector all
)))
190 (defun xselect-convert-to-delete (selection type value
)
191 (x-disown-selection-internal selection
)
192 ;; A return value of nil means that we do not know how to do this conversion,
193 ;; and replies with an "error". A return value of NULL means that we have
194 ;; done the conversion (and any side-effects) but have no value to return.
197 (defun xselect-convert-to-filename (selection type value
)
198 (cond ((overlayp value
)
199 (buffer-file-name (or (overlay-buffer value
)
200 (error "selection is in a killed buffer"))))
202 (markerp (car value
))
203 (markerp (cdr value
)))
204 (buffer-file-name (or (marker-buffer (car value
))
205 (error "selection is in a killed buffer"))))
208 (defun xselect-convert-to-charpos (selection type value
)
210 (cond ((cond ((overlayp value
)
211 (setq a
(overlay-start value
)
212 b
(overlay-end value
)))
214 (markerp (car value
))
215 (markerp (cdr value
)))
218 (setq a
(1- a
) b
(1- b
)) ; zero-based
219 (if (< b a
) (setq tmp a a b b tmp
))
221 (vector (cons (ash a -
16) (logand a
65535))
222 (cons (ash b -
16) (logand b
65535))))))))
224 (defun xselect-convert-to-lineno (selection type value
)
226 (cond ((cond ((and (consp value
)
227 (markerp (car value
))
228 (markerp (cdr value
)))
229 (setq a
(marker-position (car value
))
230 b
(marker-position (cdr value
))
231 buf
(marker-buffer (car value
))))
233 (setq buf
(overlay-buffer value
)
234 a
(overlay-start value
)
235 b
(overlay-end value
)))
239 (setq a
(count-lines 1 a
)
240 b
(count-lines 1 b
)))
241 (if (< b a
) (setq tmp a a b b tmp
))
243 (vector (cons (ash a -
16) (logand a
65535))
244 (cons (ash b -
16) (logand b
65535))))))))
246 (defun xselect-convert-to-colno (selection type value
)
248 (cond ((cond ((and (consp value
)
249 (markerp (car value
))
250 (markerp (cdr value
)))
253 buf
(marker-buffer a
)))
255 (setq buf
(overlay-buffer value
)
256 a
(overlay-start value
)
257 b
(overlay-end value
)))
262 (setq a
(current-column))
264 (setq b
(current-column)))
265 (if (< b a
) (setq tmp a a b b tmp
))
267 (vector (cons (ash a -
16) (logand a
65535))
268 (cons (ash b -
16) (logand b
65535))))))))
270 (defun xselect-convert-to-os (selection type size
)
271 (symbol-name system-type
))
273 (defun xselect-convert-to-host (selection type size
)
276 (defun xselect-convert-to-user (selection type size
)
279 (defun xselect-convert-to-class (selection type size
)
280 "Convert selection to class.
281 This function returns the string \"Emacs\"."
284 ;; We do not try to determine the name Emacs was invoked with,
285 ;; because it is not clean for a program's behavior to depend on that.
286 (defun xselect-convert-to-name (selection type size
)
287 "Convert selection to name.
288 This function returns the string \"emacs\"."
291 (defun xselect-convert-to-integer (selection type value
)
292 (and (integerp value
)
293 (cons (ash value -
16) (logand value
65535))))
295 (defun xselect-convert-to-atom (selection type value
)
296 (and (symbolp value
) value
))
298 (defun xselect-convert-to-identity (selection type value
) ; used internally
301 (setq selection-converter-alist
302 '((TEXT . xselect-convert-to-string
)
303 (COMPOUND_TEXT . xselect-convert-to-string
)
304 (STRING . xselect-convert-to-string
)
305 (TARGETS . xselect-convert-to-targets
)
306 (LENGTH . xselect-convert-to-length
)
307 (DELETE . xselect-convert-to-delete
)
308 (FILE_NAME . xselect-convert-to-filename
)
309 (CHARACTER_POSITION . xselect-convert-to-charpos
)
310 (LINE_NUMBER . xselect-convert-to-lineno
)
311 (COLUMN_NUMBER . xselect-convert-to-colno
)
312 (OWNER_OS . xselect-convert-to-os
)
313 (HOST_NAME . xselect-convert-to-host
)
314 (USER . xselect-convert-to-user
)
315 (CLASS . xselect-convert-to-class
)
316 (NAME . xselect-convert-to-name
)
317 (ATOM . xselect-convert-to-atom
)
318 (INTEGER . xselect-convert-to-integer
)
319 (_EMACS_INTERNAL . xselect-convert-to-identity
)
324 ;;; select.el ends here