Commit | Line | Data |
---|---|---|
c88ab9ce | 1 | ;;; subr.el --- basic lisp subroutines for Emacs |
630cc463 | 2 | |
2308acda | 3 | ;; Copyright (C) 1985, 86, 92, 94, 95, 99, 2000, 2001, 2002, 2003 |
fe10cef0 | 4 | ;; Free Software Foundation, Inc. |
be9b65ac | 5 | |
30764597 PJ |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: internal | |
8 | ||
be9b65ac DL |
9 | ;; This file is part of GNU Emacs. |
10 | ||
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 | |
492878e4 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
be9b65ac DL |
14 | ;; any later version. |
15 | ||
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
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. | |
be9b65ac | 25 | |
60370d40 PJ |
26 | ;;; Commentary: |
27 | ||
630cc463 | 28 | ;;; Code: |
77a5664f RS |
29 | (defvar custom-declare-variable-list nil |
30 | "Record `defcustom' calls made before `custom.el' is loaded to handle them. | |
31 | Each element of this list holds the arguments to one call to `defcustom'.") | |
32 | ||
68e3e5f5 | 33 | ;; Use this, rather than defcustom, in subr.el and other files loaded |
77a5664f RS |
34 | ;; before custom.el. |
35 | (defun custom-declare-variable-early (&rest arguments) | |
36 | (setq custom-declare-variable-list | |
37 | (cons arguments custom-declare-variable-list))) | |
2c642c03 GM |
38 | |
39 | \f | |
40 | (defun macro-declaration-function (macro decl) | |
41 | "Process a declaration found in a macro definition. | |
42 | This is set as the value of the variable `macro-declaration-function'. | |
43 | MACRO is the name of the macro being defined. | |
44 | DECL is a list `(declare ...)' containing the declarations. | |
45 | The return value of this function is not used." | |
b6a1ce0b SM |
46 | ;; We can't use `dolist' or `cadr' yet for bootstrapping reasons. |
47 | (let (d) | |
48 | ;; Ignore the first element of `decl' (it's always `declare'). | |
49 | (while (setq decl (cdr decl)) | |
50 | (setq d (car decl)) | |
51 | (cond ((and (consp d) (eq (car d) 'indent)) | |
52 | (put macro 'lisp-indent-function (car (cdr d)))) | |
53 | ((and (consp d) (eq (car d) 'debug)) | |
54 | (put macro 'edebug-form-spec (car (cdr d)))) | |
55 | (t | |
56 | (message "Unknown declaration %s" d)))))) | |
2c642c03 GM |
57 | |
58 | (setq macro-declaration-function 'macro-declaration-function) | |
59 | ||
9a5336ae JB |
60 | \f |
61 | ;;;; Lisp language features. | |
62 | ||
0764e16f SM |
63 | (defalias 'not 'null) |
64 | ||
1116910a JY |
65 | (defmacro noreturn (form) |
66 | "Evaluates FORM, with the expectation that the evaluation will signal an error | |
67 | instead of returning to its caller. If FORM does return, an error is | |
68 | signalled." | |
69 | `(prog1 ,form | |
70 | (error "Form marked with `noreturn' did return"))) | |
71 | ||
72 | (defmacro 1value (form) | |
73 | "Evaluates FORM, with the expectation that all the same value will be returned | |
74 | from all evaluations of FORM. This is the global do-nothing | |
75 | version of `1value'. There is also `testcover-1value' that | |
76 | complains if FORM ever does return differing values." | |
77 | form) | |
78 | ||
9a5336ae JB |
79 | (defmacro lambda (&rest cdr) |
80 | "Return a lambda expression. | |
81 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
82 | self-quoting; the result of evaluating the lambda expression is the | |
83 | expression itself. The lambda expression may then be treated as a | |
bec0d7f9 RS |
84 | function, i.e., stored as the function value of a symbol, passed to |
85 | funcall or mapcar, etc. | |
86 | ||
9a5336ae | 87 | ARGS should take the same form as an argument list for a `defun'. |
8fd68088 RS |
88 | DOCSTRING is an optional documentation string. |
89 | If present, it should describe how to call the function. | |
90 | But documentation strings are usually not useful in nameless functions. | |
9a5336ae JB |
91 | INTERACTIVE should be a call to the function `interactive', which see. |
92 | It may also be omitted. | |
374d3fe7 | 93 | BODY should be a list of Lisp expressions." |
9a5336ae JB |
94 | ;; Note that this definition should not use backquotes; subr.el should not |
95 | ;; depend on backquote.el. | |
96 | (list 'function (cons 'lambda cdr))) | |
97 | ||
1be152fc | 98 | (defmacro push (newelt listname) |
fa65505b | 99 | "Add NEWELT to the list stored in the symbol LISTNAME. |
1be152fc | 100 | This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)). |
d270117a | 101 | LISTNAME must be a symbol." |
f30e0cd8 | 102 | (declare (debug (form sexp))) |
22d85d00 DL |
103 | (list 'setq listname |
104 | (list 'cons newelt listname))) | |
d270117a RS |
105 | |
106 | (defmacro pop (listname) | |
107 | "Return the first element of LISTNAME's value, and remove it from the list. | |
108 | LISTNAME must be a symbol whose value is a list. | |
109 | If the value is nil, `pop' returns nil but does not actually | |
110 | change the list." | |
f30e0cd8 | 111 | (declare (debug (sexp))) |
54993fa4 MB |
112 | (list 'car |
113 | (list 'prog1 listname | |
114 | (list 'setq listname (list 'cdr listname))))) | |
d270117a | 115 | |
debff3c3 | 116 | (defmacro when (cond &rest body) |
b021ef18 | 117 | "If COND yields non-nil, do BODY, else return nil." |
d47f7515 | 118 | (declare (indent 1) (debug t)) |
debff3c3 | 119 | (list 'if cond (cons 'progn body))) |
9a5336ae | 120 | |
debff3c3 | 121 | (defmacro unless (cond &rest body) |
b021ef18 | 122 | "If COND yields nil, do BODY, else return nil." |
d47f7515 | 123 | (declare (indent 1) (debug t)) |
debff3c3 | 124 | (cons 'if (cons cond (cons nil body)))) |
d370591d | 125 | |
a0b0756a | 126 | (defmacro dolist (spec &rest body) |
d47f7515 | 127 | "Loop over a list. |
a0b0756a | 128 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
d47f7515 SM |
129 | Then evaluate RESULT to get return value, default nil. |
130 | ||
d775d486 | 131 | \(fn (VAR LIST [RESULT]) BODY...)" |
d47f7515 | 132 | (declare (indent 1) (debug ((symbolp form &optional form) body))) |
e4295aa1 | 133 | (let ((temp (make-symbol "--dolist-temp--"))) |
d47f7515 SM |
134 | `(let ((,temp ,(nth 1 spec)) |
135 | ,(car spec)) | |
136 | (while ,temp | |
137 | (setq ,(car spec) (car ,temp)) | |
138 | (setq ,temp (cdr ,temp)) | |
139 | ,@body) | |
140 | ,@(if (cdr (cdr spec)) | |
141 | `((setq ,(car spec) nil) ,@(cdr (cdr spec))))))) | |
a0b0756a RS |
142 | |
143 | (defmacro dotimes (spec &rest body) | |
d47f7515 | 144 | "Loop a certain number of times. |
a0b0756a RS |
145 | Evaluate BODY with VAR bound to successive integers running from 0, |
146 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get | |
d47f7515 SM |
147 | the return value (nil if RESULT is omitted). |
148 | ||
d775d486 | 149 | \(fn (VAR COUNT [RESULT]) BODY...)" |
d47f7515 SM |
150 | (declare (indent 1) (debug dolist)) |
151 | (let ((temp (make-symbol "--dotimes-temp--")) | |
152 | (start 0) | |
153 | (end (nth 1 spec))) | |
154 | `(let ((,temp ,end) | |
155 | (,(car spec) ,start)) | |
156 | (while (< ,(car spec) ,temp) | |
157 | ,@body | |
158 | (setq ,(car spec) (1+ ,(car spec)))) | |
159 | ,@(cdr (cdr spec))))) | |
a0b0756a | 160 | |
d370591d RS |
161 | (defsubst caar (x) |
162 | "Return the car of the car of X." | |
163 | (car (car x))) | |
164 | ||
165 | (defsubst cadr (x) | |
166 | "Return the car of the cdr of X." | |
167 | (car (cdr x))) | |
168 | ||
169 | (defsubst cdar (x) | |
170 | "Return the cdr of the car of X." | |
171 | (cdr (car x))) | |
172 | ||
173 | (defsubst cddr (x) | |
174 | "Return the cdr of the cdr of X." | |
175 | (cdr (cdr x))) | |
e8c32c99 | 176 | |
369fba5f RS |
177 | (defun last (x &optional n) |
178 | "Return the last link of the list X. Its car is the last element. | |
179 | If X is nil, return nil. | |
180 | If N is non-nil, return the Nth-to-last link of X. | |
181 | If N is bigger than the length of X, return X." | |
182 | (if n | |
183 | (let ((m 0) (p x)) | |
184 | (while (consp p) | |
185 | (setq m (1+ m) p (cdr p))) | |
186 | (if (<= n 0) p | |
187 | (if (< n m) (nthcdr (- m n) x) x))) | |
6bfdc2e2 | 188 | (while (consp (cdr x)) |
369fba5f RS |
189 | (setq x (cdr x))) |
190 | x)) | |
526d204e | 191 | |
1c1c65de KH |
192 | (defun butlast (x &optional n) |
193 | "Returns a copy of LIST with the last N elements removed." | |
194 | (if (and n (<= n 0)) x | |
195 | (nbutlast (copy-sequence x) n))) | |
196 | ||
197 | (defun nbutlast (x &optional n) | |
198 | "Modifies LIST to remove the last N elements." | |
199 | (let ((m (length x))) | |
200 | (or n (setq n 1)) | |
201 | (and (< n m) | |
202 | (progn | |
203 | (if (> n 0) (setcdr (nthcdr (- (1- m) n) x) nil)) | |
204 | x)))) | |
205 | ||
0ed2c9b6 | 206 | (defun number-sequence (from &optional to inc) |
abd9177a | 207 | "Return a sequence of numbers from FROM to TO (both inclusive) as a list. |
2c1385ed LT |
208 | INC is the increment used between numbers in the sequence and defaults to 1. |
209 | So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from | |
210 | zero. TO is only included if there is an N for which TO = FROM + N * INC. | |
211 | If TO is nil or numerically equal to FROM, return \(FROM). | |
212 | If INC is positive and TO is less than FROM, or INC is negative | |
213 | and TO is larger than FROM, return nil. | |
214 | If INC is zero and TO is neither nil nor numerically equal to | |
215 | FROM, signal an error. | |
216 | ||
217 | This function is primarily designed for integer arguments. | |
218 | Nevertheless, FROM, TO and INC can be integer or float. However, | |
219 | floating point arithmetic is inexact. For instance, depending on | |
220 | the machine, it may quite well happen that | |
221 | \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4), | |
222 | whereas \(number-sequence 0.4 0.8 0.2) returns a list with three | |
223 | elements. Thus, if some of the arguments are floats and one wants | |
224 | to make sure that TO is included, one may have to explicitly write | |
225 | TO as \(+ FROM \(* N INC)) or use a variable whose value was | |
226 | computed with this exact expression. Alternatively, you can, | |
227 | of course, also replace TO with a slightly larger value | |
228 | \(or a slightly more negative value if INC is negative)." | |
229 | (if (or (not to) (= from to)) | |
0ed2c9b6 VJL |
230 | (list from) |
231 | (or inc (setq inc 1)) | |
2c1385ed LT |
232 | (when (zerop inc) (error "The increment can not be zero")) |
233 | (let (seq (n 0) (next from)) | |
234 | (if (> inc 0) | |
235 | (while (<= next to) | |
236 | (setq seq (cons next seq) | |
237 | n (1+ n) | |
238 | next (+ from (* n inc)))) | |
239 | (while (>= next to) | |
240 | (setq seq (cons next seq) | |
241 | n (1+ n) | |
242 | next (+ from (* n inc))))) | |
0ed2c9b6 | 243 | (nreverse seq)))) |
abd9177a | 244 | |
13157efc | 245 | (defun remove (elt seq) |
963f49a2 | 246 | "Return a copy of SEQ with all occurrences of ELT removed. |
13157efc GM |
247 | SEQ must be a list, vector, or string. The comparison is done with `equal'." |
248 | (if (nlistp seq) | |
249 | ;; If SEQ isn't a list, there's no need to copy SEQ because | |
250 | ;; `delete' will return a new object. | |
251 | (delete elt seq) | |
252 | (delete elt (copy-sequence seq)))) | |
253 | ||
254 | (defun remq (elt list) | |
d47f7515 SM |
255 | "Return LIST with all occurrences of ELT removed. |
256 | The comparison is done with `eq'. Contrary to `delq', this does not use | |
257 | side-effects, and the argument LIST is not modified." | |
13157efc GM |
258 | (if (memq elt list) |
259 | (delq elt (copy-sequence list)) | |
260 | list)) | |
261 | ||
a176c9eb CW |
262 | (defun copy-tree (tree &optional vecp) |
263 | "Make a copy of TREE. | |
264 | If TREE is a cons cell, this recursively copies both its car and its cdr. | |
cfebd4db | 265 | Contrast to `copy-sequence', which copies only along the cdrs. With second |
a176c9eb CW |
266 | argument VECP, this copies vectors as well as conses." |
267 | (if (consp tree) | |
cfebd4db RS |
268 | (let (result) |
269 | (while (consp tree) | |
270 | (let ((newcar (car tree))) | |
271 | (if (or (consp (car tree)) (and vecp (vectorp (car tree)))) | |
272 | (setq newcar (copy-tree (car tree) vecp))) | |
273 | (push newcar result)) | |
274 | (setq tree (cdr tree))) | |
68b08950 | 275 | (nconc (nreverse result) tree)) |
a176c9eb CW |
276 | (if (and vecp (vectorp tree)) |
277 | (let ((i (length (setq tree (copy-sequence tree))))) | |
278 | (while (>= (setq i (1- i)) 0) | |
cfebd4db RS |
279 | (aset tree i (copy-tree (aref tree i) vecp))) |
280 | tree) | |
281 | tree))) | |
a176c9eb | 282 | |
8a288450 RS |
283 | (defun assoc-default (key alist &optional test default) |
284 | "Find object KEY in a pseudo-alist ALIST. | |
285 | ALIST is a list of conses or objects. Each element (or the element's car, | |
286 | if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY). | |
287 | If that is non-nil, the element matches; | |
288 | then `assoc-default' returns the element's cdr, if it is a cons, | |
526d204e | 289 | or DEFAULT if the element is not a cons. |
8a288450 RS |
290 | |
291 | If no element matches, the value is nil. | |
292 | If TEST is omitted or nil, `equal' is used." | |
293 | (let (found (tail alist) value) | |
294 | (while (and tail (not found)) | |
295 | (let ((elt (car tail))) | |
296 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) | |
297 | (setq found t value (if (consp elt) (cdr elt) default)))) | |
298 | (setq tail (cdr tail))) | |
299 | value)) | |
98aae5f6 KH |
300 | |
301 | (defun assoc-ignore-case (key alist) | |
302 | "Like `assoc', but ignores differences in case and text representation. | |
303 | KEY must be a string. Upper-case and lower-case letters are treated as equal. | |
304 | Unibyte strings are converted to multibyte for comparison." | |
305 | (let (element) | |
306 | (while (and alist (not element)) | |
307 | (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil t)) | |
308 | (setq element (car alist))) | |
309 | (setq alist (cdr alist))) | |
310 | element)) | |
311 | ||
312 | (defun assoc-ignore-representation (key alist) | |
313 | "Like `assoc', but ignores differences in text representation. | |
264ef586 | 314 | KEY must be a string. |
98aae5f6 KH |
315 | Unibyte strings are converted to multibyte for comparison." |
316 | (let (element) | |
317 | (while (and alist (not element)) | |
318 | (if (eq t (compare-strings key 0 nil (car (car alist)) 0 nil)) | |
319 | (setq element (car alist))) | |
320 | (setq alist (cdr alist))) | |
321 | element)) | |
cbbc3205 GM |
322 | |
323 | (defun member-ignore-case (elt list) | |
324 | "Like `member', but ignores differences in case and text representation. | |
325 | ELT must be a string. Upper-case and lower-case letters are treated as equal. | |
d86a3084 RS |
326 | Unibyte strings are converted to multibyte for comparison. |
327 | Non-strings in LIST are ignored." | |
328 | (while (and list | |
329 | (not (and (stringp (car list)) | |
330 | (eq t (compare-strings elt 0 nil (car list) 0 nil t))))) | |
242c13e8 MB |
331 | (setq list (cdr list))) |
332 | list) | |
cbbc3205 | 333 | |
9a5336ae | 334 | \f |
9a5336ae | 335 | ;;;; Keymap support. |
be9b65ac DL |
336 | |
337 | (defun undefined () | |
338 | (interactive) | |
339 | (ding)) | |
340 | ||
341 | ;Prevent the \{...} documentation construct | |
342 | ;from mentioning keys that run this command. | |
343 | (put 'undefined 'suppress-keymap t) | |
344 | ||
345 | (defun suppress-keymap (map &optional nodigits) | |
346 | "Make MAP override all normally self-inserting keys to be undefined. | |
347 | Normally, as an exception, digits and minus-sign are set to make prefix args, | |
348 | but optional second arg NODIGITS non-nil treats them like other chars." | |
098ba983 | 349 | (define-key map [remap self-insert-command] 'undefined) |
be9b65ac DL |
350 | (or nodigits |
351 | (let (loop) | |
352 | (define-key map "-" 'negative-argument) | |
353 | ;; Make plain numbers do numeric args. | |
354 | (setq loop ?0) | |
355 | (while (<= loop ?9) | |
356 | (define-key map (char-to-string loop) 'digit-argument) | |
357 | (setq loop (1+ loop)))))) | |
358 | ||
be9b65ac DL |
359 | ;Moved to keymap.c |
360 | ;(defun copy-keymap (keymap) | |
264ef586 | 361 | ; "Return a copy of KEYMAP" |
be9b65ac DL |
362 | ; (while (not (keymapp keymap)) |
363 | ; (setq keymap (signal 'wrong-type-argument (list 'keymapp keymap)))) | |
364 | ; (if (vectorp keymap) | |
365 | ; (copy-sequence keymap) | |
366 | ; (copy-alist keymap))) | |
367 | ||
f14dbba7 KH |
368 | (defvar key-substitution-in-progress nil |
369 | "Used internally by substitute-key-definition.") | |
370 | ||
7f2c2edd | 371 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) |
be9b65ac DL |
372 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. |
373 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
4656b314 | 374 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine |
ff77cf40 | 375 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP." |
739f2672 GM |
376 | ;; Don't document PREFIX in the doc string because we don't want to |
377 | ;; advertise it. It's meant for recursive calls only. Here's its | |
378 | ;; meaning | |
264ef586 | 379 | |
739f2672 GM |
380 | ;; If optional argument PREFIX is specified, it should be a key |
381 | ;; prefix, a string. Redefined bindings will then be bound to the | |
382 | ;; original key, with PREFIX added at the front. | |
7f2c2edd RS |
383 | (or prefix (setq prefix "")) |
384 | (let* ((scan (or oldmap keymap)) | |
385 | (vec1 (vector nil)) | |
f14dbba7 KH |
386 | (prefix1 (vconcat prefix vec1)) |
387 | (key-substitution-in-progress | |
388 | (cons scan key-substitution-in-progress))) | |
7f2c2edd RS |
389 | ;; Scan OLDMAP, finding each char or event-symbol that |
390 | ;; has any definition, and act on it with hack-key. | |
391 | (while (consp scan) | |
392 | (if (consp (car scan)) | |
393 | (let ((char (car (car scan))) | |
394 | (defn (cdr (car scan)))) | |
395 | ;; The inside of this let duplicates exactly | |
396 | ;; the inside of the following let that handles array elements. | |
397 | (aset vec1 0 char) | |
398 | (aset prefix1 (length prefix) char) | |
44d798af | 399 | (let (inner-def skipped) |
7f2c2edd RS |
400 | ;; Skip past menu-prompt. |
401 | (while (stringp (car-safe defn)) | |
44d798af | 402 | (setq skipped (cons (car defn) skipped)) |
7f2c2edd | 403 | (setq defn (cdr defn))) |
e025dddf RS |
404 | ;; Skip past cached key-equivalence data for menu items. |
405 | (and (consp defn) (consp (car defn)) | |
406 | (setq defn (cdr defn))) | |
7f2c2edd | 407 | (setq inner-def defn) |
e025dddf | 408 | ;; Look past a symbol that names a keymap. |
7f2c2edd RS |
409 | (while (and (symbolp inner-def) |
410 | (fboundp inner-def)) | |
411 | (setq inner-def (symbol-function inner-def))) | |
328a37ec RS |
412 | (if (or (eq defn olddef) |
413 | ;; Compare with equal if definition is a key sequence. | |
414 | ;; That is useful for operating on function-key-map. | |
415 | (and (or (stringp defn) (vectorp defn)) | |
416 | (equal defn olddef))) | |
44d798af | 417 | (define-key keymap prefix1 (nconc (nreverse skipped) newdef)) |
f14dbba7 | 418 | (if (and (keymapp defn) |
350b7567 RS |
419 | ;; Avoid recursively scanning |
420 | ;; where KEYMAP does not have a submap. | |
afd9831b RS |
421 | (let ((elt (lookup-key keymap prefix1))) |
422 | (or (null elt) | |
423 | (keymapp elt))) | |
350b7567 | 424 | ;; Avoid recursively rescanning keymap being scanned. |
f14dbba7 KH |
425 | (not (memq inner-def |
426 | key-substitution-in-progress))) | |
e025dddf RS |
427 | ;; If this one isn't being scanned already, |
428 | ;; scan it now. | |
7f2c2edd RS |
429 | (substitute-key-definition olddef newdef keymap |
430 | inner-def | |
431 | prefix1))))) | |
916cc49f | 432 | (if (vectorp (car scan)) |
7f2c2edd RS |
433 | (let* ((array (car scan)) |
434 | (len (length array)) | |
435 | (i 0)) | |
436 | (while (< i len) | |
437 | (let ((char i) (defn (aref array i))) | |
438 | ;; The inside of this let duplicates exactly | |
439 | ;; the inside of the previous let. | |
440 | (aset vec1 0 char) | |
441 | (aset prefix1 (length prefix) char) | |
44d798af | 442 | (let (inner-def skipped) |
7f2c2edd RS |
443 | ;; Skip past menu-prompt. |
444 | (while (stringp (car-safe defn)) | |
44d798af | 445 | (setq skipped (cons (car defn) skipped)) |
7f2c2edd | 446 | (setq defn (cdr defn))) |
e025dddf RS |
447 | (and (consp defn) (consp (car defn)) |
448 | (setq defn (cdr defn))) | |
7f2c2edd RS |
449 | (setq inner-def defn) |
450 | (while (and (symbolp inner-def) | |
451 | (fboundp inner-def)) | |
452 | (setq inner-def (symbol-function inner-def))) | |
328a37ec RS |
453 | (if (or (eq defn olddef) |
454 | (and (or (stringp defn) (vectorp defn)) | |
455 | (equal defn olddef))) | |
44d798af RS |
456 | (define-key keymap prefix1 |
457 | (nconc (nreverse skipped) newdef)) | |
f14dbba7 | 458 | (if (and (keymapp defn) |
afd9831b RS |
459 | (let ((elt (lookup-key keymap prefix1))) |
460 | (or (null elt) | |
461 | (keymapp elt))) | |
f14dbba7 KH |
462 | (not (memq inner-def |
463 | key-substitution-in-progress))) | |
7f2c2edd RS |
464 | (substitute-key-definition olddef newdef keymap |
465 | inner-def | |
466 | prefix1))))) | |
97fd9abf RS |
467 | (setq i (1+ i)))) |
468 | (if (char-table-p (car scan)) | |
469 | (map-char-table | |
470 | (function (lambda (char defn) | |
471 | (let () | |
472 | ;; The inside of this let duplicates exactly | |
473 | ;; the inside of the previous let, | |
474 | ;; except that it uses set-char-table-range | |
475 | ;; instead of define-key. | |
476 | (aset vec1 0 char) | |
477 | (aset prefix1 (length prefix) char) | |
478 | (let (inner-def skipped) | |
479 | ;; Skip past menu-prompt. | |
480 | (while (stringp (car-safe defn)) | |
481 | (setq skipped (cons (car defn) skipped)) | |
482 | (setq defn (cdr defn))) | |
483 | (and (consp defn) (consp (car defn)) | |
484 | (setq defn (cdr defn))) | |
485 | (setq inner-def defn) | |
486 | (while (and (symbolp inner-def) | |
487 | (fboundp inner-def)) | |
488 | (setq inner-def (symbol-function inner-def))) | |
489 | (if (or (eq defn olddef) | |
490 | (and (or (stringp defn) (vectorp defn)) | |
491 | (equal defn olddef))) | |
9a5114ac RS |
492 | (define-key keymap prefix1 |
493 | (nconc (nreverse skipped) newdef)) | |
97fd9abf RS |
494 | (if (and (keymapp defn) |
495 | (let ((elt (lookup-key keymap prefix1))) | |
496 | (or (null elt) | |
497 | (keymapp elt))) | |
498 | (not (memq inner-def | |
499 | key-substitution-in-progress))) | |
500 | (substitute-key-definition olddef newdef keymap | |
501 | inner-def | |
502 | prefix1))))))) | |
503 | (car scan))))) | |
7f2c2edd | 504 | (setq scan (cdr scan))))) |
9a5336ae | 505 | |
4ced66fd | 506 | (defun define-key-after (keymap key definition &optional after) |
4434d61b RS |
507 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
508 | This is like `define-key' except that the binding for KEY is placed | |
509 | just after the binding for the event AFTER, instead of at the beginning | |
c34a9d34 RS |
510 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
511 | \(like DEFINITION). | |
512 | ||
4ced66fd | 513 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
08b1f8a1 | 514 | AFTER should be a single event type--a symbol or a character, not a sequence. |
c34a9d34 | 515 | |
4ced66fd | 516 | Bindings are always added before any inherited map. |
c34a9d34 | 517 | |
4ced66fd DL |
518 | The order of bindings in a keymap matters when it is used as a menu." |
519 | (unless after (setq after t)) | |
4434d61b RS |
520 | (or (keymapp keymap) |
521 | (signal 'wrong-type-argument (list 'keymapp keymap))) | |
08b1f8a1 GM |
522 | (setq key |
523 | (if (<= (length key) 1) (aref key 0) | |
524 | (setq keymap (lookup-key keymap | |
525 | (apply 'vector | |
526 | (butlast (mapcar 'identity key))))) | |
527 | (aref key (1- (length key))))) | |
528 | (let ((tail keymap) done inserted) | |
4434d61b RS |
529 | (while (and (not done) tail) |
530 | ;; Delete any earlier bindings for the same key. | |
08b1f8a1 | 531 | (if (eq (car-safe (car (cdr tail))) key) |
4434d61b | 532 | (setcdr tail (cdr (cdr tail)))) |
08b1f8a1 GM |
533 | ;; If we hit an included map, go down that one. |
534 | (if (keymapp (car tail)) (setq tail (car tail))) | |
4434d61b RS |
535 | ;; When we reach AFTER's binding, insert the new binding after. |
536 | ;; If we reach an inherited keymap, insert just before that. | |
113d28a8 | 537 | ;; If we reach the end of this keymap, insert at the end. |
c34a9d34 RS |
538 | (if (or (and (eq (car-safe (car tail)) after) |
539 | (not (eq after t))) | |
113d28a8 RS |
540 | (eq (car (cdr tail)) 'keymap) |
541 | (null (cdr tail))) | |
4434d61b | 542 | (progn |
113d28a8 RS |
543 | ;; Stop the scan only if we find a parent keymap. |
544 | ;; Keep going past the inserted element | |
545 | ;; so we can delete any duplications that come later. | |
546 | (if (eq (car (cdr tail)) 'keymap) | |
547 | (setq done t)) | |
548 | ;; Don't insert more than once. | |
549 | (or inserted | |
08b1f8a1 | 550 | (setcdr tail (cons (cons key definition) (cdr tail)))) |
113d28a8 | 551 | (setq inserted t))) |
4434d61b RS |
552 | (setq tail (cdr tail))))) |
553 | ||
51fa3961 | 554 | |
d128fe85 RS |
555 | (defmacro kbd (keys) |
556 | "Convert KEYS to the internal Emacs key representation. | |
557 | KEYS should be a string constant in the format used for | |
558 | saving keyboard macros (see `insert-kbd-macro')." | |
559 | (read-kbd-macro keys)) | |
560 | ||
8bed5e3d RS |
561 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
562 | ||
9a5336ae JB |
563 | (defun keyboard-translate (from to) |
564 | "Translate character FROM to TO at a low level. | |
565 | This function creates a `keyboard-translate-table' if necessary | |
566 | and then modifies one entry in it." | |
8bed5e3d RS |
567 | (or (char-table-p keyboard-translate-table) |
568 | (setq keyboard-translate-table | |
569 | (make-char-table 'keyboard-translate-table nil))) | |
9a5336ae JB |
570 | (aset keyboard-translate-table from to)) |
571 | ||
572 | \f | |
264ef586 | 573 | ;;;; The global keymap tree. |
9a5336ae JB |
574 | |
575 | ;;; global-map, esc-map, and ctl-x-map have their values set up in | |
576 | ;;; keymap.c; we just give them docstrings here. | |
577 | ||
578 | (defvar global-map nil | |
579 | "Default global keymap mapping Emacs keyboard input into commands. | |
580 | The value is a keymap which is usually (but not necessarily) Emacs's | |
581 | global map.") | |
582 | ||
583 | (defvar esc-map nil | |
584 | "Default keymap for ESC (meta) commands. | |
585 | The normal global definition of the character ESC indirects to this keymap.") | |
586 | ||
587 | (defvar ctl-x-map nil | |
588 | "Default keymap for C-x commands. | |
589 | The normal global definition of the character C-x indirects to this keymap.") | |
590 | ||
591 | (defvar ctl-x-4-map (make-sparse-keymap) | |
03eeb110 | 592 | "Keymap for subcommands of C-x 4.") |
059184dd | 593 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
9a5336ae JB |
594 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
595 | ||
596 | (defvar ctl-x-5-map (make-sparse-keymap) | |
597 | "Keymap for frame commands.") | |
059184dd | 598 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
9a5336ae JB |
599 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
600 | ||
0f03054a | 601 | \f |
9a5336ae JB |
602 | ;;;; Event manipulation functions. |
603 | ||
da16e648 KH |
604 | ;; The call to `read' is to ensure that the value is computed at load time |
605 | ;; and not compiled into the .elc file. The value is negative on most | |
606 | ;; machines, but not on all! | |
607 | (defconst listify-key-sequence-1 (logior 128 (read "?\\M-\\^@"))) | |
114137b8 | 608 | |
cde6d7e3 RS |
609 | (defun listify-key-sequence (key) |
610 | "Convert a key sequence to a list of events." | |
611 | (if (vectorp key) | |
612 | (append key nil) | |
613 | (mapcar (function (lambda (c) | |
614 | (if (> c 127) | |
114137b8 | 615 | (logxor c listify-key-sequence-1) |
cde6d7e3 | 616 | c))) |
d47f7515 | 617 | key))) |
cde6d7e3 | 618 | |
53e5a4e8 RS |
619 | (defsubst eventp (obj) |
620 | "True if the argument is an event object." | |
621 | (or (integerp obj) | |
622 | (and (symbolp obj) | |
623 | (get obj 'event-symbol-elements)) | |
624 | (and (consp obj) | |
625 | (symbolp (car obj)) | |
626 | (get (car obj) 'event-symbol-elements)))) | |
627 | ||
628 | (defun event-modifiers (event) | |
629 | "Returns a list of symbols representing the modifier keys in event EVENT. | |
630 | The elements of the list may include `meta', `control', | |
32295976 RS |
631 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
632 | and `down'." | |
53e5a4e8 RS |
633 | (let ((type event)) |
634 | (if (listp type) | |
635 | (setq type (car type))) | |
636 | (if (symbolp type) | |
637 | (cdr (get type 'event-symbol-elements)) | |
638 | (let ((list nil)) | |
da16e648 | 639 | (or (zerop (logand type ?\M-\^@)) |
53e5a4e8 | 640 | (setq list (cons 'meta list))) |
da16e648 | 641 | (or (and (zerop (logand type ?\C-\^@)) |
53e5a4e8 RS |
642 | (>= (logand type 127) 32)) |
643 | (setq list (cons 'control list))) | |
da16e648 | 644 | (or (and (zerop (logand type ?\S-\^@)) |
53e5a4e8 RS |
645 | (= (logand type 255) (downcase (logand type 255)))) |
646 | (setq list (cons 'shift list))) | |
da16e648 | 647 | (or (zerop (logand type ?\H-\^@)) |
53e5a4e8 | 648 | (setq list (cons 'hyper list))) |
da16e648 | 649 | (or (zerop (logand type ?\s-\^@)) |
53e5a4e8 | 650 | (setq list (cons 'super list))) |
da16e648 | 651 | (or (zerop (logand type ?\A-\^@)) |
53e5a4e8 RS |
652 | (setq list (cons 'alt list))) |
653 | list)))) | |
654 | ||
d63de416 RS |
655 | (defun event-basic-type (event) |
656 | "Returns the basic type of the given event (all modifiers removed). | |
7a0485b2 | 657 | The value is a printing character (not upper case) or a symbol." |
2b0f4ba5 JB |
658 | (if (consp event) |
659 | (setq event (car event))) | |
d63de416 RS |
660 | (if (symbolp event) |
661 | (car (get event 'event-symbol-elements)) | |
662 | (let ((base (logand event (1- (lsh 1 18))))) | |
663 | (downcase (if (< base 32) (logior base 64) base))))) | |
664 | ||
0f03054a RS |
665 | (defsubst mouse-movement-p (object) |
666 | "Return non-nil if OBJECT is a mouse movement event." | |
667 | (and (consp object) | |
668 | (eq (car object) 'mouse-movement))) | |
669 | ||
670 | (defsubst event-start (event) | |
671 | "Return the starting position of EVENT. | |
672 | If EVENT is a mouse press or a mouse click, this returns the location | |
673 | of the event. | |
674 | If EVENT is a drag, this returns the drag's starting position. | |
675 | The return value is of the form | |
79bcefe2 | 676 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)) |
0f03054a | 677 | The `posn-' functions access elements of such lists." |
5ef6a86d SM |
678 | (if (consp event) (nth 1 event) |
679 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a RS |
680 | |
681 | (defsubst event-end (event) | |
682 | "Return the ending location of EVENT. EVENT should be a click or drag event. | |
683 | If EVENT is a click event, this function is the same as `event-start'. | |
684 | The return value is of the form | |
79bcefe2 | 685 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)) |
0f03054a | 686 | The `posn-' functions access elements of such lists." |
5ef6a86d SM |
687 | (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event) |
688 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a | 689 | |
32295976 RS |
690 | (defsubst event-click-count (event) |
691 | "Return the multi-click count of EVENT, a click or drag event. | |
692 | The return value is a positive integer." | |
5ef6a86d | 693 | (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1)) |
32295976 | 694 | |
0f03054a RS |
695 | (defsubst posn-window (position) |
696 | "Return the window in POSITION. | |
79bcefe2 KS |
697 | POSITION should be a list of the form returned by the `event-start' |
698 | and `event-end' functions." | |
0f03054a RS |
699 | (nth 0 position)) |
700 | ||
79bcefe2 KS |
701 | (defsubst posn-area (position) |
702 | "Return the window area recorded in POSITION, or nil for the text area. | |
703 | POSITION should be a list of the form returned by the `event-start' | |
704 | and `event-end' functions." | |
705 | (let ((area (if (consp (nth 1 position)) | |
706 | (car (nth 1 position)) | |
707 | (nth 1 position)))) | |
708 | (and (symbolp area) area))) | |
709 | ||
0f03054a RS |
710 | (defsubst posn-point (position) |
711 | "Return the buffer location in POSITION. | |
79bcefe2 KS |
712 | POSITION should be a list of the form returned by the `event-start' |
713 | and `event-end' functions." | |
714 | (or (nth 5 position) | |
715 | (if (consp (nth 1 position)) | |
716 | (car (nth 1 position)) | |
717 | (nth 1 position)))) | |
0f03054a | 718 | |
e55c21be RS |
719 | (defsubst posn-x-y (position) |
720 | "Return the x and y coordinates in POSITION. | |
79bcefe2 KS |
721 | POSITION should be a list of the form returned by the `event-start' |
722 | and `event-end' functions." | |
0f03054a RS |
723 | (nth 2 position)) |
724 | ||
ed627e08 | 725 | (defun posn-col-row (position) |
79bcefe2 KS |
726 | "Return the nominal column and row in POSITION, measured in characters. |
727 | The column and row values are approximations calculated from the x | |
728 | and y coordinates in POSITION and the frame's default character width | |
729 | and height. | |
ed627e08 | 730 | For a scroll-bar event, the result column is 0, and the row |
79bcefe2 KS |
731 | corresponds to the vertical position of the click in the scroll bar. |
732 | POSITION should be a list of the form returned by the `event-start' | |
733 | and `event-end' functions." | |
734 | (let* ((pair (posn-x-y position)) | |
735 | (window (posn-window position)) | |
736 | (area (posn-area position))) | |
737 | (cond | |
738 | ((null window) | |
739 | '(0 . 0)) | |
740 | ((eq area 'vertical-scroll-bar) | |
741 | (cons 0 (scroll-bar-scale pair (1- (window-height window))))) | |
742 | ((eq area 'horizontal-scroll-bar) | |
743 | (cons (scroll-bar-scale pair (window-width window)) 0)) | |
744 | (t | |
745 | (let* ((frame (if (framep window) window (window-frame window))) | |
746 | (x (/ (car pair) (frame-char-width frame))) | |
747 | (y (/ (cdr pair) (+ (frame-char-height frame) | |
748 | (or (frame-parameter frame 'line-spacing) | |
749 | default-line-spacing | |
750 | 0))))) | |
751 | (cons x y)))))) | |
752 | ||
753 | (defun posn-actual-col-row (position) | |
754 | "Return the actual column and row in POSITION, measured in characters. | |
755 | These are the actual row number in the window and character number in that row. | |
756 | Return nil if POSITION does not contain the actual position; in that case | |
757 | `posn-col-row' can be used to get approximate values. | |
758 | POSITION should be a list of the form returned by the `event-start' | |
759 | and `event-end' functions." | |
760 | (nth 6 position)) | |
e55c21be | 761 | |
0f03054a RS |
762 | (defsubst posn-timestamp (position) |
763 | "Return the timestamp of POSITION. | |
79bcefe2 KS |
764 | POSITION should be a list of the form returned by the `event-start' |
765 | and `event-end' functions." | |
0f03054a | 766 | (nth 3 position)) |
9a5336ae | 767 | |
79bcefe2 KS |
768 | (defsubst posn-object (position) |
769 | "Return the object of POSITION. | |
770 | POSITION should be a list of the form returned by the `event-start' | |
771 | and `event-end' functions." | |
772 | (nth 4 position)) | |
773 | ||
e08f9a0d KS |
774 | (defsubst posn-object-x-y (position) |
775 | "Return the x and y coordinates relative to the object of POSITION. | |
776 | POSITION should be a list of the form returned by the `event-start' | |
777 | and `event-end' functions." | |
778 | (nth 7 position)) | |
779 | ||
0f03054a | 780 | \f |
9a5336ae JB |
781 | ;;;; Obsolescent names for functions. |
782 | ||
059184dd ER |
783 | (defalias 'dot 'point) |
784 | (defalias 'dot-marker 'point-marker) | |
785 | (defalias 'dot-min 'point-min) | |
786 | (defalias 'dot-max 'point-max) | |
787 | (defalias 'window-dot 'window-point) | |
788 | (defalias 'set-window-dot 'set-window-point) | |
789 | (defalias 'read-input 'read-string) | |
790 | (defalias 'send-string 'process-send-string) | |
791 | (defalias 'send-region 'process-send-region) | |
792 | (defalias 'show-buffer 'set-window-buffer) | |
793 | (defalias 'buffer-flush-undo 'buffer-disable-undo) | |
794 | (defalias 'eval-current-buffer 'eval-buffer) | |
795 | (defalias 'compiled-function-p 'byte-code-function-p) | |
ae1cc031 | 796 | (defalias 'define-function 'defalias) |
be9b65ac | 797 | |
0cba3a0f | 798 | (defalias 'sref 'aref) |
2598a293 | 799 | (make-obsolete 'sref 'aref "20.4") |
1c12af5c | 800 | (make-obsolete 'char-bytes "now always returns 1." "20.4") |
9af6aa14 | 801 | (make-obsolete 'chars-in-region "use (abs (- BEG END))." "20.3") |
b4591b37 JB |
802 | (make-obsolete 'dot 'point "before 19.15") |
803 | (make-obsolete 'dot-max 'point-max "before 19.15") | |
804 | (make-obsolete 'dot-min 'point-min "before 19.15") | |
805 | (make-obsolete 'dot-marker 'point-marker "before 19.15") | |
806 | (make-obsolete 'buffer-flush-undo 'buffer-disable-undo "before 19.15") | |
807 | (make-obsolete 'baud-rate "use the baud-rate variable instead." "before 19.15") | |
808 | (make-obsolete 'compiled-function-p 'byte-code-function-p "before 19.15") | |
809 | (make-obsolete 'define-function 'defalias "20.1") | |
6bb762b3 | 810 | |
676927b7 PJ |
811 | (defun insert-string (&rest args) |
812 | "Mocklisp-compatibility insert function. | |
813 | Like the function `insert' except that any argument that is a number | |
814 | is converted into a string by expressing it in decimal." | |
815 | (dolist (el args) | |
816 | (insert (if (integerp el) (number-to-string el) el)))) | |
9e028368 SM |
817 | (make-obsolete 'insert-string 'insert "21.4") |
818 | (defun makehash (&optional test) (make-hash-table :test (or test 'eql))) | |
819 | (make-obsolete 'makehash 'make-hash-table "21.4") | |
676927b7 | 820 | |
9a5336ae JB |
821 | ;; Some programs still use this as a function. |
822 | (defun baud-rate () | |
8eb93953 | 823 | "Return the value of the `baud-rate' variable." |
9a5336ae JB |
824 | baud-rate) |
825 | ||
0a5c0893 MB |
826 | (defalias 'focus-frame 'ignore) |
827 | (defalias 'unfocus-frame 'ignore) | |
bd292357 JB |
828 | |
829 | \f | |
830 | ;;;; Obsolescence declarations for variables. | |
831 | ||
832 | (make-obsolete-variable 'directory-sep-char "do not use it." "21.1") | |
833 | (make-obsolete-variable 'mode-line-inverse-video "use the appropriate faces instead." "21.1") | |
834 | (make-obsolete-variable 'unread-command-char | |
835 | "use `unread-command-events' instead. That variable is a list of events to reread, so it now uses nil to mean `no event', instead of -1." | |
836 | "before 19.15") | |
837 | (make-obsolete-variable 'executing-macro 'executing-kbd-macro "before 19.34") | |
838 | (make-obsolete-variable 'post-command-idle-hook | |
839 | "use timers instead, with `run-with-idle-timer'." "before 19.34") | |
840 | (make-obsolete-variable 'post-command-idle-delay | |
841 | "use timers instead, with `run-with-idle-timer'." "before 19.34") | |
842 | ||
9a5336ae JB |
843 | \f |
844 | ;;;; Alternate names for functions - these are not being phased out. | |
845 | ||
059184dd ER |
846 | (defalias 'string= 'string-equal) |
847 | (defalias 'string< 'string-lessp) | |
848 | (defalias 'move-marker 'set-marker) | |
059184dd ER |
849 | (defalias 'rplaca 'setcar) |
850 | (defalias 'rplacd 'setcdr) | |
eb8c3be9 | 851 | (defalias 'beep 'ding) ;preserve lingual purity |
059184dd ER |
852 | (defalias 'indent-to-column 'indent-to) |
853 | (defalias 'backward-delete-char 'delete-backward-char) | |
854 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) | |
855 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) | |
856 | (defalias 'int-to-string 'number-to-string) | |
024ae2c6 | 857 | (defalias 'store-match-data 'set-match-data) |
112f332f | 858 | (defalias 'make-variable-frame-localizable 'make-variable-frame-local) |
d6c22d46 | 859 | ;; These are the XEmacs names: |
475fb2fb KH |
860 | (defalias 'point-at-eol 'line-end-position) |
861 | (defalias 'point-at-bol 'line-beginning-position) | |
37f6661a JB |
862 | |
863 | ;;; Should this be an obsolete name? If you decide it should, you get | |
864 | ;;; to go through all the sources and change them. | |
059184dd | 865 | (defalias 'string-to-int 'string-to-number) |
be9b65ac | 866 | \f |
9a5336ae | 867 | ;;;; Hook manipulation functions. |
be9b65ac | 868 | |
0e4d378b RS |
869 | (defun make-local-hook (hook) |
870 | "Make the hook HOOK local to the current buffer. | |
71c78f01 RS |
871 | The return value is HOOK. |
872 | ||
c344cf32 SM |
873 | You never need to call this function now that `add-hook' does it for you |
874 | if its LOCAL argument is non-nil. | |
875 | ||
0e4d378b RS |
876 | When a hook is local, its local and global values |
877 | work in concert: running the hook actually runs all the hook | |
878 | functions listed in *either* the local value *or* the global value | |
879 | of the hook variable. | |
880 | ||
08b1f8a1 | 881 | This function works by making t a member of the buffer-local value, |
7dd1926e RS |
882 | which acts as a flag to run the hook functions in the default value as |
883 | well. This works for all normal hooks, but does not work for most | |
884 | non-normal hooks yet. We will be changing the callers of non-normal | |
885 | hooks so that they can handle localness; this has to be done one by | |
886 | one. | |
887 | ||
888 | This function does nothing if HOOK is already local in the current | |
889 | buffer. | |
0e4d378b RS |
890 | |
891 | Do not use `make-local-variable' to make a hook variable buffer-local." | |
892 | (if (local-variable-p hook) | |
893 | nil | |
894 | (or (boundp hook) (set hook nil)) | |
895 | (make-local-variable hook) | |
71c78f01 RS |
896 | (set hook (list t))) |
897 | hook) | |
8eb93953 | 898 | (make-obsolete 'make-local-hook "not necessary any more." "21.1") |
0e4d378b RS |
899 | |
900 | (defun add-hook (hook function &optional append local) | |
32295976 RS |
901 | "Add to the value of HOOK the function FUNCTION. |
902 | FUNCTION is not added if already present. | |
903 | FUNCTION is added (if necessary) at the beginning of the hook list | |
904 | unless the optional argument APPEND is non-nil, in which case | |
905 | FUNCTION is added at the end. | |
906 | ||
0e4d378b RS |
907 | The optional fourth argument, LOCAL, if non-nil, says to modify |
908 | the hook's buffer-local value rather than its default value. | |
61a3d8c4 RS |
909 | This makes the hook buffer-local if needed, and it makes t a member |
910 | of the buffer-local value. That acts as a flag to run the hook | |
911 | functions in the default value as well as in the local value. | |
0e4d378b | 912 | |
32295976 RS |
913 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
914 | HOOK is void, it is first set to nil. If HOOK's value is a single | |
aa09b5ca | 915 | function, it is changed to a list of functions." |
be9b65ac | 916 | (or (boundp hook) (set hook nil)) |
0e4d378b | 917 | (or (default-boundp hook) (set-default hook nil)) |
08b1f8a1 GM |
918 | (if local (unless (local-variable-if-set-p hook) |
919 | (set (make-local-variable hook) (list t))) | |
8947a5e2 SM |
920 | ;; Detect the case where make-local-variable was used on a hook |
921 | ;; and do what we used to do. | |
552eb607 | 922 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) |
8947a5e2 SM |
923 | (setq local t))) |
924 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
925 | ;; If the hook value is a single function, turn it into a list. | |
926 | (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
2248c40d | 927 | (setq hook-value (list hook-value))) |
8947a5e2 SM |
928 | ;; Do the actual addition if necessary |
929 | (unless (member function hook-value) | |
930 | (setq hook-value | |
931 | (if append | |
932 | (append hook-value (list function)) | |
933 | (cons function hook-value)))) | |
934 | ;; Set the actual variable | |
935 | (if local (set hook hook-value) (set-default hook hook-value)))) | |
0e4d378b RS |
936 | |
937 | (defun remove-hook (hook function &optional local) | |
24980d16 RS |
938 | "Remove from the value of HOOK the function FUNCTION. |
939 | HOOK should be a symbol, and FUNCTION may be any valid function. If | |
940 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the | |
0e4d378b RS |
941 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
942 | ||
943 | The optional third argument, LOCAL, if non-nil, says to modify | |
b7a1c900 | 944 | the hook's buffer-local value rather than its default value." |
8947a5e2 SM |
945 | (or (boundp hook) (set hook nil)) |
946 | (or (default-boundp hook) (set-default hook nil)) | |
b7a1c900 RS |
947 | ;; Do nothing if LOCAL is t but this hook has no local binding. |
948 | (unless (and local (not (local-variable-p hook))) | |
8947a5e2 SM |
949 | ;; Detect the case where make-local-variable was used on a hook |
950 | ;; and do what we used to do. | |
b7a1c900 RS |
951 | (when (and (local-variable-p hook) |
952 | (not (and (consp (symbol-value hook)) | |
953 | (memq t (symbol-value hook))))) | |
954 | (setq local t)) | |
955 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
956 | ;; Remove the function, for both the list and the non-list cases. | |
957 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
958 | (if (equal hook-value function) (setq hook-value nil)) | |
959 | (setq hook-value (delete function (copy-sequence hook-value)))) | |
960 | ;; If the function is on the global hook, we need to shadow it locally | |
961 | ;;(when (and local (member function (default-value hook)) | |
962 | ;; (not (member (cons 'not function) hook-value))) | |
963 | ;; (push (cons 'not function) hook-value)) | |
964 | ;; Set the actual variable | |
965 | (if (not local) | |
966 | (set-default hook hook-value) | |
967 | (if (equal hook-value '(t)) | |
968 | (kill-local-variable hook) | |
969 | (set hook hook-value)))))) | |
6e3af630 | 970 | |
c8bfa689 | 971 | (defun add-to-list (list-var element &optional append) |
8851c1f0 | 972 | "Add to the value of LIST-VAR the element ELEMENT if it isn't there yet. |
9f0b1f09 | 973 | The test for presence of ELEMENT is done with `equal'. |
c8bfa689 MB |
974 | If ELEMENT is added, it is added at the beginning of the list, |
975 | unless the optional argument APPEND is non-nil, in which case | |
976 | ELEMENT is added at the end. | |
508bcbca | 977 | |
daebae3d PJ |
978 | The return value is the new value of LIST-VAR. |
979 | ||
8851c1f0 RS |
980 | If you want to use `add-to-list' on a variable that is not defined |
981 | until a certain package is loaded, you should put the call to `add-to-list' | |
982 | into a hook function that will be run only after loading the package. | |
983 | `eval-after-load' provides one way to do this. In some cases | |
984 | other hooks, such as major mode hooks, can do the job." | |
15171a06 KH |
985 | (if (member element (symbol-value list-var)) |
986 | (symbol-value list-var) | |
c8bfa689 MB |
987 | (set list-var |
988 | (if append | |
989 | (append (symbol-value list-var) (list element)) | |
990 | (cons element (symbol-value list-var)))))) | |
448a0170 MB |
991 | |
992 | \f | |
993 | ;;; Load history | |
994 | ||
a2c4ae01 RS |
995 | ;;; (defvar symbol-file-load-history-loaded nil |
996 | ;;; "Non-nil means we have loaded the file `fns-VERSION.el' in `exec-directory'. | |
997 | ;;; That file records the part of `load-history' for preloaded files, | |
998 | ;;; which is cleared out before dumping to make Emacs smaller.") | |
999 | ||
1000 | ;;; (defun load-symbol-file-load-history () | |
1001 | ;;; "Load the file `fns-VERSION.el' in `exec-directory' if not already done. | |
1002 | ;;; That file records the part of `load-history' for preloaded files, | |
1003 | ;;; which is cleared out before dumping to make Emacs smaller." | |
1004 | ;;; (unless symbol-file-load-history-loaded | |
1005 | ;;; (load (expand-file-name | |
1006 | ;;; ;; fns-XX.YY.ZZ.el does not work on DOS filesystem. | |
1007 | ;;; (if (eq system-type 'ms-dos) | |
1008 | ;;; "fns.el" | |
1009 | ;;; (format "fns-%s.el" emacs-version)) | |
1010 | ;;; exec-directory) | |
1011 | ;;; ;; The file name fns-%s.el already has a .el extension. | |
1012 | ;;; nil nil t) | |
1013 | ;;; (setq symbol-file-load-history-loaded t))) | |
448a0170 MB |
1014 | |
1015 | (defun symbol-file (function) | |
1016 | "Return the input source from which FUNCTION was loaded. | |
1017 | The value is normally a string that was passed to `load': | |
1018 | either an absolute file name, or a library name | |
1019 | \(with no directory name and no `.el' or `.elc' at the end). | |
1020 | It can also be nil, if the definition is not associated with any file." | |
e9f13a95 SM |
1021 | (if (and (symbolp function) (fboundp function) |
1022 | (eq 'autoload (car-safe (symbol-function function)))) | |
1023 | (nth 1 (symbol-function function)) | |
1024 | (let ((files load-history) | |
cb21744e | 1025 | file) |
e9f13a95 | 1026 | (while files |
12320833 | 1027 | (if (member function (cdr (car files))) |
e9f13a95 SM |
1028 | (setq file (car (car files)) files nil)) |
1029 | (setq files (cdr files))) | |
1030 | file))) | |
448a0170 | 1031 | |
be9b65ac | 1032 | \f |
9a5336ae JB |
1033 | ;;;; Specifying things to do after certain files are loaded. |
1034 | ||
1035 | (defun eval-after-load (file form) | |
1036 | "Arrange that, if FILE is ever loaded, FORM will be run at that time. | |
1037 | This makes or adds to an entry on `after-load-alist'. | |
90914938 | 1038 | If FILE is already loaded, evaluate FORM right now. |
12c7071c | 1039 | It does nothing if FORM is already on the list for FILE. |
19594307 DL |
1040 | FILE must match exactly. Normally FILE is the name of a library, |
1041 | with no directory or extension specified, since that is how `load' | |
a2d7836f SM |
1042 | is normally called. |
1043 | FILE can also be a feature (i.e. a symbol), in which case FORM is | |
1044 | evaluated whenever that feature is `provide'd." | |
12c7071c | 1045 | (let ((elt (assoc file after-load-alist))) |
a2d7836f SM |
1046 | ;; Make sure there is an element for FILE. |
1047 | (unless elt (setq elt (list file)) (push elt after-load-alist)) | |
1048 | ;; Add FORM to the element if it isn't there. | |
1049 | (unless (member form (cdr elt)) | |
1050 | (nconc elt (list form)) | |
1051 | ;; If the file has been loaded already, run FORM right away. | |
1052 | (if (if (symbolp file) | |
1053 | (featurep file) | |
1054 | ;; Make sure `load-history' contains the files dumped with | |
1055 | ;; Emacs for the case that FILE is one of them. | |
e9f13a95 | 1056 | ;; (load-symbol-file-load-history) |
a2d7836f SM |
1057 | (assoc file load-history)) |
1058 | (eval form)))) | |
9a5336ae JB |
1059 | form) |
1060 | ||
1061 | (defun eval-next-after-load (file) | |
1062 | "Read the following input sexp, and run it whenever FILE is loaded. | |
1063 | This makes or adds to an entry on `after-load-alist'. | |
1064 | FILE should be the name of a library, with no directory name." | |
1065 | (eval-after-load file (read))) | |
7aaacaff RS |
1066 | \f |
1067 | ;;; make-network-process wrappers | |
1068 | ||
1069 | (if (featurep 'make-network-process) | |
1070 | (progn | |
1071 | ||
1072 | (defun open-network-stream (name buffer host service) | |
1073 | "Open a TCP connection for a service to a host. | |
1074 | Returns a subprocess-object to represent the connection. | |
1075 | Input and output work as for subprocesses; `delete-process' closes it. | |
1076 | Args are NAME BUFFER HOST SERVICE. | |
1077 | NAME is name for process. It is modified if necessary to make it unique. | |
1078 | BUFFER is the buffer (or buffer-name) to associate with the process. | |
1079 | Process output goes at end of that buffer, unless you specify | |
1080 | an output stream or filter function to handle the output. | |
1081 | BUFFER may be also nil, meaning that this process is not associated | |
1082 | with any buffer | |
1083 | Third arg is name of the host to connect to, or its IP address. | |
1084 | Fourth arg SERVICE is name of the service desired, or an integer | |
1085 | specifying a port number to connect to." | |
1086 | (make-network-process :name name :buffer buffer | |
1087 | :host host :service service)) | |
1088 | ||
1089 | (defun open-network-stream-nowait (name buffer host service &optional sentinel filter) | |
1090 | "Initiate connection to a TCP connection for a service to a host. | |
1091 | It returns nil if non-blocking connects are not supported; otherwise, | |
1092 | it returns a subprocess-object to represent the connection. | |
1093 | ||
1094 | This function is similar to `open-network-stream', except that this | |
1095 | function returns before the connection is established. When the | |
1096 | connection is completed, the sentinel function will be called with | |
1097 | second arg matching `open' (if successful) or `failed' (on error). | |
1098 | ||
1099 | Args are NAME BUFFER HOST SERVICE SENTINEL FILTER. | |
1100 | NAME, BUFFER, HOST, and SERVICE are as for `open-network-stream'. | |
1101 | Optional args, SENTINEL and FILTER specifies the sentinel and filter | |
1102 | functions to be used for this network stream." | |
1103 | (if (featurep 'make-network-process '(:nowait t)) | |
1104 | (make-network-process :name name :buffer buffer :nowait t | |
1105 | :host host :service service | |
1106 | :filter filter :sentinel sentinel))) | |
1107 | ||
1108 | (defun open-network-stream-server (name buffer service &optional sentinel filter) | |
1109 | "Create a network server process for a TCP service. | |
1110 | It returns nil if server processes are not supported; otherwise, | |
1111 | it returns a subprocess-object to represent the server. | |
1112 | ||
1113 | When a client connects to the specified service, a new subprocess | |
1114 | is created to handle the new connection, and the sentinel function | |
1115 | is called for the new process. | |
1116 | ||
1117 | Args are NAME BUFFER SERVICE SENTINEL FILTER. | |
1118 | NAME is name for the server process. Client processes are named by | |
1119 | appending the ip-address and port number of the client to NAME. | |
1120 | BUFFER is the buffer (or buffer-name) to associate with the server | |
1121 | process. Client processes will not get a buffer if a process filter | |
1122 | is specified or BUFFER is nil; otherwise, a new buffer is created for | |
1123 | the client process. The name is similar to the process name. | |
1124 | Third arg SERVICE is name of the service desired, or an integer | |
1125 | specifying a port number to connect to. It may also be t to selected | |
1126 | an unused port number for the server. | |
1127 | Optional args, SENTINEL and FILTER specifies the sentinel and filter | |
1128 | functions to be used for the client processes; the server process | |
1129 | does not use these function." | |
1130 | (if (featurep 'make-network-process '(:server t)) | |
1131 | (make-network-process :name name :buffer buffer | |
1132 | :service service :server t :noquery t | |
1133 | :sentinel sentinel :filter filter))) | |
1134 | ||
1135 | )) ;; (featurep 'make-network-process) | |
1136 | ||
1137 | ||
1138 | ;; compatibility | |
1139 | ||
1140 | (defun process-kill-without-query (process &optional flag) | |
1141 | "Say no query needed if PROCESS is running when Emacs is exited. | |
1142 | Optional second argument if non-nil says to require a query. | |
264ef586 | 1143 | Value is t if a query was formerly required. |
7aaacaff RS |
1144 | New code should not use this function; use `process-query-on-exit-flag' |
1145 | or `set-process-query-on-exit-flag' instead." | |
1146 | (let ((old (process-query-on-exit-flag process))) | |
1147 | (set-process-query-on-exit-flag process nil) | |
1148 | old)) | |
9a5336ae | 1149 | |
34368d12 KS |
1150 | ;; process plist management |
1151 | ||
1152 | (defun process-get (process propname) | |
1153 | "Return the value of PROCESS' PROPNAME property. | |
1154 | This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." | |
1155 | (plist-get (process-plist process) propname)) | |
1156 | ||
1157 | (defun process-put (process propname value) | |
1158 | "Change PROCESS' PROPNAME property to VALUE. | |
1159 | It can be retrieved with `(process-get PROCESS PROPNAME)'." | |
f1180544 | 1160 | (set-process-plist process |
34368d12 KS |
1161 | (plist-put (process-plist process) propname value))) |
1162 | ||
9a5336ae JB |
1163 | \f |
1164 | ;;;; Input and display facilities. | |
1165 | ||
77a5664f | 1166 | (defvar read-quoted-char-radix 8 |
1ba764de | 1167 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
77a5664f RS |
1168 | Legitimate radix values are 8, 10 and 16.") |
1169 | ||
1170 | (custom-declare-variable-early | |
264ef586 | 1171 | 'read-quoted-char-radix 8 |
77a5664f | 1172 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
1ba764de RS |
1173 | Legitimate radix values are 8, 10 and 16." |
1174 | :type '(choice (const 8) (const 10) (const 16)) | |
1175 | :group 'editing-basics) | |
1176 | ||
9a5336ae | 1177 | (defun read-quoted-char (&optional prompt) |
2444730b RS |
1178 | "Like `read-char', but do not allow quitting. |
1179 | Also, if the first character read is an octal digit, | |
1180 | we read any number of octal digits and return the | |
569b03f2 | 1181 | specified character code. Any nondigit terminates the sequence. |
1ba764de | 1182 | If the terminator is RET, it is discarded; |
2444730b RS |
1183 | any other terminator is used itself as input. |
1184 | ||
569b03f2 RS |
1185 | The optional argument PROMPT specifies a string to use to prompt the user. |
1186 | The variable `read-quoted-char-radix' controls which radix to use | |
1187 | for numeric input." | |
c83256a0 | 1188 | (let ((message-log-max nil) done (first t) (code 0) char translated) |
2444730b RS |
1189 | (while (not done) |
1190 | (let ((inhibit-quit first) | |
42e636f0 KH |
1191 | ;; Don't let C-h get the help message--only help function keys. |
1192 | (help-char nil) | |
1193 | (help-form | |
1194 | "Type the special character you want to use, | |
2444730b | 1195 | or the octal character code. |
1ba764de | 1196 | RET terminates the character code and is discarded; |
2444730b | 1197 | any other non-digit terminates the character code and is then used as input.")) |
3f0161d0 | 1198 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
9a5336ae | 1199 | (if inhibit-quit (setq quit-flag nil))) |
3f0161d0 SM |
1200 | ;; Translate TAB key into control-I ASCII character, and so on. |
1201 | ;; Note: `read-char' does it using the `ascii-character' property. | |
1202 | ;; We could try and use read-key-sequence instead, but then C-q ESC | |
1203 | ;; or C-q C-x might not return immediately since ESC or C-x might be | |
1204 | ;; bound to some prefix in function-key-map or key-translation-map. | |
c83256a0 RS |
1205 | (setq translated char) |
1206 | (let ((translation (lookup-key function-key-map (vector char)))) | |
1207 | (if (arrayp translation) | |
1208 | (setq translated (aref translation 0)))) | |
1209 | (cond ((null translated)) | |
1210 | ((not (integerp translated)) | |
1211 | (setq unread-command-events (list char) | |
1ba764de | 1212 | done t)) |
c83256a0 | 1213 | ((/= (logand translated ?\M-\^@) 0) |
bf896a1b | 1214 | ;; Turn a meta-character into a character with the 0200 bit set. |
c83256a0 | 1215 | (setq code (logior (logand translated (lognot ?\M-\^@)) 128) |
bf896a1b | 1216 | done t)) |
c83256a0 RS |
1217 | ((and (<= ?0 translated) (< translated (+ ?0 (min 10 read-quoted-char-radix)))) |
1218 | (setq code (+ (* code read-quoted-char-radix) (- translated ?0))) | |
1219 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
1220 | ((and (<= ?a (downcase translated)) | |
d47f7515 | 1221 | (< (downcase translated) (+ ?a -10 (min 36 read-quoted-char-radix)))) |
92304bc8 | 1222 | (setq code (+ (* code read-quoted-char-radix) |
c83256a0 RS |
1223 | (+ 10 (- (downcase translated) ?a)))) |
1224 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
1225 | ((and (not first) (eq translated ?\C-m)) | |
2444730b RS |
1226 | (setq done t)) |
1227 | ((not first) | |
c83256a0 | 1228 | (setq unread-command-events (list char) |
2444730b | 1229 | done t)) |
c83256a0 | 1230 | (t (setq code translated |
2444730b RS |
1231 | done t))) |
1232 | (setq first nil)) | |
bf896a1b | 1233 | code)) |
9a5336ae | 1234 | |
44071d6b RS |
1235 | (defun read-passwd (prompt &optional confirm default) |
1236 | "Read a password, prompting with PROMPT. Echo `.' for each character typed. | |
e0e4cb7a | 1237 | End with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. |
44071d6b RS |
1238 | Optional argument CONFIRM, if non-nil, then read it twice to make sure. |
1239 | Optional DEFAULT is a default password to use instead of empty input." | |
1240 | (if confirm | |
1241 | (let (success) | |
1242 | (while (not success) | |
1243 | (let ((first (read-passwd prompt nil default)) | |
1244 | (second (read-passwd "Confirm password: " nil default))) | |
1245 | (if (equal first second) | |
fe10cef0 | 1246 | (progn |
f0491f76 | 1247 | (and (arrayp second) (clear-string second)) |
fe10cef0 | 1248 | (setq success first)) |
f0491f76 RS |
1249 | (and (arrayp first) (clear-string first)) |
1250 | (and (arrayp second) (clear-string second)) | |
44071d6b RS |
1251 | (message "Password not repeated accurately; please start over") |
1252 | (sit-for 1)))) | |
1253 | success) | |
1254 | (let ((pass nil) | |
1255 | (c 0) | |
1256 | (echo-keystrokes 0) | |
1257 | (cursor-in-echo-area t)) | |
1258 | (while (progn (message "%s%s" | |
1259 | prompt | |
1260 | (make-string (length pass) ?.)) | |
42ccb7c8 | 1261 | (setq c (read-char-exclusive nil t)) |
44071d6b | 1262 | (and (/= c ?\r) (/= c ?\n) (/= c ?\e))) |
719349f6 | 1263 | (clear-this-command-keys) |
44071d6b | 1264 | (if (= c ?\C-u) |
fe10cef0 | 1265 | (progn |
f0491f76 | 1266 | (and (arrayp pass) (clear-string pass)) |
fe10cef0 | 1267 | (setq pass "")) |
44071d6b | 1268 | (if (and (/= c ?\b) (/= c ?\177)) |
fe10cef0 GM |
1269 | (let* ((new-char (char-to-string c)) |
1270 | (new-pass (concat pass new-char))) | |
f0491f76 RS |
1271 | (and (arrayp pass) (clear-string pass)) |
1272 | (clear-string new-char) | |
fe10cef0 GM |
1273 | (setq c ?\0) |
1274 | (setq pass new-pass)) | |
44071d6b | 1275 | (if (> (length pass) 0) |
fe10cef0 | 1276 | (let ((new-pass (substring pass 0 -1))) |
f0491f76 | 1277 | (and (arrayp pass) (clear-string pass)) |
fe10cef0 | 1278 | (setq pass new-pass)))))) |
44071d6b RS |
1279 | (message nil) |
1280 | (or pass default "")))) | |
e0e4cb7a | 1281 | \f |
2493767e RS |
1282 | ;;; Atomic change groups. |
1283 | ||
69cae2d4 RS |
1284 | (defmacro atomic-change-group (&rest body) |
1285 | "Perform BODY as an atomic change group. | |
1286 | This means that if BODY exits abnormally, | |
1287 | all of its changes to the current buffer are undone. | |
b9ab4064 | 1288 | This works regardless of whether undo is enabled in the buffer. |
69cae2d4 RS |
1289 | |
1290 | This mechanism is transparent to ordinary use of undo; | |
1291 | if undo is enabled in the buffer and BODY succeeds, the | |
1292 | user can undo the change normally." | |
1293 | (let ((handle (make-symbol "--change-group-handle--")) | |
1294 | (success (make-symbol "--change-group-success--"))) | |
1295 | `(let ((,handle (prepare-change-group)) | |
1296 | (,success nil)) | |
1297 | (unwind-protect | |
1298 | (progn | |
1299 | ;; This is inside the unwind-protect because | |
1300 | ;; it enables undo if that was disabled; we need | |
1301 | ;; to make sure that it gets disabled again. | |
1302 | (activate-change-group ,handle) | |
1303 | ,@body | |
1304 | (setq ,success t)) | |
1305 | ;; Either of these functions will disable undo | |
1306 | ;; if it was disabled before. | |
1307 | (if ,success | |
1308 | (accept-change-group ,handle) | |
1309 | (cancel-change-group ,handle)))))) | |
1310 | ||
62ea1306 | 1311 | (defun prepare-change-group (&optional buffer) |
69cae2d4 | 1312 | "Return a handle for the current buffer's state, for a change group. |
62ea1306 | 1313 | If you specify BUFFER, make a handle for BUFFER's state instead. |
69cae2d4 RS |
1314 | |
1315 | Pass the handle to `activate-change-group' afterward to initiate | |
1316 | the actual changes of the change group. | |
1317 | ||
1318 | To finish the change group, call either `accept-change-group' or | |
1319 | `cancel-change-group' passing the same handle as argument. Call | |
1320 | `accept-change-group' to accept the changes in the group as final; | |
1321 | call `cancel-change-group' to undo them all. You should use | |
1322 | `unwind-protect' to make sure the group is always finished. The call | |
1323 | to `activate-change-group' should be inside the `unwind-protect'. | |
1324 | Once you finish the group, don't use the handle again--don't try to | |
1325 | finish the same group twice. For a simple example of correct use, see | |
1326 | the source code of `atomic-change-group'. | |
1327 | ||
1328 | The handle records only the specified buffer. To make a multibuffer | |
1329 | change group, call this function once for each buffer you want to | |
1330 | cover, then use `nconc' to combine the returned values, like this: | |
1331 | ||
1332 | (nconc (prepare-change-group buffer-1) | |
1333 | (prepare-change-group buffer-2)) | |
1334 | ||
1335 | You can then activate that multibuffer change group with a single | |
1336 | call to `activate-change-group' and finish it with a single call | |
1337 | to `accept-change-group' or `cancel-change-group'." | |
1338 | ||
62ea1306 RS |
1339 | (if buffer |
1340 | (list (cons buffer (with-current-buffer buffer buffer-undo-list))) | |
1341 | (list (cons (current-buffer) buffer-undo-list)))) | |
69cae2d4 RS |
1342 | |
1343 | (defun activate-change-group (handle) | |
1344 | "Activate a change group made with `prepare-change-group' (which see)." | |
1345 | (dolist (elt handle) | |
1346 | (with-current-buffer (car elt) | |
1347 | (if (eq buffer-undo-list t) | |
1348 | (setq buffer-undo-list nil))))) | |
1349 | ||
1350 | (defun accept-change-group (handle) | |
1351 | "Finish a change group made with `prepare-change-group' (which see). | |
1352 | This finishes the change group by accepting its changes as final." | |
1353 | (dolist (elt handle) | |
1354 | (with-current-buffer (car elt) | |
1355 | (if (eq elt t) | |
1356 | (setq buffer-undo-list t))))) | |
1357 | ||
1358 | (defun cancel-change-group (handle) | |
1359 | "Finish a change group made with `prepare-change-group' (which see). | |
1360 | This finishes the change group by reverting all of its changes." | |
1361 | (dolist (elt handle) | |
1362 | (with-current-buffer (car elt) | |
1363 | (setq elt (cdr elt)) | |
264ef586 | 1364 | (let ((old-car |
69cae2d4 RS |
1365 | (if (consp elt) (car elt))) |
1366 | (old-cdr | |
1367 | (if (consp elt) (cdr elt)))) | |
1368 | ;; Temporarily truncate the undo log at ELT. | |
1369 | (when (consp elt) | |
1370 | (setcar elt nil) (setcdr elt nil)) | |
1371 | (unless (eq last-command 'undo) (undo-start)) | |
1372 | ;; Make sure there's no confusion. | |
1373 | (when (and (consp elt) (not (eq elt (last pending-undo-list)))) | |
1374 | (error "Undoing to some unrelated state")) | |
1375 | ;; Undo it all. | |
1376 | (while pending-undo-list (undo-more 1)) | |
1377 | ;; Reset the modified cons cell ELT to its original content. | |
1378 | (when (consp elt) | |
1379 | (setcar elt old-car) | |
1380 | (setcdr elt old-cdr)) | |
1381 | ;; Revert the undo info to what it was when we grabbed the state. | |
1382 | (setq buffer-undo-list elt))))) | |
1383 | \f | |
a9d956be RS |
1384 | ;; For compatibility. |
1385 | (defalias 'redraw-modeline 'force-mode-line-update) | |
1386 | ||
9a5336ae | 1387 | (defun force-mode-line-update (&optional all) |
926dd40c LK |
1388 | "Force redisplay of the current buffer's mode line and header line. |
1389 | With optional non-nil ALL, force redisplay of all mode lines and | |
1390 | header lines. This function also forces recomputation of the | |
1391 | menu bar menus and the frame title." | |
9a5336ae JB |
1392 | (if all (save-excursion (set-buffer (other-buffer)))) |
1393 | (set-buffer-modified-p (buffer-modified-p))) | |
1394 | ||
aa3b4ded | 1395 | (defun momentary-string-display (string pos &optional exit-char message) |
be9b65ac DL |
1396 | "Momentarily display STRING in the buffer at POS. |
1397 | Display remains until next character is typed. | |
1398 | If the char is EXIT-CHAR (optional third arg, default is SPC) it is swallowed; | |
1399 | otherwise it is then available as input (as a command if nothing else). | |
1400 | Display MESSAGE (optional fourth arg) in the echo area. | |
1401 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
1402 | (or exit-char (setq exit-char ?\ )) | |
c306e0e0 | 1403 | (let ((inhibit-read-only t) |
ca2ec1c5 RS |
1404 | ;; Don't modify the undo list at all. |
1405 | (buffer-undo-list t) | |
be9b65ac DL |
1406 | (modified (buffer-modified-p)) |
1407 | (name buffer-file-name) | |
1408 | insert-end) | |
1409 | (unwind-protect | |
1410 | (progn | |
1411 | (save-excursion | |
1412 | (goto-char pos) | |
1413 | ;; defeat file locking... don't try this at home, kids! | |
1414 | (setq buffer-file-name nil) | |
1415 | (insert-before-markers string) | |
3eec84bf RS |
1416 | (setq insert-end (point)) |
1417 | ;; If the message end is off screen, recenter now. | |
024ae2c6 | 1418 | (if (< (window-end nil t) insert-end) |
3eec84bf RS |
1419 | (recenter (/ (window-height) 2))) |
1420 | ;; If that pushed message start off the screen, | |
1421 | ;; scroll to start it at the top of the screen. | |
1422 | (move-to-window-line 0) | |
1423 | (if (> (point) pos) | |
1424 | (progn | |
1425 | (goto-char pos) | |
1426 | (recenter 0)))) | |
be9b65ac DL |
1427 | (message (or message "Type %s to continue editing.") |
1428 | (single-key-description exit-char)) | |
3547c855 | 1429 | (let ((char (read-event))) |
be9b65ac | 1430 | (or (eq char exit-char) |
dbc4e1c1 | 1431 | (setq unread-command-events (list char))))) |
be9b65ac DL |
1432 | (if insert-end |
1433 | (save-excursion | |
1434 | (delete-region pos insert-end))) | |
1435 | (setq buffer-file-name name) | |
1436 | (set-buffer-modified-p modified)))) | |
1437 | ||
9a5336ae | 1438 | \f |
aa3b4ded SM |
1439 | ;;;; Overlay operations |
1440 | ||
1441 | (defun copy-overlay (o) | |
1442 | "Return a copy of overlay O." | |
1443 | (let ((o1 (make-overlay (overlay-start o) (overlay-end o) | |
1444 | ;; FIXME: there's no easy way to find the | |
1445 | ;; insertion-type of the two markers. | |
1446 | (overlay-buffer o))) | |
1447 | (props (overlay-properties o))) | |
1448 | (while props | |
1449 | (overlay-put o1 (pop props) (pop props))) | |
1450 | o1)) | |
1451 | ||
1452 | (defun remove-overlays (beg end name val) | |
1453 | "Clear BEG and END of overlays whose property NAME has value VAL. | |
1454 | Overlays might be moved and or split." | |
1455 | (if (< end beg) | |
1456 | (setq beg (prog1 end (setq end beg)))) | |
1457 | (save-excursion | |
1458 | (dolist (o (overlays-in beg end)) | |
1459 | (when (eq (overlay-get o name) val) | |
1460 | ;; Either push this overlay outside beg...end | |
1461 | ;; or split it to exclude beg...end | |
1462 | ;; or delete it entirely (if it is contained in beg...end). | |
1463 | (if (< (overlay-start o) beg) | |
1464 | (if (> (overlay-end o) end) | |
1465 | (progn | |
1466 | (move-overlay (copy-overlay o) | |
1467 | (overlay-start o) beg) | |
1468 | (move-overlay o end (overlay-end o))) | |
1469 | (move-overlay o (overlay-start o) beg)) | |
1470 | (if (> (overlay-end o) end) | |
1471 | (move-overlay o end (overlay-end o)) | |
1472 | (delete-overlay o))))))) | |
c5802acf | 1473 | \f |
9a5336ae JB |
1474 | ;;;; Miscellanea. |
1475 | ||
448b61c9 RS |
1476 | ;; A number of major modes set this locally. |
1477 | ;; Give it a global value to avoid compiler warnings. | |
1478 | (defvar font-lock-defaults nil) | |
1479 | ||
4fb17037 RS |
1480 | (defvar suspend-hook nil |
1481 | "Normal hook run by `suspend-emacs', before suspending.") | |
1482 | ||
1483 | (defvar suspend-resume-hook nil | |
1484 | "Normal hook run by `suspend-emacs', after Emacs is continued.") | |
1485 | ||
784bc7cd RS |
1486 | (defvar temp-buffer-show-hook nil |
1487 | "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer. | |
1488 | When the hook runs, the temporary buffer is current, and the window it | |
1489 | was displayed in is selected. This hook is normally set up with a | |
1490 | function to make the buffer read only, and find function names and | |
1491 | variable names in it, provided the major mode is still Help mode.") | |
1492 | ||
1493 | (defvar temp-buffer-setup-hook nil | |
1494 | "Normal hook run by `with-output-to-temp-buffer' at the start. | |
1495 | When the hook runs, the temporary buffer is current. | |
1496 | This hook is normally set up with a function to put the buffer in Help | |
1497 | mode.") | |
1498 | ||
448b61c9 RS |
1499 | ;; Avoid compiler warnings about this variable, |
1500 | ;; which has a special meaning on certain system types. | |
1501 | (defvar buffer-file-type nil | |
1502 | "Non-nil if the visited file is a binary file. | |
1503 | This variable is meaningful on MS-DOG and Windows NT. | |
1504 | On those systems, it is automatically local in every buffer. | |
1505 | On other systems, this variable is normally always nil.") | |
1506 | ||
a860d25f | 1507 | ;; This should probably be written in C (i.e., without using `walk-windows'). |
63503b24 | 1508 | (defun get-buffer-window-list (buffer &optional minibuf frame) |
a860d25f | 1509 | "Return windows currently displaying BUFFER, or nil if none. |
63503b24 | 1510 | See `walk-windows' for the meaning of MINIBUF and FRAME." |
43c5ac8c | 1511 | (let ((buffer (if (bufferp buffer) buffer (get-buffer buffer))) windows) |
a860d25f SM |
1512 | (walk-windows (function (lambda (window) |
1513 | (if (eq (window-buffer window) buffer) | |
1514 | (setq windows (cons window windows))))) | |
63503b24 | 1515 | minibuf frame) |
a860d25f SM |
1516 | windows)) |
1517 | ||
f9269e19 RS |
1518 | (defun ignore (&rest ignore) |
1519 | "Do nothing and return nil. | |
1520 | This function accepts any number of arguments, but ignores them." | |
c0f1a4f6 | 1521 | (interactive) |
9a5336ae JB |
1522 | nil) |
1523 | ||
1524 | (defun error (&rest args) | |
aa308ce2 RS |
1525 | "Signal an error, making error message by passing all args to `format'. |
1526 | In Emacs, the convention is that error messages start with a capital | |
1527 | letter but *do not* end with a period. Please follow this convention | |
1528 | for the sake of consistency." | |
9a5336ae JB |
1529 | (while t |
1530 | (signal 'error (list (apply 'format args))))) | |
1531 | ||
cef7ae6e | 1532 | (defalias 'user-original-login-name 'user-login-name) |
9a5336ae | 1533 | |
2493767e RS |
1534 | (defvar yank-excluded-properties) |
1535 | ||
8ed59ad5 KS |
1536 | (defun remove-yank-excluded-properties (start end) |
1537 | "Remove `yank-excluded-properties' between START and END positions. | |
1538 | Replaces `category' properties with their defined properties." | |
1539 | (let ((inhibit-read-only t)) | |
1540 | ;; Replace any `category' property with the properties it stands for. | |
1541 | (unless (memq yank-excluded-properties '(t nil)) | |
1542 | (save-excursion | |
1543 | (goto-char start) | |
1544 | (while (< (point) end) | |
1545 | (let ((cat (get-text-property (point) 'category)) | |
1546 | run-end) | |
8ed59ad5 KS |
1547 | (setq run-end |
1548 | (next-single-property-change (point) 'category nil end)) | |
ebaa3349 RS |
1549 | (when cat |
1550 | (let (run-end2 original) | |
1551 | (remove-list-of-text-properties (point) run-end '(category)) | |
1552 | (while (< (point) run-end) | |
1553 | (setq run-end2 (next-property-change (point) nil run-end)) | |
1554 | (setq original (text-properties-at (point))) | |
1555 | (set-text-properties (point) run-end2 (symbol-plist cat)) | |
1556 | (add-text-properties (point) run-end2 original) | |
1557 | (goto-char run-end2)))) | |
1558 | (goto-char run-end))))) | |
8ed59ad5 KS |
1559 | (if (eq yank-excluded-properties t) |
1560 | (set-text-properties start end nil) | |
ebaa3349 | 1561 | (remove-list-of-text-properties start end yank-excluded-properties)))) |
8ed59ad5 | 1562 | |
e0e80ec9 KS |
1563 | (defvar yank-undo-function) |
1564 | ||
1565 | (defun insert-for-yank (string) | |
529c9409 EZ |
1566 | "Calls `insert-for-yank-1' repetitively for each `yank-handler' segment. |
1567 | ||
1568 | See `insert-for-yank-1' for more details." | |
1569 | (let (to) | |
1570 | (while (setq to (next-single-property-change 0 'yank-handler string)) | |
1571 | (insert-for-yank-1 (substring string 0 to)) | |
1572 | (setq string (substring string to)))) | |
1573 | (insert-for-yank-1 string)) | |
1574 | ||
1575 | (defun insert-for-yank-1 (string) | |
e0e80ec9 | 1576 | "Insert STRING at point, stripping some text properties. |
529c9409 | 1577 | |
e0e80ec9 KS |
1578 | Strip text properties from the inserted text according to |
1579 | `yank-excluded-properties'. Otherwise just like (insert STRING). | |
1580 | ||
374d3fe7 | 1581 | If STRING has a non-nil `yank-handler' property on the first character, |
e0e80ec9 KS |
1582 | the normal insert behaviour is modified in various ways. The value of |
1583 | the yank-handler property must be a list with one to five elements | |
9dd10e25 | 1584 | with the following format: (FUNCTION PARAM NOEXCLUDE UNDO). |
e0e80ec9 KS |
1585 | When FUNCTION is present and non-nil, it is called instead of `insert' |
1586 | to insert the string. FUNCTION takes one argument--the object to insert. | |
1587 | If PARAM is present and non-nil, it replaces STRING as the object | |
1588 | passed to FUNCTION (or `insert'); for example, if FUNCTION is | |
1589 | `yank-rectangle', PARAM may be a list of strings to insert as a | |
1590 | rectangle. | |
1591 | If NOEXCLUDE is present and non-nil, the normal removal of the | |
1592 | yank-excluded-properties is not performed; instead FUNCTION is | |
1593 | responsible for removing those properties. This may be necessary | |
1594 | if FUNCTION adjusts point before or after inserting the object. | |
1595 | If UNDO is present and non-nil, it is a function that will be called | |
1596 | by `yank-pop' to undo the insertion of the current object. It is | |
f1180544 | 1597 | called with two arguments, the start and end of the current region. |
9dd10e25 | 1598 | FUNCTION may set `yank-undo-function' to override the UNDO value." |
57596fb6 KS |
1599 | (let* ((handler (and (stringp string) |
1600 | (get-text-property 0 'yank-handler string))) | |
1601 | (param (or (nth 1 handler) string)) | |
e0e80ec9 | 1602 | (opoint (point))) |
57596fb6 KS |
1603 | (setq yank-undo-function t) |
1604 | (if (nth 0 handler) ;; FUNCTION | |
1605 | (funcall (car handler) param) | |
e0e80ec9 | 1606 | (insert param)) |
57596fb6 | 1607 | (unless (nth 2 handler) ;; NOEXCLUDE |
e0e80ec9 | 1608 | (remove-yank-excluded-properties opoint (point))) |
57596fb6 KS |
1609 | (if (eq yank-undo-function t) ;; not set by FUNCTION |
1610 | (setq yank-undo-function (nth 3 handler))) ;; UNDO | |
1611 | (if (nth 4 handler) ;; COMMAND | |
1612 | (setq this-command (nth 4 handler))))) | |
f1180544 | 1613 | |
3b8690f6 KS |
1614 | (defun insert-buffer-substring-no-properties (buf &optional start end) |
1615 | "Insert before point a substring of buffer BUFFER, without text properties. | |
1616 | BUFFER may be a buffer or a buffer name. | |
1617 | Arguments START and END are character numbers specifying the substring. | |
1618 | They default to the beginning and the end of BUFFER." | |
1619 | (let ((opoint (point))) | |
1620 | (insert-buffer-substring buf start end) | |
1621 | (let ((inhibit-read-only t)) | |
1622 | (set-text-properties opoint (point) nil)))) | |
1623 | ||
1624 | (defun insert-buffer-substring-as-yank (buf &optional start end) | |
1625 | "Insert before point a part of buffer BUFFER, stripping some text properties. | |
1626 | BUFFER may be a buffer or a buffer name. Arguments START and END are | |
1627 | character numbers specifying the substring. They default to the | |
1628 | beginning and the end of BUFFER. Strip text properties from the | |
1629 | inserted text according to `yank-excluded-properties'." | |
0e874d89 RS |
1630 | ;; Since the buffer text should not normally have yank-handler properties, |
1631 | ;; there is no need to handle them here. | |
3b8690f6 KS |
1632 | (let ((opoint (point))) |
1633 | (insert-buffer-substring buf start end) | |
8ed59ad5 | 1634 | (remove-yank-excluded-properties opoint (point)))) |
3b8690f6 | 1635 | |
2493767e RS |
1636 | \f |
1637 | ;; Synchronous shell commands. | |
1638 | ||
be9b65ac DL |
1639 | (defun start-process-shell-command (name buffer &rest args) |
1640 | "Start a program in a subprocess. Return the process object for it. | |
1641 | Args are NAME BUFFER COMMAND &rest COMMAND-ARGS. | |
1642 | NAME is name for process. It is modified if necessary to make it unique. | |
1643 | BUFFER is the buffer or (buffer-name) to associate with the process. | |
1644 | Process output goes at end of that buffer, unless you specify | |
1645 | an output stream or filter function to handle the output. | |
1646 | BUFFER may be also nil, meaning that this process is not associated | |
1647 | with any buffer | |
1648 | Third arg is command name, the name of a shell command. | |
1649 | Remaining arguments are the arguments for the command. | |
4f1d6310 | 1650 | Wildcards and redirection are handled as usual in the shell." |
a247bf21 KH |
1651 | (cond |
1652 | ((eq system-type 'vax-vms) | |
1653 | (apply 'start-process name buffer args)) | |
b59f6d7a RS |
1654 | ;; We used to use `exec' to replace the shell with the command, |
1655 | ;; but that failed to handle (...) and semicolon, etc. | |
a247bf21 KH |
1656 | (t |
1657 | (start-process name buffer shell-file-name shell-command-switch | |
b59f6d7a | 1658 | (mapconcat 'identity args " "))))) |
93aca633 MB |
1659 | |
1660 | (defun call-process-shell-command (command &optional infile buffer display | |
1661 | &rest args) | |
1662 | "Execute the shell command COMMAND synchronously in separate process. | |
1663 | The remaining arguments are optional. | |
1664 | The program's input comes from file INFILE (nil means `/dev/null'). | |
1665 | Insert output in BUFFER before point; t means current buffer; | |
1666 | nil for BUFFER means discard it; 0 means discard and don't wait. | |
1667 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, | |
1668 | REAL-BUFFER says what to do with standard output, as above, | |
1669 | while STDERR-FILE says what to do with standard error in the child. | |
1670 | STDERR-FILE may be nil (discard standard error output), | |
1671 | t (mix it with ordinary output), or a file name string. | |
1672 | ||
1673 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. | |
1674 | Remaining arguments are strings passed as additional arguments for COMMAND. | |
1675 | Wildcards and redirection are handled as usual in the shell. | |
1676 | ||
1677 | If BUFFER is 0, `call-process-shell-command' returns immediately with value nil. | |
1678 | Otherwise it waits for COMMAND to terminate and returns a numeric exit | |
1679 | status or a signal description string. | |
1680 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again." | |
1681 | (cond | |
1682 | ((eq system-type 'vax-vms) | |
1683 | (apply 'call-process command infile buffer display args)) | |
1684 | ;; We used to use `exec' to replace the shell with the command, | |
1685 | ;; but that failed to handle (...) and semicolon, etc. | |
1686 | (t | |
1687 | (call-process shell-file-name | |
1688 | infile buffer display | |
1689 | shell-command-switch | |
1690 | (mapconcat 'identity (cons command args) " "))))) | |
a7ed4c2a | 1691 | \f |
a7f284ec RS |
1692 | (defmacro with-current-buffer (buffer &rest body) |
1693 | "Execute the forms in BODY with BUFFER as the current buffer. | |
a2fdb55c EN |
1694 | The value returned is the value of the last form in BODY. |
1695 | See also `with-temp-buffer'." | |
d47f7515 SM |
1696 | (declare (indent 1) (debug t)) |
1697 | `(save-current-buffer | |
1698 | (set-buffer ,buffer) | |
1699 | ,@body)) | |
1700 | ||
1701 | (defmacro with-selected-window (window &rest body) | |
1702 | "Execute the forms in BODY with WINDOW as the selected window. | |
1703 | The value returned is the value of the last form in BODY. | |
4df623c0 | 1704 | This does not alter the buffer list ordering. |
d47f7515 SM |
1705 | See also `with-temp-buffer'." |
1706 | (declare (indent 1) (debug t)) | |
4df623c0 RS |
1707 | ;; Most of this code is a copy of save-selected-window. |
1708 | `(let ((save-selected-window-window (selected-window)) | |
1709 | (save-selected-window-alist | |
1710 | (mapcar (lambda (frame) (list frame (frame-selected-window frame))) | |
1711 | (frame-list)))) | |
1712 | (unwind-protect | |
1713 | (progn (select-window ,window 'norecord) | |
1714 | ,@body) | |
1715 | (dolist (elt save-selected-window-alist) | |
1716 | (and (frame-live-p (car elt)) | |
1717 | (window-live-p (cadr elt)) | |
1718 | (set-frame-selected-window (car elt) (cadr elt)))) | |
1719 | (if (window-live-p save-selected-window-window) | |
1720 | ;; This is where the code differs from save-selected-window. | |
ec589b78 | 1721 | (select-window save-selected-window-window 'norecord))))) |
a7f284ec | 1722 | |
e5bb8a8c SM |
1723 | (defmacro with-temp-file (file &rest body) |
1724 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. | |
1725 | The value returned is the value of the last form in BODY. | |
a2fdb55c | 1726 | See also `with-temp-buffer'." |
f30e0cd8 | 1727 | (declare (debug t)) |
a7ed4c2a | 1728 | (let ((temp-file (make-symbol "temp-file")) |
a2fdb55c EN |
1729 | (temp-buffer (make-symbol "temp-buffer"))) |
1730 | `(let ((,temp-file ,file) | |
1731 | (,temp-buffer | |
1732 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) | |
1733 | (unwind-protect | |
1734 | (prog1 | |
1735 | (with-current-buffer ,temp-buffer | |
e5bb8a8c | 1736 | ,@body) |
a2fdb55c EN |
1737 | (with-current-buffer ,temp-buffer |
1738 | (widen) | |
1739 | (write-region (point-min) (point-max) ,temp-file nil 0))) | |
1740 | (and (buffer-name ,temp-buffer) | |
1741 | (kill-buffer ,temp-buffer)))))) | |
1742 | ||
e5bb8a8c | 1743 | (defmacro with-temp-message (message &rest body) |
a600effe | 1744 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
e5bb8a8c SM |
1745 | The original message is restored to the echo area after BODY has finished. |
1746 | The value returned is the value of the last form in BODY. | |
a600effe SM |
1747 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
1748 | If MESSAGE is nil, the echo area and message log buffer are unchanged. | |
1749 | Use a MESSAGE of \"\" to temporarily clear the echo area." | |
f30e0cd8 | 1750 | (declare (debug t)) |
110201c8 SM |
1751 | (let ((current-message (make-symbol "current-message")) |
1752 | (temp-message (make-symbol "with-temp-message"))) | |
1753 | `(let ((,temp-message ,message) | |
1754 | (,current-message)) | |
e5bb8a8c SM |
1755 | (unwind-protect |
1756 | (progn | |
110201c8 SM |
1757 | (when ,temp-message |
1758 | (setq ,current-message (current-message)) | |
aadf7ff3 | 1759 | (message "%s" ,temp-message)) |
e5bb8a8c | 1760 | ,@body) |
cad84646 RS |
1761 | (and ,temp-message |
1762 | (if ,current-message | |
1763 | (message "%s" ,current-message) | |
1764 | (message nil))))))) | |
e5bb8a8c SM |
1765 | |
1766 | (defmacro with-temp-buffer (&rest body) | |
1767 | "Create a temporary buffer, and evaluate BODY there like `progn'. | |
a2fdb55c | 1768 | See also `with-temp-file' and `with-output-to-string'." |
d47f7515 | 1769 | (declare (indent 0) (debug t)) |
a2fdb55c EN |
1770 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
1771 | `(let ((,temp-buffer | |
1772 | (get-buffer-create (generate-new-buffer-name " *temp*")))) | |
1773 | (unwind-protect | |
1774 | (with-current-buffer ,temp-buffer | |
e5bb8a8c | 1775 | ,@body) |
a2fdb55c EN |
1776 | (and (buffer-name ,temp-buffer) |
1777 | (kill-buffer ,temp-buffer)))))) | |
1778 | ||
5db7925d RS |
1779 | (defmacro with-output-to-string (&rest body) |
1780 | "Execute BODY, return the text it sent to `standard-output', as a string." | |
d47f7515 | 1781 | (declare (indent 0) (debug t)) |
a2fdb55c EN |
1782 | `(let ((standard-output |
1783 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) | |
5db7925d RS |
1784 | (let ((standard-output standard-output)) |
1785 | ,@body) | |
a2fdb55c EN |
1786 | (with-current-buffer standard-output |
1787 | (prog1 | |
1788 | (buffer-string) | |
1789 | (kill-buffer nil))))) | |
2ec9c94e | 1790 | |
0764e16f SM |
1791 | (defmacro with-local-quit (&rest body) |
1792 | "Execute BODY with `inhibit-quit' temporarily bound to nil." | |
12320833 | 1793 | (declare (debug t) (indent 0)) |
0764e16f SM |
1794 | `(condition-case nil |
1795 | (let ((inhibit-quit nil)) | |
1796 | ,@body) | |
1797 | (quit (setq quit-flag t)))) | |
1798 | ||
2ec9c94e RS |
1799 | (defmacro combine-after-change-calls (&rest body) |
1800 | "Execute BODY, but don't call the after-change functions till the end. | |
1801 | If BODY makes changes in the buffer, they are recorded | |
1802 | and the functions on `after-change-functions' are called several times | |
1803 | when BODY is finished. | |
31aa282e | 1804 | The return value is the value of the last form in BODY. |
2ec9c94e RS |
1805 | |
1806 | If `before-change-functions' is non-nil, then calls to the after-change | |
1807 | functions can't be deferred, so in that case this macro has no effect. | |
1808 | ||
1809 | Do not alter `after-change-functions' or `before-change-functions' | |
1810 | in BODY." | |
d47f7515 | 1811 | (declare (indent 0) (debug t)) |
2ec9c94e RS |
1812 | `(unwind-protect |
1813 | (let ((combine-after-change-calls t)) | |
1814 | . ,body) | |
1815 | (combine-after-change-execute))) | |
1816 | ||
c834b52c | 1817 | |
a13fe4c5 SM |
1818 | (defvar delay-mode-hooks nil |
1819 | "If non-nil, `run-mode-hooks' should delay running the hooks.") | |
1820 | (defvar delayed-mode-hooks nil | |
1821 | "List of delayed mode hooks waiting to be run.") | |
1822 | (make-variable-buffer-local 'delayed-mode-hooks) | |
1823 | ||
1824 | (defun run-mode-hooks (&rest hooks) | |
1825 | "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. | |
1826 | Execution is delayed if `delay-mode-hooks' is non-nil. | |
1827 | Major mode functions should use this." | |
1828 | (if delay-mode-hooks | |
1829 | ;; Delaying case. | |
1830 | (dolist (hook hooks) | |
1831 | (push hook delayed-mode-hooks)) | |
1832 | ;; Normal case, just run the hook as before plus any delayed hooks. | |
1833 | (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) | |
1834 | (setq delayed-mode-hooks nil) | |
1835 | (apply 'run-hooks hooks))) | |
1836 | ||
1837 | (defmacro delay-mode-hooks (&rest body) | |
1838 | "Execute BODY, but delay any `run-mode-hooks'. | |
1839 | Only affects hooks run in the current buffer." | |
f30e0cd8 | 1840 | (declare (debug t)) |
a13fe4c5 SM |
1841 | `(progn |
1842 | (make-local-variable 'delay-mode-hooks) | |
1843 | (let ((delay-mode-hooks t)) | |
1844 | ,@body))) | |
1845 | ||
31ca596b RS |
1846 | ;; PUBLIC: find if the current mode derives from another. |
1847 | ||
1848 | (defun derived-mode-p (&rest modes) | |
1849 | "Non-nil if the current major mode is derived from one of MODES. | |
1850 | Uses the `derived-mode-parent' property of the symbol to trace backwards." | |
1851 | (let ((parent major-mode)) | |
1852 | (while (and (not (memq parent modes)) | |
1853 | (setq parent (get parent 'derived-mode-parent)))) | |
1854 | parent)) | |
1855 | ||
7e8539cc | 1856 | (defmacro with-syntax-table (table &rest body) |
7ec51784 | 1857 | "Evaluate BODY with syntax table of current buffer set to TABLE. |
7e8539cc RS |
1858 | The syntax table of the current buffer is saved, BODY is evaluated, and the |
1859 | saved table is restored, even in case of an abnormal exit. | |
1860 | Value is what BODY returns." | |
f30e0cd8 | 1861 | (declare (debug t)) |
b3f07093 RS |
1862 | (let ((old-table (make-symbol "table")) |
1863 | (old-buffer (make-symbol "buffer"))) | |
7e8539cc RS |
1864 | `(let ((,old-table (syntax-table)) |
1865 | (,old-buffer (current-buffer))) | |
1866 | (unwind-protect | |
1867 | (progn | |
7ec51784 | 1868 | (set-syntax-table ,table) |
7e8539cc RS |
1869 | ,@body) |
1870 | (save-current-buffer | |
1871 | (set-buffer ,old-buffer) | |
1872 | (set-syntax-table ,old-table)))))) | |
dd929b41 RS |
1873 | |
1874 | (defmacro dynamic-completion-table (fun) | |
1875 | "Use function FUN as a dynamic completion table. | |
1876 | FUN is called with one argument, the string for which completion is required, | |
1877 | and it should return an alist containing all the intended possible | |
4df623c0 RS |
1878 | completions. This alist may be a full list of possible completions so that FUN |
1879 | can ignore the value of its argument. If completion is performed in the | |
dd929b41 | 1880 | minibuffer, FUN will be called in the buffer from which the minibuffer was |
4df623c0 RS |
1881 | entered. |
1882 | ||
1883 | The result of the `dynamic-completion-table' form is a function | |
1884 | that can be used as the ALIST argument to `try-completion' and | |
1885 | `all-completion'. See Info node `(elisp)Programmed Completion'." | |
dd929b41 RS |
1886 | (let ((win (make-symbol "window")) |
1887 | (string (make-symbol "string")) | |
1888 | (predicate (make-symbol "predicate")) | |
1889 | (mode (make-symbol "mode"))) | |
1890 | `(lambda (,string ,predicate ,mode) | |
1891 | (with-current-buffer (let ((,win (minibuffer-selected-window))) | |
1892 | (if (window-live-p ,win) (window-buffer ,win) | |
1893 | (current-buffer))) | |
1894 | (cond | |
1895 | ((eq ,mode t) (all-completions ,string (,fun ,string) ,predicate)) | |
1896 | ((not ,mode) (try-completion ,string (,fun ,string) ,predicate)) | |
1897 | (t (test-completion ,string (,fun ,string) ,predicate))))))) | |
1898 | ||
1899 | (defmacro lazy-completion-table (var fun &rest args) | |
1900 | "Initialize variable VAR as a lazy completion table. | |
1901 | If the completion table VAR is used for the first time (e.g., by passing VAR | |
1902 | as an argument to `try-completion'), the function FUN is called with arguments | |
4df623c0 RS |
1903 | ARGS. FUN must return the completion table that will be stored in VAR. |
1904 | If completion is requested in the minibuffer, FUN will be called in the buffer | |
1905 | from which the minibuffer was entered. The return value of | |
dd929b41 RS |
1906 | `lazy-completion-table' must be used to initialize the value of VAR." |
1907 | (let ((str (make-symbol "string"))) | |
1908 | `(dynamic-completion-table | |
1909 | (lambda (,str) | |
1910 | (unless (listp ,var) | |
1911 | (setq ,var (funcall ',fun ,@args))) | |
1912 | ,var)))) | |
a2fdb55c | 1913 | \f |
2493767e RS |
1914 | ;;; Matching and substitution |
1915 | ||
c7ca41e6 RS |
1916 | (defvar save-match-data-internal) |
1917 | ||
1918 | ;; We use save-match-data-internal as the local variable because | |
1919 | ;; that works ok in practice (people should not use that variable elsewhere). | |
1920 | ;; We used to use an uninterned symbol; the compiler handles that properly | |
1921 | ;; now, but it generates slower code. | |
9a5336ae | 1922 | (defmacro save-match-data (&rest body) |
e4d03691 JB |
1923 | "Execute the BODY forms, restoring the global value of the match data. |
1924 | The value returned is the value of the last form in BODY." | |
64ed733a PE |
1925 | ;; It is better not to use backquote here, |
1926 | ;; because that makes a bootstrapping problem | |
1927 | ;; if you need to recompile all the Lisp files using interpreted code. | |
d47f7515 | 1928 | (declare (indent 0) (debug t)) |
64ed733a PE |
1929 | (list 'let |
1930 | '((save-match-data-internal (match-data))) | |
1931 | (list 'unwind-protect | |
1932 | (cons 'progn body) | |
1933 | '(set-match-data save-match-data-internal)))) | |
993713ce | 1934 | |
cd323f89 | 1935 | (defun match-string (num &optional string) |
993713ce SM |
1936 | "Return string of text matched by last search. |
1937 | NUM specifies which parenthesized expression in the last regexp. | |
1938 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
1939 | Zero means the entire text matched by the whole regexp or whole string. | |
1940 | STRING should be given if the last search was by `string-match' on STRING." | |
cd323f89 SM |
1941 | (if (match-beginning num) |
1942 | (if string | |
1943 | (substring string (match-beginning num) (match-end num)) | |
1944 | (buffer-substring (match-beginning num) (match-end num))))) | |
58f950b4 | 1945 | |
bb760c71 RS |
1946 | (defun match-string-no-properties (num &optional string) |
1947 | "Return string of text matched by last search, without text properties. | |
1948 | NUM specifies which parenthesized expression in the last regexp. | |
1949 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
1950 | Zero means the entire text matched by the whole regexp or whole string. | |
1951 | STRING should be given if the last search was by `string-match' on STRING." | |
1952 | (if (match-beginning num) | |
1953 | (if string | |
1954 | (let ((result | |
1955 | (substring string (match-beginning num) (match-end num)))) | |
1956 | (set-text-properties 0 (length result) nil result) | |
1957 | result) | |
1958 | (buffer-substring-no-properties (match-beginning num) | |
1959 | (match-end num))))) | |
1960 | ||
f30e0cd8 SM |
1961 | (defun looking-back (regexp &optional limit) |
1962 | "Return non-nil if text before point matches regular expression REGEXP. | |
1963 | Like `looking-at' except backwards and slower. | |
1964 | LIMIT if non-nil speeds up the search by specifying how far back the | |
1965 | match can start." | |
498535fb | 1966 | (save-excursion |
f30e0cd8 | 1967 | (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t))) |
498535fb | 1968 | |
6a646626 JB |
1969 | (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
1970 | "The default value of separators for `split-string'. | |
1971 | ||
1972 | A regexp matching strings of whitespace. May be locale-dependent | |
1973 | \(as yet unimplemented). Should not match non-breaking spaces. | |
1974 | ||
1975 | Warning: binding this to a different value and using it as default is | |
1976 | likely to have undesired semantics.") | |
1977 | ||
1978 | ;; The specification says that if both SEPARATORS and OMIT-NULLS are | |
1979 | ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical | |
1980 | ;; expression leads to the equivalent implementation that if SEPARATORS | |
1981 | ;; is defaulted, OMIT-NULLS is treated as t. | |
1982 | (defun split-string (string &optional separators omit-nulls) | |
1983 | "Splits STRING into substrings bounded by matches for SEPARATORS. | |
1984 | ||
1985 | The beginning and end of STRING, and each match for SEPARATORS, are | |
1986 | splitting points. The substrings matching SEPARATORS are removed, and | |
1987 | the substrings between the splitting points are collected as a list, | |
edce3654 | 1988 | which is returned. |
b222b786 | 1989 | |
6a646626 JB |
1990 | If SEPARATORS is non-nil, it should be a regular expression matching text |
1991 | which separates, but is not part of, the substrings. If nil it defaults to | |
1992 | `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and | |
1993 | OMIT-NULLS is forced to t. | |
1994 | ||
1995 | If OMIT-NULLs is t, zero-length substrings are omitted from the list \(so | |
1996 | that for the default value of SEPARATORS leading and trailing whitespace | |
1997 | are effectively trimmed). If nil, all zero-length substrings are retained, | |
1998 | which correctly parses CSV format, for example. | |
1999 | ||
2000 | Note that the effect of `(split-string STRING)' is the same as | |
2001 | `(split-string STRING split-string-default-separators t)'). In the rare | |
2002 | case that you wish to retain zero-length substrings when splitting on | |
2003 | whitespace, use `(split-string STRING split-string-default-separators)'. | |
b021ef18 DL |
2004 | |
2005 | Modifies the match data; use `save-match-data' if necessary." | |
6a646626 JB |
2006 | (let ((keep-nulls (not (if separators omit-nulls t))) |
2007 | (rexp (or separators split-string-default-separators)) | |
edce3654 | 2008 | (start 0) |
b222b786 | 2009 | notfirst |
edce3654 | 2010 | (list nil)) |
b222b786 RS |
2011 | (while (and (string-match rexp string |
2012 | (if (and notfirst | |
2013 | (= start (match-beginning 0)) | |
2014 | (< start (length string))) | |
2015 | (1+ start) start)) | |
6a646626 | 2016 | (< start (length string))) |
b222b786 | 2017 | (setq notfirst t) |
6a646626 | 2018 | (if (or keep-nulls (< start (match-beginning 0))) |
edce3654 RS |
2019 | (setq list |
2020 | (cons (substring string start (match-beginning 0)) | |
2021 | list))) | |
2022 | (setq start (match-end 0))) | |
6a646626 | 2023 | (if (or keep-nulls (< start (length string))) |
edce3654 RS |
2024 | (setq list |
2025 | (cons (substring string start) | |
2026 | list))) | |
2027 | (nreverse list))) | |
1ccaea52 AI |
2028 | |
2029 | (defun subst-char-in-string (fromchar tochar string &optional inplace) | |
2030 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. | |
2031 | Unless optional argument INPLACE is non-nil, return a new string." | |
e6e71807 SM |
2032 | (let ((i (length string)) |
2033 | (newstr (if inplace string (copy-sequence string)))) | |
2034 | (while (> i 0) | |
2035 | (setq i (1- i)) | |
2036 | (if (eq (aref newstr i) fromchar) | |
2037 | (aset newstr i tochar))) | |
2038 | newstr)) | |
b021ef18 | 2039 | |
1697159c | 2040 | (defun replace-regexp-in-string (regexp rep string &optional |
6a646626 | 2041 | fixedcase literal subexp start) |
b021ef18 DL |
2042 | "Replace all matches for REGEXP with REP in STRING. |
2043 | ||
2044 | Return a new string containing the replacements. | |
2045 | ||
2046 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the | |
2047 | arguments with the same names of function `replace-match'. If START | |
2048 | is non-nil, start replacements at that index in STRING. | |
2049 | ||
2050 | REP is either a string used as the NEWTEXT arg of `replace-match' or a | |
2051 | function. If it is a function it is applied to each match to generate | |
2052 | the replacement passed to `replace-match'; the match-data at this | |
2053 | point are such that match 0 is the function's argument. | |
2054 | ||
1697159c DL |
2055 | To replace only the first match (if any), make REGEXP match up to \\' |
2056 | and replace a sub-expression, e.g. | |
c9bcb507 | 2057 | (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1) |
1697159c DL |
2058 | => \" bar foo\" |
2059 | " | |
b021ef18 DL |
2060 | |
2061 | ;; To avoid excessive consing from multiple matches in long strings, | |
2062 | ;; don't just call `replace-match' continually. Walk down the | |
2063 | ;; string looking for matches of REGEXP and building up a (reversed) | |
2064 | ;; list MATCHES. This comprises segments of STRING which weren't | |
2065 | ;; matched interspersed with replacements for segments that were. | |
08b1f8a1 | 2066 | ;; [For a `large' number of replacements it's more efficient to |
b021ef18 DL |
2067 | ;; operate in a temporary buffer; we can't tell from the function's |
2068 | ;; args whether to choose the buffer-based implementation, though it | |
2069 | ;; might be reasonable to do so for long enough STRING.] | |
2070 | (let ((l (length string)) | |
2071 | (start (or start 0)) | |
2072 | matches str mb me) | |
2073 | (save-match-data | |
2074 | (while (and (< start l) (string-match regexp string start)) | |
2075 | (setq mb (match-beginning 0) | |
2076 | me (match-end 0)) | |
a9853251 SM |
2077 | ;; If we matched the empty string, make sure we advance by one char |
2078 | (when (= me mb) (setq me (min l (1+ mb)))) | |
2079 | ;; Generate a replacement for the matched substring. | |
2080 | ;; Operate only on the substring to minimize string consing. | |
2081 | ;; Set up match data for the substring for replacement; | |
2082 | ;; presumably this is likely to be faster than munging the | |
2083 | ;; match data directly in Lisp. | |
2084 | (string-match regexp (setq str (substring string mb me))) | |
2085 | (setq matches | |
2086 | (cons (replace-match (if (stringp rep) | |
2087 | rep | |
2088 | (funcall rep (match-string 0 str))) | |
2089 | fixedcase literal str subexp) | |
6a646626 | 2090 | (cons (substring string start mb) ; unmatched prefix |
a9853251 SM |
2091 | matches))) |
2092 | (setq start me)) | |
b021ef18 DL |
2093 | ;; Reconstruct a string from the pieces. |
2094 | (setq matches (cons (substring string start l) matches)) ; leftover | |
2095 | (apply #'concat (nreverse matches))))) | |
a7ed4c2a | 2096 | \f |
8af7df60 RS |
2097 | (defun shell-quote-argument (argument) |
2098 | "Quote an argument for passing as argument to an inferior shell." | |
c1c74b43 | 2099 | (if (eq system-type 'ms-dos) |
8ee75d03 EZ |
2100 | ;; Quote using double quotes, but escape any existing quotes in |
2101 | ;; the argument with backslashes. | |
2102 | (let ((result "") | |
2103 | (start 0) | |
2104 | end) | |
2105 | (if (or (null (string-match "[^\"]" argument)) | |
2106 | (< (match-end 0) (length argument))) | |
2107 | (while (string-match "[\"]" argument start) | |
2108 | (setq end (match-beginning 0) | |
2109 | result (concat result (substring argument start end) | |
2110 | "\\" (substring argument end (1+ end))) | |
2111 | start (1+ end)))) | |
2112 | (concat "\"" result (substring argument start) "\"")) | |
c1c74b43 RS |
2113 | (if (eq system-type 'windows-nt) |
2114 | (concat "\"" argument "\"") | |
e1b65a6b RS |
2115 | (if (equal argument "") |
2116 | "''" | |
2117 | ;; Quote everything except POSIX filename characters. | |
2118 | ;; This should be safe enough even for really weird shells. | |
2119 | (let ((result "") (start 0) end) | |
2120 | (while (string-match "[^-0-9a-zA-Z_./]" argument start) | |
2121 | (setq end (match-beginning 0) | |
2122 | result (concat result (substring argument start end) | |
2123 | "\\" (substring argument end (1+ end))) | |
2124 | start (1+ end))) | |
2125 | (concat result (substring argument start))))))) | |
8af7df60 | 2126 | |
297d863b | 2127 | (defun make-syntax-table (&optional oldtable) |
984f718a | 2128 | "Return a new syntax table. |
0764e16f SM |
2129 | Create a syntax table which inherits from OLDTABLE (if non-nil) or |
2130 | from `standard-syntax-table' otherwise." | |
2131 | (let ((table (make-char-table 'syntax-table nil))) | |
2132 | (set-char-table-parent table (or oldtable (standard-syntax-table))) | |
2133 | table)) | |
31aa282e | 2134 | |
e9f13a95 SM |
2135 | (defun syntax-after (pos) |
2136 | "Return the syntax of the char after POS." | |
2137 | (unless (or (< pos (point-min)) (>= pos (point-max))) | |
2138 | (let ((st (if parse-sexp-lookup-properties | |
2139 | (get-char-property pos 'syntax-table)))) | |
2140 | (if (consp st) st | |
2141 | (aref (or st (syntax-table)) (char-after pos)))))) | |
2142 | ||
31aa282e KH |
2143 | (defun add-to-invisibility-spec (arg) |
2144 | "Add elements to `buffer-invisibility-spec'. | |
2145 | See documentation for `buffer-invisibility-spec' for the kind of elements | |
2146 | that can be added." | |
c525c13c RS |
2147 | (if (eq buffer-invisibility-spec t) |
2148 | (setq buffer-invisibility-spec (list t))) | |
2149 | (setq buffer-invisibility-spec | |
2150 | (cons arg buffer-invisibility-spec))) | |
31aa282e KH |
2151 | |
2152 | (defun remove-from-invisibility-spec (arg) | |
2153 | "Remove elements from `buffer-invisibility-spec'." | |
e93b8cbb | 2154 | (if (consp buffer-invisibility-spec) |
071a2a71 | 2155 | (setq buffer-invisibility-spec (delete arg buffer-invisibility-spec)))) |
baed0109 RS |
2156 | \f |
2157 | (defun global-set-key (key command) | |
2158 | "Give KEY a global binding as COMMAND. | |
7bba1895 KH |
2159 | COMMAND is the command definition to use; usually it is |
2160 | a symbol naming an interactively-callable function. | |
2161 | KEY is a key sequence; noninteractively, it is a string or vector | |
2162 | of characters or event types, and non-ASCII characters with codes | |
2163 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
2164 | ||
2165 | Note that if KEY has a local binding in the current buffer, | |
2166 | that local binding will continue to shadow any global binding | |
2167 | that you make with this function." | |
baed0109 | 2168 | (interactive "KSet key globally: \nCSet key %s to command: ") |
a2f9aa84 | 2169 | (or (vectorp key) (stringp key) |
baed0109 | 2170 | (signal 'wrong-type-argument (list 'arrayp key))) |
ff663bbe | 2171 | (define-key (current-global-map) key command)) |
baed0109 RS |
2172 | |
2173 | (defun local-set-key (key command) | |
2174 | "Give KEY a local binding as COMMAND. | |
7bba1895 KH |
2175 | COMMAND is the command definition to use; usually it is |
2176 | a symbol naming an interactively-callable function. | |
2177 | KEY is a key sequence; noninteractively, it is a string or vector | |
2178 | of characters or event types, and non-ASCII characters with codes | |
2179 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
2180 | ||
baed0109 RS |
2181 | The binding goes in the current buffer's local map, |
2182 | which in most cases is shared with all other buffers in the same major mode." | |
2183 | (interactive "KSet key locally: \nCSet key %s locally to command: ") | |
2184 | (let ((map (current-local-map))) | |
2185 | (or map | |
2186 | (use-local-map (setq map (make-sparse-keymap)))) | |
a2f9aa84 | 2187 | (or (vectorp key) (stringp key) |
baed0109 | 2188 | (signal 'wrong-type-argument (list 'arrayp key))) |
ff663bbe | 2189 | (define-key map key command))) |
984f718a | 2190 | |
baed0109 RS |
2191 | (defun global-unset-key (key) |
2192 | "Remove global binding of KEY. | |
2193 | KEY is a string representing a sequence of keystrokes." | |
2194 | (interactive "kUnset key globally: ") | |
2195 | (global-set-key key nil)) | |
2196 | ||
db2474b8 | 2197 | (defun local-unset-key (key) |
baed0109 RS |
2198 | "Remove local binding of KEY. |
2199 | KEY is a string representing a sequence of keystrokes." | |
2200 | (interactive "kUnset key locally: ") | |
2201 | (if (current-local-map) | |
db2474b8 | 2202 | (local-set-key key nil)) |
baed0109 RS |
2203 | nil) |
2204 | \f | |
4809d0dd KH |
2205 | ;; We put this here instead of in frame.el so that it's defined even on |
2206 | ;; systems where frame.el isn't loaded. | |
2207 | (defun frame-configuration-p (object) | |
2208 | "Return non-nil if OBJECT seems to be a frame configuration. | |
2209 | Any list whose car is `frame-configuration' is assumed to be a frame | |
2210 | configuration." | |
2211 | (and (consp object) | |
2212 | (eq (car object) 'frame-configuration))) | |
2213 | ||
a9a44ed1 | 2214 | (defun functionp (object) |
0764e16f | 2215 | "Non-nil iff OBJECT is a type of object that can be called as a function." |
a2d7836f | 2216 | (or (and (symbolp object) (fboundp object) |
d7d563e3 RS |
2217 | (condition-case nil |
2218 | (setq object (indirect-function object)) | |
2219 | (error nil)) | |
0764e16f | 2220 | (eq (car-safe object) 'autoload) |
f1d37f3c | 2221 | (not (car-safe (cdr-safe (cdr-safe (cdr-safe (cdr-safe object))))))) |
0764e16f | 2222 | (subrp object) (byte-code-function-p object) |
60ab6064 | 2223 | (eq (car-safe object) 'lambda))) |
a9a44ed1 | 2224 | |
f65fab59 GM |
2225 | (defun interactive-form (function) |
2226 | "Return the interactive form of FUNCTION. | |
2227 | If function is a command (see `commandp'), value is a list of the form | |
d3200788 | 2228 | \(interactive SPEC). If function is not a command, return nil." |
f65fab59 GM |
2229 | (setq function (indirect-function function)) |
2230 | (when (commandp function) | |
2231 | (cond ((byte-code-function-p function) | |
2232 | (when (> (length function) 5) | |
2233 | (let ((spec (aref function 5))) | |
2234 | (if spec | |
2235 | (list 'interactive spec) | |
2236 | (list 'interactive))))) | |
2237 | ((subrp function) | |
2238 | (subr-interactive-form function)) | |
2239 | ((eq (car-safe function) 'lambda) | |
2240 | (setq function (cddr function)) | |
2241 | (when (stringp (car function)) | |
2242 | (setq function (cdr function))) | |
2243 | (let ((form (car function))) | |
a27b451e | 2244 | (when (eq (car-safe form) 'interactive) |
f65fab59 | 2245 | (copy-sequence form))))))) |
630cc463 | 2246 | |
d3a61a11 | 2247 | (defun assq-delete-all (key alist) |
a62d6695 | 2248 | "Delete from ALIST all elements whose car is KEY. |
d87a4a45 RS |
2249 | Return the modified alist. |
2250 | Elements of ALIST that are not conses are ignored." | |
a62d6695 DL |
2251 | (let ((tail alist)) |
2252 | (while tail | |
d87a4a45 | 2253 | (if (and (consp (car tail)) (eq (car (car tail)) key)) |
a62d6695 DL |
2254 | (setq alist (delq (car tail) alist))) |
2255 | (setq tail (cdr tail))) | |
2256 | alist)) | |
2257 | ||
10cf1ba8 | 2258 | (defun make-temp-file (prefix &optional dir-flag suffix) |
cdd9f643 RS |
2259 | "Create a temporary file. |
2260 | The returned file name (created by appending some random characters at the end | |
5ef6a86d | 2261 | of PREFIX, and expanding against `temporary-file-directory' if necessary), |
cdd9f643 RS |
2262 | is guaranteed to point to a newly created empty file. |
2263 | You can then use `write-region' to write new data into the file. | |
2264 | ||
10cf1ba8 RS |
2265 | If DIR-FLAG is non-nil, create a new empty directory instead of a file. |
2266 | ||
2267 | If SUFFIX is non-nil, add that at the end of the file name." | |
1c12af5c SM |
2268 | (let ((umask (default-file-modes)) |
2269 | file) | |
2270 | (unwind-protect | |
2271 | (progn | |
2272 | ;; Create temp files with strict access rights. It's easy to | |
2273 | ;; loosen them later, whereas it's impossible to close the | |
2274 | ;; time-window of loose permissions otherwise. | |
2275 | (set-default-file-modes ?\700) | |
2276 | (while (condition-case () | |
2277 | (progn | |
2278 | (setq file | |
2279 | (make-temp-name | |
2280 | (expand-file-name prefix temporary-file-directory))) | |
2281 | (if suffix | |
2282 | (setq file (concat file suffix))) | |
2283 | (if dir-flag | |
2284 | (make-directory file) | |
2285 | (write-region "" nil file nil 'silent nil 'excl)) | |
2286 | nil) | |
2287 | (file-already-exists t)) | |
2288 | ;; the file was somehow created by someone else between | |
2289 | ;; `make-temp-name' and `write-region', let's try again. | |
2290 | nil) | |
2291 | file) | |
2292 | ;; Reset the umask. | |
2293 | (set-default-file-modes umask)))) | |
cdd9f643 | 2294 | |
d7d47268 | 2295 | \f |
7dde432d RS |
2296 | ;; If a minor mode is not defined with define-minor-mode, |
2297 | ;; add it here explicitly. | |
2298 | ;; isearch-mode is deliberately excluded, since you should | |
2299 | ;; not call it yourself. | |
2300 | (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode | |
3813f0c5 TTN |
2301 | overwrite-mode view-mode |
2302 | hs-minor-mode) | |
7dde432d RS |
2303 | "List of all minor mode functions.") |
2304 | ||
c94f4677 | 2305 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) |
d7d47268 | 2306 | "Register a new minor mode. |
c94f4677 | 2307 | |
0b2cf11f SM |
2308 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. |
2309 | ||
c94f4677 GM |
2310 | TOGGLE is a symbol which is the name of a buffer-local variable that |
2311 | is toggled on or off to say whether the minor mode is active or not. | |
2312 | ||
2313 | NAME specifies what will appear in the mode line when the minor mode | |
2314 | is active. NAME should be either a string starting with a space, or a | |
2315 | symbol whose value is such a string. | |
2316 | ||
2317 | Optional KEYMAP is the keymap for the minor mode that will be added | |
2318 | to `minor-mode-map-alist'. | |
2319 | ||
2320 | Optional AFTER specifies that TOGGLE should be added after AFTER | |
2321 | in `minor-mode-alist'. | |
2322 | ||
0b2cf11f SM |
2323 | Optional TOGGLE-FUN is an interactive function to toggle the mode. |
2324 | It defaults to (and should by convention be) TOGGLE. | |
2325 | ||
2326 | If TOGGLE has a non-nil `:included' property, an entry for the mode is | |
2327 | included in the mode-line minor mode menu. | |
2328 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." | |
7dde432d RS |
2329 | (unless (memq toggle minor-mode-list) |
2330 | (push toggle minor-mode-list)) | |
6a646626 | 2331 | |
0b2cf11f | 2332 | (unless toggle-fun (setq toggle-fun toggle)) |
0b2cf11f | 2333 | ;; Add the name to the minor-mode-alist. |
c94f4677 | 2334 | (when name |
0b2cf11f | 2335 | (let ((existing (assq toggle minor-mode-alist))) |
0b2cf11f SM |
2336 | (if existing |
2337 | (setcdr existing (list name)) | |
2338 | (let ((tail minor-mode-alist) found) | |
2339 | (while (and tail (not found)) | |
2340 | (if (eq after (caar tail)) | |
2341 | (setq found tail) | |
2342 | (setq tail (cdr tail)))) | |
2343 | (if found | |
2344 | (let ((rest (cdr found))) | |
2345 | (setcdr found nil) | |
2346 | (nconc found (list (list toggle name)) rest)) | |
2347 | (setq minor-mode-alist (cons (list toggle name) | |
2348 | minor-mode-alist))))))) | |
69cae2d4 RS |
2349 | ;; Add the toggle to the minor-modes menu if requested. |
2350 | (when (get toggle :included) | |
2351 | (define-key mode-line-mode-menu | |
2352 | (vector toggle) | |
2353 | (list 'menu-item | |
2354 | (concat | |
2355 | (or (get toggle :menu-tag) | |
2356 | (if (stringp name) name (symbol-name toggle))) | |
1c12af5c SM |
2357 | (let ((mode-name (if (symbolp name) (symbol-value name)))) |
2358 | (if (and (stringp mode-name) (string-match "[^ ]+" mode-name)) | |
2359 | (concat " (" (match-string 0 mode-name) ")")))) | |
69cae2d4 RS |
2360 | toggle-fun |
2361 | :button (cons :toggle toggle)))) | |
2362 | ||
1c12af5c | 2363 | ;; Add the map to the minor-mode-map-alist. |
c94f4677 GM |
2364 | (when keymap |
2365 | (let ((existing (assq toggle minor-mode-map-alist))) | |
0b2cf11f SM |
2366 | (if existing |
2367 | (setcdr existing keymap) | |
2368 | (let ((tail minor-mode-map-alist) found) | |
2369 | (while (and tail (not found)) | |
2370 | (if (eq after (caar tail)) | |
2371 | (setq found tail) | |
2372 | (setq tail (cdr tail)))) | |
2373 | (if found | |
2374 | (let ((rest (cdr found))) | |
2375 | (setcdr found nil) | |
2376 | (nconc found (list (cons toggle keymap)) rest)) | |
2377 | (setq minor-mode-map-alist (cons (cons toggle keymap) | |
2378 | minor-mode-map-alist)))))))) | |
2493767e | 2379 | \f |
a13fe4c5 SM |
2380 | ;; Clones ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
2381 | ||
2382 | (defun text-clone-maintain (ol1 after beg end &optional len) | |
2383 | "Propagate the changes made under the overlay OL1 to the other clones. | |
2384 | This is used on the `modification-hooks' property of text clones." | |
2385 | (when (and after (not undo-in-progress) (overlay-start ol1)) | |
2386 | (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0))) | |
2387 | (setq beg (max beg (+ (overlay-start ol1) margin))) | |
2388 | (setq end (min end (- (overlay-end ol1) margin))) | |
2389 | (when (<= beg end) | |
2390 | (save-excursion | |
2391 | (when (overlay-get ol1 'text-clone-syntax) | |
2392 | ;; Check content of the clone's text. | |
2393 | (let ((cbeg (+ (overlay-start ol1) margin)) | |
2394 | (cend (- (overlay-end ol1) margin))) | |
2395 | (goto-char cbeg) | |
2396 | (save-match-data | |
2397 | (if (not (re-search-forward | |
2398 | (overlay-get ol1 'text-clone-syntax) cend t)) | |
2399 | ;; Mark the overlay for deletion. | |
2400 | (overlay-put ol1 'text-clones nil) | |
2401 | (when (< (match-end 0) cend) | |
2402 | ;; Shrink the clone at its end. | |
2403 | (setq end (min end (match-end 0))) | |
2404 | (move-overlay ol1 (overlay-start ol1) | |
2405 | (+ (match-end 0) margin))) | |
2406 | (when (> (match-beginning 0) cbeg) | |
2407 | ;; Shrink the clone at its beginning. | |
2408 | (setq beg (max (match-beginning 0) beg)) | |
2409 | (move-overlay ol1 (- (match-beginning 0) margin) | |
2410 | (overlay-end ol1))))))) | |
2411 | ;; Now go ahead and update the clones. | |
2412 | (let ((head (- beg (overlay-start ol1))) | |
2413 | (tail (- (overlay-end ol1) end)) | |
2414 | (str (buffer-substring beg end)) | |
2415 | (nothing-left t) | |
2416 | (inhibit-modification-hooks t)) | |
2417 | (dolist (ol2 (overlay-get ol1 'text-clones)) | |
2418 | (let ((oe (overlay-end ol2))) | |
2419 | (unless (or (eq ol1 ol2) (null oe)) | |
2420 | (setq nothing-left nil) | |
2421 | (let ((mod-beg (+ (overlay-start ol2) head))) | |
2422 | ;;(overlay-put ol2 'modification-hooks nil) | |
2423 | (goto-char (- (overlay-end ol2) tail)) | |
2424 | (unless (> mod-beg (point)) | |
2425 | (save-excursion (insert str)) | |
2426 | (delete-region mod-beg (point))) | |
2427 | ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain)) | |
2428 | )))) | |
2429 | (if nothing-left (delete-overlay ol1)))))))) | |
2430 | ||
2431 | (defun text-clone-create (start end &optional spreadp syntax) | |
2432 | "Create a text clone of START...END at point. | |
2433 | Text clones are chunks of text that are automatically kept identical: | |
2434 | changes done to one of the clones will be immediately propagated to the other. | |
2435 | ||
2436 | The buffer's content at point is assumed to be already identical to | |
2437 | the one between START and END. | |
2438 | If SYNTAX is provided it's a regexp that describes the possible text of | |
2439 | the clones; the clone will be shrunk or killed if necessary to ensure that | |
2440 | its text matches the regexp. | |
2441 | If SPREADP is non-nil it indicates that text inserted before/after the | |
2442 | clone should be incorporated in the clone." | |
2443 | ;; To deal with SPREADP we can either use an overlay with `nil t' along | |
2444 | ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay | |
2445 | ;; (with a one-char margin at each end) with `t nil'. | |
2446 | ;; We opted for a larger overlay because it behaves better in the case | |
2447 | ;; where the clone is reduced to the empty string (we want the overlay to | |
2448 | ;; stay when the clone's content is the empty string and we want to use | |
2449 | ;; `evaporate' to make sure those overlays get deleted when needed). | |
264ef586 | 2450 | ;; |
a13fe4c5 SM |
2451 | (let* ((pt-end (+ (point) (- end start))) |
2452 | (start-margin (if (or (not spreadp) (bobp) (<= start (point-min))) | |
2453 | 0 1)) | |
2454 | (end-margin (if (or (not spreadp) | |
2455 | (>= pt-end (point-max)) | |
2456 | (>= start (point-max))) | |
2457 | 0 1)) | |
2458 | (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t)) | |
2459 | (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t)) | |
2460 | (dups (list ol1 ol2))) | |
2461 | (overlay-put ol1 'modification-hooks '(text-clone-maintain)) | |
2462 | (when spreadp (overlay-put ol1 'text-clone-spreadp t)) | |
2463 | (when syntax (overlay-put ol1 'text-clone-syntax syntax)) | |
2464 | ;;(overlay-put ol1 'face 'underline) | |
2465 | (overlay-put ol1 'evaporate t) | |
2466 | (overlay-put ol1 'text-clones dups) | |
264ef586 | 2467 | ;; |
a13fe4c5 SM |
2468 | (overlay-put ol2 'modification-hooks '(text-clone-maintain)) |
2469 | (when spreadp (overlay-put ol2 'text-clone-spreadp t)) | |
2470 | (when syntax (overlay-put ol2 'text-clone-syntax syntax)) | |
2471 | ;;(overlay-put ol2 'face 'underline) | |
2472 | (overlay-put ol2 'evaporate t) | |
2473 | (overlay-put ol2 'text-clones dups))) | |
27c079eb | 2474 | |
324cd947 PJ |
2475 | (defun play-sound (sound) |
2476 | "SOUND is a list of the form `(sound KEYWORD VALUE...)'. | |
2477 | The following keywords are recognized: | |
2478 | ||
2479 | :file FILE - read sound data from FILE. If FILE isn't an | |
2480 | absolute file name, it is searched in `data-directory'. | |
2481 | ||
2482 | :data DATA - read sound data from string DATA. | |
2483 | ||
2484 | Exactly one of :file or :data must be present. | |
2485 | ||
2486 | :volume VOL - set volume to VOL. VOL must an integer in the | |
2487 | range 0..100 or a float in the range 0..1.0. If not specified, | |
2488 | don't change the volume setting of the sound device. | |
2489 | ||
2490 | :device DEVICE - play sound on DEVICE. If not specified, | |
2491 | a system-dependent default device name is used." | |
2492 | (unless (fboundp 'play-sound-internal) | |
2493 | (error "This Emacs binary lacks sound support")) | |
2494 | (play-sound-internal sound)) | |
2495 | ||
27c079eb SM |
2496 | (defun define-mail-user-agent (symbol composefunc sendfunc |
2497 | &optional abortfunc hookvar) | |
2498 | "Define a symbol to identify a mail-sending package for `mail-user-agent'. | |
2499 | ||
2500 | SYMBOL can be any Lisp symbol. Its function definition and/or | |
2501 | value as a variable do not matter for this usage; we use only certain | |
2502 | properties on its property list, to encode the rest of the arguments. | |
2503 | ||
2504 | COMPOSEFUNC is program callable function that composes an outgoing | |
2505 | mail message buffer. This function should set up the basics of the | |
2506 | buffer without requiring user interaction. It should populate the | |
2507 | standard mail headers, leaving the `to:' and `subject:' headers blank | |
2508 | by default. | |
2509 | ||
2510 | COMPOSEFUNC should accept several optional arguments--the same | |
2511 | arguments that `compose-mail' takes. See that function's documentation. | |
2512 | ||
2513 | SENDFUNC is the command a user would run to send the message. | |
2514 | ||
2515 | Optional ABORTFUNC is the command a user would run to abort the | |
2516 | message. For mail packages that don't have a separate abort function, | |
2517 | this can be `kill-buffer' (the equivalent of omitting this argument). | |
2518 | ||
2519 | Optional HOOKVAR is a hook variable that gets run before the message | |
2520 | is actually sent. Callers that use the `mail-user-agent' may | |
2521 | install a hook function temporarily on this hook variable. | |
2522 | If HOOKVAR is nil, `mail-send-hook' is used. | |
2523 | ||
2524 | The properties used on SYMBOL are `composefunc', `sendfunc', | |
2525 | `abortfunc', and `hookvar'." | |
2526 | (put symbol 'composefunc composefunc) | |
2527 | (put symbol 'sendfunc sendfunc) | |
2528 | (put symbol 'abortfunc (or abortfunc 'kill-buffer)) | |
2529 | (put symbol 'hookvar (or hookvar 'mail-send-hook))) | |
2530 | ||
ab5796a9 | 2531 | ;;; arch-tag: f7e0e6e5-70aa-4897-ae72-7a3511ec40bc |
630cc463 | 2532 | ;;; subr.el ends here |