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