Commit | Line | Data |
---|---|---|
c88ab9ce | 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
630cc463 | 2 | |
b578f267 | 3 | ;; Copyright (C) 1985, 1986, 1992, 1994, 1995 Free Software Foundation, Inc. |
be9b65ac DL |
4 | |
5 | ;; This file is part of GNU Emacs. | |
6 | ||
7 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
8 | ;; it under the terms of the GNU General Public License as published by | |
492878e4 | 9 | ;; the Free Software Foundation; either version 2, or (at your option) |
be9b65ac DL |
10 | ;; any later version. |
11 | ||
12 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | ;; GNU General Public License for more details. | |
16 | ||
17 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
18 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
19 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
20 | ;; Boston, MA 02111-1307, USA. | |
be9b65ac | 21 | |
630cc463 | 22 | ;;; Code: |
77a5664f RS |
23 | (defvar custom-declare-variable-list nil |
24 | "Record `defcustom' calls made before `custom.el' is loaded to handle them. | |
25 | Each element of this list holds the arguments to one call to `defcustom'.") | |
26 | ||
68e3e5f5 | 27 | ;; Use this, rather than defcustom, in subr.el and other files loaded |
77a5664f RS |
28 | ;; before custom.el. |
29 | (defun custom-declare-variable-early (&rest arguments) | |
30 | (setq custom-declare-variable-list | |
31 | (cons arguments custom-declare-variable-list))) | |
9a5336ae JB |
32 | \f |
33 | ;;;; Lisp language features. | |
34 | ||
35 | (defmacro lambda (&rest cdr) | |
36 | "Return a lambda expression. | |
37 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
38 | self-quoting; the result of evaluating the lambda expression is the | |
39 | expression itself. The lambda expression may then be treated as a | |
bec0d7f9 RS |
40 | function, i.e., stored as the function value of a symbol, passed to |
41 | funcall or mapcar, etc. | |
42 | ||
9a5336ae | 43 | ARGS should take the same form as an argument list for a `defun'. |
8fd68088 RS |
44 | DOCSTRING is an optional documentation string. |
45 | If present, it should describe how to call the function. | |
46 | But documentation strings are usually not useful in nameless functions. | |
9a5336ae JB |
47 | INTERACTIVE should be a call to the function `interactive', which see. |
48 | It may also be omitted. | |
49 | BODY should be a list of lisp expressions." | |
50 | ;; Note that this definition should not use backquotes; subr.el should not | |
51 | ;; depend on backquote.el. | |
52 | (list 'function (cons 'lambda cdr))) | |
53 | ||
debff3c3 RS |
54 | (defmacro when (cond &rest body) |
55 | "(when COND BODY...): if COND yields non-nil, do BODY, else return nil." | |
56 | (list 'if cond (cons 'progn body))) | |
11d431ad KH |
57 | (put 'when 'lisp-indent-function 1) |
58 | (put 'when 'edebug-form-spec '(&rest form)) | |
9a5336ae | 59 | |
debff3c3 RS |
60 | (defmacro unless (cond &rest body) |
61 | "(unless COND BODY...): if COND yields nil, do BODY, else return nil." | |
62 | (cons 'if (cons cond (cons nil body)))) | |
11d431ad KH |
63 | (put 'unless 'lisp-indent-function 1) |
64 | (put 'unless 'edebug-form-spec '(&rest form)) | |
d370591d RS |
65 | |
66 | (defsubst caar (x) | |
67 | "Return the car of the car of X." | |
68 | (car (car x))) | |
69 | ||
70 | (defsubst cadr (x) | |
71 | "Return the car of the cdr of X." | |
72 | (car (cdr x))) | |
73 | ||
74 | (defsubst cdar (x) | |
75 | "Return the cdr of the car of X." | |
76 | (cdr (car x))) | |
77 | ||
78 | (defsubst cddr (x) | |
79 | "Return the cdr of the cdr of X." | |
80 | (cdr (cdr x))) | |
e8c32c99 | 81 | |
369fba5f RS |
82 | (defun last (x &optional n) |
83 | "Return the last link of the list X. Its car is the last element. | |
84 | If X is nil, return nil. | |
85 | If N is non-nil, return the Nth-to-last link of X. | |
86 | If N is bigger than the length of X, return X." | |
87 | (if n | |
88 | (let ((m 0) (p x)) | |
89 | (while (consp p) | |
90 | (setq m (1+ m) p (cdr p))) | |
91 | (if (<= n 0) p | |
92 | (if (< n m) (nthcdr (- m n) x) x))) | |
93 | (while (cdr x) | |
94 | (setq x (cdr x))) | |
95 | x)) | |
526d204e | 96 | |
8a288450 RS |
97 | (defun assoc-default (key alist &optional test default) |
98 | "Find object KEY in a pseudo-alist ALIST. | |
99 | ALIST is a list of conses or objects. Each element (or the element's car, | |
100 | if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY). | |
101 | If that is non-nil, the element matches; | |
102 | then `assoc-default' returns the element's cdr, if it is a cons, | |
526d204e | 103 | or DEFAULT if the element is not a cons. |
8a288450 RS |
104 | |
105 | If no element matches, the value is nil. | |
106 | If TEST is omitted or nil, `equal' is used." | |
107 | (let (found (tail alist) value) | |
108 | (while (and tail (not found)) | |
109 | (let ((elt (car tail))) | |
110 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) | |
111 | (setq found t value (if (consp elt) (cdr elt) default)))) | |
112 | (setq tail (cdr tail))) | |
113 | value)) | |
9a5336ae | 114 | \f |
9a5336ae | 115 | ;;;; Keymap support. |
be9b65ac DL |
116 | |
117 | (defun undefined () | |
118 | (interactive) | |
119 | (ding)) | |
120 | ||
121 | ;Prevent the \{...} documentation construct | |
122 | ;from mentioning keys that run this command. | |
123 | (put 'undefined 'suppress-keymap t) | |
124 | ||
125 | (defun suppress-keymap (map &optional nodigits) | |
126 | "Make MAP override all normally self-inserting keys to be undefined. | |
127 | Normally, as an exception, digits and minus-sign are set to make prefix args, | |
128 | but optional second arg NODIGITS non-nil treats them like other chars." | |
80e7b471 | 129 | (substitute-key-definition 'self-insert-command 'undefined map global-map) |
be9b65ac DL |
130 | (or nodigits |
131 | (let (loop) | |
132 | (define-key map "-" 'negative-argument) | |
133 | ;; Make plain numbers do numeric args. | |
134 | (setq loop ?0) | |
135 | (while (<= loop ?9) | |
136 | (define-key map (char-to-string loop) 'digit-argument) | |
137 | (setq loop (1+ loop)))))) | |
138 | ||
be9b65ac DL |
139 | ;Moved to keymap.c |
140 | ;(defun copy-keymap (keymap) | |
141 | ; "Return a copy of KEYMAP" | |
142 | ; (while (not (keymapp keymap)) | |
143 | ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) | |
144 | ; (if (vectorp keymap) | |
145 | ; (copy-sequence keymap) | |
146 | ; (copy-alist keymap))) | |
147 | ||
f14dbba7 KH |
148 | (defvar key-substitution-in-progress nil |
149 | "Used internally by substitute-key-definition.") | |
150 | ||
7f2c2edd | 151 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
be9b65ac DL |
152 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
153 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
7f2c2edd RS |
154 | If optional fourth argument OLDMAP is specified, we redefine |
155 | in KEYMAP as NEWDEF those chars which are defined as OLDDEF in OLDMAP." | |
156 | (or prefix (setq prefix "")) | |
157 | (let* ((scan (or oldmap keymap)) | |
158 | (vec1 (vector nil)) | |
f14dbba7 KH |
159 | (prefix1 (vconcat prefix vec1)) |
160 | (key-substitution-in-progress | |
161 | (cons scan key-substitution-in-progress))) | |
7f2c2edd RS |
162 | ;; Scan OLDMAP, finding each char or event-symbol that |
163 | ;; has any definition, and act on it with hack-key. | |
164 | (while (consp scan) | |
165 | (if (consp (car scan)) | |
166 | (let ((char (car (car scan))) | |
167 | (defn (cdr (car scan)))) | |
168 | ;; The inside of this let duplicates exactly | |
169 | ;; the inside of the following let that handles array elements. | |
170 | (aset vec1 0 char) | |
171 | (aset prefix1 (length prefix) char) | |
44d798af | 172 | (let (inner-def skipped) |
7f2c2edd RS |
173 | ;; Skip past menu-prompt. |
174 | (while (stringp (car-safe defn)) | |
44d798af | 175 | (setq skipped (cons (car defn) skipped)) |
7f2c2edd | 176 | (setq defn (cdr defn))) |
e025dddf RS |
177 | ;; Skip past cached key-equivalence data for menu items. |
178 | (and (consp defn) (consp (car defn)) | |
179 | (setq defn (cdr defn))) | |
7f2c2edd | 180 | (setq inner-def defn) |
e025dddf | 181 | ;; Look past a symbol that names a keymap. |
7f2c2edd RS |
182 | (while (and (symbolp inner-def) |
183 | (fboundp inner-def)) | |
184 | (setq inner-def (symbol-function inner-def))) | |
328a37ec RS |
185 | (if (or (eq defn olddef) |
186 | ;; Compare with equal if definition is a key sequence. | |
187 | ;; That is useful for operating on function-key-map. | |
188 | (and (or (stringp defn) (vectorp defn)) | |
189 | (equal defn olddef))) | |
44d798af | 190 | (define-key keymap prefix1 (nconc (nreverse skipped) newdef)) |
f14dbba7 | 191 | (if (and (keymapp defn) |
350b7567 RS |
192 | ;; Avoid recursively scanning |
193 | ;; where KEYMAP does not have a submap. | |
afd9831b RS |
194 | (let ((elt (lookup-key keymap prefix1))) |
195 | (or (null elt) | |
196 | (keymapp elt))) | |
350b7567 | 197 | ;; Avoid recursively rescanning keymap being scanned. |
f14dbba7 KH |
198 | (not (memq inner-def |
199 | key-substitution-in-progress))) | |
e025dddf RS |
200 | ;; If this one isn't being scanned already, |
201 | ;; scan it now. | |
7f2c2edd RS |
202 | (substitute-key-definition olddef newdef keymap |
203 | inner-def | |
204 | prefix1))))) | |
916cc49f | 205 | (if (vectorp (car scan)) |
7f2c2edd RS |
206 | (let* ((array (car scan)) |
207 | (len (length array)) | |
208 | (i 0)) | |
209 | (while (< i len) | |
210 | (let ((char i) (defn (aref array i))) | |
211 | ;; The inside of this let duplicates exactly | |
212 | ;; the inside of the previous let. | |
213 | (aset vec1 0 char) | |
214 | (aset prefix1 (length prefix) char) | |
44d798af | 215 | (let (inner-def skipped) |
7f2c2edd RS |
216 | ;; Skip past menu-prompt. |
217 | (while (stringp (car-safe defn)) | |
44d798af | 218 | (setq skipped (cons (car defn) skipped)) |
7f2c2edd | 219 | (setq defn (cdr defn))) |
e025dddf RS |
220 | (and (consp defn) (consp (car defn)) |
221 | (setq defn (cdr defn))) | |
7f2c2edd RS |
222 | (setq inner-def defn) |
223 | (while (and (symbolp inner-def) | |
224 | (fboundp inner-def)) | |
225 | (setq inner-def (symbol-function inner-def))) | |
328a37ec RS |
226 | (if (or (eq defn olddef) |
227 | (and (or (stringp defn) (vectorp defn)) | |
228 | (equal defn olddef))) | |
44d798af RS |
229 | (define-key keymap prefix1 |
230 | (nconc (nreverse skipped) newdef)) | |
f14dbba7 | 231 | (if (and (keymapp defn) |
afd9831b RS |
232 | (let ((elt (lookup-key keymap prefix1))) |
233 | (or (null elt) | |
234 | (keymapp elt))) | |
f14dbba7 KH |
235 | (not (memq inner-def |
236 | key-substitution-in-progress))) | |
7f2c2edd RS |
237 | (substitute-key-definition olddef newdef keymap |
238 | inner-def | |
239 | prefix1))))) | |
97fd9abf RS |
240 | (setq i (1+ i)))) |
241 | (if (char-table-p (car scan)) | |
242 | (map-char-table | |
243 | (function (lambda (char defn) | |
244 | (let () | |
245 | ;; The inside of this let duplicates exactly | |
246 | ;; the inside of the previous let, | |
247 | ;; except that it uses set-char-table-range | |
248 | ;; instead of define-key. | |
249 | (aset vec1 0 char) | |
250 | (aset prefix1 (length prefix) char) | |
251 | (let (inner-def skipped) | |
252 | ;; Skip past menu-prompt. | |
253 | (while (stringp (car-safe defn)) | |
254 | (setq skipped (cons (car defn) skipped)) | |
255 | (setq defn (cdr defn))) | |
256 | (and (consp defn) (consp (car defn)) | |
257 | (setq defn (cdr defn))) | |
258 | (setq inner-def defn) | |
259 | (while (and (symbolp inner-def) | |
260 | (fboundp inner-def)) | |
261 | (setq inner-def (symbol-function inner-def))) | |
262 | (if (or (eq defn olddef) | |
263 | (and (or (stringp defn) (vectorp defn)) | |
264 | (equal defn olddef))) | |
9a5114ac RS |
265 | (define-key keymap prefix1 |
266 | (nconc (nreverse skipped) newdef)) | |
97fd9abf RS |
267 | (if (and (keymapp defn) |
268 | (let ((elt (lookup-key keymap prefix1))) | |
269 | (or (null elt) | |
270 | (keymapp elt))) | |
271 | (not (memq inner-def | |
272 | key-substitution-in-progress))) | |
273 | (substitute-key-definition olddef newdef keymap | |
274 | inner-def | |
275 | prefix1))))))) | |
276 | (car scan))))) | |
7f2c2edd | 277 | (setq scan (cdr scan))))) |
9a5336ae | 278 | |
06ae9cf2 | 279 | (defun define-key-after (keymap key definition after) |
4434d61b RS |
280 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
281 | This is like `define-key' except that the binding for KEY is placed | |
282 | just after the binding for the event AFTER, instead of at the beginning | |
c34a9d34 RS |
283 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
284 | \(like DEFINITION). | |
285 | ||
286 | If AFTER is t, the new binding goes at the end of the keymap. | |
287 | ||
9ed287b0 | 288 | KEY must contain just one event type--that is to say, it must be |
c34a9d34 RS |
289 | a string or vector of length 1. |
290 | ||
291 | The order of bindings in a keymap matters when it is used as a menu." | |
292 | ||
4434d61b RS |
293 | (or (keymapp keymap) |
294 | (signal 'wrong-type-argument (list 'keymapp keymap))) | |
ab375e6c | 295 | (if (> (length key) 1) |
626f67f3 | 296 | (error "multi-event key specified in `define-key-after'")) |
113d28a8 | 297 | (let ((tail keymap) done inserted |
4434d61b RS |
298 | (first (aref key 0))) |
299 | (while (and (not done) tail) | |
300 | ;; Delete any earlier bindings for the same key. | |
301 | (if (eq (car-safe (car (cdr tail))) first) | |
302 | (setcdr tail (cdr (cdr tail)))) | |
303 | ;; When we reach AFTER's binding, insert the new binding after. | |
304 | ;; If we reach an inherited keymap, insert just before that. | |
113d28a8 | 305 | ;; If we reach the end of this keymap, insert at the end. |
c34a9d34 RS |
306 | (if (or (and (eq (car-safe (car tail)) after) |
307 | (not (eq after t))) | |
113d28a8 RS |
308 | (eq (car (cdr tail)) 'keymap) |
309 | (null (cdr tail))) | |
4434d61b | 310 | (progn |
113d28a8 RS |
311 | ;; Stop the scan only if we find a parent keymap. |
312 | ;; Keep going past the inserted element | |
313 | ;; so we can delete any duplications that come later. | |
314 | (if (eq (car (cdr tail)) 'keymap) | |
315 | (setq done t)) | |
316 | ;; Don't insert more than once. | |
317 | (or inserted | |
318 | (setcdr tail (cons (cons (aref key 0) definition) (cdr tail)))) | |
319 | (setq inserted t))) | |
4434d61b RS |
320 | (setq tail (cdr tail))))) |
321 | ||
d128fe85 RS |
322 | (defmacro kbd (keys) |
323 | "Convert KEYS to the internal Emacs key representation. | |
324 | KEYS should be a string constant in the format used for | |
325 | saving keyboard macros (see `insert-kbd-macro')." | |
326 | (read-kbd-macro keys)) | |
327 | ||
8bed5e3d RS |
328 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
329 | ||
9a5336ae JB |
330 | (defun keyboard-translate (from to) |
331 | "Translate character FROM to TO at a low level. | |
332 | This function creates a `keyboard-translate-table' if necessary | |
333 | and then modifies one entry in it." | |
8bed5e3d RS |
334 | (or (char-table-p keyboard-translate-table) |
335 | (setq keyboard-translate-table | |
336 | (make-char-table 'keyboard-translate-table nil))) | |
9a5336ae JB |
337 | (aset keyboard-translate-table from to)) |
338 | ||
339 | \f | |
340 | ;;;; The global keymap tree. | |
341 | ||
342 | ;;; global-map, esc-map, and ctl-x-map have their values set up in | |
343 | ;;; keymap.c; we just give them docstrings here. | |
344 | ||
345 | (defvar global-map nil | |
346 | "Default global keymap mapping Emacs keyboard input into commands. | |
347 | The value is a keymap which is usually (but not necessarily) Emacs's | |
348 | global map.") | |
349 | ||
350 | (defvar esc-map nil | |
351 | "Default keymap for ESC (meta) commands. | |
352 | The normal global definition of the character ESC indirects to this keymap.") | |
353 | ||
354 | (defvar ctl-x-map nil | |
355 | "Default keymap for C-x commands. | |
356 | The normal global definition of the character C-x indirects to this keymap.") | |
357 | ||
358 | (defvar ctl-x-4-map (make-sparse-keymap) | |
359 | "Keymap for subcommands of C-x 4") | |
059184dd | 360 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
9a5336ae JB |
361 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
362 | ||
363 | (defvar ctl-x-5-map (make-sparse-keymap) | |
364 | "Keymap for frame commands.") | |
059184dd | 365 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
9a5336ae JB |
366 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
367 | ||
0f03054a | 368 | \f |
9a5336ae JB |
369 | ;;;; Event manipulation functions. |
370 | ||
da16e648 KH |
371 | ;; The call to `read' is to ensure that the value is computed at load time |
372 | ;; and not compiled into the .elc file. The value is negative on most | |
373 | ;; machines, but not on all! | |
374 | (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@"))) | |
114137b8 | 375 | |
cde6d7e3 RS |
376 | (defun listify-key-sequence (key) |
377 | "Convert a key sequence to a list of events." | |
378 | (if (vectorp key) | |
379 | (append key nil) | |
380 | (mapcar (function (lambda (c) | |
381 | (if (> c 127) | |
114137b8 | 382 | (logxor c listify-key-sequence-1) |
cde6d7e3 RS |
383 | c))) |
384 | (append key nil)))) | |
385 | ||
53e5a4e8 RS |
386 | (defsubst eventp (obj) |
387 | "True if the argument is an event object." | |
388 | (or (integerp obj) | |
389 | (and (symbolp obj) | |
390 | (get obj 'event-symbol-elements)) | |
391 | (and (consp obj) | |
392 | (symbolp (car obj)) | |
393 | (get (car obj) 'event-symbol-elements)))) | |
394 | ||
395 | (defun event-modifiers (event) | |
396 | "Returns a list of symbols representing the modifier keys in event EVENT. | |
397 | The elements of the list may include `meta', `control', | |
32295976 RS |
398 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
399 | and `down'." | |
53e5a4e8 RS |
400 | (let ((type event)) |
401 | (if (listp type) | |
402 | (setq type (car type))) | |
403 | (if (symbolp type) | |
404 | (cdr (get type 'event-symbol-elements)) | |
405 | (let ((list nil)) | |
da16e648 | 406 | (or (zerop (logand type ?\M-\^@)) |
53e5a4e8 | 407 | (setq list (cons 'meta list))) |
da16e648 | 408 | (or (and (zerop (logand type ?\C-\^@)) |
53e5a4e8 RS |
409 | (>= (logand type 127) 32)) |
410 | (setq list (cons 'control list))) | |
da16e648 | 411 | (or (and (zerop (logand type ?\S-\^@)) |
53e5a4e8 RS |
412 | (= (logand type 255) (downcase (logand type 255)))) |
413 | (setq list (cons 'shift list))) | |
da16e648 | 414 | (or (zerop (logand type ?\H-\^@)) |
53e5a4e8 | 415 | (setq list (cons 'hyper list))) |
da16e648 | 416 | (or (zerop (logand type ?\s-\^@)) |
53e5a4e8 | 417 | (setq list (cons 'super list))) |
da16e648 | 418 | (or (zerop (logand type ?\A-\^@)) |
53e5a4e8 RS |
419 | (setq list (cons 'alt list))) |
420 | list)))) | |
421 | ||
d63de416 RS |
422 | (defun event-basic-type (event) |
423 | "Returns the basic type of the given event (all modifiers removed). | |
424 | The value is an ASCII printing character (not upper case) or a symbol." | |
2b0f4ba5 JB |
425 | (if (consp event) |
426 | (setq event (car event))) | |
d63de416 RS |
427 | (if (symbolp event) |
428 | (car (get event 'event-symbol-elements)) | |
429 | (let ((base (logand event (1- (lsh 1 18))))) | |
430 | (downcase (if (< base 32) (logior base 64) base))))) | |
431 | ||
0f03054a RS |
432 | (defsubst mouse-movement-p (object) |
433 | "Return non-nil if OBJECT is a mouse movement event." | |
434 | (and (consp object) | |
435 | (eq (car object) 'mouse-movement))) | |
436 | ||
437 | (defsubst event-start (event) | |
438 | "Return the starting position of EVENT. | |
439 | If EVENT is a mouse press or a mouse click, this returns the location | |
440 | of the event. | |
441 | If EVENT is a drag, this returns the drag's starting position. | |
442 | The return value is of the form | |
e55c21be | 443 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
0f03054a RS |
444 | The `posn-' functions access elements of such lists." |
445 | (nth 1 event)) | |
446 | ||
447 | (defsubst event-end (event) | |
448 | "Return the ending location of EVENT. EVENT should be a click or drag event. | |
449 | If EVENT is a click event, this function is the same as `event-start'. | |
450 | The return value is of the form | |
e55c21be | 451 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
0f03054a | 452 | The `posn-' functions access elements of such lists." |
69b95560 | 453 | (nth (if (consp (nth 2 event)) 2 1) event)) |
0f03054a | 454 | |
32295976 RS |
455 | (defsubst event-click-count (event) |
456 | "Return the multi-click count of EVENT, a click or drag event. | |
457 | The return value is a positive integer." | |
458 | (if (integerp (nth 2 event)) (nth 2 event) 1)) | |
459 | ||
0f03054a RS |
460 | (defsubst posn-window (position) |
461 | "Return the window in POSITION. | |
462 | POSITION should be a list of the form | |
e55c21be | 463 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
0f03054a RS |
464 | as returned by the `event-start' and `event-end' functions." |
465 | (nth 0 position)) | |
466 | ||
467 | (defsubst posn-point (position) | |
468 | "Return the buffer location in POSITION. | |
469 | POSITION should be a list of the form | |
e55c21be | 470 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
0f03054a | 471 | as returned by the `event-start' and `event-end' functions." |
15db4e0e JB |
472 | (if (consp (nth 1 position)) |
473 | (car (nth 1 position)) | |
474 | (nth 1 position))) | |
0f03054a | 475 | |
e55c21be RS |
476 | (defsubst posn-x-y (position) |
477 | "Return the x and y coordinates in POSITION. | |
0f03054a | 478 | POSITION should be a list of the form |
e55c21be | 479 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
0f03054a RS |
480 | as returned by the `event-start' and `event-end' functions." |
481 | (nth 2 position)) | |
482 | ||
ed627e08 | 483 | (defun posn-col-row (position) |
dbbcac56 | 484 | "Return the column and row in POSITION, measured in characters. |
e55c21be RS |
485 | POSITION should be a list of the form |
486 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) | |
ed627e08 RS |
487 | as returned by the `event-start' and `event-end' functions. |
488 | For a scroll-bar event, the result column is 0, and the row | |
489 | corresponds to the vertical position of the click in the scroll bar." | |
490 | (let ((pair (nth 2 position)) | |
491 | (window (posn-window position))) | |
dbbcac56 KH |
492 | (if (eq (if (consp (nth 1 position)) |
493 | (car (nth 1 position)) | |
494 | (nth 1 position)) | |
ed627e08 RS |
495 | 'vertical-scroll-bar) |
496 | (cons 0 (scroll-bar-scale pair (1- (window-height window)))) | |
dbbcac56 KH |
497 | (if (eq (if (consp (nth 1 position)) |
498 | (car (nth 1 position)) | |
499 | (nth 1 position)) | |
ed627e08 RS |
500 | 'horizontal-scroll-bar) |
501 | (cons (scroll-bar-scale pair (window-width window)) 0) | |
9ba60df9 RS |
502 | (let* ((frame (if (framep window) window (window-frame window))) |
503 | (x (/ (car pair) (frame-char-width frame))) | |
504 | (y (/ (cdr pair) (frame-char-height frame)))) | |
ed627e08 | 505 | (cons x y)))))) |
e55c21be | 506 | |
0f03054a RS |
507 | (defsubst posn-timestamp (position) |
508 | "Return the timestamp of POSITION. | |
509 | POSITION should be a list of the form | |
e55c21be | 510 | (WINDOW BUFFER-POSITION (X . Y) TIMESTAMP) |
f415c00c | 511 | as returned by the `event-start' and `event-end' functions." |
0f03054a | 512 | (nth 3 position)) |
9a5336ae | 513 | |
0f03054a | 514 | \f |
9a5336ae JB |
515 | ;;;; Obsolescent names for functions. |
516 | ||
059184dd ER |
517 | (defalias 'dot 'point) |
518 | (defalias 'dot-marker 'point-marker) | |
519 | (defalias 'dot-min 'point-min) | |
520 | (defalias 'dot-max 'point-max) | |
521 | (defalias 'window-dot 'window-point) | |
522 | (defalias 'set-window-dot 'set-window-point) | |
523 | (defalias 'read-input 'read-string) | |
524 | (defalias 'send-string 'process-send-string) | |
525 | (defalias 'send-region 'process-send-region) | |
526 | (defalias 'show-buffer 'set-window-buffer) | |
527 | (defalias 'buffer-flush-undo 'buffer-disable-undo) | |
528 | (defalias 'eval-current-buffer 'eval-buffer) | |
529 | (defalias 'compiled-function-p 'byte-code-function-p) | |
ae1cc031 | 530 | (defalias 'define-function 'defalias) |
be9b65ac | 531 | |
0cba3a0f KH |
532 | (defalias 'sref 'aref) |
533 | (make-obsolete 'sref 'aref) | |
534 | (make-obsolete 'char-bytes "Now this function always returns 1") | |
6bb762b3 | 535 | |
9a5336ae JB |
536 | ;; Some programs still use this as a function. |
537 | (defun baud-rate () | |
bcacc42c RS |
538 | "Obsolete function returning the value of the `baud-rate' variable. |
539 | Please convert your programs to use the variable `baud-rate' directly." | |
9a5336ae JB |
540 | baud-rate) |
541 | ||
0a5c0893 MB |
542 | (defalias 'focus-frame 'ignore) |
543 | (defalias 'unfocus-frame 'ignore) | |
9a5336ae JB |
544 | \f |
545 | ;;;; Alternate names for functions - these are not being phased out. | |
546 | ||
059184dd ER |
547 | (defalias 'string= 'string-equal) |
548 | (defalias 'string< 'string-lessp) | |
549 | (defalias 'move-marker 'set-marker) | |
059184dd ER |
550 | (defalias 'not 'null) |
551 | (defalias 'rplaca 'setcar) | |
552 | (defalias 'rplacd 'setcdr) | |
eb8c3be9 | 553 | (defalias 'beep 'ding) ;preserve lingual purity |
059184dd ER |
554 | (defalias 'indent-to-column 'indent-to) |
555 | (defalias 'backward-delete-char 'delete-backward-char) | |
556 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) | |
557 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) | |
558 | (defalias 'int-to-string 'number-to-string) | |
024ae2c6 | 559 | (defalias 'store-match-data 'set-match-data) |
37f6661a JB |
560 | |
561 | ;;; Should this be an obsolete name? If you decide it should, you get | |
562 | ;;; to go through all the sources and change them. | |
059184dd | 563 | (defalias 'string-to-int 'string-to-number) |
be9b65ac | 564 | \f |
9a5336ae | 565 | ;;;; Hook manipulation functions. |
be9b65ac | 566 | |
0e4d378b RS |
567 | (defun make-local-hook (hook) |
568 | "Make the hook HOOK local to the current buffer. | |
569 | When a hook is local, its local and global values | |
570 | work in concert: running the hook actually runs all the hook | |
571 | functions listed in *either* the local value *or* the global value | |
572 | of the hook variable. | |
573 | ||
7dd1926e RS |
574 | This function works by making `t' a member of the buffer-local value, |
575 | which acts as a flag to run the hook functions in the default value as | |
576 | well. This works for all normal hooks, but does not work for most | |
577 | non-normal hooks yet. We will be changing the callers of non-normal | |
578 | hooks so that they can handle localness; this has to be done one by | |
579 | one. | |
580 | ||
581 | This function does nothing if HOOK is already local in the current | |
582 | buffer. | |
0e4d378b RS |
583 | |
584 | Do not use `make-local-variable' to make a hook variable buffer-local." | |
585 | (if (local-variable-p hook) | |
586 | nil | |
587 | (or (boundp hook) (set hook nil)) | |
588 | (make-local-variable hook) | |
589 | (set hook (list t)))) | |
590 | ||
591 | (defun add-hook (hook function &optional append local) | |
32295976 RS |
592 | "Add to the value of HOOK the function FUNCTION. |
593 | FUNCTION is not added if already present. | |
594 | FUNCTION is added (if necessary) at the beginning of the hook list | |
595 | unless the optional argument APPEND is non-nil, in which case | |
596 | FUNCTION is added at the end. | |
597 | ||
0e4d378b RS |
598 | The optional fourth argument, LOCAL, if non-nil, says to modify |
599 | the hook's buffer-local value rather than its default value. | |
600 | This makes no difference if the hook is not buffer-local. | |
601 | To make a hook variable buffer-local, always use | |
602 | `make-local-hook', not `make-local-variable'. | |
603 | ||
32295976 RS |
604 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
605 | HOOK is void, it is first set to nil. If HOOK's value is a single | |
aa09b5ca | 606 | function, it is changed to a list of functions." |
be9b65ac | 607 | (or (boundp hook) (set hook nil)) |
0e4d378b | 608 | (or (default-boundp hook) (set-default hook nil)) |
32295976 RS |
609 | ;; If the hook value is a single function, turn it into a list. |
610 | (let ((old (symbol-value hook))) | |
611 | (if (or (not (listp old)) (eq (car old) 'lambda)) | |
612 | (set hook (list old)))) | |
f4e5bca5 RS |
613 | (if (or local |
614 | ;; Detect the case where make-local-variable was used on a hook | |
615 | ;; and do what we used to do. | |
cd2db344 | 616 | (and (local-variable-if-set-p hook) |
f4e5bca5 | 617 | (not (memq t (symbol-value hook))))) |
0e4d378b | 618 | ;; Alter the local value only. |
1fa0de2c | 619 | (or (if (or (consp function) (byte-code-function-p function)) |
0e4d378b RS |
620 | (member function (symbol-value hook)) |
621 | (memq function (symbol-value hook))) | |
622 | (set hook | |
623 | (if append | |
624 | (append (symbol-value hook) (list function)) | |
625 | (cons function (symbol-value hook))))) | |
626 | ;; Alter the global value (which is also the only value, | |
627 | ;; if the hook doesn't have a local value). | |
1fa0de2c | 628 | (or (if (or (consp function) (byte-code-function-p function)) |
0e4d378b RS |
629 | (member function (default-value hook)) |
630 | (memq function (default-value hook))) | |
631 | (set-default hook | |
632 | (if append | |
633 | (append (default-value hook) (list function)) | |
634 | (cons function (default-value hook))))))) | |
635 | ||
636 | (defun remove-hook (hook function &optional local) | |
24980d16 RS |
637 | "Remove from the value of HOOK the function FUNCTION. |
638 | HOOK should be a symbol, and FUNCTION may be any valid function. If | |
639 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the | |
0e4d378b RS |
640 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
641 | ||
642 | The optional third argument, LOCAL, if non-nil, says to modify | |
643 | the hook's buffer-local value rather than its default value. | |
644 | This makes no difference if the hook is not buffer-local. | |
645 | To make a hook variable buffer-local, always use | |
646 | `make-local-hook', not `make-local-variable'." | |
24980d16 | 647 | (if (or (not (boundp hook)) ;unbound symbol, or |
d46490e3 | 648 | (not (default-boundp hook)) |
24980d16 RS |
649 | (null (symbol-value hook)) ;value is nil, or |
650 | (null function)) ;function is nil, then | |
651 | nil ;Do nothing. | |
f4e5bca5 RS |
652 | (if (or local |
653 | ;; Detect the case where make-local-variable was used on a hook | |
654 | ;; and do what we used to do. | |
655 | (and (local-variable-p hook) | |
cf4a60a3 DL |
656 | (consp (symbol-value hook)) |
657 | (not (memq t (symbol-value hook))))) | |
0e4d378b RS |
658 | (let ((hook-value (symbol-value hook))) |
659 | (if (consp hook-value) | |
660 | (if (member function hook-value) | |
661 | (setq hook-value (delete function (copy-sequence hook-value)))) | |
662 | (if (equal hook-value function) | |
663 | (setq hook-value nil))) | |
664 | (set hook hook-value)) | |
665 | (let ((hook-value (default-value hook))) | |
cf4a60a3 | 666 | (if (and (consp hook-value) (not (functionp hook-value))) |
0e4d378b RS |
667 | (if (member function hook-value) |
668 | (setq hook-value (delete function (copy-sequence hook-value)))) | |
669 | (if (equal hook-value function) | |
670 | (setq hook-value nil))) | |
671 | (set-default hook hook-value))))) | |
6e3af630 RS |
672 | |
673 | (defun add-to-list (list-var element) | |
8851c1f0 | 674 | "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. |
9f0b1f09 | 675 | The test for presence of ELEMENT is done with `equal'. |
8851c1f0 RS |
676 | If you want to use `add-to-list' on a variable that is not defined |
677 | until a certain package is loaded, you should put the call to `add-to-list' | |
678 | into a hook function that will be run only after loading the package. | |
679 | `eval-after-load' provides one way to do this. In some cases | |
680 | other hooks, such as major mode hooks, can do the job." | |
15171a06 KH |
681 | (if (member element (symbol-value list-var)) |
682 | (symbol-value list-var) | |
683 | (set list-var (cons element (symbol-value list-var))))) | |
be9b65ac | 684 | \f |
9a5336ae JB |
685 | ;;;; Specifying things to do after certain files are loaded. |
686 | ||
687 | (defun eval-after-load (file form) | |
688 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
689 | This makes or adds to an entry on `after-load-alist'. | |
90914938 | 690 | If FILE is already loaded, evaluate FORM right now. |
12c7071c | 691 | It does nothing if FORM is already on the list for FILE. |
9a5336ae | 692 | FILE should be the name of a library, with no directory name." |
90914938 | 693 | ;; Make sure there is an element for FILE. |
9a5336ae JB |
694 | (or (assoc file after-load-alist) |
695 | (setq after-load-alist (cons (list file) after-load-alist))) | |
90914938 | 696 | ;; Add FORM to the element if it isn't there. |
12c7071c RS |
697 | (let ((elt (assoc file after-load-alist))) |
698 | (or (member form (cdr elt)) | |
90914938 RS |
699 | (progn |
700 | (nconc elt (list form)) | |
701 | ;; If the file has been loaded already, run FORM right away. | |
702 | (and (assoc file load-history) | |
703 | (eval form))))) | |
9a5336ae JB |
704 | form) |
705 | ||
706 | (defun eval-next-after-load (file) | |
707 | "Read the following input sexp, and run it whenever FILE is loaded. | |
708 | This makes or adds to an entry on `after-load-alist'. | |
709 | FILE should be the name of a library, with no directory name." | |
710 | (eval-after-load file (read))) | |
711 | ||
712 | \f | |
713 | ;;;; Input and display facilities. | |
714 | ||
77a5664f | 715 | (defvar read-quoted-char-radix 8 |
1ba764de | 716 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
77a5664f RS |
717 | Legitimate radix values are 8, 10 and 16.") |
718 | ||
719 | (custom-declare-variable-early | |
720 | 'read-quoted-char-radix 8 | |
721 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. | |
1ba764de RS |
722 | Legitimate radix values are 8, 10 and 16." |
723 | :type '(choice (const 8) (const 10) (const 16)) | |
724 | :group 'editing-basics) | |
725 | ||
9a5336ae | 726 | (defun read-quoted-char (&optional prompt) |
2444730b RS |
727 | "Like `read-char', but do not allow quitting. |
728 | Also, if the first character read is an octal digit, | |
729 | we read any number of octal digits and return the | |
569b03f2 | 730 | specified character code. Any nondigit terminates the sequence. |
1ba764de | 731 | If the terminator is RET, it is discarded; |
2444730b RS |
732 | any other terminator is used itself as input. |
733 | ||
569b03f2 RS |
734 | The optional argument PROMPT specifies a string to use to prompt the user. |
735 | The variable `read-quoted-char-radix' controls which radix to use | |
736 | for numeric input." | |
2444730b RS |
737 | (let ((message-log-max nil) done (first t) (code 0) char) |
738 | (while (not done) | |
739 | (let ((inhibit-quit first) | |
42e636f0 KH |
740 | ;; Don't let C-h get the help message--only help function keys. |
741 | (help-char nil) | |
742 | (help-form | |
743 | "Type the special character you want to use, | |
2444730b | 744 | or the octal character code. |
1ba764de | 745 | RET terminates the character code and is discarded; |
2444730b | 746 | any other non-digit terminates the character code and is then used as input.")) |
b7de4d62 | 747 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
9a5336ae | 748 | (if inhibit-quit (setq quit-flag nil))) |
4867f7b2 RS |
749 | ;; Translate TAB key into control-I ASCII character, and so on. |
750 | (and char | |
751 | (let ((translated (lookup-key function-key-map (vector char)))) | |
bf896a1b | 752 | (if (arrayp translated) |
4867f7b2 | 753 | (setq char (aref translated 0))))) |
9a5336ae | 754 | (cond ((null char)) |
1ba764de RS |
755 | ((not (integerp char)) |
756 | (setq unread-command-events (list char) | |
757 | done t)) | |
bf896a1b RS |
758 | ((/= (logand char ?\M-\^@) 0) |
759 | ;; Turn a meta-character into a character with the 0200 bit set. | |
760 | (setq code (logior (logand char (lognot ?\M-\^@)) 128) | |
761 | done t)) | |
1ba764de RS |
762 | ((and (<= ?0 char) (< char (+ ?0 (min 10 read-quoted-char-radix)))) |
763 | (setq code (+ (* code read-quoted-char-radix) (- char ?0))) | |
764 | (and prompt (setq prompt (message "%s %c" prompt char)))) | |
765 | ((and (<= ?a (downcase char)) | |
766 | (< (downcase char) (+ ?a -10 (min 26 read-quoted-char-radix)))) | |
92304bc8 RS |
767 | (setq code (+ (* code read-quoted-char-radix) |
768 | (+ 10 (- (downcase char) ?a)))) | |
91a6acc3 | 769 | (and prompt (setq prompt (message "%s %c" prompt char)))) |
1ba764de | 770 | ((and (not first) (eq char ?\C-m)) |
2444730b RS |
771 | (setq done t)) |
772 | ((not first) | |
773 | (setq unread-command-events (list char) | |
774 | done t)) | |
775 | (t (setq code char | |
776 | done t))) | |
777 | (setq first nil)) | |
bf896a1b | 778 | code)) |
9a5336ae | 779 | |
44071d6b RS |
780 | (defun read-passwd (prompt &optional confirm default) |
781 | "Read a password, prompting with PROMPT. Echo `.' for each character typed. | |
e0e4cb7a | 782 | End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. |
44071d6b RS |
783 | Optional argument CONFIRM, if non-nil, then read it twice to make sure. |
784 | Optional DEFAULT is a default password to use instead of empty input." | |
785 | (if confirm | |
786 | (let (success) | |
787 | (while (not success) | |
788 | (let ((first (read-passwd prompt nil default)) | |
789 | (second (read-passwd "Confirm password: " nil default))) | |
790 | (if (equal first second) | |
791 | (setq success first) | |
792 | (message "Password not repeated accurately; please start over") | |
793 | (sit-for 1)))) | |
794 | success) | |
795 | (let ((pass nil) | |
796 | (c 0) | |
797 | (echo-keystrokes 0) | |
798 | (cursor-in-echo-area t)) | |
799 | (while (progn (message "%s%s" | |
800 | prompt | |
801 | (make-string (length pass) ?.)) | |
802 | (setq c (read-char)) | |
803 | (and (/= c ?\r) (/= c ?\n) (/= c ?\e))) | |
804 | (if (= c ?\C-u) | |
805 | (setq pass "") | |
806 | (if (and (/= c ?\b) (/= c ?\177)) | |
807 | (setq pass (concat pass (char-to-string c))) | |
808 | (if (> (length pass) 0) | |
809 | (setq pass (substring pass 0 -1)))))) | |
810 | (message nil) | |
811 | (or pass default "")))) | |
e0e4cb7a | 812 | \f |
9a5336ae JB |
813 | (defun force-mode-line-update (&optional all) |
814 | "Force the mode-line of the current buffer to be redisplayed. | |
7ec2a18c | 815 | With optional non-nil ALL, force redisplay of all mode-lines." |
9a5336ae JB |
816 | (if all (save-excursion (set-buffer (other-buffer)))) |
817 | (set-buffer-modified-p (buffer-modified-p))) | |
818 | ||
be9b65ac DL |
819 | (defun momentary-string-display (string pos &optional exit-char message) |
820 | "Momentarily display STRING in the buffer at POS. | |
821 | Display remains until next character is typed. | |
822 | If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; | |
823 | otherwise it is then available as input (as a command if nothing else). | |
824 | Display MESSAGE (optional fourth arg) in the echo area. | |
825 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
826 | (or exit-char (setq exit-char ?\ )) | |
827 | (let ((buffer-read-only nil) | |
ca2ec1c5 RS |
828 | ;; Don't modify the undo list at all. |
829 | (buffer-undo-list t) | |
be9b65ac DL |
830 | (modified (buffer-modified-p)) |
831 | (name buffer-file-name) | |
832 | insert-end) | |
833 | (unwind-protect | |
834 | (progn | |
835 | (save-excursion | |
836 | (goto-char pos) | |
837 | ;; defeat file locking... don't try this at home, kids! | |
838 | (setq buffer-file-name nil) | |
839 | (insert-before-markers string) | |
3eec84bf RS |
840 | (setq insert-end (point)) |
841 | ;; If the message end is off screen, recenter now. | |
024ae2c6 | 842 | (if (< (window-end nil t) insert-end) |
3eec84bf RS |
843 | (recenter (/ (window-height) 2))) |
844 | ;; If that pushed message start off the screen, | |
845 | ;; scroll to start it at the top of the screen. | |
846 | (move-to-window-line 0) | |
847 | (if (> (point) pos) | |
848 | (progn | |
849 | (goto-char pos) | |
850 | (recenter 0)))) | |
be9b65ac DL |
851 | (message (or message "Type %s to continue editing.") |
852 | (single-key-description exit-char)) | |
3547c855 | 853 | (let ((char (read-event))) |
be9b65ac | 854 | (or (eq char exit-char) |
dbc4e1c1 | 855 | (setq unread-command-events (list char))))) |
be9b65ac DL |
856 | (if insert-end |
857 | (save-excursion | |
858 | (delete-region pos insert-end))) | |
859 | (setq buffer-file-name name) | |
860 | (set-buffer-modified-p modified)))) | |
861 | ||
9a5336ae JB |
862 | \f |
863 | ;;;; Miscellanea. | |
864 | ||
448b61c9 RS |
865 | ;; A number of major modes set this locally. |
866 | ;; Give it a global value to avoid compiler warnings. | |
867 | (defvar font-lock-defaults nil) | |
868 | ||
4fb17037 RS |
869 | (defvar suspend-hook nil |
870 | "Normal hook run by `suspend-emacs', before suspending.") | |
871 | ||
872 | (defvar suspend-resume-hook nil | |
873 | "Normal hook run by `suspend-emacs', after Emacs is continued.") | |
874 | ||
448b61c9 RS |
875 | ;; Avoid compiler warnings about this variable, |
876 | ;; which has a special meaning on certain system types. | |
877 | (defvar buffer-file-type nil | |
878 | "Non-nil if the visited file is a binary file. | |
879 | This variable is meaningful on MS-DOG and Windows NT. | |
880 | On those systems, it is automatically local in every buffer. | |
881 | On other systems, this variable is normally always nil.") | |
882 | ||
a860d25f | 883 | ;; This should probably be written in C (i.e., without using `walk-windows'). |
63503b24 | 884 | (defun get-buffer-window-list (buffer &optional minibuf frame) |
a860d25f | 885 | "Return windows currently displaying BUFFER, or nil if none. |
63503b24 | 886 | See `walk-windows' for the meaning of MINIBUF and FRAME." |
43c5ac8c | 887 | (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows) |
a860d25f SM |
888 | (walk-windows (function (lambda (window) |
889 | (if (eq (window-buffer window) buffer) | |
890 | (setq windows (cons window windows))))) | |
63503b24 | 891 | minibuf frame) |
a860d25f SM |
892 | windows)) |
893 | ||
f9269e19 RS |
894 | (defun ignore (&rest ignore) |
895 | "Do nothing and return nil. | |
896 | This function accepts any number of arguments, but ignores them." | |
c0f1a4f6 | 897 | (interactive) |
9a5336ae JB |
898 | nil) |
899 | ||
900 | (defun error (&rest args) | |
aa308ce2 RS |
901 | "Signal an error, making error message by passing all args to `format'. |
902 | In Emacs, the convention is that error messages start with a capital | |
903 | letter but *do not* end with a period. Please follow this convention | |
904 | for the sake of consistency." | |
9a5336ae JB |
905 | (while t |
906 | (signal 'error (list (apply 'format args))))) | |
907 | ||
cef7ae6e | 908 | (defalias 'user-original-login-name 'user-login-name) |
9a5336ae | 909 | |
be9b65ac DL |
910 | (defun start-process-shell-command (name buffer &rest args) |
911 | "Start a program in a subprocess. Return the process object for it. | |
912 | Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. | |
913 | NAME is name for process. It is modified if necessary to make it unique. | |
914 | BUFFER is the buffer or (buffer-name) to associate with the process. | |
915 | Process output goes at end of that buffer, unless you specify | |
916 | an output stream or filter function to handle the output. | |
917 | BUFFER may be also nil, meaning that this process is not associated | |
918 | with any buffer | |
919 | Third arg is command name, the name of a shell command. | |
920 | Remaining arguments are the arguments for the command. | |
4f1d6310 | 921 | Wildcards and redirection are handled as usual in the shell." |
a247bf21 KH |
922 | (cond |
923 | ((eq system-type 'vax-vms) | |
924 | (apply 'start-process name buffer args)) | |
b59f6d7a RS |
925 | ;; We used to use `exec' to replace the shell with the command, |
926 | ;; but that failed to handle (...) and semicolon, etc. | |
a247bf21 KH |
927 | (t |
928 | (start-process name buffer shell-file-name shell-command-switch | |
b59f6d7a | 929 | (mapconcat 'identity args " "))))) |
a7ed4c2a | 930 | \f |
a7f284ec RS |
931 | (defmacro with-current-buffer (buffer &rest body) |
932 | "Execute the forms in BODY with BUFFER as the current buffer. | |
a2fdb55c EN |
933 | The value returned is the value of the last form in BODY. |
934 | See also `with-temp-buffer'." | |
a7f284ec RS |
935 | `(save-current-buffer |
936 | (set-buffer ,buffer) | |
a2fdb55c | 937 | ,@body)) |
a7f284ec | 938 | |
a7ed4c2a RS |
939 | (defmacro with-temp-file (file &rest forms) |
940 | "Create a new buffer, evaluate FORMS there, and write the buffer to FILE. | |
a2fdb55c EN |
941 | The value of the last form in FORMS is returned, like `progn'. |
942 | See also `with-temp-buffer'." | |
a7ed4c2a | 943 | (let ((temp-file (make-symbol "temp-file")) |
a2fdb55c EN |
944 | (temp-buffer (make-symbol "temp-buffer"))) |
945 | `(let ((,temp-file ,file) | |
946 | (,temp-buffer | |
947 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) | |
948 | (unwind-protect | |
949 | (prog1 | |
950 | (with-current-buffer ,temp-buffer | |
951 | ,@forms) | |
952 | (with-current-buffer ,temp-buffer | |
953 | (widen) | |
954 | (write-region (point-min) (point-max) ,temp-file nil 0))) | |
955 | (and (buffer-name ,temp-buffer) | |
956 | (kill-buffer ,temp-buffer)))))) | |
957 | ||
958 | (defmacro with-temp-buffer (&rest forms) | |
959 | "Create a temporary buffer, and evaluate FORMS there like `progn'. | |
960 | See also `with-temp-file' and `with-output-to-string'." | |
961 | (let ((temp-buffer (make-symbol "temp-buffer"))) | |
962 | `(let ((,temp-buffer | |
963 | (get-buffer-create (generate-new-buffer-name " *temp*")))) | |
964 | (unwind-protect | |
965 | (with-current-buffer ,temp-buffer | |
966 | ,@forms) | |
967 | (and (buffer-name ,temp-buffer) | |
968 | (kill-buffer ,temp-buffer)))))) | |
969 | ||
5db7925d RS |
970 | (defmacro with-output-to-string (&rest body) |
971 | "Execute BODY, return the text it sent to `standard-output', as a string." | |
a2fdb55c EN |
972 | `(let ((standard-output |
973 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) | |
5db7925d RS |
974 | (let ((standard-output standard-output)) |
975 | ,@body) | |
a2fdb55c EN |
976 | (with-current-buffer standard-output |
977 | (prog1 | |
978 | (buffer-string) | |
979 | (kill-buffer nil))))) | |
2ec9c94e RS |
980 | |
981 | (defmacro combine-after-change-calls (&rest body) | |
982 | "Execute BODY, but don't call the after-change functions till the end. | |
983 | If BODY makes changes in the buffer, they are recorded | |
984 | and the functions on `after-change-functions' are called several times | |
985 | when BODY is finished. | |
31aa282e | 986 | The return value is the value of the last form in BODY. |
2ec9c94e RS |
987 | |
988 | If `before-change-functions' is non-nil, then calls to the after-change | |
989 | functions can't be deferred, so in that case this macro has no effect. | |
990 | ||
991 | Do not alter `after-change-functions' or `before-change-functions' | |
992 | in BODY." | |
993 | `(unwind-protect | |
994 | (let ((combine-after-change-calls t)) | |
995 | . ,body) | |
996 | (combine-after-change-execute))) | |
997 | ||
a2fdb55c | 998 | \f |
c7ca41e6 RS |
999 | (defvar save-match-data-internal) |
1000 | ||
1001 | ;; We use save-match-data-internal as the local variable because | |
1002 | ;; that works ok in practice (people should not use that variable elsewhere). | |
1003 | ;; We used to use an uninterned symbol; the compiler handles that properly | |
1004 | ;; now, but it generates slower code. | |
9a5336ae JB |
1005 | (defmacro save-match-data (&rest body) |
1006 | "Execute the BODY forms, restoring the global value of the match data." | |
9fc0eb95 | 1007 | `(let ((save-match-data-internal (match-data))) |
c7ca41e6 RS |
1008 | (unwind-protect |
1009 | (progn ,@body) | |
024ae2c6 | 1010 | (set-match-data save-match-data-internal)))) |
993713ce | 1011 | |
cd323f89 | 1012 | (defun match-string (num &optional string) |
993713ce SM |
1013 | "Return string of text matched by last search. |
1014 | NUM specifies which parenthesized expression in the last regexp. | |
1015 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
1016 | Zero means the entire text matched by the whole regexp or whole string. | |
1017 | STRING should be given if the last search was by `string-match' on STRING." | |
cd323f89 SM |
1018 | (if (match-beginning num) |
1019 | (if string | |
1020 | (substring string (match-beginning num) (match-end num)) | |
1021 | (buffer-substring (match-beginning num) (match-end num))))) | |
58f950b4 | 1022 | |
bb760c71 RS |
1023 | (defun match-string-no-properties (num &optional string) |
1024 | "Return string of text matched by last search, without text properties. | |
1025 | NUM specifies which parenthesized expression in the last regexp. | |
1026 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
1027 | Zero means the entire text matched by the whole regexp or whole string. | |
1028 | STRING should be given if the last search was by `string-match' on STRING." | |
1029 | (if (match-beginning num) | |
1030 | (if string | |
1031 | (let ((result | |
1032 | (substring string (match-beginning num) (match-end num)))) | |
1033 | (set-text-properties 0 (length result) nil result) | |
1034 | result) | |
1035 | (buffer-substring-no-properties (match-beginning num) | |
1036 | (match-end num))))) | |
1037 | ||
edce3654 RS |
1038 | (defun split-string (string &optional separators) |
1039 | "Splits STRING into substrings where there are matches for SEPARATORS. | |
1040 | Each match for SEPARATORS is a splitting point. | |
1041 | The substrings between the splitting points are made into a list | |
1042 | which is returned. | |
b222b786 RS |
1043 | If SEPARATORS is absent, it defaults to \"[ \\f\\t\\n\\r\\v]+\". |
1044 | ||
1045 | If there is match for SEPARATORS at the beginning of STRING, we do not | |
1046 | include a null substring for that. Likewise, if there is a match | |
1047 | at the end of STRING, we don't include a null substring for that." | |
edce3654 RS |
1048 | (let ((rexp (or separators "[ \f\t\n\r\v]+")) |
1049 | (start 0) | |
b222b786 | 1050 | notfirst |
edce3654 | 1051 | (list nil)) |
b222b786 RS |
1052 | (while (and (string-match rexp string |
1053 | (if (and notfirst | |
1054 | (= start (match-beginning 0)) | |
1055 | (< start (length string))) | |
1056 | (1+ start) start)) | |
1057 | (< (match-beginning 0) (length string))) | |
1058 | (setq notfirst t) | |
7eb47123 | 1059 | (or (eq (match-beginning 0) 0) |
b222b786 RS |
1060 | (and (eq (match-beginning 0) (match-end 0)) |
1061 | (eq (match-beginning 0) start)) | |
edce3654 RS |
1062 | (setq list |
1063 | (cons (substring string start (match-beginning 0)) | |
1064 | list))) | |
1065 | (setq start (match-end 0))) | |
1066 | (or (eq start (length string)) | |
1067 | (setq list | |
1068 | (cons (substring string start) | |
1069 | list))) | |
1070 | (nreverse list))) | |
a7ed4c2a | 1071 | \f |
8af7df60 RS |
1072 | (defun shell-quote-argument (argument) |
1073 | "Quote an argument for passing as argument to an inferior shell." | |
c1c74b43 RS |
1074 | (if (eq system-type 'ms-dos) |
1075 | ;; MS-DOS shells don't have quoting, so don't do any. | |
1076 | argument | |
1077 | (if (eq system-type 'windows-nt) | |
1078 | (concat "\"" argument "\"") | |
e1b65a6b RS |
1079 | (if (equal argument "") |
1080 | "''" | |
1081 | ;; Quote everything except POSIX filename characters. | |
1082 | ;; This should be safe enough even for really weird shells. | |
1083 | (let ((result "") (start 0) end) | |
1084 | (while (string-match "[^-0-9a-zA-Z_./]" argument start) | |
1085 | (setq end (match-beginning 0) | |
1086 | result (concat result (substring argument start end) | |
1087 | "\\" (substring argument end (1+ end))) | |
1088 | start (1+ end))) | |
1089 | (concat result (substring argument start))))))) | |
8af7df60 | 1090 | |
297d863b | 1091 | (defun make-syntax-table (&optional oldtable) |
984f718a | 1092 | "Return a new syntax table. |
888eb98e RS |
1093 | If OLDTABLE is non-nil, copy OLDTABLE. |
1094 | Otherwise, create a syntax table which inherits | |
1095 | all letters and control characters from the standard syntax table; | |
1096 | other characters are copied from the standard syntax table." | |
297d863b KH |
1097 | (if oldtable |
1098 | (copy-syntax-table oldtable) | |
1099 | (let ((table (copy-syntax-table)) | |
1100 | i) | |
1101 | (setq i 0) | |
1102 | (while (<= i 31) | |
a6889c57 | 1103 | (aset table i nil) |
297d863b KH |
1104 | (setq i (1+ i))) |
1105 | (setq i ?A) | |
1106 | (while (<= i ?Z) | |
a6889c57 | 1107 | (aset table i nil) |
297d863b KH |
1108 | (setq i (1+ i))) |
1109 | (setq i ?a) | |
1110 | (while (<= i ?z) | |
a6889c57 | 1111 | (aset table i nil) |
297d863b KH |
1112 | (setq i (1+ i))) |
1113 | (setq i 128) | |
1114 | (while (<= i 255) | |
a6889c57 | 1115 | (aset table i nil) |
297d863b KH |
1116 | (setq i (1+ i))) |
1117 | table))) | |
31aa282e KH |
1118 | |
1119 | (defun add-to-invisibility-spec (arg) | |
1120 | "Add elements to `buffer-invisibility-spec'. | |
1121 | See documentation for `buffer-invisibility-spec' for the kind of elements | |
1122 | that can be added." | |
1123 | (cond | |
1124 | ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t)) | |
1125 | (setq buffer-invisibility-spec (list arg))) | |
1126 | (t | |
11d431ad KH |
1127 | (setq buffer-invisibility-spec |
1128 | (cons arg buffer-invisibility-spec))))) | |
31aa282e KH |
1129 | |
1130 | (defun remove-from-invisibility-spec (arg) | |
1131 | "Remove elements from `buffer-invisibility-spec'." | |
1132 | (if buffer-invisibility-spec | |
071a2a71 | 1133 | (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec)))) |
baed0109 RS |
1134 | \f |
1135 | (defun global-set-key (key command) | |
1136 | "Give KEY a global binding as COMMAND. | |
7bba1895 KH |
1137 | COMMAND is the command definition to use; usually it is |
1138 | a symbol naming an interactively-callable function. | |
1139 | KEY is a key sequence; noninteractively, it is a string or vector | |
1140 | of characters or event types, and non-ASCII characters with codes | |
1141 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
1142 | ||
1143 | Note that if KEY has a local binding in the current buffer, | |
1144 | that local binding will continue to shadow any global binding | |
1145 | that you make with this function." | |
baed0109 RS |
1146 | (interactive "KSet key globally: \nCSet key %s to command: ") |
1147 | (or (vectorp key) (stringp key) | |
1148 | (signal 'wrong-type-argument (list 'arrayp key))) | |
ff663bbe | 1149 | (define-key (current-global-map) key command)) |
baed0109 RS |
1150 | |
1151 | (defun local-set-key (key command) | |
1152 | "Give KEY a local binding as COMMAND. | |
7bba1895 KH |
1153 | COMMAND is the command definition to use; usually it is |
1154 | a symbol naming an interactively-callable function. | |
1155 | KEY is a key sequence; noninteractively, it is a string or vector | |
1156 | of characters or event types, and non-ASCII characters with codes | |
1157 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
1158 | ||
baed0109 RS |
1159 | The binding goes in the current buffer's local map, |
1160 | which in most cases is shared with all other buffers in the same major mode." | |
1161 | (interactive "KSet key locally: \nCSet key %s locally to command: ") | |
1162 | (let ((map (current-local-map))) | |
1163 | (or map | |
1164 | (use-local-map (setq map (make-sparse-keymap)))) | |
1165 | (or (vectorp key) (stringp key) | |
1166 | (signal 'wrong-type-argument (list 'arrayp key))) | |
ff663bbe | 1167 | (define-key map key command))) |
984f718a | 1168 | |
baed0109 RS |
1169 | (defun global-unset-key (key) |
1170 | "Remove global binding of KEY. | |
1171 | KEY is a string representing a sequence of keystrokes." | |
1172 | (interactive "kUnset key globally: ") | |
1173 | (global-set-key key nil)) | |
1174 | ||
db2474b8 | 1175 | (defun local-unset-key (key) |
baed0109 RS |
1176 | "Remove local binding of KEY. |
1177 | KEY is a string representing a sequence of keystrokes." | |
1178 | (interactive "kUnset key locally: ") | |
1179 | (if (current-local-map) | |
db2474b8 | 1180 | (local-set-key key nil)) |
baed0109 RS |
1181 | nil) |
1182 | \f | |
4809d0dd KH |
1183 | ;; We put this here instead of in frame.el so that it's defined even on |
1184 | ;; systems where frame.el isn't loaded. | |
1185 | (defun frame-configuration-p (object) | |
1186 | "Return non-nil if OBJECT seems to be a frame configuration. | |
1187 | Any list whose car is `frame-configuration' is assumed to be a frame | |
1188 | configuration." | |
1189 | (and (consp object) | |
1190 | (eq (car object) 'frame-configuration))) | |
1191 | ||
a9a44ed1 | 1192 | (defun functionp (object) |
77a5664f | 1193 | "Non-nil if OBJECT is a type of object that can be called as a function." |
c029995c | 1194 | (or (subrp object) (byte-code-function-p object) |
a9a44ed1 RS |
1195 | (eq (car-safe object) 'lambda) |
1196 | (and (symbolp object) (fboundp object)))) | |
1197 | ||
9a5336ae JB |
1198 | ;; now in fns.c |
1199 | ;(defun nth (n list) | |
1200 | ; "Returns the Nth element of LIST. | |
1201 | ;N counts from zero. If LIST is not that long, nil is returned." | |
1202 | ; (car (nthcdr n list))) | |
1203 | ; | |
1204 | ;(defun copy-alist (alist) | |
1205 | ; "Return a copy of ALIST. | |
1206 | ;This is a new alist which represents the same mapping | |
1207 | ;from objects to objects, but does not share the alist structure with ALIST. | |
1208 | ;The objects mapped (cars and cdrs of elements of the alist) | |
1209 | ;are shared, however." | |
1210 | ; (setq alist (copy-sequence alist)) | |
1211 | ; (let ((tail alist)) | |
1212 | ; (while tail | |
1213 | ; (if (consp (car tail)) | |
1214 | ; (setcar tail (cons (car (car tail)) (cdr (car tail))))) | |
1215 | ; (setq tail (cdr tail)))) | |
1216 | ; alist) | |
630cc463 ER |
1217 | |
1218 | ;;; subr.el ends here |