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