Mercurial > emacs
annotate lisp/select.el @ 41800:2d1098174c8a
Doc fixes.
author | Pavel Janík <Pavel@Janik.cz> |
---|---|
date | Mon, 03 Dec 2001 06:11:37 +0000 |
parents | 67b464da13ec |
children | fd3c70d7a093 |
rev | line source |
---|---|
38414
67b464da13ec
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
33914
diff
changeset
|
1 ;;; select.el --- lisp portion of standard selection support |
2234 | 2 |
3 ;; Keywords: internal | |
4 | |
7300 | 5 ;; Copyright (c) 1993, 1994 Free Software Foundation, Inc. |
2234 | 6 ;; Based partially on earlier release by Lucid. |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
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) | |
13 ;; any later version. | |
14 | |
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. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
14169 | 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. | |
2234 | 24 |
38414
67b464da13ec
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
33914
diff
changeset
|
25 ;;; Commentary: |
67b464da13ec
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
33914
diff
changeset
|
26 |
2234 | 27 ;;; Code: |
28 | |
29 ;; This is for temporary compatibility with pre-release Emacs 19. | |
2571
b65cf676a09b
All fsets changed to defaliases.
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2234
diff
changeset
|
30 (defalias 'x-selection 'x-get-selection) |
2234 | 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, | |
19142
fffebc19fe53
(x-get-selection): Change default for data-type
Richard M. Stallman <rms@gnu.org>
parents:
17012
diff
changeset
|
34 and the argument DATA-TYPE (default `STRING') says |
33914
5876bde45199
(x-get-selection): Docstring dix.
Eli Zaretskii <eliz@gnu.org>
parents:
26423
diff
changeset
|
35 how to convert the data. |
5876bde45199
(x-get-selection): Docstring dix.
Eli Zaretskii <eliz@gnu.org>
parents:
26423
diff
changeset
|
36 |
5876bde45199
(x-get-selection): Docstring dix.
Eli Zaretskii <eliz@gnu.org>
parents:
26423
diff
changeset
|
37 TYPE may be `SECONDARY' or `CLIPBOARD', in addition to `PRIMARY'. |
5876bde45199
(x-get-selection): Docstring dix.
Eli Zaretskii <eliz@gnu.org>
parents:
26423
diff
changeset
|
38 DATA-TYPE is usually `STRING', but can also be one of the symbols |
5876bde45199
(x-get-selection): Docstring dix.
Eli Zaretskii <eliz@gnu.org>
parents:
26423
diff
changeset
|
39 in `selection-converter-alist', which see." |
19142
fffebc19fe53
(x-get-selection): Change default for data-type
Richard M. Stallman <rms@gnu.org>
parents:
17012
diff
changeset
|
40 (x-get-selection-internal (or type 'PRIMARY) (or data-type 'STRING))) |
2234 | 41 |
42 (defun x-get-clipboard () | |
43 "Return text pasted to the clipboard." | |
44 (x-get-selection-internal 'CLIPBOARD 'STRING)) | |
45 | |
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, | |
11406
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
50 a symbol, an integer (or a cons of two integers or list of two integers). |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
51 |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
52 The selection may also be a cons of two markers pointing to the same buffer, |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
53 or an overlay. In these cases, the selection is considered to be the text |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
54 between the markers *at whatever time the selection is examined*. |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
55 Thus, editing done in the buffer after you specify the selection |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
56 can alter the effective value of the selection. |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
57 |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
58 The data may also be a vector of valid non-vector selection values. |
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
59 |
26423
73efdb6af008
(x-set-selection): Call buffer-substring, not
Gerd Moellmann <gerd@gnu.org>
parents:
19142
diff
changeset
|
60 Interactively, the text of the region is used as the selection value |
73efdb6af008
(x-set-selection): Call buffer-substring, not
Gerd Moellmann <gerd@gnu.org>
parents:
19142
diff
changeset
|
61 if the prefix arg is set." |
2234 | 62 (interactive (if (not current-prefix-arg) |
11406
dc4b96a8dc2e
(x-set-selection): Fix up interactive defaults.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
63 (list 'PRIMARY (read-string "Set text for pasting: ")) |
26423
73efdb6af008
(x-set-selection): Call buffer-substring, not
Gerd Moellmann <gerd@gnu.org>
parents:
19142
diff
changeset
|
64 (list 'PRIMARY (buffer-substring (region-beginning) (region-end))))) |
2234 | 65 ;; This is for temporary compatibility with pre-release Emacs 19. |
66 (if (stringp type) | |
67 (setq type (intern type))) | |
68 (or (x-valid-simple-selection-p data) | |
69 (and (vectorp data) | |
70 (let ((valid t) | |
71 (i (1- (length data)))) | |
72 (while (>= i 0) | |
73 (or (x-valid-simple-selection-p (aref data i)) | |
74 (setq valid nil)) | |
75 (setq i (1- i))) | |
76 valid)) | |
77 (signal 'error (list "invalid selection" data))) | |
78 (or type (setq type 'PRIMARY)) | |
79 (if data | |
80 (x-own-selection-internal type data) | |
81 (x-disown-selection-internal type)) | |
82 data) | |
83 | |
84 (defun x-valid-simple-selection-p (data) | |
85 (or (stringp data) | |
86 (symbolp data) | |
87 (integerp data) | |
88 (and (consp data) | |
89 (integerp (car data)) | |
90 (or (integerp (cdr data)) | |
91 (and (consp (cdr data)) | |
92 (integerp (car (cdr data)))))) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
93 (overlayp data) |
2234 | 94 (and (consp data) |
95 (markerp (car data)) | |
96 (markerp (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)))))) | |
103 | |
104 ;;; Cut Buffer support | |
105 | |
106 (defun x-get-cut-buffer (&optional which-one) | |
107 "Returns the value of one of the 8 X server cut-buffers. Optional arg | |
108 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 | |
111 (if which-one | |
112 (aref [CUT_BUFFER0 CUT_BUFFER1 CUT_BUFFER2 CUT_BUFFER3 | |
113 CUT_BUFFER4 CUT_BUFFER5 CUT_BUFFER6 CUT_BUFFER7] | |
114 which-one) | |
115 'CUT_BUFFER0))) | |
116 | |
3035
5c758290ba6c
(x-set-cut-buffer): New arg PUSH.
Richard M. Stallman <rms@gnu.org>
parents:
2879
diff
changeset
|
117 (defun x-set-cut-buffer (string &optional push) |
2234 | 118 "Store STRING into the X server's primary cut buffer. |
3035
5c758290ba6c
(x-set-cut-buffer): New arg PUSH.
Richard M. Stallman <rms@gnu.org>
parents:
2879
diff
changeset
|
119 If PUSH is non-nil, also rotate the cut buffers: |
5c758290ba6c
(x-set-cut-buffer): New arg PUSH.
Richard M. Stallman <rms@gnu.org>
parents:
2879
diff
changeset
|
120 this means the previous value of the primary cut buffer moves the second |
2234 | 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) | |
3035
5c758290ba6c
(x-set-cut-buffer): New arg PUSH.
Richard M. Stallman <rms@gnu.org>
parents:
2879
diff
changeset
|
125 (if push |
5c758290ba6c
(x-set-cut-buffer): New arg PUSH.
Richard M. Stallman <rms@gnu.org>
parents:
2879
diff
changeset
|
126 (x-rotate-cut-buffers-internal 1)) |
2234 | 127 (x-store-cut-buffer-internal 'CUT_BUFFER0 string)) |
128 | |
129 | |
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. | |
133 | |
134 (defun xselect-convert-to-string (selection type value) | |
135 (cond ((stringp value) | |
136 value) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
137 ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
138 (save-excursion |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
139 (or (buffer-name (overlay-buffer value)) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
140 (error "selection is in a killed buffer")) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
141 (set-buffer (overlay-buffer value)) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
142 (buffer-substring (overlay-start value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
143 (overlay-end value)))) |
2234 | 144 ((and (consp value) |
145 (markerp (car value)) | |
146 (markerp (cdr value))) | |
147 (or (eq (marker-buffer (car value)) (marker-buffer (cdr value))) | |
148 (signal 'error | |
149 (list "markers must be in the same buffer" | |
150 (car value) (cdr value)))) | |
151 (save-excursion | |
152 (set-buffer (or (marker-buffer (car value)) | |
153 (error "selection is in a killed buffer"))) | |
154 (buffer-substring (car value) (cdr value)))) | |
155 (t nil))) | |
156 | |
157 (defun xselect-convert-to-length (selection type value) | |
158 (let ((value | |
159 (cond ((stringp value) | |
160 (length value)) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
161 ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
162 (abs (- (overlay-end value) (overlay-start value)))) |
2234 | 163 ((and (consp value) |
164 (markerp (car value)) | |
165 (markerp (cdr value))) | |
166 (or (eq (marker-buffer (car value)) | |
167 (marker-buffer (cdr value))) | |
168 (signal 'error | |
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)) | |
174 nil))) | |
175 | |
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))) | |
179 (rest all)) | |
180 (while rest | |
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)))) | |
185 (t | |
186 (setq rest (cdr rest))))) | |
187 (apply 'vector all))) | |
188 | |
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. | |
194 'NULL) | |
195 | |
196 (defun xselect-convert-to-filename (selection type value) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
197 (cond ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
198 (buffer-file-name (or (overlay-buffer value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
199 (error "selection is in a killed buffer")))) |
2234 | 200 ((and (consp value) |
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")))) | |
205 (t nil))) | |
206 | |
207 (defun xselect-convert-to-charpos (selection type value) | |
208 (let (a b tmp) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
209 (cond ((cond ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
210 (setq a (overlay-start value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
211 b (overlay-end value))) |
2234 | 212 ((and (consp value) |
213 (markerp (car value)) | |
214 (markerp (cdr value))) | |
215 (setq a (car value) | |
216 b (cdr value)))) | |
217 (setq a (1- a) b (1- b)) ; zero-based | |
218 (if (< b a) (setq tmp a a b b tmp)) | |
219 (cons 'SPAN | |
220 (vector (cons (ash a -16) (logand a 65535)) | |
221 (cons (ash b -16) (logand b 65535)))))))) | |
222 | |
223 (defun xselect-convert-to-lineno (selection type value) | |
224 (let (a b buf tmp) | |
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)))) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
231 ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
232 (setq buf (overlay-buffer value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
233 a (overlay-start value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
234 b (overlay-end value))) |
2234 | 235 ) |
236 (save-excursion | |
237 (set-buffer buf) | |
238 (setq a (count-lines 1 a) | |
239 b (count-lines 1 b))) | |
240 (if (< b a) (setq tmp a a b b tmp)) | |
241 (cons 'SPAN | |
242 (vector (cons (ash a -16) (logand a 65535)) | |
243 (cons (ash b -16) (logand b 65535)))))))) | |
244 | |
245 (defun xselect-convert-to-colno (selection type value) | |
246 (let (a b buf tmp) | |
247 (cond ((cond ((and (consp value) | |
248 (markerp (car value)) | |
249 (markerp (cdr value))) | |
250 (setq a (car value) | |
251 b (cdr value) | |
252 buf (marker-buffer a))) | |
6442
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
253 ((overlayp value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
254 (setq buf (overlay-buffer value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
255 a (overlay-start value) |
c81cfdffcf49
(x-valid-simple-selection-p): Accept an overlay.
Richard M. Stallman <rms@gnu.org>
parents:
3035
diff
changeset
|
256 b (overlay-end value))) |
2234 | 257 ) |
258 (save-excursion | |
259 (set-buffer buf) | |
260 (goto-char a) | |
261 (setq a (current-column)) | |
262 (goto-char b) | |
263 (setq b (current-column))) | |
264 (if (< b a) (setq tmp a a b b tmp)) | |
265 (cons 'SPAN | |
266 (vector (cons (ash a -16) (logand a 65535)) | |
267 (cons (ash b -16) (logand b 65535)))))))) | |
268 | |
269 (defun xselect-convert-to-os (selection type size) | |
270 (symbol-name system-type)) | |
271 | |
272 (defun xselect-convert-to-host (selection type size) | |
273 (system-name)) | |
274 | |
275 (defun xselect-convert-to-user (selection type size) | |
276 (user-full-name)) | |
277 | |
278 (defun xselect-convert-to-class (selection type size) | |
2879
48dd9b2361df
* select.el (xselect-convert-to-class): Just return "Emacs" here.
Jim Blandy <jimb@redhat.com>
parents:
2571
diff
changeset
|
279 "Emacs") |
2234 | 280 |
281 ;; We do not try to determine the name Emacs was invoked with, | |
282 ;; because it is not clean for a program's behavior to depend on that. | |
283 (defun xselect-convert-to-name (selection type size) | |
284 "emacs") | |
285 | |
286 (defun xselect-convert-to-integer (selection type value) | |
287 (and (integerp value) | |
288 (cons (ash value -16) (logand value 65535)))) | |
289 | |
290 (defun xselect-convert-to-atom (selection type value) | |
291 (and (symbolp value) value)) | |
292 | |
293 (defun xselect-convert-to-identity (selection type value) ; used internally | |
294 (vector value)) | |
295 | |
296 (setq selection-converter-alist | |
297 '((TEXT . xselect-convert-to-string) | |
17012
f1932b36f01d
(x-get-selection): Set default data-type of selection
Karl Heuer <kwzh@gnu.org>
parents:
14169
diff
changeset
|
298 (COMPOUND_TEXT . xselect-convert-to-string) |
2234 | 299 (STRING . xselect-convert-to-string) |
300 (TARGETS . xselect-convert-to-targets) | |
301 (LENGTH . xselect-convert-to-length) | |
302 (DELETE . xselect-convert-to-delete) | |
303 (FILE_NAME . xselect-convert-to-filename) | |
304 (CHARACTER_POSITION . xselect-convert-to-charpos) | |
305 (LINE_NUMBER . xselect-convert-to-lineno) | |
306 (COLUMN_NUMBER . xselect-convert-to-colno) | |
307 (OWNER_OS . xselect-convert-to-os) | |
308 (HOST_NAME . xselect-convert-to-host) | |
309 (USER . xselect-convert-to-user) | |
310 (CLASS . xselect-convert-to-class) | |
311 (NAME . xselect-convert-to-name) | |
312 (ATOM . xselect-convert-to-atom) | |
313 (INTEGER . xselect-convert-to-integer) | |
314 (_EMACS_INTERNAL . xselect-convert-to-identity) | |
315 )) | |
316 | |
317 (provide 'select) | |
318 | |
38414
67b464da13ec
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
33914
diff
changeset
|
319 ;;; select.el ends here |