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