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