Commit | Line | Data |
---|---|---|
78c79eb5 | 1 | ;;; subr.el --- basic lisp subroutines for Emacs -*- coding: utf-8 -*- |
630cc463 | 2 | |
acaf905b | 3 | ;; Copyright (C) 1985-1986, 1992, 1994-1995, 1999-2012 |
3226d6ca | 4 | ;; Free Software Foundation, Inc. |
be9b65ac | 5 | |
30764597 PJ |
6 | ;; Maintainer: FSF |
7 | ;; Keywords: internal | |
bd78fa1d | 8 | ;; Package: emacs |
30764597 | 9 | |
be9b65ac DL |
10 | ;; This file is part of GNU Emacs. |
11 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
be9b65ac | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
be9b65ac DL |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
be9b65ac | 24 | |
60370d40 PJ |
25 | ;;; Commentary: |
26 | ||
630cc463 | 27 | ;;; Code: |
d0fc47ed | 28 | |
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 | 38 | |
708bb6f8 RS |
39 | (defmacro declare-function (fn file &optional arglist fileonly) |
40 | "Tell the byte-compiler that function FN is defined, in FILE. | |
41 | Optional ARGLIST is the argument list used by the function. The | |
42 | FILE argument is not used by the byte-compiler, but by the | |
43 | `check-declare' package, which checks that FILE contains a | |
44 | definition for FN. ARGLIST is used by both the byte-compiler and | |
45 | `check-declare' to check for consistency. | |
46 | ||
47 | FILE can be either a Lisp file (in which case the \".el\" | |
48 | extension is optional), or a C file. C files are expanded | |
49 | relative to the Emacs \"src/\" directory. Lisp files are | |
50 | searched for using `locate-library', and if that fails they are | |
51 | expanded relative to the location of the file containing the | |
52 | declaration. A FILE with an \"ext:\" prefix is an external file. | |
53 | `check-declare' will check such files if they are found, and skip | |
54 | them without error if they are not. | |
55 | ||
56 | FILEONLY non-nil means that `check-declare' will only check that | |
57 | FILE exists, not that it defines FN. This is intended for | |
58 | function-definitions that `check-declare' does not recognize, e.g. | |
59 | `defstruct'. | |
60 | ||
61 | To specify a value for FILEONLY without passing an argument list, | |
3fa173b4 | 62 | set ARGLIST to t. This is necessary because nil means an |
708bb6f8 RS |
63 | empty argument list, rather than an unspecified one. |
64 | ||
65 | Note that for the purposes of `check-declare', this statement | |
a4d2c321 | 66 | must be the first non-whitespace on a line. |
708bb6f8 | 67 | |
83031738 | 68 | For more information, see Info node `(elisp)Declaring Functions'." |
708bb6f8 RS |
69 | ;; Does nothing - byte-compile-declare-function does the work. |
70 | nil) | |
e224699a | 71 | |
2c642c03 | 72 | \f |
c4f484f2 | 73 | ;;;; Basic Lisp macros. |
9a5336ae | 74 | |
0764e16f SM |
75 | (defalias 'not 'null) |
76 | ||
6b61353c | 77 | (defmacro noreturn (form) |
70c6db6c LT |
78 | "Evaluate FORM, expecting it not to return. |
79 | If FORM does return, signal an error." | |
6b61353c KH |
80 | `(prog1 ,form |
81 | (error "Form marked with `noreturn' did return"))) | |
82 | ||
83 | (defmacro 1value (form) | |
70c6db6c LT |
84 | "Evaluate FORM, expecting a constant return value. |
85 | This is the global do-nothing version. There is also `testcover-1value' | |
86 | that complains if FORM ever does return differing values." | |
6b61353c KH |
87 | form) |
88 | ||
8285ccd2 RS |
89 | (defmacro def-edebug-spec (symbol spec) |
90 | "Set the `edebug-form-spec' property of SYMBOL according to SPEC. | |
e32721f5 GM |
91 | Both SYMBOL and SPEC are unevaluated. The SPEC can be: |
92 | 0 (instrument no arguments); t (instrument all arguments); | |
93 | a symbol (naming a function with an Edebug specification); or a list. | |
94 | The elements of the list describe the argument types; see | |
2b1e1a22 | 95 | Info node `(elisp)Specification List' for details." |
8285ccd2 RS |
96 | `(put (quote ,symbol) 'edebug-form-spec (quote ,spec))) |
97 | ||
9a5336ae JB |
98 | (defmacro lambda (&rest cdr) |
99 | "Return a lambda expression. | |
100 | A call of the form (lambda ARGS DOCSTRING INTERACTIVE BODY) is | |
101 | self-quoting; the result of evaluating the lambda expression is the | |
102 | expression itself. The lambda expression may then be treated as a | |
bec0d7f9 | 103 | function, i.e., stored as the function value of a symbol, passed to |
265b3f2a | 104 | `funcall' or `mapcar', etc. |
bec0d7f9 | 105 | |
9a5336ae | 106 | ARGS should take the same form as an argument list for a `defun'. |
8fd68088 RS |
107 | DOCSTRING is an optional documentation string. |
108 | If present, it should describe how to call the function. | |
109 | But documentation strings are usually not useful in nameless functions. | |
9a5336ae JB |
110 | INTERACTIVE should be a call to the function `interactive', which see. |
111 | It may also be omitted. | |
a478f3e1 JB |
112 | BODY should be a list of Lisp expressions. |
113 | ||
114 | \(fn ARGS [DOCSTRING] [INTERACTIVE] BODY)" | |
9a5336ae JB |
115 | ;; Note that this definition should not use backquotes; subr.el should not |
116 | ;; depend on backquote.el. | |
117 | (list 'function (cons 'lambda cdr))) | |
118 | ||
2ec42da9 SM |
119 | (defun apply-partially (fun &rest args) |
120 | "Return a function that is a partial application of FUN to ARGS. | |
121 | ARGS is a list of the first N arguments to pass to FUN. | |
122 | The result is a new function which does the same as FUN, except that | |
123 | the first N arguments are fixed at the values with which this function | |
124 | was called." | |
f488fb65 | 125 | `(closure (t) (&rest args) |
2ec42da9 SM |
126 | (apply ',fun ,@(mapcar (lambda (arg) `',arg) args) args))) |
127 | ||
a69c67e8 CY |
128 | (if (null (featurep 'cl)) |
129 | (progn | |
354f0faf SM |
130 | ;; If we reload subr.el after having loaded CL, be careful not to |
131 | ;; overwrite CL's extended definition of `dolist', `dotimes', | |
132 | ;; `declare', `push' and `pop'. | |
1be152fc | 133 | (defmacro push (newelt listname) |
fa65505b | 134 | "Add NEWELT to the list stored in the symbol LISTNAME. |
1be152fc | 135 | This is equivalent to (setq LISTNAME (cons NEWELT LISTNAME)). |
d270117a | 136 | LISTNAME must be a symbol." |
f30e0cd8 | 137 | (declare (debug (form sexp))) |
22d85d00 | 138 | (list 'setq listname |
354f0faf | 139 | (list 'cons newelt listname))) |
d270117a RS |
140 | |
141 | (defmacro pop (listname) | |
142 | "Return the first element of LISTNAME's value, and remove it from the list. | |
143 | LISTNAME must be a symbol whose value is a list. | |
144 | If the value is nil, `pop' returns nil but does not actually | |
145 | change the list." | |
f30e0cd8 | 146 | (declare (debug (sexp))) |
54993fa4 | 147 | (list 'car |
354f0faf | 148 | (list 'prog1 listname |
a69c67e8 CY |
149 | (list 'setq listname (list 'cdr listname))))) |
150 | )) | |
d270117a | 151 | |
debff3c3 | 152 | (defmacro when (cond &rest body) |
7f67eea0 KS |
153 | "If COND yields non-nil, do BODY, else return nil. |
154 | When COND yields non-nil, eval BODY forms sequentially and return | |
155 | value of last one, or nil if there are none. | |
156 | ||
ebc3ae14 | 157 | \(fn COND BODY...)" |
d47f7515 | 158 | (declare (indent 1) (debug t)) |
debff3c3 | 159 | (list 'if cond (cons 'progn body))) |
9a5336ae | 160 | |
debff3c3 | 161 | (defmacro unless (cond &rest body) |
7f67eea0 KS |
162 | "If COND yields nil, do BODY, else return nil. |
163 | When COND yields nil, eval BODY forms sequentially and return | |
164 | value of last one, or nil if there are none. | |
165 | ||
ebc3ae14 | 166 | \(fn COND BODY...)" |
d47f7515 | 167 | (declare (indent 1) (debug t)) |
debff3c3 | 168 | (cons 'if (cons cond (cons nil body)))) |
d370591d | 169 | |
a69c67e8 CY |
170 | (if (null (featurep 'cl)) |
171 | (progn | |
354f0faf SM |
172 | ;; If we reload subr.el after having loaded CL, be careful not to |
173 | ;; overwrite CL's extended definition of `dolist', `dotimes', | |
296ba3ee | 174 | ;; `declare', `push' and `pop'. |
01d16e16 | 175 | |
a0b0756a | 176 | (defmacro dolist (spec &rest body) |
d47f7515 | 177 | "Loop over a list. |
a0b0756a | 178 | Evaluate BODY with VAR bound to each car from LIST, in turn. |
d47f7515 SM |
179 | Then evaluate RESULT to get return value, default nil. |
180 | ||
d775d486 | 181 | \(fn (VAR LIST [RESULT]) BODY...)" |
d47f7515 | 182 | (declare (indent 1) (debug ((symbolp form &optional form) body))) |
01d16e16 RS |
183 | ;; It would be cleaner to create an uninterned symbol, |
184 | ;; but that uses a lot more space when many functions in many files | |
185 | ;; use dolist. | |
ca105506 | 186 | ;; FIXME: This cost disappears in byte-compiled lexical-binding files. |
01d16e16 | 187 | (let ((temp '--dolist-tail--)) |
f488fb65 SM |
188 | ;; This is not a reliable test, but it does not matter because both |
189 | ;; semantics are acceptable, tho one is slightly faster with dynamic | |
190 | ;; scoping and the other is slightly faster (and has cleaner semantics) | |
191 | ;; with lexical scoping. | |
192 | (if lexical-binding | |
193 | `(let ((,temp ,(nth 1 spec))) | |
194 | (while ,temp | |
195 | (let ((,(car spec) (car ,temp))) | |
196 | ,@body | |
197 | (setq ,temp (cdr ,temp)))) | |
198 | ,@(if (cdr (cdr spec)) | |
199 | ;; FIXME: This let often leads to "unused var" warnings. | |
200 | `((let ((,(car spec) nil)) ,@(cdr (cdr spec)))))) | |
201 | `(let ((,temp ,(nth 1 spec)) | |
202 | ,(car spec)) | |
203 | (while ,temp | |
204 | (setq ,(car spec) (car ,temp)) | |
205 | ,@body | |
206 | (setq ,temp (cdr ,temp))) | |
207 | ,@(if (cdr (cdr spec)) | |
208 | `((setq ,(car spec) nil) ,@(cdr (cdr spec)))))))) | |
01d16e16 | 209 | |
a0b0756a | 210 | (defmacro dotimes (spec &rest body) |
d47f7515 | 211 | "Loop a certain number of times. |
a0b0756a RS |
212 | Evaluate BODY with VAR bound to successive integers running from 0, |
213 | inclusive, to COUNT, exclusive. Then evaluate RESULT to get | |
d47f7515 SM |
214 | the return value (nil if RESULT is omitted). |
215 | ||
d775d486 | 216 | \(fn (VAR COUNT [RESULT]) BODY...)" |
d47f7515 | 217 | (declare (indent 1) (debug dolist)) |
01d16e16 RS |
218 | ;; It would be cleaner to create an uninterned symbol, |
219 | ;; but that uses a lot more space when many functions in many files | |
220 | ;; use dotimes. | |
f488fb65 | 221 | ;; FIXME: This cost disappears in byte-compiled lexical-binding files. |
01d16e16 | 222 | (let ((temp '--dotimes-limit--) |
d47f7515 SM |
223 | (start 0) |
224 | (end (nth 1 spec))) | |
f488fb65 SM |
225 | ;; This is not a reliable test, but it does not matter because both |
226 | ;; semantics are acceptable, tho one is slightly faster with dynamic | |
227 | ;; scoping and the other has cleaner semantics. | |
228 | (if lexical-binding | |
229 | (let ((counter '--dotimes-counter--)) | |
230 | `(let ((,temp ,end) | |
231 | (,counter ,start)) | |
232 | (while (< ,counter ,temp) | |
233 | (let ((,(car spec) ,counter)) | |
234 | ,@body) | |
235 | (setq ,counter (1+ ,counter))) | |
236 | ,@(if (cddr spec) | |
237 | ;; FIXME: This let often leads to "unused var" warnings. | |
238 | `((let ((,(car spec) ,counter)) ,@(cddr spec)))))) | |
239 | `(let ((,temp ,end) | |
240 | (,(car spec) ,start)) | |
241 | (while (< ,(car spec) ,temp) | |
242 | ,@body | |
243 | (setq ,(car spec) (1+ ,(car spec)))) | |
244 | ,@(cdr (cdr spec)))))) | |
a0b0756a | 245 | |
06b60517 | 246 | (defmacro declare (&rest _specs) |
6b61353c KH |
247 | "Do not evaluate any arguments and return nil. |
248 | Treated as a declaration when used at the right place in a | |
a478f3e1 | 249 | `defmacro' form. \(See Info anchor `(elisp)Definition of declare'.)" |
a69c67e8 CY |
250 | nil) |
251 | )) | |
6b5de136 GM |
252 | |
253 | (defmacro ignore-errors (&rest body) | |
254 | "Execute BODY; if an error occurs, return nil. | |
255 | Otherwise, return result of last form in BODY." | |
7467d0a8 | 256 | (declare (debug t) (indent 0)) |
6b5de136 | 257 | `(condition-case nil (progn ,@body) (error nil))) |
c4f484f2 RS |
258 | \f |
259 | ;;;; Basic Lisp functions. | |
260 | ||
06b60517 | 261 | (defun ignore (&rest _ignore) |
c4f484f2 RS |
262 | "Do nothing and return nil. |
263 | This function accepts any number of arguments, but ignores them." | |
264 | (interactive) | |
265 | nil) | |
266 | ||
fd6c5134 | 267 | ;; Signal a compile-error if the first arg is missing. |
c4f484f2 RS |
268 | (defun error (&rest args) |
269 | "Signal an error, making error message by passing all args to `format'. | |
270 | In Emacs, the convention is that error messages start with a capital | |
271 | letter but *do not* end with a period. Please follow this convention | |
fd6c5134 | 272 | for the sake of consistency." |
c4f484f2 RS |
273 | (while t |
274 | (signal 'error (list (apply 'format args))))) | |
f3a30a50 | 275 | (set-advertised-calling-convention 'error '(string &rest args) "23.1") |
c4f484f2 RS |
276 | |
277 | ;; We put this here instead of in frame.el so that it's defined even on | |
278 | ;; systems where frame.el isn't loaded. | |
279 | (defun frame-configuration-p (object) | |
280 | "Return non-nil if OBJECT seems to be a frame configuration. | |
281 | Any list whose car is `frame-configuration' is assumed to be a frame | |
282 | configuration." | |
283 | (and (consp object) | |
284 | (eq (car object) 'frame-configuration))) | |
c4f484f2 RS |
285 | \f |
286 | ;;;; List functions. | |
6b61353c | 287 | |
d370591d RS |
288 | (defsubst caar (x) |
289 | "Return the car of the car of X." | |
290 | (car (car x))) | |
291 | ||
292 | (defsubst cadr (x) | |
293 | "Return the car of the cdr of X." | |
294 | (car (cdr x))) | |
295 | ||
296 | (defsubst cdar (x) | |
297 | "Return the cdr of the car of X." | |
298 | (cdr (car x))) | |
299 | ||
300 | (defsubst cddr (x) | |
301 | "Return the cdr of the cdr of X." | |
302 | (cdr (cdr x))) | |
e8c32c99 | 303 | |
a478f3e1 JB |
304 | (defun last (list &optional n) |
305 | "Return the last link of LIST. Its car is the last element. | |
306 | If LIST is nil, return nil. | |
307 | If N is non-nil, return the Nth-to-last link of LIST. | |
308 | If N is bigger than the length of LIST, return LIST." | |
369fba5f | 309 | (if n |
10e4702a | 310 | (and (>= n 0) |
88f427d5 | 311 | (let ((m (safe-length list))) |
35744400 IS |
312 | (if (< n m) (nthcdr (- m n) list) list))) |
313 | (and list | |
88f427d5 | 314 | (nthcdr (1- (safe-length list)) list)))) |
526d204e | 315 | |
a478f3e1 | 316 | (defun butlast (list &optional n) |
a3111ae4 | 317 | "Return a copy of LIST with the last N elements removed." |
a478f3e1 JB |
318 | (if (and n (<= n 0)) list |
319 | (nbutlast (copy-sequence list) n))) | |
1c1c65de | 320 | |
a478f3e1 | 321 | (defun nbutlast (list &optional n) |
1c1c65de | 322 | "Modifies LIST to remove the last N elements." |
a478f3e1 | 323 | (let ((m (length list))) |
1c1c65de KH |
324 | (or n (setq n 1)) |
325 | (and (< n m) | |
326 | (progn | |
a478f3e1 JB |
327 | (if (> n 0) (setcdr (nthcdr (- (1- m) n) list) nil)) |
328 | list)))) | |
1c1c65de | 329 | |
6b61353c KH |
330 | (defun delete-dups (list) |
331 | "Destructively remove `equal' duplicates from LIST. | |
332 | Store the result in LIST and return it. LIST must be a proper list. | |
333 | Of several `equal' occurrences of an element in LIST, the first | |
334 | one is kept." | |
335 | (let ((tail list)) | |
336 | (while tail | |
337 | (setcdr tail (delete (car tail) (cdr tail))) | |
338 | (setq tail (cdr tail)))) | |
339 | list) | |
340 | ||
0ed2c9b6 | 341 | (defun number-sequence (from &optional to inc) |
abd9177a | 342 | "Return a sequence of numbers from FROM to TO (both inclusive) as a list. |
6b61353c KH |
343 | INC is the increment used between numbers in the sequence and defaults to 1. |
344 | So, the Nth element of the list is \(+ FROM \(* N INC)) where N counts from | |
345 | zero. TO is only included if there is an N for which TO = FROM + N * INC. | |
346 | If TO is nil or numerically equal to FROM, return \(FROM). | |
347 | If INC is positive and TO is less than FROM, or INC is negative | |
348 | and TO is larger than FROM, return nil. | |
349 | If INC is zero and TO is neither nil nor numerically equal to | |
350 | FROM, signal an error. | |
351 | ||
352 | This function is primarily designed for integer arguments. | |
353 | Nevertheless, FROM, TO and INC can be integer or float. However, | |
354 | floating point arithmetic is inexact. For instance, depending on | |
355 | the machine, it may quite well happen that | |
356 | \(number-sequence 0.4 0.6 0.2) returns the one element list \(0.4), | |
357 | whereas \(number-sequence 0.4 0.8 0.2) returns a list with three | |
358 | elements. Thus, if some of the arguments are floats and one wants | |
359 | to make sure that TO is included, one may have to explicitly write | |
360 | TO as \(+ FROM \(* N INC)) or use a variable whose value was | |
361 | computed with this exact expression. Alternatively, you can, | |
362 | of course, also replace TO with a slightly larger value | |
363 | \(or a slightly more negative value if INC is negative)." | |
364 | (if (or (not to) (= from to)) | |
0ed2c9b6 VJL |
365 | (list from) |
366 | (or inc (setq inc 1)) | |
6b61353c KH |
367 | (when (zerop inc) (error "The increment can not be zero")) |
368 | (let (seq (n 0) (next from)) | |
369 | (if (> inc 0) | |
370 | (while (<= next to) | |
371 | (setq seq (cons next seq) | |
372 | n (1+ n) | |
373 | next (+ from (* n inc)))) | |
374 | (while (>= next to) | |
375 | (setq seq (cons next seq) | |
376 | n (1+ n) | |
377 | next (+ from (* n inc))))) | |
0ed2c9b6 | 378 | (nreverse seq)))) |
abd9177a | 379 | |
a176c9eb CW |
380 | (defun copy-tree (tree &optional vecp) |
381 | "Make a copy of TREE. | |
382 | If TREE is a cons cell, this recursively copies both its car and its cdr. | |
cfebd4db | 383 | Contrast to `copy-sequence', which copies only along the cdrs. With second |
a176c9eb CW |
384 | argument VECP, this copies vectors as well as conses." |
385 | (if (consp tree) | |
cfebd4db RS |
386 | (let (result) |
387 | (while (consp tree) | |
388 | (let ((newcar (car tree))) | |
389 | (if (or (consp (car tree)) (and vecp (vectorp (car tree)))) | |
390 | (setq newcar (copy-tree (car tree) vecp))) | |
391 | (push newcar result)) | |
392 | (setq tree (cdr tree))) | |
68b08950 | 393 | (nconc (nreverse result) tree)) |
a176c9eb CW |
394 | (if (and vecp (vectorp tree)) |
395 | (let ((i (length (setq tree (copy-sequence tree))))) | |
396 | (while (>= (setq i (1- i)) 0) | |
cfebd4db RS |
397 | (aset tree i (copy-tree (aref tree i) vecp))) |
398 | tree) | |
399 | tree))) | |
c4f484f2 RS |
400 | \f |
401 | ;;;; Various list-search functions. | |
a176c9eb | 402 | |
8a288450 RS |
403 | (defun assoc-default (key alist &optional test default) |
404 | "Find object KEY in a pseudo-alist ALIST. | |
753bc4f6 CY |
405 | ALIST is a list of conses or objects. Each element |
406 | (or the element's car, if it is a cons) is compared with KEY by | |
407 | calling TEST, with two arguments: (i) the element or its car, | |
408 | and (ii) KEY. | |
409 | If that is non-nil, the element matches; then `assoc-default' | |
410 | returns the element's cdr, if it is a cons, or DEFAULT if the | |
411 | element is not a cons. | |
8a288450 RS |
412 | |
413 | If no element matches, the value is nil. | |
414 | If TEST is omitted or nil, `equal' is used." | |
415 | (let (found (tail alist) value) | |
416 | (while (and tail (not found)) | |
417 | (let ((elt (car tail))) | |
418 | (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key) | |
419 | (setq found t value (if (consp elt) (cdr elt) default)))) | |
420 | (setq tail (cdr tail))) | |
421 | value)) | |
98aae5f6 | 422 | |
2b69ccfd | 423 | (make-obsolete 'assoc-ignore-case 'assoc-string "22.1") |
98aae5f6 KH |
424 | (defun assoc-ignore-case (key alist) |
425 | "Like `assoc', but ignores differences in case and text representation. | |
426 | KEY must be a string. Upper-case and lower-case letters are treated as equal. | |
427 | Unibyte strings are converted to multibyte for comparison." | |
6b61353c | 428 | (assoc-string key alist t)) |
98aae5f6 | 429 | |
2b69ccfd | 430 | (make-obsolete 'assoc-ignore-representation 'assoc-string "22.1") |
98aae5f6 KH |
431 | (defun assoc-ignore-representation (key alist) |
432 | "Like `assoc', but ignores differences in text representation. | |
264ef586 | 433 | KEY must be a string. |
98aae5f6 | 434 | Unibyte strings are converted to multibyte for comparison." |
6b61353c | 435 | (assoc-string key alist nil)) |
cbbc3205 GM |
436 | |
437 | (defun member-ignore-case (elt list) | |
5612fd08 | 438 | "Like `member', but ignore differences in case and text representation. |
cbbc3205 | 439 | ELT must be a string. Upper-case and lower-case letters are treated as equal. |
d86a3084 RS |
440 | Unibyte strings are converted to multibyte for comparison. |
441 | Non-strings in LIST are ignored." | |
442 | (while (and list | |
443 | (not (and (stringp (car list)) | |
444 | (eq t (compare-strings elt 0 nil (car list) 0 nil t))))) | |
242c13e8 MB |
445 | (setq list (cdr list))) |
446 | list) | |
cbbc3205 | 447 | |
c4f484f2 RS |
448 | (defun assq-delete-all (key alist) |
449 | "Delete from ALIST all elements whose car is `eq' to KEY. | |
450 | Return the modified alist. | |
451 | Elements of ALIST that are not conses are ignored." | |
452 | (while (and (consp (car alist)) | |
453 | (eq (car (car alist)) key)) | |
454 | (setq alist (cdr alist))) | |
455 | (let ((tail alist) tail-cdr) | |
456 | (while (setq tail-cdr (cdr tail)) | |
457 | (if (and (consp (car tail-cdr)) | |
458 | (eq (car (car tail-cdr)) key)) | |
459 | (setcdr tail (cdr tail-cdr)) | |
460 | (setq tail tail-cdr)))) | |
461 | alist) | |
462 | ||
463 | (defun rassq-delete-all (value alist) | |
464 | "Delete from ALIST all elements whose cdr is `eq' to VALUE. | |
465 | Return the modified alist. | |
466 | Elements of ALIST that are not conses are ignored." | |
467 | (while (and (consp (car alist)) | |
468 | (eq (cdr (car alist)) value)) | |
469 | (setq alist (cdr alist))) | |
470 | (let ((tail alist) tail-cdr) | |
471 | (while (setq tail-cdr (cdr tail)) | |
472 | (if (and (consp (car tail-cdr)) | |
473 | (eq (cdr (car tail-cdr)) value)) | |
474 | (setcdr tail (cdr tail-cdr)) | |
475 | (setq tail tail-cdr)))) | |
476 | alist) | |
477 | ||
478 | (defun remove (elt seq) | |
479 | "Return a copy of SEQ with all occurrences of ELT removed. | |
480 | SEQ must be a list, vector, or string. The comparison is done with `equal'." | |
481 | (if (nlistp seq) | |
482 | ;; If SEQ isn't a list, there's no need to copy SEQ because | |
483 | ;; `delete' will return a new object. | |
484 | (delete elt seq) | |
485 | (delete elt (copy-sequence seq)))) | |
486 | ||
487 | (defun remq (elt list) | |
488 | "Return LIST with all occurrences of ELT removed. | |
489 | The comparison is done with `eq'. Contrary to `delq', this does not use | |
490 | side-effects, and the argument LIST is not modified." | |
7f9b7c53 | 491 | (while (and (eq elt (car list)) (setq list (cdr list)))) |
c4f484f2 RS |
492 | (if (memq elt list) |
493 | (delq elt (copy-sequence list)) | |
494 | list)) | |
9a5336ae | 495 | \f |
9a5336ae | 496 | ;;;; Keymap support. |
be9b65ac | 497 | |
c4f484f2 RS |
498 | (defmacro kbd (keys) |
499 | "Convert KEYS to the internal Emacs key representation. | |
500 | KEYS should be a string constant in the format used for | |
501 | saving keyboard macros (see `edmacro-mode')." | |
502 | (read-kbd-macro keys)) | |
503 | ||
be9b65ac | 504 | (defun undefined () |
3fa173b4 | 505 | "Beep to tell the user this binding is undefined." |
be9b65ac DL |
506 | (interactive) |
507 | (ding)) | |
508 | ||
c4f484f2 RS |
509 | ;; Prevent the \{...} documentation construct |
510 | ;; from mentioning keys that run this command. | |
be9b65ac DL |
511 | (put 'undefined 'suppress-keymap t) |
512 | ||
513 | (defun suppress-keymap (map &optional nodigits) | |
514 | "Make MAP override all normally self-inserting keys to be undefined. | |
515 | Normally, as an exception, digits and minus-sign are set to make prefix args, | |
516 | but optional second arg NODIGITS non-nil treats them like other chars." | |
098ba983 | 517 | (define-key map [remap self-insert-command] 'undefined) |
be9b65ac DL |
518 | (or nodigits |
519 | (let (loop) | |
520 | (define-key map "-" 'negative-argument) | |
521 | ;; Make plain numbers do numeric args. | |
522 | (setq loop ?0) | |
523 | (while (<= loop ?9) | |
524 | (define-key map (char-to-string loop) 'digit-argument) | |
525 | (setq loop (1+ loop)))))) | |
526 | ||
640c8776 SM |
527 | (defun make-composed-keymap (maps &optional parent) |
528 | "Construct a new keymap composed of MAPS and inheriting from PARENT. | |
529 | When looking up a key in the returned map, the key is looked in each | |
530 | keymap of MAPS in turn until a binding is found. | |
531 | If no binding is found in MAPS, the lookup continues in PARENT, if non-nil. | |
532 | As always with keymap inheritance, a nil binding in MAPS overrides | |
533 | any corresponding binding in PARENT, but it does not override corresponding | |
534 | bindings in other keymaps of MAPS. | |
535 | MAPS can be a list of keymaps or a single keymap. | |
536 | PARENT if non-nil should be a keymap." | |
537 | `(keymap | |
538 | ,@(if (keymapp maps) (list maps) maps) | |
539 | ,@parent)) | |
540 | ||
4ced66fd | 541 | (defun define-key-after (keymap key definition &optional after) |
4434d61b RS |
542 | "Add binding in KEYMAP for KEY => DEFINITION, right after AFTER's binding. |
543 | This is like `define-key' except that the binding for KEY is placed | |
544 | just after the binding for the event AFTER, instead of at the beginning | |
c34a9d34 RS |
545 | of the map. Note that AFTER must be an event type (like KEY), NOT a command |
546 | \(like DEFINITION). | |
547 | ||
4ced66fd | 548 | If AFTER is t or omitted, the new binding goes at the end of the keymap. |
08b1f8a1 | 549 | AFTER should be a single event type--a symbol or a character, not a sequence. |
c34a9d34 | 550 | |
4ced66fd | 551 | Bindings are always added before any inherited map. |
c34a9d34 | 552 | |
0181e193 LMI |
553 | The order of bindings in a keymap only matters when it is used as |
554 | a menu, so this function is not useful for non-menu keymaps." | |
4ced66fd | 555 | (unless after (setq after t)) |
4434d61b RS |
556 | (or (keymapp keymap) |
557 | (signal 'wrong-type-argument (list 'keymapp keymap))) | |
08b1f8a1 GM |
558 | (setq key |
559 | (if (<= (length key) 1) (aref key 0) | |
560 | (setq keymap (lookup-key keymap | |
561 | (apply 'vector | |
562 | (butlast (mapcar 'identity key))))) | |
563 | (aref key (1- (length key))))) | |
564 | (let ((tail keymap) done inserted) | |
4434d61b RS |
565 | (while (and (not done) tail) |
566 | ;; Delete any earlier bindings for the same key. | |
08b1f8a1 | 567 | (if (eq (car-safe (car (cdr tail))) key) |
4434d61b | 568 | (setcdr tail (cdr (cdr tail)))) |
08b1f8a1 GM |
569 | ;; If we hit an included map, go down that one. |
570 | (if (keymapp (car tail)) (setq tail (car tail))) | |
4434d61b RS |
571 | ;; When we reach AFTER's binding, insert the new binding after. |
572 | ;; If we reach an inherited keymap, insert just before that. | |
113d28a8 | 573 | ;; If we reach the end of this keymap, insert at the end. |
c34a9d34 RS |
574 | (if (or (and (eq (car-safe (car tail)) after) |
575 | (not (eq after t))) | |
113d28a8 RS |
576 | (eq (car (cdr tail)) 'keymap) |
577 | (null (cdr tail))) | |
4434d61b | 578 | (progn |
113d28a8 RS |
579 | ;; Stop the scan only if we find a parent keymap. |
580 | ;; Keep going past the inserted element | |
581 | ;; so we can delete any duplications that come later. | |
582 | (if (eq (car (cdr tail)) 'keymap) | |
583 | (setq done t)) | |
584 | ;; Don't insert more than once. | |
585 | (or inserted | |
08b1f8a1 | 586 | (setcdr tail (cons (cons key definition) (cdr tail)))) |
113d28a8 | 587 | (setq inserted t))) |
4434d61b RS |
588 | (setq tail (cdr tail))))) |
589 | ||
a10cca6c | 590 | (defun map-keymap-sorted (function keymap) |
14694a59 RS |
591 | "Implement `map-keymap' with sorting. |
592 | Don't call this function; it is for internal use only." | |
a10cca6c SM |
593 | (let (list) |
594 | (map-keymap (lambda (a b) (push (cons a b) list)) | |
595 | keymap) | |
596 | (setq list (sort list | |
597 | (lambda (a b) | |
598 | (setq a (car a) b (car b)) | |
599 | (if (integerp a) | |
600 | (if (integerp b) (< a b) | |
601 | t) | |
602 | (if (integerp b) t | |
603 | ;; string< also accepts symbols. | |
604 | (string< a b)))))) | |
605 | (dolist (p list) | |
606 | (funcall function (car p) (cdr p))))) | |
51fa3961 | 607 | |
3349e122 SM |
608 | (defun keymap--menu-item-binding (val) |
609 | "Return the binding part of a menu-item." | |
610 | (cond | |
611 | ((not (consp val)) val) ;Not a menu-item. | |
612 | ((eq 'menu-item (car val)) | |
613 | (let* ((binding (nth 2 val)) | |
614 | (plist (nthcdr 3 val)) | |
615 | (filter (plist-get plist :filter))) | |
616 | (if filter (funcall filter binding) | |
617 | binding))) | |
618 | ((and (consp (cdr val)) (stringp (cadr val))) | |
619 | (cddr val)) | |
620 | ((stringp (car val)) | |
621 | (cdr val)) | |
622 | (t val))) ;Not a menu-item either. | |
623 | ||
624 | (defun keymap--menu-item-with-binding (item binding) | |
625 | "Build a menu-item like ITEM but with its binding changed to BINDING." | |
626 | (cond | |
08e1d82c | 627 | ((not (consp item)) binding) ;Not a menu-item. |
3349e122 SM |
628 | ((eq 'menu-item (car item)) |
629 | (setq item (copy-sequence item)) | |
630 | (let ((tail (nthcdr 2 item))) | |
631 | (setcar tail binding) | |
632 | ;; Remove any potential filter. | |
633 | (if (plist-get (cdr tail) :filter) | |
634 | (setcdr tail (plist-put (cdr tail) :filter nil)))) | |
635 | item) | |
636 | ((and (consp (cdr item)) (stringp (cadr item))) | |
637 | (cons (car item) (cons (cadr item) binding))) | |
638 | (t (cons (car item) binding)))) | |
639 | ||
640 | (defun keymap--merge-bindings (val1 val2) | |
641 | "Merge bindings VAL1 and VAL2." | |
642 | (let ((map1 (keymap--menu-item-binding val1)) | |
643 | (map2 (keymap--menu-item-binding val2))) | |
644 | (if (not (and (keymapp map1) (keymapp map2))) | |
645 | ;; There's nothing to merge: val1 takes precedence. | |
646 | val1 | |
647 | (let ((map (list 'keymap map1 map2)) | |
648 | (item (if (keymapp val1) (if (keymapp val2) nil val2) val1))) | |
649 | (keymap--menu-item-with-binding item map))))) | |
650 | ||
00f7c5ed | 651 | (defun keymap-canonicalize (map) |
3349e122 SM |
652 | "Return a simpler equivalent keymap. |
653 | This resolves inheritance and redefinitions. The returned keymap | |
654 | should behave identically to a copy of KEYMAP w.r.t `lookup-key' | |
655 | and use in active keymaps and menus. | |
656 | Subkeymaps may be modified but are not canonicalized." | |
657 | ;; FIXME: Problem with the difference between a nil binding | |
658 | ;; that hides a binding in an inherited map and a nil binding that's ignored | |
659 | ;; to let some further binding visible. Currently a nil binding hides all. | |
660 | ;; FIXME: we may want to carefully (re)order elements in case they're | |
661 | ;; menu-entries. | |
00f7c5ed | 662 | (let ((bindings ()) |
c099a588 AS |
663 | (ranges ()) |
664 | (prompt (keymap-prompt map))) | |
00f7c5ed | 665 | (while (keymapp map) |
3349e122 | 666 | (setq map (map-keymap ;; -internal |
00f7c5ed SM |
667 | (lambda (key item) |
668 | (if (consp key) | |
669 | ;; Treat char-ranges specially. | |
670 | (push (cons key item) ranges) | |
671 | (push (cons key item) bindings))) | |
672 | map))) | |
3349e122 | 673 | ;; Create the new map. |
c099a588 | 674 | (setq map (funcall (if ranges 'make-keymap 'make-sparse-keymap) prompt)) |
00f7c5ed | 675 | (dolist (binding ranges) |
3349e122 | 676 | ;; Treat char-ranges specially. FIXME: need to merge as well. |
64981d1a | 677 | (define-key map (vector (car binding)) (cdr binding))) |
3349e122 | 678 | ;; Process the bindings starting from the end. |
00f7c5ed SM |
679 | (dolist (binding (prog1 bindings (setq bindings ()))) |
680 | (let* ((key (car binding)) | |
681 | (item (cdr binding)) | |
682 | (oldbind (assq key bindings))) | |
3349e122 SM |
683 | (push (if (not oldbind) |
684 | ;; The normal case: no duplicate bindings. | |
685 | binding | |
686 | ;; This is the second binding for this key. | |
687 | (setq bindings (delq oldbind bindings)) | |
688 | (cons key (keymap--merge-bindings (cdr binding) | |
689 | (cdr oldbind)))) | |
690 | bindings))) | |
00f7c5ed SM |
691 | (nconc map bindings))) |
692 | ||
8bed5e3d RS |
693 | (put 'keyboard-translate-table 'char-table-extra-slots 0) |
694 | ||
9a5336ae JB |
695 | (defun keyboard-translate (from to) |
696 | "Translate character FROM to TO at a low level. | |
697 | This function creates a `keyboard-translate-table' if necessary | |
698 | and then modifies one entry in it." | |
8bed5e3d RS |
699 | (or (char-table-p keyboard-translate-table) |
700 | (setq keyboard-translate-table | |
701 | (make-char-table 'keyboard-translate-table nil))) | |
9a5336ae | 702 | (aset keyboard-translate-table from to)) |
9a5336ae | 703 | \f |
c4f484f2 | 704 | ;;;; Key binding commands. |
9a5336ae | 705 | |
c4f484f2 RS |
706 | (defun global-set-key (key command) |
707 | "Give KEY a global binding as COMMAND. | |
708 | COMMAND is the command definition to use; usually it is | |
709 | a symbol naming an interactively-callable function. | |
710 | KEY is a key sequence; noninteractively, it is a string or vector | |
711 | of characters or event types, and non-ASCII characters with codes | |
712 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
9a5336ae | 713 | |
c4f484f2 RS |
714 | Note that if KEY has a local binding in the current buffer, |
715 | that local binding will continue to shadow any global binding | |
716 | that you make with this function." | |
717 | (interactive "KSet key globally: \nCSet key %s to command: ") | |
718 | (or (vectorp key) (stringp key) | |
719 | (signal 'wrong-type-argument (list 'arrayp key))) | |
720 | (define-key (current-global-map) key command)) | |
9a5336ae | 721 | |
c4f484f2 RS |
722 | (defun local-set-key (key command) |
723 | "Give KEY a local binding as COMMAND. | |
724 | COMMAND is the command definition to use; usually it is | |
725 | a symbol naming an interactively-callable function. | |
726 | KEY is a key sequence; noninteractively, it is a string or vector | |
727 | of characters or event types, and non-ASCII characters with codes | |
728 | above 127 (such as ISO Latin-1) can be included if you use a vector. | |
9a5336ae | 729 | |
c4f484f2 RS |
730 | The binding goes in the current buffer's local map, |
731 | which in most cases is shared with all other buffers in the same major mode." | |
732 | (interactive "KSet key locally: \nCSet key %s locally to command: ") | |
733 | (let ((map (current-local-map))) | |
734 | (or map | |
735 | (use-local-map (setq map (make-sparse-keymap)))) | |
736 | (or (vectorp key) (stringp key) | |
737 | (signal 'wrong-type-argument (list 'arrayp key))) | |
738 | (define-key map key command))) | |
9a5336ae | 739 | |
c4f484f2 RS |
740 | (defun global-unset-key (key) |
741 | "Remove global binding of KEY. | |
742 | KEY is a string or vector representing a sequence of keystrokes." | |
743 | (interactive "kUnset key globally: ") | |
744 | (global-set-key key nil)) | |
9a5336ae | 745 | |
c4f484f2 RS |
746 | (defun local-unset-key (key) |
747 | "Remove local binding of KEY. | |
748 | KEY is a string or vector representing a sequence of keystrokes." | |
749 | (interactive "kUnset key locally: ") | |
750 | (if (current-local-map) | |
751 | (local-set-key key nil)) | |
752 | nil) | |
753 | \f | |
754 | ;;;; substitute-key-definition and its subroutines. | |
755 | ||
756 | (defvar key-substitution-in-progress nil | |
c8227332 | 757 | "Used internally by `substitute-key-definition'.") |
c4f484f2 RS |
758 | |
759 | (defun substitute-key-definition (olddef newdef keymap &optional oldmap prefix) | |
760 | "Replace OLDDEF with NEWDEF for any keys in KEYMAP now defined as OLDDEF. | |
761 | In other words, OLDDEF is replaced with NEWDEF where ever it appears. | |
762 | Alternatively, if optional fourth argument OLDMAP is specified, we redefine | |
763 | in KEYMAP as NEWDEF those keys which are defined as OLDDEF in OLDMAP. | |
764 | ||
fda11e85 RS |
765 | If you don't specify OLDMAP, you can usually get the same results |
766 | in a cleaner way with command remapping, like this: | |
50d16788 JB |
767 | \(define-key KEYMAP [remap OLDDEF] NEWDEF) |
768 | \n(fn OLDDEF NEWDEF KEYMAP &optional OLDMAP)" | |
c4f484f2 RS |
769 | ;; Don't document PREFIX in the doc string because we don't want to |
770 | ;; advertise it. It's meant for recursive calls only. Here's its | |
771 | ;; meaning | |
772 | ||
773 | ;; If optional argument PREFIX is specified, it should be a key | |
774 | ;; prefix, a string. Redefined bindings will then be bound to the | |
775 | ;; original key, with PREFIX added at the front. | |
776 | (or prefix (setq prefix "")) | |
777 | (let* ((scan (or oldmap keymap)) | |
778 | (prefix1 (vconcat prefix [nil])) | |
779 | (key-substitution-in-progress | |
780 | (cons scan key-substitution-in-progress))) | |
781 | ;; Scan OLDMAP, finding each char or event-symbol that | |
782 | ;; has any definition, and act on it with hack-key. | |
783 | (map-keymap | |
784 | (lambda (char defn) | |
785 | (aset prefix1 (length prefix) char) | |
786 | (substitute-key-definition-key defn olddef newdef prefix1 keymap)) | |
787 | scan))) | |
788 | ||
789 | (defun substitute-key-definition-key (defn olddef newdef prefix keymap) | |
790 | (let (inner-def skipped menu-item) | |
791 | ;; Find the actual command name within the binding. | |
792 | (if (eq (car-safe defn) 'menu-item) | |
793 | (setq menu-item defn defn (nth 2 defn)) | |
794 | ;; Skip past menu-prompt. | |
795 | (while (stringp (car-safe defn)) | |
796 | (push (pop defn) skipped)) | |
797 | ;; Skip past cached key-equivalence data for menu items. | |
798 | (if (consp (car-safe defn)) | |
799 | (setq defn (cdr defn)))) | |
800 | (if (or (eq defn olddef) | |
801 | ;; Compare with equal if definition is a key sequence. | |
802 | ;; That is useful for operating on function-key-map. | |
803 | (and (or (stringp defn) (vectorp defn)) | |
804 | (equal defn olddef))) | |
805 | (define-key keymap prefix | |
806 | (if menu-item | |
807 | (let ((copy (copy-sequence menu-item))) | |
808 | (setcar (nthcdr 2 copy) newdef) | |
809 | copy) | |
810 | (nconc (nreverse skipped) newdef))) | |
811 | ;; Look past a symbol that names a keymap. | |
812 | (setq inner-def | |
cf25c647 | 813 | (or (indirect-function defn t) defn)) |
c4f484f2 RS |
814 | ;; For nested keymaps, we use `inner-def' rather than `defn' so as to |
815 | ;; avoid autoloading a keymap. This is mostly done to preserve the | |
816 | ;; original non-autoloading behavior of pre-map-keymap times. | |
817 | (if (and (keymapp inner-def) | |
818 | ;; Avoid recursively scanning | |
819 | ;; where KEYMAP does not have a submap. | |
820 | (let ((elt (lookup-key keymap prefix))) | |
821 | (or (null elt) (natnump elt) (keymapp elt))) | |
822 | ;; Avoid recursively rescanning keymap being scanned. | |
823 | (not (memq inner-def key-substitution-in-progress))) | |
824 | ;; If this one isn't being scanned already, scan it now. | |
825 | (substitute-key-definition olddef newdef keymap inner-def prefix))))) | |
9a5336ae JB |
826 | |
827 | \f | |
264ef586 | 828 | ;;;; The global keymap tree. |
9a5336ae | 829 | |
354f0faf SM |
830 | ;; global-map, esc-map, and ctl-x-map have their values set up in |
831 | ;; keymap.c; we just give them docstrings here. | |
9a5336ae JB |
832 | |
833 | (defvar global-map nil | |
834 | "Default global keymap mapping Emacs keyboard input into commands. | |
835 | The value is a keymap which is usually (but not necessarily) Emacs's | |
836 | global map.") | |
837 | ||
838 | (defvar esc-map nil | |
839 | "Default keymap for ESC (meta) commands. | |
840 | The normal global definition of the character ESC indirects to this keymap.") | |
841 | ||
842 | (defvar ctl-x-map nil | |
843 | "Default keymap for C-x commands. | |
844 | The normal global definition of the character C-x indirects to this keymap.") | |
845 | ||
846 | (defvar ctl-x-4-map (make-sparse-keymap) | |
03eeb110 | 847 | "Keymap for subcommands of C-x 4.") |
059184dd | 848 | (defalias 'ctl-x-4-prefix ctl-x-4-map) |
9a5336ae JB |
849 | (define-key ctl-x-map "4" 'ctl-x-4-prefix) |
850 | ||
851 | (defvar ctl-x-5-map (make-sparse-keymap) | |
852 | "Keymap for frame commands.") | |
059184dd | 853 | (defalias 'ctl-x-5-prefix ctl-x-5-map) |
9a5336ae JB |
854 | (define-key ctl-x-map "5" 'ctl-x-5-prefix) |
855 | ||
0f03054a | 856 | \f |
9a5336ae JB |
857 | ;;;; Event manipulation functions. |
858 | ||
03a74b84 | 859 | (defconst listify-key-sequence-1 (logior 128 ?\M-\C-@)) |
114137b8 | 860 | |
cde6d7e3 RS |
861 | (defun listify-key-sequence (key) |
862 | "Convert a key sequence to a list of events." | |
863 | (if (vectorp key) | |
864 | (append key nil) | |
865 | (mapcar (function (lambda (c) | |
866 | (if (> c 127) | |
114137b8 | 867 | (logxor c listify-key-sequence-1) |
cde6d7e3 | 868 | c))) |
d47f7515 | 869 | key))) |
cde6d7e3 | 870 | |
53e5a4e8 RS |
871 | (defsubst eventp (obj) |
872 | "True if the argument is an event object." | |
7a2937ce SM |
873 | (or (and (integerp obj) |
874 | ;; Filter out integers too large to be events. | |
875 | ;; M is the biggest modifier. | |
876 | (zerop (logand obj (lognot (1- (lsh ?\M-\^@ 1))))) | |
327719ee | 877 | (characterp (event-basic-type obj))) |
53e5a4e8 RS |
878 | (and (symbolp obj) |
879 | (get obj 'event-symbol-elements)) | |
880 | (and (consp obj) | |
881 | (symbolp (car obj)) | |
882 | (get (car obj) 'event-symbol-elements)))) | |
883 | ||
884 | (defun event-modifiers (event) | |
a3111ae4 | 885 | "Return a list of symbols representing the modifier keys in event EVENT. |
53e5a4e8 | 886 | The elements of the list may include `meta', `control', |
32295976 | 887 | `shift', `hyper', `super', `alt', `click', `double', `triple', `drag', |
0e91dc92 LT |
888 | and `down'. |
889 | EVENT may be an event or an event type. If EVENT is a symbol | |
890 | that has never been used in an event that has been read as input | |
b1a4f8e1 SM |
891 | in the current Emacs session, then this function may fail to include |
892 | the `click' modifier." | |
53e5a4e8 RS |
893 | (let ((type event)) |
894 | (if (listp type) | |
895 | (setq type (car type))) | |
896 | (if (symbolp type) | |
58da34c7 SM |
897 | ;; Don't read event-symbol-elements directly since we're not |
898 | ;; sure the symbol has already been parsed. | |
899 | (cdr (internal-event-symbol-parse-modifiers type)) | |
5572c97f RS |
900 | (let ((list nil) |
901 | (char (logand type (lognot (logior ?\M-\^@ ?\C-\^@ ?\S-\^@ | |
902 | ?\H-\^@ ?\s-\^@ ?\A-\^@))))) | |
903 | (if (not (zerop (logand type ?\M-\^@))) | |
9166dbf6 | 904 | (push 'meta list)) |
5572c97f RS |
905 | (if (or (not (zerop (logand type ?\C-\^@))) |
906 | (< char 32)) | |
9166dbf6 | 907 | (push 'control list)) |
5572c97f RS |
908 | (if (or (not (zerop (logand type ?\S-\^@))) |
909 | (/= char (downcase char))) | |
9166dbf6 | 910 | (push 'shift list)) |
da16e648 | 911 | (or (zerop (logand type ?\H-\^@)) |
9166dbf6 | 912 | (push 'hyper list)) |
da16e648 | 913 | (or (zerop (logand type ?\s-\^@)) |
9166dbf6 | 914 | (push 'super list)) |
da16e648 | 915 | (or (zerop (logand type ?\A-\^@)) |
9166dbf6 | 916 | (push 'alt list)) |
53e5a4e8 RS |
917 | list)))) |
918 | ||
d63de416 | 919 | (defun event-basic-type (event) |
a3111ae4 | 920 | "Return the basic type of the given event (all modifiers removed). |
0e91dc92 LT |
921 | The value is a printing character (not upper case) or a symbol. |
922 | EVENT may be an event or an event type. If EVENT is a symbol | |
923 | that has never been used in an event that has been read as input | |
924 | in the current Emacs session, then this function may return nil." | |
2b0f4ba5 JB |
925 | (if (consp event) |
926 | (setq event (car event))) | |
d63de416 RS |
927 | (if (symbolp event) |
928 | (car (get event 'event-symbol-elements)) | |
9aca2476 RS |
929 | (let* ((base (logand event (1- ?\A-\^@))) |
930 | (uncontrolled (if (< base 32) (logior base 64) base))) | |
931 | ;; There are some numbers that are invalid characters and | |
932 | ;; cause `downcase' to get an error. | |
933 | (condition-case () | |
934 | (downcase uncontrolled) | |
935 | (error uncontrolled))))) | |
d63de416 | 936 | |
0f03054a RS |
937 | (defsubst mouse-movement-p (object) |
938 | "Return non-nil if OBJECT is a mouse movement event." | |
9166dbf6 | 939 | (eq (car-safe object) 'mouse-movement)) |
0f03054a | 940 | |
5ad4f91c SS |
941 | (defun mouse-event-p (object) |
942 | "Return non-nil if OBJECT is a mouse click event." | |
943 | ;; is this really correct? maybe remove mouse-movement? | |
944 | (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))) | |
945 | ||
0f03054a RS |
946 | (defsubst event-start (event) |
947 | "Return the starting position of EVENT. | |
c88aaf48 CY |
948 | EVENT should be a click, drag, or key press event. |
949 | If it is a key press event, the return value has the form | |
950 | (WINDOW POS (0 . 0) 0) | |
951 | If it is a click or drag event, it has the form | |
6b61353c KH |
952 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
953 | IMAGE (DX . DY) (WIDTH . HEIGHT)) | |
c88aaf48 CY |
954 | The `posn-' functions access elements of such lists. |
955 | For more information, see Info node `(elisp)Click Events'. | |
956 | ||
957 | If EVENT is a mouse or key press or a mouse click, this is the | |
958 | position of the event. If EVENT is a drag, this is the starting | |
959 | position of the drag." | |
5ef6a86d SM |
960 | (if (consp event) (nth 1 event) |
961 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a RS |
962 | |
963 | (defsubst event-end (event) | |
6b61353c KH |
964 | "Return the ending location of EVENT. |
965 | EVENT should be a click, drag, or key press event. | |
c88aaf48 CY |
966 | If EVENT is a key press event, the return value has the form |
967 | (WINDOW POS (0 . 0) 0) | |
968 | If EVENT is a click event, this function is the same as | |
969 | `event-start'. For click and drag events, the return value has | |
970 | the form | |
6b61353c KH |
971 | (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW) |
972 | IMAGE (DX . DY) (WIDTH . HEIGHT)) | |
c88aaf48 CY |
973 | The `posn-' functions access elements of such lists. |
974 | For more information, see Info node `(elisp)Click Events'. | |
975 | ||
976 | If EVENT is a mouse or key press or a mouse click, this is the | |
977 | position of the event. If EVENT is a drag, this is the starting | |
978 | position of the drag." | |
5ef6a86d SM |
979 | (if (consp event) (nth (if (consp (nth 2 event)) 2 1) event) |
980 | (list (selected-window) (point) '(0 . 0) 0))) | |
0f03054a | 981 | |
32295976 RS |
982 | (defsubst event-click-count (event) |
983 | "Return the multi-click count of EVENT, a click or drag event. | |
984 | The return value is a positive integer." | |
5ef6a86d | 985 | (if (and (consp event) (integerp (nth 2 event))) (nth 2 event) 1)) |
c4f484f2 RS |
986 | \f |
987 | ;;;; Extracting fields of the positions in an event. | |
32295976 | 988 | |
0f03054a RS |
989 | (defsubst posn-window (position) |
990 | "Return the window in POSITION. | |
6b61353c KH |
991 | POSITION should be a list of the form returned by the `event-start' |
992 | and `event-end' functions." | |
0f03054a RS |
993 | (nth 0 position)) |
994 | ||
6b61353c KH |
995 | (defsubst posn-area (position) |
996 | "Return the window area recorded in POSITION, or nil for the text area. | |
997 | POSITION should be a list of the form returned by the `event-start' | |
998 | and `event-end' functions." | |
999 | (let ((area (if (consp (nth 1 position)) | |
1000 | (car (nth 1 position)) | |
1001 | (nth 1 position)))) | |
1002 | (and (symbolp area) area))) | |
1003 | ||
0f03054a RS |
1004 | (defsubst posn-point (position) |
1005 | "Return the buffer location in POSITION. | |
6b61353c KH |
1006 | POSITION should be a list of the form returned by the `event-start' |
1007 | and `event-end' functions." | |
1008 | (or (nth 5 position) | |
1009 | (if (consp (nth 1 position)) | |
1010 | (car (nth 1 position)) | |
1011 | (nth 1 position)))) | |
1012 | ||
1013 | (defun posn-set-point (position) | |
1014 | "Move point to POSITION. | |
1015 | Select the corresponding window as well." | |
c8227332 VJL |
1016 | (if (not (windowp (posn-window position))) |
1017 | (error "Position not in text area of window")) | |
1018 | (select-window (posn-window position)) | |
1019 | (if (numberp (posn-point position)) | |
1020 | (goto-char (posn-point position)))) | |
0f03054a | 1021 | |
e55c21be RS |
1022 | (defsubst posn-x-y (position) |
1023 | "Return the x and y coordinates in POSITION. | |
74194465 CY |
1024 | The return value has the form (X . Y), where X and Y are given in |
1025 | pixels. POSITION should be a list of the form returned by | |
1026 | `event-start' and `event-end'." | |
0f03054a RS |
1027 | (nth 2 position)) |
1028 | ||
aa360da1 GM |
1029 | (declare-function scroll-bar-scale "scroll-bar" (num-denom whole)) |
1030 | ||
ed627e08 | 1031 | (defun posn-col-row (position) |
6b61353c KH |
1032 | "Return the nominal column and row in POSITION, measured in characters. |
1033 | The column and row values are approximations calculated from the x | |
1034 | and y coordinates in POSITION and the frame's default character width | |
1035 | and height. | |
ed627e08 | 1036 | For a scroll-bar event, the result column is 0, and the row |
6b61353c KH |
1037 | corresponds to the vertical position of the click in the scroll bar. |
1038 | POSITION should be a list of the form returned by the `event-start' | |
1039 | and `event-end' functions." | |
1040 | (let* ((pair (posn-x-y position)) | |
1041 | (window (posn-window position)) | |
1042 | (area (posn-area position))) | |
1043 | (cond | |
1044 | ((null window) | |
1045 | '(0 . 0)) | |
1046 | ((eq area 'vertical-scroll-bar) | |
1047 | (cons 0 (scroll-bar-scale pair (1- (window-height window))))) | |
1048 | ((eq area 'horizontal-scroll-bar) | |
1049 | (cons (scroll-bar-scale pair (window-width window)) 0)) | |
1050 | (t | |
1051 | (let* ((frame (if (framep window) window (window-frame window))) | |
7beba943 CY |
1052 | ;; FIXME: This should take line-spacing properties on |
1053 | ;; newlines into account. | |
1054 | (spacing (when (display-graphic-p frame) | |
1055 | (or (with-current-buffer (window-buffer window) | |
1056 | line-spacing) | |
1057 | (frame-parameter frame 'line-spacing))))) | |
1058 | (cond ((floatp spacing) | |
1059 | (setq spacing (truncate (* spacing | |
1060 | (frame-char-height frame))))) | |
1061 | ((null spacing) | |
1062 | (setq spacing 0))) | |
1063 | (cons (/ (car pair) (frame-char-width frame)) | |
e68afd74 | 1064 | (- (/ (cdr pair) (+ (frame-char-height frame) spacing)) |
11aad4e9 EZ |
1065 | (if (null (with-current-buffer (window-buffer window) |
1066 | header-line-format)) | |
1067 | 0 1)))))))) | |
6b61353c KH |
1068 | |
1069 | (defun posn-actual-col-row (position) | |
1070 | "Return the actual column and row in POSITION, measured in characters. | |
1071 | These are the actual row number in the window and character number in that row. | |
1072 | Return nil if POSITION does not contain the actual position; in that case | |
1073 | `posn-col-row' can be used to get approximate values. | |
1074 | POSITION should be a list of the form returned by the `event-start' | |
1075 | and `event-end' functions." | |
1076 | (nth 6 position)) | |
e55c21be | 1077 | |
0f03054a RS |
1078 | (defsubst posn-timestamp (position) |
1079 | "Return the timestamp of POSITION. | |
6b61353c KH |
1080 | POSITION should be a list of the form returned by the `event-start' |
1081 | and `event-end' functions." | |
0f03054a | 1082 | (nth 3 position)) |
9a5336ae | 1083 | |
6b61353c | 1084 | (defsubst posn-string (position) |
79a09c9c KS |
1085 | "Return the string object of POSITION. |
1086 | Value is a cons (STRING . STRING-POS), or nil if not a string. | |
6b61353c KH |
1087 | POSITION should be a list of the form returned by the `event-start' |
1088 | and `event-end' functions." | |
1089 | (nth 4 position)) | |
1090 | ||
1091 | (defsubst posn-image (position) | |
79a09c9c | 1092 | "Return the image object of POSITION. |
0c3f75f6 | 1093 | Value is a list (image ...), or nil if not an image. |
6b61353c KH |
1094 | POSITION should be a list of the form returned by the `event-start' |
1095 | and `event-end' functions." | |
1096 | (nth 7 position)) | |
1097 | ||
1098 | (defsubst posn-object (position) | |
1099 | "Return the object (image or string) of POSITION. | |
79a09c9c KS |
1100 | Value is a list (image ...) for an image object, a cons cell |
1101 | \(STRING . STRING-POS) for a string object, and nil for a buffer position. | |
6b61353c KH |
1102 | POSITION should be a list of the form returned by the `event-start' |
1103 | and `event-end' functions." | |
1104 | (or (posn-image position) (posn-string position))) | |
1105 | ||
1106 | (defsubst posn-object-x-y (position) | |
1107 | "Return the x and y coordinates relative to the object of POSITION. | |
74194465 CY |
1108 | The return value has the form (DX . DY), where DX and DY are |
1109 | given in pixels. POSITION should be a list of the form returned | |
1110 | by `event-start' and `event-end'." | |
6b61353c KH |
1111 | (nth 8 position)) |
1112 | ||
1113 | (defsubst posn-object-width-height (position) | |
1114 | "Return the pixel width and height of the object of POSITION. | |
74194465 CY |
1115 | The return value has the form (WIDTH . HEIGHT). POSITION should |
1116 | be a list of the form returned by `event-start' and `event-end'." | |
6b61353c KH |
1117 | (nth 9 position)) |
1118 | ||
0f03054a | 1119 | \f |
9a5336ae JB |
1120 | ;;;; Obsolescent names for functions. |
1121 | ||
9d28c33e SM |
1122 | (define-obsolete-function-alias 'window-dot 'window-point "22.1") |
1123 | (define-obsolete-function-alias 'set-window-dot 'set-window-point "22.1") | |
1124 | (define-obsolete-function-alias 'read-input 'read-string "22.1") | |
1125 | (define-obsolete-function-alias 'show-buffer 'set-window-buffer "22.1") | |
1126 | (define-obsolete-function-alias 'eval-current-buffer 'eval-buffer "22.1") | |
1127 | (define-obsolete-function-alias 'string-to-int 'string-to-number "22.1") | |
1128 | ||
9d28c33e SM |
1129 | (make-obsolete 'forward-point "use (+ (point) N) instead." "23.1") |
1130 | ||
1131 | (defun insert-string (&rest args) | |
1132 | "Mocklisp-compatibility insert function. | |
1133 | Like the function `insert' except that any argument that is a number | |
1134 | is converted into a string by expressing it in decimal." | |
1135 | (dolist (el args) | |
1136 | (insert (if (integerp el) (number-to-string el) el)))) | |
1137 | (make-obsolete 'insert-string 'insert "22.1") | |
1138 | ||
1139 | (defun makehash (&optional test) (make-hash-table :test (or test 'eql))) | |
1140 | (make-obsolete 'makehash 'make-hash-table "22.1") | |
1141 | ||
1142 | ;; These are used by VM and some old programs | |
1143 | (defalias 'focus-frame 'ignore "") | |
1144 | (make-obsolete 'focus-frame "it does nothing." "22.1") | |
1145 | (defalias 'unfocus-frame 'ignore "") | |
1146 | (make-obsolete 'unfocus-frame "it does nothing." "22.1") | |
1147 | (make-obsolete 'make-variable-frame-local | |
1148 | "explicitly check for a frame-parameter instead." "22.2") | |
1149 | (make-obsolete 'interactive-p 'called-interactively-p "23.2") | |
f3a30a50 | 1150 | (set-advertised-calling-convention 'called-interactively-p '(kind) "23.1") |
4fcc3d32 | 1151 | (set-advertised-calling-convention |
f3a30a50 SM |
1152 | 'all-completions '(string collection &optional predicate) "23.1") |
1153 | (set-advertised-calling-convention 'unintern '(name obarray) "23.3") | |
9d28c33e SM |
1154 | \f |
1155 | ;;;; Obsolescence declarations for variables, and aliases. | |
1156 | ||
4e3b4528 SM |
1157 | ;; Special "default-FOO" variables which contain the default value of |
1158 | ;; the "FOO" variable are nasty. Their implementation is brittle, and | |
1159 | ;; slows down several unrelated variable operations; furthermore, they | |
1160 | ;; can lead to really odd behavior if you decide to make them | |
1161 | ;; buffer-local. | |
1162 | ||
1163 | ;; Not used at all in Emacs, last time I checked: | |
1164 | (make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2") | |
1165 | (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2") | |
1166 | (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2") | |
1167 | (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2") | |
1168 | (make-obsolete-variable 'default-ctl-arrow 'ctl-arrow "23.2") | |
4e3b4528 SM |
1169 | (make-obsolete-variable 'default-truncate-lines 'truncate-lines "23.2") |
1170 | (make-obsolete-variable 'default-left-margin 'left-margin "23.2") | |
1171 | (make-obsolete-variable 'default-tab-width 'tab-width "23.2") | |
1172 | (make-obsolete-variable 'default-case-fold-search 'case-fold-search "23.2") | |
1173 | (make-obsolete-variable 'default-left-margin-width 'left-margin-width "23.2") | |
1174 | (make-obsolete-variable 'default-right-margin-width 'right-margin-width "23.2") | |
1175 | (make-obsolete-variable 'default-left-fringe-width 'left-fringe-width "23.2") | |
1176 | (make-obsolete-variable 'default-right-fringe-width 'right-fringe-width "23.2") | |
1177 | (make-obsolete-variable 'default-fringes-outside-margins 'fringes-outside-margins "23.2") | |
1178 | (make-obsolete-variable 'default-scroll-bar-width 'scroll-bar-width "23.2") | |
1179 | (make-obsolete-variable 'default-vertical-scroll-bar 'vertical-scroll-bar "23.2") | |
1180 | (make-obsolete-variable 'default-indicate-empty-lines 'indicate-empty-lines "23.2") | |
1181 | (make-obsolete-variable 'default-indicate-buffer-boundaries 'indicate-buffer-boundaries "23.2") | |
1182 | (make-obsolete-variable 'default-fringe-indicator-alist 'fringe-indicator-alist "23.2") | |
1183 | (make-obsolete-variable 'default-fringe-cursor-alist 'fringe-cursor-alist "23.2") | |
1184 | (make-obsolete-variable 'default-scroll-up-aggressively 'scroll-up-aggressively "23.2") | |
1185 | (make-obsolete-variable 'default-scroll-down-aggressively 'scroll-down-aggressively "23.2") | |
1186 | (make-obsolete-variable 'default-fill-column 'fill-column "23.2") | |
1187 | (make-obsolete-variable 'default-cursor-type 'cursor-type "23.2") | |
1188 | (make-obsolete-variable 'default-buffer-file-type 'buffer-file-type "23.2") | |
1189 | (make-obsolete-variable 'default-cursor-in-non-selected-windows 'cursor-in-non-selected-windows "23.2") | |
1190 | (make-obsolete-variable 'default-buffer-file-coding-system 'buffer-file-coding-system "23.2") | |
1191 | (make-obsolete-variable 'default-major-mode 'major-mode "23.2") | |
1192 | (make-obsolete-variable 'default-enable-multibyte-characters | |
1193 | "use enable-multibyte-characters or set-buffer-multibyte instead" "23.2") | |
1194 | ||
50d4ba39 | 1195 | (make-obsolete-variable 'define-key-rebound-commands nil "23.2") |
379ec02c | 1196 | (make-obsolete-variable 'redisplay-end-trigger-functions 'jit-lock-register "23.1") |
78f64af0 SM |
1197 | (make-obsolete-variable 'deferred-action-list 'post-command-hook "24.1") |
1198 | (make-obsolete-variable 'deferred-action-function 'post-command-hook "24.1") | |
379ec02c SM |
1199 | (make-obsolete 'window-redisplay-end-trigger nil "23.1") |
1200 | (make-obsolete 'set-window-redisplay-end-trigger nil "23.1") | |
1201 | ||
1202 | (make-obsolete 'process-filter-multibyte-p nil "23.1") | |
1203 | (make-obsolete 'set-process-filter-multibyte nil "23.1") | |
1204 | ||
c8227332 VJL |
1205 | (make-obsolete-variable |
1206 | 'mode-line-inverse-video | |
1207 | "use the appropriate faces instead." | |
1208 | "21.1") | |
1209 | (make-obsolete-variable | |
1210 | 'unread-command-char | |
1211 | "use `unread-command-events' instead. That variable is a list of events | |
304bbefc | 1212 | to reread, so it now uses nil to mean `no event', instead of -1." |
c8227332 | 1213 | "before 19.15") |
bd292357 | 1214 | |
8ee7e9db LT |
1215 | ;; Lisp manual only updated in 22.1. |
1216 | (define-obsolete-variable-alias 'executing-macro 'executing-kbd-macro | |
c8227332 | 1217 | "before 19.34") |
8ee7e9db | 1218 | |
0ecd53f8 | 1219 | (defvaralias 'x-lost-selection-hooks 'x-lost-selection-functions) |
c8227332 VJL |
1220 | (make-obsolete-variable 'x-lost-selection-hooks |
1221 | 'x-lost-selection-functions "22.1") | |
0ecd53f8 | 1222 | (defvaralias 'x-sent-selection-hooks 'x-sent-selection-functions) |
c8227332 VJL |
1223 | (make-obsolete-variable 'x-sent-selection-hooks |
1224 | 'x-sent-selection-functions "22.1") | |
9e247d24 | 1225 | |
b46957e2 EZ |
1226 | ;; This was introduced in 21.4 for pre-unicode unification. That |
1227 | ;; usage was rendered obsolete in 23.1 which uses Unicode internally. | |
1228 | ;; Other uses are possible, so this variable is not _really_ obsolete, | |
1229 | ;; but Stefan insists to mark it so. | |
1230 | (make-obsolete-variable 'translation-table-for-input nil "23.1") | |
1231 | ||
9e247d24 | 1232 | (defvaralias 'messages-buffer-max-lines 'message-log-max) |
d293848d GM |
1233 | |
1234 | ;; These aliases exist in Emacs 19.34, and probably before, but were | |
1235 | ;; only marked as obsolete in 23.1. | |
fb2bae29 | 1236 | ;; The lisp manual (since at least Emacs 21) describes them as |
d293848d GM |
1237 | ;; existing "for compatibility with Emacs version 18". |
1238 | (define-obsolete-variable-alias 'last-input-char 'last-input-event | |
1239 | "at least 19.34") | |
1240 | (define-obsolete-variable-alias 'last-command-char 'last-command-event | |
1241 | "at least 19.34") | |
1242 | ||
9a5336ae JB |
1243 | \f |
1244 | ;;;; Alternate names for functions - these are not being phased out. | |
1245 | ||
a18ff988 JB |
1246 | (defalias 'send-string 'process-send-string) |
1247 | (defalias 'send-region 'process-send-region) | |
059184dd ER |
1248 | (defalias 'string= 'string-equal) |
1249 | (defalias 'string< 'string-lessp) | |
1250 | (defalias 'move-marker 'set-marker) | |
059184dd ER |
1251 | (defalias 'rplaca 'setcar) |
1252 | (defalias 'rplacd 'setcdr) | |
eb8c3be9 | 1253 | (defalias 'beep 'ding) ;preserve lingual purity |
059184dd ER |
1254 | (defalias 'indent-to-column 'indent-to) |
1255 | (defalias 'backward-delete-char 'delete-backward-char) | |
1256 | (defalias 'search-forward-regexp (symbol-function 're-search-forward)) | |
1257 | (defalias 'search-backward-regexp (symbol-function 're-search-backward)) | |
1258 | (defalias 'int-to-string 'number-to-string) | |
024ae2c6 | 1259 | (defalias 'store-match-data 'set-match-data) |
e6979067 | 1260 | (defalias 'chmod 'set-file-modes) |
53374291 | 1261 | (defalias 'mkdir 'make-directory) |
d6c22d46 | 1262 | ;; These are the XEmacs names: |
475fb2fb KH |
1263 | (defalias 'point-at-eol 'line-end-position) |
1264 | (defalias 'point-at-bol 'line-beginning-position) | |
37f6661a | 1265 | |
c4f484f2 RS |
1266 | (defalias 'user-original-login-name 'user-login-name) |
1267 | ||
be9b65ac | 1268 | \f |
9a5336ae | 1269 | ;;;; Hook manipulation functions. |
be9b65ac | 1270 | |
0e4d378b | 1271 | (defun add-hook (hook function &optional append local) |
32295976 RS |
1272 | "Add to the value of HOOK the function FUNCTION. |
1273 | FUNCTION is not added if already present. | |
1274 | FUNCTION is added (if necessary) at the beginning of the hook list | |
1275 | unless the optional argument APPEND is non-nil, in which case | |
1276 | FUNCTION is added at the end. | |
1277 | ||
0e4d378b | 1278 | The optional fourth argument, LOCAL, if non-nil, says to modify |
465c5fc8 LMI |
1279 | the hook's buffer-local value rather than its global value. |
1280 | This makes the hook buffer-local, and it makes t a member of the | |
1281 | buffer-local value. That acts as a flag to run the hook | |
1282 | functions of the global value as well as in the local value. | |
0e4d378b | 1283 | |
32295976 RS |
1284 | HOOK should be a symbol, and FUNCTION may be any valid function. If |
1285 | HOOK is void, it is first set to nil. If HOOK's value is a single | |
aa09b5ca | 1286 | function, it is changed to a list of functions." |
be9b65ac | 1287 | (or (boundp hook) (set hook nil)) |
0e4d378b | 1288 | (or (default-boundp hook) (set-default hook nil)) |
08b1f8a1 GM |
1289 | (if local (unless (local-variable-if-set-p hook) |
1290 | (set (make-local-variable hook) (list t))) | |
8947a5e2 SM |
1291 | ;; Detect the case where make-local-variable was used on a hook |
1292 | ;; and do what we used to do. | |
1293 | (unless (and (consp (symbol-value hook)) (memq t (symbol-value hook))) | |
1294 | (setq local t))) | |
1295 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
1296 | ;; If the hook value is a single function, turn it into a list. | |
1297 | (when (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
2248c40d | 1298 | (setq hook-value (list hook-value))) |
8947a5e2 SM |
1299 | ;; Do the actual addition if necessary |
1300 | (unless (member function hook-value) | |
ff917d63 DN |
1301 | (when (stringp function) |
1302 | (setq function (purecopy function))) | |
8947a5e2 SM |
1303 | (setq hook-value |
1304 | (if append | |
1305 | (append hook-value (list function)) | |
1306 | (cons function hook-value)))) | |
1307 | ;; Set the actual variable | |
35310461 RS |
1308 | (if local |
1309 | (progn | |
1310 | ;; If HOOK isn't a permanent local, | |
1311 | ;; but FUNCTION wants to survive a change of modes, | |
1312 | ;; mark HOOK as partially permanent. | |
1313 | (and (symbolp function) | |
1314 | (get function 'permanent-local-hook) | |
1315 | (not (get hook 'permanent-local)) | |
1316 | (put hook 'permanent-local 'permanent-local-hook)) | |
1317 | (set hook hook-value)) | |
1318 | (set-default hook hook-value)))) | |
0e4d378b RS |
1319 | |
1320 | (defun remove-hook (hook function &optional local) | |
24980d16 RS |
1321 | "Remove from the value of HOOK the function FUNCTION. |
1322 | HOOK should be a symbol, and FUNCTION may be any valid function. If | |
1323 | FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the | |
0e4d378b RS |
1324 | list of hooks to run in HOOK, then nothing is done. See `add-hook'. |
1325 | ||
1326 | The optional third argument, LOCAL, if non-nil, says to modify | |
6b61353c | 1327 | the hook's buffer-local value rather than its default value." |
8947a5e2 SM |
1328 | (or (boundp hook) (set hook nil)) |
1329 | (or (default-boundp hook) (set-default hook nil)) | |
6b61353c KH |
1330 | ;; Do nothing if LOCAL is t but this hook has no local binding. |
1331 | (unless (and local (not (local-variable-p hook))) | |
8947a5e2 SM |
1332 | ;; Detect the case where make-local-variable was used on a hook |
1333 | ;; and do what we used to do. | |
6b61353c KH |
1334 | (when (and (local-variable-p hook) |
1335 | (not (and (consp (symbol-value hook)) | |
1336 | (memq t (symbol-value hook))))) | |
1337 | (setq local t)) | |
1338 | (let ((hook-value (if local (symbol-value hook) (default-value hook)))) | |
1339 | ;; Remove the function, for both the list and the non-list cases. | |
1340 | (if (or (not (listp hook-value)) (eq (car hook-value) 'lambda)) | |
1341 | (if (equal hook-value function) (setq hook-value nil)) | |
1342 | (setq hook-value (delete function (copy-sequence hook-value)))) | |
1343 | ;; If the function is on the global hook, we need to shadow it locally | |
1344 | ;;(when (and local (member function (default-value hook)) | |
1345 | ;; (not (member (cons 'not function) hook-value))) | |
1346 | ;; (push (cons 'not function) hook-value)) | |
1347 | ;; Set the actual variable | |
1348 | (if (not local) | |
1349 | (set-default hook hook-value) | |
1350 | (if (equal hook-value '(t)) | |
1351 | (kill-local-variable hook) | |
1352 | (set hook hook-value)))))) | |
6e3af630 | 1353 | |
ba83908c SM |
1354 | (defmacro letrec (binders &rest body) |
1355 | "Bind variables according to BINDERS then eval BODY. | |
1356 | The value of the last form in BODY is returned. | |
1357 | Each element of BINDERS is a list (SYMBOL VALUEFORM) which binds | |
1358 | SYMBOL to the value of VALUEFORM. | |
1359 | All symbols are bound before the VALUEFORMs are evalled." | |
1360 | ;; Only useful in lexical-binding mode. | |
1361 | ;; As a special-form, we could implement it more efficiently (and cleanly, | |
1362 | ;; making the vars actually unbound during evaluation of the binders). | |
1363 | (declare (debug let) (indent 1)) | |
1364 | `(let ,(mapcar #'car binders) | |
1365 | ,@(mapcar (lambda (binder) `(setq ,@binder)) binders) | |
1366 | ,@body)) | |
1367 | ||
b1f6fa26 CY |
1368 | (defmacro with-wrapper-hook (hook args &rest body) |
1369 | "Run BODY, using wrapper functions from HOOK with additional ARGS. | |
1370 | HOOK is an abnormal hook. Each hook function in HOOK \"wraps\" | |
1371 | around the preceding ones, like a set of nested `around' advices. | |
1372 | ||
1373 | Each hook function should accept an argument list consisting of a | |
1374 | function FUN, followed by the additional arguments in ARGS. | |
1375 | ||
c7291ad9 GM |
1376 | The first hook function in HOOK is passed a FUN that, if it is called |
1377 | with arguments ARGS, performs BODY (i.e., the default operation). | |
1378 | The FUN passed to each successive hook function is defined based | |
1379 | on the preceding hook functions; if called with arguments ARGS, | |
1380 | it does what the `with-wrapper-hook' call would do if the | |
1381 | preceding hook functions were the only ones present in HOOK. | |
1382 | ||
1383 | Each hook function may call its FUN argument as many times as it wishes, | |
1384 | including never. In that case, such a hook function acts to replace | |
1385 | the default definition altogether, and any preceding hook functions. | |
1386 | Of course, a subsequent hook function may do the same thing. | |
1387 | ||
1388 | Each hook function definition is used to construct the FUN passed | |
b1f6fa26 CY |
1389 | to the next hook function, if any. The last (or \"outermost\") |
1390 | FUN is then called once." | |
01c157cc | 1391 | (declare (indent 2) (debug (form sexp body))) |
ba83908c SM |
1392 | ;; We need those two gensyms because CL's lexical scoping is not available |
1393 | ;; for function arguments :-( | |
1394 | (let ((funs (make-symbol "funs")) | |
1395 | (global (make-symbol "global")) | |
1396 | (argssym (make-symbol "args")) | |
1397 | (runrestofhook (make-symbol "runrestofhook"))) | |
1398 | ;; Since the hook is a wrapper, the loop has to be done via | |
1399 | ;; recursion: a given hook function will call its parameter in order to | |
1400 | ;; continue looping. | |
1401 | `(letrec ((,runrestofhook | |
1402 | (lambda (,funs ,global ,argssym) | |
1403 | ;; `funs' holds the functions left on the hook and `global' | |
1404 | ;; holds the functions left on the global part of the hook | |
1405 | ;; (in case the hook is local). | |
1406 | (if (consp ,funs) | |
1407 | (if (eq t (car ,funs)) | |
1408 | (funcall ,runrestofhook | |
1409 | (append ,global (cdr ,funs)) nil ,argssym) | |
1410 | (apply (car ,funs) | |
1411 | (apply-partially | |
1412 | (lambda (,funs ,global &rest ,argssym) | |
1413 | (funcall ,runrestofhook ,funs ,global ,argssym)) | |
1414 | (cdr ,funs) ,global) | |
1415 | ,argssym)) | |
1416 | ;; Once there are no more functions on the hook, run | |
1417 | ;; the original body. | |
1418 | (apply (lambda ,args ,@body) ,argssym))))) | |
b1f6fa26 | 1419 | (funcall ,runrestofhook ,hook |
ba83908c | 1420 | ;; The global part of the hook, if any. |
b1f6fa26 CY |
1421 | ,(if (symbolp hook) |
1422 | `(if (local-variable-p ',hook) | |
1423 | (default-value ',hook))) | |
ba83908c SM |
1424 | (list ,@args))))) |
1425 | ||
62e197b1 | 1426 | (defun add-to-list (list-var element &optional append compare-fn) |
4072ef25 | 1427 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
62e197b1 RS |
1428 | The test for presence of ELEMENT is done with `equal', |
1429 | or with COMPARE-FN if that's non-nil. | |
c8bfa689 MB |
1430 | If ELEMENT is added, it is added at the beginning of the list, |
1431 | unless the optional argument APPEND is non-nil, in which case | |
1432 | ELEMENT is added at the end. | |
508bcbca | 1433 | |
daebae3d PJ |
1434 | The return value is the new value of LIST-VAR. |
1435 | ||
8851c1f0 RS |
1436 | If you want to use `add-to-list' on a variable that is not defined |
1437 | until a certain package is loaded, you should put the call to `add-to-list' | |
1438 | into a hook function that will be run only after loading the package. | |
1439 | `eval-after-load' provides one way to do this. In some cases | |
1440 | other hooks, such as major mode hooks, can do the job." | |
fb1a5d8a | 1441 | (if (cond |
78bdfbf3 | 1442 | ((null compare-fn) |
62e197b1 | 1443 | (member element (symbol-value list-var))) |
fb1a5d8a KS |
1444 | ((eq compare-fn 'eq) |
1445 | (memq element (symbol-value list-var))) | |
1446 | ((eq compare-fn 'eql) | |
1447 | (memql element (symbol-value list-var))) | |
78bdfbf3 | 1448 | (t |
2d1dd54d DK |
1449 | (let ((lst (symbol-value list-var))) |
1450 | (while (and lst | |
1451 | (not (funcall compare-fn element (car lst)))) | |
1452 | (setq lst (cdr lst))) | |
1453 | lst))) | |
15171a06 | 1454 | (symbol-value list-var) |
c8bfa689 MB |
1455 | (set list-var |
1456 | (if append | |
1457 | (append (symbol-value list-var) (list element)) | |
1458 | (cons element (symbol-value list-var)))))) | |
448a0170 | 1459 | |
cbbd0b5a KS |
1460 | |
1461 | (defun add-to-ordered-list (list-var element &optional order) | |
4072ef25 | 1462 | "Add ELEMENT to the value of LIST-VAR if it isn't there yet. |
ef1eef06 | 1463 | The test for presence of ELEMENT is done with `eq'. |
cbbd0b5a KS |
1464 | |
1465 | The resulting list is reordered so that the elements are in the | |
ef1eef06 KS |
1466 | order given by each element's numeric list order. Elements |
1467 | without a numeric list order are placed at the end of the list. | |
cbbd0b5a | 1468 | |
4072ef25 LT |
1469 | If the third optional argument ORDER is a number (integer or |
1470 | float), set the element's list order to the given value. If | |
1471 | ORDER is nil or omitted, do not change the numeric order of | |
1472 | ELEMENT. If ORDER has any other value, remove the numeric order | |
1473 | of ELEMENT if it has one. | |
8da6c2f8 | 1474 | |
219fd6cf | 1475 | The list order for each element is stored in LIST-VAR's |
8da6c2f8 | 1476 | `list-order' property. |
cbbd0b5a KS |
1477 | |
1478 | The return value is the new value of LIST-VAR." | |
219fd6cf SM |
1479 | (let ((ordering (get list-var 'list-order))) |
1480 | (unless ordering | |
1481 | (put list-var 'list-order | |
1482 | (setq ordering (make-hash-table :weakness 'key :test 'eq)))) | |
8da6c2f8 | 1483 | (when order |
ef1eef06 KS |
1484 | (puthash element (and (numberp order) order) ordering)) |
1485 | (unless (memq element (symbol-value list-var)) | |
1486 | (set list-var (cons element (symbol-value list-var)))) | |
8da6c2f8 KS |
1487 | (set list-var (sort (symbol-value list-var) |
1488 | (lambda (a b) | |
219fd6cf SM |
1489 | (let ((oa (gethash a ordering)) |
1490 | (ob (gethash b ordering))) | |
ef1eef06 KS |
1491 | (if (and oa ob) |
1492 | (< oa ob) | |
1493 | oa))))))) | |
6b04bd6e | 1494 | |
d7494911 | 1495 | (defun add-to-history (history-var newelt &optional maxelt keep-all) |
6b04bd6e KS |
1496 | "Add NEWELT to the history list stored in the variable HISTORY-VAR. |
1497 | Return the new history list. | |
1498 | If MAXELT is non-nil, it specifies the maximum length of the history. | |
1499 | Otherwise, the maximum history length is the value of the `history-length' | |
1500 | property on symbol HISTORY-VAR, if set, or the value of the `history-length' | |
1501 | variable. | |
d7494911 KS |
1502 | Remove duplicates of NEWELT if `history-delete-duplicates' is non-nil. |
1503 | If optional fourth arg KEEP-ALL is non-nil, add NEWELT to history even | |
1504 | if it is empty or a duplicate." | |
6b04bd6e KS |
1505 | (unless maxelt |
1506 | (setq maxelt (or (get history-var 'history-length) | |
1507 | history-length))) | |
1508 | (let ((history (symbol-value history-var)) | |
1509 | tail) | |
d7494911 KS |
1510 | (when (and (listp history) |
1511 | (or keep-all | |
1512 | (not (stringp newelt)) | |
1513 | (> (length newelt) 0)) | |
1514 | (or keep-all | |
1515 | (not (equal (car history) newelt)))) | |
1516 | (if history-delete-duplicates | |
1517 | (delete newelt history)) | |
1518 | (setq history (cons newelt history)) | |
1519 | (when (integerp maxelt) | |
1520 | (if (= 0 maxelt) | |
1521 | (setq history nil) | |
1522 | (setq tail (nthcdr (1- maxelt) history)) | |
1523 | (when (consp tail) | |
1524 | (setcdr tail nil))))) | |
6b04bd6e KS |
1525 | (set history-var history))) |
1526 | ||
c4f484f2 RS |
1527 | \f |
1528 | ;;;; Mode hooks. | |
1529 | ||
1530 | (defvar delay-mode-hooks nil | |
1531 | "If non-nil, `run-mode-hooks' should delay running the hooks.") | |
1532 | (defvar delayed-mode-hooks nil | |
1533 | "List of delayed mode hooks waiting to be run.") | |
1534 | (make-variable-buffer-local 'delayed-mode-hooks) | |
1535 | (put 'delay-mode-hooks 'permanent-local t) | |
cbbd0b5a | 1536 | |
15de15c6 CY |
1537 | (defvar change-major-mode-after-body-hook nil |
1538 | "Normal hook run in major mode functions, before the mode hooks.") | |
1539 | ||
c4f484f2 RS |
1540 | (defvar after-change-major-mode-hook nil |
1541 | "Normal hook run at the very end of major mode functions.") | |
1542 | ||
1543 | (defun run-mode-hooks (&rest hooks) | |
1544 | "Run mode hooks `delayed-mode-hooks' and HOOKS, or delay HOOKS. | |
12f381b7 GM |
1545 | If the variable `delay-mode-hooks' is non-nil, does not run any hooks, |
1546 | just adds the HOOKS to the list `delayed-mode-hooks'. | |
1547 | Otherwise, runs hooks in the sequence: `change-major-mode-after-body-hook', | |
1548 | `delayed-mode-hooks' (in reverse order), HOOKS, and finally | |
1549 | `after-change-major-mode-hook'. Major mode functions should use | |
1550 | this instead of `run-hooks' when running their FOO-mode-hook." | |
c4f484f2 RS |
1551 | (if delay-mode-hooks |
1552 | ;; Delaying case. | |
1553 | (dolist (hook hooks) | |
1554 | (push hook delayed-mode-hooks)) | |
1555 | ;; Normal case, just run the hook as before plus any delayed hooks. | |
1556 | (setq hooks (nconc (nreverse delayed-mode-hooks) hooks)) | |
1557 | (setq delayed-mode-hooks nil) | |
15de15c6 | 1558 | (apply 'run-hooks (cons 'change-major-mode-after-body-hook hooks)) |
c4f484f2 RS |
1559 | (run-hooks 'after-change-major-mode-hook))) |
1560 | ||
1561 | (defmacro delay-mode-hooks (&rest body) | |
1562 | "Execute BODY, but delay any `run-mode-hooks'. | |
1563 | These hooks will be executed by the first following call to | |
1564 | `run-mode-hooks' that occurs outside any `delayed-mode-hooks' form. | |
1565 | Only affects hooks run in the current buffer." | |
1566 | (declare (debug t) (indent 0)) | |
1567 | `(progn | |
1568 | (make-local-variable 'delay-mode-hooks) | |
1569 | (let ((delay-mode-hooks t)) | |
1570 | ,@body))) | |
1571 | ||
1572 | ;; PUBLIC: find if the current mode derives from another. | |
1573 | ||
1574 | (defun derived-mode-p (&rest modes) | |
1575 | "Non-nil if the current major mode is derived from one of MODES. | |
1576 | Uses the `derived-mode-parent' property of the symbol to trace backwards." | |
1577 | (let ((parent major-mode)) | |
1578 | (while (and (not (memq parent modes)) | |
1579 | (setq parent (get parent 'derived-mode-parent)))) | |
1580 | parent)) | |
1581 | \f | |
1582 | ;;;; Minor modes. | |
1583 | ||
1584 | ;; If a minor mode is not defined with define-minor-mode, | |
1585 | ;; add it here explicitly. | |
1586 | ;; isearch-mode is deliberately excluded, since you should | |
1587 | ;; not call it yourself. | |
1588 | (defvar minor-mode-list '(auto-save-mode auto-fill-mode abbrev-mode | |
1589 | overwrite-mode view-mode | |
1590 | hs-minor-mode) | |
1591 | "List of all minor mode functions.") | |
1592 | ||
1593 | (defun add-minor-mode (toggle name &optional keymap after toggle-fun) | |
1594 | "Register a new minor mode. | |
1595 | ||
1596 | This is an XEmacs-compatibility function. Use `define-minor-mode' instead. | |
1597 | ||
1598 | TOGGLE is a symbol which is the name of a buffer-local variable that | |
1599 | is toggled on or off to say whether the minor mode is active or not. | |
1600 | ||
1601 | NAME specifies what will appear in the mode line when the minor mode | |
1602 | is active. NAME should be either a string starting with a space, or a | |
1603 | symbol whose value is such a string. | |
1604 | ||
1605 | Optional KEYMAP is the keymap for the minor mode that will be added | |
1606 | to `minor-mode-map-alist'. | |
1607 | ||
1608 | Optional AFTER specifies that TOGGLE should be added after AFTER | |
1609 | in `minor-mode-alist'. | |
1610 | ||
1611 | Optional TOGGLE-FUN is an interactive function to toggle the mode. | |
1612 | It defaults to (and should by convention be) TOGGLE. | |
1613 | ||
1614 | If TOGGLE has a non-nil `:included' property, an entry for the mode is | |
1615 | included in the mode-line minor mode menu. | |
1616 | If TOGGLE has a `:menu-tag', that is used for the menu item's label." | |
1617 | (unless (memq toggle minor-mode-list) | |
1618 | (push toggle minor-mode-list)) | |
1619 | ||
1620 | (unless toggle-fun (setq toggle-fun toggle)) | |
1621 | (unless (eq toggle-fun toggle) | |
1622 | (put toggle :minor-mode-function toggle-fun)) | |
1623 | ;; Add the name to the minor-mode-alist. | |
1624 | (when name | |
1625 | (let ((existing (assq toggle minor-mode-alist))) | |
1626 | (if existing | |
1627 | (setcdr existing (list name)) | |
1628 | (let ((tail minor-mode-alist) found) | |
1629 | (while (and tail (not found)) | |
1630 | (if (eq after (caar tail)) | |
1631 | (setq found tail) | |
1632 | (setq tail (cdr tail)))) | |
1633 | (if found | |
1634 | (let ((rest (cdr found))) | |
1635 | (setcdr found nil) | |
1636 | (nconc found (list (list toggle name)) rest)) | |
365f8d85 | 1637 | (push (list toggle name) minor-mode-alist)))))) |
c4f484f2 RS |
1638 | ;; Add the toggle to the minor-modes menu if requested. |
1639 | (when (get toggle :included) | |
1640 | (define-key mode-line-mode-menu | |
1641 | (vector toggle) | |
1642 | (list 'menu-item | |
1643 | (concat | |
1644 | (or (get toggle :menu-tag) | |
1645 | (if (stringp name) name (symbol-name toggle))) | |
1646 | (let ((mode-name (if (symbolp name) (symbol-value name)))) | |
1647 | (if (and (stringp mode-name) (string-match "[^ ]+" mode-name)) | |
1648 | (concat " (" (match-string 0 mode-name) ")")))) | |
1649 | toggle-fun | |
1650 | :button (cons :toggle toggle)))) | |
cbbd0b5a | 1651 | |
c4f484f2 RS |
1652 | ;; Add the map to the minor-mode-map-alist. |
1653 | (when keymap | |
1654 | (let ((existing (assq toggle minor-mode-map-alist))) | |
1655 | (if existing | |
1656 | (setcdr existing keymap) | |
1657 | (let ((tail minor-mode-map-alist) found) | |
1658 | (while (and tail (not found)) | |
1659 | (if (eq after (caar tail)) | |
1660 | (setq found tail) | |
1661 | (setq tail (cdr tail)))) | |
1662 | (if found | |
1663 | (let ((rest (cdr found))) | |
1664 | (setcdr found nil) | |
1665 | (nconc found (list (cons toggle keymap)) rest)) | |
365f8d85 | 1666 | (push (cons toggle keymap) minor-mode-map-alist))))))) |
448a0170 MB |
1667 | \f |
1668 | ;;; Load history | |
1669 | ||
9e247d24 | 1670 | (defun symbol-file (symbol &optional type) |
37fda77e MR |
1671 | "Return the name of the file that defined SYMBOL. |
1672 | The value is normally an absolute file name. It can also be nil, | |
1673 | if the definition is not associated with any file. If SYMBOL | |
1674 | specifies an autoloaded function, the value can be a relative | |
1675 | file name without extension. | |
1676 | ||
1677 | If TYPE is nil, then any kind of definition is acceptable. If | |
1678 | TYPE is `defun', `defvar', or `defface', that specifies function | |
1679 | definition, variable definition, or face definition only." | |
9e247d24 RS |
1680 | (if (and (or (null type) (eq type 'defun)) |
1681 | (symbolp symbol) (fboundp symbol) | |
1682 | (eq 'autoload (car-safe (symbol-function symbol)))) | |
1683 | (nth 1 (symbol-function symbol)) | |
e9f13a95 | 1684 | (let ((files load-history) |
cb21744e | 1685 | file) |
e9f13a95 | 1686 | (while files |
9e247d24 RS |
1687 | (if (if type |
1688 | (if (eq type 'defvar) | |
1689 | ;; Variables are present just as their names. | |
1690 | (member symbol (cdr (car files))) | |
1691 | ;; Other types are represented as (TYPE . NAME). | |
1692 | (member (cons type symbol) (cdr (car files)))) | |
1693 | ;; We accept all types, so look for variable def | |
1694 | ;; and then for any other kind. | |
1695 | (or (member symbol (cdr (car files))) | |
1696 | (rassq symbol (cdr (car files))))) | |
e9f13a95 SM |
1697 | (setq file (car (car files)) files nil)) |
1698 | (setq files (cdr files))) | |
1699 | file))) | |
448a0170 | 1700 | |
059a552c RF |
1701 | (defun locate-library (library &optional nosuffix path interactive-call) |
1702 | "Show the precise file name of Emacs library LIBRARY. | |
c9ae6ddd EZ |
1703 | LIBRARY should be a relative file name of the library, a string. |
1704 | It can omit the suffix (a.k.a. file-name extension) if NOSUFFIX is | |
1705 | nil (which is the default, see below). | |
059a552c RF |
1706 | This command searches the directories in `load-path' like `\\[load-library]' |
1707 | to find the file that `\\[load-library] RET LIBRARY RET' would load. | |
1708 | Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes' | |
1709 | to the specified name LIBRARY. | |
1710 | ||
1711 | If the optional third arg PATH is specified, that list of directories | |
1712 | is used instead of `load-path'. | |
1713 | ||
3ac9d254 | 1714 | When called from a program, the file name is normally returned as a |
059a552c RF |
1715 | string. When run interactively, the argument INTERACTIVE-CALL is t, |
1716 | and the file name is displayed in the echo area." | |
1717 | (interactive (list (completing-read "Locate library: " | |
6a021917 SM |
1718 | (apply-partially |
1719 | 'locate-file-completion-table | |
1720 | load-path (get-load-suffixes))) | |
059a552c RF |
1721 | nil nil |
1722 | t)) | |
1723 | (let ((file (locate-file library | |
1724 | (or path load-path) | |
667b73dc LT |
1725 | (append (unless nosuffix (get-load-suffixes)) |
1726 | load-file-rep-suffixes)))) | |
059a552c RF |
1727 | (if interactive-call |
1728 | (if file | |
1729 | (message "Library is file %s" (abbreviate-file-name file)) | |
1730 | (message "No library %s in search path" library))) | |
1731 | file)) | |
1732 | ||
be9b65ac | 1733 | \f |
adbe2d11 RS |
1734 | ;;;; Specifying things to do later. |
1735 | ||
33d74677 | 1736 | (defun load-history-regexp (file) |
0988217a RS |
1737 | "Form a regexp to find FILE in `load-history'. |
1738 | FILE, a string, is described in the function `eval-after-load'." | |
33d74677 AM |
1739 | (if (file-name-absolute-p file) |
1740 | (setq file (file-truename file))) | |
0988217a | 1741 | (concat (if (file-name-absolute-p file) "\\`" "\\(\\`\\|/\\)") |
33d74677 AM |
1742 | (regexp-quote file) |
1743 | (if (file-name-extension file) | |
1744 | "" | |
1745 | ;; Note: regexp-opt can't be used here, since we need to call | |
1746 | ;; this before Emacs has been fully started. 2006-05-21 | |
1747 | (concat "\\(" (mapconcat 'regexp-quote load-suffixes "\\|") "\\)?")) | |
1748 | "\\(" (mapconcat 'regexp-quote jka-compr-load-suffixes "\\|") | |
1749 | "\\)?\\'")) | |
1750 | ||
1751 | (defun load-history-filename-element (file-regexp) | |
0988217a | 1752 | "Get the first elt of `load-history' whose car matches FILE-REGEXP. |
33d74677 AM |
1753 | Return nil if there isn't one." |
1754 | (let* ((loads load-history) | |
1755 | (load-elt (and loads (car loads)))) | |
1756 | (save-match-data | |
1757 | (while (and loads | |
1758 | (or (null (car load-elt)) | |
1759 | (not (string-match file-regexp (car load-elt))))) | |
1760 | (setq loads (cdr loads) | |
1761 | load-elt (and loads (car loads))))) | |
1762 | load-elt)) | |
1763 | ||
f291fe60 | 1764 | (put 'eval-after-load 'lisp-indent-function 1) |
9a5336ae | 1765 | (defun eval-after-load (file form) |
0b1c89c1 | 1766 | "Arrange that if FILE is loaded, FORM will be run immediately afterwards. |
90914938 | 1767 | If FILE is already loaded, evaluate FORM right now. |
33d74677 AM |
1768 | |
1769 | If a matching file is loaded again, FORM will be evaluated again. | |
1770 | ||
1771 | If FILE is a string, it may be either an absolute or a relative file | |
1772 | name, and may have an extension \(e.g. \".el\") or may lack one, and | |
1773 | additionally may or may not have an extension denoting a compressed | |
1774 | format \(e.g. \".gz\"). | |
1775 | ||
0988217a RS |
1776 | When FILE is absolute, this first converts it to a true name by chasing |
1777 | symbolic links. Only a file of this name \(see next paragraph regarding | |
33d74677 AM |
1778 | extensions) will trigger the evaluation of FORM. When FILE is relative, |
1779 | a file whose absolute true name ends in FILE will trigger evaluation. | |
1780 | ||
1781 | When FILE lacks an extension, a file name with any extension will trigger | |
1782 | evaluation. Otherwise, its extension must match FILE's. A further | |
1783 | extension for a compressed format \(e.g. \".gz\") on FILE will not affect | |
1784 | this name matching. | |
1785 | ||
1786 | Alternatively, FILE can be a feature (i.e. a symbol), in which case FORM | |
3fa173b4 | 1787 | is evaluated at the end of any file that `provide's this feature. |
0835f01e GM |
1788 | If the feature is provided when evaluating code not associated with a |
1789 | file, FORM is evaluated immediately after the provide statement. | |
33d74677 AM |
1790 | |
1791 | Usually FILE is just a library name like \"font-lock\" or a feature name | |
1792 | like 'font-lock. | |
1793 | ||
1794 | This function makes or adds to an entry on `after-load-alist'." | |
1795 | ;; Add this FORM into after-load-alist (regardless of whether we'll be | |
1796 | ;; evaluating it now). | |
1797 | (let* ((regexp-or-feature | |
3fa173b4 SM |
1798 | (if (stringp file) |
1799 | (setq file (purecopy (load-history-regexp file))) | |
1800 | file)) | |
33d74677 AM |
1801 | (elt (assoc regexp-or-feature after-load-alist))) |
1802 | (unless elt | |
1803 | (setq elt (list regexp-or-feature)) | |
1804 | (push elt after-load-alist)) | |
2ec42da9 SM |
1805 | ;; Make sure `form' is evalled in the current lexical/dynamic code. |
1806 | (setq form `(funcall ',(eval `(lambda () ,form) lexical-binding))) | |
33d74677 AM |
1807 | ;; Is there an already loaded file whose name (or `provide' name) |
1808 | ;; matches FILE? | |
68cbc58b GM |
1809 | (prog1 (if (if (stringp file) |
1810 | (load-history-filename-element regexp-or-feature) | |
1811 | (featurep file)) | |
1812 | (eval form)) | |
1813 | (when (symbolp regexp-or-feature) | |
1814 | ;; For features, the after-load-alist elements get run when `provide' is | |
1815 | ;; called rather than at the end of the file. So add an indirection to | |
1816 | ;; make sure that `form' is really run "after-load" in case the provide | |
1817 | ;; call happens early. | |
1818 | (setq form | |
0835f01e GM |
1819 | `(if load-file-name |
1820 | (let ((fun (make-symbol "eval-after-load-helper"))) | |
1821 | (fset fun `(lambda (file) | |
1822 | (if (not (equal file ',load-file-name)) | |
1823 | nil | |
1824 | (remove-hook 'after-load-functions ',fun) | |
1825 | ,',form))) | |
1826 | (add-hook 'after-load-functions fun)) | |
1827 | ;; Not being provided from a file, run form right now. | |
1828 | ,form))) | |
68cbc58b GM |
1829 | ;; Add FORM to the element unless it's already there. |
1830 | (unless (member form (cdr elt)) | |
1831 | (nconc elt (purecopy (list form))))))) | |
33d74677 | 1832 | |
838ff458 SM |
1833 | (defvar after-load-functions nil |
1834 | "Special hook run after loading a file. | |
1835 | Each function there is called with a single argument, the absolute | |
1836 | name of the file just loaded.") | |
1837 | ||
33d74677 AM |
1838 | (defun do-after-load-evaluation (abs-file) |
1839 | "Evaluate all `eval-after-load' forms, if any, for ABS-FILE. | |
5766c380 SM |
1840 | ABS-FILE, a string, should be the absolute true name of a file just loaded. |
1841 | This function is called directly from the C code." | |
1842 | ;; Run the relevant eval-after-load forms. | |
060c08b5 JB |
1843 | (mapc #'(lambda (a-l-element) |
1844 | (when (and (stringp (car a-l-element)) | |
1845 | (string-match-p (car a-l-element) abs-file)) | |
1846 | ;; discard the file name regexp | |
1847 | (mapc #'eval (cdr a-l-element)))) | |
5766c380 SM |
1848 | after-load-alist) |
1849 | ;; Complain when the user uses obsolete files. | |
838ff458 | 1850 | (when (string-match-p "/obsolete/[^/]*\\'" abs-file) |
5766c380 SM |
1851 | (run-with-timer 0 nil |
1852 | (lambda (file) | |
1853 | (message "Package %s is obsolete!" | |
1854 | (substring file 0 | |
1855 | (string-match "\\.elc?\\>" file)))) | |
838ff458 SM |
1856 | (file-name-nondirectory abs-file))) |
1857 | ;; Finally, run any other hook. | |
1858 | (run-hook-with-args 'after-load-functions abs-file)) | |
9a5336ae JB |
1859 | |
1860 | (defun eval-next-after-load (file) | |
1861 | "Read the following input sexp, and run it whenever FILE is loaded. | |
1862 | This makes or adds to an entry on `after-load-alist'. | |
1863 | FILE should be the name of a library, with no directory name." | |
1864 | (eval-after-load file (read))) | |
354f0faf | 1865 | (make-obsolete 'eval-next-after-load `eval-after-load "23.2") |
638f053a JB |
1866 | |
1867 | (defun display-delayed-warnings () | |
1868 | "Display delayed warnings from `delayed-warnings-list'. | |
2724d9c7 JB |
1869 | Used from `delayed-warnings-hook' (which see)." |
1870 | (dolist (warning (nreverse delayed-warnings-list)) | |
1871 | (apply 'display-warning warning)) | |
1872 | (setq delayed-warnings-list nil)) | |
1873 | ||
1874 | (defun collapse-delayed-warnings () | |
1875 | "Remove duplicates from `delayed-warnings-list'. | |
1876 | Collapse identical adjacent warnings into one (plus count). | |
1877 | Used from `delayed-warnings-hook' (which see)." | |
d1a5c3b4 | 1878 | (let ((count 1) |
2724d9c7 JB |
1879 | collapsed warning) |
1880 | (while delayed-warnings-list | |
1881 | (setq warning (pop delayed-warnings-list)) | |
1882 | (if (equal warning (car delayed-warnings-list)) | |
d1a5c3b4 JB |
1883 | (setq count (1+ count)) |
1884 | (when (> count 1) | |
1885 | (setcdr warning (cons (format "%s [%d times]" (cadr warning) count) | |
1886 | (cddr warning))) | |
1887 | (setq count 1)) | |
2724d9c7 JB |
1888 | (push warning collapsed))) |
1889 | (setq delayed-warnings-list (nreverse collapsed)))) | |
638f053a | 1890 | |
8eae3a58 | 1891 | ;; At present this is only used for Emacs internals. |
001bf877 | 1892 | ;; Ref http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00085.html |
2724d9c7 JB |
1893 | (defvar delayed-warnings-hook '(collapse-delayed-warnings |
1894 | display-delayed-warnings) | |
3d439cd1 CY |
1895 | "Normal hook run to process and display delayed warnings. |
1896 | By default, this hook contains functions to consolidate the | |
1897 | warnings listed in `delayed-warnings-list', display them, and set | |
1898 | `delayed-warnings-list' back to nil.") | |
638f053a | 1899 | |
7aaacaff | 1900 | \f |
c4f484f2 RS |
1901 | ;;;; Process stuff. |
1902 | ||
d43c8d03 GM |
1903 | (defun process-lines (program &rest args) |
1904 | "Execute PROGRAM with ARGS, returning its output as a list of lines. | |
1905 | Signal an error if the program returns with a non-zero exit status." | |
1906 | (with-temp-buffer | |
1907 | (let ((status (apply 'call-process program nil (current-buffer) nil args))) | |
1908 | (unless (eq status 0) | |
1909 | (error "%s exited with status %s" program status)) | |
1910 | (goto-char (point-min)) | |
1911 | (let (lines) | |
1912 | (while (not (eobp)) | |
1913 | (setq lines (cons (buffer-substring-no-properties | |
1914 | (line-beginning-position) | |
1915 | (line-end-position)) | |
1916 | lines)) | |
1917 | (forward-line 1)) | |
1918 | (nreverse lines))))) | |
1919 | ||
b96e6cde | 1920 | (defun process-live-p (process) |
bcd54f83 LMI |
1921 | "Returns non-nil if PROCESS is alive. |
1922 | A process is considered alive if its status is `run', `open', | |
1923 | `listen', `connect' or `stop'." | |
1924 | (memq (process-status process) | |
1925 | '(run open listen connect stop))) | |
1926 | ||
7aaacaff RS |
1927 | ;; compatibility |
1928 | ||
c8227332 VJL |
1929 | (make-obsolete |
1930 | 'process-kill-without-query | |
1931 | "use `process-query-on-exit-flag' or `set-process-query-on-exit-flag'." | |
1932 | "22.1") | |
06b60517 | 1933 | (defun process-kill-without-query (process &optional _flag) |
7aaacaff RS |
1934 | "Say no query needed if PROCESS is running when Emacs is exited. |
1935 | Optional second argument if non-nil says to require a query. | |
a478f3e1 | 1936 | Value is t if a query was formerly required." |
7aaacaff RS |
1937 | (let ((old (process-query-on-exit-flag process))) |
1938 | (set-process-query-on-exit-flag process nil) | |
1939 | old)) | |
9a5336ae | 1940 | |
d842b103 JL |
1941 | (defun process-kill-buffer-query-function () |
1942 | "Ask before killing a buffer that has a running process." | |
1943 | (let ((process (get-buffer-process (current-buffer)))) | |
1944 | (or (not process) | |
1945 | (not (memq (process-status process) '(run stop open listen))) | |
1946 | (not (process-query-on-exit-flag process)) | |
da9fcb93 LMI |
1947 | (yes-or-no-p |
1948 | (format "Buffer %S has a running process; kill it? " | |
1949 | (buffer-name (current-buffer))))))) | |
d842b103 JL |
1950 | |
1951 | (add-hook 'kill-buffer-query-functions 'process-kill-buffer-query-function) | |
1952 | ||
34368d12 KS |
1953 | ;; process plist management |
1954 | ||
1955 | (defun process-get (process propname) | |
1956 | "Return the value of PROCESS' PROPNAME property. | |
1957 | This is the last value stored with `(process-put PROCESS PROPNAME VALUE)'." | |
1958 | (plist-get (process-plist process) propname)) | |
1959 | ||
1960 | (defun process-put (process propname value) | |
1961 | "Change PROCESS' PROPNAME property to VALUE. | |
1962 | It can be retrieved with `(process-get PROCESS PROPNAME)'." | |
f1180544 | 1963 | (set-process-plist process |
34368d12 KS |
1964 | (plist-put (process-plist process) propname value))) |
1965 | ||
9a5336ae JB |
1966 | \f |
1967 | ;;;; Input and display facilities. | |
1968 | ||
77a5664f | 1969 | (defvar read-quoted-char-radix 8 |
1ba764de | 1970 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
77a5664f RS |
1971 | Legitimate radix values are 8, 10 and 16.") |
1972 | ||
1973 | (custom-declare-variable-early | |
264ef586 | 1974 | 'read-quoted-char-radix 8 |
77a5664f | 1975 | "*Radix for \\[quoted-insert] and other uses of `read-quoted-char'. |
1ba764de | 1976 | Legitimate radix values are 8, 10 and 16." |
c8227332 VJL |
1977 | :type '(choice (const 8) (const 10) (const 16)) |
1978 | :group 'editing-basics) | |
1ba764de | 1979 | |
03a74b84 SM |
1980 | (defconst read-key-empty-map (make-sparse-keymap)) |
1981 | ||
79bd5ba1 | 1982 | (defvar read-key-delay 0.01) ;Fast enough for 100Hz repeat rate, hopefully. |
03a74b84 SM |
1983 | |
1984 | (defun read-key (&optional prompt) | |
1985 | "Read a key from the keyboard. | |
1986 | Contrary to `read-event' this will not return a raw event but instead will | |
1987 | obey the input decoding and translations usually done by `read-key-sequence'. | |
1988 | So escape sequences and keyboard encoding are taken into account. | |
1989 | When there's an ambiguity because the key looks like the prefix of | |
1990 | some sort of escape sequence, the ambiguity is resolved via `read-key-delay'." | |
1991 | (let ((overriding-terminal-local-map read-key-empty-map) | |
1992 | (overriding-local-map nil) | |
3ff78624 | 1993 | (echo-keystrokes 0) |
03a74b84 SM |
1994 | (old-global-map (current-global-map)) |
1995 | (timer (run-with-idle-timer | |
1996 | ;; Wait long enough that Emacs has the time to receive and | |
1997 | ;; process all the raw events associated with the single-key. | |
1998 | ;; But don't wait too long, or the user may find the delay | |
1999 | ;; annoying (or keep hitting more keys which may then get | |
2000 | ;; lost or misinterpreted). | |
2001 | ;; This is only relevant for keys which Emacs perceives as | |
2002 | ;; "prefixes", such as C-x (because of the C-x 8 map in | |
2003 | ;; key-translate-table and the C-x @ map in function-key-map) | |
2004 | ;; or ESC (because of terminal escape sequences in | |
2005 | ;; input-decode-map). | |
2006 | read-key-delay t | |
2007 | (lambda () | |
2008 | (let ((keys (this-command-keys-vector))) | |
2009 | (unless (zerop (length keys)) | |
2010 | ;; `keys' is non-empty, so the user has hit at least | |
2011 | ;; one key; there's no point waiting any longer, even | |
2012 | ;; though read-key-sequence thinks we should wait | |
2013 | ;; for more input to decide how to interpret the | |
2014 | ;; current input. | |
2015 | (throw 'read-key keys))))))) | |
2016 | (unwind-protect | |
2017 | (progn | |
186e86db SM |
2018 | (use-global-map |
2019 | (let ((map (make-sparse-keymap))) | |
2020 | ;; Don't hide the menu-bar and tool-bar entries. | |
2021 | (define-key map [menu-bar] (lookup-key global-map [menu-bar])) | |
2022 | (define-key map [tool-bar] (lookup-key global-map [tool-bar])) | |
2023 | map)) | |
79bd5ba1 | 2024 | (aref (catch 'read-key (read-key-sequence-vector prompt nil t)) 0)) |
03a74b84 SM |
2025 | (cancel-timer timer) |
2026 | (use-global-map old-global-map)))) | |
2027 | ||
9a5336ae | 2028 | (defun read-quoted-char (&optional prompt) |
2444730b RS |
2029 | "Like `read-char', but do not allow quitting. |
2030 | Also, if the first character read is an octal digit, | |
2031 | we read any number of octal digits and return the | |
569b03f2 | 2032 | specified character code. Any nondigit terminates the sequence. |
1ba764de | 2033 | If the terminator is RET, it is discarded; |
2444730b RS |
2034 | any other terminator is used itself as input. |
2035 | ||
569b03f2 RS |
2036 | The optional argument PROMPT specifies a string to use to prompt the user. |
2037 | The variable `read-quoted-char-radix' controls which radix to use | |
2038 | for numeric input." | |
c83256a0 | 2039 | (let ((message-log-max nil) done (first t) (code 0) char translated) |
2444730b RS |
2040 | (while (not done) |
2041 | (let ((inhibit-quit first) | |
42e636f0 KH |
2042 | ;; Don't let C-h get the help message--only help function keys. |
2043 | (help-char nil) | |
2044 | (help-form | |
2045 | "Type the special character you want to use, | |
2444730b | 2046 | or the octal character code. |
1ba764de | 2047 | RET terminates the character code and is discarded; |
2444730b | 2048 | any other non-digit terminates the character code and is then used as input.")) |
3f0161d0 | 2049 | (setq char (read-event (and prompt (format "%s-" prompt)) t)) |
9a5336ae | 2050 | (if inhibit-quit (setq quit-flag nil))) |
3f0161d0 SM |
2051 | ;; Translate TAB key into control-I ASCII character, and so on. |
2052 | ;; Note: `read-char' does it using the `ascii-character' property. | |
278847cd SM |
2053 | ;; We should try and use read-key instead. |
2054 | (let ((translation (lookup-key local-function-key-map (vector char)))) | |
b8add347 SM |
2055 | (setq translated (if (arrayp translation) |
2056 | (aref translation 0) | |
2057 | char))) | |
2058 | (if (integerp translated) | |
2059 | (setq translated (char-resolve-modifiers translated))) | |
c83256a0 RS |
2060 | (cond ((null translated)) |
2061 | ((not (integerp translated)) | |
2062 | (setq unread-command-events (list char) | |
1ba764de | 2063 | done t)) |
c83256a0 | 2064 | ((/= (logand translated ?\M-\^@) 0) |
bf896a1b | 2065 | ;; Turn a meta-character into a character with the 0200 bit set. |
c83256a0 | 2066 | (setq code (logior (logand translated (lognot ?\M-\^@)) 128) |
bf896a1b | 2067 | done t)) |
4fcc3d32 SM |
2068 | ((and (<= ?0 translated) |
2069 | (< translated (+ ?0 (min 10 read-quoted-char-radix)))) | |
c83256a0 RS |
2070 | (setq code (+ (* code read-quoted-char-radix) (- translated ?0))) |
2071 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
2072 | ((and (<= ?a (downcase translated)) | |
4fcc3d32 SM |
2073 | (< (downcase translated) |
2074 | (+ ?a -10 (min 36 read-quoted-char-radix)))) | |
92304bc8 | 2075 | (setq code (+ (* code read-quoted-char-radix) |
c83256a0 RS |
2076 | (+ 10 (- (downcase translated) ?a)))) |
2077 | (and prompt (setq prompt (message "%s %c" prompt translated)))) | |
2078 | ((and (not first) (eq translated ?\C-m)) | |
2444730b RS |
2079 | (setq done t)) |
2080 | ((not first) | |
c83256a0 | 2081 | (setq unread-command-events (list char) |
2444730b | 2082 | done t)) |
c83256a0 | 2083 | (t (setq code translated |
2444730b RS |
2084 | done t))) |
2085 | (setq first nil)) | |
bf896a1b | 2086 | code)) |
9a5336ae | 2087 | |
266725f1 SJ |
2088 | (defun read-passwd (prompt &optional confirm default) |
2089 | "Read a password, prompting with PROMPT, and return it. | |
2090 | If optional CONFIRM is non-nil, read the password twice to make sure. | |
2091 | Optional DEFAULT is a default password to use instead of empty input. | |
2092 | ||
2093 | This function echoes `.' for each character that the user types. | |
08640de5 CY |
2094 | |
2095 | The user ends with RET, LFD, or ESC. DEL or C-h rubs out. | |
2096 | C-y yanks the current kill. C-u kills line. | |
266725f1 | 2097 | C-g quits; if `inhibit-quit' was non-nil around this function, |
3fa173b4 | 2098 | then it returns nil if the user types C-g, but `quit-flag' remains set. |
266725f1 SJ |
2099 | |
2100 | Once the caller uses the password, it can erase the password | |
2101 | by doing (clear-string STRING)." | |
2102 | (with-local-quit | |
2103 | (if confirm | |
2104 | (let (success) | |
2105 | (while (not success) | |
2106 | (let ((first (read-passwd prompt nil default)) | |
2107 | (second (read-passwd "Confirm password: " nil default))) | |
2108 | (if (equal first second) | |
2109 | (progn | |
2110 | (and (arrayp second) (clear-string second)) | |
2111 | (setq success first)) | |
2112 | (and (arrayp first) (clear-string first)) | |
2113 | (and (arrayp second) (clear-string second)) | |
2114 | (message "Password not repeated accurately; please start over") | |
2115 | (sit-for 1)))) | |
2116 | success) | |
2117 | (let ((pass nil) | |
870560eb RS |
2118 | ;; Copy it so that add-text-properties won't modify |
2119 | ;; the object that was passed in by the caller. | |
2120 | (prompt (copy-sequence prompt)) | |
266725f1 SJ |
2121 | (c 0) |
2122 | (echo-keystrokes 0) | |
7c447c3f | 2123 | (cursor-in-echo-area t) |
d4a263ba CY |
2124 | (message-log-max nil) |
2125 | (stop-keys (list 'return ?\r ?\n ?\e)) | |
2126 | (rubout-keys (list 'backspace ?\b ?\177))) | |
a4b1de6e EZ |
2127 | (add-text-properties 0 (length prompt) |
2128 | minibuffer-prompt-properties prompt) | |
266725f1 SJ |
2129 | (while (progn (message "%s%s" |
2130 | prompt | |
2131 | (make-string (length pass) ?.)) | |
4fd15622 | 2132 | (setq c (read-key)) |
d4a263ba | 2133 | (not (memq c stop-keys))) |
266725f1 | 2134 | (clear-this-command-keys) |
d4a263ba CY |
2135 | (cond ((memq c rubout-keys) ; rubout |
2136 | (when (> (length pass) 0) | |
2137 | (let ((new-pass (substring pass 0 -1))) | |
2138 | (and (arrayp pass) (clear-string pass)) | |
2139 | (setq pass new-pass)))) | |
4fd15622 | 2140 | ((eq c ?\C-g) (keyboard-quit)) |
d4a263ba CY |
2141 | ((not (numberp c))) |
2142 | ((= c ?\C-u) ; kill line | |
08640de5 CY |
2143 | (and (arrayp pass) (clear-string pass)) |
2144 | (setq pass "")) | |
2145 | ((= c ?\C-y) ; yank | |
2146 | (let* ((str (condition-case nil | |
2147 | (current-kill 0) | |
2148 | (error nil))) | |
2149 | new-pass) | |
2150 | (when str | |
2151 | (setq new-pass | |
2152 | (concat pass | |
2153 | (substring-no-properties str))) | |
2154 | (and (arrayp pass) (clear-string pass)) | |
2155 | (setq c ?\0) | |
2156 | (setq pass new-pass)))) | |
d4a263ba | 2157 | ((characterp c) ; insert char |
08640de5 CY |
2158 | (let* ((new-char (char-to-string c)) |
2159 | (new-pass (concat pass new-char))) | |
2160 | (and (arrayp pass) (clear-string pass)) | |
2161 | (clear-string new-char) | |
2162 | (setq c ?\0) | |
08640de5 | 2163 | (setq pass new-pass))))) |
266725f1 SJ |
2164 | (message nil) |
2165 | (or pass default ""))))) | |
2166 | ||
6b61353c KH |
2167 | ;; This should be used by `call-interactively' for `n' specs. |
2168 | (defun read-number (prompt &optional default) | |
3238cde3 RS |
2169 | "Read a numeric value in the minibuffer, prompting with PROMPT. |
2170 | DEFAULT specifies a default value to return if the user just types RET. | |
2171 | The value of DEFAULT is inserted into PROMPT." | |
6b61353c KH |
2172 | (let ((n nil)) |
2173 | (when default | |
2174 | (setq prompt | |
2d14d61e MB |
2175 | (if (string-match "\\(\\):[ \t]*\\'" prompt) |
2176 | (replace-match (format " (default %s)" default) t t prompt 1) | |
2177 | (replace-regexp-in-string "[ \t]*\\'" | |
2178 | (format " (default %s) " default) | |
f8cf33b1 | 2179 | prompt t t)))) |
6b61353c KH |
2180 | (while |
2181 | (progn | |
2182 | (let ((str (read-from-minibuffer prompt nil nil nil nil | |
c7863346 SM |
2183 | (and default |
2184 | (number-to-string default))))) | |
219f06f7 RS |
2185 | (condition-case nil |
2186 | (setq n (cond | |
2187 | ((zerop (length str)) default) | |
2188 | ((stringp str) (read str)))) | |
2189 | (error nil))) | |
6b61353c KH |
2190 | (unless (numberp n) |
2191 | (message "Please enter a number.") | |
2192 | (sit-for 1) | |
2193 | t))) | |
2194 | n)) | |
0369eb85 | 2195 | |
3ef01959 CY |
2196 | (defun read-char-choice (prompt chars &optional inhibit-keyboard-quit) |
2197 | "Read and return one of CHARS, prompting for PROMPT. | |
2198 | Any input that is not one of CHARS is ignored. | |
2199 | ||
2200 | If optional argument INHIBIT-KEYBOARD-QUIT is non-nil, ignore | |
2201 | keyboard-quit events while waiting for a valid input." | |
2202 | (unless (consp chars) | |
2203 | (error "Called `read-char-choice' without valid char choices")) | |
03ea5b87 | 2204 | (let (char done show-help (helpbuf " *Char Help*")) |
49c5410a SM |
2205 | (let ((cursor-in-echo-area t) |
2206 | (executing-kbd-macro executing-kbd-macro)) | |
03ea5b87 GM |
2207 | (save-window-excursion ; in case we call help-form-show |
2208 | (while (not done) | |
2209 | (unless (get-text-property 0 'face prompt) | |
2210 | (setq prompt (propertize prompt 'face 'minibuffer-prompt))) | |
2211 | (setq char (let ((inhibit-quit inhibit-keyboard-quit)) | |
2212 | (read-key prompt))) | |
647ab967 | 2213 | (and show-help (buffer-live-p (get-buffer helpbuf)) |
03ea5b87 GM |
2214 | (kill-buffer helpbuf)) |
2215 | (cond | |
2216 | ((not (numberp char))) | |
2217 | ;; If caller has set help-form, that's enough. | |
2218 | ;; They don't explicitly have to add help-char to chars. | |
2219 | ((and help-form | |
2220 | (eq char help-char) | |
2221 | (setq show-help t) | |
2222 | (help-form-show))) | |
2223 | ((memq char chars) | |
2224 | (setq done t)) | |
2225 | ((and executing-kbd-macro (= char -1)) | |
2226 | ;; read-event returns -1 if we are in a kbd macro and | |
2227 | ;; there are no more events in the macro. Attempt to | |
2228 | ;; get an event interactively. | |
2229 | (setq executing-kbd-macro nil)) | |
2230 | ((and (not inhibit-keyboard-quit) (eq char ?\C-g)) | |
2231 | (keyboard-quit)))))) | |
49c5410a | 2232 | ;; Display the question with the answer. But without cursor-in-echo-area. |
3ef01959 CY |
2233 | (message "%s%s" prompt (char-to-string char)) |
2234 | char)) | |
2235 | ||
0369eb85 CY |
2236 | (defun sit-for (seconds &optional nodisp obsolete) |
2237 | "Perform redisplay, then wait for SECONDS seconds or until input is available. | |
2238 | SECONDS may be a floating-point value. | |
2239 | \(On operating systems that do not support waiting for fractions of a | |
2240 | second, floating-point values are rounded down to the nearest integer.) | |
2241 | ||
2242 | If optional arg NODISP is t, don't redisplay, just wait for input. | |
2243 | Redisplay does not happen if input is available before it starts. | |
0369eb85 CY |
2244 | |
2245 | Value is t if waited the full time with no input arriving, and nil otherwise. | |
2246 | ||
d8120806 | 2247 | An obsolete, but still supported form is |
0369eb85 | 2248 | \(sit-for SECONDS &optional MILLISECONDS NODISP) |
d8120806 | 2249 | where the optional arg MILLISECONDS specifies an additional wait period, |
0369eb85 | 2250 | in milliseconds; this was useful when Emacs was built without |
fd6c5134 | 2251 | floating point support." |
000b06df GM |
2252 | (if (numberp nodisp) |
2253 | (setq seconds (+ seconds (* 1e-3 nodisp)) | |
2254 | nodisp obsolete) | |
2255 | (if obsolete (setq nodisp obsolete))) | |
790e0ef7 KS |
2256 | (cond |
2257 | (noninteractive | |
2258 | (sleep-for seconds) | |
2259 | t) | |
2260 | ((input-pending-p) | |
2261 | nil) | |
2262 | ((<= seconds 0) | |
2263 | (or nodisp (redisplay))) | |
2264 | (t | |
2265 | (or nodisp (redisplay)) | |
2266 | (let ((read (read-event nil nil seconds))) | |
2267 | (or (null read) | |
fb1a5d8a KS |
2268 | (progn |
2269 | ;; If last command was a prefix arg, e.g. C-u, push this event onto | |
2270 | ;; unread-command-events as (t . EVENT) so it will be added to | |
2271 | ;; this-command-keys by read-key-sequence. | |
2272 | (if (eq overriding-terminal-local-map universal-argument-map) | |
2273 | (setq read (cons t read))) | |
2274 | (push read unread-command-events) | |
2275 | nil)))))) | |
f3a30a50 | 2276 | (set-advertised-calling-convention 'sit-for '(seconds &optional nodisp) "22.1") |
8c51d2a2 | 2277 | |
9aea757b | 2278 | (defun y-or-n-p (prompt) |
8c51d2a2 | 2279 | "Ask user a \"y or n\" question. Return t if answer is \"y\". |
9aea757b CY |
2280 | PROMPT is the string to display to ask the question. It should |
2281 | end in a space; `y-or-n-p' adds \"(y or n) \" to it. | |
3d91e302 | 2282 | |
8c51d2a2 CY |
2283 | No confirmation of the answer is requested; a single character is enough. |
2284 | Also accepts Space to mean yes, or Delete to mean no. \(Actually, it uses | |
2285 | the bindings in `query-replace-map'; see the documentation of that variable | |
2286 | for more information. In this case, the useful bindings are `act', `skip', | |
2287 | `recenter', and `quit'.\) | |
2288 | ||
2289 | Under a windowing system a dialog box will be used if `last-nonmenu-event' | |
2290 | is nil and `use-dialog-box' is non-nil." | |
2291 | ;; ¡Beware! when I tried to edebug this code, Emacs got into a weird state | |
2292 | ;; where all the keys were unbound (i.e. it somehow got triggered | |
2293 | ;; within read-key, apparently). I had to kill it. | |
2294 | (let ((answer 'recenter)) | |
aa4de341 CY |
2295 | (cond |
2296 | (noninteractive | |
2297 | (setq prompt (concat prompt | |
2298 | (if (eq ?\s (aref prompt (1- (length prompt)))) | |
2299 | "" " ") | |
2300 | "(y or n) ")) | |
2301 | (let ((temp-prompt prompt)) | |
2302 | (while (not (memq answer '(act skip))) | |
2303 | (let ((str (read-string temp-prompt))) | |
2304 | (cond ((member str '("y" "Y")) (setq answer 'act)) | |
2305 | ((member str '("n" "N")) (setq answer 'skip)) | |
2306 | (t (setq temp-prompt (concat "Please answer y or n. " | |
2307 | prompt)))))))) | |
2308 | ((and (display-popup-menus-p) | |
2309 | (listp last-nonmenu-event) | |
2310 | use-dialog-box) | |
2311 | (setq answer | |
2312 | (x-popup-dialog t `(,prompt ("Yes" . act) ("No" . skip))))) | |
2313 | (t | |
9aea757b | 2314 | (setq prompt (concat prompt |
8c51d2a2 CY |
2315 | (if (eq ?\s (aref prompt (1- (length prompt)))) |
2316 | "" " ") | |
2317 | "(y or n) ")) | |
2318 | (while | |
2319 | (let* ((key | |
2320 | (let ((cursor-in-echo-area t)) | |
2321 | (when minibuffer-auto-raise | |
2322 | (raise-frame (window-frame (minibuffer-window)))) | |
2323 | (read-key (propertize (if (eq answer 'recenter) | |
2324 | prompt | |
2325 | (concat "Please answer y or n. " | |
2326 | prompt)) | |
2327 | 'face 'minibuffer-prompt))))) | |
2328 | (setq answer (lookup-key query-replace-map (vector key) t)) | |
2329 | (cond | |
2330 | ((memq answer '(skip act)) nil) | |
2331 | ((eq answer 'recenter) (recenter) t) | |
2332 | ((memq answer '(exit-prefix quit)) (signal 'quit nil) t) | |
2333 | (t t))) | |
2334 | (ding) | |
aa4de341 | 2335 | (discard-input)))) |
8c51d2a2 CY |
2336 | (let ((ret (eq answer 'act))) |
2337 | (unless noninteractive | |
c0ea08d2 GM |
2338 | ;; FIXME this prints one too many spaces, since prompt |
2339 | ;; already ends in a space. Eg "... (y or n) y". | |
8c51d2a2 CY |
2340 | (message "%s %s" prompt (if ret "y" "n"))) |
2341 | ret))) | |
2342 | ||
e0e4cb7a | 2343 | \f |
2493767e RS |
2344 | ;;; Atomic change groups. |
2345 | ||
69cae2d4 RS |
2346 | (defmacro atomic-change-group (&rest body) |
2347 | "Perform BODY as an atomic change group. | |
2348 | This means that if BODY exits abnormally, | |
2349 | all of its changes to the current buffer are undone. | |
b9ab4064 | 2350 | This works regardless of whether undo is enabled in the buffer. |
69cae2d4 RS |
2351 | |
2352 | This mechanism is transparent to ordinary use of undo; | |
2353 | if undo is enabled in the buffer and BODY succeeds, the | |
2354 | user can undo the change normally." | |
6273dc68 | 2355 | (declare (indent 0) (debug t)) |
69cae2d4 RS |
2356 | (let ((handle (make-symbol "--change-group-handle--")) |
2357 | (success (make-symbol "--change-group-success--"))) | |
2358 | `(let ((,handle (prepare-change-group)) | |
cf191706 RS |
2359 | ;; Don't truncate any undo data in the middle of this. |
2360 | (undo-outer-limit nil) | |
2361 | (undo-limit most-positive-fixnum) | |
2362 | (undo-strong-limit most-positive-fixnum) | |
69cae2d4 RS |
2363 | (,success nil)) |
2364 | (unwind-protect | |
2365 | (progn | |
2366 | ;; This is inside the unwind-protect because | |
2367 | ;; it enables undo if that was disabled; we need | |
2368 | ;; to make sure that it gets disabled again. | |
2369 | (activate-change-group ,handle) | |
2370 | ,@body | |
2371 | (setq ,success t)) | |
2372 | ;; Either of these functions will disable undo | |
2373 | ;; if it was disabled before. | |
2374 | (if ,success | |
2375 | (accept-change-group ,handle) | |
2376 | (cancel-change-group ,handle)))))) | |
2377 | ||
62ea1306 | 2378 | (defun prepare-change-group (&optional buffer) |
69cae2d4 | 2379 | "Return a handle for the current buffer's state, for a change group. |
62ea1306 | 2380 | If you specify BUFFER, make a handle for BUFFER's state instead. |
69cae2d4 RS |
2381 | |
2382 | Pass the handle to `activate-change-group' afterward to initiate | |
2383 | the actual changes of the change group. | |
2384 | ||
2385 | To finish the change group, call either `accept-change-group' or | |
2386 | `cancel-change-group' passing the same handle as argument. Call | |
2387 | `accept-change-group' to accept the changes in the group as final; | |
2388 | call `cancel-change-group' to undo them all. You should use | |
2389 | `unwind-protect' to make sure the group is always finished. The call | |
2390 | to `activate-change-group' should be inside the `unwind-protect'. | |
2391 | Once you finish the group, don't use the handle again--don't try to | |
2392 | finish the same group twice. For a simple example of correct use, see | |
2393 | the source code of `atomic-change-group'. | |
2394 | ||
2395 | The handle records only the specified buffer. To make a multibuffer | |
2396 | change group, call this function once for each buffer you want to | |
2397 | cover, then use `nconc' to combine the returned values, like this: | |
2398 | ||
2399 | (nconc (prepare-change-group buffer-1) | |
2400 | (prepare-change-group buffer-2)) | |
2401 | ||
2402 | You can then activate that multibuffer change group with a single | |
2403 | call to `activate-change-group' and finish it with a single call | |
2404 | to `accept-change-group' or `cancel-change-group'." | |
2405 | ||
62ea1306 RS |
2406 | (if buffer |
2407 | (list (cons buffer (with-current-buffer buffer buffer-undo-list))) | |
2408 | (list (cons (current-buffer) buffer-undo-list)))) | |
69cae2d4 RS |
2409 | |
2410 | (defun activate-change-group (handle) | |
2411 | "Activate a change group made with `prepare-change-group' (which see)." | |
2412 | (dolist (elt handle) | |
2413 | (with-current-buffer (car elt) | |
2414 | (if (eq buffer-undo-list t) | |
2415 | (setq buffer-undo-list nil))))) | |
2416 | ||
2417 | (defun accept-change-group (handle) | |
2418 | "Finish a change group made with `prepare-change-group' (which see). | |
2419 | This finishes the change group by accepting its changes as final." | |
2420 | (dolist (elt handle) | |
2421 | (with-current-buffer (car elt) | |
2422 | (if (eq elt t) | |
2423 | (setq buffer-undo-list t))))) | |
2424 | ||
2425 | (defun cancel-change-group (handle) | |
2426 | "Finish a change group made with `prepare-change-group' (which see). | |
2427 | This finishes the change group by reverting all of its changes." | |
2428 | (dolist (elt handle) | |
2429 | (with-current-buffer (car elt) | |
2430 | (setq elt (cdr elt)) | |
d21cba62 MR |
2431 | (save-restriction |
2432 | ;; Widen buffer temporarily so if the buffer was narrowed within | |
2433 | ;; the body of `atomic-change-group' all changes can be undone. | |
2434 | (widen) | |
2435 | (let ((old-car | |
2436 | (if (consp elt) (car elt))) | |
2437 | (old-cdr | |
2438 | (if (consp elt) (cdr elt)))) | |
2439 | ;; Temporarily truncate the undo log at ELT. | |
2440 | (when (consp elt) | |
2441 | (setcar elt nil) (setcdr elt nil)) | |
2442 | (unless (eq last-command 'undo) (undo-start)) | |
2443 | ;; Make sure there's no confusion. | |
2444 | (when (and (consp elt) (not (eq elt (last pending-undo-list)))) | |
2445 | (error "Undoing to some unrelated state")) | |
2446 | ;; Undo it all. | |
2447 | (save-excursion | |
2448 | (while (listp pending-undo-list) (undo-more 1))) | |
2449 | ;; Reset the modified cons cell ELT to its original content. | |
2450 | (when (consp elt) | |
2451 | (setcar elt old-car) | |
2452 | (setcdr elt old-cdr)) | |
2453 | ;; Revert the undo info to what it was when we grabbed the state. | |
2454 | (setq buffer-undo-list elt)))))) | |
69cae2d4 | 2455 | \f |
c4f484f2 RS |
2456 | ;;;; Display-related functions. |
2457 | ||
a9d956be RS |
2458 | ;; For compatibility. |
2459 | (defalias 'redraw-modeline 'force-mode-line-update) | |
2460 | ||
9a5336ae | 2461 | (defun force-mode-line-update (&optional all) |
6b61353c KH |
2462 | "Force redisplay of the current buffer's mode line and header line. |
2463 | With optional non-nil ALL, force redisplay of all mode lines and | |
2464 | header lines. This function also forces recomputation of the | |
2465 | menu bar menus and the frame title." | |
03a74b84 | 2466 | (if all (with-current-buffer (other-buffer))) |
9a5336ae JB |
2467 | (set-buffer-modified-p (buffer-modified-p))) |
2468 | ||
aa3b4ded | 2469 | (defun momentary-string-display (string pos &optional exit-char message) |
be9b65ac | 2470 | "Momentarily display STRING in the buffer at POS. |
12092fb3 | 2471 | Display remains until next event is input. |
dbf284be | 2472 | If POS is a marker, only its position is used; its buffer is ignored. |
12092fb3 EZ |
2473 | Optional third arg EXIT-CHAR can be a character, event or event |
2474 | description list. EXIT-CHAR defaults to SPC. If the input is | |
2475 | EXIT-CHAR it is swallowed; otherwise it is then available as | |
2476 | input (as a command if nothing else). | |
be9b65ac DL |
2477 | Display MESSAGE (optional fourth arg) in the echo area. |
2478 | If MESSAGE is nil, instructions to type EXIT-CHAR are displayed there." | |
b754307b | 2479 | (or exit-char (setq exit-char ?\s)) |
f70c4736 | 2480 | (let ((ol (make-overlay pos pos)) |
bc91aee9 | 2481 | (str (copy-sequence string))) |
be9b65ac | 2482 | (unwind-protect |
f70c4736 SM |
2483 | (progn |
2484 | (save-excursion | |
bc91aee9 | 2485 | (overlay-put ol 'after-string str) |
f70c4736 SM |
2486 | (goto-char pos) |
2487 | ;; To avoid trouble with out-of-bounds position | |
2488 | (setq pos (point)) | |
bc91aee9 | 2489 | ;; If the string end is off screen, recenter now. |
f70c4736 SM |
2490 | (if (<= (window-end nil t) pos) |
2491 | (recenter (/ (window-height) 2)))) | |
2492 | (message (or message "Type %s to continue editing.") | |
2493 | (single-key-description exit-char)) | |
fe40dc63 JB |
2494 | (let ((event (read-event))) |
2495 | ;; `exit-char' can be an event, or an event description list. | |
2496 | (or (eq event exit-char) | |
2497 | (eq event (event-convert-list exit-char)) | |
2498 | (setq unread-command-events (list event))))) | |
f70c4736 | 2499 | (delete-overlay ol)))) |
be9b65ac | 2500 | |
9a5336ae | 2501 | \f |
aa3b4ded SM |
2502 | ;;;; Overlay operations |
2503 | ||
2504 | (defun copy-overlay (o) | |
2505 | "Return a copy of overlay O." | |
48b1e7cf SM |
2506 | (let ((o1 (if (overlay-buffer o) |
2507 | (make-overlay (overlay-start o) (overlay-end o) | |
2508 | ;; FIXME: there's no easy way to find the | |
2509 | ;; insertion-type of the two markers. | |
2510 | (overlay-buffer o)) | |
2511 | (let ((o1 (make-overlay (point-min) (point-min)))) | |
2512 | (delete-overlay o1) | |
28f0b072 | 2513 | o1))) |
aa3b4ded SM |
2514 | (props (overlay-properties o))) |
2515 | (while props | |
2516 | (overlay-put o1 (pop props) (pop props))) | |
2517 | o1)) | |
2518 | ||
f24485f1 | 2519 | (defun remove-overlays (&optional beg end name val) |
aa3b4ded | 2520 | "Clear BEG and END of overlays whose property NAME has value VAL. |
cba61075 JB |
2521 | Overlays might be moved and/or split. |
2522 | BEG and END default respectively to the beginning and end of buffer." | |
d6f5ac10 | 2523 | ;; This speeds up the loops over overlays. |
f24485f1 MY |
2524 | (unless beg (setq beg (point-min))) |
2525 | (unless end (setq end (point-max))) | |
ee6bb693 | 2526 | (overlay-recenter end) |
aa3b4ded SM |
2527 | (if (< end beg) |
2528 | (setq beg (prog1 end (setq end beg)))) | |
2529 | (save-excursion | |
2530 | (dolist (o (overlays-in beg end)) | |
2531 | (when (eq (overlay-get o name) val) | |
2532 | ;; Either push this overlay outside beg...end | |
2533 | ;; or split it to exclude beg...end | |
2534 | ;; or delete it entirely (if it is contained in beg...end). | |
2535 | (if (< (overlay-start o) beg) | |
2536 | (if (> (overlay-end o) end) | |
2537 | (progn | |
2538 | (move-overlay (copy-overlay o) | |
2539 | (overlay-start o) beg) | |
2540 | (move-overlay o end (overlay-end o))) | |
2541 | (move-overlay o (overlay-start o) beg)) | |
2542 | (if (> (overlay-end o) end) | |
2543 | (move-overlay o end (overlay-end o)) | |
2544 | (delete-overlay o))))))) | |
c5802acf | 2545 | \f |
9a5336ae JB |
2546 | ;;;; Miscellanea. |
2547 | ||
4fb17037 RS |
2548 | (defvar suspend-hook nil |
2549 | "Normal hook run by `suspend-emacs', before suspending.") | |
2550 | ||
2551 | (defvar suspend-resume-hook nil | |
2552 | "Normal hook run by `suspend-emacs', after Emacs is continued.") | |
2553 | ||
784bc7cd RS |
2554 | (defvar temp-buffer-show-hook nil |
2555 | "Normal hook run by `with-output-to-temp-buffer' after displaying the buffer. | |
2556 | When the hook runs, the temporary buffer is current, and the window it | |
5247a8e6 | 2557 | was displayed in is selected.") |
784bc7cd RS |
2558 | |
2559 | (defvar temp-buffer-setup-hook nil | |
2560 | "Normal hook run by `with-output-to-temp-buffer' at the start. | |
2561 | When the hook runs, the temporary buffer is current. | |
2562 | This hook is normally set up with a function to put the buffer in Help | |
2563 | mode.") | |
2564 | ||
448b61c9 RS |
2565 | ;; Avoid compiler warnings about this variable, |
2566 | ;; which has a special meaning on certain system types. | |
2567 | (defvar buffer-file-type nil | |
2568 | "Non-nil if the visited file is a binary file. | |
2569 | This variable is meaningful on MS-DOG and Windows NT. | |
2570 | On those systems, it is automatically local in every buffer. | |
2571 | On other systems, this variable is normally always nil.") | |
28ac46f8 JPW |
2572 | |
2573 | ;; The `assert' macro from the cl package signals | |
2574 | ;; `cl-assertion-failed' at runtime so always define it. | |
2575 | (put 'cl-assertion-failed 'error-conditions '(error)) | |
6bdad9ae | 2576 | (put 'cl-assertion-failed 'error-message (purecopy "Assertion failed")) |
28ac46f8 | 2577 | |
d8869c65 CY |
2578 | (defconst user-emacs-directory |
2579 | (if (eq system-type 'ms-dos) | |
2580 | ;; MS-DOS cannot have initial dot. | |
2581 | "~/_emacs.d/" | |
2582 | "~/.emacs.d/") | |
2583 | "Directory beneath which additional per-user Emacs-specific files are placed. | |
2584 | Various programs in Emacs store information in this directory. | |
d6c180c4 JB |
2585 | Note that this should end with a directory separator. |
2586 | See also `locate-user-emacs-file'.") | |
2587 | ||
2588 | (defun locate-user-emacs-file (new-name &optional old-name) | |
2589 | "Return an absolute per-user Emacs-specific file name. | |
2590 | If OLD-NAME is non-nil and ~/OLD-NAME exists, return ~/OLD-NAME. | |
2591 | Else return NEW-NAME in `user-emacs-directory', creating the | |
2592 | directory if it does not exist." | |
2593 | (convert-standard-filename | |
2594 | (let* ((home (concat "~" (or init-file-user ""))) | |
2595 | (at-home (and old-name (expand-file-name old-name home)))) | |
2596 | (if (and at-home (file-readable-p at-home)) | |
2597 | at-home | |
2bea2795 JB |
2598 | ;; Make sure `user-emacs-directory' exists, |
2599 | ;; unless we're in batch mode or dumping Emacs | |
2600 | (or noninteractive | |
2601 | purify-flag | |
b024d9f0 MD |
2602 | (file-accessible-directory-p |
2603 | (directory-file-name user-emacs-directory)) | |
2604 | (let ((umask (default-file-modes))) | |
2605 | (unwind-protect | |
2606 | (progn | |
2607 | (set-default-file-modes ?\700) | |
2608 | (make-directory user-emacs-directory)) | |
2609 | (set-default-file-modes umask)))) | |
03a74b84 SM |
2610 | (abbreviate-file-name |
2611 | (expand-file-name new-name user-emacs-directory)))))) | |
c4f484f2 RS |
2612 | \f |
2613 | ;;;; Misc. useful functions. | |
448b61c9 | 2614 | |
c4f484f2 RS |
2615 | (defun find-tag-default () |
2616 | "Determine default tag to search for, based on text at point. | |
2617 | If there is no plausible default, return nil." | |
9db3bfae MR |
2618 | (let (from to bound) |
2619 | (when (or (progn | |
2620 | ;; Look at text around `point'. | |
2621 | (save-excursion | |
2622 | (skip-syntax-backward "w_") (setq from (point))) | |
2623 | (save-excursion | |
2624 | (skip-syntax-forward "w_") (setq to (point))) | |
2625 | (> to from)) | |
2626 | ;; Look between `line-beginning-position' and `point'. | |
2627 | (save-excursion | |
2628 | (and (setq bound (line-beginning-position)) | |
2629 | (skip-syntax-backward "^w_" bound) | |
2630 | (> (setq to (point)) bound) | |
2631 | (skip-syntax-backward "w_") | |
2632 | (setq from (point)))) | |
2633 | ;; Look between `point' and `line-end-position'. | |
2634 | (save-excursion | |
2635 | (and (setq bound (line-end-position)) | |
2636 | (skip-syntax-forward "^w_" bound) | |
2637 | (< (setq from (point)) bound) | |
2638 | (skip-syntax-forward "w_") | |
2639 | (setq to (point))))) | |
2640 | (buffer-substring-no-properties from to)))) | |
a860d25f | 2641 | |
c4f484f2 RS |
2642 | (defun play-sound (sound) |
2643 | "SOUND is a list of the form `(sound KEYWORD VALUE...)'. | |
2644 | The following keywords are recognized: | |
9a5336ae | 2645 | |
c4f484f2 RS |
2646 | :file FILE - read sound data from FILE. If FILE isn't an |
2647 | absolute file name, it is searched in `data-directory'. | |
9a5336ae | 2648 | |
c4f484f2 RS |
2649 | :data DATA - read sound data from string DATA. |
2650 | ||
2651 | Exactly one of :file or :data must be present. | |
2652 | ||
2653 | :volume VOL - set volume to VOL. VOL must an integer in the | |
2654 | range 0..100 or a float in the range 0..1.0. If not specified, | |
2655 | don't change the volume setting of the sound device. | |
9a5336ae | 2656 | |
c4f484f2 | 2657 | :device DEVICE - play sound on DEVICE. If not specified, |
d7f90d6c JB |
2658 | a system-dependent default device name is used. |
2659 | ||
2660 | Note: :data and :device are currently not supported on Windows." | |
c4f484f2 RS |
2661 | (if (fboundp 'play-sound-internal) |
2662 | (play-sound-internal sound) | |
2663 | (error "This Emacs binary lacks sound support"))) | |
9a5336ae | 2664 | |
0ef97535 GM |
2665 | (declare-function w32-shell-dos-semantics "w32-fns" nil) |
2666 | ||
c4f484f2 | 2667 | (defun shell-quote-argument (argument) |
d7f90d6c | 2668 | "Quote ARGUMENT for passing as argument to an inferior shell." |
8f91bf93 DC |
2669 | (cond |
2670 | ((eq system-type 'ms-dos) | |
2671 | ;; Quote using double quotes, but escape any existing quotes in | |
2672 | ;; the argument with backslashes. | |
2673 | (let ((result "") | |
2674 | (start 0) | |
2675 | end) | |
2676 | (if (or (null (string-match "[^\"]" argument)) | |
2677 | (< (match-end 0) (length argument))) | |
2678 | (while (string-match "[\"]" argument start) | |
2679 | (setq end (match-beginning 0) | |
2680 | result (concat result (substring argument start end) | |
2681 | "\\" (substring argument end (1+ end))) | |
2682 | start (1+ end)))) | |
2683 | (concat "\"" result (substring argument start) "\""))) | |
2684 | ||
2685 | ((and (eq system-type 'windows-nt) (w32-shell-dos-semantics)) | |
638f053a | 2686 | |
8f91bf93 DC |
2687 | ;; First, quote argument so that CommandLineToArgvW will |
2688 | ;; understand it. See | |
2689 | ;; http://msdn.microsoft.com/en-us/library/17w5ykft%28v=vs.85%29.aspx | |
2690 | ;; After we perform that level of quoting, escape shell | |
2691 | ;; metacharacters so that cmd won't mangle our argument. If the | |
2692 | ;; argument contains no double quote characters, we can just | |
2693 | ;; surround it with double quotes. Otherwise, we need to prefix | |
2694 | ;; each shell metacharacter with a caret. | |
2695 | ||
2696 | (setq argument | |
2697 | ;; escape backslashes at end of string | |
2698 | (replace-regexp-in-string | |
2699 | "\\(\\\\*\\)$" | |
2700 | "\\1\\1" | |
2701 | ;; escape backslashes and quotes in string body | |
2702 | (replace-regexp-in-string | |
2703 | "\\(\\\\*\\)\"" | |
2704 | "\\1\\1\\\\\"" | |
2705 | argument))) | |
2706 | ||
2a782793 | 2707 | (if (string-match "[%!\"]" argument) |
8f91bf93 DC |
2708 | (concat |
2709 | "^\"" | |
2710 | (replace-regexp-in-string | |
2711 | "\\([%!()\"<>&|^]\\)" | |
2712 | "^\\1" | |
2713 | argument) | |
2714 | "^\"") | |
2715 | (concat "\"" argument "\""))) | |
2716 | ||
2717 | (t | |
4bbf6b41 JR |
2718 | (if (equal argument "") |
2719 | "''" | |
2720 | ;; Quote everything except POSIX filename characters. | |
2721 | ;; This should be safe enough even for really weird shells. | |
8f91bf93 DC |
2722 | (replace-regexp-in-string |
2723 | "\n" "'\n'" | |
2724 | (replace-regexp-in-string "[^-0-9a-zA-Z_./\n]" "\\\\\\&" argument)))) | |
2725 | )) | |
3e457225 RS |
2726 | |
2727 | (defun string-or-null-p (object) | |
2728 | "Return t if OBJECT is a string or nil. | |
2729 | Otherwise, return nil." | |
2730 | (or (stringp object) (null object))) | |
2731 | ||
26715e1b | 2732 | (defun booleanp (object) |
ac6ca7ba KR |
2733 | "Return t if OBJECT is one of the two canonical boolean values: t or nil. |
2734 | Otherwise, return nil." | |
2735 | (and (memq object '(nil t)) t)) | |
26715e1b | 2736 | |
1627b55f | 2737 | (defun field-at-pos (pos) |
d7f90d6c | 2738 | "Return the field at position POS, taking stickiness etc into account." |
1ecaae6c NR |
2739 | (let ((raw-field (get-char-property (field-beginning pos) 'field))) |
2740 | (if (eq raw-field 'boundary) | |
2741 | (get-char-property (1- (field-end pos)) 'field) | |
2742 | raw-field))) | |
2743 | ||
7f3f739f LL |
2744 | (defun sha1 (object &optional start end binary) |
2745 | "Return the SHA1 (Secure Hash Algorithm) of an OBJECT. | |
2746 | OBJECT is either a string or a buffer. Optional arguments START and | |
2747 | END are character positions specifying which portion of OBJECT for | |
2748 | computing the hash. If BINARY is non-nil, return a string in binary | |
2749 | form." | |
2750 | (secure-hash 'sha1 object start end binary)) | |
2751 | ||
c4f484f2 RS |
2752 | \f |
2753 | ;;;; Support for yanking and text properties. | |
9a5336ae | 2754 | |
2493767e RS |
2755 | (defvar yank-excluded-properties) |
2756 | ||
8ed59ad5 KS |
2757 | (defun remove-yank-excluded-properties (start end) |
2758 | "Remove `yank-excluded-properties' between START and END positions. | |
2759 | Replaces `category' properties with their defined properties." | |
2760 | (let ((inhibit-read-only t)) | |
0f00e948 EZ |
2761 | ;; Replace any `category' property with the properties it stands |
2762 | ;; for. This is to remove `mouse-face' properties that are placed | |
2763 | ;; on categories in *Help* buffers' buttons. See | |
2764 | ;; http://lists.gnu.org/archive/html/emacs-devel/2002-04/msg00648.html | |
2765 | ;; for the details. | |
8ed59ad5 KS |
2766 | (unless (memq yank-excluded-properties '(t nil)) |
2767 | (save-excursion | |
2768 | (goto-char start) | |
2769 | (while (< (point) end) | |
2770 | (let ((cat (get-text-property (point) 'category)) | |
2771 | run-end) | |
8ed59ad5 KS |
2772 | (setq run-end |
2773 | (next-single-property-change (point) 'category nil end)) | |
ebaa3349 RS |
2774 | (when cat |
2775 | (let (run-end2 original) | |
2776 | (remove-list-of-text-properties (point) run-end '(category)) | |
2777 | (while (< (point) run-end) | |
2778 | (setq run-end2 (next-property-change (point) nil run-end)) | |
2779 | (setq original (text-properties-at (point))) | |
2780 | (set-text-properties (point) run-end2 (symbol-plist cat)) | |
2781 | (add-text-properties (point) run-end2 original) | |
2782 | (goto-char run-end2)))) | |
2783 | (goto-char run-end))))) | |
8ed59ad5 KS |
2784 | (if (eq yank-excluded-properties t) |
2785 | (set-text-properties start end nil) | |
ebaa3349 | 2786 | (remove-list-of-text-properties start end yank-excluded-properties)))) |
8ed59ad5 | 2787 | |
e0e80ec9 KS |
2788 | (defvar yank-undo-function) |
2789 | ||
2790 | (defun insert-for-yank (string) | |
3fa173b4 | 2791 | "Call `insert-for-yank-1' repetitively for each `yank-handler' segment. |
6b61353c KH |
2792 | |
2793 | See `insert-for-yank-1' for more details." | |
2794 | (let (to) | |
2795 | (while (setq to (next-single-property-change 0 'yank-handler string)) | |
2796 | (insert-for-yank-1 (substring string 0 to)) | |
2797 | (setq string (substring string to)))) | |
2798 | (insert-for-yank-1 string)) | |
2799 | ||
2800 | (defun insert-for-yank-1 (string) | |
e0e80ec9 | 2801 | "Insert STRING at point, stripping some text properties. |
6b61353c | 2802 | |
e0e80ec9 KS |
2803 | Strip text properties from the inserted text according to |
2804 | `yank-excluded-properties'. Otherwise just like (insert STRING). | |
2805 | ||
374d3fe7 | 2806 | If STRING has a non-nil `yank-handler' property on the first character, |
cc295a82 | 2807 | the normal insert behavior is modified in various ways. The value of |
fbe13428 | 2808 | the yank-handler property must be a list with one to four elements |
9dd10e25 | 2809 | with the following format: (FUNCTION PARAM NOEXCLUDE UNDO). |
e0e80ec9 KS |
2810 | When FUNCTION is present and non-nil, it is called instead of `insert' |
2811 | to insert the string. FUNCTION takes one argument--the object to insert. | |
2812 | If PARAM is present and non-nil, it replaces STRING as the object | |
2813 | passed to FUNCTION (or `insert'); for example, if FUNCTION is | |
2814 | `yank-rectangle', PARAM may be a list of strings to insert as a | |
2815 | rectangle. | |
2816 | If NOEXCLUDE is present and non-nil, the normal removal of the | |
5612fd08 | 2817 | `yank-excluded-properties' is not performed; instead FUNCTION is |
e0e80ec9 KS |
2818 | responsible for removing those properties. This may be necessary |
2819 | if FUNCTION adjusts point before or after inserting the object. | |
2820 | If UNDO is present and non-nil, it is a function that will be called | |
2821 | by `yank-pop' to undo the insertion of the current object. It is | |
f1180544 | 2822 | called with two arguments, the start and end of the current region. |
9dd10e25 | 2823 | FUNCTION may set `yank-undo-function' to override the UNDO value." |
57596fb6 KS |
2824 | (let* ((handler (and (stringp string) |
2825 | (get-text-property 0 'yank-handler string))) | |
2826 | (param (or (nth 1 handler) string)) | |
4f0f29aa | 2827 | (opoint (point)) |
029fd82c | 2828 | (inhibit-read-only inhibit-read-only) |
4f0f29aa RS |
2829 | end) |
2830 | ||
57596fb6 KS |
2831 | (setq yank-undo-function t) |
2832 | (if (nth 0 handler) ;; FUNCTION | |
2833 | (funcall (car handler) param) | |
e0e80ec9 | 2834 | (insert param)) |
4f0f29aa RS |
2835 | (setq end (point)) |
2836 | ||
029fd82c CY |
2837 | ;; Prevent read-only properties from interfering with the |
2838 | ;; following text property changes. | |
2839 | (setq inhibit-read-only t) | |
2840 | ||
4f0f29aa RS |
2841 | ;; What should we do with `font-lock-face' properties? |
2842 | (if font-lock-defaults | |
2843 | ;; No, just wipe them. | |
2844 | (remove-list-of-text-properties opoint end '(font-lock-face)) | |
2845 | ;; Convert them to `face'. | |
2846 | (save-excursion | |
2847 | (goto-char opoint) | |
2848 | (while (< (point) end) | |
2849 | (let ((face (get-text-property (point) 'font-lock-face)) | |
2850 | run-end) | |
2851 | (setq run-end | |
2852 | (next-single-property-change (point) 'font-lock-face nil end)) | |
2853 | (when face | |
2854 | (remove-text-properties (point) run-end '(font-lock-face nil)) | |
2855 | (put-text-property (point) run-end 'face face)) | |
2856 | (goto-char run-end))))) | |
2857 | ||
57596fb6 | 2858 | (unless (nth 2 handler) ;; NOEXCLUDE |
e0e80ec9 | 2859 | (remove-yank-excluded-properties opoint (point))) |
631890d8 RS |
2860 | |
2861 | ;; If last inserted char has properties, mark them as rear-nonsticky. | |
2862 | (if (and (> end opoint) | |
2863 | (text-properties-at (1- end))) | |
2864 | (put-text-property (1- end) end 'rear-nonsticky t)) | |
2865 | ||
c8227332 | 2866 | (if (eq yank-undo-function t) ;; not set by FUNCTION |
57596fb6 | 2867 | (setq yank-undo-function (nth 3 handler))) ;; UNDO |
c8227332 | 2868 | (if (nth 4 handler) ;; COMMAND |
57596fb6 | 2869 | (setq this-command (nth 4 handler))))) |
f1180544 | 2870 | |
a478f3e1 JB |
2871 | (defun insert-buffer-substring-no-properties (buffer &optional start end) |
2872 | "Insert before point a substring of BUFFER, without text properties. | |
3b8690f6 | 2873 | BUFFER may be a buffer or a buffer name. |
f8cf33b1 JB |
2874 | Arguments START and END are character positions specifying the substring. |
2875 | They default to the values of (point-min) and (point-max) in BUFFER." | |
3b8690f6 | 2876 | (let ((opoint (point))) |
a478f3e1 | 2877 | (insert-buffer-substring buffer start end) |
3b8690f6 KS |
2878 | (let ((inhibit-read-only t)) |
2879 | (set-text-properties opoint (point) nil)))) | |
2880 | ||
a478f3e1 JB |
2881 | (defun insert-buffer-substring-as-yank (buffer &optional start end) |
2882 | "Insert before point a part of BUFFER, stripping some text properties. | |
2883 | BUFFER may be a buffer or a buffer name. | |
f8cf33b1 JB |
2884 | Arguments START and END are character positions specifying the substring. |
2885 | They default to the values of (point-min) and (point-max) in BUFFER. | |
a478f3e1 JB |
2886 | Strip text properties from the inserted text according to |
2887 | `yank-excluded-properties'." | |
6b61353c KH |
2888 | ;; Since the buffer text should not normally have yank-handler properties, |
2889 | ;; there is no need to handle them here. | |
3b8690f6 | 2890 | (let ((opoint (point))) |
a478f3e1 | 2891 | (insert-buffer-substring buffer start end) |
8ed59ad5 | 2892 | (remove-yank-excluded-properties opoint (point)))) |
3b8690f6 | 2893 | |
2493767e | 2894 | \f |
c4f484f2 | 2895 | ;;;; Synchronous shell commands. |
2493767e | 2896 | |
be9b65ac DL |
2897 | (defun start-process-shell-command (name buffer &rest args) |
2898 | "Start a program in a subprocess. Return the process object for it. | |
be9b65ac | 2899 | NAME is name for process. It is modified if necessary to make it unique. |
54ce7cbf | 2900 | BUFFER is the buffer (or buffer name) to associate with the process. |
be9b65ac DL |
2901 | Process output goes at end of that buffer, unless you specify |
2902 | an output stream or filter function to handle the output. | |
2903 | BUFFER may be also nil, meaning that this process is not associated | |
2904 | with any buffer | |
03a74b84 SM |
2905 | COMMAND is the shell command to run. |
2906 | ||
2907 | An old calling convention accepted any number of arguments after COMMAND, | |
2908 | which were just concatenated to COMMAND. This is still supported but strongly | |
fd6c5134 | 2909 | discouraged." |
b59f6d7a RS |
2910 | ;; We used to use `exec' to replace the shell with the command, |
2911 | ;; but that failed to handle (...) and semicolon, etc. | |
7c2fb837 DN |
2912 | (start-process name buffer shell-file-name shell-command-switch |
2913 | (mapconcat 'identity args " "))) | |
f3ed9aca | 2914 | (set-advertised-calling-convention 'start-process-shell-command |
f3a30a50 | 2915 | '(name buffer command) "23.1") |
f3ed9aca | 2916 | |
a9e11582 MA |
2917 | (defun start-file-process-shell-command (name buffer &rest args) |
2918 | "Start a program in a subprocess. Return the process object for it. | |
fd6c5134 | 2919 | Similar to `start-process-shell-command', but calls `start-file-process'." |
a9e11582 MA |
2920 | (start-file-process |
2921 | name buffer | |
2922 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) | |
2923 | (if (file-remote-p default-directory) "-c" shell-command-switch) | |
2924 | (mapconcat 'identity args " "))) | |
f3ed9aca | 2925 | (set-advertised-calling-convention 'start-file-process-shell-command |
f3a30a50 | 2926 | '(name buffer command) "23.1") |
a9e11582 | 2927 | |
93aca633 MB |
2928 | (defun call-process-shell-command (command &optional infile buffer display |
2929 | &rest args) | |
2930 | "Execute the shell command COMMAND synchronously in separate process. | |
2931 | The remaining arguments are optional. | |
2932 | The program's input comes from file INFILE (nil means `/dev/null'). | |
2933 | Insert output in BUFFER before point; t means current buffer; | |
2934 | nil for BUFFER means discard it; 0 means discard and don't wait. | |
2935 | BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case, | |
2936 | REAL-BUFFER says what to do with standard output, as above, | |
2937 | while STDERR-FILE says what to do with standard error in the child. | |
2938 | STDERR-FILE may be nil (discard standard error output), | |
2939 | t (mix it with ordinary output), or a file name string. | |
2940 | ||
2941 | Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted. | |
2942 | Remaining arguments are strings passed as additional arguments for COMMAND. | |
2943 | Wildcards and redirection are handled as usual in the shell. | |
2944 | ||
2945 | If BUFFER is 0, `call-process-shell-command' returns immediately with value nil. | |
2946 | Otherwise it waits for COMMAND to terminate and returns a numeric exit | |
2947 | status or a signal description string. | |
2948 | If you quit, the process is killed with SIGINT, or SIGKILL if you quit again." | |
7c2fb837 DN |
2949 | ;; We used to use `exec' to replace the shell with the command, |
2950 | ;; but that failed to handle (...) and semicolon, etc. | |
2951 | (call-process shell-file-name | |
2952 | infile buffer display | |
2953 | shell-command-switch | |
2954 | (mapconcat 'identity (cons command args) " "))) | |
a9e11582 MA |
2955 | |
2956 | (defun process-file-shell-command (command &optional infile buffer display | |
2957 | &rest args) | |
2958 | "Process files synchronously in a separate process. | |
2959 | Similar to `call-process-shell-command', but calls `process-file'." | |
2960 | (process-file | |
2961 | (if (file-remote-p default-directory) "/bin/sh" shell-file-name) | |
2962 | infile buffer display | |
2963 | (if (file-remote-p default-directory) "-c" shell-command-switch) | |
2964 | (mapconcat 'identity (cons command args) " "))) | |
a7ed4c2a | 2965 | \f |
c4f484f2 RS |
2966 | ;;;; Lisp macros to do various things temporarily. |
2967 | ||
83f57f49 MR |
2968 | (defmacro with-current-buffer (buffer-or-name &rest body) |
2969 | "Execute the forms in BODY with BUFFER-OR-NAME temporarily current. | |
2970 | BUFFER-OR-NAME must be a buffer or the name of an existing buffer. | |
2971 | The value returned is the value of the last form in BODY. See | |
2972 | also `with-temp-buffer'." | |
d47f7515 SM |
2973 | (declare (indent 1) (debug t)) |
2974 | `(save-current-buffer | |
83f57f49 | 2975 | (set-buffer ,buffer-or-name) |
d47f7515 SM |
2976 | ,@body)) |
2977 | ||
2978 | (defmacro with-selected-window (window &rest body) | |
2979 | "Execute the forms in BODY with WINDOW as the selected window. | |
2980 | The value returned is the value of the last form in BODY. | |
4c6d1e16 | 2981 | |
a5094f72 MR |
2982 | This macro saves and restores the selected window, as well as the |
2983 | selected window of each frame. It does not change the order of | |
2984 | recently selected windows. If the previously selected window of | |
2985 | some frame is no longer live at the end of BODY, that frame's | |
2986 | selected window is left alone. If the selected window is no | |
2987 | longer live, then whatever window is selected at the end of BODY | |
2988 | remains selected. | |
2989 | ||
2990 | This macro uses `save-current-buffer' to save and restore the | |
2991 | current buffer, since otherwise its normal operation could | |
2992 | potentially make a different buffer current. It does not alter | |
2993 | the buffer list ordering." | |
d47f7515 | 2994 | (declare (indent 1) (debug t)) |
4df623c0 RS |
2995 | ;; Most of this code is a copy of save-selected-window. |
2996 | `(let ((save-selected-window-window (selected-window)) | |
3f71ad3a RS |
2997 | ;; It is necessary to save all of these, because calling |
2998 | ;; select-window changes frame-selected-window for whatever | |
2999 | ;; frame that window is in. | |
4df623c0 RS |
3000 | (save-selected-window-alist |
3001 | (mapcar (lambda (frame) (list frame (frame-selected-window frame))) | |
3002 | (frame-list)))) | |
4c6d1e16 RS |
3003 | (save-current-buffer |
3004 | (unwind-protect | |
3005 | (progn (select-window ,window 'norecord) | |
3006 | ,@body) | |
3007 | (dolist (elt save-selected-window-alist) | |
3008 | (and (frame-live-p (car elt)) | |
3009 | (window-live-p (cadr elt)) | |
a5094f72 MR |
3010 | (set-frame-selected-window (car elt) (cadr elt) 'norecord))) |
3011 | (when (window-live-p save-selected-window-window) | |
3012 | (select-window save-selected-window-window 'norecord)))))) | |
a7f284ec | 3013 | |
c3e242d3 KL |
3014 | (defmacro with-selected-frame (frame &rest body) |
3015 | "Execute the forms in BODY with FRAME as the selected frame. | |
3016 | The value returned is the value of the last form in BODY. | |
a5094f72 | 3017 | |
4e5d086d LMI |
3018 | This macro saves and restores the selected frame, and changes the |
3019 | order of neither the recently selected windows nor the buffers in | |
3020 | the buffer list." | |
c3e242d3 | 3021 | (declare (indent 1) (debug t)) |
632210dd KL |
3022 | (let ((old-frame (make-symbol "old-frame")) |
3023 | (old-buffer (make-symbol "old-buffer"))) | |
3024 | `(let ((,old-frame (selected-frame)) | |
3025 | (,old-buffer (current-buffer))) | |
3026 | (unwind-protect | |
a5094f72 | 3027 | (progn (select-frame ,frame 'norecord) |
632210dd | 3028 | ,@body) |
a5094f72 MR |
3029 | (when (frame-live-p ,old-frame) |
3030 | (select-frame ,old-frame 'norecord)) | |
3031 | (when (buffer-live-p ,old-buffer) | |
3032 | (set-buffer ,old-buffer)))))) | |
c3e242d3 | 3033 | |
e0f57e65 | 3034 | (defmacro save-window-excursion (&rest body) |
2cc775f9 | 3035 | "Execute BODY, then restore previous window configuration. |
d3760c4b CY |
3036 | This macro saves the window configuration on the selected frame, |
3037 | executes BODY, then calls `set-window-configuration' to restore | |
3038 | the saved window configuration. The return value is the last | |
3039 | form in BODY. The window configuration is also restored if BODY | |
3040 | exits nonlocally. | |
e0f57e65 SM |
3041 | |
3042 | BEWARE: Most uses of this macro introduce bugs. | |
3043 | E.g. it should not be used to try and prevent some code from opening | |
3044 | a new window, since that window may sometimes appear in another frame, | |
3045 | in which case `save-window-excursion' cannot help." | |
3046 | (declare (indent 0) (debug t)) | |
3047 | (let ((c (make-symbol "wconfig"))) | |
3048 | `(let ((,c (current-window-configuration))) | |
3049 | (unwind-protect (progn ,@body) | |
3050 | (set-window-configuration ,c))))) | |
3051 | ||
3e21b6a7 SM |
3052 | (defmacro with-output-to-temp-buffer (bufname &rest body) |
3053 | "Bind `standard-output' to buffer BUFNAME, eval BODY, then show that buffer. | |
3054 | ||
3055 | This construct makes buffer BUFNAME empty before running BODY. | |
3056 | It does not make the buffer current for BODY. | |
3057 | Instead it binds `standard-output' to that buffer, so that output | |
3058 | generated with `prin1' and similar functions in BODY goes into | |
3059 | the buffer. | |
3060 | ||
a239d4e9 | 3061 | At the end of BODY, this marks buffer BUFNAME unmodified and displays |
3e21b6a7 SM |
3062 | it in a window, but does not select it. The normal way to do this is |
3063 | by calling `display-buffer', then running `temp-buffer-show-hook'. | |
3064 | However, if `temp-buffer-show-function' is non-nil, it calls that | |
3065 | function instead (and does not run `temp-buffer-show-hook'). The | |
3066 | function gets one argument, the buffer to display. | |
3067 | ||
3068 | The return value of `with-output-to-temp-buffer' is the value of the | |
3069 | last form in BODY. If BODY does not finish normally, the buffer | |
3070 | BUFNAME is not displayed. | |
3071 | ||
3072 | This runs the hook `temp-buffer-setup-hook' before BODY, | |
3073 | with the buffer BUFNAME temporarily current. It runs the hook | |
3074 | `temp-buffer-show-hook' after displaying buffer BUFNAME, with that | |
3075 | buffer temporarily current, and the window that was used to display it | |
3076 | temporarily selected. But it doesn't run `temp-buffer-show-hook' | |
3077 | if it uses `temp-buffer-show-function'." | |
2462470b | 3078 | (declare (debug t)) |
3e21b6a7 SM |
3079 | (let ((old-dir (make-symbol "old-dir")) |
3080 | (buf (make-symbol "buf"))) | |
9dba2c64 SM |
3081 | `(let* ((,old-dir default-directory) |
3082 | (,buf | |
3083 | (with-current-buffer (get-buffer-create ,bufname) | |
3084 | (prog1 (current-buffer) | |
3085 | (kill-all-local-variables) | |
3086 | ;; FIXME: delete_all_overlays | |
3087 | (setq default-directory ,old-dir) | |
3088 | (setq buffer-read-only nil) | |
3089 | (setq buffer-file-name nil) | |
3090 | (setq buffer-undo-list t) | |
3091 | (let ((inhibit-read-only t) | |
3092 | (inhibit-modification-hooks t)) | |
3093 | (erase-buffer) | |
3094 | (run-hooks 'temp-buffer-setup-hook))))) | |
3095 | (standard-output ,buf)) | |
3096 | (prog1 (progn ,@body) | |
3097 | (internal-temp-output-buffer-show ,buf))))) | |
3e21b6a7 | 3098 | |
e5bb8a8c SM |
3099 | (defmacro with-temp-file (file &rest body) |
3100 | "Create a new buffer, evaluate BODY there, and write the buffer to FILE. | |
3101 | The value returned is the value of the last form in BODY. | |
a2fdb55c | 3102 | See also `with-temp-buffer'." |
f291fe60 | 3103 | (declare (indent 1) (debug t)) |
a7ed4c2a | 3104 | (let ((temp-file (make-symbol "temp-file")) |
a2fdb55c EN |
3105 | (temp-buffer (make-symbol "temp-buffer"))) |
3106 | `(let ((,temp-file ,file) | |
3107 | (,temp-buffer | |
3108 | (get-buffer-create (generate-new-buffer-name " *temp file*")))) | |
3109 | (unwind-protect | |
3110 | (prog1 | |
3111 | (with-current-buffer ,temp-buffer | |
e5bb8a8c | 3112 | ,@body) |
a2fdb55c | 3113 | (with-current-buffer ,temp-buffer |
ab1d3835 | 3114 | (write-region nil nil ,temp-file nil 0))) |
a2fdb55c EN |
3115 | (and (buffer-name ,temp-buffer) |
3116 | (kill-buffer ,temp-buffer)))))) | |
3117 | ||
e5bb8a8c | 3118 | (defmacro with-temp-message (message &rest body) |
a600effe | 3119 | "Display MESSAGE temporarily if non-nil while BODY is evaluated. |
e5bb8a8c SM |
3120 | The original message is restored to the echo area after BODY has finished. |
3121 | The value returned is the value of the last form in BODY. | |
a600effe SM |
3122 | MESSAGE is written to the message log buffer if `message-log-max' is non-nil. |
3123 | If MESSAGE is nil, the echo area and message log buffer are unchanged. | |
3124 | Use a MESSAGE of \"\" to temporarily clear the echo area." | |
f291fe60 | 3125 | (declare (debug t) (indent 1)) |
110201c8 SM |
3126 | (let ((current-message (make-symbol "current-message")) |
3127 | (temp-message (make-symbol "with-temp-message"))) | |
3128 | `(let ((,temp-message ,message) | |
3129 | (,current-message)) | |
e5bb8a8c SM |
3130 | (unwind-protect |
3131 | (progn | |
110201c8 SM |
3132 | (when ,temp-message |
3133 | (setq ,current-message (current-message)) | |
aadf7ff3 | 3134 | (message "%s" ,temp-message)) |
e5bb8a8c | 3135 | ,@body) |
cad84646 RS |
3136 | (and ,temp-message |
3137 | (if ,current-message | |
3138 | (message "%s" ,current-message) | |
3139 | (message nil))))))) | |
e5bb8a8c SM |
3140 | |
3141 | (defmacro with-temp-buffer (&rest body) | |
3142 | "Create a temporary buffer, and evaluate BODY there like `progn'. | |
a2fdb55c | 3143 | See also `with-temp-file' and `with-output-to-string'." |
d47f7515 | 3144 | (declare (indent 0) (debug t)) |
a2fdb55c | 3145 | (let ((temp-buffer (make-symbol "temp-buffer"))) |
9166dbf6 | 3146 | `(let ((,temp-buffer (generate-new-buffer " *temp*"))) |
4a5e1832 SM |
3147 | ;; FIXME: kill-buffer can change current-buffer in some odd cases. |
3148 | (with-current-buffer ,temp-buffer | |
3149 | (unwind-protect | |
3150 | (progn ,@body) | |
3151 | (and (buffer-name ,temp-buffer) | |
3152 | (kill-buffer ,temp-buffer))))))) | |
a2fdb55c | 3153 | |
83a5aac5 | 3154 | (defmacro with-silent-modifications (&rest body) |
f291fe60 | 3155 | "Execute BODY, pretending it does not modify the buffer. |
83a5aac5 SM |
3156 | If BODY performs real modifications to the buffer's text, other |
3157 | than cosmetic ones, undo data may become corrupted. | |
a28e4607 LMI |
3158 | |
3159 | This macro will run BODY normally, but doesn't count its buffer | |
3160 | modifications as being buffer modifications. This affects things | |
3161 | like buffer-modified-p, checking whether the file is locked by | |
3162 | someone else, running buffer modification hooks, and other things | |
3163 | of that nature. | |
3164 | ||
3165 | Typically used around modifications of text-properties which do | |
3166 | not really affect the buffer's content." | |
83a5aac5 SM |
3167 | (declare (debug t) (indent 0)) |
3168 | (let ((modified (make-symbol "modified"))) | |
3169 | `(let* ((,modified (buffer-modified-p)) | |
3170 | (buffer-undo-list t) | |
3171 | (inhibit-read-only t) | |
3172 | (inhibit-modification-hooks t) | |
3173 | deactivate-mark | |
3174 | ;; Avoid setting and removing file locks and checking | |
3175 | ;; buffer's uptodate-ness w.r.t the underlying file. | |
3176 | buffer-file-name | |
3177 | buffer-file-truename) | |
3178 | (unwind-protect | |
3179 | (progn | |
3180 | ,@body) | |
3181 | (unless ,modified | |
3182 | (restore-buffer-modified-p nil)))))) | |
3183 | ||
5db7925d RS |
3184 | (defmacro with-output-to-string (&rest body) |
3185 | "Execute BODY, return the text it sent to `standard-output', as a string." | |
d47f7515 | 3186 | (declare (indent 0) (debug t)) |
a2fdb55c EN |
3187 | `(let ((standard-output |
3188 | (get-buffer-create (generate-new-buffer-name " *string-output*")))) | |
86ec740e RF |
3189 | (unwind-protect |
3190 | (progn | |
3191 | (let ((standard-output standard-output)) | |
3192 | ,@body) | |
3193 | (with-current-buffer standard-output | |
3194 | (buffer-string))) | |
3195 | (kill-buffer standard-output)))) | |
2ec9c94e | 3196 | |
0764e16f | 3197 | (defmacro with-local-quit (&rest body) |
53a7160c | 3198 | "Execute BODY, allowing quits to terminate BODY but not escape further. |
b9308c61 | 3199 | When a quit terminates BODY, `with-local-quit' returns nil but |
60f7e8b6 RS |
3200 | requests another quit. That quit will be processed as soon as quitting |
3201 | is allowed once again. (Immediately, if `inhibit-quit' is nil.)" | |
12320833 | 3202 | (declare (debug t) (indent 0)) |
0764e16f SM |
3203 | `(condition-case nil |
3204 | (let ((inhibit-quit nil)) | |
3205 | ,@body) | |
113fe928 RS |
3206 | (quit (setq quit-flag t) |
3207 | ;; This call is to give a chance to handle quit-flag | |
3208 | ;; in case inhibit-quit is nil. | |
3209 | ;; Without this, it will not be handled until the next function | |
3210 | ;; call, and that might allow it to exit thru a condition-case | |
3211 | ;; that intends to handle the quit signal next time. | |
3212 | (eval '(ignore nil))))) | |
0764e16f | 3213 | |
c2b53d7b RS |
3214 | (defmacro while-no-input (&rest body) |
3215 | "Execute BODY only as long as there's no pending input. | |
3216 | If input arrives, that ends the execution of BODY, | |
83047ee3 RS |
3217 | and `while-no-input' returns t. Quitting makes it return nil. |
3218 | If BODY finishes, `while-no-input' returns whatever value BODY produced." | |
c2b53d7b RS |
3219 | (declare (debug t) (indent 0)) |
3220 | (let ((catch-sym (make-symbol "input"))) | |
3221 | `(with-local-quit | |
3222 | (catch ',catch-sym | |
3223 | (let ((throw-on-input ',catch-sym)) | |
790e0ef7 | 3224 | (or (input-pending-p) |
ff7d73ac | 3225 | (progn ,@body))))))) |
c2b53d7b | 3226 | |
1be3ca5a | 3227 | (defmacro condition-case-unless-debug (var bodyform &rest handlers) |
47ccb993 SM |
3228 | "Like `condition-case' except that it does not catch anything when debugging. |
3229 | More specifically if `debug-on-error' is set, then it does not catch any signal." | |
3230 | (declare (debug condition-case) (indent 2)) | |
3231 | (let ((bodysym (make-symbol "body"))) | |
3232 | `(let ((,bodysym (lambda () ,bodyform))) | |
3233 | (if debug-on-error | |
3234 | (funcall ,bodysym) | |
3235 | (condition-case ,var | |
3236 | (funcall ,bodysym) | |
3237 | ,@handlers))))) | |
3238 | ||
1be3ca5a LL |
3239 | (define-obsolete-function-alias 'condition-case-no-debug |
3240 | 'condition-case-unless-debug "24.1") | |
3241 | ||
47ccb993 SM |
3242 | (defmacro with-demoted-errors (&rest body) |
3243 | "Run BODY and demote any errors to simple messages. | |
3244 | If `debug-on-error' is non-nil, run BODY without catching its errors. | |
3245 | This is to be used around code which is not expected to signal an error | |
04bf5b65 | 3246 | but which should be robust in the unexpected case that an error is signaled." |
47ccb993 SM |
3247 | (declare (debug t) (indent 0)) |
3248 | (let ((err (make-symbol "err"))) | |
1be3ca5a | 3249 | `(condition-case-unless-debug ,err |
47ccb993 | 3250 | (progn ,@body) |
7f0ea0ff | 3251 | (error (message "Error: %S" ,err) nil)))) |
47ccb993 | 3252 | |
2ec9c94e RS |
3253 | (defmacro combine-after-change-calls (&rest body) |
3254 | "Execute BODY, but don't call the after-change functions till the end. | |
3255 | If BODY makes changes in the buffer, they are recorded | |
3256 | and the functions on `after-change-functions' are called several times | |
3257 | when BODY is finished. | |
31aa282e | 3258 | The return value is the value of the last form in BODY. |
2ec9c94e RS |
3259 | |
3260 | If `before-change-functions' is non-nil, then calls to the after-change | |
3261 | functions can't be deferred, so in that case this macro has no effect. | |
3262 | ||
3263 | Do not alter `after-change-functions' or `before-change-functions' | |
3264 | in BODY." | |
d47f7515 | 3265 | (declare (indent 0) (debug t)) |
2ec9c94e RS |
3266 | `(unwind-protect |
3267 | (let ((combine-after-change-calls t)) | |
3268 | . ,body) | |
3269 | (combine-after-change-execute))) | |
6a978be3 CY |
3270 | |
3271 | (defmacro with-case-table (table &rest body) | |
3272 | "Execute the forms in BODY with TABLE as the current case table. | |
3273 | The value returned is the value of the last form in BODY." | |
3274 | (declare (indent 1) (debug t)) | |
8d6fd8d4 JPW |
3275 | (let ((old-case-table (make-symbol "table")) |
3276 | (old-buffer (make-symbol "buffer"))) | |
3277 | `(let ((,old-case-table (current-case-table)) | |
3278 | (,old-buffer (current-buffer))) | |
3279 | (unwind-protect | |
3280 | (progn (set-case-table ,table) | |
3281 | ,@body) | |
3282 | (with-current-buffer ,old-buffer | |
3283 | (set-case-table ,old-case-table)))))) | |
c4f484f2 | 3284 | \f |
c4f484f2 | 3285 | ;;; Matching and match data. |
2493767e | 3286 | |
c7ca41e6 RS |
3287 | (defvar save-match-data-internal) |
3288 | ||
3289 | ;; We use save-match-data-internal as the local variable because | |
3290 | ;; that works ok in practice (people should not use that variable elsewhere). | |
3291 | ;; We used to use an uninterned symbol; the compiler handles that properly | |
3292 | ;; now, but it generates slower code. | |
9a5336ae | 3293 | (defmacro save-match-data (&rest body) |
e4d03691 JB |
3294 | "Execute the BODY forms, restoring the global value of the match data. |
3295 | The value returned is the value of the last form in BODY." | |
64ed733a PE |
3296 | ;; It is better not to use backquote here, |
3297 | ;; because that makes a bootstrapping problem | |
3298 | ;; if you need to recompile all the Lisp files using interpreted code. | |
d47f7515 | 3299 | (declare (indent 0) (debug t)) |
64ed733a PE |
3300 | (list 'let |
3301 | '((save-match-data-internal (match-data))) | |
3302 | (list 'unwind-protect | |
3303 | (cons 'progn body) | |
d1fab151 KS |
3304 | ;; It is safe to free (evaporate) markers immediately here, |
3305 | ;; as Lisp programs should not copy from save-match-data-internal. | |
a0ef72df | 3306 | '(set-match-data save-match-data-internal 'evaporate)))) |
993713ce | 3307 | |
cd323f89 | 3308 | (defun match-string (num &optional string) |
993713ce SM |
3309 | "Return string of text matched by last search. |
3310 | NUM specifies which parenthesized expression in the last regexp. | |
3311 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
3312 | Zero means the entire text matched by the whole regexp or whole string. | |
91054f8f LMI |
3313 | STRING should be given if the last search was by `string-match' on STRING. |
3314 | If STRING is nil, the current buffer should be the same buffer | |
3315 | the search/match was performed in." | |
cd323f89 SM |
3316 | (if (match-beginning num) |
3317 | (if string | |
3318 | (substring string (match-beginning num) (match-end num)) | |
3319 | (buffer-substring (match-beginning num) (match-end num))))) | |
58f950b4 | 3320 | |
bb760c71 RS |
3321 | (defun match-string-no-properties (num &optional string) |
3322 | "Return string of text matched by last search, without text properties. | |
3323 | NUM specifies which parenthesized expression in the last regexp. | |
3324 | Value is nil if NUMth pair didn't match, or there were less than NUM pairs. | |
3325 | Zero means the entire text matched by the whole regexp or whole string. | |
91054f8f LMI |
3326 | STRING should be given if the last search was by `string-match' on STRING. |
3327 | If STRING is nil, the current buffer should be the same buffer | |
3328 | the search/match was performed in." | |
bb760c71 RS |
3329 | (if (match-beginning num) |
3330 | (if string | |
6b61353c KH |
3331 | (substring-no-properties string (match-beginning num) |
3332 | (match-end num)) | |
bb760c71 RS |
3333 | (buffer-substring-no-properties (match-beginning num) |
3334 | (match-end num))))) | |
3335 | ||
8c2e721a JL |
3336 | |
3337 | (defun match-substitute-replacement (replacement | |
3338 | &optional fixedcase literal string subexp) | |
3339 | "Return REPLACEMENT as it will be inserted by `replace-match'. | |
3340 | In other words, all back-references in the form `\\&' and `\\N' | |
3341 | are substituted with actual strings matched by the last search. | |
3342 | Optional FIXEDCASE, LITERAL, STRING and SUBEXP have the same | |
3343 | meaning as for `replace-match'." | |
3344 | (let ((match (match-string 0 string))) | |
3345 | (save-match-data | |
3346 | (set-match-data (mapcar (lambda (x) | |
3347 | (if (numberp x) | |
3348 | (- x (match-beginning 0)) | |
3349 | x)) | |
3350 | (match-data t))) | |
3351 | (replace-match replacement fixedcase literal match subexp)))) | |
3352 | ||
3353 | ||
46065dd4 | 3354 | (defun looking-back (regexp &optional limit greedy) |
f30e0cd8 | 3355 | "Return non-nil if text before point matches regular expression REGEXP. |
991b32c3 | 3356 | Like `looking-at' except matches before point, and is slower. |
01d16e16 RS |
3357 | LIMIT if non-nil speeds up the search by specifying a minimum |
3358 | starting position, to avoid checking matches that would start | |
3359 | before LIMIT. | |
46065dd4 | 3360 | |
cde27dd2 CY |
3361 | If GREEDY is non-nil, extend the match backwards as far as |
3362 | possible, stopping when a single additional previous character | |
3363 | cannot be part of a match for REGEXP. When the match is | |
3dcde186 | 3364 | extended, its starting position is allowed to occur before |
cde27dd2 | 3365 | LIMIT." |
46065dd4 RS |
3366 | (let ((start (point)) |
3367 | (pos | |
3368 | (save-excursion | |
3369 | (and (re-search-backward (concat "\\(?:" regexp "\\)\\=") limit t) | |
3370 | (point))))) | |
3371 | (if (and greedy pos) | |
3372 | (save-restriction | |
3373 | (narrow-to-region (point-min) start) | |
3374 | (while (and (> pos (point-min)) | |
3375 | (save-excursion | |
3376 | (goto-char pos) | |
3377 | (backward-char 1) | |
3378 | (looking-at (concat "\\(?:" regexp "\\)\\'")))) | |
3379 | (setq pos (1- pos))) | |
3380 | (save-excursion | |
3381 | (goto-char pos) | |
3382 | (looking-at (concat "\\(?:" regexp "\\)\\'"))))) | |
3383 | (not (null pos)))) | |
3384 | ||
45595a4f RS |
3385 | (defsubst looking-at-p (regexp) |
3386 | "\ | |
3387 | Same as `looking-at' except this function does not change the match data." | |
3388 | (let ((inhibit-changing-match-data t)) | |
3389 | (looking-at regexp))) | |
3390 | ||
3391 | (defsubst string-match-p (regexp string &optional start) | |
3392 | "\ | |
3393 | Same as `string-match' except this function does not change the match data." | |
3394 | (let ((inhibit-changing-match-data t)) | |
3395 | (string-match regexp string start))) | |
3396 | ||
c4f484f2 RS |
3397 | (defun subregexp-context-p (regexp pos &optional start) |
3398 | "Return non-nil if POS is in a normal subregexp context in REGEXP. | |
3399 | A subregexp context is one where a sub-regexp can appear. | |
3400 | A non-subregexp context is for example within brackets, or within a | |
3401 | repetition bounds operator `\\=\\{...\\}', or right after a `\\'. | |
3402 | If START is non-nil, it should be a position in REGEXP, smaller | |
3403 | than POS, and known to be in a subregexp context." | |
3404 | ;; Here's one possible implementation, with the great benefit that it | |
3405 | ;; reuses the regexp-matcher's own parser, so it understands all the | |
3406 | ;; details of the syntax. A disadvantage is that it needs to match the | |
3407 | ;; error string. | |
3408 | (condition-case err | |
3409 | (progn | |
3410 | (string-match (substring regexp (or start 0) pos) "") | |
3411 | t) | |
3412 | (invalid-regexp | |
3413 | (not (member (cadr err) '("Unmatched [ or [^" | |
3414 | "Unmatched \\{" | |
3415 | "Trailing backslash"))))) | |
3416 | ;; An alternative implementation: | |
3417 | ;; (defconst re-context-re | |
3418 | ;; (let* ((harmless-ch "[^\\[]") | |
3419 | ;; (harmless-esc "\\\\[^{]") | |
3420 | ;; (class-harmless-ch "[^][]") | |
3421 | ;; (class-lb-harmless "[^]:]") | |
3422 | ;; (class-lb-colon-maybe-charclass ":\\([a-z]+:]\\)?") | |
3423 | ;; (class-lb (concat "\\[\\(" class-lb-harmless | |
3424 | ;; "\\|" class-lb-colon-maybe-charclass "\\)")) | |
3425 | ;; (class | |
3426 | ;; (concat "\\[^?]?" | |
3427 | ;; "\\(" class-harmless-ch | |
3428 | ;; "\\|" class-lb "\\)*" | |
3429 | ;; "\\[?]")) ; special handling for bare [ at end of re | |
3430 | ;; (braces "\\\\{[0-9,]+\\\\}")) | |
3431 | ;; (concat "\\`\\(" harmless-ch "\\|" harmless-esc | |
3432 | ;; "\\|" class "\\|" braces "\\)*\\'")) | |
3433 | ;; "Matches any prefix that corresponds to a normal subregexp context.") | |
3434 | ;; (string-match re-context-re (substring regexp (or start 0) pos)) | |
3435 | ) | |
3436 | \f | |
3437 | ;;;; split-string | |
498535fb | 3438 | |
6a646626 JB |
3439 | (defconst split-string-default-separators "[ \f\t\n\r\v]+" |
3440 | "The default value of separators for `split-string'. | |
3441 | ||
3442 | A regexp matching strings of whitespace. May be locale-dependent | |
3443 | \(as yet unimplemented). Should not match non-breaking spaces. | |
3444 | ||
3445 | Warning: binding this to a different value and using it as default is | |
3446 | likely to have undesired semantics.") | |
3447 | ||
3448 | ;; The specification says that if both SEPARATORS and OMIT-NULLS are | |
3449 | ;; defaulted, OMIT-NULLS should be treated as t. Simplifying the logical | |
3450 | ;; expression leads to the equivalent implementation that if SEPARATORS | |
3451 | ;; is defaulted, OMIT-NULLS is treated as t. | |
3452 | (defun split-string (string &optional separators omit-nulls) | |
203998e5 | 3453 | "Split STRING into substrings bounded by matches for SEPARATORS. |
6a646626 JB |
3454 | |
3455 | The beginning and end of STRING, and each match for SEPARATORS, are | |
3456 | splitting points. The substrings matching SEPARATORS are removed, and | |
3457 | the substrings between the splitting points are collected as a list, | |
edce3654 | 3458 | which is returned. |
b222b786 | 3459 | |
6a646626 JB |
3460 | If SEPARATORS is non-nil, it should be a regular expression matching text |
3461 | which separates, but is not part of, the substrings. If nil it defaults to | |
3462 | `split-string-default-separators', normally \"[ \\f\\t\\n\\r\\v]+\", and | |
3463 | OMIT-NULLS is forced to t. | |
3464 | ||
a478f3e1 | 3465 | If OMIT-NULLS is t, zero-length substrings are omitted from the list \(so |
6a646626 JB |
3466 | that for the default value of SEPARATORS leading and trailing whitespace |
3467 | are effectively trimmed). If nil, all zero-length substrings are retained, | |
3468 | which correctly parses CSV format, for example. | |
3469 | ||
3470 | Note that the effect of `(split-string STRING)' is the same as | |
55e45419 | 3471 | `(split-string STRING split-string-default-separators t)'. In the rare |
6a646626 JB |
3472 | case that you wish to retain zero-length substrings when splitting on |
3473 | whitespace, use `(split-string STRING split-string-default-separators)'. | |
b021ef18 DL |
3474 | |
3475 | Modifies the match data; use `save-match-data' if necessary." | |
6a646626 JB |
3476 | (let ((keep-nulls (not (if separators omit-nulls t))) |
3477 | (rexp (or separators split-string-default-separators)) | |
edce3654 | 3478 | (start 0) |
b222b786 | 3479 | notfirst |
edce3654 | 3480 | (list nil)) |
b222b786 RS |
3481 | (while (and (string-match rexp string |
3482 | (if (and notfirst | |
3483 | (= start (match-beginning 0)) | |
3484 | (< start (length string))) | |
3485 | (1+ start) start)) | |
6a646626 | 3486 | (< start (length string))) |
b222b786 | 3487 | (setq notfirst t) |
6a646626 | 3488 | (if (or keep-nulls (< start (match-beginning 0))) |
edce3654 RS |
3489 | (setq list |
3490 | (cons (substring string start (match-beginning 0)) | |
3491 | list))) | |
3492 | (setq start (match-end 0))) | |
6a646626 | 3493 | (if (or keep-nulls (< start (length string))) |
edce3654 RS |
3494 | (setq list |
3495 | (cons (substring string start) | |
3496 | list))) | |
3497 | (nreverse list))) | |
0b93ff3a | 3498 | |
e80b3849 | 3499 | (defun combine-and-quote-strings (strings &optional separator) |
0b93ff3a NR |
3500 | "Concatenate the STRINGS, adding the SEPARATOR (default \" \"). |
3501 | This tries to quote the strings to avoid ambiguity such that | |
e80b3849 | 3502 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs |
0b93ff3a | 3503 | Only some SEPARATORs will work properly." |
9f2bd2e7 SM |
3504 | (let* ((sep (or separator " ")) |
3505 | (re (concat "[\\\"]" "\\|" (regexp-quote sep)))) | |
0b93ff3a NR |
3506 | (mapconcat |
3507 | (lambda (str) | |
9f2bd2e7 | 3508 | (if (string-match re str) |
0b93ff3a NR |
3509 | (concat "\"" (replace-regexp-in-string "[\\\"]" "\\\\\\&" str) "\"") |
3510 | str)) | |
3511 | strings sep))) | |
3512 | ||
e80b3849 | 3513 | (defun split-string-and-unquote (string &optional separator) |
0b93ff3a | 3514 | "Split the STRING into a list of strings. |
e80b3849 RS |
3515 | It understands Emacs Lisp quoting within STRING, such that |
3516 | (split-string-and-unquote (combine-and-quote-strings strs)) == strs | |
0b93ff3a NR |
3517 | The SEPARATOR regexp defaults to \"\\s-+\"." |
3518 | (let ((sep (or separator "\\s-+")) | |
d551d20d | 3519 | (i (string-match "\"" string))) |
e80b3849 RS |
3520 | (if (null i) |
3521 | (split-string string sep t) ; no quoting: easy | |
0b93ff3a NR |
3522 | (append (unless (eq i 0) (split-string (substring string 0 i) sep t)) |
3523 | (let ((rfs (read-from-string string i))) | |
3524 | (cons (car rfs) | |
e80b3849 RS |
3525 | (split-string-and-unquote (substring string (cdr rfs)) |
3526 | sep))))))) | |
0b93ff3a | 3527 | |
c4f484f2 RS |
3528 | \f |
3529 | ;;;; Replacement in strings. | |
1ccaea52 AI |
3530 | |
3531 | (defun subst-char-in-string (fromchar tochar string &optional inplace) | |
3532 | "Replace FROMCHAR with TOCHAR in STRING each time it occurs. | |
3533 | Unless optional argument INPLACE is non-nil, return a new string." | |
e6e71807 SM |
3534 | (let ((i (length string)) |
3535 | (newstr (if inplace string (copy-sequence string)))) | |
3536 | (while (> i 0) | |
3537 | (setq i (1- i)) | |
3538 | (if (eq (aref newstr i) fromchar) | |
3539 | (aset newstr i tochar))) | |
3540 | newstr)) | |
b021ef18 | 3541 | |
1697159c | 3542 | (defun replace-regexp-in-string (regexp rep string &optional |
c8227332 | 3543 | fixedcase literal subexp start) |
b021ef18 DL |
3544 | "Replace all matches for REGEXP with REP in STRING. |
3545 | ||
3546 | Return a new string containing the replacements. | |
3547 | ||
3548 | Optional arguments FIXEDCASE, LITERAL and SUBEXP are like the | |
3549 | arguments with the same names of function `replace-match'. If START | |
3550 | is non-nil, start replacements at that index in STRING. | |
3551 | ||
3552 | REP is either a string used as the NEWTEXT arg of `replace-match' or a | |
23bb94bb RS |
3553 | function. If it is a function, it is called with the actual text of each |
3554 | match, and its value is used as the replacement text. When REP is called, | |
3fa173b4 | 3555 | the match data are the result of matching REGEXP against a substring |
23bb94bb | 3556 | of STRING. |
b021ef18 | 3557 | |
1697159c DL |
3558 | To replace only the first match (if any), make REGEXP match up to \\' |
3559 | and replace a sub-expression, e.g. | |
c9bcb507 | 3560 | (replace-regexp-in-string \"\\\\(foo\\\\).*\\\\'\" \"bar\" \" foo foo\" nil nil 1) |
1697159c DL |
3561 | => \" bar foo\" |
3562 | " | |
b021ef18 DL |
3563 | |
3564 | ;; To avoid excessive consing from multiple matches in long strings, | |
3565 | ;; don't just call `replace-match' continually. Walk down the | |
3566 | ;; string looking for matches of REGEXP and building up a (reversed) | |
3567 | ;; list MATCHES. This comprises segments of STRING which weren't | |
3568 | ;; matched interspersed with replacements for segments that were. | |
08b1f8a1 | 3569 | ;; [For a `large' number of replacements it's more efficient to |
b021ef18 DL |
3570 | ;; operate in a temporary buffer; we can't tell from the function's |
3571 | ;; args whether to choose the buffer-based implementation, though it | |
3572 | ;; might be reasonable to do so for long enough STRING.] | |
3573 | (let ((l (length string)) | |
3574 | (start (or start 0)) | |
3575 | matches str mb me) | |
3576 | (save-match-data | |
3577 | (while (and (< start l) (string-match regexp string start)) | |
3578 | (setq mb (match-beginning 0) | |
3579 | me (match-end 0)) | |
a9853251 SM |
3580 | ;; If we matched the empty string, make sure we advance by one char |
3581 | (when (= me mb) (setq me (min l (1+ mb)))) | |
3582 | ;; Generate a replacement for the matched substring. | |
3583 | ;; Operate only on the substring to minimize string consing. | |
3584 | ;; Set up match data for the substring for replacement; | |
3585 | ;; presumably this is likely to be faster than munging the | |
3586 | ;; match data directly in Lisp. | |
3587 | (string-match regexp (setq str (substring string mb me))) | |
3588 | (setq matches | |
3589 | (cons (replace-match (if (stringp rep) | |
3590 | rep | |
3591 | (funcall rep (match-string 0 str))) | |
3592 | fixedcase literal str subexp) | |
c8227332 | 3593 | (cons (substring string start mb) ; unmatched prefix |
a9853251 SM |
3594 | matches))) |
3595 | (setq start me)) | |
b021ef18 DL |
3596 | ;; Reconstruct a string from the pieces. |
3597 | (setq matches (cons (substring string start l) matches)) ; leftover | |
3598 | (apply #'concat (nreverse matches))))) | |
a7ed4c2a | 3599 | \f |
cb190d7d SM |
3600 | (defun string-prefix-p (str1 str2 &optional ignore-case) |
3601 | "Return non-nil if STR1 is a prefix of STR2. | |
3602 | If IGNORE-CASE is non-nil, the comparison is done without paying attention | |
3603 | to case differences." | |
3604 | (eq t (compare-strings str1 nil nil | |
3605 | str2 0 (length str1) ignore-case))) | |
3e26a4a2 | 3606 | |
f635daa1 | 3607 | (defun bidi-string-mark-left-to-right (str) |
9ccaaa4b | 3608 | "Return a string that can be safely inserted in left-to-right text. |
9ccaaa4b | 3609 | |
f635daa1 CY |
3610 | Normally, inserting a string with right-to-left (RTL) script into |
3611 | a buffer may cause some subsequent text to be displayed as part | |
3612 | of the RTL segment (usually this affects punctuation characters). | |
3613 | This function returns a string which displays as STR but forces | |
3614 | subsequent text to be displayed as left-to-right. | |
9ccaaa4b | 3615 | |
f635daa1 CY |
3616 | If STR contains any RTL character, this function returns a string |
3617 | consisting of STR followed by an invisible left-to-right mark | |
3618 | \(LRM) character. Otherwise, it returns STR." | |
3e26a4a2 CY |
3619 | (unless (stringp str) |
3620 | (signal 'wrong-type-argument (list 'stringp str))) | |
f635daa1 CY |
3621 | (if (string-match "\\cR" str) |
3622 | (concat str (propertize (string ?\x200e) 'invisible t)) | |
3623 | str)) | |
cb190d7d | 3624 | \f |
c4f484f2 | 3625 | ;;;; invisibility specs |
df8e73e1 | 3626 | |
c4f484f2 RS |
3627 | (defun add-to-invisibility-spec (element) |
3628 | "Add ELEMENT to `buffer-invisibility-spec'. | |
3629 | See documentation for `buffer-invisibility-spec' for the kind of elements | |
3630 | that can be added." | |
3631 | (if (eq buffer-invisibility-spec t) | |
3632 | (setq buffer-invisibility-spec (list t))) | |
3633 | (setq buffer-invisibility-spec | |
3634 | (cons element buffer-invisibility-spec))) | |
3635 | ||
3636 | (defun remove-from-invisibility-spec (element) | |
3637 | "Remove ELEMENT from `buffer-invisibility-spec'." | |
3638 | (if (consp buffer-invisibility-spec) | |
c8227332 VJL |
3639 | (setq buffer-invisibility-spec |
3640 | (delete element buffer-invisibility-spec)))) | |
a7ed4c2a | 3641 | \f |
c4f484f2 RS |
3642 | ;;;; Syntax tables. |
3643 | ||
3644 | (defmacro with-syntax-table (table &rest body) | |
3645 | "Evaluate BODY with syntax table of current buffer set to TABLE. | |
3646 | The syntax table of the current buffer is saved, BODY is evaluated, and the | |
3647 | saved table is restored, even in case of an abnormal exit. | |
3648 | Value is what BODY returns." | |
f291fe60 | 3649 | (declare (debug t) (indent 1)) |
c4f484f2 RS |
3650 | (let ((old-table (make-symbol "table")) |
3651 | (old-buffer (make-symbol "buffer"))) | |
3652 | `(let ((,old-table (syntax-table)) | |
3653 | (,old-buffer (current-buffer))) | |
3654 | (unwind-protect | |
3655 | (progn | |
3656 | (set-syntax-table ,table) | |
3657 | ,@body) | |
3658 | (save-current-buffer | |
3659 | (set-buffer ,old-buffer) | |
3660 | (set-syntax-table ,old-table)))))) | |
8af7df60 | 3661 | |
297d863b | 3662 | (defun make-syntax-table (&optional oldtable) |
984f718a | 3663 | "Return a new syntax table. |
0764e16f SM |
3664 | Create a syntax table which inherits from OLDTABLE (if non-nil) or |
3665 | from `standard-syntax-table' otherwise." | |
3666 | (let ((table (make-char-table 'syntax-table nil))) | |
3667 | (set-char-table-parent table (or oldtable (standard-syntax-table))) | |
3668 | table)) | |
31aa282e | 3669 | |
e9f13a95 | 3670 | (defun syntax-after (pos) |
9d1ffd5a EZ |
3671 | "Return the raw syntax of the char after POS. |
3672 | If POS is outside the buffer's accessible portion, return nil." | |
e9f13a95 | 3673 | (unless (or (< pos (point-min)) (>= pos (point-max))) |
d8ac3d27 SM |
3674 | (let ((st (if parse-sexp-lookup-properties |
3675 | (get-char-property pos 'syntax-table)))) | |
3676 | (if (consp st) st | |
3677 | (aref (or st (syntax-table)) (char-after pos)))))) | |
e9f13a95 | 3678 | |
cdd8dc28 | 3679 | (defun syntax-class (syntax) |
9d1ffd5a EZ |
3680 | "Return the syntax class part of the syntax descriptor SYNTAX. |
3681 | If SYNTAX is nil, return nil." | |
3682 | (and syntax (logand (car syntax) 65535))) | |
2493767e | 3683 | \f |
c4f484f2 | 3684 | ;;;; Text clones |
a13fe4c5 | 3685 | |
06b60517 | 3686 | (defun text-clone-maintain (ol1 after beg end &optional _len) |
a13fe4c5 SM |
3687 | "Propagate the changes made under the overlay OL1 to the other clones. |
3688 | This is used on the `modification-hooks' property of text clones." | |
3689 | (when (and after (not undo-in-progress) (overlay-start ol1)) | |
3690 | (let ((margin (if (overlay-get ol1 'text-clone-spreadp) 1 0))) | |
3691 | (setq beg (max beg (+ (overlay-start ol1) margin))) | |
3692 | (setq end (min end (- (overlay-end ol1) margin))) | |
3693 | (when (<= beg end) | |
3694 | (save-excursion | |
3695 | (when (overlay-get ol1 'text-clone-syntax) | |
3696 | ;; Check content of the clone's text. | |
3697 | (let ((cbeg (+ (overlay-start ol1) margin)) | |
3698 | (cend (- (overlay-end ol1) margin))) | |
3699 | (goto-char cbeg) | |
3700 | (save-match-data | |
3701 | (if (not (re-search-forward | |
3702 | (overlay-get ol1 'text-clone-syntax) cend t)) | |
3703 | ;; Mark the overlay for deletion. | |
3704 | (overlay-put ol1 'text-clones nil) | |
3705 | (when (< (match-end 0) cend) | |
3706 | ;; Shrink the clone at its end. | |
3707 | (setq end (min end (match-end 0))) | |
3708 | (move-overlay ol1 (overlay-start ol1) | |
3709 | (+ (match-end 0) margin))) | |
3710 | (when (> (match-beginning 0) cbeg) | |
3711 | ;; Shrink the clone at its beginning. | |
3712 | (setq beg (max (match-beginning 0) beg)) | |
3713 | (move-overlay ol1 (- (match-beginning 0) margin) | |
3714 | (overlay-end ol1))))))) | |
3715 | ;; Now go ahead and update the clones. | |
3716 | (let ((head (- beg (overlay-start ol1))) | |
3717 | (tail (- (overlay-end ol1) end)) | |
3718 | (str (buffer-substring beg end)) | |
3719 | (nothing-left t) | |
3720 | (inhibit-modification-hooks t)) | |
3721 | (dolist (ol2 (overlay-get ol1 'text-clones)) | |
3722 | (let ((oe (overlay-end ol2))) | |
3723 | (unless (or (eq ol1 ol2) (null oe)) | |
3724 | (setq nothing-left nil) | |
3725 | (let ((mod-beg (+ (overlay-start ol2) head))) | |
3726 | ;;(overlay-put ol2 'modification-hooks nil) | |
3727 | (goto-char (- (overlay-end ol2) tail)) | |
3728 | (unless (> mod-beg (point)) | |
3729 | (save-excursion (insert str)) | |
3730 | (delete-region mod-beg (point))) | |
3731 | ;;(overlay-put ol2 'modification-hooks '(text-clone-maintain)) | |
3732 | )))) | |
3733 | (if nothing-left (delete-overlay ol1)))))))) | |
3734 | ||
3735 | (defun text-clone-create (start end &optional spreadp syntax) | |
3736 | "Create a text clone of START...END at point. | |
3737 | Text clones are chunks of text that are automatically kept identical: | |
3738 | changes done to one of the clones will be immediately propagated to the other. | |
3739 | ||
3740 | The buffer's content at point is assumed to be already identical to | |
3741 | the one between START and END. | |
3742 | If SYNTAX is provided it's a regexp that describes the possible text of | |
3743 | the clones; the clone will be shrunk or killed if necessary to ensure that | |
3744 | its text matches the regexp. | |
3745 | If SPREADP is non-nil it indicates that text inserted before/after the | |
3746 | clone should be incorporated in the clone." | |
3747 | ;; To deal with SPREADP we can either use an overlay with `nil t' along | |
3748 | ;; with insert-(behind|in-front-of)-hooks or use a slightly larger overlay | |
3749 | ;; (with a one-char margin at each end) with `t nil'. | |
3750 | ;; We opted for a larger overlay because it behaves better in the case | |
3751 | ;; where the clone is reduced to the empty string (we want the overlay to | |
3752 | ;; stay when the clone's content is the empty string and we want to use | |
3753 | ;; `evaporate' to make sure those overlays get deleted when needed). | |
264ef586 | 3754 | ;; |
a13fe4c5 SM |
3755 | (let* ((pt-end (+ (point) (- end start))) |
3756 | (start-margin (if (or (not spreadp) (bobp) (<= start (point-min))) | |
3757 | 0 1)) | |
3758 | (end-margin (if (or (not spreadp) | |
3759 | (>= pt-end (point-max)) | |
3760 | (>= start (point-max))) | |
3761 | 0 1)) | |
3762 | (ol1 (make-overlay (- start start-margin) (+ end end-margin) nil t)) | |
3763 | (ol2 (make-overlay (- (point) start-margin) (+ pt-end end-margin) nil t)) | |
3764 | (dups (list ol1 ol2))) | |
3765 | (overlay-put ol1 'modification-hooks '(text-clone-maintain)) | |
3766 | (when spreadp (overlay-put ol1 'text-clone-spreadp t)) | |
3767 | (when syntax (overlay-put ol1 'text-clone-syntax syntax)) | |
3768 | ;;(overlay-put ol1 'face 'underline) | |
3769 | (overlay-put ol1 'evaporate t) | |
3770 | (overlay-put ol1 'text-clones dups) | |
264ef586 | 3771 | ;; |
a13fe4c5 SM |
3772 | (overlay-put ol2 'modification-hooks '(text-clone-maintain)) |
3773 | (when spreadp (overlay-put ol2 'text-clone-spreadp t)) | |
3774 | (when syntax (overlay-put ol2 'text-clone-syntax syntax)) | |
3775 | ;;(overlay-put ol2 'face 'underline) | |
3776 | (overlay-put ol2 'evaporate t) | |
3777 | (overlay-put ol2 'text-clones dups))) | |
c4f484f2 RS |
3778 | \f |
3779 | ;;;; Mail user agents. | |
27c079eb | 3780 | |
c4f484f2 RS |
3781 | ;; Here we include just enough for other packages to be able |
3782 | ;; to define them. | |
324cd947 | 3783 | |
27c079eb SM |
3784 | (defun define-mail-user-agent (symbol composefunc sendfunc |
3785 | &optional abortfunc hookvar) | |
3786 | "Define a symbol to identify a mail-sending package for `mail-user-agent'. | |
3787 | ||
3788 | SYMBOL can be any Lisp symbol. Its function definition and/or | |
3789 | value as a variable do not matter for this usage; we use only certain | |
3790 | properties on its property list, to encode the rest of the arguments. | |
3791 | ||
3792 | COMPOSEFUNC is program callable function that composes an outgoing | |
3793 | mail message buffer. This function should set up the basics of the | |
3794 | buffer without requiring user interaction. It should populate the | |
3795 | standard mail headers, leaving the `to:' and `subject:' headers blank | |
3796 | by default. | |
3797 | ||
3798 | COMPOSEFUNC should accept several optional arguments--the same | |
3799 | arguments that `compose-mail' takes. See that function's documentation. | |
3800 | ||
3801 | SENDFUNC is the command a user would run to send the message. | |
3802 | ||
3803 | Optional ABORTFUNC is the command a user would run to abort the | |
3804 | message. For mail packages that don't have a separate abort function, | |
3805 | this can be `kill-buffer' (the equivalent of omitting this argument). | |
3806 | ||
3807 | Optional HOOKVAR is a hook variable that gets run before the message | |
3808 | is actually sent. Callers that use the `mail-user-agent' may | |
3809 | install a hook function temporarily on this hook variable. | |
3810 | If HOOKVAR is nil, `mail-send-hook' is used. | |
3811 | ||
3812 | The properties used on SYMBOL are `composefunc', `sendfunc', | |
3813 | `abortfunc', and `hookvar'." | |
3814 | (put symbol 'composefunc composefunc) | |
3815 | (put symbol 'sendfunc sendfunc) | |
3816 | (put symbol 'abortfunc (or abortfunc 'kill-buffer)) | |
3817 | (put symbol 'hookvar (or hookvar 'mail-send-hook))) | |
c4f484f2 RS |
3818 | \f |
3819 | ;;;; Progress reporters. | |
b4329caa EZ |
3820 | |
3821 | ;; Progress reporter has the following structure: | |
3822 | ;; | |
3823 | ;; (NEXT-UPDATE-VALUE . [NEXT-UPDATE-TIME | |
3824 | ;; MIN-VALUE | |
3825 | ;; MAX-VALUE | |
3826 | ;; MESSAGE | |
3827 | ;; MIN-CHANGE | |
3828 | ;; MIN-TIME]) | |
3829 | ;; | |
ee7683eb | 3830 | ;; This weirdness is for optimization reasons: we want |
b4329caa EZ |
3831 | ;; `progress-reporter-update' to be as fast as possible, so |
3832 | ;; `(car reporter)' is better than `(aref reporter 0)'. | |
3833 | ;; | |
3834 | ;; NEXT-UPDATE-TIME is a float. While `float-time' loses a couple | |
3835 | ;; digits of precision, it doesn't really matter here. On the other | |
3836 | ;; hand, it greatly simplifies the code. | |
3837 | ||
9326ba26 | 3838 | (defsubst progress-reporter-update (reporter &optional value) |
c85152fc | 3839 | "Report progress of an operation in the echo area. |
9326ba26 CY |
3840 | REPORTER should be the result of a call to `make-progress-reporter'. |
3841 | ||
3842 | If REPORTER is a numerical progress reporter---i.e. if it was | |
3843 | made using non-nil MIN-VALUE and MAX-VALUE arguments to | |
3844 | `make-progress-reporter'---then VALUE should be a number between | |
3845 | MIN-VALUE and MAX-VALUE. | |
c85152fc | 3846 | |
9326ba26 | 3847 | If REPORTER is a non-numerical reporter, VALUE should be nil. |
b4329caa | 3848 | |
9326ba26 CY |
3849 | This function is relatively inexpensive. If the change since |
3850 | last update is too small or insufficient time has passed, it does | |
3851 | nothing." | |
3852 | (when (or (not (numberp value)) ; For pulsing reporter | |
3853 | (>= value (car reporter))) ; For numerical reporter | |
3854 | (progress-reporter-do-update reporter value))) | |
3855 | ||
3856 | (defun make-progress-reporter (message &optional min-value max-value | |
3857 | current-value min-change min-time) | |
3858 | "Return progress reporter object for use with `progress-reporter-update'. | |
3859 | ||
3860 | MESSAGE is shown in the echo area, with a status indicator | |
3861 | appended to the end. When you call `progress-reporter-done', the | |
3862 | word \"done\" is printed after the MESSAGE. You can change the | |
3863 | MESSAGE of an existing progress reporter by calling | |
3864 | `progress-reporter-force-update'. | |
3865 | ||
3866 | MIN-VALUE and MAX-VALUE, if non-nil, are starting (0% complete) | |
3867 | and final (100% complete) states of operation; the latter should | |
3868 | be larger. In this case, the status message shows the percentage | |
3869 | progress. | |
3870 | ||
3871 | If MIN-VALUE and/or MAX-VALUE is omitted or nil, the status | |
3872 | message shows a \"spinning\", non-numeric indicator. | |
3873 | ||
3874 | Optional CURRENT-VALUE is the initial progress; the default is | |
3875 | MIN-VALUE. | |
3876 | Optional MIN-CHANGE is the minimal change in percents to report; | |
3877 | the default is 1%. | |
3878 | CURRENT-VALUE and MIN-CHANGE do not have any effect if MIN-VALUE | |
3879 | and/or MAX-VALUE are nil. | |
3880 | ||
3881 | Optional MIN-TIME specifies the minimum interval time between | |
3882 | echo area updates (default is 0.2 seconds.) If the function | |
3883 | `float-time' is not present, time is not tracked at all. If the | |
3884 | OS is not capable of measuring fractions of seconds, this | |
3885 | parameter is effectively rounded up." | |
ea9fafe0 SM |
3886 | (when (string-match "[[:alnum:]]\\'" message) |
3887 | (setq message (concat message "..."))) | |
b4329caa EZ |
3888 | (unless min-time |
3889 | (setq min-time 0.2)) | |
3890 | (let ((reporter | |
9326ba26 CY |
3891 | ;; Force a call to `message' now |
3892 | (cons (or min-value 0) | |
b4329caa EZ |
3893 | (vector (if (and (fboundp 'float-time) |
3894 | (>= min-time 0.02)) | |
3895 | (float-time) nil) | |
3896 | min-value | |
3897 | max-value | |
3898 | message | |
3899 | (if min-change (max (min min-change 50) 1) 1) | |
3900 | min-time)))) | |
3901 | (progress-reporter-update reporter (or current-value min-value)) | |
3902 | reporter)) | |
3903 | ||
9326ba26 | 3904 | (defun progress-reporter-force-update (reporter &optional value new-message) |
b4329caa EZ |
3905 | "Report progress of an operation in the echo area unconditionally. |
3906 | ||
9326ba26 CY |
3907 | The first two arguments are the same as in `progress-reporter-update'. |
3908 | NEW-MESSAGE, if non-nil, sets a new message for the reporter." | |
b4329caa EZ |
3909 | (let ((parameters (cdr reporter))) |
3910 | (when new-message | |
3911 | (aset parameters 3 new-message)) | |
3912 | (when (aref parameters 0) | |
3913 | (aset parameters 0 (float-time))) | |
3914 | (progress-reporter-do-update reporter value))) | |
3915 | ||
9326ba26 CY |
3916 | (defvar progress-reporter--pulse-characters ["-" "\\" "|" "/"] |
3917 | "Characters to use for pulsing progress reporters.") | |
3918 | ||
b4329caa EZ |
3919 | (defun progress-reporter-do-update (reporter value) |
3920 | (let* ((parameters (cdr reporter)) | |
9326ba26 | 3921 | (update-time (aref parameters 0)) |
b4329caa EZ |
3922 | (min-value (aref parameters 1)) |
3923 | (max-value (aref parameters 2)) | |
9326ba26 | 3924 | (text (aref parameters 3)) |
b4329caa EZ |
3925 | (current-time (float-time)) |
3926 | (enough-time-passed | |
3927 | ;; See if enough time has passed since the last update. | |
3928 | (or (not update-time) | |
3929 | (when (>= current-time update-time) | |
3930 | ;; Calculate time for the next update | |
3931 | (aset parameters 0 (+ update-time (aref parameters 5))))))) | |
9326ba26 CY |
3932 | (cond ((and min-value max-value) |
3933 | ;; Numerical indicator | |
3934 | (let* ((one-percent (/ (- max-value min-value) 100.0)) | |
3935 | (percentage (if (= max-value min-value) | |
3936 | 0 | |
3937 | (truncate (/ (- value min-value) | |
3938 | one-percent))))) | |
3939 | ;; Calculate NEXT-UPDATE-VALUE. If we are not printing | |
3940 | ;; message because not enough time has passed, use 1 | |
3941 | ;; instead of MIN-CHANGE. This makes delays between echo | |
3942 | ;; area updates closer to MIN-TIME. | |
3943 | (setcar reporter | |
3944 | (min (+ min-value (* (+ percentage | |
3945 | (if enough-time-passed | |
3946 | ;; MIN-CHANGE | |
3947 | (aref parameters 4) | |
3948 | 1)) | |
3949 | one-percent)) | |
3950 | max-value)) | |
3951 | (when (integerp value) | |
3952 | (setcar reporter (ceiling (car reporter)))) | |
3953 | ;; Only print message if enough time has passed | |
3954 | (when enough-time-passed | |
3955 | (if (> percentage 0) | |
3956 | (message "%s%d%%" text percentage) | |
3957 | (message "%s" text))))) | |
3958 | ;; Pulsing indicator | |
3959 | (enough-time-passed | |
3960 | (let ((index (mod (1+ (car reporter)) 4)) | |
3961 | (message-log-max nil)) | |
3962 | (setcar reporter index) | |
3963 | (message "%s %s" | |
3964 | text | |
3965 | (aref progress-reporter--pulse-characters | |
3966 | index))))))) | |
b4329caa EZ |
3967 | |
3968 | (defun progress-reporter-done (reporter) | |
3969 | "Print reporter's message followed by word \"done\" in echo area." | |
3970 | (message "%sdone" (aref (cdr reporter) 3))) | |
3971 | ||
aa56124a SM |
3972 | (defmacro dotimes-with-progress-reporter (spec message &rest body) |
3973 | "Loop a certain number of times and report progress in the echo area. | |
3974 | Evaluate BODY with VAR bound to successive integers running from | |
3975 | 0, inclusive, to COUNT, exclusive. Then evaluate RESULT to get | |
3976 | the return value (nil if RESULT is omitted). | |
3977 | ||
3978 | At each iteration MESSAGE followed by progress percentage is | |
3979 | printed in the echo area. After the loop is finished, MESSAGE | |
3980 | followed by word \"done\" is printed. This macro is a | |
3981 | convenience wrapper around `make-progress-reporter' and friends. | |
3982 | ||
3983 | \(fn (VAR COUNT [RESULT]) MESSAGE BODY...)" | |
3984 | (declare (indent 2) (debug ((symbolp form &optional form) form body))) | |
3985 | (let ((temp (make-symbol "--dotimes-temp--")) | |
3986 | (temp2 (make-symbol "--dotimes-temp2--")) | |
3987 | (start 0) | |
3988 | (end (nth 1 spec))) | |
3989 | `(let ((,temp ,end) | |
3990 | (,(car spec) ,start) | |
3991 | (,temp2 (make-progress-reporter ,message ,start ,end))) | |
3992 | (while (< ,(car spec) ,temp) | |
3993 | ,@body | |
3994 | (progress-reporter-update ,temp2 | |
3995 | (setq ,(car spec) (1+ ,(car spec))))) | |
3996 | (progress-reporter-done ,temp2) | |
3997 | nil ,@(cdr (cdr spec))))) | |
ca548b00 | 3998 | |
e9454757 | 3999 | \f |
c4f484f2 | 4000 | ;;;; Comparing version strings. |
e9454757 | 4001 | |
2f7f4bee | 4002 | (defconst version-separator "." |
b29f5b7b | 4003 | "Specify the string used to separate the version elements. |
e9454757 VJL |
4004 | |
4005 | Usually the separator is \".\", but it can be any other string.") | |
4006 | ||
4007 | ||
2f7f4bee | 4008 | (defconst version-regexp-alist |
b29f5b7b VJL |
4009 | '(("^[-_+ ]?alpha$" . -3) |
4010 | ("^[-_+]$" . -3) ; treat "1.2.3-20050920" and "1.2-3" as alpha releases | |
4011 | ("^[-_+ ]cvs$" . -3) ; treat "1.2.3-CVS" as alpha release | |
4012 | ("^[-_+ ]?beta$" . -2) | |
e2046ecf | 4013 | ("^[-_+ ]?\\(pre\\|rcc\\)$" . -1)) |
b29f5b7b | 4014 | "Specify association between non-numeric version and its priority. |
e9454757 VJL |
4015 | |
4016 | This association is used to handle version string like \"1.0pre2\", | |
4017 | \"0.9alpha1\", etc. It's used by `version-to-list' (which see) to convert the | |
94785022 | 4018 | non-numeric part of a version string to an integer. For example: |
e9454757 VJL |
4019 | |
4020 | String Version Integer List Version | |
4021 | \"1.0pre2\" (1 0 -1 2) | |
4022 | \"1.0PRE2\" (1 0 -1 2) | |
4023 | \"22.8beta3\" (22 8 -2 3) | |
c71abb54 | 4024 | \"22.8 Beta3\" (22 8 -2 3) |
e9454757 VJL |
4025 | \"0.9alpha1\" (0 9 -3 1) |
4026 | \"0.9AlphA1\" (0 9 -3 1) | |
c71abb54 | 4027 | \"0.9 alpha\" (0 9 -3) |
e9454757 VJL |
4028 | |
4029 | Each element has the following form: | |
4030 | ||
4031 | (REGEXP . PRIORITY) | |
4032 | ||
4033 | Where: | |
4034 | ||
4035 | REGEXP regexp used to match non-numeric part of a version string. | |
94785022 | 4036 | It should begin with the `^' anchor and end with a `$' to |
d74a5c91 EZ |
4037 | prevent false hits. Letter-case is ignored while matching |
4038 | REGEXP. | |
e9454757 | 4039 | |
94785022 | 4040 | PRIORITY a negative integer specifying non-numeric priority of REGEXP.") |
e9454757 VJL |
4041 | |
4042 | ||
4043 | (defun version-to-list (ver) | |
94785022 | 4044 | "Convert version string VER into a list of integers. |
e9454757 VJL |
4045 | |
4046 | The version syntax is given by the following EBNF: | |
4047 | ||
4048 | VERSION ::= NUMBER ( SEPARATOR NUMBER )*. | |
4049 | ||
4050 | NUMBER ::= (0|1|2|3|4|5|6|7|8|9)+. | |
4051 | ||
4052 | SEPARATOR ::= `version-separator' (which see) | |
4053 | | `version-regexp-alist' (which see). | |
4054 | ||
d74a5c91 EZ |
4055 | The NUMBER part is optional if SEPARATOR is a match for an element |
4056 | in `version-regexp-alist'. | |
4057 | ||
94785022 | 4058 | Examples of valid version syntax: |
e9454757 | 4059 | |
d74a5c91 | 4060 | 1.0pre2 1.0.7.5 22.8beta3 0.9alpha1 6.9.30Beta |
e9454757 | 4061 | |
94785022 | 4062 | Examples of invalid version syntax: |
e9454757 VJL |
4063 | |
4064 | 1.0prepre2 1.0..7.5 22.8X3 alpha3.2 .5 | |
4065 | ||
94785022 | 4066 | Examples of version conversion: |
e9454757 | 4067 | |
94785022 | 4068 | Version String Version as a List of Integers |
e9454757 VJL |
4069 | \"1.0.7.5\" (1 0 7 5) |
4070 | \"1.0pre2\" (1 0 -1 2) | |
4071 | \"1.0PRE2\" (1 0 -1 2) | |
4072 | \"22.8beta3\" (22 8 -2 3) | |
4073 | \"22.8Beta3\" (22 8 -2 3) | |
4074 | \"0.9alpha1\" (0 9 -3 1) | |
4075 | \"0.9AlphA1\" (0 9 -3 1) | |
4076 | \"0.9alpha\" (0 9 -3) | |
4077 | ||
4078 | See documentation for `version-separator' and `version-regexp-alist'." | |
c71abb54 | 4079 | (or (and (stringp ver) (> (length ver) 0)) |
e9454757 | 4080 | (error "Invalid version string: '%s'" ver)) |
c71abb54 KS |
4081 | ;; Change .x.y to 0.x.y |
4082 | (if (and (>= (length ver) (length version-separator)) | |
4083 | (string-equal (substring ver 0 (length version-separator)) | |
c8227332 | 4084 | version-separator)) |
c71abb54 | 4085 | (setq ver (concat "0" ver))) |
e9454757 VJL |
4086 | (save-match-data |
4087 | (let ((i 0) | |
d74a5c91 | 4088 | (case-fold-search t) ; ignore case in matching |
e9454757 VJL |
4089 | lst s al) |
4090 | (while (and (setq s (string-match "[0-9]+" ver i)) | |
4091 | (= s i)) | |
4092 | ;; handle numeric part | |
4093 | (setq lst (cons (string-to-number (substring ver i (match-end 0))) | |
4094 | lst) | |
4095 | i (match-end 0)) | |
4096 | ;; handle non-numeric part | |
4097 | (when (and (setq s (string-match "[^0-9]+" ver i)) | |
4098 | (= s i)) | |
4099 | (setq s (substring ver i (match-end 0)) | |
4100 | i (match-end 0)) | |
4101 | ;; handle alpha, beta, pre, etc. separator | |
4102 | (unless (string= s version-separator) | |
4103 | (setq al version-regexp-alist) | |
4104 | (while (and al (not (string-match (caar al) s))) | |
4105 | (setq al (cdr al))) | |
e2046ecf CY |
4106 | (cond (al |
4107 | (push (cdar al) lst)) | |
b29f5b7b | 4108 | ;; Convert 22.3a to 22.3.1, 22.3b to 22.3.2, etc. |
e2046ecf CY |
4109 | ((string-match "^[-_+ ]?\\([a-zA-Z]\\)$" s) |
4110 | (push (- (aref (downcase (match-string 1 s)) 0) ?a -1) | |
4111 | lst)) | |
4112 | (t (error "Invalid version syntax: '%s'" ver)))))) | |
e9454757 VJL |
4113 | (if (null lst) |
4114 | (error "Invalid version syntax: '%s'" ver) | |
4115 | (nreverse lst))))) | |
4116 | ||
4117 | ||
ca548b00 | 4118 | (defun version-list-< (l1 l2) |
94785022 | 4119 | "Return t if L1, a list specification of a version, is lower than L2. |
e9454757 | 4120 | |
94785022 EZ |
4121 | Note that a version specified by the list (1) is equal to (1 0), |
4122 | \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant. | |
4123 | Also, a version given by the list (1) is higher than (1 -1), which in | |
4124 | turn is higher than (1 -2), which is higher than (1 -3)." | |
e9454757 VJL |
4125 | (while (and l1 l2 (= (car l1) (car l2))) |
4126 | (setq l1 (cdr l1) | |
4127 | l2 (cdr l2))) | |
4128 | (cond | |
4129 | ;; l1 not null and l2 not null | |
4130 | ((and l1 l2) (< (car l1) (car l2))) | |
4131 | ;; l1 null and l2 null ==> l1 length = l2 length | |
4132 | ((and (null l1) (null l2)) nil) | |
4133 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 4134 | (l1 (< (version-list-not-zero l1) 0)) |
e9454757 | 4135 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 4136 | (t (< 0 (version-list-not-zero l2))))) |
e9454757 VJL |
4137 | |
4138 | ||
ca548b00 | 4139 | (defun version-list-= (l1 l2) |
94785022 | 4140 | "Return t if L1, a list specification of a version, is equal to L2. |
e9454757 | 4141 | |
94785022 EZ |
4142 | Note that a version specified by the list (1) is equal to (1 0), |
4143 | \(1 0 0), (1 0 0 0), etc. That is, the trailing zeros are insignificant. | |
4144 | Also, a version given by the list (1) is higher than (1 -1), which in | |
4145 | turn is higher than (1 -2), which is higher than (1 -3)." | |
e9454757 VJL |
4146 | (while (and l1 l2 (= (car l1) (car l2))) |
4147 | (setq l1 (cdr l1) | |
4148 | l2 (cdr l2))) | |
4149 | (cond | |
4150 | ;; l1 not null and l2 not null | |
4151 | ((and l1 l2) nil) | |
4152 | ;; l1 null and l2 null ==> l1 length = l2 length | |
4153 | ((and (null l1) (null l2))) | |
4154 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 4155 | (l1 (zerop (version-list-not-zero l1))) |
e9454757 | 4156 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 4157 | (t (zerop (version-list-not-zero l2))))) |
e9454757 VJL |
4158 | |
4159 | ||
ca548b00 | 4160 | (defun version-list-<= (l1 l2) |
94785022 | 4161 | "Return t if L1, a list specification of a version, is lower or equal to L2. |
e9454757 VJL |
4162 | |
4163 | Note that integer list (1) is equal to (1 0), (1 0 0), (1 0 0 0), | |
b29f5b7b | 4164 | etc. That is, the trailing zeroes are insignificant. Also, integer |
e9454757 VJL |
4165 | list (1) is greater than (1 -1) which is greater than (1 -2) |
4166 | which is greater than (1 -3)." | |
4167 | (while (and l1 l2 (= (car l1) (car l2))) | |
4168 | (setq l1 (cdr l1) | |
4169 | l2 (cdr l2))) | |
4170 | (cond | |
4171 | ;; l1 not null and l2 not null | |
4172 | ((and l1 l2) (< (car l1) (car l2))) | |
4173 | ;; l1 null and l2 null ==> l1 length = l2 length | |
4174 | ((and (null l1) (null l2))) | |
4175 | ;; l1 not null and l2 null ==> l1 length > l2 length | |
ca548b00 | 4176 | (l1 (<= (version-list-not-zero l1) 0)) |
e9454757 | 4177 | ;; l1 null and l2 not null ==> l2 length > l1 length |
ca548b00 | 4178 | (t (<= 0 (version-list-not-zero l2))))) |
e9454757 | 4179 | |
ca548b00 | 4180 | (defun version-list-not-zero (lst) |
94785022 | 4181 | "Return the first non-zero element of LST, which is a list of integers. |
e9454757 | 4182 | |
94785022 | 4183 | If all LST elements are zeros or LST is nil, return zero." |
ca548b00 KS |
4184 | (while (and lst (zerop (car lst))) |
4185 | (setq lst (cdr lst))) | |
4186 | (if lst | |
4187 | (car lst) | |
4188 | ;; there is no element different of zero | |
4189 | 0)) | |
e9454757 VJL |
4190 | |
4191 | ||
4192 | (defun version< (v1 v2) | |
94785022 | 4193 | "Return t if version V1 is lower (older) than V2. |
e9454757 VJL |
4194 | |
4195 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", | |
94785022 EZ |
4196 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
4197 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", | |
7e5bfb8f EZ |
4198 | which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated |
4199 | as alpha versions." | |
ca548b00 | 4200 | (version-list-< (version-to-list v1) (version-to-list v2))) |
e9454757 VJL |
4201 | |
4202 | ||
4203 | (defun version<= (v1 v2) | |
94785022 | 4204 | "Return t if version V1 is lower (older) than or equal to V2. |
e9454757 VJL |
4205 | |
4206 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", | |
b29f5b7b | 4207 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
94785022 | 4208 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", |
7e5bfb8f EZ |
4209 | which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated |
4210 | as alpha versions." | |
ca548b00 | 4211 | (version-list-<= (version-to-list v1) (version-to-list v2))) |
e9454757 | 4212 | |
ca548b00 KS |
4213 | (defun version= (v1 v2) |
4214 | "Return t if version V1 is equal to V2. | |
e9454757 | 4215 | |
ca548b00 | 4216 | Note that version string \"1\" is equal to \"1.0\", \"1.0.0\", \"1.0.0.0\", |
b29f5b7b | 4217 | etc. That is, the trailing \".0\"s are insignificant. Also, version |
94785022 | 4218 | string \"1\" is higher (newer) than \"1pre\", which is higher than \"1beta\", |
7e5bfb8f EZ |
4219 | which is higher than \"1alpha\". Also, \"-CVS\" and \"-NNN\" are treated |
4220 | as alpha versions." | |
ca548b00 | 4221 | (version-list-= (version-to-list v1) (version-to-list v2))) |
e9454757 | 4222 | |
18d433a7 CY |
4223 | \f |
4224 | ;;; Misc. | |
a3c20c83 DN |
4225 | (defconst menu-bar-separator '("--") |
4226 | "Separator for menus.") | |
18d433a7 CY |
4227 | |
4228 | ;; The following statement ought to be in print.c, but `provide' can't | |
4229 | ;; be used there. | |
5612fd08 | 4230 | ;; http://lists.gnu.org/archive/html/emacs-devel/2009-08/msg00236.html |
18d433a7 CY |
4231 | (when (hash-table-p (car (read-from-string |
4232 | (prin1-to-string (make-hash-table))))) | |
4233 | (provide 'hashtable-print-readable)) | |
4234 | ||
630cc463 | 4235 | ;;; subr.el ends here |